Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 1 addition & 12 deletions bake/bake.go
Original file line number Diff line number Diff line change
Expand Up @@ -1508,18 +1508,7 @@ func toBuildOpt(t *Target, inp *Input) (*build.Options, error) {

secrets := t.Secrets
if isRemoteContext(bi, inp) {
if _, ok := os.LookupEnv("BUILDX_BAKE_GIT_AUTH_TOKEN"); ok {
secrets = append(secrets, &buildflags.Secret{
ID: llb.GitAuthTokenKey,
Env: "BUILDX_BAKE_GIT_AUTH_TOKEN",
})
}
if _, ok := os.LookupEnv("BUILDX_BAKE_GIT_AUTH_HEADER"); ok {
secrets = append(secrets, &buildflags.Secret{
ID: llb.GitAuthHeaderKey,
Env: "BUILDX_BAKE_GIT_AUTH_HEADER",
})
}
secrets = append(secrets, gitAuthSecretsFromEnv()...)
}
bo.SecretSpecs = secrets.Normalize()
secretAttachment, err := build.CreateSecrets(bo.SecretSpecs)
Expand Down
65 changes: 65 additions & 0 deletions bake/gitauth.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
package bake

import (
"os"
"sort"
"strings"

"github.com/docker/buildx/util/buildflags"
"github.com/moby/buildkit/client/llb"
)

const (
bakeGitAuthTokenEnv = "BUILDX_BAKE_GIT_AUTH_TOKEN" // #nosec G101 -- environment variable key, not a credential
bakeGitAuthHeaderEnv = "BUILDX_BAKE_GIT_AUTH_HEADER"
)

func gitAuthSecretsFromEnv() buildflags.Secrets {
return gitAuthSecretsFromEnviron(os.Environ())
}

func gitAuthSecretsFromEnviron(environ []string) buildflags.Secrets {
secrets := make(buildflags.Secrets, 0, 2)
secrets = append(secrets, gitAuthSecretsForEnv(llb.GitAuthTokenKey, bakeGitAuthTokenEnv, environ)...)
secrets = append(secrets, gitAuthSecretsForEnv(llb.GitAuthHeaderKey, bakeGitAuthHeaderEnv, environ)...)
return secrets
}

func gitAuthSecretsForEnv(secretIDPrefix, envPrefix string, environ []string) buildflags.Secrets {
envKeys := findGitAuthEnvKeys(envPrefix, environ)
secrets := make(buildflags.Secrets, 0, len(envKeys))
for _, envKey := range envKeys {
suffix := envKey[len(envPrefix):]
secrets = append(secrets, &buildflags.Secret{
ID: secretIDPrefix + suffix,
Env: envKey,
})
}
return secrets
}

func findGitAuthEnvKeys(envPrefix string, environ []string) []string {
prefixUpper := strings.ToUpper(envPrefix)
var keys []string
for _, env := range environ {
key, _, ok := strings.Cut(env, "=")
if !ok {
continue
}
if !strings.HasPrefix(strings.ToUpper(key), prefixUpper) {
continue
}
if len(key) == len(envPrefix) {
keys = append(keys, key)
continue
}
if len(key) <= len(envPrefix)+1 {
continue
}
if key[len(envPrefix)] == '.' {
keys = append(keys, key)
}
}
sort.Strings(keys)
return keys
}
53 changes: 53 additions & 0 deletions bake/gitauth_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
package bake

import (
"testing"

"github.com/docker/buildx/util/buildflags"
"github.com/moby/buildkit/client/llb"
"github.com/stretchr/testify/require"
)

func TestGitAuthSecretsFromEnviron(t *testing.T) {
t.Run("base keys", func(t *testing.T) {
secrets := gitAuthSecretsFromEnviron([]string{
bakeGitAuthTokenEnv + "=token",
bakeGitAuthHeaderEnv + "=basic",
})
require.Equal(t, []string{
llb.GitAuthTokenKey + "|" + bakeGitAuthTokenEnv,
llb.GitAuthHeaderKey + "|" + bakeGitAuthHeaderEnv,
}, secretPairs(secrets))
})
t.Run("domain suffix keys", func(t *testing.T) {
secrets := gitAuthSecretsFromEnviron([]string{
bakeGitAuthTokenEnv + ".github.com=token",
bakeGitAuthHeaderEnv + ".github.com=bearer",
bakeGitAuthTokenEnv + ".example.com=token2",
bakeGitAuthTokenEnv + "=fallback",
})
require.Equal(t, []string{
llb.GitAuthTokenKey + "|" + bakeGitAuthTokenEnv,
llb.GitAuthTokenKey + ".example.com|" + bakeGitAuthTokenEnv + ".example.com",
llb.GitAuthTokenKey + ".github.com|" + bakeGitAuthTokenEnv + ".github.com",
llb.GitAuthHeaderKey + ".github.com|" + bakeGitAuthHeaderEnv + ".github.com",
}, secretPairs(secrets))
})
t.Run("ignores non-domain suffix", func(t *testing.T) {
secrets := gitAuthSecretsFromEnviron([]string{
bakeGitAuthTokenEnv + "_EXTRA=token",
bakeGitAuthHeaderEnv + "-extra=basic",
bakeGitAuthTokenEnv + ".=bad",
bakeGitAuthHeaderEnv + ".=bad",
})
require.Empty(t, secrets)
})
}

func secretPairs(secrets buildflags.Secrets) []string {
out := make([]string, 0, len(secrets))
for _, s := range secrets {
out = append(out, s.ID+"|"+s.Env)
}
return out
}
14 changes: 1 addition & 13 deletions bake/remote.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,7 @@ func ReadRemoteFiles(ctx context.Context, nodes []builder.Node, url string, name
}}); err == nil {
sessions = append(sessions, ssh)
}
var gitAuthSecrets []*buildflags.Secret
if _, ok := os.LookupEnv("BUILDX_BAKE_GIT_AUTH_TOKEN"); ok {
gitAuthSecrets = append(gitAuthSecrets, &buildflags.Secret{
ID: llb.GitAuthTokenKey,
Env: "BUILDX_BAKE_GIT_AUTH_TOKEN",
})
}
if _, ok := os.LookupEnv("BUILDX_BAKE_GIT_AUTH_HEADER"); ok {
gitAuthSecrets = append(gitAuthSecrets, &buildflags.Secret{
ID: llb.GitAuthHeaderKey,
Env: "BUILDX_BAKE_GIT_AUTH_HEADER",
})
}
gitAuthSecrets := gitAuthSecretsFromEnv()
if len(gitAuthSecrets) > 0 {
if secrets, err := build.CreateSecrets(gitAuthSecrets); err == nil {
sessions = append(sessions, secrets)
Expand Down
41 changes: 41 additions & 0 deletions tests/bake.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"encoding/json"
"encoding/pem"
"fmt"
"net/url"
"os"
"path/filepath"
"strconv"
Expand Down Expand Up @@ -45,6 +46,7 @@ var bakeTests = []func(t *testing.T, sb integration.Sandbox){
testBakeLocalMulti,
testBakeRemote,
testBakeRemoteAuth,
testBakeRemoteAuthHostSuffix,
testBakeRemoteCmdContext,
testBakeRemoteLocalOverride,
testBakeLocalCwdOverride,
Expand Down Expand Up @@ -662,6 +664,45 @@ EOT
require.FileExists(t, filepath.Join(dirDest, "foo"))
}

func testBakeRemoteAuthHostSuffix(t *testing.T, sb integration.Sandbox) {
bakefile := []byte(`
target "default" {
dockerfile-inline = <<EOT
FROM scratch
COPY foo /foo
EOT
}
`)
dir := tmpdir(
t,
fstest.CreateFile("docker-bake.hcl", bakefile, 0600),
fstest.CreateFile("foo", []byte("foo"), 0600),
)
dirDest := t.TempDir()

git, err := gitutil.New(gitutil.WithWorkingDir(dir))
require.NoError(t, err)

gittestutil.GitInit(git, t)
gittestutil.GitAdd(git, t, "docker-bake.hcl", "foo")
gittestutil.GitCommit(git, t, "initial commit")

token := identity.NewID()
addr := gittestutil.GitServeHTTP(git, t, gittestutil.WithAccessToken(token))
parsed, err := url.Parse(addr)
require.NoError(t, err)
host := parsed.Host
require.NotEmpty(t, host)

out, err := bakeCmd(sb, withDir(dir),
withEnv("BUILDX_BAKE_GIT_AUTH_TOKEN."+host+"="+token),
withArgs(addr, "--set", "*.output=type=local,dest="+dirDest),
)
require.NoError(t, err, out)

require.FileExists(t, filepath.Join(dirDest, "foo"))
}

func testBakeRemoteLocalOverride(t *testing.T, sb integration.Sandbox) {
remoteBakefile := []byte(`
target "default" {
Expand Down