Skip to content

Commit

Permalink
Support config in yaml format (Soluto#114)
Browse files Browse the repository at this point in the history
  • Loading branch information
@AleF83
AleF83 authored Jul 11, 2022
1 parent 0b87112 commit 59bdbe8
Show file tree
Hide file tree
Showing 23 changed files with 312 additions and 222 deletions.
268 changes: 123 additions & 145 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,158 +10,135 @@ The image is stored in `github` registry. Use the following to pull the image:
docker pull ghcr.io/soluto/oidc-server-mock:latest
```


This is the sample of using the server in `docker-compose` configuration:

```yaml
version: '3'
services:
oidc-server-mock:
container_name: oidc-server-mock
image: ghcr.io/soluto/oidc-server-mock:latest
ports:
- "4011:80"
environment:
ASPNETCORE_ENVIRONMENT: Development
SERVER_OPTIONS_INLINE: |
{
"AccessTokenJwtType": "JWT",
"Discovery": {
"ShowKeySet": true
},
"Authentication": {
"CookieSameSiteMode": "Lax",
"CheckSessionCookieSameSiteMode": "Lax"
}
version: '3'
services:
oidc-server-mock:
container_name: oidc-server-mock
image: ghcr.io/soluto/oidc-server-mock:latest
ports:
- '4011:80'
environment:
ASPNETCORE_ENVIRONMENT: Development
SERVER_OPTIONS_INLINE: |
{
"AccessTokenJwtType": "JWT",
"Discovery": {
"ShowKeySet": true
},
"Authentication": {
"CookieSameSiteMode": "Lax",
"CheckSessionCookieSameSiteMode": "Lax"
}
ACCOUNT_OPTIONS_INLINE: |
}
ACCOUNT_OPTIONS_INLINE: |
{
"AutomaticRedirectAfterSignOut": true
}
API_SCOPES_INLINE: |
- Name: some-app-scope-1
- Name: some-app-scope-2
API_RESOURCES_INLINE: |
- Name: some-app
Scopes:
- some-app-scope-1
- some-app-scope-2
USERS_CONFIGURATION_INLINE: |
[
{
"AutomaticRedirectAfterSignOut": true
"SubjectId":"1",
"Username":"User1",
"Password":"pwd",
"Claims": [
{
"Type": "name",
"Value": "Sam Tailor"
},
{
"Type": "email",
"Value": "[email protected]"
},
{
"Type": "some-api-resource-claim",
"Value": "Sam's Api Resource Custom Claim"
},
{
"Type": "some-api-scope-claim",
"Value": "Sam's Api Scope Custom Claim"
},
{
"Type": "some-identity-resource-claim",
"Value": "Sam's Identity Resource Custom Claim"
}
]
}
API_SCOPES_INLINE: |
[
{
"Name": "some-app-scope-1"
},
{
"Name": "some-app-scope-2"
}
]
API_RESOURCES_INLINE: |
[
{
"Name": "some-app",
"Scopes": ["some-app-scope-1", "some-app-scope-2"]
}
]
USERS_CONFIGURATION_INLINE: |
[
{
"SubjectId":"1",
"Username":"User1",
"Password":"pwd",
"Claims": [
{
"Type": "name",
"Value": "Sam Tailor"
},
{
"Type": "email",
"Value": "[email protected]"
},
{
"Type": "some-api-resource-claim",
"Value": "Sam's Api Resource Custom Claim"
},
{
"Type": "some-api-scope-claim",
"Value": "Sam's Api Scope Custom Claim"
},
{
"Type": "some-identity-resource-claim",
"Value": "Sam's Identity Resource Custom Claim"
}
]
}
]
CLIENTS_CONFIGURATION_PATH: /tmp/config/clients-config.json
volumes:
- .:/tmp/config:ro
]
CLIENTS_CONFIGURATION_PATH: /tmp/config/clients-config.json
volumes:
- .:/tmp/config:ro
```
When `clients-config.json` is as following:

```json
[{
"ClientId": "implicit-mock-client",
"Description": "Client for implicit flow",
"AllowedGrantTypes": [
"implicit"
],
"AllowAccessTokensViaBrowser": true,
"RedirectUris": [
"http://localhost:3000/auth/oidc",
"http://localhost:4004/auth/oidc"
],
"AllowedScopes": [
"openid",
"profile",
"email"
],
"IdentityTokenLifetime": 3600,
"AccessTokenLifetime": 3600
},
{
"ClientId": "client-credentials-mock-client",
"ClientSecrets": [
"client-credentials-mock-client-secret"
],
"Description": "Client for client credentials flow",
"AllowedGrantTypes": [
"client_credentials"
],
"AllowedScopes": [
"some-app"
],
"ClientClaimsPrefix": "",
"Claims": [
{
"Type": "string_claim",
"Value": "string_claim_value"
},
{
"Type": "json_claim",
"Value": "['value1', 'value2']",
"ValueType": "json"
}
]
}
[
{
"ClientId": "implicit-mock-client",
"Description": "Client for implicit flow",
"AllowedGrantTypes": ["implicit"],
"AllowAccessTokensViaBrowser": true,
"RedirectUris": ["http://localhost:3000/auth/oidc", "http://localhost:4004/auth/oidc"],
"AllowedScopes": ["openid", "profile", "email"],
"IdentityTokenLifetime": 3600,
"AccessTokenLifetime": 3600
},
{
"ClientId": "client-credentials-mock-client",
"ClientSecrets": ["client-credentials-mock-client-secret"],
"Description": "Client for client credentials flow",
"AllowedGrantTypes": ["client_credentials"],
"AllowedScopes": ["some-app"],
"ClientClaimsPrefix": "",
"Claims": [
{
"Type": "string_claim",
"Value": "string_claim_value"
},
{
"Type": "json_claim",
"Value": "['value1', 'value2']",
"ValueType": "json"
}
]
}
]
```

Clients configuration should be provided. Test user configuration is optional (used for implicit flow only).

There are two ways to provide configuration for supported scopes, clients and users. You can either provide it inline as environment variable:

* `SERVER_OPTIONS_INLINE`
* `ACCOUNT_OPTIONS_INLINE`
* `API_SCOPES_INLINE`
* `USERS_CONFIGURATION_INLINE`
* `CLIENTS_CONFIGURATION_INLINE`
* `API_RESOURCES_INLINE`
* `IDENTITY_RESOURCES_INLINE`
- `SERVER_OPTIONS_INLINE`
- `ACCOUNT_OPTIONS_INLINE`
- `API_SCOPES_INLINE`
- `USERS_CONFIGURATION_INLINE`
- `CLIENTS_CONFIGURATION_INLINE`
- `API_RESOURCES_INLINE`
- `IDENTITY_RESOURCES_INLINE`

or mount volume and provide the path to configuration json as environment variable:
or mount volume and provide the path to configuration json as environment variable:

* `SERVER_OPTIONS_PATH`
* `ACCOUNT_OPTIONS_PATH`
* `API_SCOPES_PATH`
* `USERS_CONFIGURATION_PATH`
* `CLIENTS_CONFIGURATION_PATH`
* `API_RESOURCES_PATH`
* `IDENTITY_RESOURCES_PATH`
- `SERVER_OPTIONS_PATH`
- `ACCOUNT_OPTIONS_PATH`
- `API_SCOPES_PATH`
- `USERS_CONFIGURATION_PATH`
- `CLIENTS_CONFIGURATION_PATH`
- `API_RESOURCES_PATH`
- `IDENTITY_RESOURCES_PATH`

The configuration format can be Yaml or JSON both for inline or file path options.

## Base path

Expand All @@ -175,19 +152,20 @@ Just set `BasePath` property in `ASPNET_SERVICES_OPTIONS_INLINE/PATH` env var.

Users can be added (in future also removed and altered) via `user management` endpoint.

* Create new user: `POST` request to `/api/v1/user` path.
- Create new user: `POST` request to `/api/v1/user` path.
The request body should be the `User` object. Just as in `USERS_CONFIGURATION`.
The response is subjectId as sent in request.

* Get user: `GET` request to `/api/v1/user/{subjectId}` path.
- Get user: `GET` request to `/api/v1/user/{subjectId}` path.
The response is `User` object

* Update user `PUT` request to `/api/v1/user` path. (**Not implemented yet**)
- Update user `PUT` request to `/api/v1/user` path. (**Not implemented yet**)
The request body should be the `User` object. Just as in `USERS_CONFIGURATION`.
The response is subjectId as sent in request.

> If user doesn't exits it will be created.

* Delete user: `DELETE` request to `/api/v1/user/{subjectId}` path. (**Not implemented yet**)
- Delete user: `DELETE` request to `/api/v1/user/{subjectId}` path. (**Not implemented yet**)
The response is `User` object

## HTTPS
Expand Down Expand Up @@ -240,23 +218,23 @@ There are two ways to use `oidc-server-mock` with this change.

1. Clone the repo:

```sh
git clone [email protected]:Soluto/oidc-server-mock.git
```
```sh
git clone [email protected]:Soluto/oidc-server-mock.git
```

2. Install `npm` packages (run from `/e2e` folder):

```sh
npm install
```
```sh
npm install
```

> Note: During the build of Docker image UI source code is fetched from [github](https://github.com/IdentityServer/IdentityServer4.Quickstart.UI/tree/main). If you experience some issues on project compile step of Docker build or on runtime try to change the branch or commit in the [script](./src/getmain.sh).
> Note: During the build of Docker image UI source code is fetched from [github](https://github.com/IdentityServer/IdentityServer4.Quickstart.UI/tree/main). If you experience some issues on project compile step of Docker build or on runtime try to change the branch or commit in the [script](./src/getmain.sh).

3. Run tests:

```sh
npm run test
```
```sh
npm run test
```

## Used by

Expand Down
8 changes: 0 additions & 8 deletions e2e/config/api-resources.json
View file

This file was deleted.

8 changes: 8 additions & 0 deletions e2e/config/api-resources.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- Name: some-app
Scopes:
- some-app-scope-1
- some-app-scope-2
ApiSecrets:
- some-app-secret-1
UserClaims:
- some-app-user-custom-claim
9 changes: 0 additions & 9 deletions e2e/config/api-scopes.json
View file

This file was deleted.

0 e2e/config/clients-configuration.json → e2e/config/clients.json
View file
File renamed without changes.
0 e2e/config/user-configuration.json → e2e/config/users.yaml
View file
File renamed without changes.
12 changes: 8 additions & 4 deletions e2e/docker-compose.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ services:
ASPNETCORE_Kestrel__Certificates__Default__Path: /https/aspnetapp.pfx
SERVER_OPTIONS_PATH: /config/server-options.json
ACCOUNT_OPTIONS_PATH: /config/account-options.json
API_SCOPES_PATH: /config/api-scopes.json
API_RESOURCES_PATH: /config/api-resources.json
USERS_CONFIGURATION_PATH: /config/user-configuration.json
CLIENTS_CONFIGURATION_PATH: /config/clients-configuration.json
API_RESOURCES_PATH: /config/api-resources.yaml
API_SCOPES_INLINE: |
- Name: some-app-scope-1
UserClaims:
- some-app-scope-1-custom-user-claim
- Name: some-app-scope-2
USERS_CONFIGURATION_PATH: /config/users.yaml
CLIENTS_CONFIGURATION_PATH: /config/clients.json
IDENTITY_RESOURCES_PATH: /config/identity-resources.json
ASPNET_SERVICES_OPTIONS_INLINE: |
{
Expand Down
8 changes: 6 additions & 2 deletions e2e/helpers/introspect-endpoint.ts
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
import * as fs from 'fs/promises';
import { Agent } from 'https';
import path from 'path';

import fetch from 'node-fetch';

import apiResources from '../config/api-resources.json';
import * as yaml from 'yaml';

export default async (
token: string,
apiResourceId: string,
snapshotPropertyMatchers: Record<string, unknown> = {}
): Promise<void> => {
const apiResources = yaml.parse(
await fs.readFile(path.join(process.cwd(), './config/api-resources.yaml'), { encoding: 'utf8' })
);
const apiResource = apiResources.find(aR => aR.Name === apiResourceId);
expect(apiResource).toBeDefined();
const auth = Buffer.from(`${apiResource.Name}:${apiResource.ApiSecrets?.[0]}`).toString('base64');
Expand Down
Loading

0 comments on commit 59bdbe8

Please sign in to comment.