[deliverable/linux.git] / include / crypto / public_key.h

/* Asymmetric public-key algorithm definitions
 *
 * See Documentation/crypto/asymmetric-keys.txt
 *
 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public Licence
 * as published by the Free Software Foundation; either version
 * 2 of the Licence, or (at your option) any later version.
 */

#ifndef _LINUX_PUBLIC_KEY_H
#define _LINUX_PUBLIC_KEY_H

#include <linux/mpi.h>
#include <crypto/hash_info.h>

enum pkey_algo {
	PKEY_ALGO_DSA,
	PKEY_ALGO_RSA,
	PKEY_ALGO__LAST
};

extern const char *const pkey_algo_name[PKEY_ALGO__LAST];
extern const struct public_key_algorithm *pkey_algo[PKEY_ALGO__LAST];

/* asymmetric key implementation supports only up to SHA224 */
#define PKEY_HASH__LAST		(HASH_ALGO_SHA224 + 1)

enum pkey_id_type {
	PKEY_ID_PGP,		/* OpenPGP generated key ID */
	PKEY_ID_X509,		/* X.509 arbitrary subjectKeyIdentifier */
	PKEY_ID_TYPE__LAST
};

extern const char *const pkey_id_type_name[PKEY_ID_TYPE__LAST];

/*
 * Cryptographic data for the public-key subtype of the asymmetric key type.
 *
 * Note that this may include private part of the key as well as the public
 * part.
 */
struct public_key {
	const struct public_key_algorithm *algo;
	u8	capabilities;
#define PKEY_CAN_ENCRYPT	0x01
#define PKEY_CAN_DECRYPT	0x02
#define PKEY_CAN_SIGN		0x04
#define PKEY_CAN_VERIFY		0x08
	enum pkey_algo pkey_algo : 8;
	enum pkey_id_type id_type : 8;
	union {
		MPI	mpi[5];
		struct {
			MPI	p;	/* DSA prime */
			MPI	q;	/* DSA group order */
			MPI	g;	/* DSA group generator */
			MPI	y;	/* DSA public-key value = g^x mod p */
			MPI	x;	/* DSA secret exponent (if present) */
		} dsa;
		struct {
			MPI	n;	/* RSA public modulus */
			MPI	e;	/* RSA public encryption exponent */
			MPI	d;	/* RSA secret encryption exponent (if present) */
			MPI	p;	/* RSA secret prime (if present) */
			MPI	q;	/* RSA secret prime (if present) */
		} rsa;
	};
};

extern void public_key_destroy(void *payload);

/*
 * Public key cryptography signature data
 */
struct public_key_signature {
	u8 *digest;
	u8 digest_size;			/* Number of bytes in digest */
	u8 nr_mpi;			/* Occupancy of mpi[] */
	enum pkey_algo pkey_algo : 8;
	enum hash_algo pkey_hash_algo : 8;
	union {
		MPI mpi[2];
		struct {
			MPI s;		/* m^d mod n */
		} rsa;
		struct {
			MPI r;
			MPI s;
		} dsa;
	};
};

struct key;
extern int verify_signature(const struct key *key,
			    const struct public_key_signature *sig);

#endif /* _LINUX_PUBLIC_KEY_H */
Commit	Line	Data
a9681bf3 DH	1	/* Asymmetric public-key algorithm definitions
	2	*
	3	* See Documentation/crypto/asymmetric-keys.txt
	4	*
	5	* Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
	6	* Written by David Howells (dhowells@redhat.com)
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public Licence
	10	* as published by the Free Software Foundation; either version
	11	* 2 of the Licence, or (at your option) any later version.
	12	*/
	13
	14	#ifndef _LINUX_PUBLIC_KEY_H
	15	#define _LINUX_PUBLIC_KEY_H
	16
	17	#include <linux/mpi.h>
3fe78ca2	18	#include <crypto/hash_info.h>
a9681bf3 DH	19
	20	enum pkey_algo {
	21	PKEY_ALGO_DSA,
	22	PKEY_ALGO_RSA,
	23	PKEY_ALGO__LAST
	24	};
	25
9abc4e66	26	extern const char *const pkey_algo_name[PKEY_ALGO__LAST];
206ce59a	27	extern const struct public_key_algorithm *pkey_algo[PKEY_ALGO__LAST];
a9681bf3	28
3fe78ca2 DK	29	/* asymmetric key implementation supports only up to SHA224 */
3fe78ca2 DK	30	#define PKEY_HASH__LAST (HASH_ALGO_SHA224 + 1)
a9681bf3 DH	31
	32	enum pkey_id_type {
	33	PKEY_ID_PGP, /* OpenPGP generated key ID */
	34	PKEY_ID_X509, /* X.509 arbitrary subjectKeyIdentifier */
	35	PKEY_ID_TYPE__LAST
	36	};
	37
9abc4e66	38	extern const char *const pkey_id_type_name[PKEY_ID_TYPE__LAST];
a9681bf3 DH	39
	40	/*
	41	* Cryptographic data for the public-key subtype of the asymmetric key type.
	42	*
	43	* Note that this may include private part of the key as well as the public
	44	* part.
	45	*/
	46	struct public_key {
	47	const struct public_key_algorithm *algo;
	48	u8 capabilities;
	49	#define PKEY_CAN_ENCRYPT 0x01
	50	#define PKEY_CAN_DECRYPT 0x02
	51	#define PKEY_CAN_SIGN 0x04
	52	#define PKEY_CAN_VERIFY 0x08
67f7d60b	53	enum pkey_algo pkey_algo : 8;
a9681bf3 DH	54	enum pkey_id_type id_type : 8;
	55	union {
	56	MPI mpi[5];
	57	struct {
	58	MPI p; /* DSA prime */
	59	MPI q; /* DSA group order */
	60	MPI g; /* DSA group generator */
	61	MPI y; /* DSA public-key value = g^x mod p */
	62	MPI x; /* DSA secret exponent (if present) */
	63	} dsa;
	64	struct {
	65	MPI n; /* RSA public modulus */
	66	MPI e; /* RSA public encryption exponent */
	67	MPI d; /* RSA secret encryption exponent (if present) */
	68	MPI p; /* RSA secret prime (if present) */
	69	MPI q; /* RSA secret prime (if present) */
	70	} rsa;
	71	};
	72	};
	73
	74	extern void public_key_destroy(void *payload);
	75
	76	/*
	77	* Public key cryptography signature data
	78	*/
	79	struct public_key_signature {
	80	u8 *digest;
	81	u8 digest_size; /* Number of bytes in digest */
	82	u8 nr_mpi; /* Occupancy of mpi[] */
1573801f	83	enum pkey_algo pkey_algo : 8;
3fe78ca2	84	enum hash_algo pkey_hash_algo : 8;
a9681bf3 DH	85	union {
	86	MPI mpi[2];
	87	struct {
	88	MPI s; /* m^d mod n */
	89	} rsa;
	90	struct {
	91	MPI r;
	92	MPI s;
	93	} dsa;
	94	};
	95	};
	96
4ae71c1d DH	97	struct key;
	98	extern int verify_signature(const struct key *key,
	99	const struct public_key_signature *sig);
	100
a9681bf3	101	#endif /* _LINUX_PUBLIC_KEY_H */