{{.Title}}
{{.Message}}
// package oauth implement an oauth client defined in e.g. rfc 6749 // However, we try to follow some recommendations from the v2.1 oauth draft RFC // Some specific things we implement here: // - PKCE (RFC 7636) // - ISS (RFC 9207) package oauth import ( "context" "crypto/sha256" "encoding/base64" "encoding/json" "errors" "fmt" "html/template" "net" "net/http" "net/url" "time" httpw "github.com/eduvpn/eduvpn-common/internal/http" "github.com/eduvpn/eduvpn-common/internal/util" "github.com/eduvpn/eduvpn-common/types" ) // genState generates a random base64 string to be used for state // https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-04#section-4.1.1 // "state": OPTIONAL. An opaque value used by the client to maintain // state between the request and callback. The authorization server // includes this value when redirecting the user agent back to the // client. // We implement it similarly to the verifier. func genState() (string, error) { randomBytes, err := util.MakeRandomByteSlice(32) if err != nil { return "", types.NewWrappedError("failed generating an OAuth state", err) } // For consistency we also use raw url encoding here return base64.RawURLEncoding.EncodeToString(randomBytes), nil } // genChallengeS256 generates a sha256 base64 challenge from a verifier // https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-04#section-7.8 func genChallengeS256(verifier string) string { hash := sha256.Sum256([]byte(verifier)) // We use raw url encoding as the challenge does not accept padding return base64.RawURLEncoding.EncodeToString(hash[:]) } // genVerifier generates a verifier // https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-04#section-4.1.1 // The code_verifier is a unique high-entropy cryptographically random // string generated for each authorization request, using the unreserved // characters [A-Z] / [a-z] / [0-9] / "-" / "." / "_" / "~", with a // minimum length of 43 characters and a maximum length of 128 // characters. // We implement it according to the note: // NOTE: The code verifier SHOULD have enough entropy to make it // impractical to guess the value. It is RECOMMENDED that the output of // a suitable random number generator be used to create a 32-octet // sequence. The octet sequence is then base64url-encoded to produce a // 43-octet URL safe string to use as the code verifier. // See: https://datatracker.ietf.org/doc/html/rfc7636#section-4.1 func genVerifier() (string, error) { randomBytes, err := util.MakeRandomByteSlice(32) if err != nil { return "", types.NewWrappedError( "failed generating an OAuth verifier", err, ) } return base64.RawURLEncoding.EncodeToString(randomBytes), nil } // OAuth defines the main structure for this package. type OAuth struct { // ISS indicates the issuer indentifier of the authorization server as defined in RFC 9207 ISS string `json:"iss"` // BaseAuthorizationURL is the URL where authorization should take place BaseAuthorizationURL string `json:"base_authorization_url"` // TokenURL is the URL where tokens should be obtained TokenURL string `json:"token_url"` // session is the internal in progress OAuth session session ExchangeSession `json:"-"` // Token is where the access and refresh tokens are stored along with the timestamps token Token `json:"-"` } // ExchangeSession is a structure that gets passed to the callback for easy access to the current state. type ExchangeSession struct { // CallbackError indicates an error returned by the server CallbackError error // ClientID is the ID of the OAuth client ClientID string // ISS indicates the issuer inditifer ISS string // State is the expected URL state paremeter State string // Verifier is the preimage of the challenge Verifier string // Context is the context used for cancellation Context context.Context // Server is the server of the session Server *http.Server // Listener is the listener where the servers 'listens' on Listener net.Listener } // AccessToken gets the OAuth access token used for contacting the server API // It returns the access token as a string, possibly obtained fresh using the Refresh Token // If the token cannot be obtained, an error is returned and the token is an empty string. func (oauth *OAuth) AccessToken() (string, error) { errorMessage := "failed getting access token" tokens := oauth.token // We have tokens... // The tokens are not expired yet // So they should be valid, re-login not needed if !tokens.Expired() { return tokens.access, nil } // Check if refresh is even possible by doing a simple check if the refresh token is empty // This is not needed but reduces API calls to the server if tokens.refresh == "" { return "", types.NewWrappedError(errorMessage, &TokensInvalidError{Cause: "no refresh token is present"}) } // Otherwise refresh and then later return the access token if we are successful refreshErr := oauth.tokensWithRefresh() if refreshErr != nil { // We have failed to ensure the tokens due to refresh not working return "", types.NewWrappedError( errorMessage, &TokensInvalidError{ Cause: fmt.Sprintf("tokens failed refresh with error: %v", refreshErr), }, ) } // We have obtained new tokens with refresh return tokens.access, nil } // setupListener sets up an OAuth listener // If it was unsuccessful it returns an error. func (oauth *OAuth) setupListener() error { errorMessage := "failed setting up listener" oauth.session.Context = context.Background() // create a listener listener, listenerErr := net.Listen("tcp", ":0") if listenerErr != nil { return types.NewWrappedError(errorMessage, listenerErr) } oauth.session.Listener = listener return nil } // tokensWithCallback gets the OAuth tokens using a local web server // If it was unsuccessful it returns an error. func (oauth *OAuth) tokensWithCallback() error { errorMessage := "failed getting tokens with callback" if oauth.session.Listener == nil { return types.NewWrappedError(errorMessage, errors.New("no listener")) } mux := http.NewServeMux() // server /callback over the listener address oauth.session.Server = &http.Server{ Handler: mux, } mux.HandleFunc("/callback", oauth.Callback) if err := oauth.session.Server.Serve(oauth.session.Listener); err != http.ErrServerClosed { return types.NewWrappedError(errorMessage, err) } return oauth.session.CallbackError } // fillToken fills the OAuth token structure by the response // It calculates the expired timestamp by having a 'startTime' passed to it // The URL that is input here is used for additional context. func (oauth *OAuth) fillToken(response []byte, startTime time.Time, url string) error { responseStructure := TokenResponse{} jsonErr := json.Unmarshal(response, &responseStructure) if jsonErr != nil { return types.NewWrappedError( "failed filling OAuth tokens", &httpw.ParseJSONError{URL: url, Body: string(response), Err: jsonErr}, ) } internalStructure := Token{} internalStructure.expiredTimestamp = startTime.Add( time.Second * time.Duration(responseStructure.Expires), ) internalStructure.access = responseStructure.Access internalStructure.refresh = responseStructure.Refresh oauth.token = internalStructure return nil } // SetTokenExpired marks the tokens as expired by setting the expired timestamp to the current time. func (oauth *OAuth) SetTokenExpired() { oauth.token.expiredTimestamp = time.Now() } // SetTokenRenew sets the tokens for renewal by completely clearing the structure. func (oauth *OAuth) SetTokenRenew() { oauth.token = Token{} } // tokensWithAuthCode gets the access and refresh tokens using the authorization code // Access tokens: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-04#section-1.4 // Refresh tokens: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-04#section-1.3.2 // If it was unsuccessful it returns an error. func (oauth *OAuth) tokensWithAuthCode(authCode string) error { errorMessage := "failed getting tokens with the authorization code" // Make sure the verifier is set as the parameter // so that the server can verify that we are the actual owner of the authorization code reqURL := oauth.TokenURL port, portErr := oauth.ListenerPort() if portErr != nil { return types.NewWrappedError(errorMessage, portErr) } data := url.Values{ "client_id": {oauth.session.ClientID}, "code": {authCode}, "code_verifier": {oauth.session.Verifier}, "grant_type": {"authorization_code"}, "redirect_uri": {fmt.Sprintf("http://127.0.0.1:%d/callback", port)}, } headers := http.Header{ "content-type": {"application/x-www-form-urlencoded"}, } opts := &httpw.OptionalParams{Headers: headers, Body: data} currentTime := time.Now() _, body, bodyErr := httpw.PostWithOpts(reqURL, opts) if bodyErr != nil { return types.NewWrappedError(errorMessage, bodyErr) } fillErr := oauth.fillToken(body, currentTime, reqURL) if fillErr != nil { return types.NewWrappedError(errorMessage, fillErr) } return nil } // tokensWithRefresh gets the access and refresh tokens with a previously received refresh token // Access tokens: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-04#section-1.4 // Refresh tokens: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-04#section-1.3.2 // If it was unsuccessful it returns an error. func (oauth *OAuth) tokensWithRefresh() error { errorMessage := "failed getting tokens with the refresh token" reqURL := oauth.TokenURL data := url.Values{ "refresh_token": {oauth.token.refresh}, "grant_type": {"refresh_token"}, } headers := http.Header{ "content-type": {"application/x-www-form-urlencoded"}, } opts := &httpw.OptionalParams{Headers: headers, Body: data} currentTime := time.Now() _, body, bodyErr := httpw.PostWithOpts(reqURL, opts) if bodyErr != nil { return types.NewWrappedError(errorMessage, bodyErr) } fillErr := oauth.fillToken(body, currentTime, reqURL) if fillErr != nil { return types.NewWrappedError(errorMessage, fillErr) } return nil } // responseTemplate is the HTML template for the OAuth authorized response // this template was dapted from: https://github.com/eduvpn/apple/blob/5b18f834be7aebfed00570ae0c2f7bcbaf1c69cc/EduVPN/Helpers/Mac/OAuthRedirectHTTPHandler.m#L25 const responseTemplate string = `
{{.Message}}