mirror of
https://github.com/ibm-s390-linux/s390-tools.git
synced 2026-08-05 02:14:52 +00:00
Ingo Franzki
9de85f4295
For the 'zkey list', 'zkey validate' and 'zkey-cryptsetup validate' commands, display the key type. As of today there is only one possible key type (CCA-AESDATA), but in the future there might be additional key types. Signed-off-by: Ingo Franzki <ifranzki@linux.ibm.com> Reviewed-by: Harald Freudenberger <freude@linux.ibm.com> Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
137 lines
3.9 KiB
C
137 lines
3.9 KiB
C
/*
|
|
* zkey - Generate, re-encipher, and validate secure keys
|
|
*
|
|
* This header file defines the interface to the pkey kernel module.
|
|
* It defines a set of IOCTL commands with its associated structures.
|
|
*
|
|
* Copyright IBM Corp. 2017, 2018
|
|
*
|
|
* s390-tools is free software; you can redistribute it and/or modify
|
|
* it under the terms of the MIT license. See LICENSE for details.
|
|
*/
|
|
|
|
#ifndef PKEY_H
|
|
#define PKEY_H
|
|
|
|
#include "lib/zt_common.h"
|
|
|
|
/*
|
|
* Definitions for the /dev/pkey kernel module interface
|
|
*/
|
|
struct tokenheader {
|
|
u8 type;
|
|
u8 res0[3];
|
|
u8 version;
|
|
u8 res1[3];
|
|
} __packed;
|
|
|
|
#define TOKEN_TYPE_NON_CCA 0x00
|
|
#define TOKEN_TYPE_CCA_INTERNAL 0x01
|
|
|
|
#define TOKEN_VERSION_AESDATA 0x04
|
|
|
|
struct secaeskeytoken {
|
|
u8 type; /* 0x01 for internal key token */
|
|
u8 res0[3];
|
|
u8 version; /* should be 0x04 */
|
|
u8 res1[1];
|
|
u8 flag; /* key flags */
|
|
u8 res2[1];
|
|
u64 mkvp; /* master key verification pattern */
|
|
u8 key[32]; /* key value (encrypted) */
|
|
u8 cv[8]; /* control vector */
|
|
u16 bitsize; /* key bit size */
|
|
u16 keysize; /* key byte size */
|
|
u8 tvv[4]; /* token validation value */
|
|
} __packed;
|
|
|
|
#define SECURE_KEY_SIZE sizeof(struct secaeskeytoken)
|
|
|
|
struct pkey_seckey {
|
|
u8 seckey[SECURE_KEY_SIZE]; /* the secure key blob */
|
|
};
|
|
|
|
struct pkey_clrkey {
|
|
u8 clrkey[32]; /* 16, 24, or 32 byte clear key value */
|
|
};
|
|
|
|
#define PKEY_IOCTL_MAGIC 'p'
|
|
#define AUTOSELECT 0xFFFF
|
|
#define PKEYDEVICE "/dev/pkey"
|
|
#define PKEY_KEYTYPE_AES_128 1
|
|
#define PKEY_KEYTYPE_AES_192 2
|
|
#define PKEY_KEYTYPE_AES_256 3
|
|
|
|
struct pkey_genseck {
|
|
u16 cardnr; /* in: card to use or FFFF for any */
|
|
u16 domain; /* in: domain or FFFF for any */
|
|
u32 keytype; /* in: key type to generate */
|
|
struct pkey_seckey seckey; /* out: the secure key blob */
|
|
};
|
|
|
|
#define PKEY_GENSECK _IOWR(PKEY_IOCTL_MAGIC, 0x01, struct pkey_genseck)
|
|
|
|
struct pkey_clr2seck {
|
|
u16 cardnr; /* in: card to use or FFFF for any */
|
|
u16 domain; /* in: domain or FFFF for any*/
|
|
u32 keytype; /* in: key type to generate */
|
|
struct pkey_clrkey clrkey; /* in: the clear key value */
|
|
struct pkey_seckey seckey; /* out: the secure key blob */
|
|
};
|
|
|
|
#define PKEY_CLR2SECK _IOWR(PKEY_IOCTL_MAGIC, 0x02, struct pkey_clr2seck)
|
|
|
|
struct pkey_verifykey {
|
|
struct pkey_seckey seckey; /* in: the secure key blob */
|
|
u16 cardnr; /* out: card number */
|
|
u16 domain; /* out: domain number */
|
|
u16 keysize; /* out: key size in bits */
|
|
u32 attributes; /* out: attribute bits */
|
|
};
|
|
|
|
#define PKEY_VERIFY_ATTR_AES 0x0001 /* key is an AES key */
|
|
#define PKEY_VERIFY_ATTR_OLD_MKVP 0x0100 /* key has old MKVP value */
|
|
|
|
#define PKEY_VERIFYKEY _IOWR(PKEY_IOCTL_MAGIC, 0x07, struct pkey_verifykey)
|
|
|
|
#define KEY_TYPE_CCA_AESDATA "CCA-AESDATA"
|
|
|
|
#define PAES_BLOCK_SIZE 16
|
|
#define ENC_ZERO_LEN (2 * PAES_BLOCK_SIZE)
|
|
#define VERIFICATION_PATTERN_LEN (2 * ENC_ZERO_LEN + 1)
|
|
|
|
int open_pkey_device(bool verbose);
|
|
|
|
int generate_secure_key_random(int pkey_fd, const char *keyfile,
|
|
size_t keybits, bool xts, u16 card, u16 domain,
|
|
bool verbose);
|
|
|
|
int generate_secure_key_clear(int pkey_fd, const char *keyfile,
|
|
size_t keybits, bool xts,
|
|
const char *clearkeyfile,
|
|
u16 card, u16 domain,
|
|
bool verbose);
|
|
|
|
u8 *read_secure_key(const char *keyfile, size_t *secure_key_size,
|
|
bool verbose);
|
|
|
|
int write_secure_key(const char *keyfile, const u8 *secure_key,
|
|
size_t secure_key_size, bool verbose);
|
|
|
|
int validate_secure_key(int pkey_fd,
|
|
u8 *secure_key, size_t secure_key_size,
|
|
size_t *clear_key_bitsize, int *is_old_mk,
|
|
bool verbose);
|
|
|
|
int generate_key_verification_pattern(const char *key, size_t key_size,
|
|
char *vp, size_t vp_len, bool verbose);
|
|
|
|
int get_master_key_verification_pattern(const u8 *secure_key,
|
|
size_t secure_key_size, u64 *mkvp,
|
|
bool verbose);
|
|
|
|
bool is_cca_aes_data_key(const u8 *key, size_t key_size);
|
|
const char *get_key_type(const u8 *key, size_t key_size);
|
|
|
|
#endif
|