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