-
Notifications
You must be signed in to change notification settings - Fork 442
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
clean up README about breaking changes
- Loading branch information
Showing
2 changed files
with
105 additions
and
140 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,89 @@ | ||
| // | ||
| // | ||
| // [](http://godoc.org/github.com/crewjam/saml) | ||
| // | ||
| // [](https://travis-ci.org/crewjam/saml) | ||
| // | ||
| // Package saml contains a partial implementation of the SAML standard in golang. | ||
| // SAML is a standard for identity federation, i.e. either allowing a third party to authenticate your users or allowing third parties to rely on us to authenticate their users. | ||
| // | ||
| // | ||
| // Introduction | ||
| // | ||
| // | ||
| // In SAML parlance an Identity Provider (IDP) is a service that knows how to authenticate users. A Service Provider (SP) is a service that delegates authentication to an IDP. If you are building a service where users log in with someone else's credentials, then you are a Service Provider. This package supports implementing both service providers and identity providers. | ||
| // | ||
| // | ||
| // The core package contains the implementation of SAML. The package samlsp provides helper middleware suitable for use in Service Provider applications. The package samlidp provides a rudimentary IDP service that is useful for testing or as a starting point for other integrations. | ||
| // | ||
| // | ||
| // Breaking Changes | ||
| // | ||
| // Note: between version 0.2.0 and the current master include changes to the API | ||
| // that will break your existing code a little. | ||
| // | ||
| // This change turned some fields from pointers to a single optional struct into | ||
| // the more correct slice of struct, and to pluralize the field name. For example, | ||
| // `IDPSSODescriptor *IDPSSODescriptor` has become | ||
| // `IDPSSODescriptors []IDPSSODescriptor`. This more accurately reflects the | ||
| // standard. | ||
| // | ||
| // The struct `Metadata` has been renamed to `EntityDescriptor`. In 0.2.0 and before, | ||
| // every struct derived from the standard has the same name as in the standard, | ||
| // *except* for `Metadata` which should always have been called `EntityDescriptor`. | ||
| // | ||
| // In various places `url.URL` is now used where `string` was used <= version 0.1.0. | ||
| // | ||
| // In various places where keys and certificates were modeled as `string` | ||
| // <= version 0.1.0 (what was I thinking?!) they are now modeled as | ||
| // `*rsa.PrivateKey`, `*x509.Certificate`, or `crypto.PrivateKey` as appropriate. | ||
| // | ||
| // | ||
| // Version 0.4.0 introduces a few breaking changes to the _samlsp_ package in order to make the package more extensible, and to clean up the interfaces a bit. The default behavior remains the same, but you can now provide interface implementations of _RequestTracker_ (which tracks pending requests), _Session_ (which handles maintaining a session) and _OnError_ which handles reporting errors. | ||
| // | ||
| // Public fields of _samlsp.Middleware_ have changed, so some usages may require adjustment. See [issue 231](https://github.com/crewjam/saml/issues/231) for details. | ||
| // | ||
| // The option to provide an IDP metadata URL has been deprecated. Instead, we recommend that you use the `FetchMetadata()` function, or fetch the metadata yourself and use the new `ParseMetadata()` function, and pass the metadata in _samlsp.Options.IDPMetadata_. | ||
| // | ||
| // Similarly, the _HTTPClient_ field is now deprecated because it was only used for fetching metdata, which is no longer directly implemented. | ||
| // | ||
| // The fields that manage how cookies are set are deprecated as well. To customize how cookies are managed, provide custom implementation of _RequestTracker_ and/or _Session_, perhaps by extending the default implementations. | ||
| // | ||
| // The deprecated fields have not been removed from the Options structure, but will be in future. | ||
| // | ||
| // In particular we have deprecated the following fields in | ||
| // _samlsp.Options_: | ||
| // | ||
| // - `Logger` - This was used to emit errors while validating, which is an anti-pattern. | ||
| // - `IDPMetadataURL` - Instead use `FetchMetadata()` | ||
| // - `HTTPClient` - Instead pass httpClient to FetchMetadata | ||
| // - `CookieMaxAge` - Instead assign a custom CookieRequestTracker or CookieSessionProvider | ||
| // - `CookieName` - Instead assign a custom CookieRequestTracker or CookieSessionProvider | ||
| // - `CookieDomain` - Instead assign a custom CookieRequestTracker or CookieSessionProvider | ||
| // - `CookieDomain` - Instead assign a custom CookieRequestTracker or CookieSessionProvider | ||
| // | ||
| // Getting Started as a Service Provider | ||
| // | ||
| // Let us assume we have a simple web appliation to protect. We'll modify this application so it uses SAML to authenticate users. | ||
| // | ||
| // Let us assume we have a simple web application to protect. We'll modify this application so it uses SAML to authenticate users. | ||
| // | ||
| // ```golang | ||
| // package main | ||
| // | ||
| // import "net/http" | ||
| // | ||
| // | ||
| // import ( | ||
| // "fmt" | ||
| // "net/http" | ||
| // ) | ||
| // | ||
| // func hello(w http.ResponseWriter, r *http.Request) { | ||
| // fmt.Fprintf(w, "Hello, World!") | ||
| // } | ||
| // | ||
| // | ||
| // func main() { | ||
| // app := http.HandlerFunc(hello) | ||
| // http.Handle("/hello", app) | ||
| // http.ListenAndServe(":8000", nil) | ||
| // } | ||
| // ``` | ||
| // | ||
| // Each service provider must have an self-signed X.509 key pair established. You can generate your own with something like this: | ||
| // | ||
| // | ||
| // openssl req -x509 -newkey rsa:2048 -keyout myservice.key -out myservice.cert -days 365 -nodes -subj "/CN=myservice.example.com" | ||
| // | ||
| // We will use `samlsp.Middleware` to wrap the endpoint we want to protect. Middleware provides both an `http.Handler` to serve the SAML specific URLs and a set of wrappers to require the user to be logged in. We also provide the URL where the service provider can fetch the metadata from the IDP at startup. In our case, we'll use [testshib.org](https://www.testshib.org/), an identity provider designed for testing. | ||
| // | ||
| // | ||
| // We will use `samlsp.Middleware` to wrap the endpoint we want to protect. Middleware provides both an `http.Handler` to serve the SAML specific URLs and a set of wrappers to require the user to be logged in. We also provide the URL where the service provider can fetch the metadata from the IDP at startup. In our case, we'll use [samltest.id](https://samltest.id/), an identity provider designed for testing. | ||
| // | ||
| // ```golang | ||
| // package main | ||
| // | ||
| // | ||
| // import ( | ||
| // "crypto/rsa" | ||
| // "crypto/tls" | ||
| // "crypto/x509" | ||
| // "fmt" | ||
| // "net/http" | ||
| // "net/url" | ||
| // | ||
| // | ||
| // "github.com/crewjam/saml/samlsp" | ||
| // ) | ||
| // | ||
| // | ||
| // func hello(w http.ResponseWriter, r *http.Request) { | ||
| // claims := samlsp.Claims(r.Context()) | ||
| // fmt.Fprintf(w, "Hello, %s!", claims.Attributes["cn"][0]) | ||
| // fmt.Fprintf(w, "Hello, %s!", samlsp.Token(r.Context()).Attributes.Get("cn")) | ||
| // } | ||
| // | ||
| // | ||
| // func main() { | ||
| // keyPair, err := tls.LoadX509KeyPair("myservice.cert", "myservice.key") | ||
| // if err != nil { | ||
|
|
@@ -81,17 +93,17 @@ | |
| // if err != nil { | ||
| // panic(err) // TODO handle error | ||
| // } | ||
| // | ||
| // idpMetadataURL, err := url.Parse("https://www.testshib.org/metadata/testshib-providers.xml") | ||
| // | ||
| // idpMetadataURL, err := url.Parse("https://samltest.id/saml/idp") | ||
| // if err != nil { | ||
| // panic(err) // TODO handle error | ||
| // } | ||
| // | ||
| // | ||
| // rootURL, err := url.Parse("http://localhost:8000") | ||
| // if err != nil { | ||
| // panic(err) // TODO handle error | ||
| // } | ||
| // | ||
| // | ||
| // samlSP, _ := samlsp.New(samlsp.Options{ | ||
| // URL: *rootURL, | ||
| // Key: keyPair.PrivateKey.(*rsa.PrivateKey), | ||
|
|
@@ -104,61 +116,61 @@ | |
| // http.ListenAndServe(":8000", nil) | ||
| // } | ||
| // ``` | ||
| // | ||
| // Next we'll have to register our service provider with the identiy provider to establish trust from the service provider to the IDP. For [testshib.org](https://www.testshib.org/), you can do something like: | ||
| // | ||
| // | ||
| // Next we'll have to register our service provider with the identity provider to establish trust from the service provider to the IDP. For [samltest.id](https://samltest.id/), you can do something like: | ||
| // | ||
| // mdpath=saml-test-$USER-$HOST.xml | ||
| // curl localhost:8000/saml/metadata > $mdpath | ||
| // | ||
| // Naviate to https://www.testshib.org/register.html and upload the file you fetched. | ||
| // | ||
| // | ||
| // Navigate to https://samltest.id/upload.php and upload the file you fetched. | ||
| // | ||
| // Now you should be able to authenticate. The flow should look like this: | ||
| // | ||
| // | ||
| // 1. You browse to `localhost:8000/hello` | ||
| // | ||
| // 1. The middleware redirects you to `https://idp.testshib.org/idp/profile/SAML2/Redirect/SSO` | ||
| // | ||
| // 1. testshib.org prompts you for a username and password. | ||
| // | ||
| // 1. testshib.org returns you an HTML document which contains an HTML form setup to POST to `localhost:8000/saml/acs`. The form is automatically submitted if you have javascript enabled. | ||
| // | ||
| // | ||
| // 1. The middleware redirects you to `https://samltest.id/idp/profile/SAML2/Redirect/SSO` | ||
| // | ||
| // 1. samltest.id prompts you for a username and password. | ||
| // | ||
| // 1. samltest.id returns you an HTML document which contains an HTML form setup to POST to `localhost:8000/saml/acs`. The form is automatically submitted if you have javascript enabled. | ||
| // | ||
| // 1. The local service validates the response, issues a session cookie, and redirects you to the original URL, `localhost:8000/hello`. | ||
| // | ||
| // | ||
| // 1. This time when `localhost:8000/hello` is requested there is a valid session and so the main content is served. | ||
| // | ||
| // | ||
| // Getting Started as an Identity Provider | ||
| // | ||
| // Please see `examples/idp/` for a substantially complete example of how to use the library and helpers to be an identity provider. | ||
| // | ||
| // | ||
| // Please see `example/idp/` for a substantially complete example of how to use the library and helpers to be an identity provider. | ||
| // | ||
| // Support | ||
| // | ||
| // | ||
| // The SAML standard is huge and complex with many dark corners and strange, unused features. This package implements the most commonly used subset of these features required to provide a single sign on experience. The package supports at least the subset of SAML known as [interoperable SAML](http://saml2int.org). | ||
| // | ||
| // | ||
| // This package supports the Web SSO profile. Message flows from the service provider to the IDP are supported using the HTTP Redirect binding and the HTTP POST binding. Message flows from the IDP to the service provider are supported via the HTTP POST binding. | ||
| // | ||
| // The package supports signed and encrypted SAML assertions. It does not support signed or encrypted requests. | ||
| // | ||
| // | ||
| // The package can produce signed SAML assertions, and can validate both signed and encrypted SAML assertions. It does not support signed or encrypted requests. | ||
| // | ||
| // RelayState | ||
| // | ||
| // The *RelayState* parameter allows you to pass user state information across the authentication flow. The most common use for this is to allow a user to request a deep link into your site, be redirected through the SAML login flow, and upon successful completion, be directed to the originally requested link, rather than the root. | ||
| // | ||
| // Unfortunately, *RelayState* is less useful than it could be. Firstly, it is not authenticated, so anything you supply must be signed to avoid XSS or CSRF. Secondly, it is limited to 80 bytes in length, which precludes signing. (See section 3.6.3.1 of SAMLProfiles.) | ||
| // | ||
| // | ||
| // The _RelayState_ parameter allows you to pass user state information across the authentication flow. The most common use for this is to allow a user to request a deep link into your site, be redirected through the SAML login flow, and upon successful completion, be directed to the originally requested link, rather than the root. | ||
| // | ||
| // Unfortunately, _RelayState_ is less useful than it could be. Firstly, it is not authenticated, so anything you supply must be signed to avoid XSS or CSRF. Secondly, it is limited to 80 bytes in length, which precludes signing. (See section 3.6.3.1 of SAMLProfiles.) | ||
| // | ||
| // References | ||
| // | ||
| // | ||
| // The SAML specification is a collection of PDFs (sadly): | ||
| // | ||
| // | ||
| // - [SAMLCore](http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf) defines data types. | ||
| // | ||
| // | ||
| // - [SAMLBindings](http://docs.oasis-open.org/security/saml/v2.0/saml-bindings-2.0-os.pdf) defines the details of the HTTP requests in play. | ||
| // | ||
| // | ||
| // - [SAMLProfiles](http://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf) describes data flows. | ||
| // | ||
| // | ||
| // - [SAMLConformance](http://docs.oasis-open.org/security/saml/v2.0/saml-conformance-2.0-os.pdf) includes a support matrix for various parts of the protocol. | ||
| // | ||
| // [TestShib](https://www.testshib.org/) is a testing ground for SAML service and identity providers. | ||
| // | ||
| // | ||
| // [SAMLtest](https://samltest.id/) is a testing ground for SAML service and identity providers. | ||
| // | ||
| // Security Issues | ||
| // | ||
| // Please do not report security issues in the issue tracker. Rather, please contact me directly at [email protected] ([PGP Key `8EA205C01C425FF195A5E9A43FA0768F26FD2554`](https://keybase.io/crewjam)). | ||
| // | ||
| // Please do not report security issues in the issue tracker. Rather, please contact me directly at [email protected] ([PGP Key `78B6038B3B9DFB88`](https://keybase.io/crewjam)). | ||
| package saml | ||