[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>

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];

enum pkey_hash_algo {
	PKEY_HASH_MD4,
	PKEY_HASH_MD5,
	PKEY_HASH_SHA1,
	PKEY_HASH_RIPE_MD_160,
	PKEY_HASH_SHA256,
	PKEY_HASH_SHA384,
	PKEY_HASH_SHA512,
	PKEY_HASH_SHA224,
	PKEY_HASH__LAST
};

extern const char *const pkey_hash_algo_name[PKEY_HASH__LAST];

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 pkey_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>
	18
	19	enum pkey_algo {
	20	PKEY_ALGO_DSA,
	21	PKEY_ALGO_RSA,
	22	PKEY_ALGO__LAST
	23	};
	24
9abc4e66	25	extern const char *const pkey_algo_name[PKEY_ALGO__LAST];
206ce59a	26	extern const struct public_key_algorithm *pkey_algo[PKEY_ALGO__LAST];
a9681bf3 DH	27
	28	enum pkey_hash_algo {
	29	PKEY_HASH_MD4,
	30	PKEY_HASH_MD5,
	31	PKEY_HASH_SHA1,
	32	PKEY_HASH_RIPE_MD_160,
	33	PKEY_HASH_SHA256,
	34	PKEY_HASH_SHA384,
	35	PKEY_HASH_SHA512,
	36	PKEY_HASH_SHA224,
	37	PKEY_HASH__LAST
	38	};
	39
9abc4e66	40	extern const char *const pkey_hash_algo_name[PKEY_HASH__LAST];
a9681bf3 DH	41
	42	enum pkey_id_type {
	43	PKEY_ID_PGP, /* OpenPGP generated key ID */
	44	PKEY_ID_X509, /* X.509 arbitrary subjectKeyIdentifier */
	45	PKEY_ID_TYPE__LAST
	46	};
	47
9abc4e66	48	extern const char *const pkey_id_type_name[PKEY_ID_TYPE__LAST];
a9681bf3 DH	49
	50	/*
	51	* Cryptographic data for the public-key subtype of the asymmetric key type.
	52	*
	53	* Note that this may include private part of the key as well as the public
	54	* part.
	55	*/
	56	struct public_key {
	57	const struct public_key_algorithm *algo;
	58	u8 capabilities;
	59	#define PKEY_CAN_ENCRYPT 0x01
	60	#define PKEY_CAN_DECRYPT 0x02
	61	#define PKEY_CAN_SIGN 0x04
	62	#define PKEY_CAN_VERIFY 0x08
67f7d60b	63	enum pkey_algo pkey_algo : 8;
a9681bf3 DH	64	enum pkey_id_type id_type : 8;
	65	union {
	66	MPI mpi[5];
	67	struct {
	68	MPI p; /* DSA prime */
	69	MPI q; /* DSA group order */
	70	MPI g; /* DSA group generator */
	71	MPI y; /* DSA public-key value = g^x mod p */
	72	MPI x; /* DSA secret exponent (if present) */
	73	} dsa;
	74	struct {
	75	MPI n; /* RSA public modulus */
	76	MPI e; /* RSA public encryption exponent */
	77	MPI d; /* RSA secret encryption exponent (if present) */
	78	MPI p; /* RSA secret prime (if present) */
	79	MPI q; /* RSA secret prime (if present) */
	80	} rsa;
	81	};
	82	};
	83
	84	extern void public_key_destroy(void *payload);
	85
	86	/*
	87	* Public key cryptography signature data
	88	*/
	89	struct public_key_signature {
	90	u8 *digest;
	91	u8 digest_size; /* Number of bytes in digest */
	92	u8 nr_mpi; /* Occupancy of mpi[] */
1573801f	93	enum pkey_algo pkey_algo : 8;
a9681bf3 DH	94	enum pkey_hash_algo pkey_hash_algo : 8;
	95	union {
	96	MPI mpi[2];
	97	struct {
	98	MPI s; /* m^d mod n */
	99	} rsa;
	100	struct {
	101	MPI r;
	102	MPI s;
	103	} dsa;
	104	};
	105	};
	106
4ae71c1d DH	107	struct key;
	108	extern int verify_signature(const struct key *key,
	109	const struct public_key_signature *sig);
	110
a9681bf3	111	#endif /* _LINUX_PUBLIC_KEY_H */