docs/doc/source/security/kubernetes/configure-oidc-auth-applications.rst

Set up OIDC Auth Applications

The oidc-auth-apps application is a system application that needs to be configured to use a remote Windows Active Directory server to authenticate users of the Kubernetes API. The oidc-auth-apps is packaged in the ISO and uploaded by default.

Configure OIDC Auth Applications

• You must have configured the Kubernetes kube-apiserver to use the oidc-auth-apps identity provider for validation of tokens in Kubernetes API requests, which use authentication. For more information on configuring the Kubernetes kube-apiserver, see Configure Kubernetes for OIDC Token Validation while Bootstrapping the System <configure-kubernetes-for-oidc-token-validation-while-bootstrapping-the-system> or Configure Kubernetes for OIDC Token Validation after Bootstrapping the System <configure-kubernetes-for-oidc-token-validation-after-bootstrapping-the-system>.

1. Create certificates using one of the following options.

   1. Create certificates using cert-manager (recommended):

      Certificates used by oidc-auth-apps can be managed by Cert-Manager. Doing so will automatically renew the certificates before they expire. The system-local-ca ClusterIssuer (see starlingx-rest-api-applications-and-the-web-admin-server-cert-9196c5794834) will be used to issue this certificate.

      Note

      If a signing is not a well-known trusted , you must ensure the system trusts the by specifying it either during the bootstrap phase of system installation, by specifying ssl_ca_cert: <certificate_file> in the ansible bootstrap overrides localhost.yml file, or by using the system certificate-install -m ssl_ca <certificate_file> command.

      Also refer to Add a Trusted CA <add-a-trusted-ca> for installing a root , which includes instruction to lock/unlock controller nodes when using system certificate-install command.

      Important

      The namespace for oidc-auth-apps must be kube-system.

      1. Create the client and identity provider server certificate and private key pair.

         ~(keystone_admin)]$ cat <<EOF > oidc-auth-apps-certificate.yaml
         ---
         apiVersion: cert-manager.io/v1
         kind: Certificate
         metadata:
           name: oidc-auth-apps-certificate
           namespace: kube-system
         spec:
           secretName: oidc-auth-apps-certificate
           duration: 2160h # 90 days
           renewBefore: 360h # 15 days
           issuerRef:
             name: system-local-ca
             kind: ClusterIssuer
           commonName: <OAM_floating_IP_address>
           subject:
             organizations:
               - ABC-Company
             organizationalUnits:
               - StarlingX-system-oidc-auth-apps
           ipAddresses:
           - <OAM_floating_IP_address>
         
         EOF

      2. Apply the configuration.

         ~(keystone_admin)]$ kubectl apply -f oidc-auth-apps-certificate.yaml

      3. Verify the configuration.

         ~(keystone_admin)]$ kubectl get certificate oidc-auth-apps-certificate –n kube-system

      4. Configure the -client with both the Client and Identity Server Certificate and the Client and Identity Trusted certificate.

         Create a secret with the certificate of the root that signed the client and identity provider's server certificate. In this example, it will be the ca.crt of the system-local-ca ClusterIssuer).

         ~(keystone_admin)]$ mkdir /home/sysadmin/ssl
         ~(keystone_admin)]$ kubectl get secret system-local-ca -n cert-manager -o=jsonpath='{.data.ca\.crt}' | base64 --decode > /home/sysadmin/ssl/dex-ca-cert.crt
         
         ~(keystone_admin)]$ kubectl create secret generic dex-ca-cert --from-file=/home/sysadmin/ssl/dex-ca-cert.crt  -n kube-system
         
         ~(keystone_admin)]$ cat <<EOF > stx-oidc-client.yaml
         tlsName: oidc-auth-apps-certificate
         config:
            # The OIDC-client container mounts the dex-ca-cert secret at /home, therefore
            # issuer_root_ca: /home/<filename-only-of-generic-secret>
            issuer_root_ca: /home/dex-ca-cert.crt
            issuer_root_ca_secret: dex-ca-cert
         EOF
         
         ~(keystone_admin)]$ system helm-override-update oidc-auth-apps oidc-client kube-system --values stx-oidc-client.yaml

      5. Create a secret with the certificate of the that signed the certificate of the remote Windows Active Directory server that you will be using.

         Create the secret wad-ca-cert with the 's certificate that signed the Active Directory's certificate using the following command:

         ~(keystone_admin)]$ kubectl create secret generic wad-ca-cert --from-file=ssl/wad-ca-cert.crt -n kube-system

         Add the following sections to your dex helm overrides to configure the Client and Identity Server Certificate and the Windows Active Directory server Certificate for the Identity Server:

         volumeMounts:
         - mountPath: /etc/ssl/certs/adcert
           name: certdir
         - mountPath: /etc/dex/tls
           name: https-tls
         volumes:
         - name: certdir
           secret:
             secretName: wad-ca-cert
         - name: https-tls
           secret:
             defaultMode: 420
             secretName: oidc-auth-apps-certificate

      6. Apply the overrides configuration.

         ~(keystone_admin)]$ system helm-override-update oidc-auth-apps dex kube-system --values dex-overrides.yaml

      7. Configure the secret observer to track changes.

         Change the cronSchedule according to your needs. The cronSchedule controls how often the application checks to see if the certificate mounted on the dex and oidc-client pods had changed.

         Create a YAML configuration to modify the cronSchedule according to your needs.

         The cronSchedule controls how often the application checks to see if the certificate mounted on the dex and oidc-client pods changed. The following example sets the schedule to every 15 minutes.

         ~(keystone_admin)]$ cat <<EOF > secret-observer-overrides.yaml
         cronSchedule: "*/15 * * * *"
         observedSecrets:
           - secretName: "dex-ca-cert"
             filename: "dex-ca-cert.crt"
             deploymentToRestart: "stx-oidc-client"
           - secretName: "oidc-auth-apps-certificate"
             filename: "tls.crt"
             deploymentToRestart: "stx-oidc-client"
           - secretName: "oidc-auth-apps-certificate"
             filename: "tls.crt"
             deploymentToRestart: "oidc-dex"
         EOF

      Execute the following command to update the overrides:

      ~(keystone_admin)]$ system helm-override-update oidc-auth-apps secret-observer kube-system --values secret-observer-overrides.yaml

   2. Use certificates generated and signed by an external .

      Although it is recommended to use cert-manager to manage certificates, as described above in item "Create certificates using cert-manager (recommended)", one can instead use certificates generated by an external .

      For backwards compatibility reasons, the default helm chart overrides of dex, oidc-client and secret-observer in oidc-auth-apps application are set for this example of using externally generated certificates. The default override values of helm charts in oidc-auth-apps application include the use of kubernetes secrets named local-dex.tls, and dex-client-secret for declaring the dex server certificate and the which signed it, respectively. These secrets are created in this example.

      In addition, one can indicate the certificate for an server that has https enabled by using the secret wad-ca-cert as in this example.

      • You must have a signed certificate (dex-cert.pem file), and private key (dex-key.pem file) for the dex Identity Provider of oidc-auth-apps.

        This certificate must have the 's floating IP Address in the list. If you are planning on defining and using a DNS name for the 's floating IP Address, then this DNS name must also be in the list. Refer to the documentation for the external that you are using, in order to create a signed certificate and key.

        If you are using an intermediate to sign the dex certificate, include both the dex certificate (signed by the intermediate ), and the intermediate 's certificate (signed by the Root ) in that order, in dex-cert.pem.

      • You must have the certificate of the (dex-ca.pem file) that signed the above certificate for the dex Identity Provider of oidc-auth-apps.

        If an intermediate was used to sign the dex certificate and both the dex certificate and the intermediate certificate was included in dex-cert.pem, then the dex-ca.pem file should contain the root 's certificate.

        If the signing (dex-ca.pem) is not a well-known trusted , you must ensure the system trusts the by specifying it either during the bootstrap phase of system installation, by specifying ssl_ca_cert: dex-ca.pem in the ansible bootstrap overrides localhost.yml file, or by using the system certificate-install -m ssl_ca dex-ca.pem command.

        Also refer to Add a Trusted CA <add-a-trusted-ca> for installing a root , which includes instruction to lock/unlock controller nodes when using system certificate-install command.

      1. Create the secret, local-dex.tls, with the certificate and key, to be used by the oidc-auth-apps, as well as the secret, dex-client-secret, with the 's certificate that signed the local-dex.tls certificate.

         For example, assuming the cert and key pem files for creating these secrets are in /home/sysadmin/ssl/, run the following commands to create the secrets:

         Note

         oidc-auth-apps looks specifically for secrets of these names in the kube-system namespace.

         For the generic secret dex-client-secret, the filename must be dex-ca.pem.

         ~(keystone_admin)]$ kubectl create secret tls local-dex.tls --cert=ssl/dex-cert.pem --key=ssl/dex-key.pem -n kube-system
         
         ~(keystone_admin)]$ kubectl create secret generic dex-client-secret --from-file=/home/sysadmin/ssl/dex-ca.pem -n kube-system

         Create the secret wad-ca-cert with the 's certificate that signed the Active Directory's certificate using the following command:

         ~(keystone_admin)]$ kubectl create secret generic wad-ca-cert --from-file=ssl/wad-ca-cert.crt -n kube-system

2. Specify user overrides for oidc-auth-apps application, by using the following command:

   ~(keystone_admin)]$ system helm-override-update oidc-auth-apps dex kube-system --values /home/sysadmin/dex-overrides.yaml --reuse-values

   The dex-overrides.yaml file contains the desired dex helm chart overrides (that is, the connector configuration for the Active Directory service, optional token expiry, and so on), and volume mounts for providing access to the wad-ca-cert secret, described in this section.

   For the complete list of dex helm chart values supported, see Dex Helm Chart Values. For the complete list of parameters of the dex connector configuration, see Authentication Through LDAP.

   The overall Dex documentation is available on dexidp.io. The configuration of dex server version v2.31.1 is described on github (https://github.com/dexidp/dex/blob/v2.31.1/config.yaml.dist) with example config.dev.yaml (https://github.com/dexidp/dex/blob/v2.31.1/config.dev.yaml).

   The example below configures a token expiry of ten hours, a single connector to an Active Directory service using HTTPS (LDAPS) using the wad-ca-cert secret configured in this section, the required Active Directory service login information (that is, bindDN, and bindPW), and example userSearch, and groupSearch clauses.

   (Optional) There is a default secret in the dex configuration for staticClients. You can change this using helm overrides. For example, to change the secret, first run the following command to see the default settings. In this example, 10.10.10.2 is the floating IP address.

   ~(keystone_admin)]$ system helm-override-show oidc-auth-apps dex kube-system
   
   config:
     staticClients:
     - id: stx-oidc-client-app
       name: STX OIDC Client app
       redirectURIs: ['https://10.10.10.2:30555/callback']
       secret: St8rlingX

   Change the secret from the output and copy the entire configuration section shown above in to your dex overrides file shown in the example below.

   Warning

   Do not forget to include the id, name, and redirectURIs parameters.

   Note

   There is an internal client_secret that is used between the oidc-client container and the dex container. It is recommended that you configure a unique, more secure client_secret by specifying the value in the dex overrides file, as shown in the example below.

   config:
     staticClients:
     - id: stx-oidc-client-app
       name: STX OIDC Client app
       redirectURIs: ['<OAM floating IP address>/callback']
       secret: BetterSecret
     client_secret: BetterSecret
     expiry:
       idTokens: "10h"
     connectors:
     - type: ldap
       name: OpenLDAP
       id: ldap
       config:
         host: pv-windows-acti.windows-activedir.example.com:636
         rootCA: /etc/ssl/certs/adcert/wad-ca-cert.crt
         insecureNoSSL: false
         insecureSkipVerify: false
         bindDN: cn=Administrator,cn=Users,dc=windows-activedir,dc=example,dc=com
         bindPW: [<password>]
         usernamePrompt: Username
         userSearch:
           baseDN: ou=Users,ou=Titanium,dc=windows-activedir,dc=example,dc=com
           filter: "(objectClass=user)"
           username: sAMAccountName
           idAttr: sAMAccountName
           emailAttr: sAMAccountName
           nameAttr: displayName
         groupSearch:
           baseDN: ou=Groups,ou=Titanium,dc=windows-activedir,dc=example,dc=com
           filter: "(objectClass=group)"
           userAttr: DN
           groupAttr: member
           nameAttr: cn
   volumeMounts:
   - mountPath: /etc/ssl/certs/adcert
     name: certdir
   - mountPath: /etc/dex/tls
     name: https-tls
   volumes:
   - name: certdir
     secret:
       secretName: wad-ca-cert
   - name: https-tls
     secret:
       defaultMode: 420
       secretName: oidc-auth-apps-certificate

   If more than one Windows Active Directory service is required for authenticating the different users of the , multiple ldap type connectors can be configured; one for each Windows Active Directory service.

   If more than one userSearch plus groupSearch clauses are required for the same Windows Active Directory service, multiple ldap type connectors, with the same host information but different userSearch plus groupSearch clauses, should be used.

   Whenever you use multiple ldap type connectors, ensure you use unique name: and id: parameters for each connector.

3. An override in the secrets in the dex helm chart must be accompanied by an override in the oidc-client helm chart.

   The following override is sufficient for changing the secret in the /home/sysadmin/oidc-client-overrides.yaml file.

   config:
     client_secret: BetterSecret

   Apply the oidc-client overrides using the following command:

   ~(keystone_admin)]$ system helm-override-update oidc-auth-apps oidc-client kube-system --values /home/sysadmin/oidc-client-overrides.yaml --reuse-values

   Note

   If you need to manually override the secrets, the client_secret in the oidc-client overrides must match the staticClients secret and client_secret in the dex overrides, otherwise the oidc-auth client will not function.

4. Use the system application-apply command to apply the configuration:

   ~(keystone_admin)]$ system application-apply oidc-auth-apps

Default helm overrides for oidc-auth-apps application

For backwards compatibility reasons, the default helm overrides for dex helm are:

Note

It is NOT recommended to use these; it is recommended to create certificates using cert-manager and explicitly refer to the resulting certificate secrets in user-specified helm overrides, as described on the procedure above.

image:
  repository: ghcr.io/dexidp/dex
  pullPolicy: IfNotPresent
  tag: v2.31.1
imagePullSecrets:
  - name: default-registry-key
env:
  name: KUBERNETES_POD_NAMESPACE
  value: kube-system
config:
  issuer: https://<OAM_IP>:30556/dex
  staticClients:
  - id: stx-oidc-client-app
    name: STX OIDC Client app
    secret: St8rlingX
    redirectURIs:
    - https://<OAM_IP>:30555/callback
  enablePasswordDB: false
  web:
    tlsCert: /etc/dex/tls/tls.crt
    tlsKey: /etc/dex/tls/tls.key
  storage:
    type: kubernetes
    config:
      inCluster: true
  oauth2:
    skipApprovalScreen: true
  logger:
    level: debug
service:
  type: NodePort
  ports:
    https:
      nodePort: 30556
https:
  enabled: true
grpc:
  enabled: false
nodeSelector:
  node-role.kubernetes.io/control-plane: ""
volumeMounts:
- mountPath: /etc/dex/tls/
  name: https-tls
volumes:
- name: https-tls
  secret:
    defaultMode: 420
    secretName: local-dex.tls
tolerations:
- key: "node-role.kubernetes.io/master"
  operator: "Exists"
  effect: "NoSchedule"
- key: "node-role.kubernetes.io/control-plane"
  operator: "Exists"
  effect: "NoSchedule"
affinity:
  podAntiAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
    - labelSelector:
        matchExpressions:
        - key: app
          operator: In
          values:
          - dex
      topologyKey: kubernetes.io/hostname

The default helm overrides for oidc-client are:

config:
  client_id: stx-oidc-client-app
  client_secret: St8rlingX
  issuer: https://<OAM_IP>:30556/dex
  issuer_root_ca: /home/dex-ca.pem
  listen: https://0.0.0.0:5555
  redirect_uri: https://<OAM_IP>:30555/callback
  tlsCert: /etc/dex/tls/https/server/tls.crt
  tlsKey: /etc/dex/tls/https/server/tls.key
nodeSelector:
  node-role.kubernetes.io/control-plane: ""
service:
  type: NodePort
  port: 5555
  nodePort: 30555
replicas: <replicate count>
tolerations:
- key: "node-role.kubernetes.io/master"
  operator: "Exists"
  effect: "NoSchedule"
- key: "node-role.kubernetes.io/control-plane"
  operator: "Exists"
  effect: "NoSchedule"
affinity:
  podAntiAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
    - labelSelector:
        matchExpressions:
        - key: app
          operator: In
          values:
          - stx-oidc-client
      topologyKey: kubernetes.io/hostname
helmv3Compatible: true

The default helm overrides for secret-observer are:

namespace: "kube-system"
observedSecrets:
  - secretName: "dex-client-secret"
    filename: "dex-ca.pem"
    deploymentToRestart: "stx-oidc-client"
  - secretName: "local-dex.tls"
    filename: "tls.crt"
    deploymentToRestart: "stx-oidc-client"
  - secretName: "local-dex.tls"
    filename: "tls.crt"
    deploymentToRestart: "oidc-dex"
tolerations:
  - key: "node-role.kubernetes.io/master"
    operator: "Exists"
    effect: "NoSchedule"
  - key: "node-role.kubernetes.io/control-plane"
    operator: "Exists"
    effect: "NoSchedule"