im

Documentation

Overview

Copyright 2020 The KubeSphere Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type IdentityManagementInterface
  • func NewOperator(ksClient kubesphere.Interface, factory informers.InformerFactory, ...) IdentityManagementInterface
• type LoginRecorder
  • func NewLoginRecorder(ksClient kubesphere.Interface) LoginRecorder
• type PasswordAuthenticator
  • func NewPasswordAuthenticator(ksClient kubesphere.Interface, userLister iamv1alpha2listers.UserLister, ...) PasswordAuthenticator
• type TokenManagementInterface
  • func NewTokenOperator(cache cache.Interface, options *authoptions.AuthenticationOptions) TokenManagementInterface

Variables

var (
	AuthRateLimitExceeded             = fmt.Errorf("auth rate limit exceeded")
	AuthFailedIncorrectPassword       = fmt.Errorf("incorrect password")
	AuthFailedAccountIsNotActive      = fmt.Errorf("account is not active")
	AuthFailedIdentityMappingNotMatch = fmt.Errorf("identity mapping not match")
)

Types

type IdentityManagementInterface

type IdentityManagementInterface interface {
	CreateUser(user *iamv1alpha2.User) (*iamv1alpha2.User, error)
	ListUsers(query *query.Query) (*api.ListResult, error)
	DeleteUser(username string) error
	UpdateUser(user *iamv1alpha2.User) (*iamv1alpha2.User, error)
	DescribeUser(username string) (*iamv1alpha2.User, error)
	ModifyPassword(username string, password string) error
	ListLoginRecords(query *query.Query) (*api.ListResult, error)
	PasswordVerify(username string, password string) error
}

func NewOperator

func NewOperator(ksClient kubesphere.Interface, factory informers.InformerFactory, options *authoptions.AuthenticationOptions) IdentityManagementInterface

type LoginRecorder

type LoginRecorder interface {
	RecordLogin(username string, loginType iamv1alpha2.LoginType, provider string, authErr error, req *http.Request) error
}

func NewLoginRecorder

func NewLoginRecorder(ksClient kubesphere.Interface) LoginRecorder

type PasswordAuthenticator

type PasswordAuthenticator interface {
	Authenticate(username, password string) (authuser.Info, error)
}

func NewPasswordAuthenticator

func NewPasswordAuthenticator(ksClient kubesphere.Interface,
	userLister iamv1alpha2listers.UserLister,
	options *authoptions.AuthenticationOptions) PasswordAuthenticator

type TokenManagementInterface

type TokenManagementInterface interface {
	// Verify verifies a token, and return a User if it's a valid token, otherwise return error
	Verify(token string) (user.Info, error)
	// IssueTo issues a token a User, return error if issuing process failed
	IssueTo(user user.Info) (*oauth.Token, error)
}

func NewTokenOperator

func NewTokenOperator(cache cache.Interface, options *authoptions.AuthenticationOptions) TokenManagementInterface