51Degrees Common C/C++  4.1

A shared functionality library that is used by 51Degrees products
Search

evidence.h

1 /* *********************************************************************
2  * This Source Code Form is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
4  * Caversham, Reading, Berkshire, United Kingdom RG4 7BY
5  *
6  * This Source Code Form is subject to the terms of the Mozilla Public
7  * License, v. 2.0.
8  *
9  * If a copy of the MPL was not distributed with this file, You can obtain
10  * one at http://mozilla.org/MPL/2.0/.
11  *
12  * This Source Code Form is "Incompatible With Secondary Licenses", as
13  * defined by the Mozilla Public License, v. 2.0.
14  * ******************************************************************** */
15 
16 #ifndef FIFTYONE_DEGREES_EVIDENCE_H_INCLUDED
17 #define FIFTYONE_DEGREES_EVIDENCE_H_INCLUDED
18 
113 #include <stdint.h>
114 #include <stdbool.h>
115 #include <stdlib.h>
116 #include "data.h"
117 #include "ip.h"
118 #include "string.h"
119 #include "array.h"
120 
121 #ifdef __cplusplus
122 #define EXTERNAL extern "C"
123 #else
124 #define EXTERNAL
125 #endif
126 
131 typedef enum e_fiftyone_degrees_evidence_prefix {
132  FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_STRING = 1 << 0,
134  FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_IP_ADDRESSES = 1 << 1,
140  FIFTYONE_DEGREES_EVIDENCE_SERVER = 1 << 2,
142  FIFTYONE_DEGREES_EVIDENCE_QUERY = 1 << 3,
143  FIFTYONE_DEGREES_EVIDENCE_COOKIE = 1 << 4,
144  FIFTYONE_DEGREES_EVIDENCE_IGNORE = 1 << 7,
146 } fiftyoneDegreesEvidencePrefix;
147 
149 typedef struct fiftyone_degrees_evidence_prefix_map_t {
150  const char *prefix;
151  size_t prefixLength;
152  fiftyoneDegreesEvidencePrefix prefixEnum;
153 } fiftyoneDegreesEvidencePrefixMap;
154 
158 typedef struct fiftyone_degrees_evidence_key_value_pair_t {
159  fiftyoneDegreesEvidencePrefix prefix;
160  const char *field;
161  const void *originalValue;
162  const void *parsedValue;
163 } fiftyoneDegreesEvidenceKeyValuePair;
164 
165 FIFTYONE_DEGREES_ARRAY_TYPE(fiftyoneDegreesEvidenceKeyValuePair, )
166 
167 
173 typedef bool(*fiftyoneDegreesEvidenceIterateMethod)(
174  void *state,
175  fiftyoneDegreesEvidenceKeyValuePair *pair);
176 
182 EXTERNAL fiftyoneDegreesEvidenceKeyValuePairArray*
183 fiftyoneDegreesEvidenceCreate(uint32_t capacity);
184 
189 EXTERNAL void fiftyoneDegreesEvidenceFree(
190  fiftyoneDegreesEvidenceKeyValuePairArray *evidence);
191 
201 EXTERNAL fiftyoneDegreesEvidenceKeyValuePair* fiftyoneDegreesEvidenceAddString(
202  fiftyoneDegreesEvidenceKeyValuePairArray *evidence,
203  fiftyoneDegreesEvidencePrefix prefix,
204  const char *field,
205  const char *originalValue);
206 
212 EXTERNAL fiftyoneDegreesEvidencePrefixMap* fiftyoneDegreesEvidenceMapPrefix(
213  const char *key);
214 
224 EXTERNAL uint32_t fiftyoneDegreesEvidenceIterate(
225  fiftyoneDegreesEvidenceKeyValuePairArray *evidence,
226  int prefixes,
227  void *state,
228  fiftyoneDegreesEvidenceIterateMethod callback);
229 
234 #endif
fiftyoneDegreesEvidenceIterateMethod
bool(* fiftyoneDegreesEvidenceIterateMethod)(void *state, fiftyoneDegreesEvidenceKeyValuePair *pair)
Callback method used to iterate evidence key value pairs.
Definition: evidence.h:173
fiftyoneDegreesEvidenceKeyValuePair::prefix
fiftyoneDegreesEvidencePrefix prefix
e.g.
Definition: evidence.h:159
FIFTYONE_DEGREES_EVIDENCE_QUERY
A query string parameter.
Definition: evidence.h:142
fiftyoneDegreesEvidenceKeyValuePair::parsedValue
const void * parsedValue
The parsed value which may not be a string.
Definition: evidence.h:162
fiftyoneDegreesEvidenceKeyValuePair::field
const char * field
e.g.
Definition: evidence.h:160
fiftyoneDegreesEvidenceFree
EXTERNAL void fiftyoneDegreesEvidenceFree(fiftyoneDegreesEvidenceKeyValuePairArray *evidence)
Frees the memory used by an evidence array.
Definition: evidence.c:66
fiftyoneDegreesEvidencePrefixMap::prefixEnum
fiftyoneDegreesEvidencePrefix prefixEnum
Enum value of prefix name.
Definition: evidence.h:152
fiftyoneDegreesEvidencePrefixMap
Map of prefix strings to prefix enum values.
Definition: evidence.h:149
fiftyoneDegreesEvidenceIterate
EXTERNAL uint32_t fiftyoneDegreesEvidenceIterate(fiftyoneDegreesEvidenceKeyValuePairArray *evidence, int prefixes, void *state, fiftyoneDegreesEvidenceIterateMethod callback)
Iterates over the evidence calling the callback method for any values that match the prefixes provide...
Definition: evidence.c:87
FIFTYONE_DEGREES_EVIDENCE_COOKIE
A cookie value.
Definition: evidence.h:143
fiftyoneDegreesEvidenceCreate
EXTERNAL fiftyoneDegreesEvidenceKeyValuePairArray * fiftyoneDegreesEvidenceCreate(uint32_t capacity)
Creates a new evidence array with the capacity requested.
Definition: evidence.c:51
fiftyoneDegreesEvidenceKeyValuePair
Evidence key value pair structure which combines the prefix, key and value.
Definition: evidence.h:158
fiftyoneDegreesEvidencePrefix
fiftyoneDegreesEvidencePrefix
Evidence prefixes used to determine the category a piece of evidence belongs to.
Definition: evidence.h:131
FIFTYONE_DEGREES_EVIDENCE_IGNORE
The evidence is invalid and should be ignored.
Definition: evidence.h:144
fiftyoneDegreesEvidenceMapPrefix
EXTERNAL fiftyoneDegreesEvidencePrefixMap * fiftyoneDegreesEvidenceMapPrefix(const char *key)
Determines the evidence map prefix from the key.
Definition: evidence.c:108
fiftyoneDegreesEvidenceKeyValuePair::originalValue
const void * originalValue
The original unparsed value.
Definition: evidence.h:161
FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_STRING
An HTTP header value.
Definition: evidence.h:132
fiftyoneDegreesEvidenceKeyValuePairArray
Array of items of type fiftyoneDegreesEvidenceKeyValuePair used to easily access and track the size o...
Definition: evidence.h:165
FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_IP_ADDRESSES
A list of IP addresses as a string to be parsed into a IP addresses collection.
Definition: evidence.h:134
fiftyoneDegreesEvidenceAddString
EXTERNAL fiftyoneDegreesEvidenceKeyValuePair * fiftyoneDegreesEvidenceAddString(fiftyoneDegreesEvidenceKeyValuePairArray *evidence, fiftyoneDegreesEvidencePrefix prefix, const char *field, const char *originalValue)
Adds a new entry to the evidence.
Definition: evidence.c:71
FIFTYONE_DEGREES_EVIDENCE_SERVER
A server value e.g.
Definition: evidence.h:140
FIFTYONE_DEGREES_ARRAY_TYPE
#define FIFTYONE_DEGREES_ARRAY_TYPE(t, m)
Simple array structure definition macro used for generic types.
Definition: array.h:41
fiftyoneDegreesEvidencePrefixMap::prefix
const char * prefix
Name of the prefix.
Definition: evidence.h:150
fiftyoneDegreesEvidencePrefixMap::prefixLength
size_t prefixLength
Length of the prefix string.
Definition: evidence.h:151

Generated by doxygen 1.8.15