service

type AuthorizeService interface {
	// NewId generates a unique identifier for a new authorization.
	NewId() string

	// Save persists an authorization object.
	Save(*model.Authorization)

	// Remove deletes an authorization object.
	Remove(*model.Authorization)

	// GetAuthorizationByCode retrieves an authorization object by its code.
	GetAuthorizationByCode(string) *model.Authorization

	// GetAuthorizationByAccessToken retrieves an authorization object by its access token.
	GetAuthorizationByAccessToken(string) *model.Authorization

	// GetAuthorizationByRefreshToken retrieves an authorization object by its refresh token.
	GetAuthorizationByRefreshToken(string) *model.Authorization

	// GetAuthorizeionByPassword retrieves an authorization object by password verification, may return an error.
	GetAuthorizeionByPassword(*request.PasswordRequest) (*model.Authorization, error)

	// GetAuthorizationByDeviceCode retrieves an authorization object by device code.
	GetAuthorizationByDeviceCode(device_code string) *model.Authorization

	// GetAuthorizationByUserCode retrieves an authorization object by user code.
	GetAuthorizationByUserCode(user_code string) *model.Authorization

	// CreateDeviceAuthorization creates a device code authorization.
	CreateDeviceAuthorization(clientId string, scope string, issuer string) *model.Authorization

	// CreateAuthorization creates a new authorization based on the provided authorization code request information.
	CreateAuthorization(request *request.AuthorizeRequest, principal string) *model.Authorization

	// GenerateUserCode generates a unique user code for device code authorization.
	GenerateUserCode() string

	// GenerateDeviceCode generates a unique device code for device code authorization.
	GenerateDeviceCode() string
}

type ClientService interface {
	// GetClient retrieves a client object by the client ID.
	// Parameters:
	//   clientId - The unique identifier of the client.
	// Returns:
	//   model.IClient - An object that implements the client interface.
	//   error - An error message if an error occurs.
	GetClient(clientId string) (model.IClient, error)

	// ValidateSecret verifies whether the client's secret is valid.
	// Parameters:
	//   clientId - The unique identifier of the client.
	//   secret - The client's secret.
	// Returns:
	//   bool - True if the secret is valid, otherwise false.
	ValidateSecret(clientId string, secret string) bool

	// ValidateClient checks if a client object is valid.
	// Parameters:
	//   client - The client object to validate.
	// Returns:
	//   error - An error message if the client object is invalid.
	ValidateClient(client model.IClient) error

	// SetClientRepository sets the client repository.
	// Parameters:
	//   clientRepository - The client repository interface.
	// This method is used for dependency injection to access the client data store when needed.
	SetClientRepository(clientRepository repo.ClientRepository)
	// ValidateLogoutUri validates the logout URI.
	//
	// clientId is the client identifier used to ensure the URI belongs to the correct client.
	// url is the logout URI to validate.
	//
	// The function returns an error if the URI is invalid or unsafe.
	ValidateLogoutUri(clientId string, url string) error
}

type ConsentService interface {
	// GetConsents retrieves all consents for a given client and principal.
	// Parameters:
	//   clientId - the unique identifier of the client application.
	//   principal - the identifier of the consent principal, usually the user ID.
	// Returns:
	//   A list of consents (scopes) agreed to by the principal for the client application.
	//   An error, if any occurs during the retrieval process.
	GetConsents(clientId string, principal string) ([]string, error)

	// SaveConsents saves new consents for a given client and principal.
	// Parameters:
	//   clientId - the unique identifier of the client application.
	//   principal - the identifier of the consent principal, usually the user ID.
	//   scopes - a list of scopes (consent items) to be saved.
	// Returns:
	//   An error, if any occurs during the saving process.
	SaveConsents(clientId string, principal string, scopes []string) error

	// RemoveConsents removes all consents for a given client and principal.
	// Parameters:
	//   clientId - the unique identifier of the client application.
	//   principal - the identifier of the consent principal, usually the user ID.
	// Returns:
	//   An error, if any occurs during the removal process.
	RemoveConsents(clientId string, principal string) error

	// RequireConsent checks if a given client and principal require consent for specific scopes.
	// Parameters:
	//   clientId - the unique identifier of the client application.
	//   principal - the identifier of the consent principal, usually the user ID.
	//   scopes - a list of scopes (consent items) to be checked.
	// Returns:
	//   true if the principal needs to provide consent for the specified scopes under the client application; otherwise, false.
	RequireConsent(clientId string, principal string, scopes []string) bool
}

type DefaultAuthorizeService struct {
	TokenService  TokenService
	UserService   UserService
	ClientService ClientService
	Config        *conf.Config
	// contains filtered or unexported fields
}

type DefaultClientService struct {
	ClientRepository repo.ClientRepository
}

type DefaultConsentService struct {
	Repo repo.ConsentRepository
}

type DefaultUserService struct {
	UserRepository repo.UserRepository
}

type SampleTokenService struct {
}

type TokenService interface {
	// GenerateToken generates an access token based on the authorization information.
	// Parameters:
	// - authorization: An object containing user authorization details.
	// Returns:
	// - string: The generated access token.
	// - error: If there is an error during token generation, returns the error.
	GenerateToken(authorization *model.Authorization) (string, error)

	// GenerateRefreshToken generates a refresh token based on the authorization information.
	// Parameters:
	// - authorization: An object containing user authorization details.
	// Returns:
	// - string: The generated refresh token.
	// - error: If there is an error during token generation, returns the error.
	GenerateRefreshToken(authorization *model.Authorization) (string, error)

	// GenerateIDToken generates an identity token based on the authorization information.
	// Parameters:
	// - authorization: An object containing user authorization details.
	// Returns:
	// - string: The generated identity token.
	// - error: If there is an error during token generation, returns the error.
	GenerateIDToken(authorization *model.Authorization) (string, error)
}

type UserService interface {
	// GetUser retrieves user information by user ID.
	// Parameters:
	//   userId: The user's ID.
	// Returns:
	//   IUser: User information interface.
	//   error: An error if the operation fails.
	GetUser(userId string) (model.IUser, error)

	// GetUserByName retrieves user information by username.
	// Parameters:
	//   userName: The username.
	// Returns:
	//   IUser: User information interface.
	//   error: An error if the operation fails.
	GetUserByName(userName string) (model.IUser, error)

	// VerifyPassword checks whether the provided username and password match.
	// Parameters:
	//   userName: The username.
	//   password: The password.
	// Returns:
	//   bool: True if the password matches, false otherwise.
	VerifyPassword(userName string, password string) bool
}