session: add support for saving and restoring session data to disk
[project/rpcd.git] / include / rpcd / session.h
1 /*
2  * rpcd - UBUS RPC server
3  *
4  *   Copyright (C) 2013 Felix Fietkau <nbd@openwrt.org>
5  *   Copyright (C) 2013 Jo-Philipp Wich <jow@openwrt.org>
6  *
7  * Permission to use, copy, modify, and/or distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19
20 #ifndef __RPC_SESSION_H
21 #define __RPC_SESSION_H
22
23 #include <ctype.h>
24 #include <fcntl.h>
25 #include <dirent.h>
26 #include <unistd.h>
27 #include <sys/stat.h>
28 #include <sys/types.h>
29
30 #include <libubox/avl.h>
31 #include <libubox/blobmsg_json.h>
32
33 #define RPC_SID_LEN     32
34 #define RPC_DEFAULT_SESSION_TIMEOUT     300
35 #define RPC_SESSION_DIRECTORY   "/var/run/rpcd"
36
37 struct rpc_session {
38         struct avl_node avl;
39         char id[RPC_SID_LEN + 1];
40
41         struct uloop_timeout t;
42         struct avl_tree data;
43         struct avl_tree acls;
44
45         int timeout;
46 };
47
48 struct rpc_session_data {
49         struct avl_node avl;
50         struct blob_attr attr[];
51 };
52
53 struct rpc_session_acl_scope {
54         struct avl_node avl;
55         struct avl_tree acls;
56 };
57
58 struct rpc_session_acl {
59         struct avl_node avl;
60         const char *object;
61         const char *function;
62         int sort_len;
63 };
64
65 int rpc_session_api_init(struct ubus_context *ctx);
66
67 bool rpc_session_access(const char *sid, const char *scope,
68                         const char *object, const char *function);
69
70 struct rpc_session_cb {
71         struct list_head list;
72         void (*cb)(struct rpc_session *, void *);
73         void *priv;
74 };
75
76 void rpc_session_create_cb(struct rpc_session_cb *cb);
77 void rpc_session_destroy_cb(struct rpc_session_cb *cb);
78
79 void rpc_session_freeze(void);
80 void rpc_session_thaw(void);
81
82 #endif