1/*-
2 * Copyright (c) 2015 Allan Jude <allanjude@FreeBSD.org>
3 * Copyright (c) 2005-2011 Pawel Jakub Dawidek <pawel@dawidek.net>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#include <crypto/intake.h>
29
30#ifndef _GELIBOOT_H_
31#define _GELIBOOT_H_
32
33#include <geom/eli/g_eli.h>
34
35#ifndef DEV_BSIZE
36#define DEV_BSIZE 			512
37#endif
38#ifndef DEV_GELIBOOT_BSIZE
39#define DEV_GELIBOOT_BSIZE		4096
40#endif
41
42#ifndef MIN
43#define    MIN(a,b) (((a) < (b)) ? (a) : (b))
44#endif
45
46#define	GELI_MAX_KEYS			64
47#define	GELI_PW_MAXLEN			256
48#define	GELI_KEYBUF_SIZE		(sizeof(struct keybuf) + \
49    (GELI_MAX_KEYS * sizeof(struct keybuf_ent)))
50
51typedef enum geli_op {
52	GELI_DECRYPT,
53	GELI_ENCRYPT
54} geli_op_t;
55
56extern void pwgets(char *buf, int n, int hide);
57
58typedef u_char geli_ukey[G_ELI_USERKEYLEN];
59
60/*
61 * An opaque struct used internally by geliboot functions. Returned by
62 * geli_taste(), a pointer to one of these is essentially a device handle. There
63 * is no need to release or free or "give back" the pointer.
64 */
65struct geli_dev;
66
67/* Forward decls. */
68struct open_file;
69struct preloaded_file;
70
71/*
72 * Low-level interface, used by early-stage bootloaders...
73 */
74
75/* Read callback function type for geli_taste(). */
76typedef int (*geli_readfunc)(void *vdev, void *readpriv, off_t offbytes,
77    void *buf, size_t sizebytes);
78
79struct geli_dev *geli_taste(geli_readfunc readfunc, void *readpriv,
80    daddr_t lastsector, const char *namefmt, ...);
81int geli_io(struct geli_dev *gdev, geli_op_t, off_t offset, u_char *buf,
82    size_t bytes);
83int geli_havekey(struct geli_dev *gdev);
84int geli_passphrase(struct geli_dev *gdev, char *pw);
85
86/*
87 * Libsa device-and-file-level interface.
88 */
89void geli_probe_and_attach(struct open_file *f);
90
91/*
92 * Manage key data.
93 */
94void geli_add_key(geli_ukey key);
95void geli_import_key_buffer(struct keybuf *keybuf);
96void geli_export_key_buffer(struct keybuf *keybuf);
97void geli_export_key_metadata(struct preloaded_file *kfp);
98
99#endif /* _GELIBOOT_H_ */
100