mirror of
https://github.com/docker/login-action.git
synced 2026-07-24 21:57:57 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 457b874437 |
@@ -173,27 +173,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
username: ${{ vars.DOCKERHUB_OIDC_USERNAME }}
|
username: ${{ vars.DOCKERHUB_OIDC_USERNAME }}
|
||||||
|
|
||||||
registry-auth-oidc:
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
id-token: write
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
-
|
|
||||||
name: Checkout
|
|
||||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
||||||
-
|
|
||||||
name: Login to registries
|
|
||||||
uses: ./
|
|
||||||
env:
|
|
||||||
DOCKERHUB_OIDC_CONNECTIONID: ${{ vars.DOCKERHUB_OIDC_CONNECTIONID }}
|
|
||||||
with:
|
|
||||||
registry-auth: |
|
|
||||||
- username: ${{ vars.DOCKERHUB_OIDC_USERNAME }}
|
|
||||||
- registry: ghcr.io
|
|
||||||
username: ${{ github.actor }}
|
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
ecr:
|
ecr:
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
strategy:
|
strategy:
|
||||||
|
|||||||
@@ -35,12 +35,12 @@ jobs:
|
|||||||
node-version: ${{ env.NODE_VERSION }}
|
node-version: ${{ env.NODE_VERSION }}
|
||||||
-
|
-
|
||||||
name: Initialize CodeQL
|
name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@e0647621c2984b5ed2f768cb892365bf2a616ad1 # v4.37.2
|
uses: github/codeql-action/init@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4.37.3
|
||||||
with:
|
with:
|
||||||
languages: javascript-typescript
|
languages: javascript-typescript
|
||||||
build-mode: none
|
build-mode: none
|
||||||
-
|
-
|
||||||
name: Perform CodeQL Analysis
|
name: Perform CodeQL Analysis
|
||||||
uses: github/codeql-action/analyze@e0647621c2984b5ed2f768cb892365bf2a616ad1 # v4.37.2
|
uses: github/codeql-action/analyze@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4.37.3
|
||||||
with:
|
with:
|
||||||
category: "/language:javascript-typescript"
|
category: "/language:javascript-typescript"
|
||||||
|
|||||||
@@ -648,38 +648,6 @@ jobs:
|
|||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
Docker Hub OIDC can also be used with `registry-auth`. Grant `id-token: write`,
|
|
||||||
set `DOCKERHUB_OIDC_CONNECTIONID`, pass the Docker Hub organization name as
|
|
||||||
`username`, and omit `password` for the Docker Hub object:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
name: ci
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: main
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
id-token: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
login:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
-
|
|
||||||
name: Login to registries
|
|
||||||
uses: docker/login-action@v4
|
|
||||||
env:
|
|
||||||
DOCKERHUB_OIDC_CONNECTIONID: ${{ vars.DOCKERHUB_OIDC_CONNECTIONID }}
|
|
||||||
with:
|
|
||||||
registry-auth: |
|
|
||||||
- username: ${{ vars.DOCKERHUB_ORGANIZATION }}
|
|
||||||
- registry: ghcr.io
|
|
||||||
username: ${{ github.actor }}
|
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Set scopes for the authentication token
|
### Set scopes for the authentication token
|
||||||
|
|
||||||
The `scope` input allows limiting registry credentials to a specific repository
|
The `scope` input allows limiting registry credentials to a specific repository
|
||||||
|
|||||||
@@ -54,25 +54,6 @@ test('getAuthList skips secret masking when registry-auth password is absent', a
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('getAuthList supports password-less Docker Hub registry-auth for OIDC', async () => {
|
|
||||||
const [auth] = getAuthList({
|
|
||||||
registry: '',
|
|
||||||
username: '',
|
|
||||||
password: '',
|
|
||||||
scope: '',
|
|
||||||
ecr: '',
|
|
||||||
logout: true,
|
|
||||||
registryAuth: '- username: docker-org\n'
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(auth).toMatchObject({
|
|
||||||
registry: 'docker.io',
|
|
||||||
username: 'docker-org',
|
|
||||||
password: undefined,
|
|
||||||
ecr: 'auto'
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test('getAuthList masks registry-auth password when present', async () => {
|
test('getAuthList masks registry-auth password when present', async () => {
|
||||||
const stdoutWriteSpy = vi.spyOn(process.stdout, 'write').mockImplementation(() => true);
|
const stdoutWriteSpy = vi.spyOn(process.stdout, 'write').mockImplementation(() => true);
|
||||||
getAuthList({
|
getAuthList({
|
||||||
|
|||||||
@@ -1,14 +1,8 @@
|
|||||||
import {afterEach, expect, test, vi} from 'vitest';
|
import {expect, test, vi} from 'vitest';
|
||||||
|
|
||||||
import {Docker} from '@docker/actions-toolkit/lib/docker/docker.js';
|
import {Docker} from '@docker/actions-toolkit/lib/docker/docker.js';
|
||||||
|
|
||||||
import {login, loginStandard, logout} from '../src/docker.js';
|
import {loginStandard, logout} from '../src/docker.js';
|
||||||
import * as dockerhub from '../src/dockerhub.js';
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
vi.restoreAllMocks();
|
|
||||||
delete process.env.DOCKERHUB_OIDC_CONNECTIONID;
|
|
||||||
});
|
|
||||||
|
|
||||||
test('loginStandard calls exec', async () => {
|
test('loginStandard calls exec', async () => {
|
||||||
const execSpy = vi.spyOn(Docker, 'getExecOutput').mockImplementation(async () => {
|
const execSpy = vi.spyOn(Docker, 'getExecOutput').mockImplementation(async () => {
|
||||||
@@ -38,37 +32,6 @@ test('loginStandard calls exec', async () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
test('login exchanges Docker Hub OIDC token for password-less auth', async () => {
|
|
||||||
process.env.DOCKERHUB_OIDC_CONNECTIONID = '123e4567-e89b-42d3-a456-426614174000';
|
|
||||||
const execSpy = vi.spyOn(Docker, 'getExecOutput').mockImplementation(async () => {
|
|
||||||
return {
|
|
||||||
exitCode: 0,
|
|
||||||
stdout: '',
|
|
||||||
stderr: ''
|
|
||||||
};
|
|
||||||
});
|
|
||||||
const oidcSpy = vi.spyOn(dockerhub, 'getOIDCToken').mockResolvedValue({
|
|
||||||
username: 'docker-org',
|
|
||||||
token: 'hub-token'
|
|
||||||
});
|
|
||||||
|
|
||||||
await login({
|
|
||||||
registry: 'docker.io',
|
|
||||||
username: 'docker-org',
|
|
||||||
password: '',
|
|
||||||
scope: '',
|
|
||||||
ecr: 'auto',
|
|
||||||
configDir: ''
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(oidcSpy).toHaveBeenCalledWith('docker.io', 'docker-org');
|
|
||||||
expect(execSpy).toHaveBeenCalledWith(['login', '--password-stdin', '--username', 'docker-org', 'docker.io'], {
|
|
||||||
input: Buffer.from('hub-token'),
|
|
||||||
silent: true,
|
|
||||||
ignoreReturnCode: true
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test('logout calls exec', async () => {
|
test('logout calls exec', async () => {
|
||||||
const execSpy = vi.spyOn(Docker, 'getExecOutput').mockImplementation(async () => {
|
const execSpy = vi.spyOn(Docker, 'getExecOutput').mockImplementation(async () => {
|
||||||
return {
|
return {
|
||||||
|
|||||||
+1
-1
File diff suppressed because one or more lines are too long
+3
-3
File diff suppressed because one or more lines are too long
+5
-2
@@ -12,14 +12,17 @@ interface OIDCTokenResponse {
|
|||||||
access_token: string;
|
access_token: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
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 = 3600;
|
||||||
const maxRetries = 5;
|
const maxRetries = 5;
|
||||||
|
|
||||||
export const isDockerHubOIDC = (registry: string, password: string): boolean => {
|
export const isDockerHubOIDC = (registry: string, password: string): boolean => {
|
||||||
return process.env.DOCKERHUB_OIDC_CONNECTIONID !== undefined && !password && registries.has(registry);
|
return process.env.DOCKERHUB_OIDC_CONNECTIONID !== undefined && !password && isDockerHubRegistry(registry);
|
||||||
|
};
|
||||||
|
|
||||||
|
const isDockerHubRegistry = (registry: string): boolean => {
|
||||||
|
return registry === '' || registry === 'docker.io' || registry === 'registry-1.docker.io' || registry === 'registry-1-stage.docker.io';
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getOIDCToken = async (registry: string, username: string): Promise<LoginCredentials> => {
|
export const getOIDCToken = async (registry: string, username: string): Promise<LoginCredentials> => {
|
||||||
|
|||||||
Reference in New Issue
Block a user