mirror of
https://github.com/docker/login-action.git
synced 2026-08-06 21:45:06 +00:00
Compare commits
5 Commits
v4.6.0
...
dockerhub-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
72edfa6c2e | ||
|
|
2b7517a3b4 | ||
|
|
eed2509203 | ||
|
|
07573e7c18 | ||
|
|
99ffd0f38a |
@@ -758,9 +758,9 @@ The following inputs can be used as `step.with` keys:
|
|||||||
The following environment variables can be set as `step.env` keys:
|
The following environment variables can be set as `step.env` keys:
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
|-------------------------------|--------|---------|-----------------------------------------------------------------------------|
|
|-------------------------------|--------|---------|----------------------------------------------------------------------------------------------------|
|
||||||
| `DOCKERHUB_OIDC_CONNECTIONID` | String | | Docker Hub OIDC connection ID. Required for Docker Hub OIDC login |
|
| `DOCKERHUB_OIDC_CONNECTIONID` | String | | Docker Hub OIDC connection ID. Required for Docker Hub OIDC login |
|
||||||
| `DOCKERHUB_OIDC_EXPIREIN` | Number | `300` | Docker Hub OIDC token lifetime in seconds. Must be between `300` and `3600` |
|
| `DOCKERHUB_OIDC_EXPIREIN` | Number | `300` | Docker Hub OIDC token lifetime in seconds. Must be between `300` (5 minutes) and `21600` (6 hours) |
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import {beforeEach, describe, expect, test, vi} from 'vitest';
|
|||||||
import * as dockerhub from '../src/dockerhub.js';
|
import * as dockerhub from '../src/dockerhub.js';
|
||||||
|
|
||||||
vi.mock('@actions/core', () => ({
|
vi.mock('@actions/core', () => ({
|
||||||
|
debug: vi.fn(),
|
||||||
getIDToken: vi.fn(),
|
getIDToken: vi.fn(),
|
||||||
info: vi.fn(),
|
info: vi.fn(),
|
||||||
setSecret: vi.fn()
|
setSecret: vi.fn()
|
||||||
@@ -83,13 +84,22 @@ describe('getOIDCToken', () => {
|
|||||||
expect(body.get('connection_id')).toBe(validConnectionID);
|
expect(body.get('connection_id')).toBe(validConnectionID);
|
||||||
expect(body.get('expires_in')).toBe('300');
|
expect(body.get('expires_in')).toBe('300');
|
||||||
expect(setSecretMock).toHaveBeenCalledWith('hub-token');
|
expect(setSecretMock).toHaveBeenCalledWith('hub-token');
|
||||||
|
expect(core.info).toHaveBeenCalledWith('Docker Hub OIDC detected for docker.io');
|
||||||
|
expect(core.info).toHaveBeenCalledWith('Retrieving GitHub OIDC token for Docker Hub');
|
||||||
|
expect(core.info).toHaveBeenCalledWith('Exchanging GitHub OIDC token for Docker Hub token');
|
||||||
|
expect(core.info).toHaveBeenCalledWith('Docker Hub OIDC token exchange succeeded');
|
||||||
|
expect(core.debug).toHaveBeenCalledWith('Docker Hub OIDC token audience: https://identity.docker.com');
|
||||||
|
expect(core.debug).toHaveBeenCalledWith('Docker Hub OIDC token expiration: 300s');
|
||||||
|
expect(core.debug).toHaveBeenCalledWith('Sending Docker Hub OIDC token request to https://identity.docker.com/oauth/token');
|
||||||
|
expect(core.debug).toHaveBeenCalledWith('Docker Hub OIDC token request returned status code 200');
|
||||||
|
expect(core.debug).toHaveBeenCalledWith('Docker Hub OIDC token response status code: 200');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('uses custom token expiration', async () => {
|
test('uses custom token expiration', async () => {
|
||||||
process.env.DOCKERHUB_OIDC_EXPIREIN = '900';
|
process.env.DOCKERHUB_OIDC_EXPIREIN = '21600';
|
||||||
await dockerhub.getOIDCToken('docker.io', 'dbowie');
|
await dockerhub.getOIDCToken('docker.io', 'dbowie');
|
||||||
const body = new URLSearchParams(postSpy.mock.calls[0][1]);
|
const body = new URLSearchParams(postSpy.mock.calls[0][1]);
|
||||||
expect(body.get('expires_in')).toBe('900');
|
expect(body.get('expires_in')).toBe('21600');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('uses stage identity host for stage registry', async () => {
|
test('uses stage identity host for stage registry', async () => {
|
||||||
@@ -112,9 +122,9 @@ describe('getOIDCToken', () => {
|
|||||||
expect(postSpy).not.toHaveBeenCalled();
|
expect(postSpy).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
test.each(['not-a-number', '299', '3601'])('validates token expiration %p', async expiresIn => {
|
test.each(['not-a-number', '299', '21601'])('validates token expiration %p', async expiresIn => {
|
||||||
process.env.DOCKERHUB_OIDC_EXPIREIN = expiresIn;
|
process.env.DOCKERHUB_OIDC_EXPIREIN = expiresIn;
|
||||||
await expect(dockerhub.getOIDCToken('docker.io', 'dbowie')).rejects.toThrow(`Invalid DOCKERHUB_OIDC_EXPIREIN: ${expiresIn}. Must be between 300 and 3600`);
|
await expect(dockerhub.getOIDCToken('docker.io', 'dbowie')).rejects.toThrow(`Invalid DOCKERHUB_OIDC_EXPIREIN: ${expiresIn}. Must be between 300 and 21600`);
|
||||||
expect(getIDTokenMock).not.toHaveBeenCalled();
|
expect(getIDTokenMock).not.toHaveBeenCalled();
|
||||||
expect(postSpy).not.toHaveBeenCalled();
|
expect(postSpy).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|||||||
66
dist/index.cjs
generated
vendored
66
dist/index.cjs
generated
vendored
File diff suppressed because one or more lines are too long
6
dist/index.cjs.map
generated
vendored
6
dist/index.cjs.map
generated
vendored
File diff suppressed because one or more lines are too long
@@ -15,7 +15,7 @@ interface OIDCTokenResponse {
|
|||||||
const registries = new Set(['', 'docker.io', 'registry-1.docker.io', 'registry-1-stage.docker.io', 'dhi.io']);
|
const registries = new Set(['', 'docker.io', 'registry-1.docker.io', 'registry-1-stage.docker.io', 'dhi.io']);
|
||||||
const defaultExpiresIn = 300;
|
const defaultExpiresIn = 300;
|
||||||
const minExpiresIn = 300;
|
const minExpiresIn = 300;
|
||||||
const maxExpiresIn = 3600;
|
const maxExpiresIn = 21600;
|
||||||
const maxRetries = 5;
|
const maxRetries = 5;
|
||||||
|
|
||||||
export const isDockerHubOIDC = (registry: string, password: string): boolean => {
|
export const isDockerHubOIDC = (registry: string, password: string): boolean => {
|
||||||
@@ -35,6 +35,10 @@ export const getOIDCToken = async (registry: string, username: string): Promise<
|
|||||||
const expiresIn = getExpiresIn();
|
const expiresIn = getExpiresIn();
|
||||||
const identityHost = registry === 'registry-1-stage.docker.io' ? 'identity-stage.docker.com' : 'identity.docker.com';
|
const identityHost = registry === 'registry-1-stage.docker.io' ? 'identity-stage.docker.com' : 'identity.docker.com';
|
||||||
const audience = `https://${identityHost}`;
|
const audience = `https://${identityHost}`;
|
||||||
|
core.info(`Docker Hub OIDC detected for ${registry || 'docker.io'}`);
|
||||||
|
core.debug(`Docker Hub OIDC token audience: ${audience}`);
|
||||||
|
core.debug(`Docker Hub OIDC token expiration: ${expiresIn}s`);
|
||||||
|
core.info(`Retrieving GitHub OIDC token for Docker Hub`);
|
||||||
const idToken = await core.getIDToken(audience);
|
const idToken = await core.getIDToken(audience);
|
||||||
const http: httpm.HttpClient = new httpm.HttpClient('github.com/docker/login-action', [], {
|
const http: httpm.HttpClient = new httpm.HttpClient('github.com/docker/login-action', [], {
|
||||||
headers: {
|
headers: {
|
||||||
@@ -49,10 +53,12 @@ export const getOIDCToken = async (registry: string, username: string): Promise<
|
|||||||
data.set('connection_id', connectionID);
|
data.set('connection_id', connectionID);
|
||||||
data.set('expires_in', expiresIn.toString());
|
data.set('expires_in', expiresIn.toString());
|
||||||
|
|
||||||
|
core.info(`Exchanging GitHub OIDC token for Docker Hub token`);
|
||||||
const resp = await postWithRetry(http, `https://${identityHost}/oauth/token`, data.toString());
|
const resp = await postWithRetry(http, `https://${identityHost}/oauth/token`, data.toString());
|
||||||
|
|
||||||
const tokenResp = <OIDCTokenResponse>JSON.parse(await handleResponse(resp));
|
const tokenResp = <OIDCTokenResponse>JSON.parse(await handleResponse(resp));
|
||||||
core.setSecret(tokenResp.access_token);
|
core.setSecret(tokenResp.access_token);
|
||||||
|
core.info(`Docker Hub OIDC token exchange succeeded`);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
username,
|
username,
|
||||||
@@ -70,16 +76,20 @@ const getExpiresIn = (): number => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const postWithRetry = async (http: httpm.HttpClient, url: string, data: string): Promise<httpm.HttpClientResponse> => {
|
const postWithRetry = async (http: httpm.HttpClient, url: string, data: string): Promise<httpm.HttpClientResponse> => {
|
||||||
|
core.debug(`Sending Docker Hub OIDC token request to ${url}`);
|
||||||
let resp = await http.post(url, data);
|
let resp = await http.post(url, data);
|
||||||
|
core.debug(`Docker Hub OIDC token request returned status code ${resp.message.statusCode || HttpCodes.InternalServerError}`);
|
||||||
for (let attempt = 0; (resp.message.statusCode || HttpCodes.InternalServerError) === HttpCodes.TooManyRequests && attempt < maxRetries; attempt++) {
|
for (let attempt = 0; (resp.message.statusCode || HttpCodes.InternalServerError) === HttpCodes.TooManyRequests && attempt < maxRetries; attempt++) {
|
||||||
const delay = parseRetryAfter(resp.message.headers['retry-after']);
|
const delay = parseRetryAfter(resp.message.headers['retry-after']);
|
||||||
if (delay === null) {
|
if (delay === null) {
|
||||||
|
core.debug(`Docker Hub OIDC token request rate limited without retry-after header`);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
await resp.readBody();
|
await resp.readBody();
|
||||||
core.info(`Docker Hub OIDC token request rate limited, retrying in ${delay}ms (attempt ${attempt + 1}/${maxRetries})`);
|
core.info(`Docker Hub OIDC token request rate limited, retrying in ${delay}ms (attempt ${attempt + 1}/${maxRetries})`);
|
||||||
await new Promise(resolve => setTimeout(resolve, delay));
|
await new Promise(resolve => setTimeout(resolve, delay));
|
||||||
resp = await http.post(url, data);
|
resp = await http.post(url, data);
|
||||||
|
core.debug(`Docker Hub OIDC token request returned status code ${resp.message.statusCode || HttpCodes.InternalServerError}`);
|
||||||
}
|
}
|
||||||
return resp;
|
return resp;
|
||||||
};
|
};
|
||||||
@@ -101,6 +111,7 @@ const parseRetryAfter = (value: string | string[] | undefined): number | null =>
|
|||||||
const handleResponse = async (resp: httpm.HttpClientResponse): Promise<string> => {
|
const handleResponse = async (resp: httpm.HttpClientResponse): Promise<string> => {
|
||||||
const body = await resp.readBody();
|
const body = await resp.readBody();
|
||||||
const statusCode = resp.message.statusCode || HttpCodes.InternalServerError;
|
const statusCode = resp.message.statusCode || HttpCodes.InternalServerError;
|
||||||
|
core.debug(`Docker Hub OIDC token response status code: ${statusCode}`);
|
||||||
if (statusCode < HttpCodes.OK || statusCode >= HttpCodes.MultipleChoices) {
|
if (statusCode < HttpCodes.OK || statusCode >= HttpCodes.MultipleChoices) {
|
||||||
throw parseError(statusCode, body);
|
throw parseError(statusCode, body);
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user