signature.h revision 1.18
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
50/** \file
51 */
52
53#ifndef SIGNATURE_H_
54#define SIGNATURE_H_
55
56#include <sys/types.h>
57
58#include <inttypes.h>
59
60#include "packet.h"
61#include "create.h"
62#include "memory.h"
63
64typedef struct __ops_create_sig_t	 __ops_create_sig_t;
65
66__ops_create_sig_t *__ops_create_sig_new(void);
67void __ops_create_sig_delete(__ops_create_sig_t *);
68
69unsigned __ops_check_useridcert_sig(const __ops_pubkey_t *,
70			  const __ops_userid_t *,
71			  const __ops_sig_t *,
72			  const __ops_pubkey_t *,
73			  const uint8_t *);
74unsigned __ops_check_userattrcert_sig(const __ops_pubkey_t *,
75			  const __ops_userattr_t *,
76			  const __ops_sig_t *,
77			  const __ops_pubkey_t *,
78			  const uint8_t *);
79unsigned __ops_check_subkey_sig(const __ops_pubkey_t *,
80			   const __ops_pubkey_t *,
81			   const __ops_sig_t *,
82			   const __ops_pubkey_t *,
83			   const uint8_t *);
84unsigned __ops_check_direct_sig(const __ops_pubkey_t *,
85			   const __ops_sig_t *,
86			   const __ops_pubkey_t *,
87			   const uint8_t *);
88unsigned __ops_check_hash_sig(__ops_hash_t *,
89			 const __ops_sig_t *,
90			 const __ops_pubkey_t *);
91void __ops_sig_start_key_sig(__ops_create_sig_t *,
92				  const __ops_pubkey_t *,
93				  const __ops_userid_t *,
94				  __ops_sig_type_t);
95void __ops_start_sig(__ops_create_sig_t *,
96			const __ops_seckey_t *,
97			const __ops_hash_alg_t,
98			const __ops_sig_type_t);
99
100void __ops_sig_add_data(__ops_create_sig_t *, const void *, size_t);
101__ops_hash_t *__ops_sig_get_hash(__ops_create_sig_t *);
102unsigned   __ops_end_hashed_subpkts(__ops_create_sig_t *);
103unsigned __ops_write_sig(__ops_output_t *, __ops_create_sig_t *,
104			const __ops_pubkey_t *, const __ops_seckey_t *);
105unsigned   __ops_add_birthtime(__ops_create_sig_t *, time_t);
106unsigned __ops_add_expiration(__ops_create_sig_t *, time_t);
107unsigned __ops_add_issuer_keyid(__ops_create_sig_t *,
108			const uint8_t *);
109void __ops_add_primary_userid(__ops_create_sig_t *, unsigned);
110
111/* Standard Interface */
112unsigned   __ops_sign_file(__ops_io_t *,
113			const char *,
114			const char *,
115			const __ops_seckey_t *,
116			const char *,
117			const int64_t,
118			const uint64_t,
119			const unsigned,
120			const unsigned,
121			const unsigned);
122
123int __ops_sign_detached(__ops_io_t *,
124			const char *,
125			char *,
126			__ops_seckey_t *,
127			const char *,
128			const int64_t,
129			const uint64_t,
130			const unsigned,
131			const unsigned);
132
133/* armoured stuff */
134unsigned __ops_crc24(unsigned, uint8_t);
135
136void __ops_reader_push_dearmour(__ops_stream_t *);
137
138void __ops_reader_pop_dearmour(__ops_stream_t *);
139unsigned __ops_writer_push_clearsigned(__ops_output_t *, __ops_create_sig_t *);
140void __ops_writer_push_armor_msg(__ops_output_t *);
141
142typedef enum {
143	OPS_PGP_MESSAGE = 1,
144	OPS_PGP_PUBLIC_KEY_BLOCK,
145	OPS_PGP_PRIVATE_KEY_BLOCK,
146	OPS_PGP_MULTIPART_MESSAGE_PART_X_OF_Y,
147	OPS_PGP_MULTIPART_MESSAGE_PART_X,
148	OPS_PGP_SIGNATURE
149} __ops_armor_type_t;
150
151#define CRC24_INIT 0xb704ceL
152
153unsigned __ops_writer_use_armored_sig(__ops_output_t *);
154
155void __ops_writer_push_armoured(__ops_output_t *, __ops_armor_type_t);
156
157__ops_memory_t   *__ops_sign_buf(__ops_io_t *,
158				const void *,
159				const size_t,
160				const __ops_seckey_t *,
161				const int64_t,
162				const uint64_t,
163				const char *,
164				const unsigned,
165				const unsigned);
166
167unsigned __ops_keyring_read_from_mem(__ops_io_t *,
168				__ops_keyring_t *,
169				const unsigned,
170				__ops_memory_t *);
171
172#endif /* SIGNATURE_H_ */
173