Certificates

Gluu Community Edition

Certificates in Chroot

Gluu Server components have cryptographic keys and X.509 certificates that are stored inside thechroot. Details for certificates associated with each component are provided below. The following certificates are available in the /etc/certs folder.

IDP	Shibboleth	APACHE	OPENDJ
idp-encryption.crt	shibIDP.crt	httpd.crt	opendj.crt
idp-encryption.csr	shibIDP.csr	https.csr	opendj.pksc12
idp-encryption.key	shibIDP.jks	httpd.key
idp-encryption.key.orig	shibIDP.key	httpd.key.orig
idp-signing.crt	shibIDP.key.orig
idp-signing.csr	shibIDP.pkcs12
idp-signing.key
idp-signing.key.orig

The certificates for Passport authentication are passport-rp.jks, passport-rp.pem, passport-rs.jks.

The SCIM certificate is named scim-rs.jks and the OTP certificate is named otp_configuration.json.

Custom Script JSON Files

Additionally the following json files are available which are used in different custom scripts for multi-factor authentication.

• cert_creds.json
• duo_creds.json
• gplus_client_secrets.json
• otp_configuration.json
• oxauth-keys.json
• super_gluu_creds.json
• vericloud_gluu_creds.json

Generating Cryptographic Keys

The Gluu Server is compatible with the Java KeyGenerator to create new cryptographic keys if needed.

To get KeyGenerator, run the following command inside the chroot:

wget  https://ox.gluu.org/maven/org/gluu/oxauth-client/4.2.0.Final/oxauth-client-4.2.0.Final-jar-with-dependencies.jar -O oxauth-client.jar

Then, run KeyGenerator with the following command:

java -jar oxauth-client.jar <arguments>

The Gluu implementation of KeyGenerator accepts the following arguments:

Argument	Description
-at	oxEleven Access Token
-dnname	DN of certificate issuer
-enc_keys	Encryption keys to generate (For example: RSA_OAEP, RSA1_5)
-expiration	Expiration in days
-expiration_hours	Expiration in hours
-h	Show help
-keypasswd	Key Store password
-keystore	Key Store file (such as /etc/certs/api-rs.jks)
-ox11	oxEleven Generate Key Endpoint.
-sig_keys	Signature keys to generate. (For example: RS256 RS384 RS512 ES256 ES384 ES512 PS256 PS384 PS512)

Certificates in oxTrust

Certificates commonly used for SSO typically have a short expiration date, and can now be easily viewed and downloaded in oxTrust. Navigate to Configuration > Certificates to access these certificates.

The following are available:

• OpenDJ SSL
• httpd SSL
• IDP Signing
• IDP Encryption

Updating Apache Certificate

The certificates must be manually updated from the /etc/certs/ folder.

There are many tools that can be used to update and renew certificates. By default Gluu uses OpenSSL. If you have questions about using other tools, like Let'sEncrypt, check the Gluu support portal for existing threads. If there is no existing information, sign up and open a ticket.

Warning

The private key cannot be password protected, and the public key must be base64 X.509.

Note

Please backup your full /etc/certs directory and cacerts file under /opt/jdkx.y.z/jre/lib/security/ folder before updating certificates.

Please follow these steps shown below to update the Apache SSL cert:

• Save the latest SSL httpd key and certificate in the /etc/certs folder
• Rename them to httpd.key and httpd.crt respectively
• Import 'httpd.der' into the Java Keystore / Convertion to DER, command:
  openssl x509 -outform der -in httpd.crt -out httpd.der
  • Delete the existing certificate to avoid ambiguity due to presence of 2 different certificates for the same entity after importing the new one: /opt/amazon-corretto-x.x.x.x-linux-x64/bin/keytool -delete -alias <hostname_of_your_Gluu_Server>_httpd -keystore /opt/amazon-corretto-x.x.x.x/lib/security/cacerts -storepass changeit
  • Import certificate into the Java Keystore(cacerts): /opt/amazon-corretto-x.x.x.x/bin/keytool -importcert -file httpd.der -keystore /opt/amazon-corretto-x.x.x.x/lib/security/cacerts -alias <hostname_of_your_Gluu_Server>_httpd -storepass changeit
• Restart opendj, apache2/httpd, oxauth and identity services.

Install Intermediate Certificates

Please follow the steps below to install intermediate certificates:

1. Log in to the Gluu Server container.
2. Keep your intermediate certificate in the file /etc/certs/.
3. Modify /etc/apache2/sites-available/https_gluu.conf, and add
   SSLCertificateChainFile /etc/certs/name_of_your_interm_root_cert.crt.
4. Restart the httpd service.

Gluu Cloud Native Edition

Rotating Certificates and Keys in Kubernetes setup

Cert and Key Rotation in a Cloud Native Multi Cluster/Region Environment

Note

In a multi-cluster environment, rotation of certs and keys should only be done in one cluster region. If the secret and config layer aren't central, the secret and configmap should then be moved to other regions by first saving them into a file and applying them on the second or subsequent clusters.

First get both the secret and configmap and save them into files on the cluster where the rotation was done

kubectl get secret gluu -n gluu -o yaml > gluu-secret.yaml kubectl get cm gluu -n gluu -o yaml > gluu-cm.yaml

Apply them on the other cluster(s) in other regions

kubectl apply -f gluu-secret.yaml -n gluu kubectl apply -f gluu-cm.yaml -n gluu

Note

gluu-config-cm in all examples below refer to gluus installation configuration parameters. This name is correct in Kustomization installation, however in Helm the name is in the format of <helms release name>-config-cm and must be changed.

web (ingress)

Associated certificates and keys
/etc/certs/gluu_https.crt
/etc/certs/gluu_https.key

Rotate

1. Create a file named web-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: web-key-rotation
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "false"                  
       spec:
         restartPolicy: Never
         containers:
           - name: web-key-rotation
             image: gluufederation/certmanager:4.2.3_07
             envFrom:
             - configMapRef:
                 name: gluu-config-cm # This may be differnet in Helm
             args: ["patch", "web"]
   

2. Apply job

       kubectl apply -f web-key-rotation.yaml -n <gluu-namespace>
   

Load from exisitng source

Note

This will load gluu_https.crt and gluu_https.key from /etc/certs.

1. Create a secret with gluu_https.crt and gluu_https.key. Note that this may already exist in your deployment.

       kubectl create secret generic web-cert-key --from-file=gluu_https.crt --from-file=gluu_https.key -n <gluu-namespace>` 
   

2. Create a file named load-web-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: load-web-key-rotation
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "false"                  
       spec:
         restartPolicy: Never
         volumes:
         - name: web-cert
           secret:
             secretName: web-cert-key
             items:
               - key: gluu_https.crt
                 path: gluu_https.crt
         - name: web-key
           secret:
             secretName: web-cert-key
             items:
               - key: gluu_https.key
                 path: gluu_https.key                              
         containers:
           - name: load-web-key-rotation
             image: gluufederation/certmanager:4.2.3_07
             envFrom:
             - configMapRef:
                 name: gluu-config-cm  #This may be differnet in Helm
             volumeMounts:
               - name: web-cert
                 mountPath: /etc/certs/gluu_https.crt
                 subPath: gluu_https.crt
               - name: web-key
                 mountPath: /etc/certs/gluu_https.key
                 subPath: gluu_https.key
             args: ["patch", "web", "--opts", "source:from-files"]
   

3. Apply job

       kubectl apply -f load-web-key-rotation.yaml -n <gluu-namespace>
   

oxAuth

Warning

Key rotation cronJob is usually installed with Gluu. Please make sure before deploying kubectl get cronjobs -n <gluu-namespace>.

Associated certificates and keys
/etc/certs/oxauth-keys.json
/etc/certs/oxauth-keys.jks

1. Create a file named oxauth-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   kind: CronJob
   apiVersion: batch/v1beta1
   metadata:
     name: oxauth-key-rotation
   spec:
     schedule: "0 */48 * * *"
     concurrencyPolicy: Forbid
     jobTemplate:
       spec:
         template:
           metadata:
             annotations:
               sidecar.istio.io/inject: "false"
           spec:
             containers:
               - name: oxauth-key-rotation
                 image: gluufederation/certmanager:4.2.3_07
                 env:
                   - name: GLUU_CONTAINER_MAIN_NAME
                     value: "oxauth" # Place oxauth container name 
                 resources:
                   requests:
                     memory: "300Mi"
                     cpu: "300m"
                   limits:
                     memory: "300Mi"
                     cpu: "300m"
                 envFrom:
                   - configMapRef:
                       name: gluu-config-cm
                 args: ["patch", "oxauth", "--opts", "interval:48", "--opts", "key-strategy:OLDER", "--opts", "privkey-push-delay:300", "--opts", "privkey-push-strategy:NEWER"]
                 #volumeMounts:
                 #- mountPath: /etc/gluu/conf/couchbase_password 
                 #  name: cb-pass
                 #  subPath: couchbase_password
                 #- mountPath: /etc/certs/couchbase.crt
                 #  name: cb-crt
                 #  subPath: couchbase.crt
             restartPolicy: Never
             #volumes:
             #- name: cb-pass
             #  secret:
             #    secretName: cb-pass
             #- name: cb-crt
             #  secret:
             #    secretName: cb-crt
   

Warning

Key rotation cronJob will try to push oxauth-keys.jks and oxauth-keys.json to oxAuth pods. If the service account user does not have permissions to list pods the above will fail with a 403 Forbidden message. This action can be disabled forcing oxAuth pods to pull from Kubernetes Secrets instead by setting the enviornment variable GLUU_SYNC_JKS_ENABLED to true inside the main config map i.e gluu-config-cm and adding to the args of the above yaml "--opts", "push-to-container:false" so the args section would look like args: ["patch", "oxauth", "--opts", "interval:48", "--opts", "push-to-container:false"].

1. Apply cron job

       kubectl apply -f oxauth-key-rotation.yaml -n <gluu-namespace>
   

oxShibboleth

Associated certificates and keys
/etc/certs/shibIDP.crt
/etc/certs/shibIDP.key
/etc/certs/shibIDP.jks
/etc/certs/sealer.jks
/etc/certs/sealer.kver
/etc/certs/idp-signing.crt
/etc/certs/idp-signing.key
//etc/certs/idp-encryption.crt
/etc/certs/idp-encryption.key

1. Create a file named oxshibboleth-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: oxshibboleth-key-rotation
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "false"              
       spec:
         restartPolicy: Never
         containers:
           - name: oxshibboleth-key-rotation
             image: gluufederation/certmanager:4.2.3_07
             envFrom:
             - configMapRef:
                 name: gluu-config-cm
             args: ["patch", "oxshibboleth"]
   

2. Apply job

       kubectl apply -f oxshibboleth-key-rotation.yaml -n <gluu-namespace>
   

oxd oAuth client

Associated certificates and keys
/etc/certs/oxd_application.crt
/etc/certs/oxd_application.key
/etc/certs/oxd_application.keystore
/etc/certs/oxd_admin.crt
/etc/certs/oxd_admin.key
/etc/certs/oxd_admin.keystore

Note

Application common name must match oxd service name. kubectl get svc -n <gluu-namespace>. We assume it to be oxd-server below.

1. Create a file named oxd-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: oxd-key-rotation
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "false"              
       spec:
         restartPolicy: Never
         containers:
           - name: oxd-key-rotation
             image: gluufederation/certmanager:4.2.3_07
             envFrom:
             - configMapRef:
                 name: gluu-config-cm
             # Change application-cn:oxd-server and admin-cn:oxd-server to match oxd service name
             args: ["patch", "oxd", "--opts", "application-cn:oxd-server", "--opts", "admin-cn:oxd-server"]
   

2. Apply job

       kubectl apply -f oxd-key-rotation.yaml -n <gluu-namespace>
   

ldap

Note

Subject Alt Name must match opendj service.

Associated certificates and keys
/etc/certs/opendj.crt
/etc/certs/opendj.key
/etc/certs/opendj.pem
/etc/certs/opendj.pkcs12

1. Create a file named ldap-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: ldap-key-rotation
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "false"              
       spec:
         restartPolicy: Never
         containers:
           - name: ldap-key-rotation
             image: gluufederation/certmanager:4.2.3_07
             envFrom:
             - configMapRef:
                 name: gluu-config-cm
             args: ["patch", "ldap", "--opts", "subj-alt-name:opendj"] 
   

2. Apply job

       kubectl apply -f ldap-key-rotation.yaml -n <gluu-namespace>
   

3. Restart pods.

passport

Associated certificates and keys
/etc/certs/passport-rs.jks
/etc/certs/passport-rs-keys.json
/etc/certs/passport-rp.jks
/etc/certs/passport-rp-keys.json
/etc/certs/passport-rp.pem
/etc/certs/passport-sp.key
/etc/certs/passport-sp.crt

1. Create a file named passport-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: passport-key-rotation
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "false"              
       spec:
         restartPolicy: Never
         containers:
           - name: passport-key-rotation
             image: gluufederation/certmanager:4.2.3_07
             envFrom:
             - configMapRef:
                 name: gluu-config-cm
             args: ["patch", "passport"]
   

2. Apply job

       kubectl apply -f passport-key-rotation.yaml -n <gluu-namespace>
   

scim

Associated certificates and keys
/etc/certs/scim-rs.jks
/etc/certs/scim-rs-keys.json
/etc/certs/scim-rp.jks
/etc/certs/scim-rp-keys.json

1. Create a file named scim-key-rotation.yaml with the following contents :

   # License terms and conditions for Gluu Cloud Native Edition:
   # https://www.apache.org/licenses/LICENSE-2.0
   apiVersion: batch/v1
   kind: Job
   metadata:
     name: scim-key-rotation
   spec:
     template:
       metadata:
         annotations:
           sidecar.istio.io/inject: "false"              
       spec:
         restartPolicy: Never
         containers:
           - name: scim-key-rotation
             image: gluufederation/certmanager:4.2.3_07
             envFrom:
             - configMapRef:
                 name: gluu-config-cm
             args: ["patch", "scim"]
   

2. Apply job

       kubectl apply -f scim-key-rotation.yaml -n <gluu-namespace>