xref: /xnu-10063.101.15/bsd/sys/imageboot.h (revision 94d3b452840153a99b38a3a9659680b2a006908e)
1*94d3b452SApple OSS Distributions /*
2*94d3b452SApple OSS Distributions  * Copyright (c) 2006-2021 Apple Inc. All rights reserved.
3*94d3b452SApple OSS Distributions  *
4*94d3b452SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*94d3b452SApple OSS Distributions  *
6*94d3b452SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*94d3b452SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*94d3b452SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*94d3b452SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*94d3b452SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*94d3b452SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*94d3b452SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*94d3b452SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*94d3b452SApple OSS Distributions  *
15*94d3b452SApple OSS Distributions  * Please obtain a copy of the License at
16*94d3b452SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*94d3b452SApple OSS Distributions  *
18*94d3b452SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*94d3b452SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*94d3b452SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*94d3b452SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*94d3b452SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*94d3b452SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*94d3b452SApple OSS Distributions  * limitations under the License.
25*94d3b452SApple OSS Distributions  *
26*94d3b452SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*94d3b452SApple OSS Distributions  */
28*94d3b452SApple OSS Distributions #ifndef _IMAGEBOOT_H_
29*94d3b452SApple OSS Distributions #define _IMAGEBOOT_H_
30*94d3b452SApple OSS Distributions 
31*94d3b452SApple OSS Distributions struct vnode;
32*94d3b452SApple OSS Distributions 
33*94d3b452SApple OSS Distributions typedef enum imageboot_type {
34*94d3b452SApple OSS Distributions 	IMAGEBOOT_NONE,
35*94d3b452SApple OSS Distributions 	IMAGEBOOT_DMG,
36*94d3b452SApple OSS Distributions 	IMAGEBOOT_LOCKER,
37*94d3b452SApple OSS Distributions } imageboot_type_t;
38*94d3b452SApple OSS Distributions 
39*94d3b452SApple OSS Distributions imageboot_type_t        imageboot_needed(void);
40*94d3b452SApple OSS Distributions bool    imageboot_desired(void);
41*94d3b452SApple OSS Distributions void    imageboot_setup(imageboot_type_t type);
42*94d3b452SApple OSS Distributions int     imageboot_format_is_valid(const char *root_path);
43*94d3b452SApple OSS Distributions int     imageboot_mount_image(const char *root_path, int height, imageboot_type_t type);
44*94d3b452SApple OSS Distributions int     imageboot_pivot_image(const char *image_path, imageboot_type_t type, const char *mount_path,
45*94d3b452SApple OSS Distributions     const char *outgoing_root_path, const bool rooted_dmg, const bool skip_signature_check);
46*94d3b452SApple OSS Distributions int     imageboot_read_file_pageable(const char *path, void **bufp, size_t *bufszp); /* use kmem_free(kernel_map, ...) */
47*94d3b452SApple OSS Distributions int     imageboot_read_file(const char *path, void **bufp, size_t *bufszp, off_t *fsizep);
48*94d3b452SApple OSS Distributions int     imageboot_read_file_from_offset(const char *path, off_t offset, void **bufp, size_t *bufszp);
49*94d3b452SApple OSS Distributions 
50*94d3b452SApple OSS Distributions struct vnode *
51*94d3b452SApple OSS Distributions imgboot_get_image_file(const char *path, off_t *fsize, int *errp);
52*94d3b452SApple OSS Distributions 
53*94d3b452SApple OSS Distributions #define IMAGEBOOT_CONTAINER_ARG         "container-dmg"
54*94d3b452SApple OSS Distributions #define IMAGEBOOT_ROOT_ARG              "root-dmg"
55*94d3b452SApple OSS Distributions #define IMAGEBOOT_AUTHROOT_ARG          "auth-root-dmg"
56*94d3b452SApple OSS Distributions 
57*94d3b452SApple OSS Distributions //IMAGEBOOT images are capped at 2.5GB
58*94d3b452SApple OSS Distributions #define IMAGEBOOT_MAX_FILESIZE          (2684354560ULL)
59*94d3b452SApple OSS Distributions //limit certain kalloc calls to 2GB
60*94d3b452SApple OSS Distributions #define IMAGEBOOT_MAX_KALLOCSIZE        (2147483648ULL)
61*94d3b452SApple OSS Distributions 
62*94d3b452SApple OSS Distributions #endif
63