mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-04 09:59:32 +00:00
![Satya Tangirala](/assets/img/avatar_default.png)
Inline Encryption hardware allows software to specify an encryption context (an encryption key, crypto algorithm, data unit num, data unit size) along with a data transfer request to a storage device, and the inline encryption hardware will use that context to en/decrypt the data. The inline encryption hardware is part of the storage device, and it conceptually sits on the data path between system memory and the storage device. Inline Encryption hardware implementations often function around the concept of "keyslots". These implementations often have a limited number of "keyslots", each of which can hold a key (we say that a key can be "programmed" into a keyslot). Requests made to the storage device may have a keyslot and a data unit number associated with them, and the inline encryption hardware will en/decrypt the data in the requests using the key programmed into that associated keyslot and the data unit number specified with the request. As keyslots are limited, and programming keys may be expensive in many implementations, and multiple requests may use exactly the same encryption contexts, we introduce a Keyslot Manager to efficiently manage keyslots. We also introduce a blk_crypto_key, which will represent the key that's programmed into keyslots managed by keyslot managers. The keyslot manager also functions as the interface that upper layers will use to program keys into inline encryption hardware. For more information on the Keyslot Manager, refer to documentation found in block/keyslot-manager.c and linux/keyslot-manager.h. Co-developed-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Satya Tangirala <satyat@google.com> Reviewed-by: Eric Biggers <ebiggers@google.com> Reviewed-by: Christoph Hellwig <hch@lst.de> Signed-off-by: Jens Axboe <axboe@kernel.dk>
106 lines
3.3 KiB
C
106 lines
3.3 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/*
|
|
* Copyright 2019 Google LLC
|
|
*/
|
|
|
|
#ifndef __LINUX_KEYSLOT_MANAGER_H
|
|
#define __LINUX_KEYSLOT_MANAGER_H
|
|
|
|
#include <linux/bio.h>
|
|
#include <linux/blk-crypto.h>
|
|
|
|
struct blk_keyslot_manager;
|
|
|
|
/**
|
|
* struct blk_ksm_ll_ops - functions to manage keyslots in hardware
|
|
* @keyslot_program: Program the specified key into the specified slot in the
|
|
* inline encryption hardware.
|
|
* @keyslot_evict: Evict key from the specified keyslot in the hardware.
|
|
* The key is provided so that e.g. dm layers can evict
|
|
* keys from the devices that they map over.
|
|
* Returns 0 on success, -errno otherwise.
|
|
*
|
|
* This structure should be provided by storage device drivers when they set up
|
|
* a keyslot manager - this structure holds the function ptrs that the keyslot
|
|
* manager will use to manipulate keyslots in the hardware.
|
|
*/
|
|
struct blk_ksm_ll_ops {
|
|
int (*keyslot_program)(struct blk_keyslot_manager *ksm,
|
|
const struct blk_crypto_key *key,
|
|
unsigned int slot);
|
|
int (*keyslot_evict)(struct blk_keyslot_manager *ksm,
|
|
const struct blk_crypto_key *key,
|
|
unsigned int slot);
|
|
};
|
|
|
|
struct blk_keyslot_manager {
|
|
/*
|
|
* The struct blk_ksm_ll_ops that this keyslot manager will use
|
|
* to perform operations like programming and evicting keys on the
|
|
* device
|
|
*/
|
|
struct blk_ksm_ll_ops ksm_ll_ops;
|
|
|
|
/*
|
|
* The maximum number of bytes supported for specifying the data unit
|
|
* number.
|
|
*/
|
|
unsigned int max_dun_bytes_supported;
|
|
|
|
/*
|
|
* Array of size BLK_ENCRYPTION_MODE_MAX of bitmasks that represents
|
|
* whether a crypto mode and data unit size are supported. The i'th
|
|
* bit of crypto_mode_supported[crypto_mode] is set iff a data unit
|
|
* size of (1 << i) is supported. We only support data unit sizes
|
|
* that are powers of 2.
|
|
*/
|
|
unsigned int crypto_modes_supported[BLK_ENCRYPTION_MODE_MAX];
|
|
|
|
/* Device for runtime power management (NULL if none) */
|
|
struct device *dev;
|
|
|
|
/* Here onwards are *private* fields for internal keyslot manager use */
|
|
|
|
unsigned int num_slots;
|
|
|
|
/* Protects programming and evicting keys from the device */
|
|
struct rw_semaphore lock;
|
|
|
|
/* List of idle slots, with least recently used slot at front */
|
|
wait_queue_head_t idle_slots_wait_queue;
|
|
struct list_head idle_slots;
|
|
spinlock_t idle_slots_lock;
|
|
|
|
/*
|
|
* Hash table which maps struct *blk_crypto_key to keyslots, so that we
|
|
* can find a key's keyslot in O(1) time rather than O(num_slots).
|
|
* Protected by 'lock'.
|
|
*/
|
|
struct hlist_head *slot_hashtable;
|
|
unsigned int log_slot_ht_size;
|
|
|
|
/* Per-keyslot data */
|
|
struct blk_ksm_keyslot *slots;
|
|
};
|
|
|
|
int blk_ksm_init(struct blk_keyslot_manager *ksm, unsigned int num_slots);
|
|
|
|
blk_status_t blk_ksm_get_slot_for_key(struct blk_keyslot_manager *ksm,
|
|
const struct blk_crypto_key *key,
|
|
struct blk_ksm_keyslot **slot_ptr);
|
|
|
|
unsigned int blk_ksm_get_slot_idx(struct blk_ksm_keyslot *slot);
|
|
|
|
void blk_ksm_put_slot(struct blk_ksm_keyslot *slot);
|
|
|
|
bool blk_ksm_crypto_cfg_supported(struct blk_keyslot_manager *ksm,
|
|
const struct blk_crypto_config *cfg);
|
|
|
|
int blk_ksm_evict_key(struct blk_keyslot_manager *ksm,
|
|
const struct blk_crypto_key *key);
|
|
|
|
void blk_ksm_reprogram_all_keys(struct blk_keyslot_manager *ksm);
|
|
|
|
void blk_ksm_destroy(struct blk_keyslot_manager *ksm);
|
|
|
|
#endif /* __LINUX_KEYSLOT_MANAGER_H */
|