332d52d52eaaedae6ac154ae8395432760f02358
[strongswan.git] / src / libstrongswan / credentials / builder.h
1 /*
2 * Copyright (C) 2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup builder builder
18 * @{ @ingroup credentials
19 */
20
21 #ifndef BUILDER_H_
22 #define BUILDER_H_
23
24 typedef struct builder_t builder_t;
25 typedef enum builder_part_t builder_part_t;
26
27 /**
28 * Constructor function which creates a new builder instance.
29 *
30 * @param subtype constructor specific subtype, e.g. certificate_type_t
31 * @return builder to construct a instance of type
32 */
33 typedef builder_t* (*builder_constructor_t)(int subtype);
34
35 #include <library.h>
36
37 /**
38 * Parts to build credentials from.
39 */
40 enum builder_part_t {
41 /** path to a file containing an ASN1 blob, char* */
42 BUILD_FROM_FILE,
43 /** unix socket of a ssh/pgp agent, char* */
44 BUILD_AGENT_SOCKET,
45 /** DER encoded ASN1 blob, chunk_t */
46 BUILD_BLOB_ASN1_DER,
47 /** PEM encoded ASN1 blob, null terminated char* */
48 BUILD_BLOB_ASN1_PEM,
49 /** key size in bits, as used for key generation, u_int */
50 BUILD_KEY_SIZE,
51 /** private key to use for signing, private_key_t* */
52 BUILD_SIGNING_KEY,
53 /** certificate used for signing, certificate_t* */
54 BUILD_SIGNING_CERT,
55 /** public key to include, public_key_t* */
56 BUILD_PUBLIC_KEY,
57 /** subject for e.g. certificates, identification_t* */
58 BUILD_SUBJECT,
59 /** additional subject name, identification_t* */
60 BUILD_SUBJECT_ALTNAME,
61 /** issuer for e.g. certificates, identification_t* */
62 BUILD_ISSUER,
63 /** additional issuer name, identification_t* */
64 BUILD_ISSUER_ALTNAME,
65 /** notBefore, time_t* */
66 BUILD_NOT_BEFORE_TIME,
67 /** notAfter, time_t* */
68 BUILD_NOT_AFTER_TIME,
69 /** a serial number in binary form, chunk_t */
70 BUILD_SERIAL,
71 /** a comma-separated list of ietf group attributes, char* */
72 BUILD_IETF_GROUP_ATTR,
73 /** a ca certificate, certificate_t* */
74 BUILD_CA_CERT,
75 /** a certificate, certificate_t* */
76 BUILD_CERT,
77 /** enforce an additional X509 flag, x509_flag_t */
78 BUILD_X509_FLAG,
79 /** key ID of a key on a smartcard, null terminated char* ([slot:]keyid) */
80 BUILD_SMARTCARD_KEYID,
81 /** pin to access a key on a smartcard, null terminated char* */
82 BUILD_SMARTCARD_PIN,
83 /** end of variable argument builder list */
84 BUILD_END,
85 };
86
87 /**
88 * enum names for build_part_t
89 */
90 extern enum_name_t *builder_part_names;
91
92 /**
93 * Credential construction API.
94 *
95 * The builder allows the construction of credentials in a generic and
96 * flexible way.
97 */
98 struct builder_t {
99
100 /**
101 * Add a part to the construct.
102 *
103 * Any added parts are cloned/refcounted by the builder implementation, a
104 * caller may need to free the passed ressources themself.
105 *
106 * @param part kind of part
107 * @param ... part specific variable argument
108 */
109 void (*add)(builder_t *this, builder_part_t part, ...);
110
111 /**
112 * Build the construct with all supplied parts.
113 *
114 * Once build() is called, the builder gets destroyed.
115 *
116 * @return specific interface, as requested with constructor.
117 */
118 void* (*build)(builder_t *this);
119 };
120
121 /**
122 * Helper macro to cancel a build in a builder
123 */
124 #define builder_cancel(builder) { (builder)->add = (void*)nop; \
125 (builder)->build = (void*)builder_free; }
126
127 /**
128 * Helper function for a cancelled build.
129 */
130 void* builder_free(builder_t *this);
131
132 #endif /* BUILDER_H_ @}*/