Back to Fprime

Svc::Ccsds::ClearTextEncryptor

Svc/Ccsds/ClearTextEncryptor/docs/sdd.md

4.3.02.9 KB
Original Source

Svc::Ccsds::ClearTextEncryptor

[!WARNING] This component provides NO security. It performs no authentication, no integrity protection, and no encryption. All data passes through unmodified. It is intended only for clear-mode operation (e.g. as the default encryptor in a standard subtopology) and for testing. Do not use it where confidentiality, integrity, or authenticity of the data link is required.

The Svc::Ccsds::ClearTextEncryptor component is a pass-through implementation of the Svc.Ccsds.CcsdsSdlsEncrypt interface. It is a pure pass-through in both dimensions: requests received on encryptIn are forwarded out encryptOut with the buffer and context unmodified (alongside an SdlsStatus.SUCCESS status), and buffer ownership returned on encryptReturnIn is passed upstream via bufferReturnOut for deallocation. No memory is allocated.

Functionality

  • Receives an SA index, iv/data buffer, and frame context on the guarded encryptIn port; the SA index is ignored.
  • Forwards the buffer and context unmodified out encryptOut alongside an SdlsStatus.SUCCESS status.
  • Passes ownership returns received on encryptReturnIn upstream via bufferReturnOut (the forwarded buffer is the incoming buffer, as no allocation occurs).

Port Descriptions

KindNamePort TypeDescription
guarded inputencryptInSvc.Ccsds.CcsdsSdlsEncryptionReceives the SA index and iv/data buffer (from CcsdsSdlsEncrypt interface).
outputencryptOutSvc.Ccsds.CcsdsSdlsDataSends the operation status and (unmodified) data downstream.
sync inputencryptReturnInSvc.ComDataWithContextReceives back ownership of buffers sent on encryptOut.
outputbufferReturnOutSvc.ComDataWithContextReturns the incoming iv/data buffer for deallocation.

Requirements

NameDescriptionValidation
SVC-CCSDS-CLEARTEXT-ENCRYPTOR-001The ClearTextEncryptor shall accept an SA index, iv/data buffer, and frame context via the Svc.Ccsds.CcsdsSdlsEncrypt interface (guarded encryptIn).Unit Test
SVC-CCSDS-CLEARTEXT-ENCRYPTOR-002The ClearTextEncryptor shall perform no authentication and no encryption, passing the received buffer and context unmodified out encryptOut.Unit Test
SVC-CCSDS-CLEARTEXT-ENCRYPTOR-003The ClearTextEncryptor shall pass an SdlsStatus.SUCCESS status forward for every request.Unit Test
SVC-CCSDS-CLEARTEXT-ENCRYPTOR-004Upon receiving ownership of a buffer back on encryptReturnIn, the ClearTextEncryptor shall pass it upstream via bufferReturnOut for deallocation.Unit Test

See Also