smack: Add a new '-CIPSO' option to the network address label configuration
[linux-2.6.git] / Documentation / Smack.txt
1
2
3     "Good for you, you've decided to clean the elevator!"
4     - The Elevator, from Dark Star
5
6 Smack is the the Simplified Mandatory Access Control Kernel.
7 Smack is a kernel based implementation of mandatory access
8 control that includes simplicity in its primary design goals.
9
10 Smack is not the only Mandatory Access Control scheme
11 available for Linux. Those new to Mandatory Access Control
12 are encouraged to compare Smack with the other mechanisms
13 available to determine which is best suited to the problem
14 at hand.
15
16 Smack consists of three major components:
17     - The kernel
18     - A start-up script and a few modified applications
19     - Configuration data
20
21 The kernel component of Smack is implemented as a Linux
22 Security Modules (LSM) module. It requires netlabel and
23 works best with file systems that support extended attributes,
24 although xattr support is not strictly required.
25 It is safe to run a Smack kernel under a "vanilla" distribution.
26 Smack kernels use the CIPSO IP option. Some network
27 configurations are intolerant of IP options and can impede
28 access to systems that use them as Smack does.
29
30 The startup script etc-init.d-smack should be installed
31 in /etc/init.d/smack and should be invoked early in the
32 start-up process. On Fedora rc5.d/S02smack is recommended.
33 This script ensures that certain devices have the correct
34 Smack attributes and loads the Smack configuration if
35 any is defined. This script invokes two programs that
36 ensure configuration data is properly formatted. These
37 programs are /usr/sbin/smackload and /usr/sin/smackcipso.
38 The system will run just fine without these programs,
39 but it will be difficult to set access rules properly.
40
41 A version of "ls" that provides a "-M" option to display
42 Smack labels on long listing is available.
43
44 A hacked version of sshd that allows network logins by users
45 with specific Smack labels is available. This version does
46 not work for scp. You must set the /etc/ssh/sshd_config
47 line:
48    UsePrivilegeSeparation no
49
50 The format of /etc/smack/usr is:
51
52    username smack
53
54 In keeping with the intent of Smack, configuration data is
55 minimal and not strictly required. The most important
56 configuration step is mounting the smackfs pseudo filesystem.
57
58 Add this line to /etc/fstab:
59
60     smackfs /smack smackfs smackfsdef=* 0 0
61
62 and create the /smack directory for mounting.
63
64 Smack uses extended attributes (xattrs) to store file labels.
65 The command to set a Smack label on a file is:
66
67     # attr -S -s SMACK64 -V "value" path
68
69 NOTE: Smack labels are limited to 23 characters. The attr command
70       does not enforce this restriction and can be used to set
71       invalid Smack labels on files.
72
73 If you don't do anything special all users will get the floor ("_")
74 label when they log in. If you do want to log in via the hacked ssh
75 at other labels use the attr command to set the smack value on the
76 home directory and it's contents.
77
78 You can add access rules in /etc/smack/accesses. They take the form:
79
80     subjectlabel objectlabel access
81
82 access is a combination of the letters rwxa which specify the
83 kind of access permitted a subject with subjectlabel on an
84 object with objectlabel. If there is no rule no access is allowed.
85
86 A process can see the smack label it is running with by
87 reading /proc/self/attr/current. A privileged process can
88 set the process smack by writing there.
89
90 Look for additional programs on http://schaufler-ca.com
91
92 From the Smack Whitepaper:
93
94 The Simplified Mandatory Access Control Kernel
95
96 Casey Schaufler
97 casey@schaufler-ca.com
98
99 Mandatory Access Control
100
101 Computer systems employ a variety of schemes to constrain how information is
102 shared among the people and services using the machine. Some of these schemes
103 allow the program or user to decide what other programs or users are allowed
104 access to pieces of data. These schemes are called discretionary access
105 control mechanisms because the access control is specified at the discretion
106 of the user. Other schemes do not leave the decision regarding what a user or
107 program can access up to users or programs. These schemes are called mandatory
108 access control mechanisms because you don't have a choice regarding the users
109 or programs that have access to pieces of data.
110
111 Bell & LaPadula
112
113 From the middle of the 1980's until the turn of the century Mandatory Access
114 Control (MAC) was very closely associated with the Bell & LaPadula security
115 model, a mathematical description of the United States Department of Defense
116 policy for marking paper documents. MAC in this form enjoyed a following
117 within the Capital Beltway and Scandinavian supercomputer centers but was
118 often sited as failing to address general needs.
119
120 Domain Type Enforcement
121
122 Around the turn of the century Domain Type Enforcement (DTE) became popular.
123 This scheme organizes users, programs, and data into domains that are
124 protected from each other. This scheme has been widely deployed as a component
125 of popular Linux distributions. The administrative overhead required to
126 maintain this scheme and the detailed understanding of the whole system
127 necessary to provide a secure domain mapping leads to the scheme being
128 disabled or used in limited ways in the majority of cases.
129
130 Smack
131
132 Smack is a Mandatory Access Control mechanism designed to provide useful MAC
133 while avoiding the pitfalls of its predecessors. The limitations of Bell &
134 LaPadula are addressed by providing a scheme whereby access can be controlled
135 according to the requirements of the system and its purpose rather than those
136 imposed by an arcane government policy. The complexity of Domain Type
137 Enforcement and avoided by defining access controls in terms of the access
138 modes already in use.
139
140 Smack Terminology
141
142 The jargon used to talk about Smack will be familiar to those who have dealt
143 with other MAC systems and shouldn't be too difficult for the uninitiated to
144 pick up. There are four terms that are used in a specific way and that are
145 especially important:
146
147         Subject: A subject is an active entity on the computer system.
148         On Smack a subject is a task, which is in turn the basic unit
149         of execution.
150
151         Object: An object is a passive entity on the computer system.
152         On Smack files of all types, IPC, and tasks can be objects.
153
154         Access: Any attempt by a subject to put information into or get
155         information from an object is an access.
156
157         Label: Data that identifies the Mandatory Access Control
158         characteristics of a subject or an object.
159
160 These definitions are consistent with the traditional use in the security
161 community. There are also some terms from Linux that are likely to crop up:
162
163         Capability: A task that possesses a capability has permission to
164         violate an aspect of the system security policy, as identified by
165         the specific capability. A task that possesses one or more
166         capabilities is a privileged task, whereas a task with no
167         capabilities is an unprivileged task.
168
169         Privilege: A task that is allowed to violate the system security
170         policy is said to have privilege. As of this writing a task can
171         have privilege either by possessing capabilities or by having an
172         effective user of root.
173
174 Smack Basics
175
176 Smack is an extension to a Linux system. It enforces additional restrictions
177 on what subjects can access which objects, based on the labels attached to
178 each of the subject and the object.
179
180 Labels
181
182 Smack labels are ASCII character strings, one to twenty-three characters in
183 length. Single character labels using special characters, that being anything
184 other than a letter or digit, are reserved for use by the Smack development
185 team. Smack labels are unstructured, case sensitive, and the only operation
186 ever performed on them is comparison for equality. Smack labels cannot
187 contain unprintable characters or the "/" (slash) character. Smack labels
188 cannot begin with a '-', which is reserved for special options.
189
190 There are some predefined labels:
191
192         _       Pronounced "floor", a single underscore character.
193         ^       Pronounced "hat", a single circumflex character.
194         *       Pronounced "star", a single asterisk character.
195         ?       Pronounced "huh", a single question mark character.
196         @       Pronounced "Internet", a single at sign character.
197
198 Every task on a Smack system is assigned a label. System tasks, such as
199 init(8) and systems daemons, are run with the floor ("_") label. User tasks
200 are assigned labels according to the specification found in the
201 /etc/smack/user configuration file.
202
203 Access Rules
204
205 Smack uses the traditional access modes of Linux. These modes are read,
206 execute, write, and occasionally append. There are a few cases where the
207 access mode may not be obvious. These include:
208
209         Signals: A signal is a write operation from the subject task to
210         the object task.
211         Internet Domain IPC: Transmission of a packet is considered a
212         write operation from the source task to the destination task.
213
214 Smack restricts access based on the label attached to a subject and the label
215 attached to the object it is trying to access. The rules enforced are, in
216 order:
217
218         1. Any access requested by a task labeled "*" is denied.
219         2. A read or execute access requested by a task labeled "^"
220            is permitted.
221         3. A read or execute access requested on an object labeled "_"
222            is permitted.
223         4. Any access requested on an object labeled "*" is permitted.
224         5. Any access requested by a task on an object with the same
225            label is permitted.
226         6. Any access requested that is explicitly defined in the loaded
227            rule set is permitted.
228         7. Any other access is denied.
229
230 Smack Access Rules
231
232 With the isolation provided by Smack access separation is simple. There are
233 many interesting cases where limited access by subjects to objects with
234 different labels is desired. One example is the familiar spy model of
235 sensitivity, where a scientist working on a highly classified project would be
236 able to read documents of lower classifications and anything she writes will
237 be "born" highly classified. To accommodate such schemes Smack includes a
238 mechanism for specifying rules allowing access between labels.
239
240 Access Rule Format
241
242 The format of an access rule is:
243
244         subject-label object-label access
245
246 Where subject-label is the Smack label of the task, object-label is the Smack
247 label of the thing being accessed, and access is a string specifying the sort
248 of access allowed. The Smack labels are limited to 23 characters. The access
249 specification is searched for letters that describe access modes:
250
251         a: indicates that append access should be granted.
252         r: indicates that read access should be granted.
253         w: indicates that write access should be granted.
254         x: indicates that execute access should be granted.
255
256 Uppercase values for the specification letters are allowed as well.
257 Access mode specifications can be in any order. Examples of acceptable rules
258 are:
259
260         TopSecret Secret  rx
261         Secret    Unclass R
262         Manager   Game    x
263         User      HR      w
264         New       Old     rRrRr
265         Closed    Off     -
266
267 Examples of unacceptable rules are:
268
269         Top Secret Secret     rx
270         Ace        Ace        r
271         Odd        spells     waxbeans
272
273 Spaces are not allowed in labels. Since a subject always has access to files
274 with the same label specifying a rule for that case is pointless. Only
275 valid letters (rwxaRWXA) and the dash ('-') character are allowed in
276 access specifications. The dash is a placeholder, so "a-r" is the same
277 as "ar". A lone dash is used to specify that no access should be allowed.
278
279 Applying Access Rules
280
281 The developers of Linux rarely define new sorts of things, usually importing
282 schemes and concepts from other systems. Most often, the other systems are
283 variants of Unix. Unix has many endearing properties, but consistency of
284 access control models is not one of them. Smack strives to treat accesses as
285 uniformly as is sensible while keeping with the spirit of the underlying
286 mechanism.
287
288 File system objects including files, directories, named pipes, symbolic links,
289 and devices require access permissions that closely match those used by mode
290 bit access. To open a file for reading read access is required on the file. To
291 search a directory requires execute access. Creating a file with write access
292 requires both read and write access on the containing directory. Deleting a
293 file requires read and write access to the file and to the containing
294 directory. It is possible that a user may be able to see that a file exists
295 but not any of its attributes by the circumstance of having read access to the
296 containing directory but not to the differently labeled file. This is an
297 artifact of the file name being data in the directory, not a part of the file.
298
299 IPC objects, message queues, semaphore sets, and memory segments exist in flat
300 namespaces and access requests are only required to match the object in
301 question.
302
303 Process objects reflect tasks on the system and the Smack label used to access
304 them is the same Smack label that the task would use for its own access
305 attempts. Sending a signal via the kill() system call is a write operation
306 from the signaler to the recipient. Debugging a process requires both reading
307 and writing. Creating a new task is an internal operation that results in two
308 tasks with identical Smack labels and requires no access checks.
309
310 Sockets are data structures attached to processes and sending a packet from
311 one process to another requires that the sender have write access to the
312 receiver. The receiver is not required to have read access to the sender.
313
314 Setting Access Rules
315
316 The configuration file /etc/smack/accesses contains the rules to be set at
317 system startup. The contents are written to the special file /smack/load.
318 Rules can be written to /smack/load at any time and take effect immediately.
319 For any pair of subject and object labels there can be only one rule, with the
320 most recently specified overriding any earlier specification.
321
322 The program smackload is provided to ensure data is formatted
323 properly when written to /smack/load. This program reads lines
324 of the form
325
326     subjectlabel objectlabel mode.
327
328 Task Attribute
329
330 The Smack label of a process can be read from /proc/<pid>/attr/current. A
331 process can read its own Smack label from /proc/self/attr/current. A
332 privileged process can change its own Smack label by writing to
333 /proc/self/attr/current but not the label of another process.
334
335 File Attribute
336
337 The Smack label of a filesystem object is stored as an extended attribute
338 named SMACK64 on the file. This attribute is in the security namespace. It can
339 only be changed by a process with privilege.
340
341 Privilege
342
343 A process with CAP_MAC_OVERRIDE is privileged.
344
345 Smack Networking
346
347 As mentioned before, Smack enforces access control on network protocol
348 transmissions. Every packet sent by a Smack process is tagged with its Smack
349 label. This is done by adding a CIPSO tag to the header of the IP packet. Each
350 packet received is expected to have a CIPSO tag that identifies the label and
351 if it lacks such a tag the network ambient label is assumed. Before the packet
352 is delivered a check is made to determine that a subject with the label on the
353 packet has write access to the receiving process and if that is not the case
354 the packet is dropped.
355
356 CIPSO Configuration
357
358 It is normally unnecessary to specify the CIPSO configuration. The default
359 values used by the system handle all internal cases. Smack will compose CIPSO
360 label values to match the Smack labels being used without administrative
361 intervention. Unlabeled packets that come into the system will be given the
362 ambient label.
363
364 Smack requires configuration in the case where packets from a system that is
365 not smack that speaks CIPSO may be encountered. Usually this will be a Trusted
366 Solaris system, but there are other, less widely deployed systems out there.
367 CIPSO provides 3 important values, a Domain Of Interpretation (DOI), a level,
368 and a category set with each packet. The DOI is intended to identify a group
369 of systems that use compatible labeling schemes, and the DOI specified on the
370 smack system must match that of the remote system or packets will be
371 discarded. The DOI is 3 by default. The value can be read from /smack/doi and
372 can be changed by writing to /smack/doi.
373
374 The label and category set are mapped to a Smack label as defined in
375 /etc/smack/cipso.
376
377 A Smack/CIPSO mapping has the form:
378
379         smack level [category [category]*]
380
381 Smack does not expect the level or category sets to be related in any
382 particular way and does not assume or assign accesses based on them. Some
383 examples of mappings:
384
385         TopSecret 7
386         TS:A,B    7 1 2
387         SecBDE    5 2 4 6
388         RAFTERS   7 12 26
389
390 The ":" and "," characters are permitted in a Smack label but have no special
391 meaning.
392
393 The mapping of Smack labels to CIPSO values is defined by writing to
394 /smack/cipso. Again, the format of data written to this special file
395 is highly restrictive, so the program smackcipso is provided to
396 ensure the writes are done properly. This program takes mappings
397 on the standard input and sends them to /smack/cipso properly.
398
399 In addition to explicit mappings Smack supports direct CIPSO mappings. One
400 CIPSO level is used to indicate that the category set passed in the packet is
401 in fact an encoding of the Smack label. The level used is 250 by default. The
402 value can be read from /smack/direct and changed by writing to /smack/direct.
403
404 Socket Attributes
405
406 There are two attributes that are associated with sockets. These attributes
407 can only be set by privileged tasks, but any task can read them for their own
408 sockets.
409
410         SMACK64IPIN: The Smack label of the task object. A privileged
411         program that will enforce policy may set this to the star label.
412
413         SMACK64IPOUT: The Smack label transmitted with outgoing packets.
414         A privileged program may set this to match the label of another
415         task with which it hopes to communicate.
416
417 Smack Netlabel Exceptions
418
419 You will often find that your labeled application has to talk to the outside,
420 unlabeled world. To do this there's a special file /smack/netlabel where you can
421 add some exceptions in the form of :
422 @IP1       LABEL1 or
423 @IP2/MASK  LABEL2
424
425 It means that your application will have unlabeled access to @IP1 if it has
426 write access on LABEL1, and access to the subnet @IP2/MASK if it has write
427 access on LABEL2.
428
429 Entries in the /smack/netlabel file are matched by longest mask first, like in
430 classless IPv4 routing.
431
432 A special label '@' and an option '-CIPSO' can be used there :
433 @      means Internet, any application with any label has access to it
434 -CIPSO means standard CIPSO networking
435
436 If you don't know what CIPSO is and don't plan to use it, you can just do :
437 echo 127.0.0.1 -CIPSO > /smack/netlabel
438 echo 0.0.0.0/0 @      > /smack/netlabel
439
440 If you use CIPSO on your 192.168.0.0/16 local network and need also unlabeled
441 Internet access, you can have :
442 echo 127.0.0.1      -CIPSO > /smack/netlabel
443 echo 192.168.0.0/16 -CIPSO > /smack/netlabel
444 echo 0.0.0.0/0      @      > /smack/netlabel
445
446
447 Writing Applications for Smack
448
449 There are three sorts of applications that will run on a Smack system. How an
450 application interacts with Smack will determine what it will have to do to
451 work properly under Smack.
452
453 Smack Ignorant Applications
454
455 By far the majority of applications have no reason whatever to care about the
456 unique properties of Smack. Since invoking a program has no impact on the
457 Smack label associated with the process the only concern likely to arise is
458 whether the process has execute access to the program.
459
460 Smack Relevant Applications
461
462 Some programs can be improved by teaching them about Smack, but do not make
463 any security decisions themselves. The utility ls(1) is one example of such a
464 program.
465
466 Smack Enforcing Applications
467
468 These are special programs that not only know about Smack, but participate in
469 the enforcement of system policy. In most cases these are the programs that
470 set up user sessions. There are also network services that provide information
471 to processes running with various labels.
472
473 File System Interfaces
474
475 Smack maintains labels on file system objects using extended attributes. The
476 Smack label of a file, directory, or other file system object can be obtained
477 using getxattr(2).
478
479         len = getxattr("/", "security.SMACK64", value, sizeof (value));
480
481 will put the Smack label of the root directory into value. A privileged
482 process can set the Smack label of a file system object with setxattr(2).
483
484         len = strlen("Rubble");
485         rc = setxattr("/foo", "security.SMACK64", "Rubble", len, 0);
486
487 will set the Smack label of /foo to "Rubble" if the program has appropriate
488 privilege.
489
490 Socket Interfaces
491
492 The socket attributes can be read using fgetxattr(2).
493
494 A privileged process can set the Smack label of outgoing packets with
495 fsetxattr(2).
496
497         len = strlen("Rubble");
498         rc = fsetxattr(fd, "security.SMACK64IPOUT", "Rubble", len, 0);
499
500 will set the Smack label "Rubble" on packets going out from the socket if the
501 program has appropriate privilege.
502
503         rc = fsetxattr(fd, "security.SMACK64IPIN, "*", strlen("*"), 0);
504
505 will set the Smack label "*" as the object label against which incoming
506 packets will be checked if the program has appropriate privilege.
507
508 Administration
509
510 Smack supports some mount options:
511
512         smackfsdef=label: specifies the label to give files that lack
513         the Smack label extended attribute.
514
515         smackfsroot=label: specifies the label to assign the root of the
516         file system if it lacks the Smack extended attribute.
517
518         smackfshat=label: specifies a label that must have read access to
519         all labels set on the filesystem. Not yet enforced.
520
521         smackfsfloor=label: specifies a label to which all labels set on the
522         filesystem must have read access. Not yet enforced.
523
524 These mount options apply to all file system types.
525