git.iko.soy/typeable/oauth2-proxy
on v4.1.0 help sign in
typeable/oauth2-proxy/options.go
628 lines 26 kB history raw
1package main
3import (
4 "context"
5 "crypto"
6 "crypto/tls"
7 "encoding/base64"
8 "fmt"
9 "io/ioutil"
10 "net/http"
11 "net/url"
12 "os"
13 "regexp"
14 "strings"
15 "time"
17 oidc "github.com/coreos/go-oidc"
18 "github.com/dgrijalva/jwt-go"
19 "github.com/mbland/hmacauth"
20 "github.com/pusher/oauth2_proxy/pkg/apis/options"
21 sessionsapi "github.com/pusher/oauth2_proxy/pkg/apis/sessions"
22 "github.com/pusher/oauth2_proxy/pkg/encryption"
23 "github.com/pusher/oauth2_proxy/pkg/logger"
24 "github.com/pusher/oauth2_proxy/pkg/sessions"
25 "github.com/pusher/oauth2_proxy/providers"
26 "gopkg.in/natefinch/lumberjack.v2"
29// Options holds Configuration Options that can be set by Command Line Flag,
30// or Config File
31type Options struct {
32 ProxyPrefix string `flag:"proxy-prefix" cfg:"proxy_prefix" env:"OAUTH2_PROXY_PROXY_PREFIX"`
33 PingPath string `flag:"ping-path" cfg:"ping_path" env:"OAUTH2_PROXY_PING_PATH"`
34 ProxyWebSockets bool `flag:"proxy-websockets" cfg:"proxy_websockets" env:"OAUTH2_PROXY_PROXY_WEBSOCKETS"`
35 HTTPAddress string `flag:"http-address" cfg:"http_address" env:"OAUTH2_PROXY_HTTP_ADDRESS"`
36 HTTPSAddress string `flag:"https-address" cfg:"https_address" env:"OAUTH2_PROXY_HTTPS_ADDRESS"`
37 ForceHTTPS bool `flag:"force-https" cfg:"force_https" env:"OAUTH2_PROXY_FORCE_HTTPS"`
38 RedirectURL string `flag:"redirect-url" cfg:"redirect_url" env:"OAUTH2_PROXY_REDIRECT_URL"`
39 ClientID string `flag:"client-id" cfg:"client_id" env:"OAUTH2_PROXY_CLIENT_ID"`
40 ClientSecret string `flag:"client-secret" cfg:"client_secret" env:"OAUTH2_PROXY_CLIENT_SECRET"`
41 TLSCertFile string `flag:"tls-cert-file" cfg:"tls_cert_file" env:"OAUTH2_PROXY_TLS_CERT_FILE"`
42 TLSKeyFile string `flag:"tls-key-file" cfg:"tls_key_file" env:"OAUTH2_PROXY_TLS_KEY_FILE"`
44 AuthenticatedEmailsFile string `flag:"authenticated-emails-file" cfg:"authenticated_emails_file" env:"OAUTH2_PROXY_AUTHENTICATED_EMAILS_FILE"`
45 KeycloakGroup string `flag:"keycloak-group" cfg:"keycloak_group" env:"OAUTH2_PROXY_KEYCLOAK_GROUP"`
46 AzureTenant string `flag:"azure-tenant" cfg:"azure_tenant" env:"OAUTH2_PROXY_AZURE_TENANT"`
47 BitbucketTeam string `flag:"bitbucket-team" cfg:"bitbucket_team" env:"OAUTH2_PROXY_BITBUCKET_TEAM"`
48 BitbucketRepository string `flag:"bitbucket-repository" cfg:"bitbucket_repository" env:"OAUTH2_PROXY_BITBUCKET_REPOSITORY"`
49 EmailDomains []string `flag:"email-domain" cfg:"email_domains" env:"OAUTH2_PROXY_EMAIL_DOMAINS"`
50 WhitelistDomains []string `flag:"whitelist-domain" cfg:"whitelist_domains" env:"OAUTH2_PROXY_WHITELIST_DOMAINS"`
51 GitHubOrg string `flag:"github-org" cfg:"github_org" env:"OAUTH2_PROXY_GITHUB_ORG"`
52 GitHubTeam string `flag:"github-team" cfg:"github_team" env:"OAUTH2_PROXY_GITHUB_TEAM"`
53 GitLabGroup string `flag:"gitlab-group" cfg:"gitlab_group" env:"OAUTH2_PROXY_GITLAB_GROUP"`
54 GoogleGroups []string `flag:"google-group" cfg:"google_group" env:"OAUTH2_PROXY_GOOGLE_GROUPS"`
55 GoogleAdminEmail string `flag:"google-admin-email" cfg:"google_admin_email" env:"OAUTH2_PROXY_GOOGLE_ADMIN_EMAIL"`
56 GoogleServiceAccountJSON string `flag:"google-service-account-json" cfg:"google_service_account_json" env:"OAUTH2_PROXY_GOOGLE_SERVICE_ACCOUNT_JSON"`
57 HtpasswdFile string `flag:"htpasswd-file" cfg:"htpasswd_file" env:"OAUTH2_PROXY_HTPASSWD_FILE"`
58 DisplayHtpasswdForm bool `flag:"display-htpasswd-form" cfg:"display_htpasswd_form" env:"OAUTH2_PROXY_DISPLAY_HTPASSWD_FORM"`
59 CustomTemplatesDir string `flag:"custom-templates-dir" cfg:"custom_templates_dir" env:"OAUTH2_PROXY_CUSTOM_TEMPLATES_DIR"`
60 Banner string `flag:"banner" cfg:"banner" env:"OAUTH2_PROXY_BANNER"`
61 Footer string `flag:"footer" cfg:"footer" env:"OAUTH2_PROXY_FOOTER"`
63 // Embed CookieOptions
64 options.CookieOptions
66 // Embed SessionOptions
67 options.SessionOptions
69 Upstreams []string `flag:"upstream" cfg:"upstreams" env:"OAUTH2_PROXY_UPSTREAMS"`
70 SkipAuthRegex []string `flag:"skip-auth-regex" cfg:"skip_auth_regex" env:"OAUTH2_PROXY_SKIP_AUTH_REGEX"`
71 SkipJwtBearerTokens bool `flag:"skip-jwt-bearer-tokens" cfg:"skip_jwt_bearer_tokens" env:"OAUTH2_PROXY_SKIP_JWT_BEARER_TOKENS"`
72 ExtraJwtIssuers []string `flag:"extra-jwt-issuers" cfg:"extra_jwt_issuers" env:"OAUTH2_PROXY_EXTRA_JWT_ISSUERS"`
73 PassBasicAuth bool `flag:"pass-basic-auth" cfg:"pass_basic_auth" env:"OAUTH2_PROXY_PASS_BASIC_AUTH"`
74 BasicAuthPassword string `flag:"basic-auth-password" cfg:"basic_auth_password" env:"OAUTH2_PROXY_BASIC_AUTH_PASSWORD"`
75 PassAccessToken bool `flag:"pass-access-token" cfg:"pass_access_token" env:"OAUTH2_PROXY_PASS_ACCESS_TOKEN"`
76 PassHostHeader bool `flag:"pass-host-header" cfg:"pass_host_header" env:"OAUTH2_PROXY_PASS_HOST_HEADER"`
77 SkipProviderButton bool `flag:"skip-provider-button" cfg:"skip_provider_button" env:"OAUTH2_PROXY_SKIP_PROVIDER_BUTTON"`
78 PassUserHeaders bool `flag:"pass-user-headers" cfg:"pass_user_headers" env:"OAUTH2_PROXY_PASS_USER_HEADERS"`
79 SSLInsecureSkipVerify bool `flag:"ssl-insecure-skip-verify" cfg:"ssl_insecure_skip_verify" env:"OAUTH2_PROXY_SSL_INSECURE_SKIP_VERIFY"`
80 SSLUpstreamInsecureSkipVerify bool `flag:"ssl-upstream-insecure-skip-verify" cfg:"ssl_upstream_insecure_skip_verify" env:"OAUTH2_PROXY_SSL_UPSTREAM_INSECURE_SKIP_VERIFY"`
81 SetXAuthRequest bool `flag:"set-xauthrequest" cfg:"set_xauthrequest" env:"OAUTH2_PROXY_SET_XAUTHREQUEST"`
82 SetAuthorization bool `flag:"set-authorization-header" cfg:"set_authorization_header" env:"OAUTH2_PROXY_SET_AUTHORIZATION_HEADER"`
83 PassAuthorization bool `flag:"pass-authorization-header" cfg:"pass_authorization_header" env:"OAUTH2_PROXY_PASS_AUTHORIZATION_HEADER"`
84 SkipAuthPreflight bool `flag:"skip-auth-preflight" cfg:"skip_auth_preflight" env:"OAUTH2_PROXY_SKIP_AUTH_PREFLIGHT"`
85 FlushInterval time.Duration `flag:"flush-interval" cfg:"flush_interval" env:"OAUTH2_PROXY_FLUSH_INTERVAL"`
87 // These options allow for other providers besides Google, with
88 // potential overrides.
89 Provider string `flag:"provider" cfg:"provider" env:"OAUTH2_PROXY_PROVIDER"`
90 ProviderName string `flag:"provider-display-name" cfg:"provider_display_name" env:"OAUTH2_PROXY_PROVIDER_DISPLAY_NAME"`
91 OIDCIssuerURL string `flag:"oidc-issuer-url" cfg:"oidc_issuer_url" env:"OAUTH2_PROXY_OIDC_ISSUER_URL"`
92 InsecureOIDCAllowUnverifiedEmail bool `flag:"insecure-oidc-allow-unverified-email" cfg:"insecure_oidc_allow_unverified_email" env:"OAUTH2_PROXY_INSECURE_OIDC_ALLOW_UNVERIFIED_EMAIL"`
93 SkipOIDCDiscovery bool `flag:"skip-oidc-discovery" cfg:"skip_oidc_discovery" env:"OAUTH2_PROXY_SKIP_OIDC_DISCOVERY"`
94 OIDCJwksURL string `flag:"oidc-jwks-url" cfg:"oidc_jwks_url" env:"OAUTH2_PROXY_OIDC_JWKS_URL"`
95 LoginURL string `flag:"login-url" cfg:"login_url" env:"OAUTH2_PROXY_LOGIN_URL"`
96 RedeemURL string `flag:"redeem-url" cfg:"redeem_url" env:"OAUTH2_PROXY_REDEEM_URL"`
97 ProfileURL string `flag:"profile-url" cfg:"profile_url" env:"OAUTH2_PROXY_PROFILE_URL"`
98 ProtectedResource string `flag:"resource" cfg:"resource" env:"OAUTH2_PROXY_RESOURCE"`
99 ValidateURL string `flag:"validate-url" cfg:"validate_url" env:"OAUTH2_PROXY_VALIDATE_URL"`
100 Scope string `flag:"scope" cfg:"scope" env:"OAUTH2_PROXY_SCOPE"`
101 ApprovalPrompt string `flag:"approval-prompt" cfg:"approval_prompt" env:"OAUTH2_PROXY_APPROVAL_PROMPT"`
103 // Configuration values for logging
104 LoggingFilename string `flag:"logging-filename" cfg:"logging_filename" env:"OAUTH2_PROXY_LOGGING_FILENAME"`
105 LoggingMaxSize int `flag:"logging-max-size" cfg:"logging_max_size" env:"OAUTH2_PROXY_LOGGING_MAX_SIZE"`
106 LoggingMaxAge int `flag:"logging-max-age" cfg:"logging_max_age" env:"OAUTH2_PROXY_LOGGING_MAX_AGE"`
107 LoggingMaxBackups int `flag:"logging-max-backups" cfg:"logging_max_backups" env:"OAUTH2_PROXY_LOGGING_MAX_BACKUPS"`
108 LoggingLocalTime bool `flag:"logging-local-time" cfg:"logging_local_time" env:"OAUTH2_PROXY_LOGGING_LOCAL_TIME"`
109 LoggingCompress bool `flag:"logging-compress" cfg:"logging_compress" env:"OAUTH2_PROXY_LOGGING_COMPRESS"`
110 StandardLogging bool `flag:"standard-logging" cfg:"standard_logging" env:"OAUTH2_PROXY_STANDARD_LOGGING"`
111 StandardLoggingFormat string `flag:"standard-logging-format" cfg:"standard_logging_format" env:"OAUTH2_PROXY_STANDARD_LOGGING_FORMAT"`
112 RequestLogging bool `flag:"request-logging" cfg:"request_logging" env:"OAUTH2_PROXY_REQUEST_LOGGING"`
113 RequestLoggingFormat string `flag:"request-logging-format" cfg:"request_logging_format" env:"OAUTH2_PROXY_REQUEST_LOGGING_FORMAT"`
114 ExcludeLoggingPaths string `flag:"exclude-logging-paths" cfg:"exclude_logging_paths" env:"OAUTH2_PROXY_EXCLUDE_LOGGING_PATHS"`
115 SilencePingLogging bool `flag:"silence-ping-logging" cfg:"silence_ping_logging" env:"OAUTH2_PROXY_SILENCE_PING_LOGGING"`
116 AuthLogging bool `flag:"auth-logging" cfg:"auth_logging" env:"OAUTH2_PROXY_LOGGING_AUTH_LOGGING"`
117 AuthLoggingFormat string `flag:"auth-logging-format" cfg:"auth_logging_format" env:"OAUTH2_PROXY_AUTH_LOGGING_FORMAT"`
118 SignatureKey string `flag:"signature-key" cfg:"signature_key" env:"OAUTH2_PROXY_SIGNATURE_KEY"`
119 AcrValues string `flag:"acr-values" cfg:"acr_values" env:"OAUTH2_PROXY_ACR_VALUES"`
120 JWTKey string `flag:"jwt-key" cfg:"jwt_key" env:"OAUTH2_PROXY_JWT_KEY"`
121 JWTKeyFile string `flag:"jwt-key-file" cfg:"jwt_key_file" env:"OAUTH2_PROXY_JWT_KEY_FILE"`
122 PubJWKURL string `flag:"pubjwk-url" cfg:"pubjwk_url" env:"OAUTH2_PROXY_PUBJWK_URL"`
123 GCPHealthChecks bool `flag:"gcp-healthchecks" cfg:"gcp_healthchecks" env:"OAUTH2_PROXY_GCP_HEALTHCHECKS"`
125 // internal values that are set after config validation
126 redirectURL *url.URL
127 proxyURLs []*url.URL
128 CompiledRegex []*regexp.Regexp
129 provider providers.Provider
130 sessionStore sessionsapi.SessionStore
131 signatureData *SignatureData
132 oidcVerifier *oidc.IDTokenVerifier
133 jwtBearerVerifiers []*oidc.IDTokenVerifier
136// SignatureData holds hmacauth signature hash and key
137type SignatureData struct {
138 hash crypto.Hash
139 key string
142// NewOptions constructs a new Options with defaulted values
143func NewOptions() *Options {
144 return &Options{
145 ProxyPrefix: "/oauth2",
146 PingPath: "/ping",
147 ProxyWebSockets: true,
148 HTTPAddress: "127.0.0.1:4180",
149 HTTPSAddress: ":443",
150 ForceHTTPS: false,
151 DisplayHtpasswdForm: true,
152 CookieOptions: options.CookieOptions{
153 CookieName: "_oauth2_proxy",
154 CookieSecure: true,
155 CookieHTTPOnly: true,
156 CookieExpire: time.Duration(168) * time.Hour,
157 CookieRefresh: time.Duration(0),
158 },
159 SessionOptions: options.SessionOptions{
160 Type: "cookie",
161 },
162 SetXAuthRequest: false,
163 SkipAuthPreflight: false,
164 PassBasicAuth: true,
165 PassUserHeaders: true,
166 PassAccessToken: false,
167 PassHostHeader: true,
168 SetAuthorization: false,
169 PassAuthorization: false,
170 ApprovalPrompt: "force",
171 InsecureOIDCAllowUnverifiedEmail: false,
172 SkipOIDCDiscovery: false,
173 LoggingFilename: "",
174 LoggingMaxSize: 100,
175 LoggingMaxAge: 7,
176 LoggingMaxBackups: 0,
177 LoggingLocalTime: true,
178 LoggingCompress: false,
179 ExcludeLoggingPaths: "",
180 SilencePingLogging: false,
181 StandardLogging: true,
182 StandardLoggingFormat: logger.DefaultStandardLoggingFormat,
183 RequestLogging: true,
184 RequestLoggingFormat: logger.DefaultRequestLoggingFormat,
185 AuthLogging: true,
186 AuthLoggingFormat: logger.DefaultAuthLoggingFormat,
187 }
190// jwtIssuer hold parsed JWT issuer info that's used to construct a verifier.
191type jwtIssuer struct {
192 issuerURI string
193 audience string
196func parseURL(toParse string, urltype string, msgs []string) (*url.URL, []string) {
197 parsed, err := url.Parse(toParse)
198 if err != nil {
199 return nil, append(msgs, fmt.Sprintf(
200 "error parsing %s-url=%q %s", urltype, toParse, err))
201 }
202 return parsed, msgs
205// Validate checks that required options are set and validates those that they
206// are of the correct format
207func (o *Options) Validate() error {
208 if o.SSLInsecureSkipVerify {
209 // TODO: Accept a certificate bundle.
210 insecureTransport := &http.Transport{
211 TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
212 }
213 http.DefaultClient = &http.Client{Transport: insecureTransport}
214 }
216 msgs := make([]string, 0)
217 if o.CookieSecret == "" {
218 msgs = append(msgs, "missing setting: cookie-secret")
219 }
220 if o.ClientID == "" {
221 msgs = append(msgs, "missing setting: client-id")
222 }
223 // login.gov uses a signed JWT to authenticate, not a client-secret
224 if o.ClientSecret == "" && o.Provider != "login.gov" {
225 msgs = append(msgs, "missing setting: client-secret")
226 }
227 if o.AuthenticatedEmailsFile == "" && len(o.EmailDomains) == 0 && o.HtpasswdFile == "" {
228 msgs = append(msgs, "missing setting for email validation: email-domain or authenticated-emails-file required."+
229 "\n use email-domain=* to authorize all email addresses")
230 }
232 if o.OIDCIssuerURL != "" {
234 ctx := context.Background()
236 // Construct a manual IDTokenVerifier from issuer URL & JWKS URI
237 // instead of metadata discovery if we enable -skip-oidc-discovery.
238 // In this case we need to make sure the required endpoints for
239 // the provider are configured.
240 if o.SkipOIDCDiscovery {
241 if o.LoginURL == "" {
242 msgs = append(msgs, "missing setting: login-url")
243 }
244 if o.RedeemURL == "" {
245 msgs = append(msgs, "missing setting: redeem-url")
246 }
247 if o.OIDCJwksURL == "" {
248 msgs = append(msgs, "missing setting: oidc-jwks-url")
249 }
250 keySet := oidc.NewRemoteKeySet(ctx, o.OIDCJwksURL)
251 o.oidcVerifier = oidc.NewVerifier(o.OIDCIssuerURL, keySet, &oidc.Config{
252 ClientID: o.ClientID,
253 })
254 } else {
255 // Configure discoverable provider data.
256 provider, err := oidc.NewProvider(ctx, o.OIDCIssuerURL)
257 if err != nil {
258 return err
259 }
260 o.oidcVerifier = provider.Verifier(&oidc.Config{
261 ClientID: o.ClientID,
262 })
264 o.LoginURL = provider.Endpoint().AuthURL
265 o.RedeemURL = provider.Endpoint().TokenURL
266 }
267 if o.Scope == "" {
268 o.Scope = "openid email profile"
269 }
270 }
272 if o.SkipJwtBearerTokens {
273 // If we are using an oidc provider, go ahead and add that provider to the list
274 if o.oidcVerifier != nil {
275 o.jwtBearerVerifiers = append(o.jwtBearerVerifiers, o.oidcVerifier)
276 }
277 // Configure extra issuers
278 if len(o.ExtraJwtIssuers) > 0 {
279 var jwtIssuers []jwtIssuer
280 jwtIssuers, msgs = parseJwtIssuers(o.ExtraJwtIssuers, msgs)
281 for _, jwtIssuer := range jwtIssuers {
282 verifier, err := newVerifierFromJwtIssuer(jwtIssuer)
283 if err != nil {
284 msgs = append(msgs, fmt.Sprintf("error building verifiers: %s", err))
285 }
286 o.jwtBearerVerifiers = append(o.jwtBearerVerifiers, verifier)
287 }
288 }
289 }
291 o.redirectURL, msgs = parseURL(o.RedirectURL, "redirect", msgs)
293 for _, u := range o.Upstreams {
294 upstreamURL, err := url.Parse(u)
295 if err != nil {
296 msgs = append(msgs, fmt.Sprintf("error parsing upstream: %s", err))
297 } else {
298 if upstreamURL.Path == "" {
299 upstreamURL.Path = "/"
300 }
301 o.proxyURLs = append(o.proxyURLs, upstreamURL)
302 }
303 }
305 for _, u := range o.SkipAuthRegex {
306 CompiledRegex, err := regexp.Compile(u)
307 if err != nil {
308 msgs = append(msgs, fmt.Sprintf("error compiling regex=%q %s", u, err))
309 continue
310 }
311 o.CompiledRegex = append(o.CompiledRegex, CompiledRegex)
312 }
313 msgs = parseProviderInfo(o, msgs)
315 var cipher *encryption.Cipher
316 if o.PassAccessToken || o.SetAuthorization || o.PassAuthorization || (o.CookieRefresh != time.Duration(0)) {
317 validCookieSecretSize := false
318 for _, i := range []int{16, 24, 32} {
319 if len(secretBytes(o.CookieSecret)) == i {
320 validCookieSecretSize = true
321 }
322 }
323 var decoded bool
324 if string(secretBytes(o.CookieSecret)) != o.CookieSecret {
325 decoded = true
326 }
327 if validCookieSecretSize == false {
328 var suffix string
329 if decoded {
330 suffix = fmt.Sprintf(" note: cookie secret was base64 decoded from %q", o.CookieSecret)
331 }
332 msgs = append(msgs, fmt.Sprintf(
333 "cookie_secret must be 16, 24, or 32 bytes "+
334 "to create an AES cipher when "+
335 "pass_access_token == true or "+
336 "cookie_refresh != 0, but is %d bytes.%s",
337 len(secretBytes(o.CookieSecret)), suffix))
338 } else {
339 var err error
340 cipher, err = encryption.NewCipher(secretBytes(o.CookieSecret))
341 if err != nil {
342 msgs = append(msgs, fmt.Sprintf("cookie-secret error: %v", err))
343 }
344 }
345 }
347 o.SessionOptions.Cipher = cipher
348 sessionStore, err := sessions.NewSessionStore(&o.SessionOptions, &o.CookieOptions)
349 if err != nil {
350 msgs = append(msgs, fmt.Sprintf("error initialising session storage: %v", err))
351 } else {
352 o.sessionStore = sessionStore
353 }
355 if o.CookieRefresh >= o.CookieExpire {
356 msgs = append(msgs, fmt.Sprintf(
357 "cookie_refresh (%s) must be less than "+
358 "cookie_expire (%s)",
359 o.CookieRefresh.String(),
360 o.CookieExpire.String()))
361 }
363 if len(o.GoogleGroups) > 0 || o.GoogleAdminEmail != "" || o.GoogleServiceAccountJSON != "" {
364 if len(o.GoogleGroups) < 1 {
365 msgs = append(msgs, "missing setting: google-group")
366 }
367 if o.GoogleAdminEmail == "" {
368 msgs = append(msgs, "missing setting: google-admin-email")
369 }
370 if o.GoogleServiceAccountJSON == "" {
371 msgs = append(msgs, "missing setting: google-service-account-json")
372 }
373 }
375 msgs = parseSignatureKey(o, msgs)
376 msgs = validateCookieName(o, msgs)
377 msgs = setupLogger(o, msgs)
379 if len(msgs) != 0 {
380 return fmt.Errorf("Invalid configuration:\n %s",
381 strings.Join(msgs, "\n "))
382 }
383 return nil
386func parseProviderInfo(o *Options, msgs []string) []string {
387 p := &providers.ProviderData{
388 Scope: o.Scope,
389 ClientID: o.ClientID,
390 ClientSecret: o.ClientSecret,
391 ApprovalPrompt: o.ApprovalPrompt,
392 }
393 p.LoginURL, msgs = parseURL(o.LoginURL, "login", msgs)
394 p.RedeemURL, msgs = parseURL(o.RedeemURL, "redeem", msgs)
395 p.ProfileURL, msgs = parseURL(o.ProfileURL, "profile", msgs)
396 p.ValidateURL, msgs = parseURL(o.ValidateURL, "validate", msgs)
397 p.ProtectedResource, msgs = parseURL(o.ProtectedResource, "resource", msgs)
399 o.provider = providers.New(o.Provider, p)
400 switch p := o.provider.(type) {
401 case *providers.AzureProvider:
402 p.Configure(o.AzureTenant)
403 case *providers.GitHubProvider:
404 p.SetOrgTeam(o.GitHubOrg, o.GitHubTeam)
405 case *providers.KeycloakProvider:
406 p.SetGroup(o.KeycloakGroup)
407 case *providers.GoogleProvider:
408 if o.GoogleServiceAccountJSON != "" {
409 file, err := os.Open(o.GoogleServiceAccountJSON)
410 if err != nil {
411 msgs = append(msgs, "invalid Google credentials file: "+o.GoogleServiceAccountJSON)
412 } else {
413 p.SetGroupRestriction(o.GoogleGroups, o.GoogleAdminEmail, file)
414 }
415 }
416 case *providers.BitbucketProvider:
417 p.SetTeam(o.BitbucketTeam)
418 p.SetRepository(o.BitbucketRepository)
419 case *providers.OIDCProvider:
420 p.AllowUnverifiedEmail = o.InsecureOIDCAllowUnverifiedEmail
421 if o.oidcVerifier == nil {
422 msgs = append(msgs, "oidc provider requires an oidc issuer URL")
423 } else {
424 p.Verifier = o.oidcVerifier
425 }
426 case *providers.GitLabProvider:
427 p.AllowUnverifiedEmail = o.InsecureOIDCAllowUnverifiedEmail
428 p.Group = o.GitLabGroup
429 p.EmailDomains = o.EmailDomains
431 if o.oidcVerifier != nil {
432 p.Verifier = o.oidcVerifier
433 } else {
434 // Initialize with default verifier for gitlab.com
435 ctx := context.Background()
437 provider, err := oidc.NewProvider(ctx, "https://gitlab.com")
438 if err != nil {
439 msgs = append(msgs, "failed to initialize oidc provider for gitlab.com")
440 } else {
441 p.Verifier = provider.Verifier(&oidc.Config{
442 ClientID: o.ClientID,
443 })
445 p.LoginURL, msgs = parseURL(provider.Endpoint().AuthURL, "login", msgs)
446 p.RedeemURL, msgs = parseURL(provider.Endpoint().TokenURL, "redeem", msgs)
447 }
448 }
449 case *providers.LoginGovProvider:
450 p.AcrValues = o.AcrValues
451 p.PubJWKURL, msgs = parseURL(o.PubJWKURL, "pubjwk", msgs)
453 // JWT key can be supplied via env variable or file in the filesystem, but not both.
454 switch {
455 case o.JWTKey != "" && o.JWTKeyFile != "":
456 msgs = append(msgs, "cannot set both jwt-key and jwt-key-file options")
457 case o.JWTKey == "" && o.JWTKeyFile == "":
458 msgs = append(msgs, "login.gov provider requires a private key for signing JWTs")
459 case o.JWTKey != "":
460 // The JWT Key is in the commandline argument
461 signKey, err := jwt.ParseRSAPrivateKeyFromPEM([]byte(o.JWTKey))
462 if err != nil {
463 msgs = append(msgs, "could not parse RSA Private Key PEM")
464 } else {
465 p.JWTKey = signKey
466 }
467 case o.JWTKeyFile != "":
468 // The JWT key is in the filesystem
469 keyData, err := ioutil.ReadFile(o.JWTKeyFile)
470 if err != nil {
471 msgs = append(msgs, "could not read key file: "+o.JWTKeyFile)
472 }
473 signKey, err := jwt.ParseRSAPrivateKeyFromPEM(keyData)
474 if err != nil {
475 msgs = append(msgs, "could not parse private key from PEM file:"+o.JWTKeyFile)
476 } else {
477 p.JWTKey = signKey
478 }
479 }
480 }
481 return msgs
484func parseSignatureKey(o *Options, msgs []string) []string {
485 if o.SignatureKey == "" {
486 return msgs
487 }
489 components := strings.Split(o.SignatureKey, ":")
490 if len(components) != 2 {
491 return append(msgs, "invalid signature hash:key spec: "+
492 o.SignatureKey)
493 }
495 algorithm, secretKey := components[0], components[1]
496 var hash crypto.Hash
497 var err error
498 if hash, err = hmacauth.DigestNameToCryptoHash(algorithm); err != nil {
499 return append(msgs, "unsupported signature hash algorithm: "+
500 o.SignatureKey)
501 }
502 o.signatureData = &SignatureData{hash: hash, key: secretKey}
503 return msgs
506// parseJwtIssuers takes in an array of strings in the form of issuer=audience
507// and parses to an array of jwtIssuer structs.
508func parseJwtIssuers(issuers []string, msgs []string) ([]jwtIssuer, []string) {
509 var parsedIssuers []jwtIssuer
510 for _, jwtVerifier := range issuers {
511 components := strings.Split(jwtVerifier, "=")
512 if len(components) < 2 {
513 msgs = append(msgs, fmt.Sprintf("invalid jwt verifier uri=audience spec: %s", jwtVerifier))
514 continue
515 }
516 uri, audience := components[0], strings.Join(components[1:], "=")
517 parsedIssuers = append(parsedIssuers, jwtIssuer{issuerURI: uri, audience: audience})
518 }
519 return parsedIssuers, msgs
522// newVerifierFromJwtIssuer takes in issuer information in jwtIssuer info and returns
523// a verifier for that issuer.
524func newVerifierFromJwtIssuer(jwtIssuer jwtIssuer) (*oidc.IDTokenVerifier, error) {
525 config := &oidc.Config{
526 ClientID: jwtIssuer.audience,
527 }
528 // Try as an OpenID Connect Provider first
529 var verifier *oidc.IDTokenVerifier
530 provider, err := oidc.NewProvider(context.Background(), jwtIssuer.issuerURI)
531 if err != nil {
532 // Try as JWKS URI
533 jwksURI := strings.TrimSuffix(jwtIssuer.issuerURI, "/") + "/.well-known/jwks.json"
534 _, err := http.NewRequest("GET", jwksURI, nil)
535 if err != nil {
536 return nil, err
537 }
538 verifier = oidc.NewVerifier(jwtIssuer.issuerURI, oidc.NewRemoteKeySet(context.Background(), jwksURI), config)
539 } else {
540 verifier = provider.Verifier(config)
541 }
542 return verifier, nil
545func validateCookieName(o *Options, msgs []string) []string {
546 cookie := &http.Cookie{Name: o.CookieName}
547 if cookie.String() == "" {
548 return append(msgs, fmt.Sprintf("invalid cookie name: %q", o.CookieName))
549 }
550 return msgs
553func addPadding(secret string) string {
554 padding := len(secret) % 4
555 switch padding {
556 case 1:
557 return secret + "==="
558 case 2:
559 return secret + "=="
560 case 3:
561 return secret + "="
562 default:
563 return secret
564 }
567// secretBytes attempts to base64 decode the secret, if that fails it treats the secret as binary
568func secretBytes(secret string) []byte {
569 b, err := base64.URLEncoding.DecodeString(addPadding(secret))
570 if err == nil {
571 return []byte(addPadding(string(b)))
572 }
573 return []byte(secret)
576func setupLogger(o *Options, msgs []string) []string {
577 // Setup the log file
578 if len(o.LoggingFilename) > 0 {
579 // Validate that the file/dir can be written
580 file, err := os.OpenFile(o.LoggingFilename, os.O_WRONLY|os.O_CREATE, 0666)
581 if err != nil {
582 if os.IsPermission(err) {
583 return append(msgs, "unable to write to log file: "+o.LoggingFilename)
584 }
585 }
586 file.Close()
588 logger.Printf("Redirecting logging to file: %s", o.LoggingFilename)
590 logWriter := &lumberjack.Logger{
591 Filename: o.LoggingFilename,
592 MaxSize: o.LoggingMaxSize, // megabytes
593 MaxAge: o.LoggingMaxAge, // days
594 MaxBackups: o.LoggingMaxBackups,
595 LocalTime: o.LoggingLocalTime,
596 Compress: o.LoggingCompress,
597 }
599 logger.SetOutput(logWriter)
600 }
602 // Supply a sanity warning to the logger if all logging is disabled
603 if !o.StandardLogging && !o.AuthLogging && !o.RequestLogging {
604 logger.Print("Warning: Logging disabled. No further logs will be shown.")
605 }
607 // Pass configuration values to the standard logger
608 logger.SetStandardEnabled(o.StandardLogging)
609 logger.SetAuthEnabled(o.AuthLogging)
610 logger.SetReqEnabled(o.RequestLogging)
611 logger.SetStandardTemplate(o.StandardLoggingFormat)
612 logger.SetAuthTemplate(o.AuthLoggingFormat)
613 logger.SetReqTemplate(o.RequestLoggingFormat)
615 excludePaths := make([]string, 0)
616 excludePaths = append(excludePaths, strings.Split(o.ExcludeLoggingPaths, ",")...)
617 if o.SilencePingLogging {
618 excludePaths = append(excludePaths, o.PingPath)
619 }
621 logger.SetExcludePaths(excludePaths)
623 if !o.LoggingLocalTime {
624 logger.SetFlags(logger.Flags() | logger.LUTC)
625 }
627 return msgs