blob: 95d27b95d0329188f70ad483bec7762e0e923e77 (
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/*
* Copyright (c) 2014-2015 Samsung Electronics Co., Ltd All Rights Reserved
*
* 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
*/
/**
* \file src/include/cynara-admin-types.h
* \author Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
* \author Aleksander Zdyb <a.zdyb@samsung.com>
* \author Zofia Abramowska <z.abramowska@samsung.com>
* \author Oskar Switalski <o.switalski@samsung.com>
* \version 1.0
* \brief This file contains structs and consts for cynara admin.
*/
#ifndef CYNARA_ADMIN_TYPES_H
#define CYNARA_ADMIN_TYPES_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* \struct cynara_admin_policy
* \brief Defines single policy
*/
struct cynara_admin_policy {
char *bucket; /**< Name of bucket, in which policy is placed */
char *client; /**< Identifier of client (application) */
char *user; /**< Identifier of user */
char *privilege; /**< Privilege name */
int result; /**< Result of policy */
char *result_extra; /**< Not always used, may contain some additional result data
like e.g. name of bucket in case result == CYNARA_ADMIN_BUCKET */
};
/**
* \struct cynara_admin_policy_descr
* \brief Describes policy of type given with result
*/
struct cynara_admin_policy_descr {
int result; /**< Result of policy to describe */
char *name; /**< Descriptive name of given policy result */
};
/**
* \name Wildcard
* Can replace client, user or privilege name.
* WILDCARD matches any string during check procedure from libcynara-client.
*/
#define CYNARA_ADMIN_WILDCARD "*"
/**
* \name Name of Default Bucket
* Default bucket - the one that check starts in.
* Default bucket cannot be removed, although its default policy
* (which originally is set to DENY) can be changed.
*/
#define CYNARA_ADMIN_DEFAULT_BUCKET ""
/**
* \name Any
* Can replace client, user or privilege name.
* ANY matches any string (including WILDCARD) during:
*
* * policy removal with cynara_admin_erase() function
* * listing policies from a single bucket.
*
* Using ANY as default policy for bucket or as policy type of inserted policy record
* is forbidden and will cause CYNARA_API_INVALID_PARAM error.
*/
#define CYNARA_ADMIN_ANY "#"
#ifdef __cplusplus
}
#endif
#endif /* CYNARA_ADMIN_TYPES_H */
|
