algapi.h 10.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * Cryptographic API for algorithms (i.e., low-level API).
 *
 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option) 
 * any later version.
 *
 */
#ifndef _CRYPTO_ALGAPI_H
#define _CRYPTO_ALGAPI_H

#include <linux/crypto.h>
16 17
#include <linux/list.h>
#include <linux/kernel.h>
18
#include <linux/skbuff.h>
19

20
struct module;
21
struct rtattr;
22 23 24
struct seq_file;

struct crypto_type {
25
	unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
26
	unsigned int (*extsize)(struct crypto_alg *alg);
27
	int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
28
	int (*init_tfm)(struct crypto_tfm *tfm);
29
	void (*show)(struct seq_file *m, struct crypto_alg *alg);
30
	int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
31 32 33 34 35 36
	struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask);

	unsigned int type;
	unsigned int maskclear;
	unsigned int maskset;
	unsigned int tfmsize;
37
};
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

struct crypto_instance {
	struct crypto_alg alg;

	struct crypto_template *tmpl;
	struct hlist_node list;

	void *__ctx[] CRYPTO_MINALIGN_ATTR;
};

struct crypto_template {
	struct list_head list;
	struct hlist_head instances;
	struct module *module;

53
	struct crypto_instance *(*alloc)(struct rtattr **tb);
54
	void (*free)(struct crypto_instance *inst);
55
	int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
56 57 58 59

	char name[CRYPTO_MAX_ALG_NAME];
};

Herbert Xu's avatar
Herbert Xu committed
60 61 62 63
struct crypto_spawn {
	struct list_head list;
	struct crypto_alg *alg;
	struct crypto_instance *inst;
64
	const struct crypto_type *frontend;
65
	u32 mask;
Herbert Xu's avatar
Herbert Xu committed
66 67
};

68 69 70 71 72 73 74 75
struct crypto_queue {
	struct list_head list;
	struct list_head *backlog;

	unsigned int qlen;
	unsigned int max_qlen;
};

76 77 78 79 80
struct scatter_walk {
	struct scatterlist *sg;
	unsigned int offset;
};

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
struct blkcipher_walk {
	union {
		struct {
			struct page *page;
			unsigned long offset;
		} phys;

		struct {
			u8 *page;
			u8 *addr;
		} virt;
	} src, dst;

	struct scatter_walk in;
	unsigned int nbytes;

	struct scatter_walk out;
	unsigned int total;

	void *page;
	u8 *buffer;
	u8 *iv;

	int flags;
105
	unsigned int blocksize;
106 107
};

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
struct ablkcipher_walk {
	struct {
		struct page *page;
		unsigned int offset;
	} src, dst;

	struct scatter_walk	in;
	unsigned int		nbytes;
	struct scatter_walk	out;
	unsigned int		total;
	struct list_head	buffers;
	u8			*iv_buffer;
	u8			*iv;
	int			flags;
	unsigned int		blocksize;
};

125
extern const struct crypto_type crypto_ablkcipher_type;
126
extern const struct crypto_type crypto_aead_type;
127 128
extern const struct crypto_type crypto_blkcipher_type;

129 130
void crypto_mod_put(struct crypto_alg *alg);

131 132 133 134
int crypto_register_template(struct crypto_template *tmpl);
void crypto_unregister_template(struct crypto_template *tmpl);
struct crypto_template *crypto_lookup_template(const char *name);

135 136
int crypto_register_instance(struct crypto_template *tmpl,
			     struct crypto_instance *inst);
137
int crypto_unregister_instance(struct crypto_alg *alg);
138

Herbert Xu's avatar
Herbert Xu committed
139
int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
140
		      struct crypto_instance *inst, u32 mask);
141 142 143 144
int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
		       struct crypto_instance *inst,
		       const struct crypto_type *frontend);

Herbert Xu's avatar
Herbert Xu committed
145
void crypto_drop_spawn(struct crypto_spawn *spawn);
146 147
struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
				    u32 mask);
148
void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
Herbert Xu's avatar
Herbert Xu committed
149

150 151 152 153 154 155
static inline void crypto_set_spawn(struct crypto_spawn *spawn,
				    struct crypto_instance *inst)
{
	spawn->inst = inst;
}

156 157
struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
int crypto_check_attr_type(struct rtattr **tb, u32 type);
158
const char *crypto_attr_alg_name(struct rtattr *rta);
159 160 161 162 163 164 165 166 167 168
struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
				    const struct crypto_type *frontend,
				    u32 type, u32 mask);

static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
						 u32 type, u32 mask)
{
	return crypto_attr_alg2(rta, NULL, type, mask);
}

Herbert Xu's avatar
Herbert Xu committed
169
int crypto_attr_u32(struct rtattr *rta, u32 *num);
170 171
void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
			     unsigned int head);
172 173 174
struct crypto_instance *crypto_alloc_instance(const char *name,
					      struct crypto_alg *alg);

175 176 177
void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
int crypto_enqueue_request(struct crypto_queue *queue,
			   struct crypto_async_request *request);
178
void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset);
179 180 181
struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);

182 183 184 185
/* These functions require the input/output to be aligned as u32. */
void crypto_inc(u8 *a, unsigned int size);
void crypto_xor(u8 *dst, const u8 *src, unsigned int size);

186 187 188 189 190 191
int blkcipher_walk_done(struct blkcipher_desc *desc,
			struct blkcipher_walk *walk, int err);
int blkcipher_walk_virt(struct blkcipher_desc *desc,
			struct blkcipher_walk *walk);
int blkcipher_walk_phys(struct blkcipher_desc *desc,
			struct blkcipher_walk *walk);
192 193 194
int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
			      struct blkcipher_walk *walk,
			      unsigned int blocksize);
195

196 197 198 199 200 201
int ablkcipher_walk_done(struct ablkcipher_request *req,
			 struct ablkcipher_walk *walk, int err);
int ablkcipher_walk_phys(struct ablkcipher_request *req,
			 struct ablkcipher_walk *walk);
void __ablkcipher_walk_complete(struct ablkcipher_walk *walk);

202 203
static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
{
204 205
	return PTR_ALIGN(crypto_tfm_ctx(tfm),
			 crypto_tfm_alg_alignmask(tfm) + 1);
206 207
}

208 209 210 211 212 213
static inline struct crypto_instance *crypto_tfm_alg_instance(
	struct crypto_tfm *tfm)
{
	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
}

214 215 216 217 218
static inline void *crypto_instance_ctx(struct crypto_instance *inst)
{
	return inst->__ctx;
}

219 220 221 222 223 224 225 226 227 228 229
static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
	struct crypto_ablkcipher *tfm)
{
	return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
}

static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
{
	return crypto_tfm_ctx(&tfm->base);
}

230 231 232 233 234
static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
{
	return crypto_tfm_ctx_aligned(&tfm->base);
}

235 236 237 238 239
static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
{
	return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
}

Herbert Xu's avatar
Herbert Xu committed
240 241 242 243 244 245 246 247 248 249 250
static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
{
	return crypto_tfm_ctx(&tfm->base);
}

static inline struct crypto_instance *crypto_aead_alg_instance(
	struct crypto_aead *aead)
{
	return crypto_tfm_alg_instance(&aead->base);
}

251 252 253 254
static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
	struct crypto_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
255
	u32 mask = CRYPTO_ALG_TYPE_MASK;
256 257 258 259

	return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
}

260 261 262 263 264 265 266 267 268 269
static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
{
	return crypto_tfm_ctx(&tfm->base);
}

static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
{
	return crypto_tfm_ctx_aligned(&tfm->base);
}

270 271 272 273 274 275 276 277 278
static inline struct crypto_cipher *crypto_spawn_cipher(
	struct crypto_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	u32 mask = CRYPTO_ALG_TYPE_MASK;

	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
}

279 280 281 282 283
static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
{
	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
}

284 285 286 287 288 289 290 291
static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_HASH;
	u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;

	return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
}

292 293 294 295 296
static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
{
	return crypto_tfm_ctx(&tfm->base);
}

297 298 299 300 301
static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
{
	return crypto_tfm_ctx_aligned(&tfm->base);
}

302 303 304 305 306 307 308 309 310 311
static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
				       struct scatterlist *dst,
				       struct scatterlist *src,
				       unsigned int nbytes)
{
	walk->in.sg = src;
	walk->out.sg = dst;
	walk->total = nbytes;
}

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
static inline void ablkcipher_walk_init(struct ablkcipher_walk *walk,
					struct scatterlist *dst,
					struct scatterlist *src,
					unsigned int nbytes)
{
	walk->in.sg = src;
	walk->out.sg = dst;
	walk->total = nbytes;
	INIT_LIST_HEAD(&walk->buffers);
}

static inline void ablkcipher_walk_complete(struct ablkcipher_walk *walk)
{
	if (unlikely(!list_empty(&walk->buffers)))
		__ablkcipher_walk_complete(walk);
}

329 330 331 332 333 334 335
static inline struct crypto_async_request *crypto_get_backlog(
	struct crypto_queue *queue)
{
	return queue->backlog == &queue->list ? NULL :
	       container_of(queue->backlog, struct crypto_async_request, list);
}

336
static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
337 338
					     struct ablkcipher_request *request)
{
339
	return crypto_enqueue_request(queue, &request->base);
340 341 342
}

static inline struct ablkcipher_request *ablkcipher_dequeue_request(
343
	struct crypto_queue *queue)
344
{
345
	return ablkcipher_request_cast(crypto_dequeue_request(queue));
346 347 348 349 350 351 352
}

static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
{
	return req->__ctx;
}

353 354
static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
					  struct crypto_ablkcipher *tfm)
355
{
356
	return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
357 358
}

Herbert Xu's avatar
Herbert Xu committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
static inline void *aead_request_ctx(struct aead_request *req)
{
	return req->__ctx;
}

static inline void aead_request_complete(struct aead_request *req, int err)
{
	req->base.complete(&req->base, err);
}

static inline u32 aead_request_flags(struct aead_request *req)
{
	return req->base.flags;
}

static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
						     u32 type, u32 mask)
{
	return crypto_attr_alg(tb[1], type, mask);
}

380 381 382 383 384 385 386 387 388
/*
 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
 * Otherwise returns zero.
 */
static inline int crypto_requires_sync(u32 type, u32 mask)
{
	return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
}

389 390
#endif	/* _CRYPTO_ALGAPI_H */