Add support for the OIDCScope configuration parameter

[abellotti]

There are tons of OpenID-Connect configuration parameters we could be considering for OOTB support with mod_auth_openidc in Apache, as seen here in https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf.

While customers can manually update the manageiq-external-auth-openidc.conf file in the /etc/httpd/conf.d directory on the appliance, template for that file being here: https://github.com/ManageIQ/manageiq-appliance/blob/master/TEMPLATE/etc/httpd/conf.d/manageiq-external-auth-openidc.conf.erb, we like to minimize the need to manually update those.

One parameter we can add support for is the OIDCScope. While for our testing the default scope of openid is sufficient, customers may need to add additional scopes as some of the claims we require as shown here https://github.com/ManageIQ/manageiq-appliance/blob/master/TEMPLATE/etc/httpd/conf.d/manageiq-remote-user-openidc.conf
are only sent by the Identity Provider via the additional scopes defined.

This RFE is to add support for the OIDC Scope parameter in ManageIQ. This includes the following updates:

The template itself:

• https://github.com/ManageIQ/manageiq-appliance/blob/master/TEMPLATE/etc/httpd/conf.d/manageiq-external-auth-openidc.conf.erb

  Adding the configurable parameter:

OIDCScope       <%= oidc_scope %>

The updated documentation for manual configuration mentioning the new parameter and the default openid:

• https://github.com/ManageIQ/manageiq_docs/blob/master/auth/openid_connect.adoc

The Appliance console CLI for configuring the new parameter:

• https://github.com/ManageIQ/manageiq-appliance_console/blob/master/lib/manageiq/appliance_console/oidc_authentication.rb

  Adding the optional:

    --oidc-scope <scope> 

as optional parameter, and defaulting to openid if not specified.

We also need to update the config map generator for the ManageIQ httpd pod accordingly:

• https://github.com/ManageIQ/httpd_configmap_generator/blob/master/README-oidc.md

• https://github.com/ManageIQ/httpd_configmap_generator/blob/master/lib/httpd_configmap_generator/oidc.rb

  Adding support for the optional:

   --oidc-scope <scope>

Making sure the auth-oidc-scope parameter is defined for the template to consume.

Would need to update the Podified HTTPD Container's template accordingly to add the OIDCScope parameter:

• https://github.com/ManageIQ/manageiq-pods/blob/36f3915cedd74ab42b4d6be0250434b0c0cc1b46/templates/app/httpd.yaml#L136

Finally, when we generate a JWT token in the API in the get_jwt_token method shown here:
- https://github.com/ManageIQ/manageiq-api/blob/95e86abb70c2a601f424e18f3d8d0f3d119c9d01/app/controllers/api/base_controller/authentication.rb#L230

We need to pass the scope as fetched from the config file to the Identity Provider's token_endpoint so we get the optional claims defined for the appliance/ - Implemented here: ManageIQ/manageiq-api#747

[abellotti]

/cc @Fryguy @jvlcek

[Fryguy]

@abellotti Was this part of the recent PR? (and thus closable?)

[Fryguy]

Oh...didn't realize this was for appliance_console cli

[miq-bot]

This issue has been automatically marked as stale because it has not been updated for at least 3 months.

If you can still reproduce this issue on the current release or on master, please reply with all of the information you have about it in order to keep the issue open.

Thank you for all your contributions! More information about the ManageIQ triage process can be found in the traige process documentation.

[miq-bot]

This issue has been automatically marked as stale because it has not been updated for at least 3 months.

If you can still reproduce this issue on the current release or on master, please reply with all of the information you have about it in order to keep the issue open.

Thank you for all your contributions! More information about the ManageIQ triage process can be found in the triage process documentation.