2 * AppArmor security module
4 * This file contains AppArmor functions for unpacking policy loaded from
7 * Copyright (C) 1998-2008 Novell/SUSE
8 * Copyright 2009-2010 Canonical Ltd.
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation, version 2 of the
15 * AppArmor uses a serialized binary format for loading policy. To find
16 * policy format documentation look in Documentation/security/apparmor.txt
17 * All policy is validated before it is used.
20 #include <asm/unaligned.h>
21 #include <linux/ctype.h>
22 #include <linux/errno.h>
24 #include "include/apparmor.h"
25 #include "include/audit.h"
26 #include "include/context.h"
27 #include "include/match.h"
28 #include "include/policy.h"
29 #include "include/policy_unpack.h"
30 #include "include/sid.h"
33 * The AppArmor interface treats data as a type byte followed by the
34 * actual data. The interface has the notion of a a named entry
35 * which has a name (AA_NAME typecode followed by name string) followed by
36 * the entries typecode and data. Named types allow for optional
37 * elements and extensions to be added and tested for without breaking
38 * backwards compatibility.
46 AA_NAME
, /* same as string except it is items name */
58 * aa_ext is the read of the buffer containing the serialized profile. The
59 * data is copied into a kernel buffer in apparmorfs and then handed off to
60 * the unpack routines.
65 void *pos
; /* pointer to current position in the buffer */
69 /* audit callback for unpack fields */
70 static void audit_cb(struct audit_buffer
*ab
, void *va
)
72 struct common_audit_data
*sa
= va
;
73 if (sa
->aad
->iface
.target
) {
74 struct aa_profile
*name
= sa
->aad
->iface
.target
;
75 audit_log_format(ab
, " name=");
76 audit_log_untrustedstring(ab
, name
->base
.hname
);
78 if (sa
->aad
->iface
.pos
)
79 audit_log_format(ab
, " offset=%ld", sa
->aad
->iface
.pos
);
83 * audit_iface - do audit message for policy unpacking/load/replace/remove
84 * @new: profile if it has been allocated (MAYBE NULL)
85 * @name: name of the profile being manipulated (MAYBE NULL)
86 * @info: any extra info about the failure (MAYBE NULL)
87 * @e: buffer position info
90 * Returns: %0 or error
92 static int audit_iface(struct aa_profile
*new, const char *name
,
93 const char *info
, struct aa_ext
*e
, int error
)
95 struct aa_profile
*profile
= __aa_current_profile();
96 struct common_audit_data sa
;
97 struct apparmor_audit_data aad
= {0,};
98 sa
.type
= LSM_AUDIT_DATA_NONE
;
101 aad
.iface
.pos
= e
->pos
- e
->start
;
102 aad
.iface
.target
= new;
107 return aa_audit(AUDIT_APPARMOR_STATUS
, profile
, GFP_KERNEL
, &sa
,
111 /* test if read will be in packed data bounds */
112 static bool inbounds(struct aa_ext
*e
, size_t size
)
114 return (size
<= e
->end
- e
->pos
);
118 * aa_u16_chunck - test and do bounds checking for a u16 size based chunk
119 * @e: serialized data read head (NOT NULL)
120 * @chunk: start address for chunk of data (NOT NULL)
122 * Returns: the size of chunk found with the read head at the end of the chunk.
124 static size_t unpack_u16_chunk(struct aa_ext
*e
, char **chunk
)
128 if (!inbounds(e
, sizeof(u16
)))
130 size
= le16_to_cpu(get_unaligned((u16
*) e
->pos
));
131 e
->pos
+= sizeof(u16
);
132 if (!inbounds(e
, size
))
139 /* unpack control byte */
140 static bool unpack_X(struct aa_ext
*e
, enum aa_code code
)
144 if (*(u8
*) e
->pos
!= code
)
151 * unpack_nameX - check is the next element is of type X with a name of @name
152 * @e: serialized data extent information (NOT NULL)
154 * @name: name to match to the serialized element. (MAYBE NULL)
156 * check that the next serialized data element is of type X and has a tag
157 * name @name. If @name is specified then there must be a matching
158 * name element in the stream. If @name is NULL any name element will be
159 * skipped and only the typecode will be tested.
161 * Returns 1 on success (both type code and name tests match) and the read
162 * head is advanced past the headers
164 * Returns: 0 if either match fails, the read head does not move
166 static bool unpack_nameX(struct aa_ext
*e
, enum aa_code code
, const char *name
)
169 * May need to reset pos if name or type doesn't match
173 * Check for presence of a tagname, and if present name size
174 * AA_NAME tag value is a u16.
176 if (unpack_X(e
, AA_NAME
)) {
178 size_t size
= unpack_u16_chunk(e
, &tag
);
179 /* if a name is specified it must match. otherwise skip tag */
180 if (name
&& (!size
|| strcmp(name
, tag
)))
183 /* if a name is specified and there is no name tag fail */
187 /* now check if type code matches */
188 if (unpack_X(e
, code
))
196 static bool unpack_u32(struct aa_ext
*e
, u32
*data
, const char *name
)
198 if (unpack_nameX(e
, AA_U32
, name
)) {
199 if (!inbounds(e
, sizeof(u32
)))
202 *data
= le32_to_cpu(get_unaligned((u32
*) e
->pos
));
203 e
->pos
+= sizeof(u32
);
209 static bool unpack_u64(struct aa_ext
*e
, u64
*data
, const char *name
)
211 if (unpack_nameX(e
, AA_U64
, name
)) {
212 if (!inbounds(e
, sizeof(u64
)))
215 *data
= le64_to_cpu(get_unaligned((u64
*) e
->pos
));
216 e
->pos
+= sizeof(u64
);
222 static size_t unpack_array(struct aa_ext
*e
, const char *name
)
224 if (unpack_nameX(e
, AA_ARRAY
, name
)) {
226 if (!inbounds(e
, sizeof(u16
)))
228 size
= (int)le16_to_cpu(get_unaligned((u16
*) e
->pos
));
229 e
->pos
+= sizeof(u16
);
235 static size_t unpack_blob(struct aa_ext
*e
, char **blob
, const char *name
)
237 if (unpack_nameX(e
, AA_BLOB
, name
)) {
239 if (!inbounds(e
, sizeof(u32
)))
241 size
= le32_to_cpu(get_unaligned((u32
*) e
->pos
));
242 e
->pos
+= sizeof(u32
);
243 if (inbounds(e
, (size_t) size
)) {
252 static int unpack_str(struct aa_ext
*e
, const char **string
, const char *name
)
258 if (unpack_nameX(e
, AA_STRING
, name
)) {
259 size
= unpack_u16_chunk(e
, &src_str
);
261 /* strings are null terminated, length is size - 1 */
262 if (src_str
[size
- 1] != 0)
274 static int unpack_strdup(struct aa_ext
*e
, char **string
, const char *name
)
278 int res
= unpack_str(e
, &tmp
, name
);
284 *string
= kmemdup(tmp
, res
, GFP_KERNEL
);
294 * verify_accept - verify the accept tables of a dfa
295 * @dfa: dfa to verify accept tables of (NOT NULL)
296 * @flags: flags governing dfa
298 * Returns: 1 if valid accept tables else 0 if error
300 static bool verify_accept(struct aa_dfa
*dfa
, int flags
)
304 /* verify accept permissions */
305 for (i
= 0; i
< dfa
->tables
[YYTD_ID_ACCEPT
]->td_lolen
; i
++) {
306 int mode
= ACCEPT_TABLE(dfa
)[i
];
308 if (mode
& ~DFA_VALID_PERM_MASK
)
311 if (ACCEPT_TABLE2(dfa
)[i
] & ~DFA_VALID_PERM2_MASK
)
318 * unpack_dfa - unpack a file rule dfa
319 * @e: serialized data extent information (NOT NULL)
321 * returns dfa or ERR_PTR or NULL if no dfa
323 static struct aa_dfa
*unpack_dfa(struct aa_ext
*e
)
327 struct aa_dfa
*dfa
= NULL
;
329 size
= unpack_blob(e
, &blob
, "aadfa");
332 * The dfa is aligned with in the blob to 8 bytes
333 * from the beginning of the stream.
335 size_t sz
= blob
- (char *)e
->start
;
336 size_t pad
= ALIGN(sz
, 8) - sz
;
337 int flags
= TO_ACCEPT1_FLAG(YYTD_DATA32
) |
338 TO_ACCEPT2_FLAG(YYTD_DATA32
);
341 if (aa_g_paranoid_load
)
342 flags
|= DFA_FLAG_VERIFY_STATES
;
344 dfa
= aa_dfa_unpack(blob
+ pad
, size
- pad
, flags
);
349 if (!verify_accept(dfa
, flags
))
357 return ERR_PTR(-EPROTO
);
361 * unpack_trans_table - unpack a profile transition table
362 * @e: serialized data extent information (NOT NULL)
363 * @profile: profile to add the accept table to (NOT NULL)
365 * Returns: 1 if table successfully unpacked
367 static bool unpack_trans_table(struct aa_ext
*e
, struct aa_profile
*profile
)
371 /* exec table is optional */
372 if (unpack_nameX(e
, AA_STRUCT
, "xtable")) {
375 size
= unpack_array(e
, NULL
);
376 /* currently 4 exec bits and entries 0-3 are reserved iupcx */
379 profile
->file
.trans
.table
= kzalloc(sizeof(char *) * size
,
381 if (!profile
->file
.trans
.table
)
384 profile
->file
.trans
.size
= size
;
385 for (i
= 0; i
< size
; i
++) {
387 int c
, j
, size2
= unpack_strdup(e
, &str
, NULL
);
388 /* unpack_strdup verifies that the last character is
389 * null termination byte.
393 profile
->file
.trans
.table
[i
] = str
;
394 /* verify that name doesn't start with space */
398 /* count internal # of internal \0 */
399 for (c
= j
= 0; j
< size2
- 2; j
++) {
404 /* beginning with : requires an embedded \0,
405 * verify that exactly 1 internal \0 exists
406 * trailing \0 already verified by unpack_strdup
410 /* first character after : must be valid */
414 /* fail - all other cases with embedded \0 */
417 if (!unpack_nameX(e
, AA_ARRAYEND
, NULL
))
419 if (!unpack_nameX(e
, AA_STRUCTEND
, NULL
))
425 aa_free_domain_entries(&profile
->file
.trans
);
430 static bool unpack_rlimits(struct aa_ext
*e
, struct aa_profile
*profile
)
434 /* rlimits are optional */
435 if (unpack_nameX(e
, AA_STRUCT
, "rlimits")) {
438 if (!unpack_u32(e
, &tmp
, NULL
))
440 profile
->rlimits
.mask
= tmp
;
442 size
= unpack_array(e
, NULL
);
443 if (size
> RLIM_NLIMITS
)
445 for (i
= 0; i
< size
; i
++) {
447 int a
= aa_map_resource(i
);
448 if (!unpack_u64(e
, &tmp2
, NULL
))
450 profile
->rlimits
.limits
[a
].rlim_max
= tmp2
;
452 if (!unpack_nameX(e
, AA_ARRAYEND
, NULL
))
454 if (!unpack_nameX(e
, AA_STRUCTEND
, NULL
))
465 * unpack_profile - unpack a serialized profile
466 * @e: serialized data extent information (NOT NULL)
468 * NOTE: unpack profile sets audit struct if there is a failure
470 static struct aa_profile
*unpack_profile(struct aa_ext
*e
)
472 struct aa_profile
*profile
= NULL
;
473 const char *name
= NULL
;
474 int i
, error
= -EPROTO
;
478 /* check that we have the right struct being passed */
479 if (!unpack_nameX(e
, AA_STRUCT
, "profile"))
481 if (!unpack_str(e
, &name
, NULL
))
484 profile
= aa_alloc_profile(name
);
486 return ERR_PTR(-ENOMEM
);
488 /* profile renaming is optional */
489 (void) unpack_str(e
, &profile
->rename
, "rename");
491 /* xmatch is optional and may be NULL */
492 profile
->xmatch
= unpack_dfa(e
);
493 if (IS_ERR(profile
->xmatch
)) {
494 error
= PTR_ERR(profile
->xmatch
);
495 profile
->xmatch
= NULL
;
498 /* xmatch_len is not optional if xmatch is set */
499 if (profile
->xmatch
) {
500 if (!unpack_u32(e
, &tmp
, NULL
))
502 profile
->xmatch_len
= tmp
;
505 /* per profile debug flags (complain, audit) */
506 if (!unpack_nameX(e
, AA_STRUCT
, "flags"))
508 if (!unpack_u32(e
, &tmp
, NULL
))
511 profile
->flags
|= PFLAG_HAT
;
512 if (!unpack_u32(e
, &tmp
, NULL
))
515 profile
->mode
= APPARMOR_COMPLAIN
;
516 if (!unpack_u32(e
, &tmp
, NULL
))
519 profile
->audit
= AUDIT_ALL
;
521 if (!unpack_nameX(e
, AA_STRUCTEND
, NULL
))
524 /* path_flags is optional */
525 if (unpack_u32(e
, &profile
->path_flags
, "path_flags"))
526 profile
->path_flags
|= profile
->flags
& PFLAG_MEDIATE_DELETED
;
528 /* set a default value if path_flags field is not present */
529 profile
->path_flags
= PFLAG_MEDIATE_DELETED
;
531 if (!unpack_u32(e
, &(profile
->caps
.allow
.cap
[0]), NULL
))
533 if (!unpack_u32(e
, &(profile
->caps
.audit
.cap
[0]), NULL
))
535 if (!unpack_u32(e
, &(profile
->caps
.quiet
.cap
[0]), NULL
))
537 if (!unpack_u32(e
, &tmpcap
.cap
[0], NULL
))
540 if (unpack_nameX(e
, AA_STRUCT
, "caps64")) {
541 /* optional upper half of 64 bit caps */
542 if (!unpack_u32(e
, &(profile
->caps
.allow
.cap
[1]), NULL
))
544 if (!unpack_u32(e
, &(profile
->caps
.audit
.cap
[1]), NULL
))
546 if (!unpack_u32(e
, &(profile
->caps
.quiet
.cap
[1]), NULL
))
548 if (!unpack_u32(e
, &(tmpcap
.cap
[1]), NULL
))
550 if (!unpack_nameX(e
, AA_STRUCTEND
, NULL
))
554 if (unpack_nameX(e
, AA_STRUCT
, "capsx")) {
555 /* optional extended caps mediation mask */
556 if (!unpack_u32(e
, &(profile
->caps
.extended
.cap
[0]), NULL
))
558 if (!unpack_u32(e
, &(profile
->caps
.extended
.cap
[1]), NULL
))
560 if (!unpack_nameX(e
, AA_STRUCTEND
, NULL
))
564 if (!unpack_rlimits(e
, profile
))
567 if (unpack_nameX(e
, AA_STRUCT
, "policydb")) {
568 /* generic policy dfa - optional and may be NULL */
569 profile
->policy
.dfa
= unpack_dfa(e
);
570 if (IS_ERR(profile
->policy
.dfa
)) {
571 error
= PTR_ERR(profile
->policy
.dfa
);
572 profile
->policy
.dfa
= NULL
;
575 if (!unpack_u32(e
, &profile
->policy
.start
[0], "start"))
576 /* default start state */
577 profile
->policy
.start
[0] = DFA_START
;
578 /* setup class index */
579 for (i
= AA_CLASS_FILE
; i
<= AA_CLASS_LAST
; i
++) {
580 profile
->policy
.start
[i
] =
581 aa_dfa_next(profile
->policy
.dfa
,
582 profile
->policy
.start
[0],
585 if (!unpack_nameX(e
, AA_STRUCTEND
, NULL
))
590 profile
->file
.dfa
= unpack_dfa(e
);
591 if (IS_ERR(profile
->file
.dfa
)) {
592 error
= PTR_ERR(profile
->file
.dfa
);
593 profile
->file
.dfa
= NULL
;
597 if (!unpack_u32(e
, &profile
->file
.start
, "dfa_start"))
598 /* default start state */
599 profile
->file
.start
= DFA_START
;
601 if (!unpack_trans_table(e
, profile
))
604 if (!unpack_nameX(e
, AA_STRUCTEND
, NULL
))
614 audit_iface(profile
, name
, "failed to unpack profile", e
, error
);
615 aa_put_profile(profile
);
617 return ERR_PTR(error
);
621 * verify_head - unpack serialized stream header
622 * @e: serialized data read head (NOT NULL)
623 * @ns: Returns - namespace if one is specified else NULL (NOT NULL)
625 * Returns: error or 0 if header is good
627 static int verify_header(struct aa_ext
*e
, const char **ns
)
629 int error
= -EPROTONOSUPPORT
;
630 /* get the interface version */
631 if (!unpack_u32(e
, &e
->version
, "version")) {
632 audit_iface(NULL
, NULL
, "invalid profile format", e
, error
);
636 /* check that the interface version is currently supported */
637 if (e
->version
!= 5) {
638 audit_iface(NULL
, NULL
, "unsupported interface version", e
,
643 /* read the namespace if present */
644 if (!unpack_str(e
, ns
, "namespace"))
650 static bool verify_xindex(int xindex
, int table_size
)
653 xtype
= xindex
& AA_X_TYPE_MASK
;
654 index
= xindex
& AA_X_INDEX_MASK
;
655 if (xtype
== AA_X_TABLE
&& index
> table_size
)
660 /* verify dfa xindexes are in range of transition tables */
661 static bool verify_dfa_xindex(struct aa_dfa
*dfa
, int table_size
)
664 for (i
= 0; i
< dfa
->tables
[YYTD_ID_ACCEPT
]->td_lolen
; i
++) {
665 if (!verify_xindex(dfa_user_xindex(dfa
, i
), table_size
))
667 if (!verify_xindex(dfa_other_xindex(dfa
, i
), table_size
))
674 * verify_profile - Do post unpack analysis to verify profile consistency
675 * @profile: profile to verify (NOT NULL)
677 * Returns: 0 if passes verification else error
679 static int verify_profile(struct aa_profile
*profile
)
681 if (aa_g_paranoid_load
) {
682 if (profile
->file
.dfa
&&
683 !verify_dfa_xindex(profile
->file
.dfa
,
684 profile
->file
.trans
.size
)) {
685 audit_iface(profile
, NULL
, "Invalid named transition",
695 * aa_unpack - unpack packed binary profile data loaded from user space
696 * @udata: user data copied to kmem (NOT NULL)
697 * @size: the size of the user data
698 * @ns: Returns namespace profile is in if specified else NULL (NOT NULL)
700 * Unpack user data and return refcounted allocated profile or ERR_PTR
702 * Returns: profile else error pointer if fails to unpack
704 struct aa_profile
*aa_unpack(void *udata
, size_t size
, const char **ns
)
706 struct aa_profile
*profile
= NULL
;
714 error
= verify_header(&e
, ns
);
716 return ERR_PTR(error
);
718 profile
= unpack_profile(&e
);
722 error
= verify_profile(profile
);
724 aa_put_profile(profile
);
725 profile
= ERR_PTR(error
);
728 /* return refcount */