Clarify documentation of password quality check modules
[heimdal.git] / lib / hx509 / peer.c
blobc796e19173666721200929cf926b806e88b1eb64
1 /*
2 * Copyright (c) 2006 - 2007 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
34 #include "hx_locl.h"
36 /**
37 * @page page_peer Hx509 crypto selecting functions
39 * Peer info structures are used togeter with hx509_crypto_select() to
40 * select the best avaible crypto algorithm to use.
42 * See the library functions here: @ref hx509_peer
45 /**
46 * Allocate a new peer info structure an init it to default values.
48 * @param context A hx509 context.
49 * @param peer return an allocated peer, free with hx509_peer_info_free().
51 * @return An hx509 error code, see hx509_get_error_string().
53 * @ingroup hx509_peer
56 int
57 hx509_peer_info_alloc(hx509_context context, hx509_peer_info *peer)
59 *peer = calloc(1, sizeof(**peer));
60 if (*peer == NULL) {
61 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
62 return ENOMEM;
64 return 0;
68 static void
69 free_cms_alg(hx509_peer_info peer)
71 if (peer->val) {
72 size_t i;
73 for (i = 0; i < peer->len; i++)
74 free_AlgorithmIdentifier(&peer->val[i]);
75 free(peer->val);
76 peer->val = NULL;
77 peer->len = 0;
81 /**
82 * Free a peer info structure.
84 * @param peer peer info to be freed.
86 * @ingroup hx509_peer
89 void
90 hx509_peer_info_free(hx509_peer_info peer)
92 if (peer == NULL)
93 return;
94 if (peer->cert)
95 hx509_cert_free(peer->cert);
96 free_cms_alg(peer);
97 memset(peer, 0, sizeof(*peer));
98 free(peer);
102 * Set the certificate that remote peer is using.
104 * @param peer peer info to update
105 * @param cert cerificate of the remote peer.
107 * @return An hx509 error code, see hx509_get_error_string().
109 * @ingroup hx509_peer
113 hx509_peer_info_set_cert(hx509_peer_info peer,
114 hx509_cert cert)
116 if (peer->cert)
117 hx509_cert_free(peer->cert);
118 peer->cert = hx509_cert_ref(cert);
119 return 0;
123 * Add an additional algorithm that the peer supports.
125 * @param context A hx509 context.
126 * @param peer the peer to set the new algorithms for
127 * @param val an AlgorithmsIdentier to add
129 * @return An hx509 error code, see hx509_get_error_string().
131 * @ingroup hx509_peer
135 hx509_peer_info_add_cms_alg(hx509_context context,
136 hx509_peer_info peer,
137 const AlgorithmIdentifier *val)
139 void *ptr;
140 int ret;
142 ptr = realloc(peer->val, sizeof(peer->val[0]) * (peer->len + 1));
143 if (ptr == NULL) {
144 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
145 return ENOMEM;
147 ret = copy_AlgorithmIdentifier(val, &peer->val[peer->len]);
148 if (ret == 0)
149 peer->len += 1;
150 else
151 hx509_set_error_string(context, 0, ret, "out of memory");
152 return ret;
156 * Set the algorithms that the peer supports.
158 * @param context A hx509 context.
159 * @param peer the peer to set the new algorithms for
160 * @param val array of supported AlgorithmsIdentiers
161 * @param len length of array val.
163 * @return An hx509 error code, see hx509_get_error_string().
165 * @ingroup hx509_peer
169 hx509_peer_info_set_cms_algs(hx509_context context,
170 hx509_peer_info peer,
171 const AlgorithmIdentifier *val,
172 size_t len)
174 size_t i;
176 free_cms_alg(peer);
178 peer->val = calloc(len, sizeof(*peer->val));
179 if (peer->val == NULL) {
180 peer->len = 0;
181 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
182 return ENOMEM;
184 peer->len = len;
185 for (i = 0; i < len; i++) {
186 int ret;
187 ret = copy_AlgorithmIdentifier(&val[i], &peer->val[i]);
188 if (ret) {
189 hx509_clear_error_string(context);
190 free_cms_alg(peer);
191 return ret;
194 return 0;
197 #if 0
200 * S/MIME
204 hx509_peer_info_parse_smime(hx509_peer_info peer,
205 const heim_octet_string *data)
207 return 0;
211 hx509_peer_info_unparse_smime(hx509_peer_info peer,
212 heim_octet_string *data)
214 return 0;
218 * For storing hx509_peer_info to be able to cache them.
222 hx509_peer_info_parse(hx509_peer_info peer,
223 const heim_octet_string *data)
225 return 0;
229 hx509_peer_info_unparse(hx509_peer_info peer,
230 heim_octet_string *data)
232 return 0;
234 #endif