密钥槽原型接口。更多...

#include <keyslot.h>

ara::crypto::keys::KeySlot 的协作图:

Public 类型
using	Uptr = std::unique_ptr< KeySlot >
	KeySlot共享智能指针更多...

Public 成员函数
virtual	~KeySlot () noexcept=default
	KeySlot析构函数更多...

KeySlot &	operator= (const KeySlot &other)=default
	拷贝重置另一个KeySlot到此实例更多...

KeySlot &	operator= (KeySlot &&other)=default
	移动重置另一个KeySlot到此实例更多...

virtual ara::core::Result< cryp::CryptoProvider::Uptr >	MyProvider () const noexcept=0
	检索拥有此 KeySlot 的 CryptoProvider 实例。更多...

virtual bool	IsEmpty () const noexcept=0
	检查插槽是否为空更多...

virtual ara::core::Result< void >	Clear () noexcept=0
	清空密钥槽更多...

virtual ara::core::Result< void >	SaveCopy (const IOInterface &container) noexcept=0
	将提供的源 IOInterface 的内容保存到此密钥槽更多...

virtual ara::core::Result< KeySlotPrototypeProps >	GetPrototypedProps () const noexcept=0
	获取密钥槽的槽属性更多...

virtual ara::core::Result< KeySlotContentProps >	GetContentProps () const noexcept=0
	获取密钥槽的内容属性更多...

virtual ara::core::Result< IOInterface::Uptr >	Open (bool subscribeForUpdates=false, bool writeable=false) const noexcept=0
	打开这个键槽并返回一个 IOInterface 更多...

详细描述

密钥槽原型接口。

Swsid: SWS_CRYPT_30400

符合标准: yes

非标原因: N/A

种类: class

符号: KeySlot

范围: namespace ara::crypto::keys

基类: N/A

分类: ara

头文件

注解: 此类允许访问物理密钥槽。

模板参数

在文件第行定义.

成员类型定义说明

◆ Uptr

using ara::crypto::keys::KeySlot::Uptr = std::unique_ptr<KeySlot>

KeySlot共享智能指针

Swsid: SWS_CRYPT_30402

符合标准: yes

非标原因: N/A

种类: type alias

符号: Uptr

范围: class ara::crypto::keys::KeySlot

派生来源: std::unique_ptr<KeySlot>

分类: ara

头文件

注解: N/A

在文件第行定义.

构造及析构函数说明

◆ ~KeySlot()

virtual ara::crypto::keys::KeySlot::~KeySlot ( )

virtualdefaultnoexcept

KeySlot析构函数

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回: N/A

注解: N/A

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30401

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A}

头文件

异常安全: noexcept

分类: ara

成员函数说明

◆ Clear()

virtual ara::core::Result<void> ara::crypto::keys::KeySlot::Clear ( )

pure virtualnoexcept

清空密钥槽

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回: ara::core::Result<void>处理结果

注解: [Error] CryptoErrc::kUnreservedResource 目标槽非可写打开

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30405

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: ara

◆ GetContentProps()

virtual ara::core::Result<KeySlotContentProps> ara::crypto::keys::KeySlot::GetContentProps ( ) const

pure virtualnoexcept

获取密钥槽的内容属性

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回: ara::core::Result<KeySlotContentProps> KeySlotContentProps结果

注解: [Error] CryptoErrc::kUnreservedResource 获取失败; [Error] CryptoErrc::kEmptyContainer 空槽号

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30408

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: ara

◆ GetPrototypedProps()

virtual ara::core::Result<KeySlotPrototypeProps> ara::crypto::keys::KeySlot::GetPrototypedProps ( ) const

pure virtualnoexcept

获取密钥槽的槽属性

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回: ara::core::Result< KeySlotPrototypeProps > KeySlotPrototypeProps结果

注解: [Error] CryptoErrc::kUnreservedResource 获取失败

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30407

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: ara

◆ IsEmpty()

virtual bool ara::crypto::keys::KeySlot::IsEmpty ( ) const

pure virtualnoexcept

检查插槽是否为空

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回: bool 如果插槽为空，则为 true 否则为 false

注解: N/A

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30404

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: ara

◆ MyProvider()

virtual ara::core::Result<cryp::CryptoProvider::Uptr> ara::crypto::keys::KeySlot::MyProvider ( ) const

pure virtualnoexcept

检索拥有此 KeySlot 的 CryptoProvider 实例。

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回: ara::core::Result<cryp::CryptoProvider::Uptr> 要与此密钥槽一起使用的 CryptoProvider 的 unique_ptr

注解: N/A

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30403

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: internal

◆ Open()

virtual ara::core::Result<IOInterface::Uptr> ara::crypto::keys::KeySlot::Open	(	bool	subscribeForUpdates = `false`,
		bool	writeable = `false`
	)		const

pure virtualnoexcept

打开这个键槽并返回一个 IOInterface

模板参数

N/A

参数

[in]	bool	subscribeForUpdates = false 订阅更新通知（暂不支持）
[in]	bool	writeable = false 表示是否应以可写的方式打开密钥槽默认只读
[out]	N/A
[in,out]	N/A

返回: ara::core::Result<IOInterface::Uptr> IOInterface的共享指针的结果

注解: [Error] CryptoErrc::kUnreservedResource 无法打开槽号

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30409

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: ara

◆ operator=() [1/2]

KeySlot& ara::crypto::keys::KeySlot::operator= ( const KeySlot & other )

default

拷贝重置另一个KeySlot到此实例

模板参数

N/A

参数

[in]	other	其他KeySlot实例
[out]	N/A
[in,out]	N/A

返回: *this 包括其他实例的内容

注解: N/A

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30220

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: internal

◆ operator=() [2/2]

KeySlot& ara::crypto::keys::KeySlot::operator= ( KeySlot && other )

default

移动重置另一个KeySlot到此实例

模板参数

N/A

参数

[in]	other	其他KeySlot实例
[out]	N/A
[in,out]	N/A

返回: *this 包括其他实例的内容

注解: N/A

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30221

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: internal

◆ SaveCopy()

virtual ara::core::Result<void> ara::crypto::keys::KeySlot::SaveCopy ( const IOInterface & container )

pure virtualnoexcept

将提供的源 IOInterface 的内容保存到此密钥槽

模板参数

N/A

参数

[in]	const	IOInterface& container 源 IOInterface
[out]	N/A
[in,out]	N/A

返回: ara::core::Result<void> 处理结果

注解: [Error] CryptoErrc::kEmptyContainer 源 IOInterface 为空; [Error] CryptoErrc::kIncompatibleObject 源对象具有属性“会话”或者源 IOInterface 引用来自不同 CryptoProvider 的 KeySlot; [Error] CryptoErrc::kContentRestrictions 源对象不满足插槽限制, 限制指目标槽号类型不收限，或者目标槽类型与源槽类型相同; [Error] CryptoErrc::kUnreservedResource 目标插槽未以可写方式打开

错误码偏差项: N/A

异常

N/A

Swsid: SWS_CRYPT_30406

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: reentrant

Fireandforget: no

错误: N/A

头文件

异常安全: noexcept

分类: ara

Public 类型

Public 成员函数

详细描述

成员类型定义说明

◆ Uptr

构造及析构函数说明

◆ ~KeySlot()

成员函数说明

◆ Clear()

◆ GetContentProps()

◆ GetPrototypedProps()

◆ IsEmpty()

◆ MyProvider()

◆ Open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SaveCopy()