Skip to content

[noissue] Recover metadata_signing documentation #1645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rayzilt wants to merge 1 commit into
base: main
Choose a base branch
from
+102 −6
Open

[noissue] Recover metadata_signing documentation #1645

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 102 additions & 6 deletions docs/admin/guides/configurations/metadata_signing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ See pulpcore documentation for details on Content Signing: [https://docs.pulppro
See pulp_container documentation for details on Container Image Signing: [https://docs.pulpproject.org/pulp_container/workflows/sign-images.html](https://docs.pulpproject.org/pulp_container/workflows/sign-images.html)


## Create a gpg key
## Creating a gpg key

* create the key
```bash
Expand Down Expand Up @@ -50,14 +50,17 @@ sub rsa2048 2022-12-14 [E]

See the GnuPG official documentation for more information on how to generate a new keypair: [https://www.gnupg.org/gph/en/manual/c14.html](https://www.gnupg.org/gph/en/manual/c14.html)

## Create a Secret with the gpg key
## Creating a Secret with the gpg key

!!! WARNING
Make sure to set `signing_service.gpg` as the key name for the `Secret` (using a different name will fail operator's execution)

```bash
$ gpg --export-secret-keys -a pulp@example.com > /tmp/gpg_private_key.gpg
$ kubectl create secret generic signing-secret --from-file=signing_service.gpg=/tmp/gpg_private_key.gpg
```

## Create a Secret with the signing scripts
## Creating a Secret with the signing scripts

* example of a collection signing script
```bash
Expand Down Expand Up @@ -115,14 +118,86 @@ fi
EOF
```

* example of an APT signing script
```bash
$ SIGNING_SCRIPT_PATH=/tmp
$ APT_SIGNING_SCRIPT=apt_script.sh
$ cat<<EOF> "$SIGNING_SCRIPT_PATH/$APT_SIGNING_SCRIPT"
#!/bin/bash

set -e

RELEASE_FILE="\$(/usr/bin/readlink -f \$1)"
OUTPUT_DIR="\$(/usr/bin/mktemp -d)"
DETACHED_SIGNATURE_PATH="\${OUTPUT_DIR}/Release.gpg"
INLINE_SIGNATURE_PATH="\${OUTPUT_DIR}/InRelease"
COMMON_GPG_OPTS="--batch --armor --digest-algo SHA256 --default-key \$PULP_SIGNING_KEY_FINGERPRINT"

# Create a detached signature
/usr/bin/gpg \${COMMON_GPG_OPTS} \
--detach-sign \
--output "\${DETACHED_SIGNATURE_PATH}" \
"\${RELEASE_FILE}"

# Create an inline signature
/usr/bin/gpg \${COMMON_GPG_OPTS} \
--clearsign \
--output "\${INLINE_SIGNATURE_PATH}" \
"\${RELEASE_FILE}"

echo { \
\"signatures\": { \
\"inline\": \"\${INLINE_SIGNATURE_PATH}\", \
\"detached\": \"\${DETACHED_SIGNATURE_PATH}\" \
} \
}

EOF
```

* example of an RPM signing script
```bash
$ SIGNING_SCRIPT_PATH=/tmp
$ APT_SIGNING_SCRIPT=rpm_script.sh
$ cat<<EOF> "$SIGNING_SCRIPT_PATH/$RPM_SIGNING_SCRIPT"
#!/bin/bash

set -e

FILE_PATH=\$1
GPG_FINGERPRINT="\$PULP_SIGNING_KEY_FINGERPRINT"
GPG_HOME=/var/lib/pulp/.gnupg/
GPG_BIN=/usr/bin/gpg

# Make sure the gpg public key has been imported
gpg --export -a \$GPG_FINGERPRINT > /tmp/RPM-GPG-KEY
rpm --import /tmp/RPM-GPG-KEY

rpm \
--define "_signature gpg" \
--define "_gpg_path \$GPG_HOME" \
--define "_gpg_name \$GPG_FINGERPRINT" \
--define "_gpgbin \$GPG_BIN" \
--define "__gpg_sign_cmd %{__gpg} gpg --force-v3-sigs --batch --verbose --no-armor --no-secmem-warning -u %{_gpg_name} -sbo %{__signature_filename} --digest-algo sha256 -v --pinentry-mode loopback %{__plaintext_filename}" \
--addsign "\$FILE_PATH" 1> /dev/null

STATUS=\$?
if [[ \$STATUS -eq 0 ]]; then
echo {\"rpm_package\": \"\$FILE_PATH\"}
else
exit \$STATUS
fi
EOF
```

!!! WARNING
Make sure to set `collection_script.sh` and/or `container_script.sh` as key names (using different names would fail operator's execution)
Make sure to set `collection_script.sh`, `container_script.sh`, `apt_script.sh`, and/or `rpm_script.sh` as key names (using different names would fail operator's execution)

```bash
$ kubectl create secret generic signing-scripts --from-file=collection_script.sh=/tmp/collection_script.sh --from-file=container_script.sh=/tmp/container_script.sh
$ kubectl create secret generic signing-scripts --from-file=collection_script.sh=/tmp/collection_script.sh --from-file=container_script.sh=/tmp/container_script.sh --from-file=apt_script.sh=/tmp/apt_script.sh --from-file=rpm_script.sh=/tmp/rpm_script.sh
```

## Configure Pulp CR
## Configuring Pulp CR

* configure Pulp CR with the Secrets created in the previous steps
```yaml
Expand All @@ -147,6 +222,10 @@ Signing service 'collection-signing-service' has been successfully removed.
Successfully added signing service collection-signing-service for key 66BBFE010CF70CC92826D9AB71684D7912B09BC1.
Signing service 'container-signing-service' has been successfully removed.
Successfully added signing service container-signing-service for key 66BBFE010CF70CC92826D9AB71684D7912B09BC1.
Signing service 'apt-signing-service' has been successfully removed.
Successfully added signing service apt-signing-service for key 66BBFE010CF70CC92826D9AB71684D7912B09BC1.
Signing service 'rpm-signing-service' has been successfully removed.
Successfully added signing service rpm-signing-service for key 66BBFE010CF70CC92826D9AB71684D7912B09BC1.
```

double-checking if the signing services are stored in the database:
Expand All @@ -158,6 +237,15 @@ $ kubectl exec deployment/pulp-api -- curl -suadmin:$PULP_PWD localhost:24817/pu
"next": null,
"previous": null,
"results": [
{
"pulp_href": "/pulp/api/v3/signing-services/0191e929-31f4-77d1-841e-2b545cf45da3/",
"pulp_created": "2024-09-13T02:14:36.846612Z",
"pulp_last_updated": "2024-09-13T02:14:36.846627Z",
"name": "apt-signing-service",
"public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQGiBGbjgnIRBACc7VbJTNbDRja...",
"pubkey_fingerprint": "66BBFE010CF70CC92826D9AB71684D7912B09BC1",
"script": "/var/lib/pulp/scripts/apt_script.sh"
},
{
"pulp_href": "/pulp/api/v3/signing-services/018c0126-1f0c-7803-868d-1a1ee7210db1/",
"pulp_created": "2023-11-22T11:45:25.042451Z",
Expand All @@ -173,6 +261,14 @@ $ kubectl exec deployment/pulp-api -- curl -suadmin:$PULP_PWD localhost:24817/pu
"public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQINBGJFjREBE...",
"pubkey_fingerprint": "66BBFE010CF70CC92826D9AB71684D7912B09BC1",
"script": "/var/lib/pulp/scripts/collection_script.sh"
},
{
"pulp_href": "/pulp/api/v3/signing-services/0194a988-684c-7dda-9b16-2bb614a8e1ba/",
"pulp_created": "2025-01-27T20:51:17.323038Z",
"name": "rpm-signing-service",
"public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQGNBGeSYcYBDADaKR4OZ+y...",
"pubkey_fingerprint": "66BBFE010CF70CC92826D9AB71684D7912B09BC1",
"script": "/var/lib/pulp/scripts/rpm_script.sh"
}
]
}
Expand Down