oauthproxy

package module
v0.0.0-...-008dc81 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 15, 2026 License: MIT Imports: 35 Imported by: 0

README

Oauth Proxy

This proxy is created to allow multiple clients (programs, servers) to use the same Oauth token to be used simultaneously and keeping the latest (refresh) token in sync in multiple processes.

This is a proxy specifically for Oauth token calls. It intercepts calls to the token endpoint of a Oauth provider. The proxy keeps a local database of the tokens and expire times. Whenever a token is to expire, the proxy refreshes the token with a call to the original provider endpoint and stores the new tokens (refresh token and access token) centrally. So is ensured every client uses the same refresh token, access token and expire time. The proxy takes care of making calls to the original token endpoint.

       +----------+
       |          |
       |  Oauth   |
       | provider |
       |          |
       +----+-----+
            ^
            |
            v
       +----+-----+
       |          |
       |  Oauth   |
       |  proxy   |
       |          |
       +-+------+-+
         ^      ^
         |      |
     +---+      +---+
     |              |
+----+-----+   +----+-----+
|          |   |          |
|  Oauth   |   |  Oauth   |
|  client  |   |  client  |
|          |   |          |
+----------+   +----------+

Installation

go get github.com/omniboost/oauth-proxy/bin/oauth-proxy

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	GRAFANA_LOKI_URL   = os.Getenv("GRAFANA_LOKI_URL")
	GRAFANA_LOKI_USER  = os.Getenv("GRAFANA_LOKI_USER")
	GRAFANA_LOKI_TOKEN = os.Getenv("GRAFANA_LOKI_TOKEN")
)

Functions

This section is empty.

Types

type ErrorResponse 

type ErrorResponse struct {
	// acceptable:
	// - invalid_request
	// - invalid_client
	// - invalid_grant
	// - invalid_scope
	// - unauthorized_client
	// - unsupported_grant_type
	Error            string `json:"error"`
	ErrorDescription string `json:"error_description,omitempty"`
	ErrorURI         string `json:"error_uri,omitempty"`
}

type RawMessages 

type RawMessages map[string]json.RawMessage

type RevokeRequest 

type RevokeRequest struct {
	// contains filtered or unexported fields
}

type RoundTripperWithSave 

type RoundTripperWithSave struct {
	// contains filtered or unexported fields
}

func NewRoundTripperWithSave 

func NewRoundTripperWithSave(rtp http.RoundTripper) *RoundTripperWithSave

func (*RoundTripperWithSave) LastResponseBody 

func (rt *RoundTripperWithSave) LastResponseBody() io.Reader

func (*RoundTripperWithSave) RoundTrip 

func (rt *RoundTripperWithSave) RoundTrip(req *http.Request) (*http.Response, error)

type Server 

type Server struct {
	// contains filtered or unexported fields
}

func NewServer 

func NewServer() (*Server, error)

func (*Server) Addr 

func (s *Server) Addr() string

func (*Server) ErrorResponse 

func (s *Server) ErrorResponse(w http.ResponseWriter, err error)

func (*Server) GetTokenRequestParamsFromFormRequest 

func (s *Server) GetTokenRequestParamsFromFormRequest(r *http.Request) (providers.TokenRequestParams, error)

func (*Server) GetTokenRequestParamsFromJSONRequest 

func (s *Server) GetTokenRequestParamsFromJSONRequest(r *http.Request) (providers.TokenRequestParams, error)

func (*Server) GetTokenRequestParamsFromRequest 

func (s *Server) GetTokenRequestParamsFromRequest(r *http.Request) (providers.TokenRequestParams, error)

func (*Server) GetTokenRevokeParamsFromRequest 

func (s *Server) GetTokenRevokeParamsFromRequest(r *http.Request) (TokenRevokeParams, error)

func (*Server) NewClient 

func (s *Server) NewClient() *http.Client

func (*Server) NewDB 

func (s *Server) NewDB() (*sql.DB, error)

func (*Server) NewHTTP 

func (s *Server) NewHTTP() *http.Server

func (*Server) NewProviderRevokeHandler 

func (s *Server) NewProviderRevokeHandler(provider providers.RevokeProvider) http.HandlerFunc

func (*Server) NewProviderTokenHandler 

func (s *Server) NewProviderTokenHandler(provider providers.Provider) http.HandlerFunc

func (*Server) NewProviders 

func (s *Server) NewProviders() providers.Providers

func (*Server) NewRouter 

func (s *Server) NewRouter() *http.ServeMux

func (*Server) PushRequestResponseToGrafana 

func (s *Server) PushRequestResponseToGrafana(r *http.Request, w http.ResponseWriter, metrics httpsnoop.Metrics) error

func (*Server) RequestToken 

func (s *Server) RequestToken(provider providers.Provider, params providers.TokenRequestParams) (*Token, error)

func (*Server) RevokeToken 

func (s *Server) RevokeToken(provider providers.RevokeProvider, params TokenRevokeParams) (*http.Response, error)

func (*Server) SetDB 

func (s *Server) SetDB(db *sql.DB)

func (*Server) SetHTTP 

func (s *Server) SetHTTP(http *http.Server)

func (*Server) SetPort 

func (s *Server) SetPort(port int)

func (*Server) SetProviders 

func (s *Server) SetProviders(pp providers.Providers)

func (*Server) SetRouter 

func (s *Server) SetRouter(r *http.ServeMux)

func (*Server) Start 

func (s *Server) Start() error

func (*Server) StartLambda 

func (s *Server) StartLambda() error

func (*Server) StartLocal 

func (s *Server) StartLocal() error

func (*Server) Stop 

func (s *Server) Stop() error

type Token 

type Token struct {
	*oauth2.Token
	Raw map[string]json.RawMessage
}

type TokenRequest 

type TokenRequest struct {
	// contains filtered or unexported fields
}

type TokenRequestBody 

type TokenRequestBody struct {
	RefreshToken string `json:"refresh_token"`
	ClientID     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
	Code         string `json:"code"`
	RedirectURL  string `json:"redirect_uri"`
	CodeVerifier string `json:"code_verifier,omitempty"`
	GrantType    string
	Username     string
	Password     string

	RawMessages
}

func (*TokenRequestBody) UnmarshalJSON 

func (rb *TokenRequestBody) UnmarshalJSON(data []byte) error

func (TokenRequestBody) Validate 

func (rb TokenRequestBody) Validate() []error

type TokenRequestResult 

type TokenRequestResult struct {
	// contains filtered or unexported fields
}

type TokenRequester 

type TokenRequester struct {
	// contains filtered or unexported fields
}

func NewTokenRequester 

func NewTokenRequester(db *sql.DB, provider providers.Provider) *TokenRequester

func (*TokenRequester) AuthorizationTokenFromDB 

func (tr *TokenRequester) AuthorizationTokenFromDB(db mysql.DB, params providers.TokenRequestParams) (*mysql.OauthToken, error)

func (*TokenRequester) ClientCredentialsTokenFromDB 

func (tr *TokenRequester) ClientCredentialsTokenFromDB(db mysql.DB, params providers.TokenRequestParams) (*mysql.OauthToken, error)

func (*TokenRequester) CodeExchange 

func (tr *TokenRequester) CodeExchange(req TokenRequest) (*Token, error)

func (*TokenRequester) DBTokenToOauth2Token 

func (tr *TokenRequester) DBTokenToOauth2Token(dbToken *mysql.OauthToken) (*Token, error)

func (*TokenRequester) FetchNewTokenAuthorizationCode 

func (tr *TokenRequester) FetchNewTokenAuthorizationCode(params providers.TokenRequestParams) (*oauth2.Token, error)

func (*TokenRequester) FetchNewTokenClientCredentials 

func (tr *TokenRequester) FetchNewTokenClientCredentials(params providers.TokenRequestParams) (*oauth2.Token, error)

func (*TokenRequester) FetchNewTokenPassword 

func (tr *TokenRequester) FetchNewTokenPassword(params providers.TokenRequestParams) (*oauth2.Token, error)

func (*TokenRequester) IncrementNrOfSubsequentProviderErrors 

func (tr *TokenRequester) IncrementNrOfSubsequentProviderErrors(db mysql.DB, token *mysql.OauthToken) error

func (*TokenRequester) Listen 

func (tr *TokenRequester) Listen()

func (*TokenRequester) NewTokenRequest 

func (tr *TokenRequester) NewTokenRequest(params providers.TokenRequestParams) TokenRequest

func (*TokenRequester) PasswordTokenFromDB 

func (tr *TokenRequester) PasswordTokenFromDB(db mysql.DB, params providers.TokenRequestParams) (*mysql.OauthToken, error)

func (*TokenRequester) Request 

func (tr *TokenRequester) Request(params providers.TokenRequestParams) (*Token, error)

func (*TokenRequester) SaveAuthorizationToken 

func (tr *TokenRequester) SaveAuthorizationToken(db mysql.DB, token *Token, params providers.TokenRequestParams) (mysql.OauthToken, error)

func (*TokenRequester) SaveClientCredentialsToken 

func (tr *TokenRequester) SaveClientCredentialsToken(db mysql.DB, token *Token, params providers.TokenRequestParams) (mysql.OauthToken, error)

func (*TokenRequester) SavePasswordToken 

func (tr *TokenRequester) SavePasswordToken(db mysql.DB, token *Token, params providers.TokenRequestParams) (mysql.OauthToken, error)

func (*TokenRequester) Start 

func (tr *TokenRequester) Start()

func (*TokenRequester) Stop 

func (tr *TokenRequester) Stop()

func (*TokenRequester) TokenRefresh 

func (tr *TokenRequester) TokenRefresh(req TokenRequest) (*Token, error)

func (*TokenRequester) TokenRefreshAuthorizationCode 

func (tr *TokenRequester) TokenRefreshAuthorizationCode(req TokenRequest) (*Token, error)

func (*TokenRequester) TokenRefreshClientCredentials 

func (tr *TokenRequester) TokenRefreshClientCredentials(req TokenRequest) (*Token, error)

func (*TokenRequester) TokenRefreshPassword 

func (tr *TokenRequester) TokenRefreshPassword(req TokenRequest) (*Token, error)

func (*TokenRequester) VerifyIDToken 

func (tr *TokenRequester) VerifyIDToken(token *oauth2.Token, params providers.TokenRequestParams) error

type TokenResponseBody 

type TokenResponseBody struct {
	TokenType    string `json:"token_type"`
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
	ExpiresIn    int    `json:"expires_in"`

	RawMessages `json:"-"`
}

func (TokenResponseBody) MarshalJSON 

func (rb TokenResponseBody) MarshalJSON() ([]byte, error)

func (*TokenResponseBody) UnmarshalJSON 

func (rb *TokenResponseBody) UnmarshalJSON(data []byte) error

type TokenRevokeParams 

type TokenRevokeParams struct {
	ClientID     string `schema:"client_id"`
	ClientSecret string `schema:"client_secret"`

	Token         string `schema:"token"`
	TokenTypeHint string `schema:"token_type_hint"`
	Request       *http.Request
}

type TokenRevokeResult 

type TokenRevokeResult struct {
	// contains filtered or unexported fields
}

type TokenRevoker 

type TokenRevoker struct {
	// contains filtered or unexported fields
}

func NewTokenRevoker 

func NewTokenRevoker(db *sql.DB, provider providers.RevokeProvider) *TokenRevoker

func (*TokenRevoker) Listen 

func (tr *TokenRevoker) Listen()

func (*TokenRevoker) NewTokenRevoke 

func (tr *TokenRevoker) NewTokenRevoke(params TokenRevokeParams) RevokeRequest

func (*TokenRevoker) Revoke 

func (tr *TokenRevoker) Revoke(params TokenRevokeParams) (*http.Response, error)

func (*TokenRevoker) Start 

func (tr *TokenRevoker) Start()

Source Files

View all Source files

Directories

Path Synopsis
bin
oauth-proxy command
oauth-proxy/cmd
Package mysql contains generated code for schema 'oauth_proxy'.
 Package mysql contains generated code for schema 'oauth_proxy'.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.