1containers-auth.json(5)() containers-auth.json(5)()
2
3
4
6 containers-auth.json - syntax for the registry authentication file
7
8
9
11 A credentials file in JSON format used to authenticate against con‐
12 tainer image registries. On Linux it is stored at ${XDG_RUN‐
13 TIME_DIR}/containers/auth.json; on Windows and macOS, at $HOME/.con‐
14 fig/containers/auth.json
15
16
18 The auth.json file stores encrypted authentication information for the
19 user to container image registries. The file can have zero to many
20 entries and is created by a login command from a container tool such as
21 podman login, buildah login or skopeo login. Each entry includes the
22 name of the registry and then an auth token in the form of a base64
23 encoded string from the concatenation of the username, a colon, and the
24 password.
25
26
27 The following example shows the values found in auth.json after the
28 user logged in to their accounts on quay.io and docker.io:
29
30
31 {
32 "auths": {
33 "docker.io": {
34 "auth": "erfi7sYi89234xJUqaqxgmzcnQ2rRFWM5aJX0EC="
35 },
36 "quay.io": {
37 "auth": "juQAqGmz5eR1ipzx8Evn6KGdw8fEa1w5MWczmgY="
38 }
39 }
40 }
41
42
43
44 An entry can be removed by using a logout command from a container tool
45 such as podman logout or buildah logout.
46
47
48 In addition, credential helpers can be configured for specific reg‐
49 istries and the credentials-helper software can be used to manage the
50 credentials in a more secure way than depending on the base64 encoded
51 authentication provided by login. If the credential helpers are con‐
52 figured for specific registries, the base64 encoded authentication will
53 not be used for operations concerning credentials of the specified reg‐
54 istries.
55
56
57 When the credential helper is in use on a Linux platform, the auth.json
58 file would contain keys that specify the registry domain, and values
59 that specify the suffix of the program to use (i.e. everything after
60 docker-credential-). For example:
61
62
63 {
64 "auths": {
65 "localhost:5001": {}
66 },
67 "credHelpers": {
68 "registry.example.com": "secretservice"
69 }
70 }
71
72
73
74 For more information on credential helpers, please reference the GitHub
75 docker-credential-helpers project ⟨https://github.com/docker/docker-
76 credential-helpers/releases⟩.
77
78
79
81 buildah-login(1), buildah-logout(1), podman-login(1), podman-logout(1), skopeo-login(1), skopeo-logout(1)
82
83
84
85
87 Feb 2020, Originally compiled by Tom Sweeney tsweeney@redhat.com
88 ⟨mailto:tsweeney@redhat.com⟩
89
90
91
92 containers-auth.json(5)()