peridot/vendor/github.com/ory/hydra-client-go/models/login_request.go

308 lines
7.9 KiB
Go
Raw Normal View History

2022-07-07 20:11:50 +00:00
// Code generated by go-swagger; DO NOT EDIT.
package models
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
"context"
"github.com/go-openapi/errors"
"github.com/go-openapi/strfmt"
"github.com/go-openapi/swag"
"github.com/go-openapi/validate"
)
// LoginRequest Contains information on an ongoing login request.
//
// swagger:model loginRequest
type LoginRequest struct {
// ID is the identifier ("login challenge") of the login request. It is used to
// identify the session.
// Required: true
Challenge *string `json:"challenge"`
// client
// Required: true
Client *OAuth2Client `json:"client"`
// oidc context
OidcContext *OpenIDConnectContext `json:"oidc_context,omitempty"`
// RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which
// initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but
// might come in handy if you want to deal with additional request parameters.
// Required: true
RequestURL *string `json:"request_url"`
// requested access token audience
// Required: true
RequestedAccessTokenAudience StringSlicePipeDelimiter `json:"requested_access_token_audience"`
// requested scope
// Required: true
RequestedScope StringSlicePipeDelimiter `json:"requested_scope"`
// SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)
// this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)
// this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back-
// channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
SessionID string `json:"session_id,omitempty"`
// Skip, if true, implies that the client has requested the same scopes from the same user previously.
// If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.
//
// This feature allows you to update / set session information.
// Required: true
Skip *bool `json:"skip"`
// Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope
// requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type
// when accepting the login request, or the request will fail.
// Required: true
Subject *string `json:"subject"`
}
// Validate validates this login request
func (m *LoginRequest) Validate(formats strfmt.Registry) error {
var res []error
if err := m.validateChallenge(formats); err != nil {
res = append(res, err)
}
if err := m.validateClient(formats); err != nil {
res = append(res, err)
}
if err := m.validateOidcContext(formats); err != nil {
res = append(res, err)
}
if err := m.validateRequestURL(formats); err != nil {
res = append(res, err)
}
if err := m.validateRequestedAccessTokenAudience(formats); err != nil {
res = append(res, err)
}
if err := m.validateRequestedScope(formats); err != nil {
res = append(res, err)
}
if err := m.validateSkip(formats); err != nil {
res = append(res, err)
}
if err := m.validateSubject(formats); err != nil {
res = append(res, err)
}
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}
func (m *LoginRequest) validateChallenge(formats strfmt.Registry) error {
if err := validate.Required("challenge", "body", m.Challenge); err != nil {
return err
}
return nil
}
func (m *LoginRequest) validateClient(formats strfmt.Registry) error {
if err := validate.Required("client", "body", m.Client); err != nil {
return err
}
if m.Client != nil {
if err := m.Client.Validate(formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("client")
}
return err
}
}
return nil
}
func (m *LoginRequest) validateOidcContext(formats strfmt.Registry) error {
if swag.IsZero(m.OidcContext) { // not required
return nil
}
if m.OidcContext != nil {
if err := m.OidcContext.Validate(formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("oidc_context")
}
return err
}
}
return nil
}
func (m *LoginRequest) validateRequestURL(formats strfmt.Registry) error {
if err := validate.Required("request_url", "body", m.RequestURL); err != nil {
return err
}
return nil
}
func (m *LoginRequest) validateRequestedAccessTokenAudience(formats strfmt.Registry) error {
if err := validate.Required("requested_access_token_audience", "body", m.RequestedAccessTokenAudience); err != nil {
return err
}
if err := m.RequestedAccessTokenAudience.Validate(formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("requested_access_token_audience")
}
return err
}
return nil
}
func (m *LoginRequest) validateRequestedScope(formats strfmt.Registry) error {
if err := validate.Required("requested_scope", "body", m.RequestedScope); err != nil {
return err
}
if err := m.RequestedScope.Validate(formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("requested_scope")
}
return err
}
return nil
}
func (m *LoginRequest) validateSkip(formats strfmt.Registry) error {
if err := validate.Required("skip", "body", m.Skip); err != nil {
return err
}
return nil
}
func (m *LoginRequest) validateSubject(formats strfmt.Registry) error {
if err := validate.Required("subject", "body", m.Subject); err != nil {
return err
}
return nil
}
// ContextValidate validate this login request based on the context it is used
func (m *LoginRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
var res []error
if err := m.contextValidateClient(ctx, formats); err != nil {
res = append(res, err)
}
if err := m.contextValidateOidcContext(ctx, formats); err != nil {
res = append(res, err)
}
if err := m.contextValidateRequestedAccessTokenAudience(ctx, formats); err != nil {
res = append(res, err)
}
if err := m.contextValidateRequestedScope(ctx, formats); err != nil {
res = append(res, err)
}
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}
func (m *LoginRequest) contextValidateClient(ctx context.Context, formats strfmt.Registry) error {
if m.Client != nil {
if err := m.Client.ContextValidate(ctx, formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("client")
}
return err
}
}
return nil
}
func (m *LoginRequest) contextValidateOidcContext(ctx context.Context, formats strfmt.Registry) error {
if m.OidcContext != nil {
if err := m.OidcContext.ContextValidate(ctx, formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("oidc_context")
}
return err
}
}
return nil
}
func (m *LoginRequest) contextValidateRequestedAccessTokenAudience(ctx context.Context, formats strfmt.Registry) error {
if err := m.RequestedAccessTokenAudience.ContextValidate(ctx, formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("requested_access_token_audience")
}
return err
}
return nil
}
func (m *LoginRequest) contextValidateRequestedScope(ctx context.Context, formats strfmt.Registry) error {
if err := m.RequestedScope.ContextValidate(ctx, formats); err != nil {
if ve, ok := err.(*errors.Validation); ok {
return ve.ValidateName("requested_scope")
}
return err
}
return nil
}
// MarshalBinary interface implementation
func (m *LoginRequest) MarshalBinary() ([]byte, error) {
if m == nil {
return nil, nil
}
return swag.WriteJSON(m)
}
// UnmarshalBinary interface implementation
func (m *LoginRequest) UnmarshalBinary(b []byte) error {
var res LoginRequest
if err := swag.ReadJSON(b, &res); err != nil {
return err
}
*m = res
return nil
}