kms

Documentation

Index

• Constants
• type CancelKeyDeletionArgs
• type CancelKeyDeletionResponse
• type Client
  • func NewClient(accessKeyId, accessKeySecret string) *Client
  • func NewClientWithEndpoint(endpoint string, accessKeyId string, accessKeySecret string) *Client
  • func NewClientWithRegion(accessKeyId string, accessKeySecret string, regionID common.Region) *Client
  • func NewECSClientWithSecurityToken(accessKeyId string, accessKeySecret string, securityToken string, ...) *Client
  • func NewKMSClientWithEndpointAndSecurityToken(endpoint string, accessKeyId string, accessKeySecret string, ...) *Client
  • func (client *Client) CancelKeyDeletion(keyId string) (*CancelKeyDeletionResponse, error)
  • func (client *Client) CreateKey(args *CreateKeyArgs) (*CreateKeyResponse, error)
  • func (client *Client) Decrypt(args *DecryptArgs) (*DecryptResponse, error)
  • func (client *Client) DescribeKey(keyId string) (*DescribeKeyResponse, error)
  • func (client *Client) DescribeRegions() (*DescribeRegionsResponse, error)
  • func (client *Client) DisableKey(keyId string) (*DisableKeyResponse, error)
  • func (client *Client) EnableKey(keyId string) (*EnableKeyResponse, error)
  • func (client *Client) Encrypt(args *EncryptAgrs) (*EncryptResponse, error)
  • func (client *Client) GenerateDataKey(args *GenerateDataKeyArgs) (*GenerateDataKeyResponse, error)
  • func (client *Client) ListKeys(args *ListKeysArgs) (*ListKeysResponse, error)
  • func (client *Client) ScheduleKeyDeletion(args *ScheduleKeyDeletionArgs) (*ScheduleKeyDeletionResponse, error)
• type CreateKeyArgs
• type CreateKeyResponse
• type DecryptArgs
• type DecryptResponse
• type DescribeKeyArgs
• type DescribeKeyResponse
• type DescribeRegionsArgs
• type DescribeRegionsResponse
• type DisableKeyArgs
• type DisableKeyResponse
• type EnableKeyArgs
• type EnableKeyResponse
• type EncryptAgrs
• type EncryptResponse
• type GenerateDataKeyArgs
• type GenerateDataKeyResponse
• type Key
• type KeyMetadata
• type KeySpec
• type KeyUsage
• type Keys
• type ListKeysArgs
• type ListKeysResponse
• type Region
• type Regions
• type ScheduleKeyDeletionArgs
• type ScheduleKeyDeletionResponse

Constants

const (
	// KMSDefaultEndpoint is the default API endpoint of KMS services
	KMSDefaultEndpoint = "https://kms.cn-hangzhou.aliyuncs.com"
	KMSAPIVersion      = "2016-01-20"
	KMSServiceCode     = "kms"
)

const (
	KeySpec_AES_256 = KeySpec("AES_256")
	KeySpec_AES_128 = KeySpec("AES_128")
)

const (
	KEY_USAGE_ENCRYPT_DECRYPT = KeyUsage("ENCRYPT/DECRYPT")
)

Types

type CancelKeyDeletionArgs

type CancelKeyDeletionArgs struct {
	KeyId string
}

https://help.aliyun.com/document_detail/44197.html?spm=5176.doc54560.6.562.p7NkZB

type CancelKeyDeletionResponse

type CancelKeyDeletionResponse struct {
	common.Response
}

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(accessKeyId, accessKeySecret string) *Client

NewClient creates a new instance of KMS client

func NewClientWithEndpoint

func NewClientWithEndpoint(endpoint string, accessKeyId string, accessKeySecret string) *Client

func NewClientWithRegion

func NewClientWithRegion(accessKeyId string, accessKeySecret string, regionID common.Region) *Client

func NewECSClientWithSecurityToken

func NewECSClientWithSecurityToken(accessKeyId string, accessKeySecret string, securityToken string, regionID common.Region) *Client

func NewKMSClientWithEndpointAndSecurityToken

func NewKMSClientWithEndpointAndSecurityToken(endpoint string, accessKeyId string, accessKeySecret string, securityToken string, regionID common.Region) *Client

func (*Client) CancelKeyDeletion

func (client *Client) CancelKeyDeletion(keyId string) (*CancelKeyDeletionResponse, error)

func (*Client) CreateKey

func (client *Client) CreateKey(args *CreateKeyArgs) (*CreateKeyResponse, error)

func (*Client) Decrypt

func (client *Client) Decrypt(args *DecryptArgs) (*DecryptResponse, error)

func (*Client) DescribeKey

func (client *Client) DescribeKey(keyId string) (*DescribeKeyResponse, error)

func (*Client) DescribeRegions

func (client *Client) DescribeRegions() (*DescribeRegionsResponse, error)

func (*Client) DisableKey

func (client *Client) DisableKey(keyId string) (*DisableKeyResponse, error)

func (*Client) EnableKey

func (client *Client) EnableKey(keyId string) (*EnableKeyResponse, error)

func (*Client) Encrypt

func (client *Client) Encrypt(args *EncryptAgrs) (*EncryptResponse, error)

func (*Client) GenerateDataKey

func (client *Client) GenerateDataKey(args *GenerateDataKeyArgs) (*GenerateDataKeyResponse, error)

func (*Client) ListKeys

func (client *Client) ListKeys(args *ListKeysArgs) (*ListKeysResponse, error)

func (*Client) ScheduleKeyDeletion

func (client *Client) ScheduleKeyDeletion(args *ScheduleKeyDeletionArgs) (*ScheduleKeyDeletionResponse, error)

type CreateKeyArgs

type CreateKeyArgs struct {
	KeyUsage    KeyUsage
	Description string
}

type CreateKeyResponse

type CreateKeyResponse struct {
	common.Response
	KeyMetadata KeyMetadata
}

type DecryptArgs

type DecryptArgs struct {
	CiphertextBlob    string
	EncryptionContext map[string]string
}

https://help.aliyun.com/document_detail/28950.html?spm=5176.doc28947.6.564.JrFZRr

type DecryptResponse

type DecryptResponse struct {
	common.Response
	Plaintext string
	KeyId     string
}

type DescribeKeyArgs

type DescribeKeyArgs struct {
	KeyId string
}

https://help.aliyun.com/document_detail/28952.html?spm=5176.doc28950.6.565.66jjUg

type DescribeKeyResponse

type DescribeKeyResponse struct {
	common.Response
	KeyMetadata KeyMetadata
}

type DescribeRegionsArgs

type DescribeRegionsArgs struct {
}

type DescribeRegionsResponse

type DescribeRegionsResponse struct {
	common.Response
	Regions Regions
}

type DisableKeyArgs

type DisableKeyArgs struct {
	KeyId string
}

https://help.aliyun.com/document_detail/35151.html?spm=5176.doc28952.6.567.v0ZOgK

type DisableKeyResponse

type DisableKeyResponse struct {
	common.Response
}

type EnableKeyArgs

type EnableKeyArgs struct {
	KeyId string
}

https://help.aliyun.com/document_detail/35150.html?spm=5176.doc35151.6.568.angV44

type EnableKeyResponse

type EnableKeyResponse struct {
	common.Response
}

type EncryptAgrs

type EncryptAgrs struct {
	KeyId             string
	Plaintext         string
	EncryptionContext map[string]string
}

https://help.aliyun.com/document_detail/28949.html?spm=5176.doc28950.6.569.kI1mTw

type EncryptResponse

type EncryptResponse struct {
	common.Response
	CiphertextBlob string
	KeyId          string
}

type GenerateDataKeyArgs

type GenerateDataKeyArgs struct {
	KeyId             string
	KeySpec           KeySpec
	NumberOfBytes     int
	EncryptionContext map[string]string
}

type GenerateDataKeyResponse

type GenerateDataKeyResponse struct {
	common.Response
	CiphertextBlob string
	KeyId          string
	RequestId      string
}

type Key

type Key struct {
	KeyId  string
	KeyArn string
}

type KeyMetadata

type KeyMetadata struct {
	CreationDate string
	Description  string
	KeyId        string
	KeyState     string
	KeyUsage     string
	DeleteDate   string
	Creator      string
	Arn          string
}

type KeySpec

type KeySpec string

https://help.aliyun.com/document_detail/28948.html?spm=5176.doc28949.6.570.bFGCyz

type KeyUsage

type KeyUsage string

https://help.aliyun.com/document_detail/28947.html?spm=5176.doc44197.6.563.CRY6Nq

type Keys

type Keys struct {
	Key []Key
}

type ListKeysArgs

type ListKeysArgs struct {
	common.Pagination
}

https://help.aliyun.com/document_detail/28951.html?spm=5176.doc28948.6.571.PIpkFD

type ListKeysResponse

type ListKeysResponse struct {
	common.Response
	common.PaginationResult
	Keys Keys
}

type Region

type Region struct {
	RegionId string
}

type Regions

type Regions struct {
	Region []Region
}

type ScheduleKeyDeletionArgs

type ScheduleKeyDeletionArgs struct {
	KeyId               string
	PendingWindowInDays int
}

https://help.aliyun.com/document_detail/44196.html?spm=5176.doc28951.6.572.9Oqd9S

type ScheduleKeyDeletionResponse

type ScheduleKeyDeletionResponse struct {
	common.Response
}