<br />

Added: HEAD

## **PROTOCOLS**

## Controller

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=53)*

Protocol used between block drivers and hardware inline encryption controllers.

<br />

### DeriveRawSecret

#### Request

| Name | Type |
|---|---|
| `wrapped_key` | `vector<uint8>` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Controller_DeriveRawSecret_Result` |

### ProgramKeySlot

#### Request

| Name | Type |
|---|---|
| `wrapped_key` | `vector<uint8>` |
| `data_unit_size` | `uint32` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Controller_ProgramKeySlot_Result` |

## Device

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=10)*

### DeriveRawSecret

Derives a raw software secret from the ephemerally wrapped `wrapped_key`. `wrapped_key`
must be a key wrapped by the inline encryption hardware (in the same session/boot) via a
separate mechanism to this protocol. The returned secret can be used for non-inline
cryptographic operations e.g. it can be used for encrypting filesystem metadata not covered
by inline encryption.
Returns

- ZX_ERR_INVALID_ARGS if `wrapped_key` is not the expected size or if the `wrapped_key` fails authentication (e.g. wrapped_key is from a previous boot).
- ZX_ERR_TIMED_OUT if the operation times out.
- ZX_ERR_INTERNAL if the operation failed for any other reason.

#### Request

| Name | Type |
|---|---|
| `wrapped_key` | `vector<uint8>` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Device_DeriveRawSecret_Result` |

### ProgramKey

Programs the ephemerally wrapped `wrapped_key` into the inline encryption hardware in the
next available slot and returns a `key_token` capability representing that slot. The
returned `key_token` must be registered with a block session via
`fuchsia.storage.block/Session.RegisterKey` before the slot can be used in block I/O
requests. All slots programmed via the connection this method is called on will be evicted
once the connection is dropped. It is not possible to evict individual keys (not for any
technical reasons; a need for this has not yet arisen). `wrapped_key` must be a key wrapped
by the inline encryption hardware (in the same session/boot) via a separate mechanism to
this protocol.

Returns

- ZX_ERR_NO_RESOURCES if there are no available key slots.
- ZX_ERR_INVALID_ARGS if `wrapped_key` is not the expected size or if the `wrapped_key` fails authentication (e.g. wrapped_key is from a previous boot).
- ZX_ERR_TIMED_OUT if the operation times out.
- ZX_ERR_INTERNAL if the operation failed for any other reason.

#### Request

| Name | Type |
|---|---|
| `wrapped_key` | `vector<uint8>` |
| `data_unit_size` | `uint32` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Device_ProgramKey_Result` |

## DriverDevice

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=71)*

A driver transport variant of the `Controller` protocol.

<br />

### DeriveRawSecret

#### Request

| Name | Type |
|---|---|
| `wrapped_key` | `vector<uint8>` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Controller_DeriveRawSecret_Result` |

### ProgramKeySlot

#### Request

| Name | Type |
|---|---|
| `wrapped_key` | `vector<uint8>` |
| `data_unit_size` | `uint32` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Controller_ProgramKeySlot_Result` |

## **STRUCTS**

### Controller_DeriveRawSecret_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=63)*

| Field | Type | Description | Default |
|---|---|---|---|
| `secret` | `vector<uint8>` |   | No default |

### Controller_ProgramKeySlot_Response

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=57)*

| Field | Type | Description | Default |
|---|---|---|---|
| `slot` | `uint8` |   | No default |

### Device_DeriveRawSecret_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=46)*

| Field | Type | Description | Default |
|---|---|---|---|
| `secret` | `vector<uint8>` |   | No default |

### Device_ProgramKey_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=30)*

| Field | Type | Description | Default |
|---|---|---|---|
| `key_token` | `handle<eventpair>` |   | No default |

## **UNIONS**

### Controller_DeriveRawSecret_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=63)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Controller_DeriveRawSecret_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Controller_ProgramKeySlot_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=57)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Controller_ProgramKeySlot_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Device_DeriveRawSecret_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=46)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Device_DeriveRawSecret_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Device_ProgramKey_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.inlineencryption/inlineencryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.inlineencryption/inlineencryption.fidl;l=30)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.inlineencryption#Device_ProgramKey_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />