client

package
v1.0.0-beta.9 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2018 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ClientsHandlerPath = "/clients"
)

Variables

View Source 
var Migrations = map[string]*migrate.MemoryMigrationSource{
	"mysql": {Migrations: []*migrate.Migration{
		sharedMigrations[0],
		sharedMigrations[1],
		sharedMigrations[2],
		{
			Id: "4",
			Up: []string{
				`UPDATE hydra_client SET sector_identifier_uri='', jwks='', jwks_uri='', request_uris=''`,
				`ALTER TABLE hydra_client MODIFY sector_identifier_uri TEXT NOT NULL`,
				`ALTER TABLE hydra_client MODIFY jwks TEXT NOT NULL`,
				`ALTER TABLE hydra_client MODIFY jwks_uri TEXT NOT NULL`,
				`ALTER TABLE hydra_client MODIFY request_uris TEXT NOT NULL`,
			},
			Down: []string{
				`ALTER TABLE hydra_client MODIFY sector_identifier_uri TEXT`,
				`ALTER TABLE hydra_client MODIFY jwks TEXT`,
				`ALTER TABLE hydra_client MODIFY jwks_uri TEXT`,
				`ALTER TABLE hydra_client MODIFY request_uris TEXT`,
			},
		},
		sharedMigrations[3],
		sharedMigrations[4],
		sharedMigrations[5],
		{
			Id: "8",
			Up: []string{
				`UPDATE hydra_client SET allowed_cors_origins=''`,
				`ALTER TABLE hydra_client MODIFY allowed_cors_origins TEXT NOT NULL`,
			},
			Down: []string{
				`ALTER TABLE hydra_client MODIFY allowed_cors_origins TEXT`,
			},
		},
	}},
	"postgres": {Migrations: []*migrate.Migration{
		sharedMigrations[0],
		sharedMigrations[1],
		sharedMigrations[2],
		{
			Id: "4",
			Up: []string{
				`UPDATE hydra_client SET sector_identifier_uri='', jwks='', jwks_uri='', request_uris=''`,
				`ALTER TABLE hydra_client ALTER COLUMN sector_identifier_uri SET NOT NULL`,
				`ALTER TABLE hydra_client ALTER COLUMN jwks SET NOT NULL`,
				`ALTER TABLE hydra_client ALTER COLUMN jwks_uri SET NOT NULL`,
				`ALTER TABLE hydra_client ALTER COLUMN request_uris SET NOT NULL`,
			},
			Down: []string{
				`ALTER TABLE hydra_client ALTER COLUMN sector_identifier_uri DROP NOT NULL`,
				`ALTER TABLE hydra_client ALTER COLUMN jwks DROP NOT NULL`,
				`ALTER TABLE hydra_client ALTER COLUMN jwks_uri DROP NOT NULL`,
				`ALTER TABLE hydra_client ALTER COLUMN request_uris DROP NOT NULL`,
			},
		},
		sharedMigrations[3],
		sharedMigrations[4],
		sharedMigrations[5],
		{
			Id: "8",
			Up: []string{
				`UPDATE hydra_client SET allowed_cors_origins=''`,
				`ALTER TABLE hydra_client ALTER COLUMN allowed_cors_origins SET NOT NULL`,
			},
			Down: []string{
				`ALTER TABLE hydra_client ALTER COLUMN allowed_cors_origins DROP NOT NULL`,
			},
		},
	}},
}

Functions

func TestHelperClientAuthenticate added in v0.9.3 

func TestHelperClientAuthenticate(k string, m Manager) func(t *testing.T)

func TestHelperClientAutoGenerateKey added in v0.9.1 

func TestHelperClientAutoGenerateKey(k string, m Storage) func(t *testing.T)

func TestHelperCreateGetDeleteClient added in v0.9.1 

func TestHelperCreateGetDeleteClient(k string, m Storage) func(t *testing.T)

Types

type Client 

type Client struct {
	// ClientID  is the id for this client.
	ClientID string `json:"client_id"`

	// Name is the human-readable string name of the client to be presented to the
	// end-user during authorization.
	Name string `json:"client_name"`

	// Secret is the client's secret. The secret will be included in the create request as cleartext, and then
	// never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users
	// that they need to write the secret down as it will not be made available again.
	Secret string `json:"client_secret,omitempty"`

	// RedirectURIs is an array of allowed redirect urls for the client, for example http://mydomain/oauth/callback .
	RedirectURIs []string `json:"redirect_uris"`

	// GrantTypes is an array of grant types the client is allowed to use.
	//
	// Pattern: client_credentials|authorize_code|implicit|refresh_token
	GrantTypes []string `json:"grant_types"`

	// ResponseTypes is an array of the OAuth 2.0 response type strings that the client can
	// use at the authorization endpoint.
	//
	// Pattern: id_token|code|token
	ResponseTypes []string `json:"response_types"`

	// Scope is a string containing a space-separated list of scope values (as
	// described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client
	// can use when requesting access tokens.
	//
	// Pattern: ([a-zA-Z0-9\.\*]+\s?)+
	Scope string `json:"scope"`

	// Owner is a string identifying the owner of the OAuth 2.0 Client.
	Owner string `json:"owner"`

	// PolicyURI is a URL string that points to a human-readable privacy policy document
	// that describes how the deployment organization collects, uses,
	// retains, and discloses personal data.
	PolicyURI string `json:"policy_uri"`

	// AllowedCORSOrigins are one or more URLs (scheme://host[:port]) which are allowed to make CORS requests
	// to the /oauth/token endpoint. If this array is empty, the sever's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)
	// will be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.
	// Be aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.
	AllowedCORSOrigins []string `json:"allowed_cors_origins"`

	// TermsOfServiceURI is a URL string that points to a human-readable terms of service
	// document for the client that describes a contractual relationship
	// between the end-user and the client that the end-user accepts when
	// authorizing the client.
	TermsOfServiceURI string `json:"tos_uri"`

	// ClientURI is an URL string of a web page providing information about the client.
	// If present, the server SHOULD display this URL to the end-user in
	// a clickable fashion.
	ClientURI string `json:"client_uri"`

	// LogoURI is an URL string that references a logo for the client.
	LogoURI string `json:"logo_uri"`

	// Contacts is a array of strings representing ways to contact people responsible
	// for this client, typically email addresses.
	Contacts []string `json:"contacts"`

	// SecretExpiresAt is an integer holding the time at which the client
	// secret will expire or 0 if it will not expire. The time is
	// represented as the number of seconds from 1970-01-01T00:00:00Z as
	// measured in UTC until the date/time of expiration.
	SecretExpiresAt int `json:"client_secret_expires_at"`

	// SubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a
	// list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.
	SubjectType string `json:"subject_type"`

	// URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a
	// file with a single JSON array of redirect_uri values.
	SectorIdentifierURI string `json:"sector_identifier_uri,omitempty"`

	// URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains
	// the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the
	// Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing
	// and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced
	// JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both
	// signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used
	// to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST
	// match those in the certificate.
	JSONWebKeysURI string `json:"jwks_uri,omitempty"`

	// Client's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as
	// the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter
	// is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for
	// instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client
	// can use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation
	// (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks
	// parameters MUST NOT be used together.
	JSONWebKeys *jose.JSONWebKeySet `json:"jwks,omitempty"`

	// Requested Client Authentication method for the Token Endpoint. The options are client_secret_post,
	// client_secret_basic, private_key_jwt, and none.
	TokenEndpointAuthMethod string `json:"token_endpoint_auth_method,omitempty"`

	// Array of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the
	// contents of the files referenced by these URIs and not retrieve them at the time they are used in a request.
	// OPs can require that request_uri values used be pre-registered with the require_request_uri_registration
	// discovery parameter.
	RequestURIs []string `json:"request_uris,omitempty"`

	// JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects
	// from this Client MUST be rejected, if not signed with this algorithm.
	RequestObjectSigningAlgorithm string `json:"request_object_signing_alg,omitempty"`

	// JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT
	// [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims
	// as a UTF-8 encoded JSON object using the application/json content-type.
	UserinfoSignedResponseAlg string `json:"userinfo_signed_response_alg,omitempty"`
}

Client represents an OAuth 2.0 Client.

swagger:model oAuth2Client

func (*Client) GetGrantTypes 

func (c *Client) GetGrantTypes() fosite.Arguments

func (*Client) GetHashedSecret 

func (c *Client) GetHashedSecret() []byte

func (*Client) GetID 

func (c *Client) GetID() string

func (*Client) GetJSONWebKeys 

func (c *Client) GetJSONWebKeys() *jose.JSONWebKeySet

func (*Client) GetJSONWebKeysURI 

func (c *Client) GetJSONWebKeysURI() string

func (*Client) GetOwner 

func (c *Client) GetOwner() string

func (*Client) GetRedirectURIs 

func (c *Client) GetRedirectURIs() []string

func (*Client) GetRequestObjectSigningAlgorithm 

func (c *Client) GetRequestObjectSigningAlgorithm() string

func (*Client) GetRequestURIs 

func (c *Client) GetRequestURIs() []string

func (*Client) GetResponseTypes 

func (c *Client) GetResponseTypes() fosite.Arguments

func (*Client) GetScopes 

func (c *Client) GetScopes() fosite.Arguments

func (*Client) GetTokenEndpointAuthMethod 

func (c *Client) GetTokenEndpointAuthMethod() string

func (*Client) GetTokenEndpointAuthSigningAlgorithm 

func (c *Client) GetTokenEndpointAuthSigningAlgorithm() string

func (*Client) IsPublic added in v0.6.0 

func (c *Client) IsPublic() bool

type Handler 

type Handler struct {
	Manager   Manager
	H         herodot.Writer
	Validator *Validator
}

func NewHandler 

func NewHandler(
	manager Manager,
	h herodot.Writer,
	defaultClientScopes []string,
	subjectTypes []string,
) *Handler

func (*Handler) Create 

func (h *Handler) Create(w http.ResponseWriter, r *http.Request, _ httprouter.Params)

swagger:route POST /clients oAuth2 createOAuth2Client

Create an OAuth 2.0 client

Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. 

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Responses:
  200: oAuth2Client
  401: genericError
  403: genericError
  500: genericError

func (*Handler) Delete 

func (h *Handler) Delete(w http.ResponseWriter, r *http.Request, ps httprouter.Params)

swagger:route DELETE /clients/{id} oAuth2 deleteOAuth2Client

Deletes an OAuth 2.0 Client

Delete an existing OAuth 2.0 Client by its ID.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. 

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Responses:
  204: emptyResponse
  401: genericError
  403: genericError
  500: genericError

func (*Handler) Get 

func (h *Handler) Get(w http.ResponseWriter, r *http.Request, ps httprouter.Params)

swagger:route GET /clients/{id} oAuth2 getOAuth2Client

Get an OAuth 2.0 Client.

Get an OAUth 2.0 client by its ID. This endpoint never returns passwords.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. 

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Responses:
  200: oAuth2Client
  401: genericError
  403: genericError
  500: genericError

func (*Handler) List added in v0.8.0 

func (h *Handler) List(w http.ResponseWriter, r *http.Request, ps httprouter.Params)

swagger:route GET /clients oAuth2 listOAuth2Clients

List OAuth 2.0 Clients

This endpoint lists all clients in the database, and never returns client secrets.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. 

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Responses:
  200: oAuth2ClientList
  401: genericError
  403: genericError
  500: genericError

func (*Handler) SetRoutes 

func (h *Handler) SetRoutes(r *httprouter.Router)

func (*Handler) Update added in v0.5.0 

func (h *Handler) Update(w http.ResponseWriter, r *http.Request, ps httprouter.Params)

swagger:route PUT /clients/{id} oAuth2 updateOAuth2Client

Update an OAuth 2.0 Client

Update an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. 

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Responses:
  200: oAuth2Client
  401: genericError
  403: genericError
  500: genericError

type Manager 

type Manager interface {
	Storage

	Authenticate(id string, secret []byte) (*Client, error)
}

type MemoryManager 

type MemoryManager struct {
	Clients []Client
	Hasher  fosite.Hasher
	sync.RWMutex
}

func NewMemoryManager added in v0.9.14 

func NewMemoryManager(hasher fosite.Hasher) *MemoryManager

func (*MemoryManager) Authenticate 

func (m *MemoryManager) Authenticate(id string, secret []byte) (*Client, error)

func (*MemoryManager) CreateClient 

func (m *MemoryManager) CreateClient(c *Client) error

func (*MemoryManager) DeleteClient 

func (m *MemoryManager) DeleteClient(id string) error

func (*MemoryManager) GetClient 

func (m *MemoryManager) GetClient(_ context.Context, id string) (fosite.Client, error)

func (*MemoryManager) GetClients 

func (m *MemoryManager) GetClients(limit, offset int) (clients map[string]Client, err error)

func (*MemoryManager) GetConcreteClient 

func (m *MemoryManager) GetConcreteClient(id string) (*Client, error)

func (*MemoryManager) UpdateClient added in v0.5.0 

func (m *MemoryManager) UpdateClient(c *Client) error

type SQLManager added in v0.6.0 

type SQLManager struct {
	Hasher fosite.Hasher
	DB     *sqlx.DB
}

func (*SQLManager) Authenticate added in v0.6.0 

func (m *SQLManager) Authenticate(id string, secret []byte) (*Client, error)

func (*SQLManager) CreateClient added in v0.6.0 

func (m *SQLManager) CreateClient(c *Client) error

func (*SQLManager) CreateSchemas added in v0.6.0 

func (m *SQLManager) CreateSchemas() (int, error)

func (*SQLManager) DeleteClient added in v0.6.0 

func (m *SQLManager) DeleteClient(id string) error

func (*SQLManager) GetClient added in v0.6.0 

func (m *SQLManager) GetClient(_ context.Context, id string) (fosite.Client, error)

func (*SQLManager) GetClients added in v0.6.0 

func (m *SQLManager) GetClients(limit, offset int) (clients map[string]Client, err error)

func (*SQLManager) GetConcreteClient added in v0.6.0 

func (m *SQLManager) GetConcreteClient(id string) (*Client, error)

func (*SQLManager) UpdateClient added in v0.6.0 

func (m *SQLManager) UpdateClient(c *Client) error

type Storage 

type Storage interface {
	fosite.Storage

	CreateClient(c *Client) error

	UpdateClient(c *Client) error

	DeleteClient(id string) error

	GetClients(limit, offset int) (map[string]Client, error)

	GetConcreteClient(id string) (*Client, error)
}

type Validator 

type Validator struct {
	DefaultClientScopes []string
	SubjectTypes        []string
	// contains filtered or unexported fields
}

func NewValidator 

func NewValidator(
	defaultClientScopes []string,
	subjectTypes []string,
) *Validator

func (*Validator) Validate 

func (v *Validator) Validate(c *Client) error

Source Files

View all Source files

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.