Chapter 1. Red Hat OpenShift Container Platform
1.1. Protect your signing data Copy linkLink copied to clipboard!
As a systems administrator, protecting the signing data of your software supply chain is critical when there is data loss due to hardware failure or accidental data deletion.
The OpenShift API Data Protection (OADP) product provides data protection to applications running on Red Hat OpenShift Container Platform. By using the OADP product, this can help us get the software developers back to signing and verifying code as quickly as possible. After installing and configuring the OADP operator you can start backing up and restoring your Red Hat Trusted Artifact Signer (RHTAS) data.
1.1.1. Installing and configuring the OADP Operator Copy linkLink copied to clipboard!
The OpenShift API Data Protection (OADP) Operator gives you the ability to backup OpenShift application resources and internal container images. You can use the OADP Operator to backup and restore your Trusted Artifact Signer data.
This procedure uses Amazon Web Services (AWS) Simple Storage Service (S3) to create a bucket for illustrating how to configure the OADP operator. You can choose to use a different supported S3-compatible object storage platform instead of AWS, such as Red Hat OpenShift Data Foundation.
Prerequisites
- Red Hat OpenShift Container Platform 4.15 or later.
-
Access to the OpenShift web console with the
cluster-admin
role. - The ability to create an S3-compatible bucket.
-
A workstation with the
oc
, andaws
binaries installed.
Procedure
Open a terminal on your workstation, and log in to OpenShift:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Create a new bucket:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new user:
aws iam create-user --user-name $USER
$ aws iam create-user --user-name $USER
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new policy:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Associate this policy to the new user:
aws iam put-user-policy \ --user-name $USER \ --policy-name velero \ --policy-document file://velero-policy.json
$ aws iam put-user-policy \ --user-name $USER \ --policy-name velero \ --policy-document file://velero-policy.json
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create an access key:
aws iam create-access-key --user-name $USER --output=json | jq -r '.AccessKey | [ "export AWS_ACCESS_KEY_ID=" + .AccessKeyId, "export AWS_SECRET_ACCESS_KEY=" + .SecretAccessKey ] | join("\n")'
$ aws iam create-access-key --user-name $USER --output=json | jq -r '.AccessKey | [ "export AWS_ACCESS_KEY_ID=" + .AccessKeyId, "export AWS_SECRET_ACCESS_KEY=" + .SecretAccessKey ] | join("\n")'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a credentials file with your AWS secret key information:
cat << EOF > ./credentials-velero [default] aws_access_key_id=$AWS_ACCESS_KEY_ID aws_secret_access_key=$AWS_SECRET_ACCESS_KEY EOF
$ cat << EOF > ./credentials-velero [default] aws_access_key_id=$AWS_ACCESS_KEY_ID aws_secret_access_key=$AWS_SECRET_ACCESS_KEY EOF
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Log in to the OpenShift web console with a user that has the
cluster-admin
role. - From the Administrator perspective, expand the Operators navigation menu, and click OperatorHub.
- In the search field, type oadp, and click the OADP Operator tile provided by Red Hat.
- Click the Install button to show the operator details.
- Accept the default values, click Install on the Install Operator page, and wait for the installation to finish.
After the operator installation finishes, from your workstation terminal, create a secret resource for OpenShift with your AWS credentials:
oc create secret generic cloud-credentials -n openshift-adp --from-file cloud=credentials-velero
$ oc create secret generic cloud-credentials -n openshift-adp --from-file cloud=credentials-velero
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - From the OpenShift web console, click the View Operator button.
- Click Create instance on the DataProtectionApplication (DPA) tile.
- On the Create DataProtectionApplication page, select YAML view.
Edit the following values in the resource file:
-
Under the
metadata
section, replacevelero-sample
withvelero
. -
Under the
spec.configuration.nodeAgent
section, replacerestic
withkopia
. -
Under the
spec.configuration.velero
section, addresourceTimeout: 10m
. -
Under the
spec.configuration.velero.defaultPlugins
section, add- csi
. -
Under the
spec.snapshotLocations
section, replace theus-west-2
value with your AWS regional value. -
Under the
spec.backupLocations
section, replace theus-east-1
value with your AWS regional value. -
Under the
spec.backupLocations.objectStorage
section, replacemy-bucket-name
with your bucket name. Replacevelero
with your bucket prefix name, if you use a different prefix.
-
Under the
- Click the Create button.
1.1.2. Backing up your Trusted Artifact Signer data Copy linkLink copied to clipboard!
With the OpenShift API Data Protection (OADP) operator installed and with an instance deployed, you can create a volume snapshot resource, and a backup resource to backup your Red Hat Trusted Artifact Signer (RHTAS) data.
Prerequisites
- Red Hat OpenShift Container Platform 4.15 or later.
-
Access to the OpenShift web console with the
cluster-admin
role. - Installation of the OADP operator.
-
A workstation with the
oc
binary installed.
Procedure
Open a terminal on your workstation, and log in to OpenShift:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Find and edit the
VolumeSnapshotClass
resource:oc get VolumeSnapshotClass -n openshift-adp oc edit VolumeSnapshotClass csi-aws-vsc -n openshift-adp
$ oc get VolumeSnapshotClass -n openshift-adp $ oc edit VolumeSnapshotClass csi-aws-vsc -n openshift-adp
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the following values in the resource file:
-
Under the
metadata.labels
section, add thevelero.io/csi-volumesnapshot-class: "true"
label. - Save your changes, and quit the editor.
-
Under the
Create a
Backup
resource:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the schedule property to enable Cron scheduling for running this backup. In the example, this backup resource runs everyday at 7:00 a.m.
By default, all resources are backed up within the trusted-artifact-signer namespace. You can specify what resources you want to include or exclude by using the includeResources or excludedResources properties respectively.
ImportantDepending on the storage class of the backup target, persistent volumes cannot be actively in-use for the backup to be successful.
1.1.3. Restoring your Trusted Artifact Signer data Copy linkLink copied to clipboard!
With the Red Hat Trusted Artifact Signer (RHTAS) and OpenShift API Data Protection (OADP) operators installed, and a backup resource for RHTAS namespace, you can restore your data to an OpenShift cluster.
Prerequisites
- Red Hat OpenShift Container Platform version 4.15 or later.
-
Access to the OpenShift web console with the
cluster-admin
role. - Installation of the RHTAS Operator.
- Installation of the OADP Operator.
-
A backup resource of the
trusted-artifact-signer
namespace structure. -
A workstation with the
oc
binary installed.
Procedure
Disable the RHTAS operator:
oc scale deploy rhtas-operator-controller-manager --replicas=0 -n openshift-operators
$ oc scale deploy rhtas-operator-controller-manager --replicas=0 -n openshift-operators
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
Restore
resource:Copy to Clipboard Copied! Toggle word wrap Toggle overflow If restoring your RHTAS data to a different OpenShift cluster, do the following steps.
Delete the secret for the Trillian database:
oc delete secret securesign-sample-trillian-db-tls oc delete pod trillian-db-xxx
$ oc delete secret securesign-sample-trillian-db-tls $ oc delete pod trillian-db-xxx
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThe RHTAS operator recreates the secret and restarts the pod.
-
Run the
restoreOwnerReferences.sh
script.
Enable the RHTAS operator:
oc scale deploy rhtas-operator-controller-manager --replicas=1 -n openshift-operators
$ oc scale deploy rhtas-operator-controller-manager --replicas=1 -n openshift-operators
Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantImmediately starting the RHTAS operator after starting the restore ensures the claim of the persistent volume.
1.2. The Update Framework Copy linkLink copied to clipboard!
As a systems administrator, understanding Red Hat’s implementation of The Update Framework (TUF) for Red Hat Trusted Artifact Signer (RHTAS) is important in helping you to maintaining a secure coding environment for developers. You can refresh TUF’s root and non-root metadata periodically to help prevent mix-and-match attacks on a code base. Refreshing the TUF metadata gives clients the ability to detect and reject outdated or tampered-with files.
1.2.1. Trusted Artifact Signer’s implementation of The Update Framework Copy linkLink copied to clipboard!
Starting with Red Hat Trusted Artifact Signer (RHTAS) version 1.1, we implemented The Update Framework (TUF) as a trust root to store public keys, and certificates used by RHTAS services. The Update Framework is a sophisticated framework for securing software update systems, and this makes it ideal for securing shipped artifacts. The Update Framework refers to the RHTAS services as trusted root targets. There are four trusted targets, one for each RHTAS service: Fulcio, Certificate Transparency (CT) log, Rekor, and Timestamp Authority (TSA). Client software, such as cosign
, use the RHTAS trust root targets to sign and verify artifact signatures. A simple HTTP server distributes the public keys and certificates to the client software. This simple HTTP server has the TUF repository of the individual targets.
By default, when deploying RHTAS on Red Hat OpenShift or Red Hat Enterprise Linux, we create a TUF repository, and prepopulate the individual targets. By default, the expiration date of all metadata files is 52 weeks from the time you deploy the RHTAS service. Red Hat recommends choosing shorter expiration periods, and rotating your public keys and certificates often. Doing these maintenance tasks regularly can help prevent attacks on your code base.
1.2.2. Updating The Update Framework metadata files Copy linkLink copied to clipboard!
By default, The Update Framework (TUF) metadata files expire after 52 weeks from the Red Hat Trusted Artifact Signer (RHTAS) deployment date. At a minimum, you have to update the TUF metadata files at least once every 52 weeks before they expire. Red Hat recommends updating the metadata files more often than once a year.
This procedure walks you through refreshing the root, and non-root metadata files.
Prerequisites
- Installation of the RHTAS operator running on Red Hat OpenShift Container Platform.
- A running Securesign instance.
-
A workstation with the
oc
binary installed.
Procedure
Download the
tuftool
binary from the OpenShift cluster to your workstation.ImportantCurrently, the
tuftool
binary is only available for Linux operating systems on the x86_64 architecture.- From the home page, click the ? icon, click Command line tools, go to the tuftool download section, and click the link for your platform.
Open a terminal on your workstation, decompress the binary
.gz
file, and set the execution bit:gunzip tuftool-amd64.gz chmod +x tuftool-amd64
$ gunzip tuftool-amd64.gz $ chmod +x tuftool-amd64
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Move and rename the binary to a location within your
$PATH
environment:sudo mv tuftool-amd64 /usr/local/bin/tuftool
$ sudo mv tuftool-amd64 /usr/local/bin/tuftool
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Log in to OpenShift from the command line:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Switch to the RHTAS project:
oc project trusted-artifact-signer
$ oc project trusted-artifact-signer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Configure your shell environment:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Set the expiration durations according to your requirements.
Create a temporary TUF directory structure:
mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
$ mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Download the TUF contents to the temporary TUF directory structure:
oc extract --to "${KEYDIR}/" secret/tuf-root-keys oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" cp "${TUF_REPO}/root.json" "${ROOT}"
$ oc extract --to "${KEYDIR}/" secret/tuf-root-keys $ oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" $ cp "${TUF_REPO}/root.json" "${ROOT}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow You can update the timestamp, snapshot, and targets metadata all in one command:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can also run the TUF metadata update on a subset of TUF metadata files. For example, the
timestamp.json
metadata file expires more often than the other metadata files. Therefore, you can just update the timestamp metadata file by running the following command:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Only update the root expiration date if it is about to expire:
tuftool root expire "${ROOT}" "${ROOT_EXPIRATION}"
$ tuftool root expire "${ROOT}" "${ROOT_EXPIRATION}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can skip this step if the root file is not close to expiring.
Update the root version:
tuftool root bump-version "${ROOT}"
$ tuftool root bump-version "${ROOT}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Sign the root metadata file again:
tuftool root sign "${ROOT}" -k "${KEYDIR}/root.pem"
$ tuftool root sign "${ROOT}" -k "${KEYDIR}/root.pem"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Set the new root version, and copy the root metadata file in place:
export NEW_ROOT_VERSION=$(cat "${ROOT}" | jq -r ".signed.version") cp "${ROOT}" "${TUF_REPO}/root.json" cp "${ROOT}" "${TUF_REPO}/${NEW_ROOT_VERSION}.root.json"
$ export NEW_ROOT_VERSION=$(cat "${ROOT}" | jq -r ".signed.version") $ cp "${ROOT}" "${TUF_REPO}/root.json" $ cp "${ROOT}" "${TUF_REPO}/${NEW_ROOT_VERSION}.root.json"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Upload these changes to the TUF server:
oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
$ oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.3. Rotate your certificates and keys Copy linkLink copied to clipboard!
As a systems administrator, you can proactively rotate the certificates and signer keys used by the Red Hat Trusted Artifact Signer (RHTAS) service running on Red Hat OpenShift. Rotating your keys regularly can prevent key tampering, and theft. These procedures guide you through expiring your old certificates and signer keys, and replacing them with a new certificate and signer key for the underlying services that make up RHTAS. You can rotate keys and certificates for the following services:
- Rekor
- Certificate Transparency log
- Fulcio
- Timestamp Authority
1.3.1. Rotating the Rekor signer key Copy linkLink copied to clipboard!
You can proactively rotate Rekor’s signer key by using the sharding feature to freeze the log tree, and create a new log tree with a new signer key. This procedure walks you through expiring your old Rekor signer key, and replacing it with a new signer key for Red Hat Trusted Artifact Signer (RHTAS) to use. Expiring your old Rekor signer key still allows you to verify artifacts signed by the old key.
This procedure requires downtime to the Rekor service.
Prerequisites
- Installation of the RHTAS operator running on Red Hat OpenShift Container Platform.
- A running Securesign instance.
-
A workstation with the
oc
,openssl
, andcosign
binaries installed.
Procedure
Download the
rekor-cli
binary from the OpenShift cluster to your workstation.- Login to the OpenShift web console. From the home page, click the ? icon, click Command line tools, go to the rekor-cli download section, and click the link for your platform.
Open a terminal on your workstation, decompress the binary
.gz
file, and set the execute bit:gunzip rekor-cli-amd64.gz chmod +x rekor-cli-amd64
$ gunzip rekor-cli-amd64.gz $ chmod +x rekor-cli-amd64
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Move and rename the binary to a location within your
$PATH
environment:sudo mv rekor-cli-amd64 /usr/local/bin/rekor-cli
$ sudo mv rekor-cli-amd64 /usr/local/bin/rekor-cli
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Download the
tuftool
binary from the OpenShift cluster to your workstation.ImportantThe
tuftool
binary is only available for Linux operating systems.- From the home page, click the ? icon, click Command line tools, go to the tuftool download section, and click the link for your platform.
From a terminal on your workstation, decompress the binary
.gz
file, and set the execute bit:gunzip tuftool-amd64.gz chmod +x tuftool-amd64
$ gunzip tuftool-amd64.gz $ chmod +x tuftool-amd64
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Move and rename the binary to a location within your
$PATH
environment:sudo mv tuftool-amd64 /usr/local/bin/tuftool
$ sudo mv tuftool-amd64 /usr/local/bin/tuftool
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Log in to OpenShift from the command line:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Switch to the RHTAS project:
oc project trusted-artifact-signer
$ oc project trusted-artifact-signer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the Rekor URL:
export REKOR_URL=$(oc get rekor -o jsonpath='{.items[0].status.url}')
$ export REKOR_URL=$(oc get rekor -o jsonpath='{.items[0].status.url}')
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the log tree identifier for the active shard:
export OLD_TREE_ID=$(rekor-cli loginfo --rekor_server $REKOR_URL --format json | jq -r .TreeID)
$ export OLD_TREE_ID=$(rekor-cli loginfo --rekor_server $REKOR_URL --format json | jq -r .TreeID)
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Set the log tree to the
DRAINING
state:oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=DRAINING
$ oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=DRAINING
Copy to Clipboard Copied! Toggle word wrap Toggle overflow While draining, the tree log will not accept any new entries. Watch and wait for the queue to empty.
ImportantYou must wait for the queues to be empty before proceeding to the next step. If leaves are still integrating while draining, then freezing the log tree during this process can cause the log path to exceed the maximum merge delay (MMD) threshold.
Freeze the log tree:
oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=FROZEN
$ oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=FROZEN
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the length of the frozen log tree:
export OLD_SHARD_LENGTH=$(rekor-cli loginfo --rekor_server $REKOR_URL --format json | jq -r .ActiveTreeSize)
$ export OLD_SHARD_LENGTH=$(rekor-cli loginfo --rekor_server $REKOR_URL --format json | jq -r .ActiveTreeSize)
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get Rekor’s public key for the old shard:
export OLD_PUBLIC_KEY=$(curl -s $REKOR_URL/api/v1/log/publicKey | base64 | tr -d '\n')
$ export OLD_PUBLIC_KEY=$(curl -s $REKOR_URL/api/v1/log/publicKey | base64 | tr -d '\n')
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new log tree:
export NEW_TREE_ID=$(oc run createtree --image registry.redhat.io/rhtas/createtree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- -logtostderr=false --admin_server=trillian-logserver:8091 --display_name=rekor-tree)
$ export NEW_TREE_ID=$(oc run createtree --image registry.redhat.io/rhtas/createtree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- -logtostderr=false --admin_server=trillian-logserver:8091 --display_name=rekor-tree)
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Now you have two log trees, one frozen tree, and a new tree that will become the active shard.
Create a new private key:
openssl ecparam -genkey -name secp384r1 -noout -out new-rekor.pem
$ openssl ecparam -genkey -name secp384r1 -noout -out new-rekor.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantThe new key must have a unique file name.
Create a new secret resource with the new signer key:
oc create secret generic rekor-signer-key --from-file=private=new-rekor.pem
$ oc create secret generic rekor-signer-key --from-file=private=new-rekor.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the Securesign Rekor configuration with the new tree identifier and the old sharding information:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIf you have
/spec/rekor/signer/keyPasswordRef
set with a value, then create a new separate update to remove it:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Apply this update after applying the first update.
Update the Securesign instance:
oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH_1"
$ oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH_1"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait for the Rekor server to redeploy with the new signer key:
oc wait pod -l app.kubernetes.io/name=rekor-server --for=condition=Ready
$ oc wait pod -l app.kubernetes.io/name=rekor-server --for=condition=Ready
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the new public key:
export NEW_KEY_NAME=new-rekor.pub curl $(oc get rekor -o jsonpath='{.items[0].status.url}')/api/v1/log/publicKey -o $NEW_KEY_NAME
$ export NEW_KEY_NAME=new-rekor.pub $ curl $(oc get rekor -o jsonpath='{.items[0].status.url}')/api/v1/log/publicKey -o $NEW_KEY_NAME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Configure The Update Framework (TUF) service to use the new Rekor public key.
Configure your shell environment:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a temporary TUF directory structure:
mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
$ mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Download the TUF contents to the temporary TUF directory structure:
oc extract --to "${KEYDIR}/" secret/tuf-root-keys oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" cp "${TUF_REPO}/root.json" "${ROOT}"
$ oc extract --to "${KEYDIR}/" secret/tuf-root-keys $ oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" $ cp "${TUF_REPO}/root.json" "${ROOT}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Find the active Rekor signer key file name. Open the latest target file, for example,
1.target.json
, within the local TUF repository. In this file you will find the active Rekor signer key file name, for example,rekor.pub
. Set an environment variable with this active Rekor signer key file name:export ACTIVE_KEY_NAME=rekor.pub
$ export ACTIVE_KEY_NAME=rekor.pub
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the Rekor signer key with the old public key:
echo $OLD_PUBLIC_KEY | base64 -d > $ACTIVE_KEY_NAME
$ echo $OLD_PUBLIC_KEY | base64 -d > $ACTIVE_KEY_NAME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expire the old Rekor signer key:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the new Rekor signer key:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Upload these changes to the TUF server:
oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
$ oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the working directory:
rm -r $WORK
$ rm -r $WORK
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Update the
cosign
configuration with the updated TUF configuration:cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
$ cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Now, you are ready to sign and verify your artifacts with the new Rekor signer key.
1.3.2. Rotating the Certificate Transparency log signer key Copy linkLink copied to clipboard!
You can proactively rotate Certificate Transparency (CT) log signer key by using the sharding feature to freeze the log tree, and create a new log tree with a new signer key. This procedure walks you through expiring your old CT log signer key, and replacing it with a new signer key for Red Hat Trusted Artifact Signer (RHTAS) to use. Expiring your old CT log signer key still allows you to verify artifacts signed by the old key.
Prerequisites
- Installation of the RHTAS operator running on Red Hat OpenShift Container Platform.
- A running Securesign instance.
-
A workstation with the
oc
,openssl
, andcosign
binaries installed.
Procedure
Download the
tuftool
binary from the OpenShift cluster to your workstation.ImportantCurrently, the
tuftool
binary is only available for Linux operating systems on the x86_64 architecture.- From the home page, click the ? icon, click Command line tools, go to the tuftool download section, and click the link for your platform.
Open a terminal on your workstation, decompress the binary
.gz
file, and set the execution bit:unzip tuftool-amd64.gz chmod +x tuftool-amd64
$ unzip tuftool-amd64.gz $ chmod +x tuftool-amd64
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Move and rename the binary to a location within your
$PATH
environment:sudo mv tuftool-amd64 /usr/local/bin/tuftool
$ sudo mv tuftool-amd64 /usr/local/bin/tuftool
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Log in to OpenShift from the command line:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Switch to the RHTAS project:
oc project trusted-artifact-signer
$ oc project trusted-artifact-signer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Make a backup of the current CT log configuration, and keys:
export SERVER_CONFIG_NAME=$(oc get ctlog -o jsonpath='{.items[0].status.serverConfigRef.name}') oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.config}" | base64 --decode > config.txtpb oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.fulcio-0}" | base64 --decode > fulcio-0.pem oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.private}" | base64 --decode > private.pem oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.public}" | base64 --decode > public.pem
$ export SERVER_CONFIG_NAME=$(oc get ctlog -o jsonpath='{.items[0].status.serverConfigRef.name}') $ oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.config}" | base64 --decode > config.txtpb $ oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.fulcio-0}" | base64 --decode > fulcio-0.pem $ oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.private}" | base64 --decode > private.pem $ oc get secret $SERVER_CONFIG_NAME -o jsonpath="{.data.public}" | base64 --decode > public.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Capture the current tree identifier:
export OLD_TREE_ID=$(oc get ctlog -o jsonpath='{.items[0].status.treeID}')
$ export OLD_TREE_ID=$(oc get ctlog -o jsonpath='{.items[0].status.treeID}')
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Set the log tree to the
DRAINING
state:oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=DRAINING
$ oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=DRAINING
Copy to Clipboard Copied! Toggle word wrap Toggle overflow While draining, the tree log will not accept any new entries. Watch and wait for the queue to empty.
ImportantYou must wait for the queues to be empty before proceeding to the next step. If leaves are still integrating while draining, then freezing the log tree during this process can cause the log path to exceed the maximum merge delay (MMD) threshold.
Once the queue has been fully drained, freeze the log:
oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=FROZEN
$ oc run --image registry.redhat.io/rhtas/updatetree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- updatetree --admin_server=trillian-logserver:8091 --tree_id=${OLD_TREE_ID} --tree_state=FROZEN
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new Merkle tree, and capture the new tree identifier:
export NEW_TREE_ID=$(kubectl run createtree --image registry.redhat.io/rhtas/createtree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- -logtostderr=false --admin_server=trillian-logserver:8091 --display_name=ctlog-tree)
$ export NEW_TREE_ID=$(kubectl run createtree --image registry.redhat.io/rhtas/createtree-rhel9:1.1.0 --restart=Never --attach=true --rm=true -q -- -logtostderr=false --admin_server=trillian-logserver:8091 --display_name=ctlog-tree)
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Generate a new certificate, along with new public and private keys:
openssl ecparam -genkey -name prime256v1 -noout -out new-ctlog.pem openssl ec -in new-ctlog.pem -pubout -out new-ctlog-public.pem openssl ec -in new-ctlog.pem -out new-ctlog.pass.pem -des3 -passout pass:"CHANGE_ME"
$ openssl ecparam -genkey -name prime256v1 -noout -out new-ctlog.pem $ openssl ec -in new-ctlog.pem -pubout -out new-ctlog-public.pem $ openssl ec -in new-ctlog.pem -out new-ctlog.pass.pem -des3 -passout pass:"CHANGE_ME"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with a new password.
ImportantThe certificate and new keys must have unique file names.
Update the CT log configuration.
-
Open the
config.txtpb
file for editing. For the frozen log, add the
not_after_limit
field to the frozen log entry, rename the prefix value to a unique name, and replace the old path to the private key withctfe-keys/private-0
:Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can get the current time value for seconds and nanoseconds, by running the following commands:
date +%s
, anddate +%N
.ImportantThe
not_after_limit
field defines the end of the timestamp range for the frozen log only. Certificates beyond this point in time are no longer accepted for inclusion in this log.-
Copy and paste the frozen log
config
block, appending it to the configuration file to create a new entry. Change the following lines in the new
config
block. Set thelog_id
to the new tree identifier, change theprefix
totrusted-artifact-signer
, change theprivate_key
path toctfe-keys/private
, remove thepublic_key
line, and changenot_after_limit
tonot_after_start
and set the timestamp range:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the NEW_TREE_ID, and replace CHANGE_ME with the new private key password. The password here must match the password used for generating the new private and public keys.
ImportantThe
not_after_start
field defines the beginning of the timestamp range inclusively. This means the log will start accepting certificates at this point in time.
-
Open the
Create a new secret resource:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with the new private key password.
Configure The Update Framework (TUF) service to use the new CT log public key.
Configure your shell environment:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a temporary TUF directory structure:
mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
$ mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Download the TUF contents to the temporary TUF directory structure:
oc extract --to "${KEYDIR}/" secret/tuf-root-keys oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" cp "${TUF_REPO}/root.json" "${ROOT}"
$ oc extract --to "${KEYDIR}/" secret/tuf-root-keys $ oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" $ cp "${TUF_REPO}/root.json" "${ROOT}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Find the active CT log public key file name. Open the latest target file, for example,
1.targets.json
, within the local TUF repository. In this target file you will find the active CT log public key file name, for example,ctfe.pub
. Set an environment variable with this active CT log public key file name:export ACTIVE_CTFE_NAME=ctfe.pub
$ export ACTIVE_CTFE_NAME=ctfe.pub
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Extract the active CT log public key from OpenShift:
oc get secret $(oc get ctlog securesign-sample -o jsonpath='{.status.publicKeyRef.name}') -o jsonpath='{.data.public}' | base64 -d > $ACTIVE_CTFE_NAME
$ oc get secret $(oc get ctlog securesign-sample -o jsonpath='{.status.publicKeyRef.name}') -o jsonpath='{.data.public}' | base64 -d > $ACTIVE_CTFE_NAME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expire the old CT log signer key:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the new CT log signer key:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Upload these changes to the TUF server:
oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
$ oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Update the Securesign CT log configuration with the new tree identifier:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Patch the Securesign instance:
oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH"
$ oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait for the CT log server to redeploy:
oc wait pod -l app.kubernetes.io/name=ctlog --for=condition=Ready
$ oc wait pod -l app.kubernetes.io/name=ctlog --for=condition=Ready
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the working directory:
rm -r $WORK
$ rm -r $WORK
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the
cosign
configuration with the updated TUF configuration:cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
$ cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Now, you are ready to sign and verify your artifacts with the new CT log signer key.
1.3.3. Rotating the Fulcio certificate Copy linkLink copied to clipboard!
You can proactively rotate the certificate used by the Fulcio service. This procedure walks you through expiring your old Fulcio certificate, and replacing it with a new certificate for Red Hat Trusted Artifact Signer (RHTAS) to use. Expiring your old Fulcio certificate still allows you to verify artifacts signed by the old certificate.
Prerequisites
- Installation of the RHTAS operator running on Red Hat OpenShift Container Platform.
- A running Securesign instance.
-
A workstation with the
oc
,openssl
, andcosign
binaries installed.
Procedure
Download the
tuftool
binary from the OpenShift cluster to your workstation.ImportantCurrently, the
tuftool
binary is only available for Linux operating systems on the x86_64 architecture.- From the home page, click the ? icon, click Command line tools, go to the tuftool download section, and click the link for your platform.
Open a terminal on your workstation, decompress the binary
.gz
file, and set the execution bit:gunzip tuftool-amd64.gz chmod +x tuftool-amd64
$ gunzip tuftool-amd64.gz $ chmod +x tuftool-amd64
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Move and rename the binary to a location within your
$PATH
environment:sudo mv tuftool-amd64 /usr/local/bin/tuftool
$ sudo mv tuftool-amd64 /usr/local/bin/tuftool
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Log in to OpenShift from the command line:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Switch to the RHTAS project:
oc project trusted-artifact-signer
$ oc project trusted-artifact-signer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Generate a new certificate, along with new public and private keys:
openssl ecparam -genkey -name prime256v1 -noout -out new-fulcio.pem openssl ec -in new-fulcio.pem -pubout -out new-fulcio-public.pem openssl ec -in new-fulcio.pem -out new-fulcio.pass.pem -des3 -passout pass:"CHANGE_ME" openssl req -new -x509 -key new-fulcio.pass.pem -out new-fulcio.cert.pem
$ openssl ecparam -genkey -name prime256v1 -noout -out new-fulcio.pem $ openssl ec -in new-fulcio.pem -pubout -out new-fulcio-public.pem $ openssl ec -in new-fulcio.pem -out new-fulcio.pass.pem -des3 -passout pass:"CHANGE_ME" $ openssl req -new -x509 -key new-fulcio.pass.pem -out new-fulcio.cert.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with a new password.
ImportantThe certificate and new keys must have unique file names.
Create a new secret:
oc create secret generic fulcio-config \ --from-file=private=new-fulcio.pass.pem \ --from-file=cert=new-fulcio.cert.pem \ --from-literal=password=CHANGE_ME
$ oc create secret generic fulcio-config \ --from-file=private=new-fulcio.pass.pem \ --from-file=cert=new-fulcio.cert.pem \ --from-literal=password=CHANGE_ME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with a new password.
NoteThe password here must match the password used for generating the new private and public keys.
Configure The Update Framework (TUF) service to use the new Fulcio certificate.
Set up your shell environment:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a temporary TUF directory structure:
mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
$ mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Download the TUF contents to the temporary TUF directory structure:
oc extract --to "${KEYDIR}/" secret/tuf-root-keys oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" cp "${TUF_REPO}/root.json" "${ROOT}"
$ oc extract --to "${KEYDIR}/" secret/tuf-root-keys $ oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" $ cp "${TUF_REPO}/root.json" "${ROOT}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Find the active Fulcio certificate file name. Open the latest target file, for example,
1.targets.json
, within the local TUF repository. In this file you will find the active Fulcio certificate file name, for example,fulcio_v1.crt.pem
. Set an environment variable with this active Fulcio certificate file name:export ACTIVE_CERT_NAME=fulcio_v1.crt.pem
$ export ACTIVE_CERT_NAME=fulcio_v1.crt.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Extract the active Fulcio certificate from OpenShift:
oc get secret $(oc get fulcio securesign-sample -o jsonpath='{.status.certificate.caRef.name}') -o jsonpath='{.data.cert}' | base64 -d > $ACTIVE_CERT_NAME
$ oc get secret $(oc get fulcio securesign-sample -o jsonpath='{.status.certificate.caRef.name}') -o jsonpath='{.data.cert}' | base64 -d > $ACTIVE_CERT_NAME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expire the old certificate:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the new Fulcio certificate:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Upload these changes to the TUF server:
oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
$ oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the working directory:
rm -r $WORK
$ rm -r $WORK
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Update the Securesign Fulcio configuration:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Patch the Securesign instance:
oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH"
$ oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait for the Fulcio server to redeploy:
oc wait pod -l app.kubernetes.io/name=fulcio-server --for=condition=Ready oc wait pod -l app.kubernetes.io/name=ctlog --for=condition=Ready
$ oc wait pod -l app.kubernetes.io/name=fulcio-server --for=condition=Ready $ oc wait pod -l app.kubernetes.io/name=ctlog --for=condition=Ready
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the
cosign
configuration with the updated TUF configuration:cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
$ cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Now, you are ready to sign and verify your artifacts with the new Fulcio certificate.
1.3.4. Rotating the Timestamp Authority signer key and certificate chain Copy linkLink copied to clipboard!
You can proactively rotate the Timestamp Authority (TSA) signer key and certificate chain. This procedure walks you through expiring your old TSA signer key and certificate chain, and replacing them with a new ones for Red Hat Trusted Artifact Signer (RHTAS) to use. Expiring your old TSA signer key and certificate chain still allows you to verify artifacts signed by the old key and certificate chain.
Prerequisites
- Installation of the RHTAS operator running on Red Hat OpenShift Container Platform.
- A running Securesign instance.
-
A workstation with the
oc
andopenssl
binaries installed.
Procedure
Download the
tuftool
binary from the OpenShift cluster to your workstation.ImportantCurrently, the
tuftool
binary is only available for Linux operating systems on the x86_64 architecture.- From the home page, click the ? icon, click Command line tools, go to the tuftool download section, and click the link for your platform.
Open a terminal on your workstation, decompress the binary
.gz
file, and set the execution bit:gunzip tuftool-amd64.gz chmod +x tuftool-amd64
$ gunzip tuftool-amd64.gz $ chmod +x tuftool-amd64
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Move and rename the binary to a location within your
$PATH
environment:sudo mv tuftool-amd64 /usr/local/bin/tuftool
$ sudo mv tuftool-amd64 /usr/local/bin/tuftool
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Log in to OpenShift from the command line:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Switch to the RHTAS project:
oc project trusted-artifact-signer
$ oc project trusted-artifact-signer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Generate a new certificate chain, and a new signer key.
ImportantThe new certificate and keys must have unique file names.
Create a temporary working directory:
mkdir certs && cd certs
$ mkdir certs && cd certs
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the root certificate authority (CA) private key, and set a password:
openssl req -x509 -newkey rsa:2048 -days 365 -sha256 -nodes \ -keyout rootCA.key.pem -out rootCA.crt.pem \ -passout pass:"CHANGE_ME" \ -subj "/C=CC/ST=state/L=Locality/O=RH/OU=RootCA/CN=RootCA" \ -addext "basicConstraints=CA:true" -addext "keyUsage=cRLSign, keyCertSign"
$ openssl req -x509 -newkey rsa:2048 -days 365 -sha256 -nodes \ -keyout rootCA.key.pem -out rootCA.crt.pem \ -passout pass:"CHANGE_ME" \ -subj "/C=CC/ST=state/L=Locality/O=RH/OU=RootCA/CN=RootCA" \ -addext "basicConstraints=CA:true" -addext "keyUsage=cRLSign, keyCertSign"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with a new password.
Create the intermediate CA private key and certificate signing request (CSR), and set a password:
openssl req -newkey rsa:2048 -sha256 \ -keyout intermediateCA.key.pem -out intermediateCA.csr.pem \ -passout pass:"CHANGE_ME" \ -subj "/C=CC/ST=state/L=Locality/O=RH/OU=IntermediateCA/CN=IntermediateCA"
$ openssl req -newkey rsa:2048 -sha256 \ -keyout intermediateCA.key.pem -out intermediateCA.csr.pem \ -passout pass:"CHANGE_ME" \ -subj "/C=CC/ST=state/L=Locality/O=RH/OU=IntermediateCA/CN=IntermediateCA"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with a new password.
Sign the intermediate CA certificate with the root CA:
openssl x509 -req -in intermediateCA.csr.pem -CA rootCA.crt.pem -CAkey rootCA.key.pem \ -CAcreateserial -out intermediateCA.crt.pem -days 365 -sha256 \ -extfile <(echo -e "basicConstraints=CA:true\nkeyUsage=cRLSign, keyCertSign\nextendedKeyUsage=critical,timeStamping") \ -passin pass:"CHANGE_ME"
$ openssl x509 -req -in intermediateCA.csr.pem -CA rootCA.crt.pem -CAkey rootCA.key.pem \ -CAcreateserial -out intermediateCA.crt.pem -days 365 -sha256 \ -extfile <(echo -e "basicConstraints=CA:true\nkeyUsage=cRLSign, keyCertSign\nextendedKeyUsage=critical,timeStamping") \ -passin pass:"CHANGE_ME"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with the root CA private key password to sign the intermediate CA certificate.
Create the leaf CA private key and CSR, and set a password:
openssl req -newkey rsa:2048 -sha256 \ -keyout leafCA.key.pem -out leafCA.csr.pem \ -passout pass:"CHANGE_ME" \ -subj "/C=CC/ST=state/L=Locality/O=RH/OU=LeafCA/CN=LeafCA"
$ openssl req -newkey rsa:2048 -sha256 \ -keyout leafCA.key.pem -out leafCA.csr.pem \ -passout pass:"CHANGE_ME" \ -subj "/C=CC/ST=state/L=Locality/O=RH/OU=LeafCA/CN=LeafCA"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Sign the leaf CA certificate with the intermediate CA:
openssl x509 -req -in leafCA.csr.pem -CA intermediateCA.crt.pem -CAkey intermediateCA.key.pem \ -CAcreateserial -out leafCA.crt.pem -days 365 -sha256 \ -extfile <(echo -e "basicConstraints=CA:false\nkeyUsage=cRLSign, keyCertSign\nextendedKeyUsage=critical,timeStamping") \ -passin pass:"CHANGE_ME"
$ openssl x509 -req -in leafCA.csr.pem -CA intermediateCA.crt.pem -CAkey intermediateCA.key.pem \ -CAcreateserial -out leafCA.crt.pem -days 365 -sha256 \ -extfile <(echo -e "basicConstraints=CA:false\nkeyUsage=cRLSign, keyCertSign\nextendedKeyUsage=critical,timeStamping") \ -passin pass:"CHANGE_ME"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with the intermediate CA private key password to sign the leaf CA certificate.
Create the certificate chain by combining the newly created certificates together:
cat leafCA.crt.pem intermediateCA.crt.pem rootCA.crt.pem > new-tsa.certchain.pem
$ cat leafCA.crt.pem intermediateCA.crt.pem rootCA.crt.pem > new-tsa.certchain.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Create a new secret resource with the signer key:
oc create secret generic rotated-signer-key --from-file=rotated-signer-key=certs/leafCA.key.pem
$ oc create secret generic rotated-signer-key --from-file=rotated-signer-key=certs/leafCA.key.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new secret resource with the new certificate chain:
oc create secret generic rotated-cert-chain --from-file=rotated-cert-chain=certs/new-tsa.certchain.pem
$ oc create secret generic rotated-cert-chain --from-file=rotated-cert-chain=certs/new-tsa.certchain.pem
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new secret resource with for the password:
oc create secret generic rotated-password --from-literal=rotated-password=CHANGE_ME
$ oc create secret generic rotated-password --from-literal=rotated-password=CHANGE_ME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Replace CHANGE_ME with the intermediate CA private key password.
Find your active TSA certificate file name, the TSA URL string, and configure your shell environment with these values:
export ACTIVE_CERT_CHAIN_NAME=tsa.certchain.pem export TSA_URL=$(oc get timestampauthority securesign-sample -o jsonpath='{.status.url}')/api/v1/timestamp curl $TSA_URL/certchain -o $ACTIVE_CERT_CHAIN_NAME
$ export ACTIVE_CERT_CHAIN_NAME=tsa.certchain.pem $ export TSA_URL=$(oc get timestampauthority securesign-sample -o jsonpath='{.status.url}')/api/v1/timestamp $ curl $TSA_URL/certchain -o $ACTIVE_CERT_CHAIN_NAME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the Securesign TSA configuration:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Patch the Securesign instance:
oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH"
$ oc patch Securesign securesign-sample --type='json' -p="$SECURESIGN_PATCH"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait for the TSA server to redeploy with the new signer key and certificate chain:
oc get pods -w -l app.kubernetes.io/name=tsa-server
$ oc get pods -w -l app.kubernetes.io/name=tsa-server
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the new certificate chain:
export NEW_CERT_CHAIN_NAME=new-tsa.certchain.pem curl $TSA_URL/certchain -o $NEW_CERT_CHAIN_NAME
$ export NEW_CERT_CHAIN_NAME=new-tsa.certchain.pem $ curl $TSA_URL/certchain -o $NEW_CERT_CHAIN_NAME
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Configure The Update Framework (TUF) service to use the new TSA certificate chain.
Set up your shell environment:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a temporary TUF directory structure:
mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
$ mkdir -p "${WORK}/root/" "${KEYDIR}" "${INPUT}" "${TUF_REPO}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Download the TUF contents to the temporary TUF directory structure:
oc extract --to "${KEYDIR}/" secret/tuf-root-keys oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" cp "${TUF_REPO}/root.json" "${ROOT}"
$ oc extract --to "${KEYDIR}/" secret/tuf-root-keys $ oc cp "${TUF_SERVER_POD}:/var/www/html" "${TUF_REPO}" $ cp "${TUF_REPO}/root.json" "${ROOT}"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expire the old TSA certificate:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the new TSA certificate:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Upload these changes to the TUF server:
oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
$ oc rsync "${TUF_REPO}/" "${TUF_SERVER_POD}:/var/www/html"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the working directory:
rm -r $WORK
$ rm -r $WORK
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Update the
cosign
configuration with the updated TUF configuration:cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
$ cosign initialize --mirror=$TUF_URL --root=$TUF_URL/root.json
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Now, you are ready to sign and verify your artifacts that uses the new TSA signer key, and certificate.
1.4. Using your own certificate authority bundle Copy linkLink copied to clipboard!
You can bring your organization’s certificate authority (CA) bundle for signing and verifying your build artifacts with Red Hat’s Trusted Artifact Signer (RHTAS) service.
Prerequisites
- Installation of the RHTAS operator running on Red Hat OpenShift Container Platform.
- A running Securesign instance.
- Your CA root certificate.
-
A workstation with the
oc
binary installed.
Procedure
Log in to OpenShift from the command line:
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
oc login --token=TOKEN --server=SERVER_URL_AND_PORT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
$ oc login --token=sha256~ZvFDBvoIYAbVECixS4-WmkN4RfnNd8Neh3y1WuiFPXC --server=https://example.com:6443
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find your login token and URL for use on the command line from the OpenShift web console. Log in to the OpenShift web console. Click your user name, and click Copy login command. Offer your user name and password again, if asked, and click Display Token to view the command.
Switch to the RHTAS project:
oc project trusted-artifact-signer
$ oc project trusted-artifact-signer
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a new ConfigMap by using your organization’s CA root certificate bundle:
oc create configmap custom-ca-bundle --from-file=ca-bundle.crt
$ oc create configmap custom-ca-bundle --from-file=ca-bundle.crt
Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantThe certificate filename must be
ca-bundle.crt
.Open the Securesign resource for editing:
oc edit Securesign securesign-sample
$ oc edit Securesign securesign-sample
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the
rhtas.redhat.com/trusted-ca
under themetadata.annotations
section:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Save, and quit the editor.
Open the Fulcio resource for editing:
oc edit Fulcio securesign-sample
$ oc edit Fulcio securesign-sample
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the
rhtas.redhat.com/trusted-ca
under themetadata.annotations
section:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Save, and quit the editor.
- Wait for the RHTAS operator to reconfigure before signing and verifying artifacts.