1 // SPDX-License-Identifier: GPL-2.0-only
3 * Landlock LSM - Ruleset management
6 * Copyright © 2018-2020 ANSSI
9 #include <linux/bits.h>
10 #include <linux/bug.h>
11 #include <linux/compiler_types.h>
12 #include <linux/err.h>
13 #include <linux/errno.h>
14 #include <linux/kernel.h>
15 #include <linux/lockdep.h>
16 #include <linux/overflow.h>
17 #include <linux/rbtree.h>
18 #include <linux/refcount.h>
19 #include <linux/slab.h>
20 #include <linux/spinlock.h>
21 #include <linux/workqueue.h>
27 static struct landlock_ruleset *create_ruleset(const u32 num_layers)
29 struct landlock_ruleset *new_ruleset;
32 kzalloc(struct_size(new_ruleset, access_masks, num_layers),
35 return ERR_PTR(-ENOMEM);
36 refcount_set(&new_ruleset->usage, 1);
37 mutex_init(&new_ruleset->lock);
38 new_ruleset->root_inode = RB_ROOT;
40 #if IS_ENABLED(CONFIG_INET)
41 new_ruleset->root_net_port = RB_ROOT;
42 #endif /* IS_ENABLED(CONFIG_INET) */
44 new_ruleset->num_layers = num_layers;
53 struct landlock_ruleset *
54 landlock_create_ruleset(const access_mask_t fs_access_mask,
55 const access_mask_t net_access_mask)
57 struct landlock_ruleset *new_ruleset;
59 /* Informs about useless ruleset. */
60 if (!fs_access_mask && !net_access_mask)
61 return ERR_PTR(-ENOMSG);
62 new_ruleset = create_ruleset(1);
63 if (IS_ERR(new_ruleset))
66 landlock_add_fs_access_mask(new_ruleset, fs_access_mask, 0);
68 landlock_add_net_access_mask(new_ruleset, net_access_mask, 0);
72 static void build_check_rule(void)
74 const struct landlock_rule rule = {
78 BUILD_BUG_ON(rule.num_layers < LANDLOCK_MAX_NUM_LAYERS);
81 static bool is_object_pointer(const enum landlock_key_type key_type)
84 case LANDLOCK_KEY_INODE:
87 #if IS_ENABLED(CONFIG_INET)
88 case LANDLOCK_KEY_NET_PORT:
90 #endif /* IS_ENABLED(CONFIG_INET) */
98 static struct landlock_rule *
99 create_rule(const struct landlock_id id,
100 const struct landlock_layer (*const layers)[], const u32 num_layers,
101 const struct landlock_layer *const new_layer)
103 struct landlock_rule *new_rule;
108 /* Should already be checked by landlock_merge_ruleset(). */
109 if (WARN_ON_ONCE(num_layers >= LANDLOCK_MAX_NUM_LAYERS))
110 return ERR_PTR(-E2BIG);
111 new_num_layers = num_layers + 1;
113 new_num_layers = num_layers;
115 new_rule = kzalloc(struct_size(new_rule, layers, new_num_layers),
118 return ERR_PTR(-ENOMEM);
119 RB_CLEAR_NODE(&new_rule->node);
120 if (is_object_pointer(id.type)) {
121 /* This should be catched by insert_rule(). */
122 WARN_ON_ONCE(!id.key.object);
123 landlock_get_object(id.key.object);
126 new_rule->key = id.key;
127 new_rule->num_layers = new_num_layers;
128 /* Copies the original layer stack. */
129 memcpy(new_rule->layers, layers,
130 flex_array_size(new_rule, layers, num_layers));
132 /* Adds a copy of @new_layer on the layer stack. */
133 new_rule->layers[new_rule->num_layers - 1] = *new_layer;
137 static struct rb_root *get_root(struct landlock_ruleset *const ruleset,
138 const enum landlock_key_type key_type)
141 case LANDLOCK_KEY_INODE:
142 return &ruleset->root_inode;
144 #if IS_ENABLED(CONFIG_INET)
145 case LANDLOCK_KEY_NET_PORT:
146 return &ruleset->root_net_port;
147 #endif /* IS_ENABLED(CONFIG_INET) */
151 return ERR_PTR(-EINVAL);
155 static void free_rule(struct landlock_rule *const rule,
156 const enum landlock_key_type key_type)
161 if (is_object_pointer(key_type))
162 landlock_put_object(rule->key.object);
166 static void build_check_ruleset(void)
168 const struct landlock_ruleset ruleset = {
173 BUILD_BUG_ON(ruleset.num_rules < LANDLOCK_MAX_NUM_RULES);
174 BUILD_BUG_ON(ruleset.num_layers < LANDLOCK_MAX_NUM_LAYERS);
178 * insert_rule - Create and insert a rule in a ruleset
180 * @ruleset: The ruleset to be updated.
181 * @id: The ID to build the new rule with. The underlying kernel object, if
182 * any, must be held by the caller.
183 * @layers: One or multiple layers to be copied into the new rule.
184 * @num_layers: The number of @layers entries.
186 * When user space requests to add a new rule to a ruleset, @layers only
187 * contains one entry and this entry is not assigned to any level. In this
188 * case, the new rule will extend @ruleset, similarly to a boolean OR between
191 * When merging a ruleset in a domain, or copying a domain, @layers will be
192 * added to @ruleset as new constraints, similarly to a boolean AND between
195 static int insert_rule(struct landlock_ruleset *const ruleset,
196 const struct landlock_id id,
197 const struct landlock_layer (*const layers)[],
198 const size_t num_layers)
200 struct rb_node **walker_node;
201 struct rb_node *parent_node = NULL;
202 struct landlock_rule *new_rule;
203 struct rb_root *root;
206 lockdep_assert_held(&ruleset->lock);
207 if (WARN_ON_ONCE(!layers))
210 if (is_object_pointer(id.type) && WARN_ON_ONCE(!id.key.object))
213 root = get_root(ruleset, id.type);
215 return PTR_ERR(root);
217 walker_node = &root->rb_node;
218 while (*walker_node) {
219 struct landlock_rule *const this =
220 rb_entry(*walker_node, struct landlock_rule, node);
222 if (this->key.data != id.key.data) {
223 parent_node = *walker_node;
224 if (this->key.data < id.key.data)
225 walker_node = &((*walker_node)->rb_right);
227 walker_node = &((*walker_node)->rb_left);
231 /* Only a single-level layer should match an existing rule. */
232 if (WARN_ON_ONCE(num_layers != 1))
235 /* If there is a matching rule, updates it. */
236 if ((*layers)[0].level == 0) {
238 * Extends access rights when the request comes from
239 * landlock_add_rule(2), i.e. @ruleset is not a domain.
241 if (WARN_ON_ONCE(this->num_layers != 1))
243 if (WARN_ON_ONCE(this->layers[0].level != 0))
245 this->layers[0].access |= (*layers)[0].access;
249 if (WARN_ON_ONCE(this->layers[0].level == 0))
253 * Intersects access rights when it is a merge between a
254 * ruleset and a domain.
256 new_rule = create_rule(id, &this->layers, this->num_layers,
258 if (IS_ERR(new_rule))
259 return PTR_ERR(new_rule);
260 rb_replace_node(&this->node, &new_rule->node, root);
261 free_rule(this, id.type);
265 /* There is no match for @id. */
266 build_check_ruleset();
267 if (ruleset->num_rules >= LANDLOCK_MAX_NUM_RULES)
269 new_rule = create_rule(id, layers, num_layers, NULL);
270 if (IS_ERR(new_rule))
271 return PTR_ERR(new_rule);
272 rb_link_node(&new_rule->node, parent_node, walker_node);
273 rb_insert_color(&new_rule->node, root);
274 ruleset->num_rules++;
278 static void build_check_layer(void)
280 const struct landlock_layer layer = {
285 BUILD_BUG_ON(layer.level < LANDLOCK_MAX_NUM_LAYERS);
286 BUILD_BUG_ON(layer.access < LANDLOCK_MASK_ACCESS_FS);
289 /* @ruleset must be locked by the caller. */
290 int landlock_insert_rule(struct landlock_ruleset *const ruleset,
291 const struct landlock_id id,
292 const access_mask_t access)
294 struct landlock_layer layers[] = { {
296 /* When @level is zero, insert_rule() extends @ruleset. */
301 return insert_rule(ruleset, id, &layers, ARRAY_SIZE(layers));
304 static void get_hierarchy(struct landlock_hierarchy *const hierarchy)
307 refcount_inc(&hierarchy->usage);
310 static void put_hierarchy(struct landlock_hierarchy *hierarchy)
312 while (hierarchy && refcount_dec_and_test(&hierarchy->usage)) {
313 const struct landlock_hierarchy *const freeme = hierarchy;
315 hierarchy = hierarchy->parent;
320 static int merge_tree(struct landlock_ruleset *const dst,
321 struct landlock_ruleset *const src,
322 const enum landlock_key_type key_type)
324 struct landlock_rule *walker_rule, *next_rule;
325 struct rb_root *src_root;
329 lockdep_assert_held(&dst->lock);
330 lockdep_assert_held(&src->lock);
332 src_root = get_root(src, key_type);
333 if (IS_ERR(src_root))
334 return PTR_ERR(src_root);
336 /* Merges the @src tree. */
337 rbtree_postorder_for_each_entry_safe(walker_rule, next_rule, src_root,
339 struct landlock_layer layers[] = { {
340 .level = dst->num_layers,
342 const struct landlock_id id = {
343 .key = walker_rule->key,
347 if (WARN_ON_ONCE(walker_rule->num_layers != 1))
350 if (WARN_ON_ONCE(walker_rule->layers[0].level != 0))
353 layers[0].access = walker_rule->layers[0].access;
355 err = insert_rule(dst, id, &layers, ARRAY_SIZE(layers));
362 static int merge_ruleset(struct landlock_ruleset *const dst,
363 struct landlock_ruleset *const src)
368 /* Should already be checked by landlock_merge_ruleset() */
369 if (WARN_ON_ONCE(!src))
371 /* Only merge into a domain. */
372 if (WARN_ON_ONCE(!dst || !dst->hierarchy))
375 /* Locks @dst first because we are its only owner. */
376 mutex_lock(&dst->lock);
377 mutex_lock_nested(&src->lock, SINGLE_DEPTH_NESTING);
379 /* Stacks the new layer. */
380 if (WARN_ON_ONCE(src->num_layers != 1 || dst->num_layers < 1)) {
384 dst->access_masks[dst->num_layers - 1] = src->access_masks[0];
386 /* Merges the @src inode tree. */
387 err = merge_tree(dst, src, LANDLOCK_KEY_INODE);
391 #if IS_ENABLED(CONFIG_INET)
392 /* Merges the @src network port tree. */
393 err = merge_tree(dst, src, LANDLOCK_KEY_NET_PORT);
396 #endif /* IS_ENABLED(CONFIG_INET) */
399 mutex_unlock(&src->lock);
400 mutex_unlock(&dst->lock);
404 static int inherit_tree(struct landlock_ruleset *const parent,
405 struct landlock_ruleset *const child,
406 const enum landlock_key_type key_type)
408 struct landlock_rule *walker_rule, *next_rule;
409 struct rb_root *parent_root;
413 lockdep_assert_held(&parent->lock);
414 lockdep_assert_held(&child->lock);
416 parent_root = get_root(parent, key_type);
417 if (IS_ERR(parent_root))
418 return PTR_ERR(parent_root);
420 /* Copies the @parent inode or network tree. */
421 rbtree_postorder_for_each_entry_safe(walker_rule, next_rule,
423 const struct landlock_id id = {
424 .key = walker_rule->key,
428 err = insert_rule(child, id, &walker_rule->layers,
429 walker_rule->num_layers);
436 static int inherit_ruleset(struct landlock_ruleset *const parent,
437 struct landlock_ruleset *const child)
445 /* Locks @child first because we are its only owner. */
446 mutex_lock(&child->lock);
447 mutex_lock_nested(&parent->lock, SINGLE_DEPTH_NESTING);
449 /* Copies the @parent inode tree. */
450 err = inherit_tree(parent, child, LANDLOCK_KEY_INODE);
454 #if IS_ENABLED(CONFIG_INET)
455 /* Copies the @parent network port tree. */
456 err = inherit_tree(parent, child, LANDLOCK_KEY_NET_PORT);
459 #endif /* IS_ENABLED(CONFIG_INET) */
461 if (WARN_ON_ONCE(child->num_layers <= parent->num_layers)) {
465 /* Copies the parent layer stack and leaves a space for the new layer. */
466 memcpy(child->access_masks, parent->access_masks,
467 flex_array_size(parent, access_masks, parent->num_layers));
469 if (WARN_ON_ONCE(!parent->hierarchy)) {
473 get_hierarchy(parent->hierarchy);
474 child->hierarchy->parent = parent->hierarchy;
477 mutex_unlock(&parent->lock);
478 mutex_unlock(&child->lock);
482 static void free_ruleset(struct landlock_ruleset *const ruleset)
484 struct landlock_rule *freeme, *next;
487 rbtree_postorder_for_each_entry_safe(freeme, next, &ruleset->root_inode,
489 free_rule(freeme, LANDLOCK_KEY_INODE);
491 #if IS_ENABLED(CONFIG_INET)
492 rbtree_postorder_for_each_entry_safe(freeme, next,
493 &ruleset->root_net_port, node)
494 free_rule(freeme, LANDLOCK_KEY_NET_PORT);
495 #endif /* IS_ENABLED(CONFIG_INET) */
497 put_hierarchy(ruleset->hierarchy);
501 void landlock_put_ruleset(struct landlock_ruleset *const ruleset)
504 if (ruleset && refcount_dec_and_test(&ruleset->usage))
505 free_ruleset(ruleset);
508 static void free_ruleset_work(struct work_struct *const work)
510 struct landlock_ruleset *ruleset;
512 ruleset = container_of(work, struct landlock_ruleset, work_free);
513 free_ruleset(ruleset);
516 void landlock_put_ruleset_deferred(struct landlock_ruleset *const ruleset)
518 if (ruleset && refcount_dec_and_test(&ruleset->usage)) {
519 INIT_WORK(&ruleset->work_free, free_ruleset_work);
520 schedule_work(&ruleset->work_free);
525 * landlock_merge_ruleset - Merge a ruleset with a domain
527 * @parent: Parent domain.
528 * @ruleset: New ruleset to be merged.
530 * Returns the intersection of @parent and @ruleset, or returns @parent if
531 * @ruleset is empty, or returns a duplicate of @ruleset if @parent is empty.
533 struct landlock_ruleset *
534 landlock_merge_ruleset(struct landlock_ruleset *const parent,
535 struct landlock_ruleset *const ruleset)
537 struct landlock_ruleset *new_dom;
542 if (WARN_ON_ONCE(!ruleset || parent == ruleset))
543 return ERR_PTR(-EINVAL);
546 if (parent->num_layers >= LANDLOCK_MAX_NUM_LAYERS)
547 return ERR_PTR(-E2BIG);
548 num_layers = parent->num_layers + 1;
553 /* Creates a new domain... */
554 new_dom = create_ruleset(num_layers);
558 kzalloc(sizeof(*new_dom->hierarchy), GFP_KERNEL_ACCOUNT);
559 if (!new_dom->hierarchy) {
563 refcount_set(&new_dom->hierarchy->usage, 1);
565 /* ...as a child of @parent... */
566 err = inherit_ruleset(parent, new_dom);
570 /* ...and including @ruleset. */
571 err = merge_ruleset(new_dom, ruleset);
578 landlock_put_ruleset(new_dom);
583 * The returned access has the same lifetime as @ruleset.
585 const struct landlock_rule *
586 landlock_find_rule(const struct landlock_ruleset *const ruleset,
587 const struct landlock_id id)
589 const struct rb_root *root;
590 const struct rb_node *node;
592 root = get_root((struct landlock_ruleset *)ruleset, id.type);
595 node = root->rb_node;
598 struct landlock_rule *this =
599 rb_entry(node, struct landlock_rule, node);
601 if (this->key.data == id.key.data)
603 if (this->key.data < id.key.data)
604 node = node->rb_right;
606 node = node->rb_left;
612 * @layer_masks is read and may be updated according to the access request and
614 * @masks_array_size must be equal to ARRAY_SIZE(*layer_masks).
616 * Returns true if the request is allowed (i.e. relevant layer masks for the
617 * request are empty).
619 bool landlock_unmask_layers(const struct landlock_rule *const rule,
620 const access_mask_t access_request,
621 layer_mask_t (*const layer_masks)[],
622 const size_t masks_array_size)
626 if (!access_request || !layer_masks)
632 * An access is granted if, for each policy layer, at least one rule
633 * encountered on the pathwalk grants the requested access,
634 * regardless of its position in the layer stack. We must then check
635 * the remaining layers for each inode, from the first added layer to
636 * the last one. When there is multiple requested accesses, for each
637 * policy layer, the full set of requested accesses may not be granted
638 * by only one rule, but by the union (binary OR) of multiple rules.
639 * E.g. /a/b <execute> + /a <read> => /a/b <execute + read>
641 for (layer_level = 0; layer_level < rule->num_layers; layer_level++) {
642 const struct landlock_layer *const layer =
643 &rule->layers[layer_level];
644 const layer_mask_t layer_bit = BIT_ULL(layer->level - 1);
645 const unsigned long access_req = access_request;
646 unsigned long access_bit;
650 * Records in @layer_masks which layer grants access to each
654 for_each_set_bit(access_bit, &access_req, masks_array_size) {
655 if (layer->access & BIT_ULL(access_bit))
656 (*layer_masks)[access_bit] &= ~layer_bit;
657 is_empty = is_empty && !(*layer_masks)[access_bit];
665 typedef access_mask_t
666 get_access_mask_t(const struct landlock_ruleset *const ruleset,
667 const u16 layer_level);
670 * landlock_init_layer_masks - Initialize layer masks from an access request
672 * Populates @layer_masks such that for each access right in @access_request,
673 * the bits for all the layers are set where this access right is handled.
675 * @domain: The domain that defines the current restrictions.
676 * @access_request: The requested access rights to check.
677 * @layer_masks: It must contain %LANDLOCK_NUM_ACCESS_FS or
678 * %LANDLOCK_NUM_ACCESS_NET elements according to @key_type.
679 * @key_type: The key type to switch between access masks of different types.
681 * Returns: An access mask where each access right bit is set which is handled
682 * in any of the active layers in @domain.
685 landlock_init_layer_masks(const struct landlock_ruleset *const domain,
686 const access_mask_t access_request,
687 layer_mask_t (*const layer_masks)[],
688 const enum landlock_key_type key_type)
690 access_mask_t handled_accesses = 0;
691 size_t layer_level, num_access;
692 get_access_mask_t *get_access_mask;
695 case LANDLOCK_KEY_INODE:
696 get_access_mask = landlock_get_fs_access_mask;
697 num_access = LANDLOCK_NUM_ACCESS_FS;
700 #if IS_ENABLED(CONFIG_INET)
701 case LANDLOCK_KEY_NET_PORT:
702 get_access_mask = landlock_get_net_access_mask;
703 num_access = LANDLOCK_NUM_ACCESS_NET;
705 #endif /* IS_ENABLED(CONFIG_INET) */
712 memset(layer_masks, 0,
713 array_size(sizeof((*layer_masks)[0]), num_access));
715 /* An empty access request can happen because of O_WRONLY | O_RDWR. */
719 /* Saves all handled accesses per layer. */
720 for (layer_level = 0; layer_level < domain->num_layers; layer_level++) {
721 const unsigned long access_req = access_request;
722 const access_mask_t access_mask =
723 get_access_mask(domain, layer_level);
724 unsigned long access_bit;
726 for_each_set_bit(access_bit, &access_req, num_access) {
727 if (BIT_ULL(access_bit) & access_mask) {
728 (*layer_masks)[access_bit] |=
729 BIT_ULL(layer_level);
730 handled_accesses |= BIT_ULL(access_bit);
734 return handled_accesses;