A device detection library that is used natively or by 51Degrees products

evidence.h

1/* *********************************************************************
2 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3 * Copyright 2026 51 Degrees Mobile Experts Limited, Davidson House,
4 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
5 *
6 * This Original Work is licensed under the European Union Public Licence
7 * (EUPL) v.1.2 and is subject to its terms as set out below.
8 *
9 * If a copy of the EUPL was not distributed with this file, You can obtain
10 * one at https://opensource.org/licenses/EUPL-1.2.
11 *
12 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
13 * amended by the European Commission) shall be deemed incompatible for
14 * the purposes of the Work and the provisions of the compatibility
15 * clause in Article 5 of the EUPL shall not apply.
16 *
17 * If using the Work as, or as part of, a network application, by
18 * including the attribution notice(s) required under Article 5 of the EUPL
19 * in the end user terms of the application under an appropriate heading,
20 * such notice(s) shall fulfill the requirements of that article.
21 * ********************************************************************* */
22
23#ifndef FIFTYONE_DEGREES_EVIDENCE_H_INCLUDED
24#define FIFTYONE_DEGREES_EVIDENCE_H_INCLUDED
25
26#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS
27#include "ipiSymbols.h"
28#endif
29
122
123#include <stdint.h>
124#include <stdbool.h>
125#include <stdlib.h>
126#include "data.h"
127#include "ip.h"
128#include "string.h"
129#include "array.h"
130#include "common.h"
131#include "pair.h"
132#include "headers.h"
133
138typedef enum e_fiftyone_degrees_evidence_prefix {
139 FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_STRING = 1 << 0,
141 FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_IP_ADDRESSES = 1 << 1,
147 FIFTYONE_DEGREES_EVIDENCE_SERVER = 1 << 2,
149 FIFTYONE_DEGREES_EVIDENCE_QUERY = 1 << 3,
150 FIFTYONE_DEGREES_EVIDENCE_COOKIE = 1 << 4,
151 FIFTYONE_DEGREES_EVIDENCE_IGNORE = 1 << 7,
153} fiftyoneDegreesEvidencePrefix;
154
156typedef struct fiftyone_degrees_evidence_prefix_map_t {
157 const char *prefix;
158 size_t prefixLength;
159 fiftyoneDegreesEvidencePrefix prefixEnum;
160} fiftyoneDegreesEvidencePrefixMap;
161
165typedef struct fiftyone_degrees_evidence_key_value_pair_t {
166 fiftyoneDegreesEvidencePrefix prefix;
167 fiftyoneDegreesKeyValuePair item;
168 const void *parsedValue;
169 size_t parsedLength;
170 fiftyoneDegreesHeader* header;
172} fiftyoneDegreesEvidenceKeyValuePair;
173
178typedef struct fiftyone_degrees_array_fiftyoneDegreesEvidenceKeyValuePair_t
179 fiftyoneDegreesEvidenceKeyValuePairArray;
180
185#define FIFTYONE_DEGREES_ARRAY_EVIDENCE_MEMBER \
186 fiftyoneDegreesEvidenceKeyValuePairArray *next; \
187 fiftyoneDegreesEvidenceKeyValuePairArray *prev;
188
193FIFTYONE_DEGREES_ARRAY_TYPE(
194 fiftyoneDegreesEvidenceKeyValuePair,
195 FIFTYONE_DEGREES_ARRAY_EVIDENCE_MEMBER)
196
197
203typedef bool(*fiftyoneDegreesEvidenceIterateMethod)(
204 void *state,
205 fiftyoneDegreesEvidenceKeyValuePair *pair);
206
212EXTERNAL fiftyoneDegreesEvidenceKeyValuePairArray*
213 fiftyoneDegreesEvidenceCreate(uint32_t capacity);
214
220EXTERNAL void fiftyoneDegreesEvidenceFree(
221 fiftyoneDegreesEvidenceKeyValuePairArray *evidence);
222
236EXTERNAL fiftyoneDegreesEvidenceKeyValuePair* fiftyoneDegreesEvidenceAddString(
237 fiftyoneDegreesEvidenceKeyValuePairArray *evidence,
238 fiftyoneDegreesEvidencePrefix prefix,
239 const char *key,
240 const char *value);
241
254EXTERNAL fiftyoneDegreesEvidenceKeyValuePair* fiftyoneDegreesEvidenceAddPair(
255 fiftyoneDegreesEvidenceKeyValuePairArray* evidence,
256 fiftyoneDegreesEvidencePrefix prefix,
257 fiftyoneDegreesKeyValuePair pair);
258
264EXTERNAL fiftyoneDegreesEvidencePrefixMap* fiftyoneDegreesEvidenceMapPrefix(
265 const char *key);
266
272EXTERNAL const char* fiftyoneDegreesEvidencePrefixString(
273 fiftyoneDegreesEvidencePrefix prefix);
274
286EXTERNAL uint32_t fiftyoneDegreesEvidenceIterate(
287 fiftyoneDegreesEvidenceKeyValuePairArray *evidence,
288 int prefixes,
289 void *state,
290 fiftyoneDegreesEvidenceIterateMethod callback);
291
321EXTERNAL bool fiftyoneDegreesEvidenceIterateForHeaders(
322 fiftyoneDegreesEvidenceKeyValuePairArray* evidence,
323 int prefixes,
324 fiftyoneDegreesHeaderPtrs* headers,
325 char* const buffer,
326 size_t const length,
327 void* state,
328 fiftyoneDegreesEvidenceIterateMethod callback);
329
333
334#endif
FIFTYONE_DEGREES_ARRAY_TYPE
#define FIFTYONE_DEGREES_ARRAY_TYPE(t, m)
Simple array structure definition macro used for generic types.
Definition array.h:55
fiftyoneDegreesEvidencePrefix
fiftyoneDegreesEvidencePrefix
@
Definition evidence.h:138
FIFTYONE_DEGREES_EVIDENCE_QUERY
@ FIFTYONE_DEGREES_EVIDENCE_QUERY
A query string parameter.
Definition evidence.h:149
FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_IP_ADDRESSES
@ 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:141
FIFTYONE_DEGREES_EVIDENCE_COOKIE
@ FIFTYONE_DEGREES_EVIDENCE_COOKIE
A cookie value.
Definition evidence.h:150
FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_STRING
@ FIFTYONE_DEGREES_EVIDENCE_HTTP_HEADER_STRING
An HTTP header value.
Definition evidence.h:139
FIFTYONE_DEGREES_EVIDENCE_IGNORE
@ FIFTYONE_DEGREES_EVIDENCE_IGNORE
The evidence is invalid and should be ignored.
Definition evidence.h:151
FIFTYONE_DEGREES_EVIDENCE_SERVER
@ FIFTYONE_DEGREES_EVIDENCE_SERVER
A server value e.g.
Definition evidence.h:147
evidence
Definition GettingStarted.c:67
fiftyoneDegreesEvidenceKeyValuePairArray
Array of evidence key value pairs and a pointer to the next array if present or NULL of not present.
Definition evidence.h:195
fiftyoneDegreesEvidenceKeyValuePairArray::capacity
uint32_t capacity
Number of available items.
Definition evidence.h:195
fiftyoneDegreesEvidenceKeyValuePair
Evidence key value pair structure which combines the prefix, key and value.
Definition evidence.h:165
fiftyoneDegreesEvidenceKeyValuePair::parsedLength
size_t parsedLength
length of parsedValue string
Definition evidence.h:169
fiftyoneDegreesEvidenceKeyValuePair::item
fiftyoneDegreesKeyValuePair item
the field key and original value
Definition evidence.h:167
fiftyoneDegreesEvidenceKeyValuePair::prefix
fiftyoneDegreesEvidencePrefix prefix
e.g.
Definition evidence.h:166
fiftyoneDegreesEvidenceKeyValuePair::header
fiftyoneDegreesHeader * header
Unique header in the data set, or null if not related to a header.
Definition evidence.h:170
fiftyoneDegreesEvidenceKeyValuePair::parsedValue
const void * parsedValue
parsed value which may not be a string
Definition evidence.h:168
fiftyoneDegreesEvidencePrefixMap
Map of prefix strings to prefix enum values.
Definition evidence.h:156
fiftyoneDegreesEvidencePrefixMap::prefix
const char * prefix
Name of the prefix.
Definition evidence.h:157
fiftyoneDegreesEvidencePrefixMap::prefixEnum
fiftyoneDegreesEvidencePrefix prefixEnum
Enum value of prefix name.
Definition evidence.h:159
fiftyoneDegreesEvidencePrefixMap::prefixLength
size_t prefixLength
Length of the prefix string.
Definition evidence.h:158
fiftyoneDegreesKeyValuePair
Definition pair.h:33

Have a data or code question? Get in touch and explore subscription options.