summaryrefslogtreecommitdiff
path: root/usr/src/common/net/wanboot/wanboot_conf.h
blob: 92a0347db6583da801a26707608b4fbca173afb7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_WANBOOT_CONF_H
#define	_WANBOOT_CONF_H

#pragma ident	"%Z%%M%	%I%	%E% SMI"

#include <sys/time.h>
#include <sys/nvpair.h>

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * Valid wanboot.conf(4) names
 */
#define	BC_BOOT_FILE			"boot_file"
#define	BC_ROOT_SERVER			"root_server"
#define	BC_ROOT_FILE			"root_file"
#define	BC_ENCRYPTION_TYPE		"encryption_type"
#define	BC_SIGNATURE_TYPE		"signature_type"
#define	BC_CLIENT_AUTHENTICATION	"client_authentication"
#define	BC_SERVER_AUTHENTICATION	"server_authentication"
#define	BC_BOOT_LOGGER			"boot_logger"
#define	BC_RESOLVE_HOSTS		"resolve_hosts"
#define	BC_SYSTEM_CONF			"system_conf"

/*
 * Valid encryption types
 */
#define	BC_ENCRYPTION_3DES		"3des"
#define	BC_ENCRYPTION_AES		"aes"

/*
 * Valid signature types
 */
#define	BC_SIGNATURE_SHA1		"sha1"

/*
 * Valid yes/no options
 */
#define	BC_YES				"yes"
#define	BC_NO				"no"

/*
 * Define some maximum length for a line in wanboot.conf(4):
 */
#define	BC_MAX_LINE_LENGTH		4096

/*
 * Return codes from init_bootconf(); if BC_FAILURE, the 'bc_error_code'
 * field below gives the reason:
 */
#define	BC_SUCCESS			0
#define	BC_FAILURE			1

/*
 * Possible values of the 'bc_error_code' field below; refer to
 * bootconf_errmsg.c for a description of these codes:
 */
typedef enum {
	BC_E_NOERROR,
	BC_E_ACCESS,
	BC_E_NVLIST,
	BC_E_IOERR,
	BC_E_TOO_LONG,
	BC_E_SYNTAX,
	BC_E_UNKNOWN_NAME,
	BC_E_ENCRYPTION_ILLEGAL,
	BC_E_SIGNATURE_ILLEGAL,
	BC_E_CLIENT_AUTH_ILLEGAL,
	BC_E_SERVER_AUTH_ILLEGAL,
	BC_E_ROOT_SERVER_BAD,
	BC_E_ROOT_SERVER_ABSENT,
	BC_E_ROOT_FILE_ABSENT,
	BC_E_BOOT_LOGGER_BAD,
	BC_E_ENCRYPTED_NOT_SIGNED,
	BC_E_CLIENT_AUTH_NOT_ENCRYPTED,
	BC_E_CLIENT_AUTH_NOT_SERVER,
	BC_E_SERVER_AUTH_NOT_SIGNED,
	BC_E_SERVER_AUTH_NOT_HTTPS,
	BC_E_SERVER_AUTH_NOT_HTTP,
	BC_E_BOOTLOGGER_AUTH_NOT_HTTP
} bc_errcode_t;

/*
 * Structure defining the bootconf context:
 */
typedef struct bc_handle {
	nvlist_t	*bc_nvl;	/* The nvpair list representation */
	bc_errcode_t	bc_error_code;	/* On error, one of the above codes */
	int		bc_error_pos;	/* Line in error in wanboot.conf */
} bc_handle_t;

/*
 * The interfaces to be used when accessing the wanboot.conf file:
 */
extern int	bootconf_init(bc_handle_t *handle, const char *bootconf);
extern char	*bootconf_get(bc_handle_t *handle, const char *name);
extern void	bootconf_end(bc_handle_t *handle);
#if	!defined(_BOOT)
extern char	*bootconf_errmsg(bc_handle_t *handle);
#endif	/* !defined(_BOOT) */

#ifdef	__cplusplus
}
#endif

#endif	/* _WANBOOT_CONF_H */