resources

Documentation

Index

• type BindIdentityToDeviceBody
• type CreateCABody
• type CreateDMSBody
• type CreateDeviceBody
• type FilterFieldType
• type FilterOperation
• type FilterOption
• type GetCAsResponse
• type GetCertificateStatus
• type GetCertificatesByExpirationDateQueryParams
• type GetCertsResponse
• type GetDMSsResponse
• type GetDevicesResponse
• type ImportCABody
• type ImportCertificateBody
• type IterableList
  • func (itr IterableList[E]) GetList() []E
  • func (itr IterableList[E]) GetNextBookmark() string
• type Iterator
• type ListInput
• type QueryParameters
• type SignCertificateBody
• type SignResponse
• type SignatureSignBody
• type SignatureVerifyBody
• type SortMode
  • func ParseSortMode(t string) SortMode
• type SortOptions
• type SubscribeBody
• type UpdateCAMetadataBody
• type UpdateCertificateMetadataBody
• type UpdateCertificateStatusBody
• type UpdateDeviceIdentitySlotBody
• type UpdateDeviceMetadataBody
• type VerifyResponse

Types

type BindIdentityToDeviceBody

type BindIdentityToDeviceBody struct {
	BindMode                models.DeviceEventType `json:"bind_mode"`
	DeviceID                string                 `json:"device_id"`
	CertificateSerialNumber string                 `json:"certificate_serial_number"`
}

type CreateCABody

type CreateCABody struct {
	ID                 string             `json:"id"`
	ParentID           string             `json:"parent_id"`
	Subject            models.Subject     `json:"subject"`
	KeyMetadata        models.KeyMetadata `json:"key_metadata"`
	CAExpiration       models.Expiration  `json:"ca_expiration"`
	IssuanceExpiration models.Expiration  `json:"issuance_expiration"`
	EngineID           string             `json:"engine_id"`
	Metadata           map[string]any     `json:"metadata"`
}

type CreateDMSBody

type CreateDMSBody struct {
	ID       string             `json:"id"`
	Name     string             `json:"name"`
	Metadata map[string]any     `json:"metadata"`
	Settings models.DMSSettings `json:"settings"`
}

type CreateDeviceBody

type CreateDeviceBody struct {
	ID        string         `json:"id"`
	Alias     string         `json:"alias"`
	Tags      []string       `json:"tags"`
	Metadata  map[string]any `json:"metadata"`
	DMSID     string         `json:"dms_id"`
	Icon      string         `json:"icon"`
	IconColor string         `json:"icon_color"`
}

type FilterFieldType

type FilterFieldType int

const (
	StringFilterFieldType FilterFieldType = iota
	StringArrayFilterFieldType
	DateFilterFieldType
	NumberFilterFieldType
	EnumFilterFieldType
)

type FilterOperation

type FilterOperation int

const (
	UnspecifiedFilter FilterOperation = iota

	StringEqual
	StringNotEqual
	StringContains
	StringNotContains

	StringArrayContains

	DateEqual
	DateBefore
	DateAfter

	NumberEqual
	NumberNotEqual
	NumberLessThan
	NumberLessOrEqualThan
	NumberGreaterThan
	NumberGreaterOrEqualThan

	EnumEqual
	EnumNotEqual
)

type FilterOption

type FilterOption struct {
	Field           string
	FilterOperation FilterOperation
	Value           string
}

type GetCAsResponse

type GetCAsResponse struct {
	IterableList[models.CACertificate]
}

type GetCertificateStatus

type GetCertificateStatus struct {
	CAID      string                   `json:"CAID"`
	Status    models.CertificateStatus `json:"status"`
	ListInput []models.Certificate     `json:"lostCertificates"`
}

type GetCertificatesByExpirationDateQueryParams

type GetCertificatesByExpirationDateQueryParams struct {
	ExpiresAfter  time.Time `form:"expires_after"`
	ExpiresBefore time.Time `form:"expires_before"`
}

type GetCertsResponse

type GetCertsResponse struct {
	IterableList[models.Certificate]
}

type GetDMSsResponse

type GetDMSsResponse struct {
	IterableList[models.DMS]
}

type GetDevicesResponse

type GetDevicesResponse struct {
	IterableList[models.Device]
}

type ImportCABody

type ImportCABody struct {
	ID                 string                    `json:"id"`
	EngineID           string                    `json:"engine_id"`
	ParentID           string                    `json:"parent_id"`
	CAPrivateKey       string                    `json:"private_key"` //b64 from PEM
	CACertificate      *models.X509Certificate   `json:"ca"`
	CAChain            []*models.X509Certificate `json:"ca_chain"`
	CAType             models.CertificateType    `json:"ca_type"`
	IssuanceExpiration models.Expiration         `json:"issuance_expiration"`
}

type ImportCertificateBody

type ImportCertificateBody struct {
	Metadata    map[string]interface{}  `json:"metadata"`
	Certificate *models.X509Certificate `json:"certificate"`
}

type IterableList

type IterableList[E any] struct {
	NextBookmark string `json:"next"`
	List         []E    `json:"list"`
}

func (IterableList[E]) GetList

func (itr IterableList[E]) GetList() []E

func (IterableList[E]) GetNextBookmark

func (itr IterableList[E]) GetNextBookmark() string

type Iterator

type Iterator[E any] interface {
	GetList() []E
	GetNextBookmark() string
}

type ListInput

type ListInput[E any] struct {
	QueryParameters *QueryParameters
	ExhaustiveRun   bool //wether to iter all elems
	ApplyFunc       func(elem E)
}

type QueryParameters

type QueryParameters struct {
	NextBookmark string
	Sort         SortOptions
	PageSize     int
	Filters      []FilterOption
}

type SignCertificateBody

type SignCertificateBody struct {
	SignVerbatim bool                           `json:"sign_verbatim"`
	CertRequest  *models.X509CertificateRequest `json:"csr"`
	Subject      *models.Subject                `json:"subject"`
}

type SignResponse

type SignResponse struct {
	SignedData string `json:"signed_data"`
}

type SignatureSignBody

type SignatureSignBody struct {
	Message          string                 `json:"message"`
	MessageType      models.SignMessageType `json:"message_type"`
	SigningAlgorithm string                 `json:"signature_algorithm"`
}

type SignatureVerifyBody

type SignatureVerifyBody struct {
	Signature        string                 `json:"signature"`
	Message          string                 `json:"message"`
	MessageType      models.SignMessageType `json:"message_type"`
	SigningAlgorithm string                 `json:"signature_algorithm"`
}

type SortMode

type SortMode string

const (
	SortModeAsc  SortMode = "asc"
	SortModeDesc SortMode = "desc"
)

func ParseSortMode

func ParseSortMode(t string) SortMode

type SortOptions

type SortOptions struct {
	SortMode  SortMode
	SortField string
}

type SubscribeBody

type SubscribeBody struct {
	EventType  models.EventType               `json:"event_type"`
	Conditions []models.SubscriptionCondition `json:"conditions"`
	Channel    models.Channel                 `json:"channel"`
}

type UpdateCAMetadataBody

type UpdateCAMetadataBody struct {
	Metadata map[string]interface{} `json:"metadata"`
}

type UpdateCertificateMetadataBody

type UpdateCertificateMetadataBody struct {
	Metadata map[string]interface{} `json:"metadata"`
}

type UpdateCertificateStatusBody

type UpdateCertificateStatusBody struct {
	NewStatus        models.CertificateStatus `json:"status"`
	RevocationReason models.RevocationReason  `json:"revocation_reason"`
}

type UpdateDeviceIdentitySlotBody

type UpdateDeviceIdentitySlotBody struct {
	models.Slot[string]
}

type UpdateDeviceMetadataBody

type UpdateDeviceMetadataBody struct {
	Metadata map[string]any `json:"metadata"`
}

type VerifyResponse

type VerifyResponse struct {
	Valid bool `json:"valid"`
}