Svc/Ccsds/SdlsFileKeyManager/docs/sdd.md
The Svc::Ccsds::SdlsFileKeyManager component supplies SDLS keys read from a file via the Svc.Ccsds.SdlsKeyInterface interface. The key file path and the key length to read are set at runtime through a configure() call, since these vary across instances of the component. Each key request opens the file, reads exactly the configured number of bytes into the caller-provided SdlsKeyBuffer, closes the file, and returns SdlsStatus.SUCCESS. Any file error results in an SdlsStatus.KEY_ERROR return.
configure(path, keySize) must be called during topology setup. It asserts that keySize is in (0, MAX_SDLS_KEY_SIZE], where MAX_SDLS_KEY_SIZE is defined in the SdlsKeyConfig configuration module.keyGet port carrying a reference to an on-stack SdlsKeyBuffer (Fw::LinearBufferTemplate<MAX_SDLS_KEY_SIZE>).keySize bytes into the buffer, and returns SUCCESS. The file is opened and closed per request, so the key file may be replaced at runtime and no file handle is held open.KEY_ERROR with the buffer length reset to zero, and emits the KeyReadFailed WARNING_HI event carrying the OS status and byte counts.configure() has been called asserts (fail early).| Kind | Name | Port Type | Description |
|---|---|---|---|
| guarded input | keyGet | Svc.Ccsds.SdlsKey | Receives a key request: fills the provided SdlsKeyBuffer with the key and returns the operation status. |
| Name | Severity | Description |
|---|---|---|
| KeyReadFailed | WARNING_HI | The key file could not be read (open error, read error, or short read); carries the OS status and bytes read/expected. |
| Name | Description | Validation |
|---|---|---|
| SVC-CCSDS-SDLS-FILE-KEY-MANAGER-001 | The SdlsFileKeyManager shall accept key requests via the Svc.Ccsds.SdlsKeyInterface interface (guarded keyGet), filling the provided SdlsKeyBuffer. | Unit Test |
| SVC-CCSDS-SDLS-FILE-KEY-MANAGER-002 | Upon a key request, the SdlsFileKeyManager shall read exactly the configured key length from the configured file into the provided buffer and return SdlsStatus.SUCCESS. | Unit Test |
| SVC-CCSDS-SDLS-FILE-KEY-MANAGER-003 | The SdlsFileKeyManager shall return SdlsStatus.KEY_ERROR and emit a WARNING_HI event on any file error (open error, read error, or short read). | Unit Test |
| SVC-CCSDS-SDLS-FILE-KEY-MANAGER-004 | The key file path and key length shall be supplied at runtime via configure(); the key length shall be in (0, MAX_SDLS_KEY_SIZE]. A key request before configuration shall assert. | Unit Test |