SNIP_ADAPTIVE_OS_SECTION_8_API_specification
Wortlaut
[SWS_CRYPT_20724]{DRAFT}
Definition
of
API
function
ara::crypto::cryp::CryptoProvider::GetSerializedSize ⌈
Kind:
function
Header file:
#include "ara/crypto/cryp/crypto_provider.h"
Scope:
class ara::crypto::cryp::CryptoProvider
Symbol:
GetSerializedSize(CryptoObjectType cryptoObjectType, AlgId algId, Serializable::FormatId
formatId=Serializable::kFormatDefault)
Syntax:
virtual ara::core::Result< std::size_t > GetSerializedSize (Crypto
ObjectType cryptoObjectType, AlgId algId, Serializable::FormatId
formatId=Serializable::kFormatDefault) const noexcept=0;
cryptoObjectType
the type of the target object
algId
the Crypto Provider algorithm ID of the target object
Parameters (in):
formatId
the Crypto Provider specific identifier of the output format
Return value:
ara::core::Result<
std::size_t >
size required for storing of the object serialized in the specified
format
Exception Safety:
noexcept
Thread Safety:
Thread-safe
ara::crypto::CryptoErrc::k
UnknownIdentifier
if any argument has an unsupported value
Errors:
ara::crypto::CryptoErrc::k
IncompatibleArguments
if any pair of the arguments are incompatible
Description:
Return required buffer size for serialization of an object in specific format.
⌋(RS_CRYPTO_02005, RS_CRYPTO_02006)
[SWS_CRYPT_20732]{DRAFT}
Definition
of
API
function
ara::crypto::cryp::CryptoProvider::ImportPublicObject ⌈
Kind:
function
Header file:
#include "ara/crypto/cryp/crypto_provider.h"
Scope:
class ara::crypto::cryp::CryptoProvider
Symbol:
ImportPublicObject(IOInterface &container, ReadOnlyMemRegion serialized, CryptoObjectType
expectedObject=CryptoObjectType::kUndefined)
Syntax:
virtual ara::core::Result< void > ImportPublicObject (IOInterface
&container, ReadOnlyMemRegion serialized, CryptoObjectType expected
Object=CryptoObjectType::kUndefined) noexcept=0;
serialized
the memory region that contains a securely serialized object that
should be imported to the IOInterface
Parameters (in):
expectedObject
the expected object type (default value CryptoObjectType::k
Unknown means without check)
Parameters (out):
container
the IOInterface for storing of the imported object
Return value:
ara::core::Result< void >
–
Exception Safety:
noexcept
Thread Safety:
Thread-safe
ara::crypto::CryptoErrc::k
UnexpectedValue
if the serialized contains incorrect data
ara::crypto::CryptoErrc::k
BadObjectType
if (expectedObject != CryptoObjectType::kUnknown), but the actual
object type differs from the expected one
Errors:
ara::crypto::CryptoErrc::k
InsufficientCapacity
if capacity of the container is not enough to save the de-serialized
object
▽
Versionen & Provenienz · Zugeordnete Anforderungen
Diese Angaben zeigt der Versions-Explorer.
Begründung & Zuweisungs-Evidenz
Cited verbatim in the snippet (deterministic citation).
Dokumenten-Herkunft & Rückverfolgbarkeit
| Spezifikations-Dokument | SWS_Cryptography.pdf |
|---|---|
| Dokumentseite | Seite 145 |
| Ziel-Modul | crypto (adaptive) |
| Ziel-Anforderung | SWS_CRYPT_20732 |
| Semantische Rolle | constitutive |
| Automatisierungs-Konfidenz | 0.95 |