structs

type ACLGroup struct {
	ID          *uint  `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	CreatedAt   int64  `json:"created_at,omitempty"`
	UpdateAt    int64  `json:"updated_at,omitempty"`
}

type ACLGroupResource struct {
	Group     ACLGroup      `json:"group,omitempty"`
	Resources []ACLResource `json:"resources,omitempty"`
}

type ACLGroups struct {
	Groups []ACLGroup `json:"groups,omitempty"`
}

type ACLResource struct {
	ID      uint   `json:"id,omitempty"`
	Service string `json:"service,omitempty"`
	Path    string `json:"path,omitempty"`
	Method  string `json:"method,moitempty"`
}

type ACLResourceRequest struct {
	GroupID   uint   `json:"group_id,omitempty"`
	Resources []uint `json:"resources,omitempty"`
}

type ACLResponse struct {
	Access     string `json:"access,omitempty"`
	Identifier string `json:"identifier,omitempty"`
	Roles      string `json:"roles,omitempty"`
	ChannelId  string `json:"channel_id,omitempty"`
}

type AccessKeyValue struct {
	ApiKey     string `json:"api_key,omitempty"`
	Identifier string `json:"identifier,omitempty"`
}

type AccesskeyRequest struct {
	Accesskey AccesskeyRequestInner `json:"accesskey,omitempty"`
}

type AccesskeyRequestInner struct {
	Description string `json:"description,omitempty"`
	Identifier  string `json:"identifier,omitempty"`
}

type AccesskeyResponse struct {
	Accesskey AccesskeyResponseInner `json:"accesskey,omitempty"`
}

type AccesskeyResponseInner struct {
	Id          string         `json:"id,omitempty"`
	Description string         `json:"description,omitempty"`
	Issued_at   int64          `json:"issued_at,omitempty"`
	Value       AccessKeyValue `json:"value,omitempty"`
}

type Cert struct {
	Key    string `json:"key,omitempty"`
	Cert   string `json:"cert,omitempty"`
	CACert string `json:"ca_cert,omitempty"`
}

type CertCreateReq struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	ApiKey      string `json:"api_key,omitempty"`
}

type CertCreateReqBody struct {
	Certificate CertCreateReq `json:"certificate,omitempty"`
}

type CertCreateResp struct {
	ID          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	ApiKey      string `json:"api_key,omitempty"`
	IssuedAt    int64  `json:"issued_at,omitempty"`
	Hash        string `json:"hash,omitempty"`
	Status      string `json:"status,omitempty"`
	Value       *Cert  `json:"value,omitempty"`
}

type CertCreateRespBody struct {
	Certificate *CertCreateResp `json:"certificate,omitempty"`
}

type CertInfo struct {
	ID          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	ApiKey      string `json:"api_key,omitempty"`
	IssuedAt    int64  `json:"issued_at,omitempty"`
	Hash        string `json:"hash,omitempty"`
	Status      string `json:"status,omitempty"`
}

type CertListRespBody struct {
	Certificates []*CertInfo `json:"certificates,omitempty"`
}

type ChannelIDAccess struct {
	ChannelID string `json:"channel_id,omitempty"`
	//Access     string `json:"access,omitempty"`
	Identifier string `json:"identifier,omitempty"`
}

type CredentialsListResponse struct {
	Credentials []UserInfo `json:"credentials,omitempty"`
}

type CredentialsStruct struct {
	Id          string      `json:"id,omitempty"`
	Role        string      `json:"role,omitempty"`
	Description string      `json:"description,omitempty"`
	Channel_id  string      `json:"channel_id,omitempty"`
	Issued_at   int64       `json:"issued_at,omitempty"`
	Value       ValueStruct `json:"value,omitempty"`
}

type DAppListResp struct {
	ID               int64  `json:"id,omitempty" gorm:"primary_key;AUTO_INCREMENT"`
	Name             string `json:"name.omitempty" gorm:"type:varchar(32)"`
	ApiKey           string `json:"api_key,omitempty" gorm:"type:varchar(128)"`
	Identifier       string `json:"identifier,omitempty" gorm:"type:varchar(128);"`
	ParentIdentifier string `json:"parent_identifier,omitempty" gorm:"type:varchar(128)"`
	Type             int    `json:"type,omitempty"` //包括去中心化交易所，游戏，其他等
	Description      string `json:"description,omitempty" gorm:"type:varchar(128)"`
	IconFile         []byte `json:"icon_file" gorm:"type:bytea"`
	IconName         string `json:"icon_name" gorm:"type:varchar(32)"`
	IssuedAt         int64  `json:"issued_at,omitempty"`
}

type DAppUpdateRequest struct {
	Identifier  string `json:"identifier,omitempty"`
	Name        string `json:"name,omitepmty"`
	Type        int    `json:"type,omitempty"`
	Description string `json:"description,omitempty"`
	IconFile    []byte `json:"icon,omitempty"`
	IconName    string `json:"icon_name" gorm:"type:varchar(32)"`
}

type DappInfoResponse struct {
	Identifier         string `json:"id,omitempty"`
	Access             string `json:"access,omitempty"`
	Email              string `json:"email,omitempty"`
	Phone              string `json:"phone,omitempty"`
	GroupID            uint   `json:"group_id,omitempty"`
	UserType           uint   `json:"user_type,omitempty"`
	ChannelID          string `json:"channel_id,omitempty"`
	Description        string `json:"description,omitempty"`
	VerificationStatus string `json:"verification_status"`
	MetaData           string `json:"meta_data,omitempty"`
}

type DappUsersNumResponse struct {
	DappUsersNum int `json:"dapp_users_num,omitempty"`
}

type EnterpriseInfo struct {
	CompanyName            string `json:"company_name,omitempty"`
	CompanyAddr            string `json:"company_address,omitempty"`
	TaxCode                string `json:"tax_code,omitempty"`
	JuridicalPersonName    string `json:"juridical_person_name,omitempty"`
	JuridicalPersonTel     string `json:"juridical_person_tel,omitempty"`
	JuridicalPersonID      string `json:"juridical_person_id,omitempty"`
	Licence                string `json:"licence,omitempty"`
	LicenceFileName        string `json:"licence_file_name,omitempty"`
	LicenceNumber          string `json:"licence_number,omitempty"`
	IdentityTop            string `json:"identity_top,omitempty"`
	IdentityTopFileName    string `json:"identity_top_file_type,omitempty"`
	IdentityBottom         string `json:"identity_bottom,omitempty"`
	IdentityBottomFileName string `json:"identity_bottom_file_type,omitempty"`
}

type GetCertStatusResp struct {
	Certificate GetCertStatusRespInner `json:"certificate,omitempty"`
}

type GetCertStatusRespInner struct {
	Isued_at int64 `json:"issued_at,omitempty"`
}

type GetTokenResponse struct {
	Token TokenDetail `json:"token,omitempty"`
}

type IACLClient interface {
	// create acl group
	CreateACLGroup(*ACLGroup, http.Header) (*ACLGroup, error)
	// update acl group
	UpdateACLGroup(*ACLGroup, http.Header) (*ACLGroup, error)
	// delete acl group
	DeleteACLGroup(*ACLGroups, http.Header) (*ACLGroups, error)
	// get acl groups
	GetACLGroups(uint, uint, http.Header) (*ACLGroups, error)
	// get acl group
	GetACLGroup(uint, http.Header) (*ACLGroupResource, error)
	// add acl resource
	AddACLResource(*ACLResourceRequest, http.Header) (*ACLGroup, error)
	// remove acl resource
	RemoveACLResource(*ACLResourceRequest, http.Header) (*ACLGroup, error)
	// get user acl group
	GetUserACLGroup(uint, http.Header) (*ACLGroup, error)
	// update user acl group
	UpdateUserACLGroup(*UpdateUserGroupRequest, http.Header) (*UpdateUserGroupRequest, error)
}

type ICertsClient interface {
	// create cert
	CreateCerts(*CertCreateReqBody, http.Header) (*CertCreateRespBody, error)
	// disable cert
	DisableCerts(*CertCreateReqBody, http.Header) (*CertCreateRespBody, error)
	// recover cert
	RecoverCerts(*CertCreateReqBody, http.Header) (*CertCreateRespBody, error)
	// delete cert
	DeleteCerts(*CertCreateReqBody, http.Header) (*CertCreateRespBody, error)
	// get cert status
	StatusCerts(string, http.Header) (*GetCertStatusResp, error)
	// retrieve cert
	RetrieveCerts(string, string, http.Header) ([]byte, error)
}

type IEdkeyClient interface {
	// generate key
	Generate(string, http.Header) ([]byte, []byte, error)
	// download key
	Download(string, string, string, http.Header) error
}

type IFredClient interface {
	GetUserClient() IUserClient
	GetEdkeyClient() IEdkeyClient
	GetCertsClient() ICertsClient
	GetACLClient() IACLClient
	GetSubwalletClient() ISubwalletClient
}

type IOauth2Client interface {
	// validate oauth2 token
	ValidateOauth2Token(*Oauth2AccessToken) (bool, error)
}

type ISubwalletClient interface {
	RegisterSubwallet(*SubwalletRegisterRequest, http.Header) error
	UpdateDApp(*DAppUpdateRequest, http.Header) error
	DAppList(identifier, page, num string, header http.Header) (*DAppListResp, error)
	DAppinfo(identifier string, header http.Header) (*DAppListResp, error)
}

type IUserClient interface {
	// register new user
	RegisterUser(*RegisterRequest, http.Header) (*ResponseStruct, error)
	// revoke user
	Revoke(*RevokeRequest, http.Header) error
	// login
	Login(*LoginRequest) (*GetTokenResponse, error)
	// get user info with api key
	GetUserInfoWithAPIKey(string, http.Header) (*UserInfo, error)
	// get user info with DID
	GetUserInfoWithDID(string, http.Header) (*UserInfo, error)
	// reset user password
	ResetUserPassword(*UpdatePasswordRequest, http.Header) error
	// update user password
	UpdateUserPassword(*UpdatePasswordRequest, http.Header) error
	// revoke token
	RevokeToken(http.Header) error
	// validate token
	ValidateToken(http.Header) (*TokenInfo, error)
	// get version
	Version() (*reststructs.VersionResponse, error)
	// update channel id
	UpdateChannelID(*UpdateChannelIDRequest, http.Header) error
	// get accesskey
	Accesskey(*AccesskeyRequest, http.Header) (*AccesskeyResponse, error)
	// validate acl
	ACLVerification(http.Header) (*ACLResponse, error)
	// update identity status
	UpdateIdentityStatus(UserInfo, http.Header) error
	// query identity status
	QueryIdentityStatus(string, http.Header) (*UserInfo, error)
	// upload identity file
	UploadIdentity(string, string, http.Header) error
	// query usertype users count. userType 1: Enterprise 2: Persional 0: Enterprise+Persional
	QueryUsersCount(int, http.Header) (*UsersNumResponse, error)
	// query dapp users count creted by did
	QueryDappUsersCount(string, http.Header) (*DappUsersNumResponse, error)
	// query userType users list
	QueryUsersList(userType, page, num int, head http.Header) ([]DappInfoResponse, error)
	// query dapp users list created by did
	QueryDappUsersList(did string, page, num int, head http.Header) ([]DappInfoResponse, error)
	// query the last num days or months(depend on querytype) users growth
	QueryUsersGrowth(queryType, num int, head http.Header) ([]UsersGrowthResponse, error)
}

type LoginAccess struct {
	Value LoginAccessSecret
}

type LoginAccessSecret struct {
	Access string `json:"access,omitempty"`
	Phone  string `json:"phone,omitempty"`
	Email  string `json:"email,omitempty"`
	Secret string `json:"secret,omitempty"`
}

type LoginRequest struct {
	Credential LoginAccess `json:"credential,omitempty"`
}

type Oauth2AccessToken struct {
	AccessToken string `json:"access_token,omitempty"`
}

type RegisterBody struct {
	Role        string `json:"role,omitempty"`
	Description string `json:"description,omitempty"`
	ChannelId   string `json:"channel_id,omitempty"`
	Value       User   `json:"value,omitempty"`
}

type RegisterRequest struct {
	Credential RegisterBody `json:"credential,omitempty"`
}

type ResponseStruct struct {
	Credentials CredentialsStruct `json:"credentials,omitempty"`
}

type RevokeRequest struct {
	Credential *User `json:"credential,omitempty"`
}

type SubwalletRegisterRequest struct {
	Identifier      string `json:"identifier,omitempty"`
	ParentIdentifer string `json:"parent_identifier,omitempty"`
	SubwalletType   int32  `json:"subwallet_type,omitempty"`
}

type TokenCreateRequest struct {
	// The name of the token role
	Role string `json:"role,omitempty"`
	// A list of policies for the token
	Policies []string `json:"policies,omitempty"`
	NoParent bool     `json:"no_parent,omitempty"`
	//  A map of string to string valued metadata. This is passed through to the audit backends
	MetaData map[string]string `json:"meta_data,omitempty"`
	// If set, the token will have an explicit max TTL set upon it. This maximum token TTL cannot be changed later,
	// and unlike with normal tokens, updates to the system/mount max TTL value will have no effect at renewal time
	// the token will never be able to be renewed or used past the value set at issue time
	MaxTTL string `json:"max_ttl,omitempty"`
	// Set to false to disable the ability of the token to be renewed past its initial TTL.
	// Setting the value to true will allow the token to be renewable up to the system/mount maximum TTL
	Renewable *bool `json:"renewable,omitempty"`
	// The TTL period of the token, provided as "1h", where hour is the largest suffix.
	// If not provided, the token is valid for the default lease TTL, or indefinitely if the root policy is used
	TTL string `json:"ttl,omitempty"`
	// The maximum uses for the given token. This can be used to create a one-time-token or limited use token.
	// The value of 0 has no limit to the number of uses
	NumUsers int `json:"num_users,omitempty"`
}

type TokenDetail struct {
	IssuedAt     int64  `json:"issue_at,omitempty"`
	ExpiresAt    int64  `json:"expires_at,omitempty"`
	Value        string `json:"value,omitempty"`
	CredentialId string `json:"credential_id,omitempty"`
	Roles        string `json:"roles,omitempty"`
	Identifier   string `json:"identifier,omitempty"`
	GroupID      uint   `json:"group_id,omitempty"`
	ChannelId    string `json:"channel_id,omitempty"`
}

type TokenInfo struct {
	CredentialId string `json:"credential_id,omitempty"`
	Access       string `json:"access,omitempty"`
	Phone        string `json:"phone,omitempty"`
	Email        string `json:"email,omitempty"`
	Roles        string `json:"roles,omitempty"`
	Identifier   string `json:"identifier,omitempty"`
	GroupID      uint   `json:"group_id,omitempty"`
	ChannelID    string `json:"channel_id,omitempty"`
}

type UpdateChannelIDRequest struct {
	Credential *ChannelIDAccess `json:"credential,omitempty"`
}

type UpdatePasswordBody struct {
	OriginalSecret string `json:"original_secret,omitempty"`
	Identifier     string `json:"identifier,omitempty"`
	NewSecret      string `json:"new_secret,omitempty"`
	Access         string `json:"access,omitempty"`
	Email          string `json:"email,omitempty"`
	Phone          string `json:"phone,omitempty"`
}

type UpdatePasswordRequest struct {
	Credential *UpdatePasswordBody `json:"credential,omitempty"`
}

type UpdateUserGroupRequest struct {
	Users []UserInfo `json:"users,omitempty"`
}

type User struct {
	Access     string      `json:"access,omitempty"` // username
	Phone      string      `json:"phone,omitempty"`
	Email      string      `json:"email,omitempty"`
	Secret     string      `json:"secret,omitempty"` // password
	Identifier string      `json:"identifier,omitempty"`
	UserType   uint        `json:"user_type,omitempty"`
	Metadata   interface{} `json:"meta_data,omitempty"`
}

type UserInfo struct {
	Id                 string          `json:"id,omitempty"`
	GroupID            string          `json:"group_id,omitempty"`
	Access             string          `json:"access,omitempty"`
	Phone              string          `json:"phone,omitempty"`
	Email              string          `json:"email,omitempty"`
	Identifier         string          `json:"identifier,omitempty"`
	Status             string          `json:"status,omitempty"`
	Roles              string          `json:"roles,omitempty"`
	VerificationStatus uint            `json:"verification_status,omitempty"`
	Remark             string          `json:"remark,omitempty"`
	UserType           uint            `json:"user_type,omitempty"`
	EnterpriseInfo     *EnterpriseInfo `json:"enterprise_info,omitempty"`
	Issued_at          int64           `json:"issued_at,omitempty"`
	Channel_id         string          `json:"channel_id,omitempty"`
	CreatedAt          int64           `json:"created_at,omitempty"`
	UpdateAt           int64           `json:"update_at,omitempty"`
}

type UsersGrowthResponse struct {
	DateTime string `json:"datetime,omitempty"`
	// the num of new users created during datetime
	GrowthAmount int `json:"growth_amount,omitempty"`
}

type UsersNumResponse struct {
	UsersNum int `json:"users_num,omitempty"`
}

type ValueStruct struct {
	Access     string `json:"access,omitempty"`
	Identifier string `json:"identifier,omitempty"`
}