@@ -11,6 +11,7 @@ import (
1111 sessionsapi "github.com/oauth2-proxy/oauth2-proxy/pkg/apis/sessions"
1212 "github.com/oauth2-proxy/oauth2-proxy/pkg/logger"
1313 "github.com/oauth2-proxy/oauth2-proxy/providers"
14+ "github.com/spf13/pflag"
1415)
1516
1617// SignatureData holds hmacauth signature hash and key
@@ -160,6 +161,7 @@ func (o *Options) SetRealClientIPParser(s logging.RealClientIPParser) { o.realCl
160161func NewOptions() *Options {
161162 return &Options{
162163 ProxyPrefix: "/oauth2",
164+ ProviderType: "google",
163165 PingPath: "/ping",
164166 ProxyWebSockets: true,
165167 HTTPAddress: "127.0.0.1:4180",
@@ -173,12 +175,15 @@ func NewOptions() *Options {
173175 HTTPOnly: true,
174176 Expire: time.Duration(168) * time.Hour,
175177 Refresh: time.Duration(0),
178+ Path: "/",
176179 },
177180 Session: SessionOptions{
178181 Type: "cookie",
179182 },
183+ AzureTenant: "common",
180184 SetXAuthRequest: false,
181185 SkipAuthPreflight: false,
186+ FlushInterval: time.Duration(1) * time.Second,
182187 PassBasicAuth: true,
183188 SetBasicAuth: false,
184189 PassUserHeaders: true,
@@ -208,3 +213,128 @@ func NewOptions() *Options {
208213 AuthLoggingFormat: logger.DefaultAuthLoggingFormat,
209214 }
210215}
216+
217+// NewFlagSet creates a new FlagSet with all of the flags required by Options
218+func NewFlagSet() *pflag.FlagSet {
219+ flagSet := pflag.NewFlagSet("oauth2-proxy", pflag.ExitOnError)
220+
221+ flagSet.String("http-address", "127.0.0.1:4180", "[http://]<addr>:<port> or unix://<path> to listen on for HTTP clients")
222+ flagSet.String("https-address", ":443", "<addr>:<port> to listen on for HTTPS clients")
223+ flagSet.Bool("reverse-proxy", false, "are we running behind a reverse proxy, controls whether headers like X-Real-Ip are accepted")
224+ flagSet.String("real-client-ip-header", "X-Real-IP", "Header used to determine the real IP of the client (one of: X-Forwarded-For, X-Real-IP, or X-ProxyUser-IP)")
225+ flagSet.Bool("force-https", false, "force HTTPS redirect for HTTP requests")
226+ flagSet.String("tls-cert-file", "", "path to certificate file")
227+ flagSet.String("tls-key-file", "", "path to private key file")
228+ flagSet.String("redirect-url", "", "the OAuth Redirect URL. ie: \"https://internalapp.yourcompany.com/oauth2/callback\"")
229+ flagSet.Bool("set-xauthrequest", false, "set X-Auth-Request-User and X-Auth-Request-Email response headers (useful in Nginx auth_request mode)")
230+ flagSet.StringSlice("upstream", []string{}, "the http url(s) of the upstream endpoint, file:// paths for static files or static://<status_code> for static response. Routing is based on the path")
231+ flagSet.Bool("pass-basic-auth", true, "pass HTTP Basic Auth, X-Forwarded-User and X-Forwarded-Email information to upstream")
232+ flagSet.Bool("set-basic-auth", false, "set HTTP Basic Auth information in response (useful in Nginx auth_request mode)")
233+ flagSet.Bool("prefer-email-to-user", false, "Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, eg. htaccess authentication. Used in conjunction with -pass-basic-auth and -pass-user-headers")
234+ flagSet.Bool("pass-user-headers", true, "pass X-Forwarded-User and X-Forwarded-Email information to upstream")
235+ flagSet.String("basic-auth-password", "", "the password to set when passing the HTTP Basic Auth header")
236+ flagSet.Bool("pass-access-token", false, "pass OAuth access_token to upstream via X-Forwarded-Access-Token header")
237+ flagSet.Bool("pass-host-header", true, "pass the request Host Header to upstream")
238+ flagSet.Bool("pass-authorization-header", false, "pass the Authorization Header to upstream")
239+ flagSet.Bool("set-authorization-header", false, "set Authorization response headers (useful in Nginx auth_request mode)")
240+ flagSet.StringSlice("skip-auth-regex", []string{}, "bypass authentication for requests path's that match (may be given multiple times)")
241+ flagSet.Bool("skip-provider-button", false, "will skip sign-in-page to directly reach the next step: oauth/start")
242+ flagSet.Bool("skip-auth-preflight", false, "will skip authentication for OPTIONS requests")
243+ flagSet.Bool("ssl-insecure-skip-verify", false, "skip validation of certificates presented when using HTTPS providers")
244+ flagSet.Bool("ssl-upstream-insecure-skip-verify", false, "skip validation of certificates presented when using HTTPS upstreams")
245+ flagSet.Duration("flush-interval", time.Duration(1)*time.Second, "period between response flushing when streaming responses")
246+ flagSet.Bool("skip-jwt-bearer-tokens", false, "will skip requests that have verified JWT bearer tokens (default false)")
247+ flagSet.StringSlice("extra-jwt-issuers", []string{}, "if skip-jwt-bearer-tokens is set, a list of extra JWT issuer=audience pairs (where the issuer URL has a .well-known/openid-configuration or a .well-known/jwks.json)")
248+
249+ flagSet.StringSlice("email-domain", []string{}, "authenticate emails with the specified domain (may be given multiple times). Use * to authenticate any email")
250+ flagSet.StringSlice("whitelist-domain", []string{}, "allowed domains for redirection after authentication. Prefix domain with a . to allow subdomains (eg .example.com)")
251+ flagSet.String("keycloak-group", "", "restrict login to members of this group.")
252+ flagSet.String("azure-tenant", "common", "go to a tenant-specific or common (tenant-independent) endpoint.")
253+ flagSet.String("bitbucket-team", "", "restrict logins to members of this team")
254+ flagSet.String("bitbucket-repository", "", "restrict logins to user with access to this repository")
255+ flagSet.String("github-org", "", "restrict logins to members of this organisation")
256+ flagSet.String("github-team", "", "restrict logins to members of this team")
257+ flagSet.String("github-repo", "", "restrict logins to collaborators of this repository")
258+ flagSet.String("github-token", "", "the token to use when verifying repository collaborators (must have push access to the repository)")
259+ flagSet.String("gitlab-group", "", "restrict logins to members of this group")
260+ flagSet.StringSlice("google-group", []string{}, "restrict logins to members of this google group (may be given multiple times).")
261+ flagSet.String("google-admin-email", "", "the google admin to impersonate for api calls")
262+ flagSet.String("google-service-account-json", "", "the path to the service account json credentials")
263+ flagSet.String("client-id", "", "the OAuth Client ID: ie: \"123456.apps.googleusercontent.com\"")
264+ flagSet.String("client-secret", "", "the OAuth Client Secret")
265+ flagSet.String("client-secret-file", "", "the file with OAuth Client Secret")
266+ flagSet.String("authenticated-emails-file", "", "authenticate against emails via file (one per line)")
267+ flagSet.String("htpasswd-file", "", "additionally authenticate against a htpasswd file. Entries must be created with \"htpasswd -s\" for SHA encryption or \"htpasswd -B\" for bcrypt encryption")
268+ flagSet.Bool("display-htpasswd-form", true, "display username / password login form if an htpasswd file is provided")
269+ flagSet.String("custom-templates-dir", "", "path to custom html templates")
270+ flagSet.String("banner", "", "custom banner string. Use \"-\" to disable default banner.")
271+ flagSet.String("footer", "", "custom footer string. Use \"-\" to disable default footer.")
272+ flagSet.String("proxy-prefix", "/oauth2", "the url root path that this proxy should be nested under (e.g. /<oauth2>/sign_in)")
273+ flagSet.String("ping-path", "/ping", "the ping endpoint that can be used for basic health checks")
274+ flagSet.Bool("proxy-websockets", true, "enables WebSocket proxying")
275+
276+ flagSet.String("cookie-name", "_oauth2_proxy", "the name of the cookie that the oauth_proxy creates")
277+ flagSet.String("cookie-secret", "", "the seed string for secure cookies (optionally base64 encoded)")
278+ flagSet.StringSlice("cookie-domain", []string{}, "Optional cookie domains to force cookies to (ie: `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match).")
279+ flagSet.String("cookie-path", "/", "an optional cookie path to force cookies to (ie: /poc/)*")
280+ flagSet.Duration("cookie-expire", time.Duration(168)*time.Hour, "expire timeframe for cookie")
281+ flagSet.Duration("cookie-refresh", time.Duration(0), "refresh the cookie after this duration; 0 to disable")
282+ flagSet.Bool("cookie-secure", true, "set secure (HTTPS) cookie flag")
283+ flagSet.Bool("cookie-httponly", true, "set HttpOnly cookie flag")
284+ flagSet.String("cookie-samesite", "", "set SameSite cookie attribute (ie: \"lax\", \"strict\", \"none\", or \"\"). ")
285+
286+ flagSet.String("session-store-type", "cookie", "the session storage provider to use")
287+ flagSet.String("redis-connection-url", "", "URL of redis server for redis session storage (eg: redis://HOST[:PORT])")
288+ flagSet.Bool("redis-use-sentinel", false, "Connect to redis via sentinels. Must set --redis-sentinel-master-name and --redis-sentinel-connection-urls to use this feature")
289+ flagSet.String("redis-sentinel-master-name", "", "Redis sentinel master name. Used in conjunction with --redis-use-sentinel")
290+ flagSet.String("redis-ca-path", "", "Redis custom CA path")
291+ flagSet.Bool("redis-insecure-skip-tls-verify", false, "Use insecure TLS connection to redis")
292+ flagSet.StringSlice("redis-sentinel-connection-urls", []string{}, "List of Redis sentinel connection URLs (eg redis://HOST[:PORT]). Used in conjunction with --redis-use-sentinel")
293+ flagSet.Bool("redis-use-cluster", false, "Connect to redis cluster. Must set --redis-cluster-connection-urls to use this feature")
294+ flagSet.StringSlice("redis-cluster-connection-urls", []string{}, "List of Redis cluster connection URLs (eg redis://HOST[:PORT]). Used in conjunction with --redis-use-cluster")
295+
296+ flagSet.String("logging-filename", "", "File to log requests to, empty for stdout")
297+ flagSet.Int("logging-max-size", 100, "Maximum size in megabytes of the log file before rotation")
298+ flagSet.Int("logging-max-age", 7, "Maximum number of days to retain old log files")
299+ flagSet.Int("logging-max-backups", 0, "Maximum number of old log files to retain; 0 to disable")
300+ flagSet.Bool("logging-local-time", true, "If the time in log files and backup filenames are local or UTC time")
301+ flagSet.Bool("logging-compress", false, "Should rotated log files be compressed using gzip")
302+
303+ flagSet.Bool("standard-logging", true, "Log standard runtime information")
304+ flagSet.String("standard-logging-format", logger.DefaultStandardLoggingFormat, "Template for standard log lines")
305+
306+ flagSet.Bool("request-logging", true, "Log HTTP requests")
307+ flagSet.String("request-logging-format", logger.DefaultRequestLoggingFormat, "Template for HTTP request log lines")
308+ flagSet.String("exclude-logging-paths", "", "Exclude logging requests to paths (eg: '/path1,/path2,/path3')")
309+ flagSet.Bool("silence-ping-logging", false, "Disable logging of requests to ping endpoint")
310+
311+ flagSet.Bool("auth-logging", true, "Log authentication attempts")
312+ flagSet.String("auth-logging-format", logger.DefaultAuthLoggingFormat, "Template for authentication log lines")
313+
314+ flagSet.String("provider", "google", "OAuth provider")
315+ flagSet.String("provider-display-name", "", "Provider display name")
316+ flagSet.String("oidc-issuer-url", "", "OpenID Connect issuer URL (ie: https://accounts.google.com)")
317+ flagSet.Bool("insecure-oidc-allow-unverified-email", false, "Don't fail if an email address in an id_token is not verified")
318+ flagSet.Bool("insecure-oidc-skip-issuer-verification", false, "Do not verify if issuer matches OIDC discovery URL")
319+ flagSet.Bool("skip-oidc-discovery", false, "Skip OIDC discovery and use manually supplied Endpoints")
320+ flagSet.String("oidc-jwks-url", "", "OpenID Connect JWKS URL (ie: https://www.googleapis.com/oauth2/v3/certs)")
321+ flagSet.String("login-url", "", "Authentication endpoint")
322+ flagSet.String("redeem-url", "", "Token redemption endpoint")
323+ flagSet.String("profile-url", "", "Profile access endpoint")
324+ flagSet.String("resource", "", "The resource that is protected (Azure AD only)")
325+ flagSet.String("validate-url", "", "Access token validation endpoint")
326+ flagSet.String("scope", "", "OAuth scope specification")
327+ flagSet.String("prompt", "", "OIDC prompt")
328+ flagSet.String("approval-prompt", "force", "OAuth approval_prompt")
329+
330+ flagSet.String("signature-key", "", "GAP-Signature request signature key (algorithm:secretkey)")
331+ flagSet.String("acr-values", "", "acr values string: optional")
332+ flagSet.String("jwt-key", "", "private key in PEM format used to sign JWT, so that you can say something like -jwt-key=\"${OAUTH2_PROXY_JWT_KEY}\": required by login.gov")
333+ flagSet.String("jwt-key-file", "", "path to the private key file in PEM format used to sign the JWT so that you can say something like -jwt-key-file=/etc/ssl/private/jwt_signing_key.pem: required by login.gov")
334+ flagSet.String("pubjwk-url", "", "JWK pubkey access endpoint: required by login.gov")
335+ flagSet.Bool("gcp-healthchecks", false, "Enable GCP/GKE healthcheck endpoints")
336+
337+ flagSet.String("user-id-claim", "email", "which claim contains the user ID")
338+
339+ return flagSet
340+}