Documentation ¶
Overview ¶
Package client Code generated by go-bindata. (@generated) DO NOT EDIT. sources: migrations/sql/cockroach/13.sql migrations/sql/cockroach/14.sql migrations/sql/mysql/11.sql migrations/sql/mysql/13.sql migrations/sql/mysql/14.sql migrations/sql/mysql/4.sql migrations/sql/mysql/8.sql migrations/sql/mysql/9.sql migrations/sql/postgres/11.sql migrations/sql/postgres/13.sql migrations/sql/postgres/14.sql migrations/sql/postgres/4.sql migrations/sql/postgres/8.sql migrations/sql/postgres/9.sql migrations/sql/shared/.gitattributes migrations/sql/shared/.gitkeep migrations/sql/shared/1.sql migrations/sql/shared/10.sql migrations/sql/shared/12.sql migrations/sql/shared/2.sql migrations/sql/shared/3.sql migrations/sql/shared/5.sql migrations/sql/shared/6.sql migrations/sql/shared/7.sql migrations/sql/tests/.gitkeep migrations/sql/tests/10_test.sql migrations/sql/tests/11_test.sql migrations/sql/tests/12_test.sql migrations/sql/tests/13_test.sql migrations/sql/tests/14_test.sql migrations/sql/tests/1_test.sql migrations/sql/tests/2_test.sql migrations/sql/tests/3_test.sql migrations/sql/tests/4_test.sql migrations/sql/tests/5_test.sql migrations/sql/tests/6_test.sql migrations/sql/tests/7_test.sql migrations/sql/tests/8_test.sql migrations/sql/tests/9_test.sql
Index ¶
- Constants
- Variables
- func Asset(name string) ([]byte, error)
- func AssetDir(name string) ([]string, error)
- func AssetInfo(name string) (os.FileInfo, error)
- func AssetNames() []string
- func MustAsset(name string) []byte
- func RestoreAsset(dir, name string) error
- func RestoreAssets(dir, name string) error
- func TestHelperClientAuthenticate(k string, m Manager) func(t *testing.T)
- func TestHelperClientAutoGenerateKey(k string, m Storage) func(t *testing.T)
- func TestHelperCreateGetDeleteClient(k string, m Storage) func(t *testing.T)
- type Client
- func (c *Client) GetAudience() fosite.Arguments
- func (c *Client) GetGrantTypes() fosite.Arguments
- func (c *Client) GetHashedSecret() []byte
- func (c *Client) GetID() string
- func (c *Client) GetJSONWebKeys() *jose.JSONWebKeySet
- func (c *Client) GetJSONWebKeysURI() string
- func (c *Client) GetOwner() string
- func (c *Client) GetRedirectURIs() []string
- func (c *Client) GetRequestObjectSigningAlgorithm() string
- func (c *Client) GetRequestURIs() []string
- func (c *Client) GetResponseTypes() fosite.Arguments
- func (c *Client) GetScopes() fosite.Arguments
- func (c *Client) GetTokenEndpointAuthMethod() string
- func (c *Client) GetTokenEndpointAuthSigningAlgorithm() string
- func (c *Client) IsPublic() bool
- type Configuration
- type Handler
- func (h *Handler) Create(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
- func (h *Handler) Delete(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
- func (h *Handler) Get(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
- func (h *Handler) List(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
- func (h *Handler) SetRoutes(admin *x.RouterAdmin)
- func (h *Handler) Update(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
- type InternalRegistry
- type Manager
- type MemoryManager
- func (m *MemoryManager) Authenticate(ctx context.Context, id string, secret []byte) (*Client, error)
- func (m *MemoryManager) CountClients(ctx context.Context) (n int, err error)
- func (m *MemoryManager) CreateClient(ctx context.Context, c *Client) error
- func (m *MemoryManager) DeleteClient(ctx context.Context, id string) error
- func (m *MemoryManager) GetClient(ctx context.Context, id string) (fosite.Client, error)
- func (m *MemoryManager) GetClients(ctx context.Context, limit, offset int) (clients []Client, err error)
- func (m *MemoryManager) GetConcreteClient(ctx context.Context, id string) (*Client, error)
- func (m *MemoryManager) UpdateClient(ctx context.Context, c *Client) error
- type Registry
- type SQLManager
- func (m *SQLManager) Authenticate(ctx context.Context, id string, secret []byte) (*Client, error)
- func (m *SQLManager) CountClients(ctx context.Context) (int, error)
- func (m *SQLManager) CreateClient(ctx context.Context, c *Client) error
- func (m *SQLManager) CreateSchemas(dbName string) (int, error)
- func (m *SQLManager) DeleteClient(ctx context.Context, id string) error
- func (m *SQLManager) GetClient(ctx context.Context, id string) (fosite.Client, error)
- func (m *SQLManager) GetClients(ctx context.Context, limit, offset int) (clients []Client, err error)
- func (m *SQLManager) GetConcreteClient(ctx context.Context, id string) (*Client, error)
- func (m *SQLManager) PlanMigration(dbName string) ([]*migrate.PlannedMigration, error)
- func (m *SQLManager) UpdateClient(ctx context.Context, c *Client) error
- type Storage
- type Validator
Constants ¶
const (
ClientsHandlerPath = "/clients"
)
Variables ¶
var Migrations = map[string]*dbal.PackrMigrationSource{ dbal.DriverMySQL: dbal.NewMustPackerMigrationSource(logrus.New(), AssetNames(), Asset, []string{"migrations/sql/shared", "migrations/sql/mysql"}, true), dbal.DriverPostgreSQL: dbal.NewMustPackerMigrationSource(logrus.New(), AssetNames(), Asset, []string{"migrations/sql/shared", "migrations/sql/postgres"}, true), dbal.DriverCockroachDB: dbal.NewMustPackerMigrationSource(logrus.New(), AssetNames(), Asset, []string{"migrations/sql/cockroach"}, true), }
Functions ¶
func Asset ¶
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDir ¶
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/ foo.txt img/ a.png b.png
then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.
func AssetInfo ¶
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func MustAsset ¶
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.
func RestoreAsset ¶
RestoreAsset restores an asset under the given directory
func RestoreAssets ¶
RestoreAssets restores an asset under the given directory recursively
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|authorization_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"` // Audience is a whitelist defining the audiences this client is allowed to request tokens for. An audience limits // the applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list // of URLs. URLs MUST NOT contain whitespaces. Audience []string `json:"audience"` // 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. // // This feature is currently not supported and it's value will always // be set to 0. 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"` // CreatedAt returns the timestamp of the client's creation. CreatedAt time.Time `json:"created_at,omitempty"` // UpdatedAt returns the timestamp of the last update. UpdatedAt time.Time `json:"updated_at,omitempty"` // RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query // parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the // request and to determine which of the potentially multiple sessions is to be logged out; if either is // included, both MUST be. FrontChannelLogoutURI string `json:"frontchannel_logout_uri,omitempty"` // Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be // included to identify the RP session with the OP when the frontchannel_logout_uri is used. // If omitted, the default value is false. FrontChannelLogoutSessionRequired bool `json:"frontchannel_logout_session_required,omitempty"` // Array of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the // post_logout_redirect_uri parameter after a logout has been performed. PostLogoutRedirectURIs []string `json:"post_logout_redirect_uris,omitempty"` // RP URL that will cause the RP to log itself out when sent a Logout Token by the OP. BackChannelLogoutURI string `json:"backchannel_logout_uri,omitempty"` // Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout // Token to identify the RP session with the OP when the backchannel_logout_uri is used. // If omitted, the default value is false. BackChannelLogoutSessionRequired bool `json:"backchannel_logout_session_required,omitempty"` // Metadata is arbitrary data. Metadata json.RawMessage `json:"metadata,omitempty"` }
Client represents an OAuth 2.0 Client.
swagger:model oAuth2Client
func (*Client) GetAudience ¶
func (*Client) GetGrantTypes ¶
func (*Client) GetHashedSecret ¶
func (*Client) GetJSONWebKeys ¶
func (c *Client) GetJSONWebKeys() *jose.JSONWebKeySet
func (*Client) GetJSONWebKeysURI ¶
func (*Client) GetRedirectURIs ¶
func (*Client) GetRequestObjectSigningAlgorithm ¶
func (*Client) GetRequestURIs ¶
func (*Client) GetResponseTypes ¶
func (*Client) GetTokenEndpointAuthMethod ¶
func (*Client) GetTokenEndpointAuthSigningAlgorithm ¶
type Configuration ¶
type Configuration interface { configuration.Provider }
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
func NewHandler ¶
func NewHandler(r InternalRegistry) *Handler
func (*Handler) Create ¶
func (h *Handler) Create(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
swagger:route POST /clients admin 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: 201: oAuth2Client 400: genericError 409: genericError 500: genericError
func (*Handler) Delete ¶
func (h *Handler) Delete(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
swagger:route DELETE /clients/{id} admin 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 404: genericError 500: genericError
func (*Handler) Get ¶
func (h *Handler) Get(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
swagger:route GET /clients/{id} admin 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 404: genericError 500: genericError
func (*Handler) List ¶
func (h *Handler) List(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
swagger:route GET /clients admin 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. The "Link" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?limit={limit}&offset={offset}>; rel="{page}"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.
Consumes: - application/json Produces: - application/json Schemes: http, https Responses: 200: oAuth2ClientList 500: genericError
func (*Handler) SetRoutes ¶
func (h *Handler) SetRoutes(admin *x.RouterAdmin)
func (*Handler) Update ¶
func (h *Handler) Update(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
swagger:route PUT /clients/{id} admin 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 500: genericError
type InternalRegistry ¶
type InternalRegistry interface { x.RegistryWriter Registry }
type MemoryManager ¶
type MemoryManager struct { Clients []Client sync.RWMutex // contains filtered or unexported fields }
func NewMemoryManager ¶
func NewMemoryManager(r InternalRegistry) *MemoryManager
func (*MemoryManager) Authenticate ¶
func (*MemoryManager) CountClients ¶
func (m *MemoryManager) CountClients(ctx context.Context) (n int, err error)
func (*MemoryManager) CreateClient ¶
func (m *MemoryManager) CreateClient(ctx context.Context, c *Client) error
func (*MemoryManager) DeleteClient ¶
func (m *MemoryManager) DeleteClient(ctx context.Context, id string) error
func (*MemoryManager) GetClients ¶
func (*MemoryManager) GetConcreteClient ¶
func (*MemoryManager) UpdateClient ¶
func (m *MemoryManager) UpdateClient(ctx context.Context, c *Client) error
type SQLManager ¶
func NewSQLManager ¶
func NewSQLManager(db *sqlx.DB, r InternalRegistry) *SQLManager
func (*SQLManager) Authenticate ¶
func (*SQLManager) CountClients ¶
func (m *SQLManager) CountClients(ctx context.Context) (int, error)
func (*SQLManager) CreateClient ¶
func (m *SQLManager) CreateClient(ctx context.Context, c *Client) error
func (*SQLManager) CreateSchemas ¶
func (m *SQLManager) CreateSchemas(dbName string) (int, error)
func (*SQLManager) DeleteClient ¶
func (m *SQLManager) DeleteClient(ctx context.Context, id string) error
func (*SQLManager) GetClients ¶
func (*SQLManager) GetConcreteClient ¶
func (*SQLManager) PlanMigration ¶
func (m *SQLManager) PlanMigration(dbName string) ([]*migrate.PlannedMigration, error)
func (*SQLManager) UpdateClient ¶
func (m *SQLManager) UpdateClient(ctx context.Context, c *Client) error
type Storage ¶
type Storage interface { fosite.Storage CreateClient(ctx context.Context, c *Client) error UpdateClient(ctx context.Context, c *Client) error DeleteClient(ctx context.Context, id string) error GetClients(ctx context.Context, limit, offset int) ([]Client, error) CountClients(ctx context.Context) (int, error) GetConcreteClient(ctx context.Context, id string) (*Client, error) }
type Validator ¶
type Validator struct {
// contains filtered or unexported fields
}
func NewValidator ¶
func NewValidator(conf Configuration) *Validator
func NewValidatorWithClient ¶
func NewValidatorWithClient(conf Configuration, client *http.Client) *Validator