package cap
import "github.com/hashicorp/cap"
cap (collection of authentication packages) provides a collection of related packages which enable support for OIDC, JWT Verification, and Distributed Claims.
See README.md
Code:play
Example (Oidc)¶
package main
import (
"context"
"encoding/json"
"fmt"
"net/http"
"time"
"github.com/hashicorp/cap/oidc"
)
func main() {
ctx := context.Background()
// Create a new Config
pc, err := oidc.NewConfig(
"http://your-issuer.com/",
"your_client_id",
"your_client_secret",
[]oidc.Alg{oidc.RS256},
[]string{"http://your_redirect_url"},
)
if err != nil {
// handle error
}
// Create a provider
p, err := oidc.NewProvider(pc)
if err != nil {
// handle error
}
defer p.Done()
// Create a Request for a user's authentication attempt that will use the
// authorization code flow. (See NewRequest(...) using the WithPKCE and
// WithImplicit options for creating a Request that uses those flows.)
oidcRequest, err := oidc.NewRequest(2*time.Minute, "http://your_redirect_url/callback")
if err != nil {
// handle error
}
// Create an auth URL
authURL, err := p.AuthURL(ctx, oidcRequest)
if err != nil {
// handle error
}
fmt.Println("open url to kick-off authentication: ", authURL)
// Create a http.Handler for OIDC authentication response redirects
callbackHandler := func(w http.ResponseWriter, r *http.Request) {
// Exchange a successful authentication's authorization code and
// authorization state (received in a callback) for a verified Token.
t, err := p.Exchange(ctx, oidcRequest, r.FormValue("state"), r.FormValue("code"))
if err != nil {
// handle error
}
var claims map[string]interface{}
if err := t.IDToken().Claims(&claims); err != nil {
// handle error
}
// Get the user's claims via the provider's UserInfo endpoint
var infoClaims map[string]interface{}
err = p.UserInfo(ctx, t.StaticTokenSource(), claims["sub"].(string), &infoClaims)
if err != nil {
// handle error
}
resp := struct {
IDTokenClaims map[string]interface{}
UserInfoClaims map[string]interface{}
}{claims, infoClaims}
enc := json.NewEncoder(w)
if err := enc.Encode(resp); err != nil {
// handle error
}
}
http.HandleFunc("/callback", callbackHandler)
}
Index ¶
Examples ¶
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
jwt | Package jwt provides signature verification and claims set validation for JSON Web Tokens (JWT) of the JSON Web Signature (JWS) form. |
oidc | oidc is a package for writing clients that integrate with OIDC Providers using OIDC flows. |
oidc/callback | callback is a package that provides callbacks (in the form of http.HandlerFunc) for handling OIDC provider responses to authorization code flow (with optional PKCE) and implicit flow authentication attempts. |
oidc/clientassertion | Package clientassertion signs JWTs with a Private Key or Client Secret for use in OIDC client_assertion requests, A.K.A. private_key_jwt. |
oidc/examples | |
oidc/examples/cli | |
oidc/examples/spa | |
oidc/internal | |
util |
- Version
- v0.9.0 (latest)
- Published
- Feb 28, 2025
- Platform
- linux/amd64
- Last checked
- 2 months ago –
Tools for package owners.