├── .github ├── dependabot.yaml └── workflows │ ├── ipxe_build.yaml │ ├── ipxe_version.yaml │ └── release.yaml ├── .gitignore ├── .goreleaser.yaml ├── CHANGELOG.md ├── Containerfile ├── LICENSE.txt ├── README.md ├── cmd └── pixie │ ├── cmd.go │ └── validate.go ├── go.mod ├── go.sum └── pkg ├── http └── server.go ├── log ├── level.go └── log.go └── tftp ├── chain.ipxe ├── embed.go └── server.go /.github/dependabot.yaml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: gomod 4 | directory: / 5 | schedule: 6 | interval: daily 7 | 8 | - package-ecosystem: github-actions 9 | directory: / 10 | schedule: 11 | interval: daily 12 | -------------------------------------------------------------------------------- /.github/workflows/ipxe_build.yaml: -------------------------------------------------------------------------------- 1 | name: Build iPXE 2 | 3 | on: 4 | workflow_call: 5 | 6 | env: 7 | IPXE_REF: d3c8944d5c3ab262826ed33b16f3fc4dd43bc304 8 | 9 | jobs: 10 | x86: 11 | runs-on: ubuntu-20.04 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v4 15 | with: 16 | repository: ipxe/ipxe 17 | ref: ${{ env.IPXE_REF }} 18 | fetch-depth: 0 # we need the entire history to build iPXE 19 | 20 | - name: Cache binaries 21 | uses: actions/cache@v4 22 | id: cache 23 | with: 24 | key: ipxe-x86-${{ env.IPXE_REF }} 25 | path: | 26 | src/bin/*.kpxe 27 | src/bin*/*.efi 28 | 29 | - name: Build 30 | if: steps.cache.outputs.cache-hit != 'true' 31 | run: | 32 | make -j4 -C src \ 33 | bin/undionly.kpxe \ 34 | bin-x86_64-efi/ipxe.efi \ 35 | bin-x86_64-efi/snponly.efi \ 36 | bin-i386-efi/ipxe.efi \ 37 | bin-i386-efi/snponly.efi 38 | 39 | arm32: 40 | runs-on: ubuntu-20.04 41 | steps: 42 | - name: Checkout 43 | uses: actions/checkout@v4 44 | with: 45 | repository: ipxe/ipxe 46 | ref: ${{ env.IPXE_REF }} 47 | fetch-depth: 0 # we need the entire history to build iPXE 48 | 49 | - name: Cache binaries 50 | uses: actions/cache@v4 51 | id: cache 52 | with: 53 | key: ipxe-arm32-${{ env.IPXE_REF }} 54 | path: | 55 | src/bin-arm32-efi/snponly.efi 56 | 57 | - name: Add cross-compile deps 58 | if: steps.cache.outputs.cache-hit != 'true' 59 | run: | 60 | sudo apt update 61 | sudo apt install -y gcc-arm-none-eabi 62 | 63 | - name: Build 64 | if: steps.cache.outputs.cache-hit != 'true' 65 | run: | 66 | make -j4 -C src CROSS=arm-none-eabi- ARCH=arm32 \ 67 | bin-arm32-efi/snponly.efi 68 | 69 | arm64: 70 | runs-on: ubuntu-20.04 71 | steps: 72 | - name: Checkout 73 | uses: actions/checkout@v4 74 | with: 75 | repository: ipxe/ipxe 76 | ref: ${{ env.IPXE_REF }} 77 | fetch-depth: 0 # we need the entire history to build iPXE 78 | 79 | - name: Cache binaries 80 | uses: actions/cache@v4 81 | id: cache 82 | with: 83 | key: ipxe-arm64-${{ env.IPXE_REF }} 84 | path: | 85 | src/bin-arm64-efi/snponly.efi 86 | 87 | - name: Add cross-compile deps 88 | if: steps.cache.outputs.cache-hit != 'true' 89 | run: | 90 | sudo apt update 91 | sudo apt install -y gcc-aarch64-linux-gnu 92 | 93 | - name: Build 94 | if: steps.cache.outputs.cache-hit != 'true' 95 | run: | 96 | make -j4 -C src CROSS=aarch64-linux-gnu- ARCH=arm64 \ 97 | bin-arm64-efi/snponly.efi 98 | 99 | cache: 100 | runs-on: ubuntu-20.04 101 | needs: 102 | - x86 103 | - arm32 104 | - arm64 105 | steps: 106 | - name: Mount x86 cache 107 | uses: actions/cache@v4 108 | with: 109 | key: ipxe-x86-${{ env.IPXE_REF }} 110 | path: | 111 | src/bin/*.kpxe 112 | src/bin*/*.efi 113 | 114 | - name: Mount arm32 cache 115 | uses: actions/cache@v4 116 | with: 117 | key: ipxe-arm32-${{ env.IPXE_REF }} 118 | path: | 119 | src/bin-arm32-efi/snponly.efi 120 | 121 | - name: Mount arm64 cache 122 | uses: actions/cache@v4 123 | with: 124 | key: ipxe-arm64-${{ env.IPXE_REF }} 125 | path: | 126 | src/bin-arm64-efi/snponly.efi 127 | 128 | - name: Create artifact 129 | uses: actions/upload-artifact@v4 130 | with: 131 | name: ipxe-roms 132 | path: src/bin*/* 133 | -------------------------------------------------------------------------------- /.github/workflows/ipxe_version.yaml: -------------------------------------------------------------------------------- 1 | name: Update iPXE version 2 | 3 | on: 4 | schedule: 5 | - cron: '0 6 * * *' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | update-version: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout 13 | uses: actions/checkout@v4 14 | 15 | - name: Get latest version 16 | run: | 17 | echo "::set-output name=sha::$(curl -u "u:${{ github.token }}" https://api.github.com/repos/ipxe/ipxe/git/ref/heads/master | jq -r '.object.sha')" 18 | id: version 19 | 20 | - name: Update version string 21 | run: | 22 | sed -Ei 's/(IPXE_REF=)[0-9a-f]{40}/\1${{ steps.version.outputs.sha }}/' .goreleaser.yaml 23 | 24 | - name: Create pull request 25 | uses: peter-evans/create-pull-request@v7 26 | with: 27 | title: ':arrow_up: Bump ipxe/ipxe' 28 | body: 'https://github.com/ipxe/ipxe/commits/${{ steps.version.outputs.sha }}' 29 | commit-message: ':arrow_up: Bump ipxe/ipxe to ${{ steps.version.outputs.sha }}' 30 | labels: dependencies 31 | branch: ipxe-version 32 | token: ${{ secrets.WORKFLOW_PAT }} # needed to modify workflow files 33 | delete-branch: true 34 | -------------------------------------------------------------------------------- /.github/workflows/release.yaml: -------------------------------------------------------------------------------- 1 | name: release 2 | 3 | on: 4 | push: 5 | tags: 6 | - '**' 7 | 8 | permissions: 9 | contents: write 10 | packages: write 11 | 12 | jobs: 13 | release: 14 | runs-on: ubuntu-latest 15 | env: 16 | DOCKER_CLI_EXPERIMENTAL: enabled # needed for docker manifests 17 | steps: 18 | - name: Checkout 19 | uses: actions/checkout@v4 20 | with: 21 | fetch-depth: 0 # we need the entire history to build changelog 22 | 23 | - name: Setup Go 24 | uses: actions/setup-go@v5 25 | with: 26 | go-version-file: go.mod 27 | 28 | - name: Setup QEMU for cross-compiling container images 29 | uses: docker/setup-qemu-action@v3 30 | 31 | - name: Setup Docker buildx 32 | uses: docker/setup-buildx-action@v3 33 | 34 | - name: Authenticate with GHCR 35 | uses: docker/login-action@v3 36 | with: 37 | registry: ghcr.io 38 | username: ${{ github.repository_owner }} 39 | password: ${{ secrets.GITHUB_TOKEN }} 40 | 41 | - name: Install cross-compile dependencies 42 | run: | 43 | sudo apt update 44 | sudo apt install -y gcc-arm-none-eabi gcc-aarch64-linux-gnu 45 | 46 | - name: Run goreleaser 47 | uses: goreleaser/goreleaser-action@v6 48 | with: 49 | args: release --clean 50 | env: 51 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 52 | REPOSITORY_OWNER: ${{ github.repository_owner }} 53 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /pkg/tftp/ipxe/ 2 | /dist/ 3 | -------------------------------------------------------------------------------- /.goreleaser.yaml: -------------------------------------------------------------------------------- 1 | env: 2 | - IPXE_REF=24db39fb2983ca83ab5c6ee37cb57a4f7f6f94e6 3 | before: 4 | hooks: 5 | - rm -rf pkg/tftp/ipxe 6 | - git clone https://github.com/ipxe/ipxe pkg/tftp/ipxe 7 | - git -C pkg/tftp/ipxe checkout {{ .Env.IPXE_REF }} 8 | - make -C pkg/tftp/ipxe/src -j4 bin/undionly.kpxe 9 | bin-x86_64-efi/ipxe.efi 10 | bin-x86_64-efi/snponly.efi 11 | bin-i386-efi/ipxe.efi 12 | bin-i386-efi/snponly.efi 13 | - make -C pkg/tftp/ipxe/src -j4 CROSS=arm-none-eabi- ARCH=arm32 bin-arm32-efi/snponly.efi 14 | - make -C pkg/tftp/ipxe/src -j4 CROSS=aarch64-linux-gnu- ARCH=arm64 bin-arm64-efi/snponly.efi 15 | 16 | builds: 17 | - main: ./cmd/pixie 18 | goos: 19 | - linux 20 | goarch: 21 | - amd64 22 | - arm64 23 | - arm 24 | env: 25 | - CGO_ENABLED=0 26 | 27 | dockers: 28 | - goos: linux 29 | goarch: amd64 30 | dockerfile: Containerfile 31 | use: buildx 32 | build_flag_templates: 33 | - --platform=linux/amd64 34 | image_templates: 35 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:{{ .Tag }}-amd64 36 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:latest-amd64 37 | 38 | - goos: linux 39 | goarch: arm64 40 | dockerfile: Containerfile 41 | use: buildx 42 | build_flag_templates: 43 | - --platform=linux/arm64 44 | image_templates: 45 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:{{ .Tag }}-arm64 46 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:latest-arm64 47 | 48 | - goos: linux 49 | goarch: arm 50 | dockerfile: Containerfile 51 | use: buildx 52 | build_flag_templates: 53 | - --platform=linux/arm 54 | image_templates: 55 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:{{ .Tag }}-arm32 56 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:latest-arm32 57 | 58 | docker_manifests: 59 | - name_template: ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:{{ .Tag }} 60 | image_templates: 61 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:{{ .Tag }}-amd64 62 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:{{ .Tag }}-arm64 63 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:{{ .Tag }}-arm32 64 | 65 | - name_template: ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:latest 66 | image_templates: 67 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:latest-amd64 68 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:latest-arm64 69 | - ghcr.io/{{ .Env.REPOSITORY_OWNER }}/{{ .ProjectName }}:latest-arm32 70 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ### Changes in 0.3.4 (2024-02-13) 2 | 3 | - Changed: iPXE version to v1.21.1+94b39fb 4 | - Changed: Updated pin/tftp to v3.1.0 5 | - Changed: Updated indirect dependencies 6 | 7 | ### Changes in 0.3.3 (2023-10-28) 8 | 9 | - Changed: iPXE version to v1.21.1+115707c 10 | - Changed: Updated to Go v1.21 11 | - Changed: Updated indirect dependencies 12 | 13 | ### Changes in 0.3.2 (2023-03-10) 14 | 15 | - Changed: iPXE version to v1.21.1+9e1f7a3 16 | 17 | ### Changes in 0.3.1 (2022-12-31) 18 | 19 | - Changed: Build system, with multi-arch container images 20 | - Changed: tftp version to 3.0.0 21 | - Changed: iPXE version to v1.21.1+7147532 22 | 23 | ### Changes in 0.3.0 (2022-06-05) 24 | 25 | - Added: Support for 64-bit and 32-bit ARM ROMs 26 | - Added: Support for x86 snponly ROMs 27 | 28 | ### Changes in 0.2.6 (2022-06-05) 29 | 30 | - Fixed: Incorrect HTTP port used in chain 31 | 32 | ### Changes in 0.2.5 (2021-10-09) 33 | 34 | - Fixed: netboot.xyz not working (iPXE ROM doesn't support TLS) 35 | 36 | ### Changes in 0.2.4 (2021-10-09) 37 | 38 | - Fixed: iPXE and extra files not being served 39 | 40 | ### Changes in 0.2.3 (2021-10-09) 41 | 42 | - Added: Option for logging 43 | - Added: netboot.xyz to the iPXE menu 44 | 45 | ### Changes in 0.2.2 (2021-10-09) 46 | 47 | - Added: Validation to CLI arguments 48 | - Changed: iPXE version to v1.21.1+2265a65 49 | 50 | ### Changes in 0.2.1 (2021-10-09) 51 | 52 | - Fixed: Release changelog 53 | 54 | ### Changes in 0.2.0 (2021-10-09) 55 | 56 | - Added: Support for serving extra files over HTTP 57 | 58 | ### Changes in 0.1.3 (2021-10-09) 59 | 60 | - Fixed: Failing build due to broken action 61 | 62 | ### Changes in 0.1.2 (2021-10-09) 63 | 64 | - Fixed: Missing version string 65 | 66 | ### Changes in 0.1.1 (2021-10-09) 67 | 68 | - Fixed: Missing binaries in releases 69 | - Fixed: Container image tag 70 | 71 | ### Changes in 0.1.0 (2021-10-09) 72 | 73 | - Initial release 74 | -------------------------------------------------------------------------------- /Containerfile: -------------------------------------------------------------------------------- 1 | FROM scratch 2 | 3 | COPY --chown=65536:65536 --chmod=0777 pixie / 4 | 5 | # set default ports for rootless use 6 | ENV TFTP :6969 7 | ENV HTTP :8080 8 | ENV SCRIPTS /scripts 9 | 10 | EXPOSE 6969/udp 11 | EXPOSE 8080/tcp 12 | VOLUME /scripts 13 | 14 | CMD ["/pixie"] 15 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pixie 2 | 3 | TFTP and HTTP server specifically designed to serve [iPXE](https://ipxe.org). 4 | 5 | pixie comes embedded with the following ROMs provided by the iPXE project: 6 | 7 | - `undionly.kpxe` - for legacy (BIOS) machines 8 | - `snponly64.efi` - for 64-bit EFI machines 9 | - `snponly32.efi` - for 32-bit EFI machines 10 | - `ipxe64.efi` - for 64-bit EFI machines (contains embedded networking stack) 11 | - `ipxe32.efi` - for 32-bit EFI machines (contains embedded networking stack) 12 | - `snponly-arm64.efi` - for 64-bit ARM machines 13 | - `snponly-arm32.efi` - for 32-bit ARM machines 14 | 15 | It comes with an embedded [iPXE script](https://ipxe.org/scripting), which is used to chainload into per-machine iPXE scripts or access an iPXE shell. 16 | 17 | ![iPXE menu](https://user-images.githubusercontent.com/26496/136672695-f7598db1-d067-4ac7-93d3-6a640726d471.png) 18 | 19 | It has no dependencies, everything is in one binary. 20 | 21 | ## Usage 22 | 23 | 1. Run the `pixie` binary using default ports, specifying path to store iPXE scripts: 24 | 25 | ``` 26 | pixie -d /srv/ipxe 27 | ``` 28 | 29 | > See `--help` for more options 30 | 31 | 2. Define iPXE script for a machine with the MAC-address `00:11:22:33:44:55`: 32 | 33 | ``` 34 | cat >/srv/ipxe/00-11-22-33-44-55.ipxe < In both these examples `pixie` runs on `192.168.0.100` 69 | 70 | ### Walkthrough 71 | 72 | When a machine with the MAC-address of `00:11:22:33:44:55` now attempts to PXE boot, the following will happen: 73 | 74 | 1. The machine queries DHCP (standard procedure from PXE) 75 | 2. The DHCP server will instruct the machine to download a new ROM from pixie (`next-server`) using TFTP 76 | - if the machine is running BIOS it will ask for `undionly.kpxe` 77 | - if the machine is running EFI it will ask for `snponly.efi` 78 | 3. The machine downloads and runs the iPXE ROM from pixie 79 | 4. The machine queries DHCP again (this time from iPXE) 80 | 5. The DHCP server will instruct the machine to download the `chain.ipxe` file from pixie using TFTP 81 | 6. The machine downloads and runs the `chain.ipxe` script 82 | - the screenshot above shows this stage 83 | 7. Unless manually intervened, the machine chainloads into its iPXE script from pixie using HTTP 84 | 8. The machine boots the operating system 85 | -------------------------------------------------------------------------------- /cmd/pixie/cmd.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "sync" 7 | 8 | "github.com/alexflint/go-arg" 9 | "github.com/p3lim/pixie/pkg/http" 10 | "github.com/p3lim/pixie/pkg/log" 11 | "github.com/p3lim/pixie/pkg/tftp" 12 | ) 13 | 14 | var version = "dev" 15 | 16 | type args struct { 17 | TFTP string `arg:"-t,env" default:"0.0.0.0:69" placeholder:"ADDR" help:"tftp server address and port"` 18 | HTTP string `arg:"-u,env" default:"0.0.0.0:80" placeholder:"ADDR" help:"http server address and port"` 19 | Scripts string `arg:"-d,env,required" placeholder:"DIR" help:"path to iPXE scripts served from HTTP"` 20 | Extra string `arg:"-e,env" placeholder:"DIR" help:"path to extra files served from HTTP"` 21 | Verbosity string `arg:"-v,env:LEVEL" default:"INFO" placeholder:"LEVEL" help:"verbosity level (ERROR,WARNING,INFO,DEBUG)"` 22 | } 23 | 24 | func (args) Version() string { 25 | return fmt.Sprintf("pixie %s", version) 26 | } 27 | 28 | func main() { 29 | var cfg args 30 | arg.MustParse(&cfg) 31 | 32 | if err := cfg.Validate(); err != nil { 33 | fmt.Println(err) 34 | os.Exit(1) 35 | } 36 | 37 | if level, err := log.GetLevel(cfg.Verbosity); err != nil { 38 | fmt.Println(err) 39 | os.Exit(1) 40 | } else { 41 | log.SetLevel(level) 42 | } 43 | 44 | wg := new(sync.WaitGroup) 45 | wg.Add(2) 46 | 47 | go func() { 48 | tftpServer := tftp.NewServer(cfg.TFTP, cfg.HTTP) 49 | log.Infof("tftp server listening on %s", cfg.TFTP) 50 | log.Fatal(tftpServer.Serve()) 51 | wg.Done() 52 | }() 53 | 54 | go func() { 55 | httpServer := http.NewServer(cfg.HTTP, cfg.Scripts, cfg.Extra) 56 | log.Infof("http server listening on %s", cfg.HTTP) 57 | log.Fatal(httpServer.Serve()) 58 | wg.Done() 59 | }() 60 | 61 | wg.Wait() 62 | } 63 | -------------------------------------------------------------------------------- /cmd/pixie/validate.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "net" 6 | "os" 7 | "strconv" 8 | ) 9 | 10 | func parseHostPort(hostport string) error { 11 | host, port, err := net.SplitHostPort(hostport) 12 | if err != nil { 13 | return err 14 | } 15 | 16 | portInt, err := strconv.Atoi(port) 17 | if err != nil { 18 | return fmt.Errorf("unable to parse port") 19 | } 20 | if portInt < 1 || portInt > 65535 { 21 | return fmt.Errorf("invalid port %d", portInt) 22 | } 23 | if host != "" && net.ParseIP(host) == nil { 24 | return fmt.Errorf("invalid ip %s", host) 25 | } 26 | 27 | return nil 28 | } 29 | 30 | func parseDir(path string) error { 31 | if fs, err := os.Stat(path); os.IsNotExist(err) { 32 | return fmt.Errorf("path does not exist at %s", path) 33 | } else if os.IsPermission(err) { 34 | return fmt.Errorf("path is not accessible at %s", path) 35 | } else if !fs.IsDir() { 36 | return fmt.Errorf("path is not a directory at %s", path) 37 | } 38 | 39 | return nil 40 | } 41 | 42 | func (cfg args) Validate() error { 43 | if err := parseHostPort(cfg.TFTP); err != nil { 44 | return err 45 | } 46 | if err := parseHostPort(cfg.HTTP); err != nil { 47 | return err 48 | } 49 | if err := parseDir(cfg.Scripts); err != nil { 50 | return err 51 | } 52 | if cfg.Extra != "" { 53 | if err := parseDir(cfg.Extra); err != nil { 54 | return err 55 | } 56 | } 57 | 58 | return nil 59 | } 60 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/p3lim/pixie 2 | 3 | go 1.21 4 | 5 | require ( 6 | github.com/alexflint/go-arg v1.5.1 7 | github.com/pin/tftp/v3 v3.1.0 8 | ) 9 | 10 | require ( 11 | github.com/alexflint/go-scalar v1.2.0 // indirect 12 | golang.org/x/net v0.21.0 // indirect 13 | golang.org/x/sys v0.17.0 // indirect 14 | ) 15 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/alexflint/go-arg v1.5.1 h1:nBuWUCpuRy0snAG+uIJ6N0UvYxpxA0/ghA/AaHxlT8Y= 2 | github.com/alexflint/go-arg v1.5.1/go.mod h1:A7vTJzvjoaSTypg4biM5uYNTkJ27SkNTArtYXnlqVO8= 3 | github.com/alexflint/go-scalar v1.2.0 h1:WR7JPKkeNpnYIOfHRa7ivM21aWAdHD0gEWHCx+WQBRw= 4 | github.com/alexflint/go-scalar v1.2.0/go.mod h1:LoFvNMqS1CPrMVltza4LvnGKhaSpc3oyLEBUZVhhS2o= 5 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 6 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 7 | github.com/pin/tftp/v3 v3.1.0 h1:rQaxd4pGwcAJnpId8zC+O2NX3B2/NscjDZQaqEjuE7c= 8 | github.com/pin/tftp/v3 v3.1.0/go.mod h1:xwQaN4viYL019tM4i8iecm++5cGxSqen6AJEOEyEI0w= 9 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 10 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 11 | github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= 12 | github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= 13 | github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 14 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 15 | golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= 16 | golang.org/x/net v0.21.0 h1:AQyQV4dYCvJ7vGmJyKki9+PBdyvhkSd8EIx/qb0AYv4= 17 | golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= 18 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 19 | golang.org/x/sys v0.17.0 h1:25cE3gD+tdBA7lp7QfhuV+rJiE9YXTcS3VG1SqssI/Y= 20 | golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= 21 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 22 | gopkg.in/yaml.v3 v3.0.0 h1:hjy8E9ON/egN1tAYqKb61G10WtihqetD4sz2H+8nIeA= 23 | gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 24 | -------------------------------------------------------------------------------- /pkg/http/server.go: -------------------------------------------------------------------------------- 1 | package http 2 | 3 | import ( 4 | "net/http" 5 | ) 6 | 7 | type Server struct { 8 | Addr string 9 | Scripts string 10 | Extra string 11 | } 12 | 13 | func NewServer(addr string, path, extra string) *Server { 14 | return &Server{ 15 | Addr: addr, 16 | Scripts: path, 17 | Extra: extra, 18 | } 19 | } 20 | 21 | func (server *Server) Serve() error { 22 | mux := http.NewServeMux() 23 | mux.Handle("/ipxe/", http.StripPrefix("/ipxe", http.FileServer(http.Dir(server.Scripts)))) 24 | 25 | if server.Extra != "" { 26 | mux.Handle("/extra/", http.StripPrefix("/extra", http.FileServer(http.Dir(server.Extra)))) 27 | } 28 | 29 | return http.ListenAndServe(server.Addr, mux) 30 | } 31 | -------------------------------------------------------------------------------- /pkg/log/level.go: -------------------------------------------------------------------------------- 1 | package log 2 | 3 | import "fmt" 4 | 5 | type Level int 6 | 7 | const ( 8 | ERROR = iota 9 | WARNING 10 | INFO 11 | DEBUG 12 | ) 13 | 14 | var logLevel Level = INFO 15 | 16 | func SetLevel(level Level) { 17 | logLevel = level 18 | } 19 | 20 | func GetLevel(str string) (Level, error) { 21 | switch str { 22 | case "ERROR": 23 | return ERROR, nil 24 | case "WARNING": 25 | return WARNING, nil 26 | case "INFO": 27 | return INFO, nil 28 | case "DEBUG": 29 | return DEBUG, nil 30 | default: 31 | return 0, fmt.Errorf("invalid verbosity level %s", str) 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /pkg/log/log.go: -------------------------------------------------------------------------------- 1 | package log 2 | 3 | import ( 4 | "fmt" 5 | "log" 6 | ) 7 | 8 | func Fatal(v ...interface{}) { 9 | if logLevel >= ERROR { 10 | log.Fatalf("[FATAL] %v", v...) 11 | } 12 | } 13 | 14 | func Fatalf(format string, v ...interface{}) { 15 | if logLevel >= ERROR { 16 | log.Fatalf("[FATAL] %v", fmt.Sprintf(format, v...)) 17 | } 18 | } 19 | 20 | func Error(v ...interface{}) { 21 | if logLevel >= ERROR { 22 | log.Printf("[ERROR] %v", v...) 23 | } 24 | } 25 | 26 | func Errorf(format string, v ...interface{}) { 27 | if logLevel >= ERROR { 28 | log.Printf("[ERROR] %v", fmt.Sprintf(format, v...)) 29 | } 30 | } 31 | 32 | func Warning(v ...interface{}) { 33 | if logLevel >= WARNING { 34 | log.Printf("[WARNING] %v", v...) 35 | } 36 | } 37 | 38 | func Warningf(format string, v ...interface{}) { 39 | if logLevel >= WARNING { 40 | log.Printf("[WARNING] %v", fmt.Sprintf(format, v...)) 41 | } 42 | } 43 | 44 | func Info(v ...interface{}) { 45 | if logLevel >= INFO { 46 | log.Printf("[INFO] %v", v...) 47 | } 48 | } 49 | 50 | func Infof(format string, v ...interface{}) { 51 | if logLevel >= INFO { 52 | log.Printf("[INFO] %v", fmt.Sprintf(format, v...)) 53 | } 54 | } 55 | 56 | func Debug(v ...interface{}) { 57 | if logLevel >= DEBUG { 58 | log.Printf("[DEBUG] %v", v...) 59 | } 60 | } 61 | 62 | func Debugf(format string, v ...interface{}) { 63 | if logLevel >= DEBUG { 64 | log.Printf("[DEBUG] %v", fmt.Sprintf(format, v...)) 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /pkg/tftp/chain.ipxe: -------------------------------------------------------------------------------- 1 | #!ipxe 2 | 3 | menu PXE Boot Options 4 | 5 | item install Chainload installation 6 | item xyz Chainload netboot.xyz 7 | item shell iPXE shell 8 | item exit Exit 9 | 10 | choose --default install --timeout 10000 option && goto ${option} 11 | 12 | :install 13 | chain http://${next-server}:HTTP_PORT/ipxe/${mac:hexhyp}.ipxe 14 | 15 | :xyz 16 | chain --autofree http://boot.netboot.xyz 17 | 18 | :shell 19 | shell 20 | 21 | :exit 22 | exit 23 | -------------------------------------------------------------------------------- /pkg/tftp/embed.go: -------------------------------------------------------------------------------- 1 | package tftp 2 | 3 | import _ "embed" 4 | 5 | // this will embed iPXE ROMs already present in the `ipxe` subdirectory relative to this file into 6 | // variables during build time. 7 | 8 | //go:embed ipxe/src/bin/undionly.kpxe 9 | var undionly []byte 10 | 11 | //go:embed ipxe/src/bin-x86_64-efi/ipxe.efi 12 | var ipxe64 []byte 13 | 14 | //go:embed ipxe/src/bin-i386-efi/ipxe.efi 15 | var ipxe32 []byte 16 | 17 | //go:embed ipxe/src/bin-x86_64-efi/snponly.efi 18 | var snponly64 []byte 19 | 20 | //go:embed ipxe/src/bin-i386-efi/snponly.efi 21 | var snponly32 []byte 22 | 23 | //go:embed ipxe/src/bin-arm64-efi/snponly.efi 24 | var snponly64arm []byte 25 | 26 | //go:embed ipxe/src/bin-arm32-efi/snponly.efi 27 | var snponly32arm []byte 28 | 29 | //go:embed chain.ipxe 30 | var chainTemplate string 31 | -------------------------------------------------------------------------------- /pkg/tftp/server.go: -------------------------------------------------------------------------------- 1 | package tftp 2 | 3 | import ( 4 | "bytes" 5 | "io" 6 | "net" 7 | "os" 8 | "strings" 9 | 10 | "github.com/p3lim/pixie/pkg/log" 11 | "github.com/pin/tftp/v3" 12 | ) 13 | 14 | type Server struct { 15 | Addr string 16 | 17 | chain string 18 | } 19 | 20 | func NewServer(addr string, http string) *Server { 21 | _, httpPort, _ := net.SplitHostPort(http) // already validated 22 | return &Server{ 23 | Addr: addr, 24 | chain: strings.Replace(chainTemplate, "HTTP_PORT", httpPort, 1), 25 | } 26 | } 27 | 28 | func (server *Server) Serve() error { 29 | tftpServer := tftp.NewServer(server.readHandler, server.writeHandler) 30 | return tftpServer.ListenAndServe(server.Addr) 31 | } 32 | 33 | func (server *Server) readHandler(filename string, rf io.ReaderFrom) (err error) { 34 | remoteAddr := "" 35 | if raddr, ok := rf.(tftp.OutgoingTransfer); ok { 36 | r := raddr.RemoteAddr() 37 | remoteAddr = r.String() 38 | } 39 | 40 | log.Debugf("request for '%s' by '%s'", filename, remoteAddr) 41 | 42 | var n int64 43 | switch filename { 44 | case "chain.ipxe": 45 | n, err = rf.ReadFrom(strings.NewReader(server.chain)) 46 | case "undionly.kpxe": 47 | n, err = rf.ReadFrom(bytes.NewReader(undionly)) 48 | case "ipxe64.efi", "ipxe.efi": 49 | n, err = rf.ReadFrom(bytes.NewReader(ipxe64)) 50 | case "ipxe32.efi": 51 | n, err = rf.ReadFrom(bytes.NewReader(ipxe32)) 52 | case "snponly64.efi", "snponly.efi": 53 | n, err = rf.ReadFrom(bytes.NewReader(snponly64)) 54 | case "snponly32.efi": 55 | n, err = rf.ReadFrom(bytes.NewReader(snponly32)) 56 | case "snponly-arm64.efi", "snponly-arm.efi": 57 | n, err = rf.ReadFrom(bytes.NewReader(snponly64arm)) 58 | case "snponly-arm32.efi": 59 | n, err = rf.ReadFrom(bytes.NewReader(snponly32arm)) 60 | default: 61 | err = os.ErrNotExist 62 | } 63 | 64 | log.Debugf("%d bytes written to '%s'", n, remoteAddr) 65 | 66 | return err 67 | } 68 | 69 | func (Server) writeHandler(filename string, wt io.WriterTo) error { 70 | remoteAddr := "" 71 | if raddr, ok := wt.(tftp.IncomingTransfer); ok { 72 | r := raddr.RemoteAddr() 73 | remoteAddr = r.String() 74 | } 75 | 76 | log.Debugf("request to write '%s' denied for '%s'", filename, remoteAddr) 77 | return os.ErrPermission 78 | } 79 | --------------------------------------------------------------------------------