clase ara::crypto::Serializable

La interfaz ara::crypto::Serializable define el estándar uniforme para la exportación pública de objetos criptográficos en secuencias de bytes específicas del formato. Las aplicaciones determinan previamente a través de GetExportSize() el tamaño de búfer requerido y ejecutan a continuación la serialización propiamente dicha mediante ExportPublicly() en un búfer provisto [SWS_CRYPT_10711]. Todas las operaciones son seguras frente a excepciones y thread-safe, requiriendo la exportación de claves obligatoriamente el permiso kAllowPlaintextExport y estando los errores siempre sujetos a una semántica de reversión (rollback_semantics) [SWS_CRYPT_50006].

más ›

Contexto

La interfaz ara::crypto::Serializable define el contrato abstracto para objetos criptográficos en el módulo crypto que pueden transformarse en una representación de bytes estandarizada. Como interfaz pura, encapsula la capacidad de serializar un objeto en un formato de salida especificado por un identificador de formato (FormatId) [SWS_CRYPT_10711]. Entre los participantes de interacción típicos se encuentran componentes de aplicación o de plataforma que deben almacenar de forma persistente artefactos criptográficos como claves o certificados, transmitirlos a través de canales de comunicación o intercambiarlos en texto claro. La interfaz garantiza que la exportación se lleve a cabo de manera controlada y teniendo en cuenta tanto los formatos como las restricciones de seguridad.

Ciclo de vida

Dado que ara::crypto::Serializable representa una interfaz puramente virtual con métodos puramente virtuales, la clase no dispone de lógica de instanciación propia. La vida útil y la creación dependen por completo de las clases criptográficas concretas derivadas que implementan la interfaz. Ambos métodos especificados de la interfaz, GetExportSize() [SWS_CRYPT_50006] y ExportPublicly() [SWS_CRYPT_10711], están declarados como const y no modifican el estado interno del objeto durante la serialización. Conforme a la especificación, las operaciones están diseñadas como seguras frente a excepciones (exception safe) y seguras para concurrencia (thread-safe) [SWS_CRYPT_10711], [SWS_CRYPT_50006], de modo que se permiten accesos de lectura paralelos a la misma instancia de objeto.

Ruta de uso

El flujo regular de una exportación se estructura en una secuencia de dos pasos que consta de la determinación del tamaño y la serialización propiamente dicha. Para evitar desbordamientos de búfer o asignaciones fallidas, el invocador consulta previamente mediante el método GetExportSize() el tamaño exacto de búfer necesario en bytes para el formato de destino deseado [SWS_CRYPT_50006]. Tras una respuesta satisfactoria, el invocador proporciona una zona de memoria escribible del tipo ReadWriteMemRegion. Es de suponer que en la mayoría de las implementaciones esta zona de memoria se asigne dinámicamente según el número de bytes determinado o se proporcione a partir de un pool de memoria reservado previamente. Pregunta Q-0c04ba0a352f0a37 (abierta)

En el paso siguiente, la aplicación invoca ExportPublicly() y transfiere tanto el búfer provisto como el FormatId [SWS_CRYPT_10711] seleccionado previamente. El objeto serializa sus datos útiles en la zona de memoria transferida y, en caso de éxito, devuelve dentro del tipo de retorno ara::core::Result<std::size_t> el número de bytes efectivamente escritos [SWS_CRYPT_10711].

Diagrama de secuencia: orden típico de invocación para la serialización de un objeto mediante consulta de tamaño y posterior exportación. Fuentes: [SWS_CRYPT_50006], [SWS_CRYPT_10711]

Escenarios de error

Las operaciones de la interfaz señalan estados de error a través del tipo de retorno ara::core::Result, garantizando todos los errores especificados una estricta semántica de reversión (rollback_semantics) [SWS_CRYPT_10711], [SWS_CRYPT_50006]. Si una invocación falla, el sistema completo permanece en un estado consistente. Se definen los siguientes casos de error:

• ara::crypto::CryptoErrc::kUnsupportedFormat: se devuelve tanto por GetExportSize() [SWS_CRYPT_50006] como por ExportPublicly() [SWS_CRYPT_10711] si el FormatId indicado no es compatible con el tipo de objeto concreto.
• ara::crypto::CryptoErrc::kInsufficientCapacity: se produce en ExportPublicly() si la capacidad del búfer ReadWriteMemRegion transferido no es suficiente para los datos serializados [SWS_CRYPT_10711].
• ara::crypto::CryptoErrc::kUnsupported: es notificado por ExportPublicly() en caso de que la exportación no sea compatible por principio para el objeto específico [SWS_CRYPT_10711].
• ara::crypto::CryptoErrc::kUsageViolation: se produce en ExportPublicly() cuando el objeto es una clave cuyas reglas de uso no permiten una exportación en texto claro (el uso permitido no incluye kAllowPlaintextExport) [SWS_CRYPT_10711].