Skip to content

Latest commit

 

History

History
251 lines (212 loc) · 7.9 KB

README.md

File metadata and controls

251 lines (212 loc) · 7.9 KB
Raw

Table of Contents

References

Instructions

Requirements

To generate locally the certificate and key, the following tools are needed:

  • openssl
  • keytool

To generate on kubernetes the certificate and keys, install the certificate manager project

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.0/cert-manager.yaml

or 

helm repo add jetstack https://charts.jetstack.io
helm install \
  cert-manager jetstack/cert-manager \
  --namespace cert-manager \
  --create-namespace \
  --set installCRDs=true

Create a pkcs12 using cert manager

The scenario to follow to populate the needed files (ca.crt, tls.crt, tls.key and keystore.p12) using the Certificate Manager and selfsigned certificate is quite simple and will need to create a:

  • Keystore secret
  • Certificate CR containing the information about the hostname, machine to secure using HTTPS/TLS
  • Self signed Issuer CR

Some scripts have been created to simplify this process

HOSTNAME=localhost \
NAMESPACE=demo \
STORE_PASSWORD=supersecret \
./scripts/gen-ca-selfsign-cert-manager.sh

Here is an example detailing what we must do to deploy such CRs on a k8s cluster:

kubectl create ns demo
kubectl delete clusterissuer/selfsigned-issuer
kubectl delete certificate/snowdrop-dev -n demo
kubectl delete secret/pkcs12-pass -n demo
kubectl delete secret/tls-secret -n demo
cat <<EOF | kubectl apply -f -
---
apiVersion: v1
kind: Secret
metadata:
  name: pkcs12-pass
  namespace: demo
data:
  password: c3VwZXJzZWNyZXQ=
type: Opaque  
---  
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: selfsigned-issuer
spec:
  selfSigned: {}
and Certificate:
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
  name: snowdrop-dev
  namespace: demo
spec:
  commonName: snowdrop.dev
  subject:
    organizationalUnits:
    - Snowdrop
    organizations:
    - "Red Hat"
    localities:
    - Florennes
    provinces:
    - Namur
    countries:
    - BE
  dnsNames:
  - snowdrop.dev
  - www.snowdrop.dev
  duration: 2160h0m0s
  issuerRef:
    kind: ClusterIssuer
    name: selfsigned-issuer
  privateKey:  
    algorithm: RSA
    encoding: PKCS8
    size: 2048
  keystores:
    pkcs12:
      create: true
      passwordSecretRef:
        name: pkcs12-pass
        key: password  
  renewBefore: 360h0m0s
  secretName: tls-secret
  usages:
  - server auth
  - client auth
EOF

To read the content of the generated certificates (CA and TLS), use the following commands:

./scripts/get_cert_from_secret.sh ca.crt
./scripts/get_cert_from_secret.sh tls.crt

cat _temp/cert-manager/ca.crt | openssl x509 -noout -text > _temp/cert-manager/ca.crt.txt
cat _temp/cert-manager/tls.crt | openssl x509 -noout -text > _temp/cert-manager/tls.crt.txt

and next check the content generated under _temp/cert-manager/

NOTE: As the script or the instructions will generate a Certificate using hard values, then I recommand that you look to the next section in order to generate it using the YTT template

Generate the Certificate and Issuer using ytt

To generate within the terminal the Certificate and Issuer YAML, simply execute the following ytt command

ytt -f ytt-template

NOTE: Change the needed values within your my-values.yml file or pass the parameters from the command line such as:

cat <<EOF > my-values.yml
name: spring-boot
certificate:
  commonName: spring-boot.10.20.1.1.nip.io
  dnsNames:
  - spring-boot.10.20.1.1.nip.io
  keystores:
    type: pkcs12
    passwordSecretRef:
      name: pkcs12-secret
      key: password
EOF

ytt --data-values-file my-values.yml -f ytt-template

OR

ytt -f ytt-template \
    -v name=spring-boot \
    -v certificate.commonName=spring-boot.10.20.1.1.nip.io \
    --data-value-yaml "certificate.dnsNames=[spring-boot.10.20.1.1.nip.io]"

Demo

To play with the keystore and trustore populated use the following demo projects:

Generate the CA & Server certificate and their keys locally

See the all-in-one instructions script: gen-ca-selfsign-import.sh

Generate ca certificate and key file

openssl genrsa -out ca/ca.key 2048
openssl req -x509 -new \
    -nodes \
    -sha256 \
    -days 3650 \
    -subj '/CN=CA Authory/O=Red Hat/L=Florennes/C=BE' \
    -key ca/ca.key \
    -out ca/ca.crt

Generate client key & certificate signing request"

# Could be done with one command
openssl genrsa -out cert/tls.key 2048
openssl req -new -key cert/tls.key -subj '/CN=www.snowdrop.dev/O=Red Hat/L=Florennes/C=BE' -out cert/tls.csr

echo "Sign CSR with CA"
openssl x509 -req -in cert/tls.csr -CA ca/ca.crt -CAkey ca/ca.key -CAcreateserial -out cert/tls.pem -days 1024 -sha256

Combine your key and certificate in a PKCS#12 (P12) bundle

openssl pkcs12 -inkey cert/tls.key -in cert/tls.pem -CAfile cert/ca.crt -chain -passin pass:password -passout pass:password -export -out cert/tls.p12

Generate jks file from p12 file

keytool -importkeystore -srckeystore cert/tls.p12 -srcstoretype pkcs12 -srcstorepass password -deststorepass password -destkeystore cert/tls.jks

Interesting commands

To check the content of the store

keytool -list -storetype PKCS12 -keystore cert/snowdrop.p12 -storepass password 
OR 
openssl pkcs12 -info -in cert/snowdrop.p12 -passin pass:password -passout pass:password

To export the private key

openssl pkcs12 -in cert/snowdrop.p12 -passin pass:password -passout pass:password -nocerts -nodes | openssl pkcs8 -nocrypt -out cert/sowdrop.key

To export the client and CA certificate

openssl pkcs12 -in cert/snowdrop.p12 -passin pass:password -passout pass:password -clcerts -nokeys | openssl x509 -out cert/snowdrop.crt
openssl pkcs12 -in cert/snowdrop.p12 -passin pass:password -passout pass:password -cacerts -nokeys -chain | openssl x509 -out cert/ca.crt

To export the public key

openssl x509 -pubkey -in cert/snowdrop.crt -noout > cert/snowdrop_pub.key

Additional information

For generating our keystore in a JKS format, we can use the following command: keytool -genkeypair -alias snowdrop -keyalg RSA -keysize 2048 -keystore snowdrop.jks -storepass password -validity 3650

Note: We recommend using the PKCS12 format, which is an industry standard format !

So in case we already have a JKS keystore, we can convert it to PKCS12 format using the following command: keytool -importkeystore -srckeystore baeldung.jks -destkeystore baeldung.p12 -deststoretype pkcs12

Note: We'll have to provide the source keystore password and also set a new keystore password. The alias and keystore password will be needed later.