1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
|
// Copyright 2024 OpenPubkey
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
package providers
import (
"context"
"fmt"
"net/http"
"time"
"github.com/google/uuid"
"github.com/openpubkey/openpubkey/discover"
simpleoidc "github.com/openpubkey/openpubkey/oidc"
"github.com/openpubkey/openpubkey/pktoken/clientinstance"
"github.com/openpubkey/openpubkey/util"
"github.com/sirupsen/logrus"
"github.com/zitadel/oidc/v3/pkg/client/rp"
"github.com/zitadel/oidc/v3/pkg/oidc"
)
// StandardOpOptions is an options struct that configures how providers.StandardOp
// operates. See providers.GetDefaultStandardOpOptions for the recommended default
// values to use when using the standardOp for a custom OpenIdProvider.
type StandardOpOptions struct {
// ClientID is the client ID of the OIDC application. It should be the
// expected "aud" claim in received ID tokens from the OP.
ClientID string
// ClientSecret is the client secret of the OIDC application. Some OPs do
// not require that this value is set.
ClientSecret string
// Issuer is the OP's issuer URI for performing OIDC authorization and
// discovery.
Issuer string
// Scopes is the list of scopes to send to the OP in the initial
// authorization request.
Scopes []string
// PromptType is the type of prompt to use when requesting authorization from the user. Typically
// this is set to "consent".
PromptType string
// AccessType is the type of access to request from the OP. Typically this is set to "offline".
AccessType string
// RedirectURIs is the list of authorized redirect URIs that can be
// redirected to by the OP after the user completes the authorization code
// flow exchange. Ensure that your OIDC application is configured to accept
// these URIs otherwise an error may occur.
RedirectURIs []string
// GQSign denotes if the received ID token should be upgraded to a GQ token
// using GQ signatures.
GQSign bool
// OpenBrowser denotes if the client's default browser should be opened
// automatically when performing the OIDC authorization flow. This value
// should typically be set to true, unless performing some headless
// automation (e.g. integration tests) where you don't want the browser to
// open.
OpenBrowser bool
// HttpClient is the http.Client to use when making queries to the OP (OIDC
// code exchange, refresh, verification of ID token, fetch of JWKS endpoint,
// etc.). If nil, then http.DefaultClient is used.
HttpClient *http.Client
// IssuedAtOffset configures the offset to add when validating the "iss" and
// "exp" claims of received ID tokens from the OP.
IssuedAtOffset time.Duration
}
func GetDefaultStandardOpOptions(issuer string, clientID string) *StandardOpOptions {
return &StandardOpOptions{
Issuer: issuer,
ClientID: clientID,
Scopes: []string{"openid profile email"},
PromptType: "consent",
AccessType: "offline",
RedirectURIs: []string{
"http://localhost:3000/login-callback",
"http://localhost:10001/login-callback",
"http://localhost:11110/login-callback",
},
GQSign: false,
OpenBrowser: true,
HttpClient: nil,
IssuedAtOffset: 1 * time.Minute,
}
}
// NewStandardOpWithOptions creates a standard OP with configuration specified
// using an options struct. This is useful if you want to use your own OIDC
// Client or override the configuration.
func NewStandardOpWithOptions(opts *StandardOpOptions) BrowserOpenIdProvider {
return &StandardOp{
clientID: opts.ClientID,
ClientSecret: opts.ClientSecret,
Scopes: opts.Scopes,
PromptType: opts.PromptType,
AccessType: opts.AccessType,
RedirectURIs: opts.RedirectURIs,
GQSign: opts.GQSign,
OpenBrowser: opts.OpenBrowser,
HttpClient: opts.HttpClient,
IssuedAtOffset: opts.IssuedAtOffset,
issuer: opts.Issuer,
requestTokensOverrideFunc: nil,
publicKeyFinder: discover.PublicKeyFinder{
JwksFunc: func(ctx context.Context, issuer string) ([]byte, error) {
return discover.GetJwksByIssuer(ctx, issuer, opts.HttpClient)
},
},
}
}
type StandardOp struct {
clientID string
ClientSecret string
Scopes []string
PromptType string
AccessType string
RedirectURIs []string
GQSign bool
OpenBrowser bool
HttpClient *http.Client
IssuedAtOffset time.Duration
issuer string
server *http.Server
publicKeyFinder discover.PublicKeyFinder
requestTokensOverrideFunc func(string) (*simpleoidc.Tokens, error)
httpSessionHook http.HandlerFunc
reuseBrowserWindowHook chan string
}
type StandardOpRefreshable struct {
StandardOp
}
var _ OpenIdProvider = (*StandardOp)(nil)
var _ BrowserOpenIdProvider = (*StandardOp)(nil)
var _ RefreshableOpenIdProvider = (*StandardOpRefreshable)(nil)
// NewStandardOp creates a standard OP (OpenID Provider) using the
// default configuration options and returns a BrowserOpenIdProvider.
func NewStandardOp(issuer string, clientID string) BrowserOpenIdProvider {
options := GetDefaultStandardOpOptions(issuer, clientID)
return NewStandardOpWithOptions(options)
}
func (s *StandardOp) requestTokens(ctx context.Context, cicHash string) (*simpleoidc.Tokens, error) {
if s.requestTokensOverrideFunc != nil {
return s.requestTokensOverrideFunc(cicHash)
}
redirectURI, ln, err := FindAvailablePort(s.RedirectURIs)
if err != nil {
return nil, err
}
logrus.Infof("listening on http://%s/", ln.Addr().String())
logrus.Info("press ctrl+c to stop")
mux := http.NewServeMux()
s.server = &http.Server{Handler: mux}
cookieHandler, err := configCookieHandler()
if err != nil {
return nil, err
}
options := []rp.Option{
rp.WithCookieHandler(cookieHandler),
rp.WithSigningAlgsFromDiscovery(),
rp.WithVerifierOpts(
rp.WithIssuedAtOffset(s.IssuedAtOffset), rp.WithNonce(
func(ctx context.Context) string { return cicHash })),
}
options = append(options, rp.WithPKCE(cookieHandler))
if s.HttpClient != nil {
options = append(options, rp.WithHTTPClient(s.HttpClient))
}
// The reason we don't set the relyingParty on the struct and reuse it,
// is because refresh requests require a slightly different set of
// options. For instance we want the option to check the nonce (WithNonce)
// here, but in RefreshTokens we don't want that option set because
// a refreshed ID token doesn't have a nonce.
relyingParty, err := rp.NewRelyingPartyOIDC(ctx,
s.issuer, s.clientID, s.ClientSecret, redirectURI.String(),
s.Scopes, options...)
if err != nil {
return nil, fmt.Errorf("error creating provider: %w", err)
}
state := func() string {
return uuid.New().String()
}
shutdownServer := func() {
if err := s.server.Shutdown(ctx); err != nil {
logrus.Errorf("Failed to shutdown http server: %v", err)
}
}
chTokens := make(chan *oidc.Tokens[*oidc.IDTokenClaims], 1)
chErr := make(chan error, 1)
mux.Handle("/login", rp.AuthURLHandler(state, relyingParty,
rp.WithURLParam("nonce", cicHash),
// Select account requires that the user click the account they want to use.
// Results in better UX than just automatically dropping them into their
// only signed in account.
// See prompt parameter in OIDC spec https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
rp.WithPromptURLParam(s.PromptType),
rp.WithURLParam("access_type", s.AccessType)),
)
marshalToken := func(w http.ResponseWriter, r *http.Request, retTokens *oidc.Tokens[*oidc.IDTokenClaims], state string, rp rp.RelyingParty) {
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
chErr <- err
return
}
chTokens <- retTokens
// If defined the OIDC client hands over control of the HTTP server session to the OpenPubkey client.
// Useful for redirecting the user's browser window that just finished OIDC Auth flow to the
// MFA Cosigner Auth URI.
if s.httpSessionHook != nil {
s.httpSessionHook(w, r)
defer shutdownServer() // If no http session hook is set, we do server shutdown in RequestTokens
} else {
if _, err := w.Write([]byte("You may now close this window")); err != nil {
logrus.Error(err)
}
}
}
callbackPath := redirectURI.Path
mux.Handle(callbackPath, rp.CodeExchangeHandler(marshalToken, relyingParty))
go func() {
err := s.server.Serve(ln)
if err != nil && err != http.ErrServerClosed {
logrus.Error(err)
}
}()
loginURI := fmt.Sprintf("http://localhost:%s/login", redirectURI.Port())
// If reuseBrowserWindowHook is set, don't open a new browser window
// instead redirect the user's existing browser window
if s.reuseBrowserWindowHook != nil {
s.reuseBrowserWindowHook <- loginURI
} else if s.OpenBrowser {
logrus.Infof("Opening browser to %s ", loginURI)
if err := util.OpenUrl(loginURI); err != nil {
logrus.Errorf("Failed to open url: %v", err)
}
} else {
// If s.OpenBrowser is false, tell the user what URL to open.
// This is useful when a user wants to use a different browser than the default one.
logrus.Infof("Open your browser to: %s ", loginURI)
}
// If httpSessionHook is not defined shutdown the server when done,
// otherwise keep it open for the httpSessionHook
// If httpSessionHook is set we handle both possible cases to ensure
// the server is shutdown:
// 1. We shut it down if an error occurs in the marshalToken handler
// 2. We shut it down if the marshalToken handler completes
if s.httpSessionHook == nil {
defer shutdownServer()
}
select {
case <-ctx.Done():
return nil, ctx.Err()
case err := <-chErr:
if s.httpSessionHook != nil {
defer shutdownServer()
}
return nil, err
case retTokens := <-chTokens:
// retTokens is a zitadel/oidc struct. We turn it into our simpler token struct
return &simpleoidc.Tokens{
IDToken: []byte(retTokens.IDToken),
RefreshToken: []byte(retTokens.RefreshToken),
AccessToken: []byte(retTokens.AccessToken)}, nil
}
}
func (s *StandardOp) RequestTokens(ctx context.Context, cic *clientinstance.Claims) (*simpleoidc.Tokens, error) {
// Define our commitment as the hash of the client instance claims
cicHash, err := cic.Hash()
if err != nil {
return nil, fmt.Errorf("error calculating client instance claim commitment: %w", err)
}
tokens, err := s.requestTokens(ctx, string(cicHash))
if err != nil {
return nil, err
}
if s.GQSign {
idToken := tokens.IDToken
if gqToken, err := CreateGQToken(ctx, idToken, s); err != nil {
return nil, err
} else {
tokens.IDToken = gqToken
return tokens, nil
}
}
return tokens, nil
}
func (s *StandardOpRefreshable) RefreshTokens(ctx context.Context, refreshToken []byte) (*simpleoidc.Tokens, error) {
cookieHandler, err := configCookieHandler()
if err != nil {
return nil, err
}
options := []rp.Option{
rp.WithCookieHandler(cookieHandler),
rp.WithVerifierOpts(
rp.WithIssuedAtOffset(s.IssuedAtOffset),
rp.WithNonce(nil), // disable nonce check
),
}
options = append(options, rp.WithPKCE(cookieHandler))
if s.HttpClient != nil {
options = append(options, rp.WithHTTPClient(s.HttpClient))
}
// The redirect URI is not sent in the refresh request so we set it to an empty string.
// According to the OIDC spec the only values send on a refresh request are:
// client_id, client_secret, grant_type, refresh_token, and scope.
// https://openid.net/specs/openid-connect-core-1_0.html#RefreshingAccessToken
redirectURI := ""
relyingParty, err := rp.NewRelyingPartyOIDC(ctx, s.issuer, s.clientID,
s.ClientSecret, redirectURI, s.Scopes, options...)
if err != nil {
return nil, fmt.Errorf("failed to create RP to verify token: %w", err)
}
retTokens, err := rp.RefreshTokens[*oidc.IDTokenClaims](ctx, relyingParty, string(refreshToken), "", "")
if err != nil {
return nil, err
}
if retTokens.RefreshToken == "" {
// Google does not rotate refresh tokens, the one you get at the
// beginning is the only one you'll ever get. This may not be true
// of OPs.
retTokens.RefreshToken = string(refreshToken)
}
return &simpleoidc.Tokens{
IDToken: []byte(retTokens.IDToken),
RefreshToken: []byte(retTokens.RefreshToken),
AccessToken: []byte(retTokens.AccessToken)}, nil
}
func (s *StandardOp) PublicKeyByToken(ctx context.Context, token []byte) (*discover.PublicKeyRecord, error) {
return s.publicKeyFinder.ByToken(ctx, s.issuer, token)
}
func (s *StandardOp) PublicKeyByKeyId(ctx context.Context, keyID string) (*discover.PublicKeyRecord, error) {
return s.publicKeyFinder.ByKeyID(ctx, s.issuer, keyID)
}
func (s *StandardOp) Issuer() string {
return s.issuer
}
func (s *StandardOp) ClientID() string {
return s.clientID
}
func (s *StandardOp) VerifyIDToken(ctx context.Context, idt []byte, cic *clientinstance.Claims) error {
vp := NewProviderVerifier(
s.issuer,
ProviderVerifierOpts{
CommitType: CommitTypesEnum.NONCE_CLAIM,
ClientID: s.clientID,
DiscoverPublicKey: &s.publicKeyFinder,
})
return vp.VerifyIDToken(ctx, idt, cic)
}
func (s *StandardOpRefreshable) VerifyRefreshedIDToken(ctx context.Context, origIdt []byte, reIdt []byte) error {
if err := simpleoidc.SameIdentity(origIdt, reIdt); err != nil {
return fmt.Errorf("refreshed ID Token is for different subject than original ID Token: %w", err)
}
if err := simpleoidc.RequireOlder(origIdt, reIdt); err != nil {
return fmt.Errorf("refreshed ID Token should not be issued before original ID Token: %w", err)
}
options := []rp.Option{}
if s.HttpClient != nil {
options = append(options, rp.WithHTTPClient(s.HttpClient))
}
redirectURI := ""
relyingParty, err := rp.NewRelyingPartyOIDC(ctx, s.issuer, s.clientID,
s.ClientSecret, redirectURI, s.Scopes, options...)
if err != nil {
return fmt.Errorf("failed to create RP to verify token: %w", err)
}
_, err = rp.VerifyIDToken[*oidc.IDTokenClaims](ctx, string(reIdt), relyingParty.IDTokenVerifier())
return err
}
// HookHTTPSession provides a means to hook the HTTP Server session resulting
// from the OpenID Provider sending an authcode to the OIDC client by
// redirecting the user's browser with the authcode supplied in the URI.
// If this hook is set, it will be called after the receiving the authcode
// but before send an HTTP response to the user. The code which sets this hook
// can choose what HTTP response to server to the user.
//
// We use this so that we can redirect the user web browser window to
// the MFA Cosigner URI after the user finishes the OIDC Auth flow. This
// method is only available to browser based providers.
func (s *StandardOp) HookHTTPSession(h http.HandlerFunc) {
s.httpSessionHook = h
}
// ReuseBrowserWindow is needed so that do not open more than one browser window.
// If we are using a web based OpenID Provider chooser, we have already opened one
// window on the user's browser. We should reuse that window here rather than
// opening a second browser window.
func (s *StandardOp) ReuseBrowserWindowHook(h chan string) {
s.reuseBrowserWindowHook = h
}
// GetBrowserWindowHook ris used by testing to trigger the redirect without
// calling out the OP. This is hidden by not including in the interface.
func (s *StandardOp) TriggerBrowserWindowHook(uri string) {
s.reuseBrowserWindowHook <- uri
}
|