Debian Codegraph @

cextern/xpa/man/mann/xpaacl.n

raw
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 . de IX
53 . tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 . nr % 0
56 . rr F
57 .\}
58 .el \{\
59 . de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
66 .if n \{\
67 . ds #H 0
68 . ds #V .8m
69 . ds #F .3m
70 . ds #[ \f1
71 . ds #] \fP
72 .\}
73 .if t \{\
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 . ds #V .6m
76 . ds #F 0
77 . ds #[ \&
78 . ds #] \&
79 .\}
80 . \" simple accents for nroff and troff
81 .if n \{\
82 . ds ' \&
83 . ds ` \&
84 . ds ^ \&
85 . ds , \&
86 . ds ~ ~
87 . ds /
88 .\}
89 .if t \{\
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 . ds : e
114 . ds 8 ss
115 . ds o a
116 . ds d- d\h'-1'\(ga
117 . ds D- D\h'-1'\(hy
118 . ds th \o'bp'
119 . ds Th \o'LP'
120 . ds ae ae
121 . ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "xpaacl n"
127 .TH xpaacl n "July 23, 2013" "version 2.1.15" "SAORD Documentation"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 \&\fBXPAAcl: Access Control for \s-1XPA\s0 Messaging\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\s-1XPA\s0 supports host-based access control for each \s-1XPA\s0 access point. You
137 can enable/disable access control using the \s-1XPA_ACL\s0 environment
138 variable. You can specify access to specific \s-1XPA\s0 access points for
139 specific machines using the \s-1XPA_DEFACL\s0 and \s-1XPA_ACLFILE\s0 environment
140 variables. By default, an \s-1XPA\s0 access point is accessible only to
141 processes running on the same machine (same as X Windows).
142 .SH "DESCRIPTION"
143 .IX Header "DESCRIPTION"
144 When \s-1INET\s0 sockets are in use (the default, as specified by the
145 \&\fI\s-1XPA_METHOD\s0\fR environment variable), \s-1XPA\s0 supports a host-based
146 access control mechanism for individual access points. This mean that
147 access can be specified for get, set, or info operations for each
148 access point on a machine by machine basis. For \s-1LOCAL\s0 sockets, access
149 is restricted (by definition) to the host machine.
150 .PP
151 \&\s-1XPA\s0 access control is enabled by default, but can be turned off by
152 setting the \fI\s-1XPA_ACL\s0\fR environment variable to \fIfalse\fR.
153 In this case, any process can access any \s-1XPA\s0 server.
154 .PP
155 Assuming that access control is turned on, the \s-1ACL\s0 for an individual
156 \&\s-1XPA\s0 access point is set up when that access point is registered
157 (although it can be changed later on; see below). This can be done in
158 one of two ways:
159 .PP
160 Firstly, the \fI\s-1XPA_ACLFILE\s0\fR environment variable can defined to
161 point to a file of access controls for individual access points. The format
162 of this file is:
163 .PP
164 .Vb 1
165 \& class:name ip acl
166 .Ve
167 .PP
168 The first argument is a template that specifies the class:name of the
169 access point covered by this \s-1ACL\s0. See
170 \&\s-1XPA\s0 Access Points and Templates
171 for more information about xpa templates.
172 .PP
173 The second argument is the \s-1IP\s0 address (in human-readable format) of
174 the machine which is being given access. This argument can be
175 \&\fI*\fR to match all \s-1IP\s0 addresses. It also can be \fI\f(CI$host\fI\fR
176 to match the \s-1IP\s0 address of the current host.
177 .PP
178 The third argument is a string combination of \fIs\fR, \fIg\fR,
179 or \fIi\fR to allow \fIxpaset\fR, \fIxpaget\fR, or
180 \&\fIxpainfo\fR access respectively. The \s-1ACL\s0 argument can be
181 \&\fI+\fR to give \fIsgi\fR access or it can be \fI\-\fR to turn
182 off all access.
183 .PP
184 For example,
185 .PP
186 .Vb 3
187 \& *:xpa1 somehost sg
188 \& *:xpa1 myhost +
189 \& * * g
190 .Ve
191 .PP
192 will allow processes on the machine somehost to make xpaget and xpaset calls,
193 allow processes on myhost to make any call, and allow all other hosts to
194 make xpaget (but not xpaset) calls.
195 .PP
196 Secondly, if the \fI\s-1XPA_ACLFILE\s0\fR does not exist, then a single
197 default value for all access points can be specified using the
198 \&\fI\s-1XPA_DEFACL\s0\fR environment variable. The default value for this
199 variable is:
200 .PP
201 .Vb 1
202 \& #define XPA_DEFACL "*:* $host +"
203 .Ve
204 .PP
205 meaning that all access points are fully accessible to all processes
206 on the current host. Thus, in the absence of any \s-1ACL\s0 environment variables,
207 processes on the current host have full access to all access points
208 created on that host. This parallels the X11 xhost mechanism.
209 .PP
210 Access to an individual \s-1XPA\s0 access point can be changed using the \-acl
211 parameter for that access point. For example:
212 .PP
213 .Vb 1
214 \& xpaset \-p xpa1 \-acl "somehost \-"
215 .Ve
216 .PP
217 will turn off all access control for somehost to the xpa1 access point, while:
218 .PP
219 .Vb 1
220 \& xpaset \-p XPA:xpa1 \-acl "beberly gs"
221 .Ve
222 .PP
223 will give beberly xpaget and xpaset access to the access point whose
224 class is \s-1XPA\s0 and whose name is xpa1.
225 .PP
226 Similarly, the current \s-1ACL\s0 for a given access point can be retrieved using:
227 .PP
228 .Vb 1
229 \& xpaget xpa1 \-acl
230 .Ve
231 .PP
232 Of course, you must have xpaget access to this \s-1XPA\s0 access point to
233 retrieve its \s-1ACL\s0.
234 .PP
235 Note that the \s-1XPA\s0 access points registered in the \fIxpans\fR
236 program also behave according to the \s-1ACL\s0 rules. That is, you cannot
237 use xpaget to view the access points registered with xpans unless
238 you have the proper \s-1ACL\s0.
239 .PP
240 Note also when a client request is made to an \s-1XPA\s0 server, the access
241 control is checked when the initial connection is established. This
242 access in effect at this time remains in effect so long as the client
243 connection is maintained, regardless of whether the access fro that
244 \&\s-1XPA\s0 is changed later on.
245 .PP
246 We recognize that host-based access control is only relatively secure
247 and will consider more stringent security (e.g., private key) in the
248 future if the community requires such support.
249 .SH "SEE ALSO"
250 .IX Header "SEE ALSO"
251 See xpa(n) for a list of \s-1XPA\s0 help pages