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
92
93
94
95
96
97
98
99
|
/*
* ID Mapping Plugin interface for cifs-utils
* Copyright (C) 2012 Jeff Layton (jlayton@samba.org)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <stdint.h>
#ifndef _CIFSIDMAP_H
#define _CIFSIDMAP_H
#define NUM_AUTHS (6) /* number of authority fields */
#define SID_MAX_SUB_AUTHORITIES (15) /* max number of sub authority fields */
/*
* Binary representation of a SID as presented to/from the kernel. Note that
* the sub_auth field is always stored in little-endian here.
*/
struct cifs_sid {
uint8_t revision; /* revision level */
uint8_t num_subauth;
uint8_t authority[NUM_AUTHS];
uint32_t sub_auth[SID_MAX_SUB_AUTHORITIES];
} __attribute__((packed));
/* Plugins should implement the following functions: */
/**
* cifs_idmap_init_plugin - Initialize the plugin interface
* @handle - return pointer for an opaque handle
* @errmsg - pointer to error message pointer
*
* This function should do whatever is required to establish a context
* for later ID mapping operations. The "handle" is an opaque context
* cookie that will be passed in on subsequent ID mapping operations.
* The errmsg is used to pass back an error string both during the init
* and in subsequent idmapping functions. On any error, the plugin
* should point *errmsg at a string describing that error. Returns 0
* on success and non-zero on error.
*
* int cifs_idmap_init_plugin(void **handle, const char **errmsg);
*/
/**
* cifs_idmap_exit_plugin - Destroy an idmapping context
* @handle - context handle that should be destroyed
*
* When programs are finished with the idmapping plugin, they'll call
* this function to destroy any context that was created during the
* init_plugin. The handle passed back in was the one given by the init
* routine.
*
* void cifs_idmap_exit_plugin(void *handle);
*/
/**
* cifs_idmap_sid_to_str - convert cifs_sid to a string
* @handle - context handle
* @sid - pointer to a cifs_sid
* @name - return pointer for the name
*
* This function should convert the given cifs_sid to a string
* representation or mapped name in a heap-allocated buffer. The caller
* of this function is expected to free "name" on success. Returns 0 on
* success and non-zero on error. On error, the errmsg pointer passed
* in to the init_plugin function should point to an error string.
*
* int cifs_idmap_sid_to_str(void *handle, const struct cifs_sid *sid,
* char **name);
*/
/**
* cifs_idmap_str_to_sid - convert string to struct cifs_sid
* @handle - context handle
* @name - pointer to name string to be converted
* @sid - pointer to struct cifs_sid where result should go
*
* This function converts a name string or string representation of
* a SID to a struct cifs_sid. The cifs_sid should already be
* allocated. Returns 0 on success and non-zero on error. On error, the
* plugin should reset the errmsg pointer passed to the init_plugin
* function to an error string.
*
* int cifs_idmap_str_to_sid(void *handle, const char *name,
* struct cifs_sid *sid);
*/
#endif /* _CIFSIDMAP_H */
|
