4869c82c0528e82d8fabb6eb2c9bfae8c54b89a4
[oonf.git] / include / oonf / crypto / rfc5444_signature / rfc5444_signature.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 /**
43  * @file
44  */
45
46 #ifndef RFC5444_SIGNATURE_H_
47 #define RFC5444_SIGNATURE_H_
48
49 #include <oonf/libcommon/avl.h>
50 #include <oonf/oonf.h>
51 #include <oonf/crypto/rfc7182_provider/rfc7182_provider.h>
52 #include <oonf/subsystems/oonf_rfc5444.h>
53 #include <oonf/librfc5444/rfc5444_writer.h>
54
55 enum
56 {
57   RFC5444_SIG_MAX_HASHSIZE = RFC5444_MAX_PACKET_SIZE,
58   RFC5444_SIG_MAX_CRYPTSIZE = RFC5444_MAX_PACKET_SIZE,
59 };
60
61 /**
62  * Unique key for a rfc5444 signature
63  */
64 struct rfc5444_signature_key {
65   /*! hash function id */
66   uint8_t hash_function;
67
68   /*! crypto function id */
69   uint8_t crypt_function;
70 };
71
72 /**
73  * results for signature id check
74  */
75 enum rfc5444_sigid_check
76 {
77   /*! signature id is okay */
78   RFC5444_SIGID_OKAY,
79
80   /*! ignore signature id */
81   RFC5444_SIGID_IGNORE,
82
83   /*! drop signature */
84   RFC5444_SIGID_DROP,
85 };
86
87 /**
88  * object representing a registered signature
89  */
90 struct rfc5444_signature {
91   /*! data that makes the unique key of a signature */
92   struct rfc5444_signature_key key;
93
94   /*! true if signature is source specific */
95   bool source_specific;
96
97   /**
98    * function to check key_id field of incoming signatures
99    * @param sig this rfc5444 signature
100    * @param id pointer to key id
101    * @param len length of key id
102    * @return okay, ignore or drop
103    */
104   enum rfc5444_sigid_check (*verify_id)(struct rfc5444_signature *sig, const void *id, size_t len);
105
106   /**
107    * checks if signature applies to a message/packet
108    * @param sig this rfc5444 signature
109    * @param msg_type rfc5444 message type, -1 for packet signature
110    * @return true if signature applies to message type, false otherwise
111    */
112   bool (*is_matching_signature)(struct rfc5444_signature *sig, int msg_type);
113
114   /**
115    * @param sig this rfc5444 signature
116    * @param length pointer to length field for crypto key length
117    * @return pointer to crypto key
118    */
119   const void *(*getCryptoKey)(struct rfc5444_signature *sig, size_t *length);
120
121   /**
122    * @param sig this rfc5444 signature
123    * @param length pointer to length field for key-id length
124    * @return pointer to key-id
125    */
126   const void *(*getKeyId)(struct rfc5444_signature *sig, size_t *length);
127
128   /*! true if message/packet should be dropped if signature is invalid */
129   bool drop_if_invalid;
130
131   /* the following data will be filled by the API */
132
133   /*! source IP address of packet to be signed/checked */
134   const struct netaddr *source;
135
136   /*! pointer to cryptographic hash of signature */
137   struct rfc7182_hash *hash;
138
139   /*! pointer to cryptographic function of signature */
140   struct rfc7182_crypt *crypt;
141
142   /*! true if signature has been validated */
143   bool verified;
144
145   /*! true if signature is essential for the current check */
146   bool _must_be_verified;
147
148   /*! rfc5444 postprocessor to add the signature */
149   struct rfc5444_writer_postprocessor _postprocessor;
150
151   /*! hook into the registered signature tree */
152   struct avl_node _node;
153 };
154
155 /*! subsystem identifier */
156 #define OONF_RFC5444_SIG_SUBSYSTEM "rfc5444_sig"
157
158 EXPORT void rfc5444_sig_add(struct rfc5444_signature *sig);
159 EXPORT void rfc5444_sig_remove(struct rfc5444_signature *sig);
160
161 #endif /* RFC5444_SIGNATURE_H_ */