Skip to content

✨ feat(registry): add mTls support #1

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
Waler wants to merge 2 commits into
base: main
Choose a base branch
from
Open

✨ feat(registry): add mTls support #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42de365
✅ test: Fixing retention test for update operations
Waler Mar 11, 2026
376389e
✨ feat(registry): add mTls support
Waler Mar 11, 2026
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
19 changes: 19 additions & 0 deletions app/registries/BaseRegistry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,25 @@ test('authenticateBearer should attach CA from cafile when configured', async ()
}
});

test('authenticateBearer should attach mtls cert and key when configured', async () => {
const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'drydock-baseregistry-'));
const clientCertPath = path.join(tempDir, 'clientcert.pem');
const clientKeyPath = path.join(tempDir, 'clientkey.pem');
try {
fs.writeFileSync(clientCertPath, 'test-client-cert-content');
fs.writeFileSync(clientKeyPath, 'test-client-key-content');
baseRegistry.configuration = { clientcertfile: clientCertPath, clientkeyfile: clientKeyPath };
const result = await baseRegistry.authenticateBearer({ headers: {} }, 'token-value');
expect(result.headers.Authorization).toBe('Bearer token-value');
expect(result.httpsAgent).toBeDefined();
expect(result.httpsAgent.options.rejectUnauthorized).toBe(true);
expect(result.httpsAgent.options.cert.toString('utf-8')).toBe('test-client-cert-content');
expect(result.httpsAgent.options.key.toString('utf-8')).toBe('test-client-key-content');
} finally {
fs.rmSync(tempDir, { recursive: true, force: true });
}
});

test('getAuthCredentials should return auth when set', () => {
baseRegistry.configuration = { auth: 'base64-auth' };
expect(baseRegistry.getAuthCredentials()).toBe('base64-auth');
Expand Down
16 changes: 15 additions & 1 deletion app/registries/BaseRegistry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ class BaseRegistry extends Registry {
private getHttpsAgent() {
const shouldDisableTlsVerification = this.configuration?.insecure === true;
const hasCaFile = Boolean(this.configuration?.cafile);
if (!shouldDisableTlsVerification && !hasCaFile) {
const hasMutalTls = Boolean(this.configuration?.clientcertfile);
if (!shouldDisableTlsVerification && !hasCaFile && !hasMutalTls) {
return undefined;
}

Expand All @@ -91,12 +92,25 @@ class BaseRegistry extends Registry {
});
ca = fs.readFileSync(caPath);
}
let clientCert, clientKey;
if (hasMutalTls) {
const clientCertPath = resolveConfiguredPath(this.configuration.clientcertfile, {
label: `registry ${this.getId()} client cert file path`,
});
clientCert = fs.readFileSync(clientCertPath);
const clientKeyPath = resolveConfiguredPath(this.configuration.clientkeyfile, {
label: `registry ${this.getId()} client key file path`,
});
clientKey = fs.readFileSync(clientKeyPath);
}

// Intentional opt-in for self-hosted registries with private/self-signed cert chains.
// lgtm[js/disabling-certificate-validation]
this.httpsAgent = new https.Agent({
ca,
rejectUnauthorized: !shouldDisableTlsVerification,
cert: clientCert,
key: clientKey,
});
return this.httpsAgent;
}
Expand Down
7 changes: 5 additions & 2 deletions app/registries/providers/shared/SelfHostedBasic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,15 @@ class SelfHostedBasic extends BaseRegistry {
login: this.joi.string(),
password: this.joi.string(),
auth: authSchema,
cafile: this.joi.string(),
insecure: this.joi.boolean(),
cafile: this.joi.string(),
clientcertfile: this.joi.string(),
clientkeyfile: this.joi.string(),
})
.and('login', 'password')
.without('login', 'auth')
.without('password', 'auth');
.without('password', 'auth')
.and('clientcertfile', 'clientkeyfile');
}

maskConfiguration() {
Expand Down
2 changes: 1 addition & 1 deletion app/store/update-operation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ describe('Update Operation Store', () => {
});

for (let i = 0; i < 97; i += 1) {
vi.setSystemTime(new Date(2026, 1, 1, 0, 1, i));
vi.setSystemTime(new Date(2026, 2, 1, 0, 1, i));
fresh.updateOperation(third.id, {
lastError: `error-${i}`,
});
Expand Down
2 changes: 2 additions & 0 deletions content/docs/current/configuration/registries/artifactory/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The `artifactory` registry lets you configure a [JFrog Artifactory](https://jfro
| `DD_REGISTRY_ARTIFACTORY_{REGISTRY_NAME}_AUTH` | ⚪ | Base64 encoded `login:password` string | DD_REGISTRY_ARTIFACTORY_\{REGISTRY_NAME\}_LOGIN/PASSWORD must not be defined | |
| `DD_REGISTRY_ARTIFACTORY_{REGISTRY_NAME}_CAFILE` | ⚪ | Path to custom CA certificate file | | |
| `DD_REGISTRY_ARTIFACTORY_{REGISTRY_NAME}_INSECURE` | ⚪ | Allow insecure (non-TLS) connections | `true`, `false` | `false` |
| `DD_REGISTRY_ARTIFACTORY_{REGISTRY_NAME}_CLIENTCERTFILE` | ⚪ | Path to mTls client certificate file | | |
| `DD_REGISTRY_ARTIFACTORY_{REGISTRY_NAME}_CLIENTKEYFILE` | ⚪ | Path to mTls client key file | | |

## Examples

Expand Down
2 changes: 2 additions & 0 deletions content/docs/current/configuration/registries/custom/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The `custom` registry lets you configure a self-hosted [Docker Registry](https:/
| `DD_REGISTRY_CUSTOM_{REGISTRY_NAME}_AUTH` | ⚪ | Base64-encoded `login:password` string | DD_REGISTRY_CUSTOM_\{REGISTRY_NAME\}_LOGIN/PASSWORD must not be defined | |
| `DD_REGISTRY_CUSTOM_{REGISTRY_NAME}_CAFILE` | ⚪ | Path to custom CA certificate file | | |
| `DD_REGISTRY_CUSTOM_{REGISTRY_NAME}_INSECURE` | ⚪ | Allow insecure (non-TLS) connections | `true`, `false` | `false` |
| `DD_REGISTRY_CUSTOM_{REGISTRY_NAME}_CLIENTCERTFILE` | ⚪ | Path to mTls client certificate file | | |
| `DD_REGISTRY_CUSTOM_{REGISTRY_NAME}_CLIENTKEYFILE` | ⚪ | Path to mTls client key file | | |

## Examples

Expand Down
2 changes: 2 additions & 0 deletions content/docs/current/configuration/registries/forgejo/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The `forgejo` registry lets you configure a self-hosted [Forgejo](https://forgej
| `DD_REGISTRY_FORGEJO_{REGISTRY_NAME}_AUTH` | ⚪ | Base64-encoded `login:password` string | DD_REGISTRY_FORGEJO_\{REGISTRY_NAME\}_LOGIN/PASSWORD must not be defined | |
| `DD_REGISTRY_FORGEJO_{REGISTRY_NAME}_CAFILE` | ⚪ | Path to custom CA certificate file | | |
| `DD_REGISTRY_FORGEJO_{REGISTRY_NAME}_INSECURE` | ⚪ | Allow insecure (non-TLS) connections | `true`, `false` | `false` |
| `DD_REGISTRY_FORGEJO_{REGISTRY_NAME}_CLIENTCERTFILE` | ⚪ | Path to mTls client certificate file | | |
| `DD_REGISTRY_FORGEJO_{REGISTRY_NAME}_CLIENTKEYFILE` | ⚪ | Path to mTls client key file | | |

## Examples

Expand Down
2 changes: 2 additions & 0 deletions content/docs/current/configuration/registries/gitea/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The `gitea` registry lets you configure a self-hosted [Gitea](https://gitea.com)
| `DD_REGISTRY_GITEA_{REGISTRY_NAME}_AUTH` | ⚪ | Base64-encoded `login:password` string | DD_REGISTRY_GITEA_\{REGISTRY_NAME\}_LOGIN/PASSWORD must not be defined | |
| `DD_REGISTRY_GITEA_{REGISTRY_NAME}_CAFILE` | ⚪ | Path to custom CA certificate file | | |
| `DD_REGISTRY_GITEA_{REGISTRY_NAME}_INSECURE` | ⚪ | Allow insecure (non-TLS) connections | `true`, `false` | `false` |
| `DD_REGISTRY_GITEA_{REGISTRY_NAME}_CLIENTCERTFILE` | ⚪ | Path to mTls client certificate file | | |
| `DD_REGISTRY_GITEA_{REGISTRY_NAME}_CLIENTKEYFILE` | ⚪ | Path to mTls client key file | | |

## Examples

Expand Down
2 changes: 2 additions & 0 deletions content/docs/current/configuration/registries/harbor/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The `harbor` registry lets you configure a self-hosted [Harbor](https://goharbor
| `DD_REGISTRY_HARBOR_{REGISTRY_NAME}_AUTH` | ⚪ | Base64 encoded `login:password` string | DD_REGISTRY_HARBOR_\{REGISTRY_NAME\}_LOGIN/PASSWORD must not be defined | |
| `DD_REGISTRY_HARBOR_{REGISTRY_NAME}_CAFILE` | ⚪ | Path to custom CA certificate file | | |
| `DD_REGISTRY_HARBOR_{REGISTRY_NAME}_INSECURE` | ⚪ | Allow insecure (non-TLS) connections | `true`, `false` | `false` |
| `DD_REGISTRY_HARBOR_{REGISTRY_NAME}_CLIENTCERTFILE` | ⚪ | Path to mTls client certificate file | | |
| `DD_REGISTRY_HARBOR_{REGISTRY_NAME}_CLIENTKEYFILE` | ⚪ | Path to mTls client key file | | |

## Examples

Expand Down
2 changes: 2 additions & 0 deletions content/docs/current/configuration/registries/nexus/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The `nexus` registry lets you configure a [Sonatype Nexus](https://www.sonatype.
| `DD_REGISTRY_NEXUS_{REGISTRY_NAME}_AUTH` | ⚪ | Base64 encoded `login:password` string | DD_REGISTRY_NEXUS_\{REGISTRY_NAME\}_LOGIN/PASSWORD must not be defined | |
| `DD_REGISTRY_NEXUS_{REGISTRY_NAME}_CAFILE` | ⚪ | Path to custom CA certificate file | | |
| `DD_REGISTRY_NEXUS_{REGISTRY_NAME}_INSECURE` | ⚪ | Allow insecure (non-TLS) connections | `true`, `false` | `false` |
| `DD_REGISTRY_NEXUS_{REGISTRY_NAME}_CLIENTCERTFILE` | ⚪ | Path to mTls client certificate file | | |
| `DD_REGISTRY_NEXUS_{REGISTRY_NAME}_CLIENTKEYFILE` | ⚪ | Path to mTls client key file | | |

## Examples

Expand Down