xref: /netbsd-src/crypto/external/bsd/netpgp/dist/src/lib/validate.h (revision c8da0e5fefd3800856b306200a18b2315c7fbb9f)
1 /*-
2  * Copyright (c) 2009 The NetBSD Foundation, Inc.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to The NetBSD Foundation
6  * by Alistair Crooks (agc@NetBSD.org)
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    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.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 /*
30  * Copyright (c) 2005-2008 Nominet UK (www.nic.uk)
31  * All rights reserved.
32  * Contributors: Ben Laurie, Rachel Willmer. The Contributors have asserted
33  * their moral rights under the UK Copyright Design and Patents Act 1988 to
34  * be recorded as the authors of this copyright work.
35  *
36  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
37  * use this file except in compliance with the License.
38  *
39  * You may obtain a copy of the License at
40  *     http://www.apache.org/licenses/LICENSE-2.0
41  *
42  * Unless required by applicable law or agreed to in writing, software
43  * distributed under the License is distributed on an "AS IS" BASIS,
44  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
45  *
46  * See the License for the specific language governing permissions and
47  * limitations under the License.
48  */
49 #ifndef VALIDATE_H_
50 #define VALIDATE_H_	1
51 
52 typedef struct {
53 	const __ops_keydata_t *key;
54 	unsigned        packet;
55 	unsigned        offset;
56 }               validate_reader_t;
57 
58 /** Struct used with the validate_key_cb callback */
59 typedef struct {
60 	__ops_pubkey_t pubkey;
61 	__ops_pubkey_t subkey;
62 	__ops_seckey_t seckey;
63 	enum {
64 		ATTRIBUTE = 1,
65 		ID
66 	}               last_seen;
67 	__ops_user_id_t   user_id;
68 	__ops_user_attribute_t user_attribute;
69 	unsigned char   hash[OPS_MAX_HASH_SIZE];
70 	const __ops_keyring_t *keyring;
71 	validate_reader_t *rarg;
72 	__ops_validation_t *result;
73 	__ops_parse_cb_return_t(*cb_get_passphrase) (const __ops_packet_t *, __ops_callback_data_t *);
74 }               validate_key_cb_t;
75 
76 /** Struct use with the validate_data_cb callback */
77 typedef struct {
78 	enum {
79 		LITERAL_DATA,
80 		SIGNED_CLEARTEXT
81 	} use;
82 	union {
83 		__ops_litdata_body_t litdata_body;
84 		__ops_cleartext_body_t cleartext_body;
85 	} data;
86 	unsigned char   hash[OPS_MAX_HASH_SIZE];	/* <! the hash */
87 	__ops_memory_t   *mem;
88 	const __ops_keyring_t *keyring;	/* <! keyring to use */
89 	validate_reader_t *rarg;	/* <! reader-specific arg */
90 	__ops_validation_t *result;	/* <! where to put the result */
91 }               validate_data_cb_t;	/* <! used with
92 					 * validate_data_cb callback */
93 
94 void	__ops_keydata_reader_set(__ops_parseinfo_t *, const __ops_keydata_t *);
95 
96 __ops_parse_cb_return_t __ops_validate_key_cb(const __ops_packet_t *,
97 					__ops_callback_data_t *);
98 
99 bool   __ops_validate_file(__ops_validation_t *, const char *, const char *,
100 			const int, const __ops_keyring_t *);
101 bool   __ops_validate_mem(__ops_validation_t *, __ops_memory_t *, const int,
102 			const __ops_keyring_t *);
103 
104 __ops_parse_cb_return_t validate_data_cb(const __ops_packet_t *,
105 				__ops_callback_data_t *);
106 
107 #endif /* !VALIDATE_H_ */
108