Skip to content
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.

Sign up for GitHub

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

Adding support for OpenID-Connect #251

Merged
merged 6 commits into from
Jun 26, 2018
Merged

Adding support for OpenID-Connect #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fdd60b0
Adding support for OpenID-Connect
abellotti Nov 30, 2017
c4b8ff8
Needed to leverage the APPLICATION_DOMAIN for defining
abellotti Dec 1, 2017
858e62d
Updated miq-template.yaml and miq-template-ext-db.yaml
abellotti Dec 1, 2017
03d6944
Making the HTTPD_AUTH_OIDC_* environment variables
abellotti Dec 4, 2017
85fa9de
For OpenID-Connect /openid-connect is only served by mod_auth_openidc,
abellotti Jun 5, 2018
109fa75
Updated README.md to reflect the support of oidc.
abellotti Jun 22, 2018
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,6 +580,7 @@ The config map includes the following:
| external | IPA, IPA 2-factor authentication, IPA/AD Trust, Ldap (OpenLdap, RHDS, Active Directory, etc.)
| active-directory | Active Directory domain realm join
| saml | SAML based authentication (Keycloak, ADFS, etc.)
| oidc | OpenID-Connect based authentication (Keycloak, ADFS, etc.)

* The kerberos realms to join `auth-kerberos-realms`, default is `undefined`

Expand Down Expand Up @@ -623,7 +624,7 @@ Binary files can be specified in the configuration map in their base64 encoded f

When an /etc/sssd/sssd.conf file is included in the configuration map, the httpd pod automatically enables the sssd service upon startup.

### Sample external authentication configuration:
### Sample external authentication configuration for SAML:

Excluding the content of the files, a SAML auth-config map data section may look like:

Expand Down
56 changes: 56 additions & 0 deletions templates/miq-template-ext-db.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ objects:

# For SAML /saml2 is only served by mod_auth_mellon in the httpd pod
RewriteCond %{REQUEST_URI} !^/saml2

# For OpenID-Connect /openid-connect is only served by mod_auth_openidc
RewriteCond %{REQUEST_URI} !^/openid-connect

RewriteRule ^/ http://ui:3000%{REQUEST_URI} [P,QSA,L]
ProxyPassReverse / http://ui:3000/

Expand Down Expand Up @@ -144,6 +148,24 @@ objects:
</Location>

Include "conf.d/external-auth-remote-user-conf"
configuration-openid-connect-auth: |
LoadModule auth_openidc_module modules/mod_auth_openidc.so

OIDCProviderMetadataURL ${HTTPD_AUTH_OIDC_PROVIDER_METADATA_URL}
OIDCClientID ${HTTPD_AUTH_OIDC_CLIENT_ID}
OIDCClientSecret ${HTTPD_AUTH_OIDC_CLIENT_SECRET}

OIDCRedirectURI "https://${APPLICATION_DOMAIN}/oidc_login/redirect_uri"
OIDCOAuthRemoteUserClaim username

OIDCCryptoPassphrase sp-secret

<Location /oidc_login>
AuthType openid-connect
Require valid-user
</Location>

Include "conf.d/external-auth-openid-connect-remote-user-conf"
external-auth-load-modules-conf: |
LoadModule authnz_pam_module modules/mod_authnz_pam.so
LoadModule intercept_form_submit_module modules/mod_intercept_form_submit.so
Expand Down Expand Up @@ -197,13 +219,27 @@ objects:
RequestHeader set X_REMOTE_USER_FULLNAME %{REMOTE_USER_FULLNAME}e env=REMOTE_USER_FULLNAME
RequestHeader set X_REMOTE_USER_GROUPS %{REMOTE_USER_GROUPS}e env=REMOTE_USER_GROUPS
RequestHeader set X_REMOTE_USER_DOMAIN %{REMOTE_USER_DOMAIN}e env=REMOTE_USER_DOMAIN
external-auth-openid-connect-remote-user-conf: |
RequestHeader unset X_REMOTE_USER

RequestHeader set X_REMOTE_USER %{OIDC_CLAIM_PREFERRED_USERNAME}e env=OIDC_CLAIM_PREFERRED_USERNAME
RequestHeader set X_EXTERNAL_AUTH_ERROR %{EXTERNAL_AUTH_ERROR}e env=EXTERNAL_AUTH_ERROR
RequestHeader set X_REMOTE_USER_EMAIL %{OIDC_CLAIM_EMAIL}e env=OIDC_CLAIM_EMAIL
RequestHeader set X_REMOTE_USER_FIRSTNAME %{OIDC_CLAIM_GIVEN_NAME}e env=OIDC_CLAIM_GIVEN_NAME
RequestHeader set X_REMOTE_USER_LASTNAME %{OIDC_CLAIM_FAMILY_NAME}e env=OIDC_CLAIM_FAMILY_NAME
RequestHeader set X_REMOTE_USER_FULLNAME %{OIDC_CLAIM_NAME}e env=OIDC_CLAIM_NAME
RequestHeader set X_REMOTE_USER_GROUPS %{OIDC_CLAIM_GROUPS}e env=OIDC_CLAIM_GROUPS
RequestHeader set X_REMOTE_USER_DOMAIN %{OIDC_CLAIM_DOMAIN}e env=OIDC_CLAIM_DOMAIN
- apiVersion: v1
kind: ConfigMap
metadata:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
data:
auth-type: internal
auth-kerberos-realms: undefined
auth-oidc-provider-metadata-url: undefined
auth-oidc-client-id: undefined
auth-oidc-client-secret: undefined
auth-configuration.conf: |
# External Authentication Configuration File
#
Expand Down Expand Up @@ -505,6 +541,8 @@ objects:
limits:
memory: "${HTTPD_MEM_LIMIT}"
env:
- name: APPLICATION_DOMAIN
value: "${APPLICATION_DOMAIN}"
- name: HTTPD_AUTH_TYPE
valueFrom:
configMapKeyRef:
Expand All @@ -515,6 +553,24 @@ objects:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-kerberos-realms
- name: HTTPD_AUTH_OIDC_PROVIDER_METADATA_URL
valueFrom:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-oidc-provider-metadata-url
optional: true
- name: HTTPD_AUTH_OIDC_CLIENT_ID
valueFrom:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-oidc-client-id
optional: true
- name: HTTPD_AUTH_OIDC_CLIENT_SECRET
valueFrom:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-oidc-client-secret
optional: true
lifecycle:
postStart:
exec:
Expand Down
56 changes: 56 additions & 0 deletions templates/miq-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ objects:

# For SAML /saml2 is only served by mod_auth_mellon in the httpd pod
RewriteCond %{REQUEST_URI} !^/saml2

# For OpenID-Connect /openid-connect is only served by mod_auth_openidc
RewriteCond %{REQUEST_URI} !^/openid-connect

RewriteRule ^/ http://ui:3000%{REQUEST_URI} [P,QSA,L]
ProxyPassReverse / http://ui:3000/

Expand Down Expand Up @@ -217,6 +221,24 @@ objects:
</Location>

Include "conf.d/external-auth-remote-user-conf"
configuration-openid-connect-auth: |
LoadModule auth_openidc_module modules/mod_auth_openidc.so

OIDCProviderMetadataURL ${HTTPD_AUTH_OIDC_PROVIDER_METADATA_URL}
OIDCClientID ${HTTPD_AUTH_OIDC_CLIENT_ID}
OIDCClientSecret ${HTTPD_AUTH_OIDC_CLIENT_SECRET}

OIDCRedirectURI "https://${APPLICATION_DOMAIN}/oidc_login/redirect_uri"
OIDCOAuthRemoteUserClaim username

OIDCCryptoPassphrase sp-secret

<Location /oidc_login>
AuthType openid-connect
Require valid-user
</Location>

Include "conf.d/external-auth-openid-connect-remote-user-conf"
external-auth-load-modules-conf: |
LoadModule authnz_pam_module modules/mod_authnz_pam.so
LoadModule intercept_form_submit_module modules/mod_intercept_form_submit.so
Expand Down Expand Up @@ -270,13 +292,27 @@ objects:
RequestHeader set X_REMOTE_USER_FULLNAME %{REMOTE_USER_FULLNAME}e env=REMOTE_USER_FULLNAME
RequestHeader set X_REMOTE_USER_GROUPS %{REMOTE_USER_GROUPS}e env=REMOTE_USER_GROUPS
RequestHeader set X_REMOTE_USER_DOMAIN %{REMOTE_USER_DOMAIN}e env=REMOTE_USER_DOMAIN
external-auth-openid-connect-remote-user-conf: |
RequestHeader unset X_REMOTE_USER

RequestHeader set X_REMOTE_USER %{OIDC_CLAIM_PREFERRED_USERNAME}e env=OIDC_CLAIM_PREFERRED_USERNAME
RequestHeader set X_EXTERNAL_AUTH_ERROR %{EXTERNAL_AUTH_ERROR}e env=EXTERNAL_AUTH_ERROR
RequestHeader set X_REMOTE_USER_EMAIL %{OIDC_CLAIM_EMAIL}e env=OIDC_CLAIM_EMAIL
RequestHeader set X_REMOTE_USER_FIRSTNAME %{OIDC_CLAIM_GIVEN_NAME}e env=OIDC_CLAIM_GIVEN_NAME
RequestHeader set X_REMOTE_USER_LASTNAME %{OIDC_CLAIM_FAMILY_NAME}e env=OIDC_CLAIM_FAMILY_NAME
RequestHeader set X_REMOTE_USER_FULLNAME %{OIDC_CLAIM_NAME}e env=OIDC_CLAIM_NAME
RequestHeader set X_REMOTE_USER_GROUPS %{OIDC_CLAIM_GROUPS}e env=OIDC_CLAIM_GROUPS
RequestHeader set X_REMOTE_USER_DOMAIN %{OIDC_CLAIM_DOMAIN}e env=OIDC_CLAIM_DOMAIN
- apiVersion: v1
kind: ConfigMap
metadata:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
data:
auth-type: internal
auth-kerberos-realms: undefined
auth-oidc-provider-metadata-url: undefined
auth-oidc-client-id: undefined
auth-oidc-client-secret: undefined
auth-configuration.conf: |
# External Authentication Configuration File
#
Expand Down Expand Up @@ -650,6 +686,8 @@ objects:
limits:
memory: "${HTTPD_MEM_LIMIT}"
env:
- name: APPLICATION_DOMAIN
value: "${APPLICATION_DOMAIN}"
- name: HTTPD_AUTH_TYPE
valueFrom:
configMapKeyRef:
Expand All @@ -660,6 +698,24 @@ objects:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-kerberos-realms
- name: HTTPD_AUTH_OIDC_PROVIDER_METADATA_URL
valueFrom:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-oidc-provider-metadata-url
optional: true
- name: HTTPD_AUTH_OIDC_CLIENT_ID
valueFrom:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-oidc-client-id
optional: true
- name: HTTPD_AUTH_OIDC_CLIENT_SECRET
valueFrom:
configMapKeyRef:
name: "${HTTPD_SERVICE_NAME}-auth-configs"
key: auth-oidc-client-secret
optional: true
lifecycle:
postStart:
exec:
Expand Down