ara::crypto::keys::KeyStorageProvider类 参考

密钥存储Provider类定义 更多...

#include <key_storage_provider.h>

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

Public 类型
using	Uptr = std::unique_ptr< KeyStorageProvider >
	密钥Provider的共享智能指针 更多...

Public 成员函数
virtual	~KeyStorageProvider () noexcept=default
	KeyStorageProvider析构函数 更多...
KeyStorageProvider &	operator= (const KeyStorageProvider &other)=default
	将另一个 KeyStorageProvider 复制赋值给此实例 更多...
KeyStorageProvider &	operator= (KeyStorageProvider &&other)=default
	将另一个 KeyStorageProvider 移动赋值给此实例 更多...
virtual ara::core::Result< KeySlot::Uptr >	LoadKeySlot (ara::core::InstanceSpecifier &iSpecify) noexcept=0
	加载到指定KeySlot 更多...
virtual ara::core::Result< TransactionId >	BeginTransaction (const TransactionScope &targetSlots) noexcept=0
	开始新的槽号列表更新事务。 更多...
virtual ara::core::Result< void >	CommitTransaction (TransactionId id) noexcept=0
	将事务的更改提交到密钥存储。 更多...
virtual ara::core::Result< void >	RollbackTransaction (TransactionId id) noexcept=0
	回滚密钥存储中事务期间执行的所有更改。 更多...

详细描述

密钥存储Provider类定义

Swsid

SWS_CRYPT_30100

符合标准

yes

非标原因

N/A

种类

class

符号

ara::crypto::keys::KeyStorageProvider

范围

namespace ara::crypto::keys

基类

N/A

分类

ara

头文件

注解

N/A

模板参数

N/A

在文件 第 行定义.

成员类型定义说明

Uptr

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

密钥Provider的共享智能指针

Swsid

SWS_CRYPT_30101

符合标准

yes

非标原因

N/A

种类

type alias

符号

Uptr

范围

class ara::crypto::keys::KeyStorageProvider

派生来源

std::unique_ptr<KeyStorageProvider>

分类

ara

头文件

注解

N/A

在文件 第 行定义.

构造及析构函数说明

~KeyStorageProvider()

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

virtualdefaultnoexcept

KeyStorageProvider析构函数

模板参数

N/A

参数

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

返回

N/A

注解

N/A

错误码偏差项

N/A

异常

N/A

Swsid

SWS_CRYPT_30110

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

reentrant

Fireandforget

no

错误

N/A

头文件

异常安全

noexcept

分类

ara

成员函数说明

BeginTransaction()

virtual ara::core::Result<TransactionId> ara::crypto::keys::KeyStorageProvider::BeginTransaction ( const TransactionScope &  targetSlots )

pure virtualnoexcept

开始新的槽号列表更新事务。

模板参数

N/A

参数

[in]	targetSlots	在此事务期间应更新的 KeySlot 列表
[out]	N/A
[in,out]	N/A

返回

ara::core::Result< TransactionId > 分配给此事务的唯一 ID

注解

[Error] CryptoError::kBusyResource targetSlots 列表具有已涉及另一个待处理事务或以写入模式打开的关密钥槽

错误码偏差项

N/A

异常

N/A

Swsid

SWS_CRYPT_30123

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

reentrant

Fireandforget

no

错误

N/A

头文件

异常安全

noexcept

分类

ara

CommitTransaction()

virtual ara::core::Result<void> ara::crypto::keys::KeyStorageProvider::CommitTransaction ( TransactionId  id )

pure virtualnoexcept

将事务的更改提交到密钥存储。

模板参数

N/A

参数

[in]	id	应提交的事务的 ID
[out]	N/A
[in,out]	N/A

返回

ara::core::Result<void> 提交操作结果

注解

在事务期间对密钥槽所做的任何更改在提交执行之前都是不可见的。

提交命令将事务期间所做的所有更改永久保存在密钥存储中。

[Error] CryptoError::kInvalidArgument 提供的 ID 无效，即此 ID 未知或对应事务已完成（提交或回滚）

错误码偏差项

N/A

异常

N/A

Swsid

SWS_CRYPT_30124

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

reentrant

Fireandforget

no

错误

N/A

头文件

异常安全

noexcept

分类

ara

LoadKeySlot()

virtual ara::core::Result<KeySlot::Uptr> ara::crypto::keys::KeyStorageProvider::LoadKeySlot ( ara::core::InstanceSpecifier &  iSpecify )

pure virtualnoexcept

加载到指定KeySlot

模板参数

N/A

参数

[in]	iSpecify	目标槽实例标识符
[out]	N/A
[in,out]	N/A

返回

ara::core::Result<KeySlot::Uptr> KeySlot 共享指针

注解

[Error] CryptoErrc::kUnreservedResource 指定标识不识别

错误码偏差项

N/A

异常

N/A

Swsid

SWS_CRYPT_30115

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

reentrant

Fireandforget

no

错误

N/A

头文件

异常安全

noexcept

分类

ara

operator=() [1/2]

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

default

将另一个 KeyStorageProvider 复制赋值给此实例

模板参数

N/A

参数

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

返回

KeyStorageProvider &， *this 包含其他实例内容

注解

N/A

错误码偏差项

N/A

异常

N/A

Swsid

SWS_CRYPT_30222

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

reentrant

Fireandforget

no

错误

N/A

头文件

异常安全

noexcept

分类

ara

operator=() [2/2]

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

default

将另一个 KeyStorageProvider 移动赋值给此实例

模板参数

N/A

参数

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

返回

KeyStorageProvider &， *this 包含其他实例内容

注解

N/A

错误码偏差项

N/A

异常

N/A

Swsid

SWS_CRYPT_30223

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

reentrant

Fireandforget

no

错误

N/A

头文件

异常安全

noexcept

分类

ara

RollbackTransaction()

virtual ara::core::Result<void> ara::crypto::keys::KeyStorageProvider::RollbackTransaction ( TransactionId  id )

pure virtualnoexcept

回滚密钥存储中事务期间执行的所有更改。

模板参数

N/A

参数

[in]	id	应回滚的事务的 ID
[out]	N/A
[in,out]	N/A

返回

ara::core::Result<void> 回滚操作结果

注解

回滚命令永久取消在密钥存储中的事务期间所做的所有更改。

回滚事务对所有应用程序都是完全不可见的

[Error] CryptoError::kInvalidArgument 提供的 ID 无效，即此 ID 未知或对应事务已完成（提交或回滚）

错误码偏差项

N/A

异常

N/A

Swsid

SWS_CRYPT_30125

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

reentrant

Fireandforget

no

错误

N/A

头文件

@exceptionsafety