aboutsummaryrefslogtreecommitdiffstats
path: root/src/dbinit.h
blob: a546575007d64ad72ed3fe1b5e7b5228fe979bf6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/*
 * Copyright (C) 2018 "IoT.bzh"
 * Author José Bollo <jose.bollo@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
/******************************************************************************/
/******************************************************************************/
/* READING DATABASE RULE FILES FOR INITIALISATION                             */
/******************************************************************************/
/******************************************************************************/

/**
 * Add to the database the data from file of 'path'
 *
 * ---------------------------------------------------------------------------
 * The file must be made of lines being either empty, comment or rule
 *
 * Empty lines or comment lines are ignored.
 *
 * An empty line only contains spaces and/or tabs
 *
 * A comment line start with the character #. It can be preceded by any count
 * of spaces and/or tabs.
 *
 * Other lines are rules. They must be made of 6 fields separated by any count
 * of space and/or tabs. Spaces and tabs at the begining of the line are
 * ignored.
 *
 * The 6 fields of a rule are:
 *
 *       CLIENT SESSION USER PERMISSION VALUE EXPIRATION
 *
 * CLIENT, SESSION, USER, PERMISSION are arbitrary strings. The single star
 * mean 'any value'.
 *
 * Value must be a string of some meaning. Known values are:
 *
 *   - yes:   grant the permission
 *   - no:    forbid the permission
 *   - @:...: agent at (@)
 *
 * Expiration can be expressed
 *
 * ---------------------------------------------------------------------------
 *
 * @param path path of the initialization file
 * @return 0 in case of success or a negative -errno like code
 */
extern
int
dbinit_add_file(
	const char *path
);