https://github.com/loginradius/go-saml
High Level API Implementation of SAML 2.0 (Currently Supported Identity Provider Implementation) Single Sign On
https://github.com/loginradius/go-saml
federation go golang hacktoberfest hacktoberfest2021 saml sso
Last synced: about 1 year ago
JSON representation
High Level API Implementation of SAML 2.0 (Currently Supported Identity Provider Implementation) Single Sign On
- Host: GitHub
- URL: https://github.com/loginradius/go-saml
- Owner: LoginRadius
- License: mit
- Created: 2020-09-18T12:44:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-21T16:26:39.000Z (over 5 years ago)
- Last Synced: 2024-10-02T10:05:38.501Z (over 1 year ago)
- Topics: federation, go, golang, hacktoberfest, hacktoberfest2021, saml, sso
- Language: Go
- Homepage:
- Size: 85 KB
- Stars: 11
- Watchers: 8
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# go-saml
High-level API library for Single Sign On with SAML 2.0 based on [etree](https://github.com/beevik/etree) and [signedxml](https://github.com/ma314smith/signedxml), a pure Go implementation.
The library provides the Identity Provider Implementation with support of both IDPInitiated and SPInitiated flow.
## Features
* Generating identity provider metadata
* Validating Redirect/Post Binding signed/unsigned AuthnRequests
* Generating Post signed Responses
* Validating Redirect/Post Binding signed/unsigned LogoutRequest
* Generating Post signed LogoutResponses
* SessionIndex
## Installation
Install `go-saml` into your `$GOPATH` using go get:
```
go get github.com/LoginRadius/go-saml
```
## Usage
Below are samples to show how you might use the library.
### Create Idp Provider Instance
```
idp := saml.IdentityProvider{
IsIdpInitiated: false,
Issuer: "https://identity-provider.com/",
Audiences: "https://service-provider.com/",
IDPCert: "",
IDPKey: "",
SPCert: "",
NameIdentifier: "john@idp.com",
NameIdentifierFormat: saml.AttributeFormatUnspecified,
ACSLocation: "https://service-provider-acs.com", //Service Provider Login Url
ACSBinging: saml.HTTPPostBinding,
SessionIndex: "1ac5bc03-06a1-413d-8542-e7a7e7d9e9f2",
LogoutUrl: "https://service-provider-acs.com/logout" //Service Provider Logout Url
}
//Add Attributes
idp.AddAttribute("Fname", "john", saml.AttributeFormatUnspecified)
```
### Validate and Parse AuthnRequest
```
//This validate the AuthnRequest and set parsed value in the idp instance,
//that used in Generating the SAML Response with InResponseTo property.
//Get Querystring and Payload values from request with url.Value{} type
validationError := idp.ValidateAuthnRequest(method"POST",query url.Values,payload url.Values);
if validationError !=nil {
return validationError
}
```
### Generate Login Response
```
signedXML, signedXMLErr := idp.NewSignedLoginResponse()
if signedXMLErr != nil {
return signedXMLErr
}
//Generate html content for Post
html, err := idp.ResponseHtml(signedXML, "Response")
if err !=nil {
return err
}
```
### Validate and Parse Logout Request
```
//This validate the AuthnRequest and set parsed value in the idp instance,
//that is used in Generating the SAML Logout Response with InResponseTo property
//Get Querystring and Payload values from request with url.Value{} type
validationError := idp.ValidateLogoutRequest(method"POST",query url.Values,payload url.Values);
if validationError !=nil {
return validationError
}
```
### Generate Logout Response
```
signedXML, signedXMLErr := idp.NewSignedLoginResponse()
if signedXMLErr != nil {
return signedXMLErr
}
//Generate html content for Post
html, err := idp.ResponseHtml(signedXML, "LogoutResponse")
if err !=nil {
return err
}
```
### Metadata Identity Provider
```
idp := saml.IdentityProvider{
Issuer: "https://identity-provider.com/",
Audiences: "https://service-provider.com/",
IDPCert: "",
NameIdentifierFormat: saml.AttributeFormatUnspecified,
}
idp.AddSingleSignOnService(saml.MetadataBinding{
Binding: saml.HTTPPostBinding,
Location: "https://identity-provider.com/saml/post",
})
idp.AddSingleSignOnService(saml.MetadataBinding{
Binding: saml.HTTPRedirectBinding,
Location: "https://identity-provider.com/saml/redirect",
})
idp.AddSingleSignOutService(saml.MetadataBinding{
Binding: saml.HTTPPostBinding,
Location: "https://identity-provider.com/saml/post/logout",
})
// Generate xml for IDP Metadata
xml, xmlerr := idp.MetaDataResponse()
```
### Example
Please see [examples](examples) for how to use the library to be an identity provider.
## Contributing
Would love any contribution by you, including better documentation, tests or more robust functionality. Please follow the [contributing guide](CONTRIBUTING.md)
## License
[MIT](LICENSE)