Skip to content

RORDEV-1446-Add-support-for-the-passing-any-SAML/OIDC-config-parameters-via-kibana.yml #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 64 additions & 1 deletion kibana.md
Original file line number Diff line number Diff line change
Expand Up @@ -1060,7 +1060,21 @@ readonlyrest_kbn:
authnContext: "http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/windows" # Name identifier format to request auth context.`
identifierFormat: null # Name identifier format to request from identity provider.`
[...]
```
```

### Additional Parameters
When configuring SAML authentication in ReadonlyREST Enterprise, you can provide additional parameters to customize the behavior of the SAML service provider integration.
These parameters allow for fine-tuning the SAML integration to work with various identity providers and specific configurations

You can find a list of all supported parameters in the [Passport-SAML Configuration Parameters documentation](https://github.com/node-saml/passport-saml/tree/3.x?tab=readme-ov-file#config-parameter-details)

```yaml
readonlyrest_kbn:
auth:
saml_serv1:
audience: "https://sp.example.com/metadata"`
[...]
```

## OpenID Connect (OIDC)
([Enterprise](https://readonlyrest.com/enterprise))
Expand Down Expand Up @@ -1201,6 +1215,55 @@ readonlyrest_kbn:
userInfoSource: 'access_token' # Available options: 'user_info_endpoint' (default) or 'access_token'
```


### Additional Parameters
When configuring OpenID Connect (OIDC) in ReadonlyREST Enterprise, you can provide additional parameters to customize the behavior of the OIDC client and issuer. These parameters allow for fine-tuning the OIDC integration to work with various providers and specific configurations.
These additional parameters allow you to solve complex authentication scenarios, work with non-standard OIDC providers, and fine-tune the security and performance characteristics of your OIDC integration.

#### Issuer Additional Parameters
You can find a list of all supported parameters:

For Kibana 7.12.0 and above: [documentation](https://github.com/panva/openid-client/tree/v5.x/docs#new-issuermetadata)

For Kibana below 7.12.0: [documentation](https://github.com/panva/openid-client/tree/v4.x/docs#new-issuermetadata)

```yaml
readonlyrest_kbn.auth:
oidc_kc:
[...]
issuerAdditionalParameters:
metadata:
token_endpoint: 'https://custom-token-endpoint'
jwks_uri: 'https://custom-jwks-uri'
```

#### Client Additional Parameters
You can find a list of all supported parameters:

For Kibana 7.12.0 and above: [documentation](https://github.com/panva/openid-client/tree/v5.x/docs#new-clientmetadata-jwks-options)

For Kibana below 7.12.0: [documentation](https://github.com/panva/openid-client/tree/v4.x/docs#new-clientmetadata-jwks-options)

```yaml
readonlyrest_kbn.auth:
oidc_kc:
[...]
clientAdditionalParameters:
metadata:
response_types: ['code']
redirect_uris: ['https://my-app/callback']
jwks:
keys:
- kty: 'RSA'
use: 'sig'
alg: 'RS256'
kid: 'key1'
n: 'PLACEHOLDER_TO_CHANGE_INTO_REAL_CERTIFICATE'
e: 'AQAB'
options:
additionalAuthorizedParties: 'my-app'
```

## Load balancers

These features will work with all ReadonlyREST Editions
Expand Down