generated from sigstore/sigstore-project-template
-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add file based configuration. (#121)
This adds [git-config](https://git-scm.com/docs/git-config) based configuration for gitsign values. Caveats: - GITSIGN_CREDENTIAL_CACHE intentionally not supported since this is likely changing soon. - We do not use subsections (i.e. we use gitsign.issuer instead of gitsign.oidc.issuer). This gives us some wiggle room to add host based config later on similar to https://git-scm.com/docs/gitcredentials Signed-off-by: Billy Lynch <billy@chainguard.dev> Signed-off-by: Billy Lynch <billy@chainguard.dev>
- Loading branch information
Showing
12 changed files
with
289 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| // Copyright 2022 The Sigstore Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package config | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/go-git/go-git/v5" | ||
| "github.com/go-git/go-git/v5/config" | ||
| format "github.com/go-git/go-git/v5/plumbing/format/config" | ||
| ) | ||
|
|
||
| // Config represents configuration options for gitsign. | ||
| type Config struct { | ||
| // Address of Fulcio server | ||
| Fulcio string | ||
| // Address of Rekor server | ||
| Rekor string | ||
|
|
||
| // OIDC client ID for application | ||
| ClientID string | ||
| // OIDC Redirect URL | ||
| RedirectURL string | ||
| // OIDC provider to be used to issue ID token | ||
| Issuer string | ||
|
|
||
| // Path to log status output. Helpful for debugging when no TTY is available in the environment. | ||
| LogPath string | ||
| } | ||
|
|
||
| // Get fetches the gitsign config options for the repo in the current working | ||
| // directory. | ||
| func Get() (*Config, error) { | ||
| repo, err := git.PlainOpenWithOptions(".", &git.PlainOpenOptions{DetectDotGit: true}) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return getWithRepo(repo) | ||
| } | ||
|
|
||
| // getWithRepo fetches a config for a given repository. This is separated out | ||
| // from Get so that we can create in-memory repos for testing. | ||
| func getWithRepo(repo *git.Repository) (*Config, error) { | ||
| cfg, err := repo.ConfigScoped(config.GlobalScope) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| out := &Config{ | ||
| Fulcio: "https://fulcio.sigstore.dev", | ||
| Rekor: "https://rekor.sigstore.dev", | ||
| ClientID: "sigstore", | ||
| Issuer: "https://oauth2.sigstore.dev/auth", | ||
| } | ||
|
|
||
| // Get values from config file. | ||
| for _, s := range cfg.Raw.Sections { | ||
| if s.IsName("gitsign") { | ||
| applyGitOptions(out, s.Options) | ||
| } | ||
| } | ||
|
|
||
| // Get values from env vars | ||
| out.Fulcio = envOrValue("GITSIGN_FULCIO_URL", out.Fulcio) | ||
| out.Rekor = envOrValue("GITSIGN_REKOR_URL", out.Rekor) | ||
| out.ClientID = envOrValue("GITSIGN_OIDC_CLIENT_ID", out.ClientID) | ||
| out.RedirectURL = envOrValue("GITSIGN_OIDC_REDIRECT_URL", out.RedirectURL) | ||
| out.Issuer = envOrValue("GITSIGN_OIDC_ISSUER", out.Issuer) | ||
| out.LogPath = envOrValue("GITSIGN_LOG", out.LogPath) | ||
|
|
||
| return out, nil | ||
| } | ||
|
|
||
| func applyGitOptions(out *Config, opts format.Options) { | ||
| // Iterate over options once instead of using Get (which itself iterates | ||
| // over options until a matching key is found). | ||
| for _, o := range opts { | ||
| switch o.Key { | ||
| case "fulcio": | ||
| out.Fulcio = o.Value | ||
| case "rekor": | ||
| out.Rekor = o.Value | ||
| case "clientID": | ||
| out.ClientID = o.Value | ||
| case "redirectURL": | ||
| out.RedirectURL = o.Value | ||
| case "issuer": | ||
| out.Issuer = o.Value | ||
| case "logPath": | ||
| out.LogPath = o.Value | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func envOrValue(env, value string) string { | ||
| // Only override values if the environment variable is set. | ||
| if v, ok := os.LookupEnv(env); ok { | ||
| return v | ||
| } | ||
| return value | ||
| } |
Oops, something went wrong.