You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,34 +7,32 @@ Provides a SAML SP authentication proxy for backend web services
7
7
## Usage
8
8
9
9
```text
10
-
--attribute-header-mappings value
10
+
-attribute-header-mappings attribute=header
11
11
Comma separated list of attribute=header pairs mapping SAML IdP response attributes to forwarded request header [SAML_PROXY_ATTRIBUTE_HEADER_MAPPINGS]
12
-
--authorize-attribute string
12
+
-authorize-attribute attribute
13
13
Enables authorization and specifies the attribute to check for authorized values [SAML_PROXY_AUTHORIZE_ATTRIBUTE]
14
-
--authorize-values value
15
-
Specifies the possible values that must be present in the authorize attribute [SAML_PROXY_AUTHORIZE_VALUES]
16
-
--backend-url string
14
+
-authorize-values values
15
+
If enabled, comma separated list of values that must be present in the authorize attribute [SAML_PROXY_AUTHORIZE_VALUES]
16
+
-backend-url URL
17
17
URL of the backend being proxied [SAML_PROXY_BACKEND_URL]
18
-
--base-url string
18
+
-base-url URL
19
19
External URL of this proxy [SAML_PROXY_BASE_URL]
20
-
--bind string
20
+
-bind host:port
21
21
host:port to bind for serving HTTP [SAML_PROXY_BIND] (default ":8080")
22
-
--idp-ca-path string
22
+
-idp-ca-path path
23
23
Optional path to a CA certificate PEM file for the IdP [SAML_PROXY_IDP_CA_PATH]
24
-
--idp-metadata-url string
24
+
-idp-metadata-url URL
25
25
URL of the IdP's metadata XML [SAML_PROXY_IDP_METADATA_URL]
26
-
--name-id-format string
26
+
-name-id-format string
27
27
One of unspecified, transient (default), email, or persistent to use a standard format or give a full URN of the name ID format [SAML_PROXY_NAME_ID_FORMAT]
28
-
--name-id-mapping string
28
+
-name-id-mapping header
29
29
Name of the request header to convey the SAML nameID/subject [SAML_PROXY_NAME_ID_MAPPING]
30
-
--new-auth-webhook-url string
30
+
-new-auth-webhook-url URL
31
31
URL of webhook that will get POST'ed when a new authentication is processed [SAML_PROXY_NEW_AUTH_WEBHOOK_URL]
32
-
--sp-cert-path string
33
-
Path to the X509 public certificate PEM file for this SP [SAML_PROXY_SP_CERT_PATH] (default "saml-auth-proxy.cert")
34
-
--sp-key-path string
35
-
Path to the X509 private key PEM file for this SP [SAML_PROXY_SP_KEY_PATH] (default "saml-auth-proxy.key")
36
-
--version
37
-
show version and exit [SAML_PROXY_VERSION]
32
+
-sp-cert-path path
33
+
The path to the X509 public certificate PEM file for this SP [SAML_PROXY_SP_CERT_PATH] (default "saml-auth-proxy.cert")
34
+
-sp-key-path path
35
+
The path to the X509 private key PEM file for this SP [SAML_PROXY_SP_KEY_PATH] (default "saml-auth-proxy.key")
38
36
```
39
37
40
38
The snake-case values, such as `SAML_PROXY_BACKEND_URL`, are the equivalent environment variables
Copy file name to clipboardExpand all lines: server/server.go
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -15,19 +15,19 @@ import (
15
15
16
16
typeConfigstruct {
17
17
Versionbool`usage:"show version and exit"`
18
-
Bindstring`default:":8080" usage:"host:port to bind for serving HTTP"`
19
-
BaseUrlstring`usage:"External URL of this proxy"`
20
-
BackendUrlstring`usage:"URL of the backend being proxied"`
21
-
IdpMetadataUrlstring`usage:"URL of the IdP's metadata XML"`
22
-
IdpCaPathstring`usage:"Optional path to a CA certificate PEM file for the IdP"`
18
+
Bindstring`default:":8080" usage:"[host:port] to bind for serving HTTP"`
19
+
BaseUrlstring`usage:"External [URL] of this proxy"`
20
+
BackendUrlstring`usage:"[URL] of the backend being proxied"`
21
+
IdpMetadataUrlstring`usage:"[URL] of the IdP's metadata XML"`
22
+
IdpCaPathstring`usage:"Optional [path] to a CA certificate PEM file for the IdP"`
23
23
NameIdFormatstring`usage:"One of unspecified, transient (default), email, or persistent to use a standard format or give a full URN of the name ID format"`
24
-
SpKeyPathstring`default:"saml-auth-proxy.key" usage:"Path to the X509 private key PEM file for this SP"`
25
-
SpCertPathstring`default:"saml-auth-proxy.cert" usage:"Path to the X509 public certificate PEM file for this SP"`
26
-
NameIdMappingstring`usage:"Name of the request header to convey the SAML nameID/subject"`
27
-
AttributeHeaderMappingsmap[string]string`usage:"Comma separated list of attribute=header pairs mapping SAML IdP response attributes to forwarded request header"`
28
-
NewAuthWebhookUrlstring`usage:"URL of webhook that will get POST'ed when a new authentication is processed"`
29
-
AuthorizeAttributestring`usage:"Enables authorization and specifies the attribute to check for authorized values"`
30
-
AuthorizeValues []string`usage:"Specifies the possible values that must be present in the authorize attribute"`
24
+
SpKeyPathstring`default:"saml-auth-proxy.key" usage:"The [path] to the X509 private key PEM file for this SP"`
25
+
SpCertPathstring`default:"saml-auth-proxy.cert" usage:"The [path] to the X509 public certificate PEM file for this SP"`
26
+
NameIdMappingstring`usage:"Name of the request [header] to convey the SAML nameID/subject"`
27
+
AttributeHeaderMappingsmap[string]string`usage:"Comma separated list of [attribute=header] pairs mapping SAML IdP response attributes to forwarded request header"`
28
+
NewAuthWebhookUrlstring`usage:"[URL] of webhook that will get POST'ed when a new authentication is processed"`
29
+
AuthorizeAttributestring`usage:"Enables authorization and specifies the [attribute] to check for authorized values"`
30
+
AuthorizeValues []string`usage:"If enabled, comma separated list of [values] that must be present in the authorize attribute"`
0 commit comments