Simple interface class for authentication request objects.
更多...
#include <authentication.h>
|
| | Authentication (const ara::core::InstanceSpecifier &specifier) |
| | Constructor. 更多...
|
| |
| virtual | ~Authentication () |
| | destructor. 更多...
|
| |
| virtual ara::core::Future< OperationOutput > | DeAuthentication ()=0 |
| | DeAuthentication succeeds, the server is secured again. 更多...
|
| |
| virtual ara::core::Future< OperationOutput > | VerifyCertificateUnidirectional (uint8_t CommunicationConfiguration, ByteSpan ClientCertificate, ByteSpan ClientChallenge)=0 |
| | Authenticate by validating certificates. 更多...
|
| |
| virtual ara::core::Future< OperationOutput > | VerifyCertificateBidirectional (uint8_t CommunicationConfiguration, ByteSpan ClientCertificate, ByteSpan ClientChallenge)=0 |
| | Initiate authentication by validating the certificate and generating proof of ownership from the server. 更多...
|
| |
| virtual ara::core::Future< OperationOutput > | VerifyOwnership (ByteSpan ClientPOWN, ByteSpan ClientEphemeralPublicKey)=0 |
| | Initiate authentication by validating the certificate. 更多...
|
| |
| virtual ara::core::Future< OperationOutput > | TransmitCertificate (uint16_t CertificateEvaluationId, ByteSpan CertificateData)=0 |
| | This SubFunction parameter transmits the certificate independently or after a previous authentication. 更多...
|
| |
| virtual ara::core::Future< OperationOutput > | AuthenticationConfiguration ()=0 |
| | Authentication configuration provided by the server. 更多...
|
| |
| ara::core::Result< void > | Offer () |
| | Provides a service that enables the DM to forward the diagnostic service request to the diagnostic application for processing. 更多...
|
| |
| void | StopOffer () |
| | StopOffer prohibits forwarding of messages delivered from DMs. 更多...
|
| |
Simple interface class for authentication request objects.
- Swsid
- N/A
- 符合标准
- No
- 非标原因
- custom interface
- 种类
- class
- 符号
- ara::diag::Authentication
- 范围
- namespace ara::diag
- 基类
- N/A
- 分类
- ara
- 头文件
- ara/diag/authentication.h
- 注解
- Authentication service is used for authentication.
- 模板参数
-
在文件 第 行定义.
◆ Authentication()
| ara::diag::Authentication::Authentication |
( |
const ara::core::InstanceSpecifier & |
specifier | ) |
|
|
explicit |
Constructor.
- 模板参数
-
- 参数
-
| [in] | specifier | An instance designator of PortPrototype. InstanceSpecifier is an alias for std::string type. |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ ~Authentication()
| ara::diag::Authentication::~Authentication |
( |
| ) |
|
|
virtual |
destructor.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ AuthenticationConfiguration()
| virtual ara::core::Future<OperationOutput> ara::diag::Authentication::AuthenticationConfiguration |
( |
| ) |
|
|
pure virtual |
Authentication configuration provided by the server.
- 模板参数
-
- 参数
-
| [in] | N/A |
|
| [out] | ara::core::Future<OperationOutput> | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
◆ DeAuthentication()
| virtual ara::core::Future<OperationOutput> ara::diag::Authentication::DeAuthentication |
( |
| ) |
|
|
pure virtual |
DeAuthentication succeeds, the server is secured again.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | ara::core::Future<OperationOutput> | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
◆ Offer()
| ara::core::Result< void > ara::diag::Authentication::Offer |
( |
| ) |
|
Provides a service that enables the DM to forward the diagnostic service request to the diagnostic application for processing.
- 模板参数
-
- 参数
-
| [in] | N/A |
|
| [out] | int | |
| [in,out] | N/A | |
- 返回
- int
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
引用了 ara::diag::kAlreadyOffered.
◆ StopOffer()
| void ara::diag::Authentication::StopOffer |
( |
| ) |
|
StopOffer prohibits forwarding of messages delivered from DMs.
- 模板参数
-
- 参数
-
| [in] | N/A |
|
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- N/A
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ TransmitCertificate()
| virtual ara::core::Future<OperationOutput> ara::diag::Authentication::TransmitCertificate |
( |
uint16_t |
CertificateEvaluationId, |
|
|
ByteSpan |
CertificateData |
|
) |
| |
|
pure virtual |
This SubFunction parameter transmits the certificate independently or after a previous authentication.
- 模板参数
-
- 参数
-
| [in] | CertificateEvaluationId | Providing a different certificateEvaluationId allows the server to identify the certificate. |
| [in] | CertificateData | The certificate to verify. |
| [out] | ara::core::Future<OperationOutput> | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
◆ VerifyCertificateBidirectional()
| virtual ara::core::Future<OperationOutput> ara::diag::Authentication::VerifyCertificateBidirectional |
( |
uint8_t |
CommunicationConfiguration, |
|
|
ByteSpan |
ClientCertificate, |
|
|
ByteSpan |
ClientChallenge |
|
) |
| |
|
pure virtual |
Initiate authentication by validating the certificate and generating proof of ownership from the server.
- 模板参数
-
- 参数
-
| [in] | CommunicationConfiguration | Configuration information on how to proceed with secure authentication after further diagnostic communications. |
| [in] | ClientCertificate | Certificate received from the tester during one-way certification. |
| [in] | ClientChallenge | This parameter provides the challenge Client received from the tester during one-way authentication. This parameter depends on the communication configuration used and may be empty. |
| [out] | ara::core::Future<OperationOutput> | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
◆ VerifyCertificateUnidirectional()
| virtual ara::core::Future<OperationOutput> ara::diag::Authentication::VerifyCertificateUnidirectional |
( |
uint8_t |
CommunicationConfiguration, |
|
|
ByteSpan |
ClientCertificate, |
|
|
ByteSpan |
ClientChallenge |
|
) |
| |
|
pure virtual |
Authenticate by validating certificates.
- 模板参数
-
- 参数
-
| [in] | CommunicationConfiguration | Configuration information on how to proceed with secure authentication after further diagnostic communications. |
| [in] | ClientCertificate | Certificate received from the tester during one-way certification. |
| [in] | ClientChallenge | This parameter provides the challenge Client received from the tester during one-way authentication. This parameter depends on the communication configuration used and may be empty. |
| [out] | ara::core::Future<OperationOutput> | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara
◆ VerifyOwnership()
| virtual ara::core::Future<OperationOutput> ara::diag::Authentication::VerifyOwnership |
( |
ByteSpan |
ClientPOWN, |
|
|
ByteSpan |
ClientEphemeralPublicKey |
|
) |
| |
|
pure virtual |
Initiate authentication by validating the certificate.
- 模板参数
-
- 参数
-
| [in] | ClientPOWN | Proof of ownership provided by the tester to the challengeServer previously exchanged. |
| [in] | ClientEphemeralPublicKey | Temporary public key, may be empty. |
| [out] | ara::core::Future<OperationOutput> | |
| [in,out] | N/A | |
- 返回
- ara::core::Future<OperationOutput>
- 注解
- N/A
- 异常
-
- Swsid
- N/A
- 符合标准
- no
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- N/A
- Fireandforget
- N/A
- 错误
- N/A
- 头文件
- ara/diag/Authentication.h
- 异常安全
- N/A
- 分类
- ara