Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remove158/chula-sso
A standalone chula-sso-mock based on chula-sso
https://github.com/remove158/chula-sso
chulalongkorn gin-gonic golang sso
Last synced: 3 months ago
JSON representation
A standalone chula-sso-mock based on chula-sso
- Host: GitHub
- URL: https://github.com/remove158/chula-sso
- Owner: remove158
- Created: 2022-09-03T07:13:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-13T20:22:59.000Z (12 months ago)
- Last Synced: 2024-06-20T13:31:39.777Z (8 months ago)
- Topics: chulalongkorn, gin-gonic, golang, sso
- Language: Go
- Homepage: https://sso.piyaphat.com/login?service=https://www.google.com
- Size: 121 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Chula SSO
A standalone chula-sso-mock based on [chula-sso](https://account.it.chula.ac.th/wiki/doku.php?id=how_does_it_work)
Being used in development by [Piyaphat Pinyo](https://www.github.com/remove158)
Please feel free to use [https://sso.piyaphat.com](https://sso.piyaphat.com/login?service=https://www.google.com)
## Usage
Docker images are available on the [GitHub Packages](https://github.com/remove158/chula-sso/pkgs/container/chula-sso).
1. Install docker
2. Download the image: `docker pull ghcr.io/remove158/chula-sso:latest`
3. Run: `docker run -p 8080:8080 ghcr.io/remove158/chula-sso:latest`
## Preview
## Configuration
The configuration is done by the following environment variables. (see [`docker run`](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) on how to set it)
| Name | Environment Variable | Default |
| ------------ | -------------------- | ------- |
| DeeAppId | DEE_APP_ID | test |
| DeeAppSecret | DEE_APP_SECRET | test |
| Port | PORT | 8080 |
## Endpoint
### GET /login
- Request
```sh
curl --request GET \
--url 'https://sso.piyaphat.com/login?service=https://www.google.com'
```
- Response 302 Found
```js
// (on-success) 302 Location: https://www.google.com?ticket=86966dc5-2049-428f-88fe-2d78a5985d38
```
- Response 400 Bad Request
```json
{
"error": "Key: 'GetLoginRequest.Service' Error:Field validation for 'Service' failed on the 'required' tag"
}
```
### GET, POST /serviceValidation
- Request
```sh
curl --request POST \
--url 'https://sso.piyaphat.com/serviceValidation' \
--header 'DeeAppId: test' \
--header 'DeeAppSecret: test' \
--header 'DeeTicket: 1b50cf0d-ceed-46da-a672-4c61060ece8d'
```
- Response 200 (application/json)
```json
{
"uid": "14c6c69f-21ca-4999-999c-423dde2515ad",
"username": "6200000021",
"gecos": "Prayut Chan-Angkhan, ENG",
"disable": false,
"roles": ["student"],
"firstname": "Prayut",
"firstnameth": "Prayut",
"lastname": "Chan-Angkhan",
"lastnameth": "Chan-Angkhan",
"ouid": "6200000021",
"email": "[email protected]"
}
```
- Response 401 Unauthorized
```json
{
"error": "ticket not found"
}
```
## Diagram
### Login
```mermaid
sequenceDiagram
Client->>SSO: GET: /login?service=https://www.google.com
alt provide service
SSO->>Client: 302 Found
else didn't provide service
SSO->>Client: 400 Bad Request
end
```