1 /* $OpenBSD: uvm_swap_encrypt.h,v 1.7 2002/07/02 19:38:55 nate Exp $ */
2
3 /*
4 * Copyright 1999 Niels Provos <provos@citi.umich.edu>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Niels Provos.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef _UVM_SWAP_ENCRYPT_H
34 #define _UVM_SWAP_ENCRYPT_H
35
36 #define SWPENC_ENABLE 0
37 #define SWPENC_CREATED 1
38 #define SWPENC_DELETED 2
39 #define SWPENC_MAXID 3
40
41 #define CTL_SWPENC_NAMES { \
42 { "enable", CTLTYPE_INT }, \
43 { "keyscreated", CTLTYPE_INT }, \
44 { "keysdeleted", CTLTYPE_INT }, \
45 }
46
47 #define SWAP_KEY_EXPIRE (120 /*60 * 60*/) /* time after that keys expire */
48 #define SWAP_KEY_SIZE 4 /* 128-bit keys */
49
50 struct swap_key {
51 u_int32_t key[SWAP_KEY_SIZE]; /* secret key for swap range */
52 u_int16_t refcount; /* pages that still need it */
53 };
54
55 int swap_encrypt_ctl(int *, u_int, void *, size_t *, void *, size_t,
56 struct proc *);
57
58 void swap_encrypt(struct swap_key *,caddr_t, caddr_t, u_int64_t, size_t);
59 void swap_decrypt(struct swap_key *,caddr_t, caddr_t, u_int64_t, size_t);
60
61 void swap_key_cleanup(struct swap_key *);
62 void swap_key_prepare(struct swap_key *, int);
63
64 #define SWAP_KEY_GET(s,x) do { if ((x)->refcount == 0) {\
65 swap_key_create(x); \
66 } \
67 (x)->refcount++; } while(0);
68 #define SWAP_KEY_PUT(s,x) do { (x)->refcount--; \
69 if ((x)->refcount == 0) { \
70 swap_key_delete(x); \
71 } \
72 } while(0);
73
74 void swap_key_create(struct swap_key *);
75 void swap_key_delete(struct swap_key *);
76
77 extern int uvm_doswapencrypt; /* swapencrypt enabled/disabled */
78 extern int uvm_swprekeyprint;
79 extern u_int uvm_swpkeyexpire; /* expiry time for keys (tR) */
80 extern int swap_encrypt_initialized;
81
82 #endif /* _UVM_SWAP_ENCRYPT_H */