Repository: FiloSottile/age Branch: main Commit: 4a3a4ef00aa1 Files: 94 Total size: 444.6 KB Directory structure: gitextract_a732ze8h/ ├── .gitattributes ├── .github/ │ ├── CONTRIBUTING.md │ ├── ISSUE_TEMPLATE/ │ │ ├── bug-report.md │ │ └── config.yml │ └── workflows/ │ ├── LICENSE.suffix.txt │ ├── build.yml │ ├── certs/ │ │ ├── README │ │ ├── uitacllc.crt │ │ └── uitacllc.key │ ├── interop.yml │ ├── ronn.yml │ └── test.yml ├── LICENSE ├── README.md ├── SIGSUM.md ├── age.go ├── age_test.go ├── agessh/ │ ├── agessh.go │ ├── agessh_test.go │ └── encrypted_keys.go ├── armor/ │ ├── armor.go │ └── armor_test.go ├── cmd/ │ ├── age/ │ │ ├── age.go │ │ ├── age_test.go │ │ ├── encrypted_keys.go │ │ ├── parse.go │ │ ├── testdata/ │ │ │ ├── armor.txt │ │ │ ├── batchpass.txt │ │ │ ├── duplicates.txt │ │ │ ├── ed25519.txt │ │ │ ├── encrypted_keys.txt │ │ │ ├── hybrid.txt │ │ │ ├── keygen.txt │ │ │ ├── output_file.txt │ │ │ ├── pkcs8.txt │ │ │ ├── plugin.txt │ │ │ ├── rsa.txt │ │ │ ├── scrypt.txt │ │ │ ├── terminal.txt │ │ │ ├── usage.txt │ │ │ └── x25519.txt │ │ ├── tui.go │ │ └── wordlist.go │ ├── age-inspect/ │ │ └── inspect.go │ ├── age-keygen/ │ │ └── keygen.go │ └── age-plugin-batchpass/ │ └── plugin-batchpass.go ├── doc/ │ ├── age-inspect.1 │ ├── age-inspect.1.html │ ├── age-inspect.1.ronn │ ├── age-keygen.1 │ ├── age-keygen.1.html │ ├── age-keygen.1.ronn │ ├── age-plugin-batchpass.1 │ ├── age-plugin-batchpass.1.html │ ├── age-plugin-batchpass.1.ronn │ ├── age.1 │ ├── age.1.html │ └── age.1.ronn ├── extra/ │ ├── age-plugin-pq/ │ │ └── plugin-pq.go │ ├── age-plugin-tag/ │ │ └── plugin-tag.go │ └── age-plugin-tagpq/ │ └── plugin-tagpq.go ├── go.mod ├── go.sum ├── internal/ │ ├── bech32/ │ │ ├── bech32.go │ │ └── bech32_test.go │ ├── format/ │ │ ├── format.go │ │ └── format_test.go │ ├── inspect/ │ │ ├── inspect.go │ │ └── inspect_test.go │ ├── stream/ │ │ ├── stream.go │ │ └── stream_test.go │ └── term/ │ ├── term.go │ └── term_windows.go ├── logo/ │ └── README.md ├── parse.go ├── plugin/ │ ├── client.go │ ├── client_test.go │ ├── encode.go │ ├── example_test.go │ ├── plugin.go │ └── tui.go ├── pq.go ├── primitives.go ├── recipients_test.go ├── scrypt.go ├── tag/ │ ├── internal/ │ │ ├── age-plugin-tagtest/ │ │ │ └── plugin-tagtest.go │ │ └── tagtest/ │ │ └── tagtest.go │ ├── tag.go │ └── tag_test.go ├── testdata/ │ ├── example.age │ ├── example.zip.age │ └── example_keys.txt ├── testkit_test.go └── x25519.go ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitattributes ================================================ *.age binary testdata/testkit/* binary ================================================ FILE: .github/CONTRIBUTING.md ================================================ ## Issues I want to hear about any issues you encounter while using age. Particularly appreciated are well researched, complete [issues](https://github.com/FiloSottile/age/issues/new/choose) with lots of context, **focusing on the intended outcome and/or use case**. Issues don't have to be just about bugs: if something was hard to figure out or unexpected, please file a **[UX report](https://github.com/FiloSottile/age/discussions/new?category=UX-reports)**! ✨ Not all issue reports might lead to a change, so please don't be offended if yours doesn't, but they are precious datapoints to understand how age could work better in aggregate. ## Pull requests age is a little unusual in how it is maintained. I like to keep the code style consistent and complexity to a minimum, and going through many iterations of code review is a significant toil on both contributors and maintainers. age is also small enough that such a time investment is unlikely to pay off over ongoing contributions. Therefore, **be prepared for your change to get reimplemented rather than merged**, and please don't be offended if that happens. PRs are still appreciated as a way to clarify the intended behavior, but are not at all required: prefer focusing on providing detailed context in an issue report instead. To learn more, please see my [maintenance policy](https://github.com/FiloSottile/FiloSottile/blob/main/maintenance.md). ## Other ways to contribute age itself is not community maintained, but its ecosystem very much is, and that's where a lot of the strength of age is! Here are some ideas for ways to contribute to age and its ecosystem, besides contributing to this repository. * **Write an article about how to use age for a certain community or use case.** The number one reason people don't use age is because they haven't heard about it and existing tutorials present more complex alternatives. * Integrate age into existing projects that might use it, for example replacing legacy alternatives. * Build and maintain an [age plugin](https://c2sp.org/age-plugin) for a KMS or platform. * Watch the [discussions](https://github.com/FiloSottile/age/discussions) and help other users. * Provide bindings in a language or framework that doesn't support age well. * Package age for an ecosystem that doesn't have packages yet. If you build or write something related to age, [let me know](https://github.com/FiloSottile/age/discussions/new?category=general)! 💖 ================================================ FILE: .github/ISSUE_TEMPLATE/bug-report.md ================================================ --- name: Bug report 🐞 about: Did you encounter a bug in this implementation? title: '' labels: '' assignees: '' --- ## Environment * OS: * age version: ## What were you trying to do ## What happened ``` ``` ================================================ FILE: .github/ISSUE_TEMPLATE/config.yml ================================================ contact_links: - name: UX report ✨ url: https://github.com/FiloSottile/age/discussions/new?category=UX-reports about: Was age hard to use? It's not you, it's us. We want to hear about it. - name: Spec feedback 📃 url: https://github.com/FiloSottile/age/discussions/new?category=Spec-feedback about: Have a comment about the age spec as it's implemented by this and other tools? - name: Questions, feature requests, and more 💬 url: https://github.com/FiloSottile/age/discussions about: Do you need support? Did you make something with age? Do you have an idea? Tell us about it! ================================================ FILE: .github/workflows/LICENSE.suffix.txt ================================================ --- Copyright 2009 The Go Authors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ================================================ FILE: .github/workflows/build.yml ================================================ name: Build and upload binaries on: release: types: [published] push: pull_request: permissions: contents: read jobs: build: name: Build binaries runs-on: ubuntu-latest strategy: matrix: include: - {GOOS: linux, GOARCH: amd64} - {GOOS: linux, GOARCH: arm, GOARM: 6} - {GOOS: linux, GOARCH: arm64} - {GOOS: darwin, GOARCH: arm64} - {GOOS: darwin, GOARCH: amd64} - {GOOS: windows, GOARCH: amd64} - {GOOS: freebsd, GOARCH: amd64} steps: - name: Checkout repository uses: actions/checkout@v5 with: fetch-depth: 0 persist-credentials: false - name: Install Go uses: actions/setup-go@v6 with: go-version-file: go.mod cache: false - name: Build binary run: | VERSION="$(git describe --tags)" DIR="$(mktemp -d)" mkdir "$DIR/age" go build -o "$DIR/age" -trimpath ./cmd/... cp LICENSE "$DIR/age/LICENSE" cat .github/workflows/LICENSE.suffix.txt >> "$DIR/age/LICENSE" if [ "$GOOS" == "windows" ]; then sudo apt-get update && sudo apt-get install -y osslsigncode if [ -n "${{ secrets.SIGN_PASS }}" ]; then for exe in "$DIR"/age/*.exe; do /usr/bin/osslsigncode sign -t "http://timestamp.comodoca.com" \ -certs .github/workflows/certs/uitacllc.crt \ -key .github/workflows/certs/uitacllc.key \ -pass "${{ secrets.SIGN_PASS }}" \ -n age -in "$exe" -out "$exe.signed" mv "$exe.signed" "$exe" done fi ( cd "$DIR"; zip age.zip -r age ) mv "$DIR/age.zip" "age-$VERSION-$GOOS-$GOARCH.zip" else tar -cvzf "age-$VERSION-$GOOS-$GOARCH.tar.gz" -C "$DIR" age fi env: CGO_ENABLED: 0 GOOS: ${{ matrix.GOOS }} GOARCH: ${{ matrix.GOARCH }} GOARM: ${{ matrix.GOARM }} - name: Upload workflow artifacts uses: actions/upload-artifact@v4 with: name: age-artifacts-${{ matrix.GOOS }}-${{ matrix.GOARCH }} path: age-* source: name: Package source code runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v5 with: fetch-depth: 0 persist-credentials: false - name: Install Go uses: actions/setup-go@v6 with: go-version-file: go.mod cache: false - name: Create source tarball run: | VERSION="$(git describe --tags)" DIR="$(mktemp -d)" mkdir "$DIR/age" git archive --format=tar.gz HEAD | tar -xz -C "$DIR/age" ( cd "$DIR/age"; go mod vendor ) for cmd in "$DIR"/age/{cmd,extra}/*; do echo "package main" >> "$cmd/version.go" echo "" >> "$cmd/version.go" echo "func init() { Version = \"$VERSION\" }" >> "$cmd/version.go" done tar -cvzf "age-$VERSION-source.tar.gz" -C "$DIR" age - name: Upload workflow artifacts uses: actions/upload-artifact@v4 with: name: age-artifacts-source path: age-*-source.tar.gz upload: name: Upload and attest release artifacts if: github.event_name == 'release' needs: [build, source] permissions: contents: write attestations: write id-token: write runs-on: ubuntu-latest steps: - name: Download workflow artifacts uses: actions/download-artifact@v4 with: pattern: age-artifacts-* merge-multiple: true - name: Generate artifacts attestation uses: actions/attest-build-provenance@v3 with: subject-path: age-* - name: Upload release artifacts run: gh release upload "$GITHUB_REF_NAME" age-* env: GH_REPO: ${{ github.repository }} GH_TOKEN: ${{ github.token }} ================================================ FILE: .github/workflows/certs/README ================================================ In this folder there are uitacllc.crt PKCS#7 encoded certificate chain for a code signing certificate issued to Up in the Air Consulting LLC valid until Sep 26 23:59:59 2024 GMT. https://crt.sh/?id=5339775059 uitacllc.key PEM encrypted private key for the leaf certificate above. Its passphrase is long and randomly generated, so the awful legacy key derivation doesn't really matter, and it makes osslsigncode happy. ================================================ FILE: .github/workflows/certs/uitacllc.key ================================================ -----BEGIN RSA PRIVATE KEY----- Proc-Type: 4,ENCRYPTED DEK-Info: AES-256-CBC,B93C1A166F3677D68FB9CB3E8A184729 UriYsaq3tLyvycDDB2YeQ+9L1P5VCPcfVkYR1ocleF8WxNDUPdz3RqbryAZZdXVO 0bcvAHTXkdI4Oiw5mN0S8fGsNq9zn+pyResx3lXtgN3oCDCe2SQn28uEEKxPzud5 0NRXYoBP+pLDjiuQ/6Lp7DovnAO/uxaPFvYRMiknNVOhwyHGWZyuUe01S9J9im7y vgc1wkyQzmABIhARynEXHp3KnM9aF8X1/ck839lQRBFrvRFNm5rqiON26spr1Hu5 znrbVGROYk0XNdH5VHDk7V9k+v2WLL/b4nxlMymZpDzr9pXzX8olpLnQrarsMbHe ysfXNTtQi5Dq6KXURW8VA4DmxAzTRNUxe2aA4JnAEyFU5LDLetTN9F9M7BUkHbXH RpSbZqDjPwg7U98vuSwxjIkncHSiYYi3FmSoupLvV+eIP6qRSgONdzGlP5NTn4Lh N1lYMPHPldH6UjLHrldkYN16TQlrqNHZExN91XvsZVjpyAgErY18xwi3CTEco45D fRqsiWXtoas4LkafhSY0vfl5aFhY9YPUpS6uFdgWBvgcQeYb8meX5Nr4dNXVk5Wa yRlYlW/X0TWC0T9qaBOPN/z7OWO5aL4jYRcKQQ+aR8gFcHGGCpRAKD369OneXfOQ MD9UHoPG4WTBg/NU9OSskcywfuSOkwAGfBVNXrnEj6tYFjsjYK2nC2gm+opUCfm0 a1FeDb5nQSOgOJKUCO6Aj+0NvDvVLUOsTk1lfzSugIkmUOdV+rXHnrZC+90q8KfN S2JlzwSZNg0e+VxZpnD7k7axHkbHrbebtrLvzKVnrh3s0OFAXN0isMw7yhhWtzUe mPoQTZusLDOAJe/QPuNlDUgr4uoVZtoXrPzoZZkw2VFLwYy2g/EYvlK9BdVVTnRm 9Hq9IBDrZw+SV/7roaeVOXbzrQoxEoXcL7eo6iWvV5Q7Ll5C4ovelHKy3IAzcpYP 6LKfxAO2sIKTALrHbtBNG+O4RTtxOva1hyg27V4v2k53CF/GhoBRPSpbbupwppXc lJJ9RtMTRfhCv/ObhdsJED+YUqFifTJfcnQ1iGN8dnBuGrjXxVCN0wgmv46Pdhn0 tUfGlkFquOOWamaVaIvp6JCVUDa1ezMzleILoYvrxvOuP+dGVrwTwVCXpx4JuUgp d72/w+EnqlZnwsAzdrErJFXnHux981ZoojmG94km1B6gPPwMB8JRcD67lfhG/vne IpTuuzGaSInf24cGNig01hbBuKSg79yNY0llkECPBXbEhfkemEMhg1WHoNP2eG8j MHS5OCT5KiOfi77pSO3M2mGB1HWYE5R0lcMibukK9ZdyIYcTeMZ0RcGm6YSNv570 ok/Ex4LUCW66AIWFefmbIOtJSIMHlNKWRPJwnJxVoE5qgH0f/2xL3k15vpI55lAS sabzegnYlElPbUlZGhgwjKknxgqMhFIW/ZS0h2FukFLwipr4qI47nHWz5dguNkYn 48sSKg3YMhVx/sT+X2A/6zqsC+p4PT7Ti5ruWb7S9L9vRuBdIDNE9qAwuz0g8Bs3 WhOx6OW2ZqDQEuRhN0lyGA0mwRC4HPFE9b8dnN8lNm+RsnMfNoFxzPnqtsxhEAwa 2a4ijT97ka94lDy7WQ2bwLRz7trKV/T6MeETKE4s7+z2dMTr1f8IwA2uCovFmO9T aMQAePFEtDT3qwIPu0zH1ocSCkZ50f7RgVmp4FNn03uT/TnsASrr5CS9m8A9gjEn QiztQyqt27fTT61YkNdA6lwbpFiByugVbS+mWsNa9kvBkgQkcMQwgrELmU9sYdBT nRMa60i0nEINT/x3zFvT6R7Dl/O8/QhXLeYv20X2roghPw48IovLb8x7dT3YEQSn ARIXXVPxwOVvS8xcCa69/+1HjC6vNG9dNNnAsVHxB8mDTBqmmLzAMOVzDoNWEgDd zoRhQ3ORb1brPlKWg8um/svLiSV63ZYi2J8LPamoGmZ/7J8i5rjOpOeG493UICBR JymmYGUo6/C1Ze8swdMHApVU/spo0s8BCGkMjYUAaxXD7RufN2DuY30Vny/DMn4y XasuHS9RstD2Okv25PD06Y2H52HJ6MNdArmPZRe0k2ZbhATs5dXOfmaF5Z0f4IkE G+hsxE1wlCo900ewntx16sBCbI0v9aE+Napf2+ueqPQ06CdfiTG5yOmeXzgR/8zS KVmTHpmmFpYtj/N350BLAVb/Hwzmh+ieWnO7TUjvNAHUn2i5LZU65rN3GOlPyIlz DzB2T6KjOUPFKqSRrIin14HLyf5w0vDuJhe5Zpe0hhYKvoKhwCEVefbmkasWeso3 xsXxOOoL39GA0QpYjR6ztqR8fS9jTeu5IY+zY5LO8yS7+StP3H8CcqRMuxb3ntym -----END RSA PRIVATE KEY----- ================================================ FILE: .github/workflows/interop.yml ================================================ name: Interoperability tests on: push permissions: contents: read jobs: trigger: name: Trigger runs-on: ubuntu-latest steps: - name: Trigger interoperability tests in str4d/rage run: > gh api repos/str4d/rage/dispatches --field event_type="age-interop-request" --field client_payload[sha]="$GITHUB_SHA" env: GITHUB_TOKEN: ${{ secrets.RAGE_INTEROP_ACCESS_TOKEN }} ================================================ FILE: .github/workflows/ronn.yml ================================================ name: Generate man pages on: push: branches: - '**' paths: - '**.ronn' - '**/ronn.yml' permissions: contents: read jobs: ronn: name: Ronn runs-on: ubuntu-latest steps: - uses: actions/checkout@v5 with: persist-credentials: false - uses: geomys/sandboxed-step@v1.2.1 with: persist-workspace-changes: true run: | sudo apt-get update && sudo apt-get install -y ronn bash -O globstar -c 'ronn **/*.ronn' # rdiscount randomizes the output for no good reason, which causes # changes to always get committed. Sigh. # https://github.com/davidfstr/rdiscount/blob/6b1471ec3/ext/generate.c#L781-L795 for f in doc/*.html; do awk '/Filippo Valsorda/ { $0 = "

Filippo Valsorda age@filippo.io

" } { print }' "$f" > "$f.tmp" mv "$f.tmp" "$f" done - uses: actions/upload-artifact@v4 with: name: man-pages path: | doc/*.1 doc/*.html commit: name: Commit changes needs: ronn permissions: contents: write runs-on: ubuntu-latest steps: - uses: actions/checkout@v5 with: persist-credentials: true - uses: actions/download-artifact@v4 with: name: man-pages path: doc/ - name: Commit and push if changed run: |- git config user.name "GitHub Actions" git config user.email "actions@users.noreply.github.com" git add doc/ git commit -m "doc: regenerate groff and html man pages" || exit 0 git push ================================================ FILE: .github/workflows/test.yml ================================================ name: Go tests on: push: pull_request: schedule: # daily at 09:42 UTC - cron: '42 9 * * *' workflow_dispatch: permissions: contents: read jobs: test: strategy: fail-fast: false matrix: go: - { go-version: stable } - { go-version: oldstable } os: - ubuntu-latest - macos-latest - windows-latest runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v5 with: persist-credentials: false - uses: actions/setup-go@v6 with: go-version: ${{ matrix.go.go-version }} - run: | go test -race ./... test-latest: runs-on: ubuntu-latest strategy: fail-fast: false matrix: go: - { go-version: stable } - { go-version: oldstable } steps: - uses: actions/checkout@v5 with: persist-credentials: false - uses: actions/setup-go@v6 with: go-version: ${{ matrix.go.go-version }} - uses: geomys/sandboxed-step@v1.2.1 with: run: | go get -u -t ./... go test -race ./... staticcheck: runs-on: ubuntu-latest steps: - uses: actions/checkout@v5 with: persist-credentials: false - uses: actions/setup-go@v6 with: go-version: stable - uses: geomys/sandboxed-step@v1.2.1 with: run: go run honnef.co/go/tools/cmd/staticcheck@latest ./... govulncheck: runs-on: ubuntu-latest steps: - uses: actions/checkout@v5 with: persist-credentials: false - uses: actions/setup-go@v6 with: go-version: stable - uses: geomys/sandboxed-step@v1.2.1 with: run: go run golang.org/x/vuln/cmd/govulncheck@latest ./... ================================================ FILE: LICENSE ================================================ Copyright 2019 The age Authors Copyright 2019 Google LLC Copyright 2022 Filippo Valsorda Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the age project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ================================================ FILE: README.md ================================================

The age logo, a wireframe of St. Peters dome in Rome, with the text: age, file encryption

[![Go Reference](https://pkg.go.dev/badge/filippo.io/age.svg)](https://pkg.go.dev/filippo.io/age) [![man page]()](https://filippo.io/age/age.1) [![C2SP specification](https://img.shields.io/badge/%C2%A7%23-specification-blueviolet)](https://age-encryption.org/v1) age is a simple, modern and secure file encryption tool, format, and Go library. It features small explicit keys, post-quantum support, no config options, and UNIX-style composability. ``` $ age-keygen -o key.txt Public key: age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p $ tar cvz ~/data | age -r age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p > data.tar.gz.age $ age --decrypt -i key.txt data.tar.gz.age > data.tar.gz ``` 📜 The format specification is at [age-encryption.org/v1](https://age-encryption.org/v1). age was designed by [@benjojo](https://github.com/benjojo) and [@FiloSottile](https://github.com/FiloSottile). 🦀 An alternative interoperable Rust implementation is available at [github.com/str4d/rage](https://github.com/str4d/rage). 🌍 [Typage](https://github.com/FiloSottile/typage) is a TypeScript implementation. It works in the browser, Node.js, Deno, and Bun. 🔑 Hardware PIV tokens such as YubiKeys are supported through the [age-plugin-yubikey](https://github.com/str4d/age-plugin-yubikey) plugin. ✨ For more plugins, implementations, tools, and integrations, check out the [awesome age](https://github.com/FiloSottile/awesome-age) list. 💬 The author pronounces it `[aɡe̞]` [with a hard *g*](https://translate.google.com/?sl=it&text=aghe), like GIF, and it's always spelled lowercase. ## Installation
Homebrew (macOS or Linux) brew install age
MacPorts port install age
Windows winget install --id FiloSottile.age
Alpine Linux v3.15+ apk add age
Arch Linux pacman -S age
Debian 12+ (Bookworm) apt install age
Debian 11 (Bullseye) apt install age/bullseye-backports (enable backports for age v1.0.0+)
Fedora 33+ dnf install age
Gentoo Linux emerge app-crypt/age
Guix System guix package -i age
NixOS / Nix nix-env -i age
openSUSE Tumbleweed zypper install age
Ubuntu 22.04+ apt install age
Void Linux xbps-install age
FreeBSD pkg install age (security/age)
OpenBSD 6.7+ pkg_add age (security/age)
Chocolatey (Windows) choco install age.portable
Scoop (Windows) scoop bucket add extras && scoop install age
On Windows, Linux, macOS, and FreeBSD you can use the pre-built binaries. ``` https://dl.filippo.io/age/latest?for=linux/amd64 https://dl.filippo.io/age/v1.3.1?for=darwin/arm64 ... ``` If you download the pre-built binaries, you can check their [Sigsum proofs](./SIGSUM.md). If your system has [a supported version of Go](https://go.dev/dl/), you can build from source. ``` go install filippo.io/age/cmd/...@latest ``` Help from new packagers is very welcome. ## Usage For the full documentation, read [the age(1) man page](https://filippo.io/age/age.1). ``` Usage: age [--encrypt] (-r RECIPIENT | -R PATH)... [--armor] [-o OUTPUT] [INPUT] age [--encrypt] --passphrase [--armor] [-o OUTPUT] [INPUT] age --decrypt [-i PATH]... [-o OUTPUT] [INPUT] Options: -e, --encrypt Encrypt the input to the output. Default if omitted. -d, --decrypt Decrypt the input to the output. -o, --output OUTPUT Write the result to the file at path OUTPUT. -a, --armor Encrypt to a PEM encoded format. -p, --passphrase Encrypt with a passphrase. -r, --recipient RECIPIENT Encrypt to the specified RECIPIENT. Can be repeated. -R, --recipients-file PATH Encrypt to recipients listed at PATH. Can be repeated. -i, --identity PATH Use the identity file at PATH. Can be repeated. INPUT defaults to standard input, and OUTPUT defaults to standard output. If OUTPUT exists, it will be overwritten. RECIPIENT can be an age public key generated by age-keygen ("age1...") or an SSH public key ("ssh-ed25519 AAAA...", "ssh-rsa AAAA..."). Recipient files contain one or more recipients, one per line. Empty lines and lines starting with "#" are ignored as comments. "-" may be used to read recipients from standard input. Identity files contain one or more secret keys ("AGE-SECRET-KEY-1..."), one per line, or an SSH key. Empty lines and lines starting with "#" are ignored as comments. Passphrase encrypted age files can be used as identity files. Multiple key files can be provided, and any unused ones will be ignored. "-" may be used to read identities from standard input. When --encrypt is specified explicitly, -i can also be used to encrypt to an identity file symmetrically, instead or in addition to normal recipients. ``` ### Multiple recipients Files can be encrypted to multiple recipients by repeating `-r/--recipient`. Every recipient will be able to decrypt the file. ``` $ age -o example.jpg.age -r age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p \ -r age1lggyhqrw2nlhcxprm67z43rta597azn8gknawjehu9d9dl0jq3yqqvfafg example.jpg ``` #### Recipient files Multiple recipients can also be listed one per line in one or more files passed with the `-R/--recipients-file` flag. ``` $ cat recipients.txt # Alice age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p # Bob age1lggyhqrw2nlhcxprm67z43rta597azn8gknawjehu9d9dl0jq3yqqvfafg $ age -R recipients.txt example.jpg > example.jpg.age ``` If the argument to `-R` (or `-i`) is `-`, the file is read from standard input. ### Post-quantum keys To generate hybrid post-quantum keys, which are secure against future quantum computer attacks, use the `-pq` flag with `age-keygen`. This may become the default in the future. Post-quantum identities start with `AGE-SECRET-KEY-PQ-1...` and recipients with `age1pq1...`. The recipients are unfortunately ~2000 characters long. ``` $ age-keygen -pq -o key.txt $ age-keygen -y key.txt > recipient.txt $ age -R recipient.txt example.jpg > example.jpg.age $ age -d -i key.txt example.jpg.age > example.jpg ``` Support for post-quantum keys is built into age v1.3.0 and later. Alternatively, the `age-plugin-pq` binary can be installed and placed in `$PATH` to add support to any version and implementation of age that supports plugins. Recipients will work out of the box, while identities will have to be converted to plugin identities with `age-plugin-pq -identity`. ### Passphrases Files can be encrypted with a passphrase by using `-p/--passphrase`. By default age will automatically generate a secure passphrase. Passphrase protected files are automatically detected at decrypt time. ``` $ age -p secrets.txt > secrets.txt.age Enter passphrase (leave empty to autogenerate a secure one): Using the autogenerated passphrase "release-response-step-brand-wrap-ankle-pair-unusual-sword-train". $ age -d secrets.txt.age > secrets.txt Enter passphrase: ``` ### Passphrase-protected key files If an identity file passed to `-i` is a passphrase encrypted age file, it will be automatically decrypted. ``` $ age-keygen | age -p > key.age Public key: age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5 Enter passphrase (leave empty to autogenerate a secure one): Using the autogenerated passphrase "hip-roast-boring-snake-mention-east-wasp-honey-input-actress". $ age -r age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5 secrets.txt > secrets.txt.age $ age -d -i key.age secrets.txt.age > secrets.txt Enter passphrase for identity file "key.age": ``` Passphrase-protected identity files are not necessary for most use cases, where access to the encrypted identity file implies access to the whole system. However, they can be useful if the identity file is stored remotely. ### SSH keys As a convenience feature, age also supports encrypting to `ssh-rsa` and `ssh-ed25519` SSH public keys, and decrypting with the respective private key file. (`ssh-agent` is not supported.) ``` $ age -R ~/.ssh/id_ed25519.pub example.jpg > example.jpg.age $ age -d -i ~/.ssh/id_ed25519 example.jpg.age > example.jpg ``` Note that SSH key support employs more complex cryptography, and embeds a public key tag in the encrypted file, making it possible to track files that are encrypted to a specific public key. #### Encrypting to a GitHub user Combining SSH key support and `-R`, you can easily encrypt a file to the SSH keys listed on a GitHub profile. ``` $ curl https://github.com/benjojo.keys | age -R - example.jpg > example.jpg.age ``` Keep in mind that people might not protect SSH keys long-term, since they are revokable when used only for authentication, and that SSH keys held on YubiKeys can't be used to decrypt files. ### Inspecting encrypted files The `age-inspect` command can display metadata about an encrypted file without decrypting it, including the recipient types, whether it uses post-quantum encryption, and the payload size. ``` $ age-inspect secrets.age secrets.age is an age file, version "age-encryption.org/v1". This file is encrypted to the following recipient types: - "mlkem768x25519" This file uses post-quantum encryption. Size breakdown (assuming it decrypts successfully): Header 1627 bytes Encryption overhead 32 bytes Payload 42 bytes ------------------- Total 1701 bytes ``` For scripting, use `--json` to get machine-readable output. ================================================ FILE: SIGSUM.md ================================================ If you download the pre-built binaries of version v1.2.0+, you can check their [Sigsum](https://www.sigsum.org) proofs, which are like signatures with extra transparency: you can cryptographically verify that every proof is logged in a public append-only log, so the age project can be held accountable for every binary release we ever produced. This is similar to what the [Go Checksum Database](https://go.dev/blog/module-mirror-launch) provides. ``` cat << EOF > age-sigsum-key.pub ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIM1WpnEswJLPzvXJDiswowy48U+G+G1kmgwUE2eaRHZG ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAz2WM5CyPLqiNjk7CLl4roDXwKhQ0QExXLebukZEZFS EOF curl -JLO "https://dl.filippo.io/age/v1.3.1?for=darwin/arm64" curl -JLO "https://dl.filippo.io/age/v1.3.1?for=darwin/arm64&proof" go install sigsum.org/sigsum-go/cmd/sigsum-verify@v0.13.1 sigsum-verify -k age-sigsum-key.pub -P sigsum-generic-2025-1 \ age-v1.3.1-darwin-arm64.tar.gz.proof < age-v1.3.1-darwin-arm64.tar.gz ``` You can learn more about what's happening above in the [Sigsum docs](https://www.sigsum.org/getting-started/). ### Release playbook Dear future me, to sign a new release and produce Sigsum proofs, run the following ``` VERSION=v1.3.1 go install sigsum.org/sigsum-go/cmd/sigsum-verify@latest go install github.com/tillitis/tkey-ssh-agent/cmd/tkey-ssh-agent@main tkey-ssh-agent --agent-socket tkey-ssh-agent.sock --uss passage -c other/tkey-ssh-sigsum-age SSH_AUTH_SOCK=tkey-ssh-agent.sock ssh-add -L > tkey-ssh-agent.pub passage other/sigsum-ratelimit > sigsum-ratelimit gh release download $VERSION --repo FiloSottile/age --dir artifacts/ SSH_AUTH_SOCK=tkey-ssh-agent.sock sigsum-submit -k tkey-ssh-agent.pub -P sigsum-generic-2025-1 -a sigsum-ratelimit -d filippo.io artifacts/* gh release upload $VERSION --repo FiloSottile/age artifacts/*.proof ``` In the future, we will move to reproducing the artifacts locally, and signing those instead of the ones built by GitHub Actions. ================================================ FILE: age.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // Package age implements file encryption according to the age-encryption.org/v1 // specification. // // For most use cases, use the [Encrypt] and [Decrypt] functions with // [HybridRecipient] and [HybridIdentity]. If passphrase encryption is // required, use [ScryptRecipient] and [ScryptIdentity]. For compatibility with // existing SSH keys use the filippo.io/age/agessh package. // // age encrypted files are binary and not malleable. For encoding them as text, // use the filippo.io/age/armor package. // // # Key management // // age does not have a global keyring. Instead, since age keys are small, // textual, and cheap, you are encouraged to generate dedicated keys for each // task and application. // // Recipient public keys can be passed around as command line flags and in // config files, while secret keys should be stored in dedicated files, through // secret management systems, or as environment variables. // // There is no default path for age keys. Instead, they should be stored at // application-specific paths. The CLI supports files where private keys are // listed one per line, ignoring empty lines and lines starting with "#". These // files can be parsed with [ParseIdentities]. // // When integrating age into a new system, it's recommended that you only // support native (X25519 and hybrid) keys, and not SSH keys. The latter are // supported for manual encryption operations. If you need to tie into existing // key management infrastructure, you might want to consider implementing your // own [Recipient] and [Identity]. // // # Backwards compatibility // // Files encrypted with a stable version (not alpha, beta, or release candidate) // of age, or with any v1.0.0 beta or release candidate, will decrypt with any // later versions of the v1 API. This might change in v2, in which case v1 will // be maintained with security fixes for compatibility with older files. // // If decrypting an older file poses a security risk, doing so might require an // explicit opt-in in the API. package age import ( "bytes" "crypto/hmac" "crypto/rand" "errors" "fmt" "io" "slices" "sort" "filippo.io/age/internal/format" "filippo.io/age/internal/stream" ) // An Identity is passed to [Decrypt] to unwrap an opaque file key from a // recipient stanza. It can be for example a secret key like [HybridIdentity], a // plugin, or a custom implementation. type Identity interface { // Unwrap must return an error wrapping [ErrIncorrectIdentity] if none of // the recipient stanzas match the identity, any other error will be // considered fatal. // // Most age API users won't need to interact with this method directly, and // should instead pass [Identity] implementations to [Decrypt]. Unwrap(stanzas []*Stanza) (fileKey []byte, err error) } // ErrIncorrectIdentity is returned by [Identity.Unwrap] if none of the // recipient stanzas match the identity. var ErrIncorrectIdentity = errors.New("incorrect identity for recipient block") // A Recipient is passed to [Encrypt] to wrap an opaque file key to one or more // recipient stanza(s). It can be for example a public key like [HybridRecipient], // a plugin, or a custom implementation. type Recipient interface { // Most age API users won't need to interact with this method directly, and // should instead pass [Recipient] implementations to [Encrypt]. Wrap(fileKey []byte) ([]*Stanza, error) } // RecipientWithLabels can be optionally implemented by a [Recipient], in which // case [Encrypt] will use WrapWithLabels instead of [Recipient.Wrap]. // // Encrypt will succeed only if the labels returned by all the recipients // (assuming the empty set for those that don't implement RecipientWithLabels) // are the same. // // This can be used to ensure a recipient is only used with other recipients // with equivalent properties (for example by setting a "postquantum" label) or // to ensure a recipient is always used alone (by returning a random label, for // example to preserve its authentication properties). type RecipientWithLabels interface { WrapWithLabels(fileKey []byte) (s []*Stanza, labels []string, err error) } // A Stanza is a section of the age header that encapsulates the file key as // encrypted to a specific recipient. // // Most age API users won't need to interact with this type directly, and should // instead pass [Recipient] implementations to [Encrypt] and [Identity] // implementations to [Decrypt]. type Stanza struct { Type string Args []string Body []byte } const fileKeySize = 16 const streamNonceSize = 16 func encryptHdr(fileKey []byte, recipients ...Recipient) (*format.Header, error) { if len(recipients) == 0 { return nil, errors.New("no recipients specified") } hdr := &format.Header{} var labels []string for i, r := range recipients { stanzas, l, err := wrapWithLabels(r, fileKey) if err != nil { return nil, fmt.Errorf("failed to wrap key for recipient #%d: %w", i, err) } sort.Strings(l) if i == 0 { labels = l } else if !slicesEqual(labels, l) { return nil, incompatibleLabelsError(labels, l) } for _, s := range stanzas { hdr.Recipients = append(hdr.Recipients, (*format.Stanza)(s)) } } if mac, err := headerMAC(fileKey, hdr); err != nil { return nil, fmt.Errorf("failed to compute header MAC: %v", err) } else { hdr.MAC = mac } return hdr, nil } // Encrypt encrypts a file to one or more recipients. Every recipient will be // able to decrypt the file. // // Writes to the returned WriteCloser are encrypted and written to dst as an age // file. The caller must call Close on the WriteCloser when done for the last // chunk to be encrypted and flushed to dst. func Encrypt(dst io.Writer, recipients ...Recipient) (io.WriteCloser, error) { fileKey := make([]byte, fileKeySize) rand.Read(fileKey) hdr, err := encryptHdr(fileKey, recipients...) if err != nil { return nil, err } if err := hdr.Marshal(dst); err != nil { return nil, fmt.Errorf("failed to write header: %w", err) } nonce := make([]byte, streamNonceSize) rand.Read(nonce) if _, err := dst.Write(nonce); err != nil { return nil, fmt.Errorf("failed to write nonce: %w", err) } return stream.NewEncryptWriter(streamKey(fileKey, nonce), dst) } // EncryptReader encrypts a file to one or more recipients. Every recipient will be // able to decrypt the file. // // Reads from the returned Reader produce the encrypted file, where the plaintext // is read from src. func EncryptReader(src io.Reader, recipients ...Recipient) (io.Reader, error) { fileKey := make([]byte, fileKeySize) rand.Read(fileKey) hdr, err := encryptHdr(fileKey, recipients...) if err != nil { return nil, err } buf := &bytes.Buffer{} if err := hdr.Marshal(buf); err != nil { return nil, fmt.Errorf("failed to prepare header: %w", err) } nonce := make([]byte, streamNonceSize) rand.Read(nonce) r, err := stream.NewEncryptReader(streamKey(fileKey, nonce), src) if err != nil { return nil, err } return io.MultiReader(buf, bytes.NewReader(nonce), r), nil } func wrapWithLabels(r Recipient, fileKey []byte) (s []*Stanza, labels []string, err error) { if r, ok := r.(RecipientWithLabels); ok { return r.WrapWithLabels(fileKey) } s, err = r.Wrap(fileKey) return } func slicesEqual(s1, s2 []string) bool { if len(s1) != len(s2) { return false } for i := range s1 { if s1[i] != s2[i] { return false } } return true } func incompatibleLabelsError(l1, l2 []string) error { hasPQ1 := slices.Contains(l1, "postquantum") hasPQ2 := slices.Contains(l2, "postquantum") if hasPQ1 != hasPQ2 { return fmt.Errorf("incompatible recipients: can't mix post-quantum and classic recipients, or the file would be vulnerable to quantum computers") } return fmt.Errorf("incompatible recipients: %q and %q can't be mixed", l1, l2) } // NoIdentityMatchError is returned by [Decrypt] when none of the supplied // identities match the encrypted file. type NoIdentityMatchError struct { // Errors is a slice of all the errors returned to Decrypt by the Unwrap // calls it made. They all wrap [ErrIncorrectIdentity]. Errors []error // StanzaTypes are the first argument of each recipient stanza in the // encrypted file's header. StanzaTypes []string } func (e *NoIdentityMatchError) Error() string { if len(e.Errors) == 1 { return "identity did not match any of the recipients: " + e.Errors[0].Error() } return "no identity matched any of the recipients" } func (e *NoIdentityMatchError) Unwrap() []error { return e.Errors } // Decrypt decrypts a file encrypted to one or more identities. // All identities will be tried until one successfully decrypts the file. // Native, non-interactive identities are tried before any other identities. // // Decrypt returns a Reader reading the decrypted plaintext of the age file read // from src. If no identity matches the encrypted file, the returned error will // be of type [NoIdentityMatchError]. func Decrypt(src io.Reader, identities ...Identity) (io.Reader, error) { hdr, payload, err := format.Parse(src) if err != nil { return nil, fmt.Errorf("failed to read header: %w", err) } fileKey, err := decryptHdr(hdr, identities...) if err != nil { return nil, err } nonce := make([]byte, streamNonceSize) if _, err := io.ReadFull(payload, nonce); err != nil { return nil, fmt.Errorf("failed to read nonce: %w", err) } return stream.NewDecryptReader(streamKey(fileKey, nonce), payload) } // DecryptReaderAt decrypts a file encrypted to one or more identities. // All identities will be tried until one successfully decrypts the file. // Native, non-interactive identities are tried before any other identities. // // DecryptReaderAt takes an underlying [io.ReaderAt] and its total encrypted // size, and returns a ReaderAt of the decrypted plaintext and the plaintext // size. These can be used for example to instantiate an [io.SectionReader], // which implements [io.Reader] and [io.Seeker], or for [zip.NewReader]. // Note that ReaderAt by definition disregards the seek position of src. // // The ReadAt method of the returned ReaderAt can be called concurrently. // The ReaderAt will internally cache the most recently decrypted chunk. // DecryptReaderAt reads and decrypts the final chunk before returning, // to authenticate the plaintext size. // // If no identity matches the encrypted file, the returned error will be of // type [NoIdentityMatchError]. func DecryptReaderAt(src io.ReaderAt, encryptedSize int64, identities ...Identity) (io.ReaderAt, int64, error) { srcReader := io.NewSectionReader(src, 0, encryptedSize) hdr, payload, err := format.Parse(srcReader) if err != nil { return nil, 0, fmt.Errorf("failed to read header: %w", err) } buf := &bytes.Buffer{} if err := hdr.Marshal(buf); err != nil { return nil, 0, fmt.Errorf("failed to serialize header: %w", err) } fileKey, err := decryptHdr(hdr, identities...) if err != nil { return nil, 0, err } nonce := make([]byte, streamNonceSize) if _, err := io.ReadFull(payload, nonce); err != nil { return nil, 0, fmt.Errorf("failed to read nonce: %w", err) } payloadOffset := int64(buf.Len()) + int64(len(nonce)) payloadSize := encryptedSize - payloadOffset plaintextSize, err := stream.PlaintextSize(payloadSize) if err != nil { return nil, 0, err } payloadReaderAt := io.NewSectionReader(src, payloadOffset, payloadSize) r, err := stream.NewDecryptReaderAt(streamKey(fileKey, nonce), payloadReaderAt, payloadSize) if err != nil { return nil, 0, err } return r, plaintextSize, nil } func decryptHdr(hdr *format.Header, identities ...Identity) ([]byte, error) { if len(identities) == 0 { return nil, errors.New("no identities specified") } slices.SortStableFunc(identities, func(a, b Identity) int { var aIsNative, bIsNative bool switch a.(type) { case *X25519Identity, *HybridIdentity, *ScryptIdentity: aIsNative = true } switch b.(type) { case *X25519Identity, *HybridIdentity, *ScryptIdentity: bIsNative = true } if aIsNative && !bIsNative { return -1 } if !aIsNative && bIsNative { return 1 } return 0 }) stanzas := make([]*Stanza, 0, len(hdr.Recipients)) errNoMatch := &NoIdentityMatchError{} for _, s := range hdr.Recipients { errNoMatch.StanzaTypes = append(errNoMatch.StanzaTypes, s.Type) stanzas = append(stanzas, (*Stanza)(s)) } var fileKey []byte for _, id := range identities { var err error fileKey, err = id.Unwrap(stanzas) if errors.Is(err, ErrIncorrectIdentity) { errNoMatch.Errors = append(errNoMatch.Errors, err) continue } if err != nil { return nil, err } break } if fileKey == nil { return nil, errNoMatch } if mac, err := headerMAC(fileKey, hdr); err != nil { return nil, fmt.Errorf("failed to compute header MAC: %v", err) } else if !hmac.Equal(mac, hdr.MAC) { return nil, errors.New("bad header MAC") } return fileKey, nil } // multiUnwrap is a helper that implements Identity.Unwrap in terms of a // function that unwraps a single recipient stanza. func multiUnwrap(unwrap func(*Stanza) ([]byte, error), stanzas []*Stanza) ([]byte, error) { for _, s := range stanzas { fileKey, err := unwrap(s) if errors.Is(err, ErrIncorrectIdentity) { // If we ever start returning something interesting wrapping // ErrIncorrectIdentity, we should let it make its way up through // Decrypt into NoIdentityMatchError.Errors. continue } if err != nil { return nil, err } return fileKey, nil } return nil, ErrIncorrectIdentity } // ExtractHeader returns a detached header from the src file. // // The detached header can be decrypted with [DecryptHeader] (for example on a // different system, without sharing the ciphertext) and then the file key can // be used with [NewInjectedFileKeyIdentity]. // // This is a low-level function that most users won't need. func ExtractHeader(src io.Reader) ([]byte, error) { hdr, _, err := format.Parse(src) if err != nil { return nil, fmt.Errorf("failed to read header: %w", err) } buf := &bytes.Buffer{} if err := hdr.Marshal(buf); err != nil { return nil, fmt.Errorf("failed to serialize header: %w", err) } return buf.Bytes(), nil } // DecryptHeader decrypts a detached header and returns a file key. // // The detached header can be produced by [ExtractHeader], and the // returned file key can be used with [NewInjectedFileKeyIdentity]. // // This is a low-level function that most users won't need. // It is the caller's responsibility to keep track of what file the // returned file key decrypts, and to ensure the file key is not used // for any other purpose. func DecryptHeader(header []byte, identities ...Identity) ([]byte, error) { hdr, _, err := format.Parse(bytes.NewReader(header)) if err != nil { return nil, fmt.Errorf("failed to read header: %w", err) } return decryptHdr(hdr, identities...) } type injectedFileKeyIdentity struct { fileKey []byte } // NewInjectedFileKeyIdentity returns an [Identity] that always produces // a fixed file key, allowing the use of a file key obtained out-of-band, // for example via [DecryptHeader]. // // This is a low-level function that most users won't need. func NewInjectedFileKeyIdentity(fileKey []byte) Identity { return injectedFileKeyIdentity{fileKey} } func (i injectedFileKeyIdentity) Unwrap(stanzas []*Stanza) (fileKey []byte, err error) { return i.fileKey, nil } ================================================ FILE: age_test.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package age_test import ( "archive/zip" "bytes" "errors" "fmt" "io" "io/fs" "log" "os" "slices" "strings" "testing" "filippo.io/age" ) func ExampleEncrypt() { publicKey := "age1cy0su9fwf3gf9mw868g5yut09p6nytfmmnktexz2ya5uqg9vl9sss4euqm" recipient, err := age.ParseX25519Recipient(publicKey) if err != nil { log.Fatalf("Failed to parse public key %q: %v", publicKey, err) } out := &bytes.Buffer{} w, err := age.Encrypt(out, recipient) if err != nil { log.Fatalf("Failed to create encrypted file: %v", err) } if _, err := io.WriteString(w, "Black lives matter."); err != nil { log.Fatalf("Failed to write to encrypted file: %v", err) } if err := w.Close(); err != nil { log.Fatalf("Failed to close encrypted file: %v", err) } fmt.Printf("Encrypted file size: %d\n", out.Len()) // Output: // Encrypted file size: 219 } // DO NOT hardcode the private key. Store it in a secret storage solution, // on disk if the local machine is trusted, or have the user provide it. var privateKey string func init() { privateKey = "AGE-SECRET-KEY-184JMZMVQH3E6U0PSL869004Y3U2NYV7R30EU99CSEDNPH02YUVFSZW44VU" } func ExampleDecrypt() { identity, err := age.ParseX25519Identity(privateKey) if err != nil { log.Fatalf("Failed to parse private key: %v", err) } f, err := os.Open("testdata/example.age") if err != nil { log.Fatalf("Failed to open file: %v", err) } r, err := age.Decrypt(f, identity) if err != nil { log.Fatalf("Failed to open encrypted file: %v", err) } out := &bytes.Buffer{} if _, err := io.Copy(out, r); err != nil { log.Fatalf("Failed to read encrypted file: %v", err) } fmt.Printf("File contents: %q\n", out.Bytes()) // Output: // File contents: "Black lives matter." } func ExampleParseIdentities() { keyFile, err := os.Open("testdata/example_keys.txt") if err != nil { log.Fatalf("Failed to open private keys file: %v", err) } identities, err := age.ParseIdentities(keyFile) if err != nil { log.Fatalf("Failed to parse private key: %v", err) } f, err := os.Open("testdata/example.age") if err != nil { log.Fatalf("Failed to open file: %v", err) } r, err := age.Decrypt(f, identities...) if err != nil { log.Fatalf("Failed to open encrypted file: %v", err) } out := &bytes.Buffer{} if _, err := io.Copy(out, r); err != nil { log.Fatalf("Failed to read encrypted file: %v", err) } fmt.Printf("File contents: %q\n", out.Bytes()) // Output: // File contents: "Black lives matter." } func ExampleGenerateX25519Identity() { identity, err := age.GenerateX25519Identity() if err != nil { log.Fatalf("Failed to generate key pair: %v", err) } fmt.Printf("Public key: %s...\n", identity.Recipient().String()[:4]) fmt.Printf("Private key: %s...\n", identity.String()[:16]) // Output: // Public key: age1... // Private key: AGE-SECRET-KEY-1... } const helloWorld = "Hello, Twitch!" func TestEncryptDecryptX25519(t *testing.T) { a, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } b, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := age.Encrypt(buf, a.Recipient(), b.Recipient()) if err != nil { t.Fatal(err) } if _, err := io.WriteString(w, helloWorld); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } out, err := age.Decrypt(buf, b) if err != nil { t.Fatal(err) } outBytes, err := io.ReadAll(out) if err != nil { t.Fatal(err) } if string(outBytes) != helloWorld { t.Errorf("wrong data: %q, excepted %q", outBytes, helloWorld) } } func TestEncryptDecryptScrypt(t *testing.T) { password := "twitch.tv/filosottile" r, err := age.NewScryptRecipient(password) if err != nil { t.Fatal(err) } r.SetWorkFactor(15) buf := &bytes.Buffer{} w, err := age.Encrypt(buf, r) if err != nil { t.Fatal(err) } if _, err := io.WriteString(w, helloWorld); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } i, err := age.NewScryptIdentity(password) if err != nil { t.Fatal(err) } out, err := age.Decrypt(buf, i) if err != nil { t.Fatal(err) } outBytes, err := io.ReadAll(out) if err != nil { t.Fatal(err) } if string(outBytes) != helloWorld { t.Errorf("wrong data: %q, excepted %q", outBytes, helloWorld) } } func ExampleDecryptReaderAt() { identity, err := age.ParseX25519Identity(privateKey) if err != nil { log.Fatalf("Failed to parse private key: %v", err) } f, err := os.Open("testdata/example.zip.age") if err != nil { log.Fatalf("Failed to open file: %v", err) } stat, err := f.Stat() if err != nil { log.Fatalf("Failed to stat file: %v", err) } r, size, err := age.DecryptReaderAt(f, stat.Size(), identity) if err != nil { log.Fatalf("Failed to open encrypted file: %v", err) } z, err := zip.NewReader(r, size) if err != nil { log.Fatalf("Failed to open zip: %v", err) } contents, err := fs.ReadFile(z, "example.txt") if err != nil { log.Fatalf("Failed to read file from zip: %v", err) } fmt.Printf("File contents: %q\n", contents) // Output: // File contents: "Black lives matter." } func TestParseIdentities(t *testing.T) { tests := []struct { name string wantCount int wantErr bool file string }{ {"valid", 2, false, ` # this is a comment # AGE-SECRET-KEY-1705XN76M8EYQ8M9PY4E2G3KA8DN7NSCGT3V4HMN20H3GCX4AS6HSSTG8D3 # AGE-SECRET-KEY-1D6K0SGAX3NU66R4GYFZY0UQWCLM3UUSF3CXLW4KXZM342WQSJ82QKU59QJ AGE-SECRET-KEY-19WUMFE89H3928FRJ5U3JYRNHM6CERQGKSQ584AQ8QY7T7R09D32SWE4DYH`}, {"invalid", 0, true, ` AGE-SECRET-KEY-1705XN76M8EYQ8M9PY4E2G3KA8DN7NSCGT3V4HMN20H3GCX4AS6HSSTG8D3 AGE-SECRET-KEY--1D6K0SGAX3NU66R4GYFZY0UQWCLM3UUSF3CXLW4KXZM342WQSJ82QKU59Q`}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { got, err := age.ParseIdentities(strings.NewReader(tt.file)) if (err != nil) != tt.wantErr { t.Errorf("ParseIdentities() error = %v, wantErr %v", err, tt.wantErr) return } if len(got) != tt.wantCount { t.Errorf("ParseIdentities() returned %d identities, want %d", len(got), tt.wantCount) } }) } } type testRecipient struct { labels []string } func (testRecipient) Wrap(fileKey []byte) ([]*age.Stanza, error) { panic("expected WrapWithLabels instead") } func (t testRecipient) WrapWithLabels(fileKey []byte) (s []*age.Stanza, labels []string, err error) { return []*age.Stanza{{Type: "test"}}, t.labels, nil } func TestLabels(t *testing.T) { scrypt, err := age.NewScryptRecipient("xxx") if err != nil { t.Fatal(err) } i, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } x25519 := i.Recipient() pqc := testRecipient{[]string{"postquantum"}} pqcAndFoo := testRecipient{[]string{"postquantum", "foo"}} fooAndPQC := testRecipient{[]string{"foo", "postquantum"}} if _, err := age.Encrypt(io.Discard, scrypt, scrypt); err == nil { t.Error("expected two scrypt recipients to fail") } if _, err := age.Encrypt(io.Discard, scrypt, x25519); err == nil { t.Error("expected x25519 mixed with scrypt to fail") } if _, err := age.Encrypt(io.Discard, x25519, scrypt); err == nil { t.Error("expected x25519 mixed with scrypt to fail") } if _, err := age.Encrypt(io.Discard, pqc, x25519); err == nil { t.Error("expected x25519 mixed with pqc to fail") } if _, err := age.Encrypt(io.Discard, x25519, pqc); err == nil { t.Error("expected x25519 mixed with pqc to fail") } if _, err := age.Encrypt(io.Discard, pqc, pqc); err != nil { t.Errorf("expected two pqc to work, got %v", err) } if _, err := age.Encrypt(io.Discard, pqc); err != nil { t.Errorf("expected one pqc to work, got %v", err) } if _, err := age.Encrypt(io.Discard, pqcAndFoo, pqc); err == nil { t.Error("expected pqc+foo mixed with pqc to fail") } if _, err := age.Encrypt(io.Discard, pqc, pqcAndFoo); err == nil { t.Error("expected pqc+foo mixed with pqc to fail") } if _, err := age.Encrypt(io.Discard, pqc, pqc, pqcAndFoo); err == nil { t.Error("expected pqc+foo mixed with pqc to fail") } if _, err := age.Encrypt(io.Discard, pqcAndFoo, pqcAndFoo); err != nil { t.Errorf("expected two pqc+foo to work, got %v", err) } if _, err := age.Encrypt(io.Discard, pqcAndFoo, fooAndPQC); err != nil { t.Errorf("expected pqc+foo mixed with foo+pqc to work, got %v", err) } } // testIdentity is a non-native identity that records if Unwrap is called. type testIdentity struct { called bool } func (ti *testIdentity) Unwrap(stanzas []*age.Stanza) ([]byte, error) { ti.called = true return nil, age.ErrIncorrectIdentity } func TestDecryptNativeIdentitiesFirst(t *testing.T) { correct, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } unrelated, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := age.Encrypt(buf, correct.Recipient()) if err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } nonNative := &testIdentity{} // Pass identities: unrelated native, non-native, correct native. // Native identities should be tried first, so correct should match // before nonNative is ever called. _, err = age.Decrypt(bytes.NewReader(buf.Bytes()), unrelated, nonNative, correct) if err != nil { t.Fatal(err) } if nonNative.called { t.Error("non-native identity was called, but native identities should be tried first") } } type stanzaTypeRecipient string func (s stanzaTypeRecipient) Wrap(fileKey []byte) ([]*age.Stanza, error) { return []*age.Stanza{{Type: string(s)}}, nil } func TestNoIdentityMatchErrorStanzaTypes(t *testing.T) { a, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } b, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } wrong, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := age.Encrypt(buf, a.Recipient(), stanzaTypeRecipient("other"), b.Recipient()) if err != nil { t.Fatal(err) } if _, err := io.WriteString(w, helloWorld); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } _, err = age.Decrypt(bytes.NewReader(buf.Bytes()), wrong) if err == nil { t.Fatal("expected decryption to fail") } var noMatch *age.NoIdentityMatchError if !errors.As(err, &noMatch) { t.Fatalf("expected NoIdentityMatchError, got %T: %v", err, err) } want := []string{"X25519", "other", "X25519"} if !slices.Equal(noMatch.StanzaTypes, want) { t.Errorf("StanzaTypes = %v, want %v", noMatch.StanzaTypes, want) } } func TestScryptIdentityErrors(t *testing.T) { t.Run("not passphrase-encrypted", func(t *testing.T) { i, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := age.Encrypt(buf, i.Recipient()) if err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } scryptID, err := age.NewScryptIdentity("password") if err != nil { t.Fatal(err) } _, err = age.Decrypt(bytes.NewReader(buf.Bytes()), scryptID) if err == nil { t.Fatal("expected decryption to fail") } if !errors.Is(err, age.ErrIncorrectIdentity) { t.Errorf("expected ErrIncorrectIdentity, got %v", err) } if !strings.Contains(err.Error(), "not passphrase-encrypted") { t.Errorf("expected error to mention 'not passphrase-encrypted', got %v", err) } }) t.Run("incorrect passphrase", func(t *testing.T) { r, err := age.NewScryptRecipient("correct-password") if err != nil { t.Fatal(err) } r.SetWorkFactor(10) // Low for fast test buf := &bytes.Buffer{} w, err := age.Encrypt(buf, r) if err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } scryptID, err := age.NewScryptIdentity("wrong-password") if err != nil { t.Fatal(err) } _, err = age.Decrypt(bytes.NewReader(buf.Bytes()), scryptID) if err == nil { t.Fatal("expected decryption to fail") } if !errors.Is(err, age.ErrIncorrectIdentity) { t.Errorf("expected ErrIncorrectIdentity, got %v", err) } if !strings.Contains(err.Error(), "incorrect passphrase") { t.Errorf("expected error to mention 'incorrect passphrase', got %v", err) } }) } func TestDetachedHeader(t *testing.T) { i, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := age.Encrypt(buf, i.Recipient()) if err != nil { t.Fatal(err) } if _, err := io.WriteString(w, helloWorld); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } encrypted := buf.Bytes() header, err := age.ExtractHeader(bytes.NewReader(encrypted)) if err != nil { t.Fatal(err) } fileKey, err := age.DecryptHeader(header, i) if err != nil { t.Fatal(err) } identity := age.NewInjectedFileKeyIdentity(fileKey) out, err := age.Decrypt(bytes.NewReader(encrypted), identity) if err != nil { t.Fatal(err) } outBytes, err := io.ReadAll(out) if err != nil { t.Fatal(err) } if string(outBytes) != helloWorld { t.Errorf("wrong data: %q, expected %q", outBytes, helloWorld) } } func TestEncryptReader(t *testing.T) { a, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } r, err := age.EncryptReader(strings.NewReader(helloWorld), a.Recipient()) if err != nil { t.Fatal(err) } buf := &bytes.Buffer{} if _, err := io.Copy(buf, r); err != nil { t.Fatal(err) } out, err := age.Decrypt(buf, a) if err != nil { t.Fatal(err) } outBytes, err := io.ReadAll(out) if err != nil { t.Fatal(err) } if string(outBytes) != helloWorld { t.Errorf("wrong data: %q, excepted %q", outBytes, helloWorld) } } ================================================ FILE: agessh/agessh.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // Package agessh provides age.Identity and age.Recipient implementations of // types "ssh-rsa" and "ssh-ed25519", which allow reusing existing SSH keys for // encryption with age-encryption.org/v1. // // These recipient types should only be used for compatibility with existing // keys, and native keys should be preferred otherwise. // // Note that these recipient types are not anonymous: the encrypted message will // include a short 32-bit ID of the public key. package agessh import ( "crypto/ed25519" "crypto/rand" "crypto/rsa" "crypto/sha256" "crypto/sha512" "errors" "fmt" "io" "filippo.io/age" "filippo.io/age/internal/format" "filippo.io/edwards25519" "golang.org/x/crypto/chacha20poly1305" "golang.org/x/crypto/curve25519" "golang.org/x/crypto/hkdf" "golang.org/x/crypto/ssh" ) func sshFingerprint(pk ssh.PublicKey) string { h := sha256.Sum256(pk.Marshal()) return format.EncodeToString(h[:4]) } const oaepLabel = "age-encryption.org/v1/ssh-rsa" type RSARecipient struct { sshKey ssh.PublicKey pubKey *rsa.PublicKey } var _ age.Recipient = &RSARecipient{} func NewRSARecipient(pk ssh.PublicKey) (*RSARecipient, error) { if pk.Type() != "ssh-rsa" { return nil, errors.New("SSH public key is not an RSA key") } r := &RSARecipient{ sshKey: pk, } if pk, ok := pk.(ssh.CryptoPublicKey); ok { if pk, ok := pk.CryptoPublicKey().(*rsa.PublicKey); ok { r.pubKey = pk } else { return nil, errors.New("unexpected public key type") } } else { return nil, errors.New("pk does not implement ssh.CryptoPublicKey") } if r.pubKey.Size() < 2048/8 { return nil, errors.New("RSA key size is too small") } return r, nil } func (r *RSARecipient) Wrap(fileKey []byte) ([]*age.Stanza, error) { l := &age.Stanza{ Type: "ssh-rsa", Args: []string{sshFingerprint(r.sshKey)}, } wrappedKey, err := rsa.EncryptOAEP(sha256.New(), rand.Reader, r.pubKey, fileKey, []byte(oaepLabel)) if err != nil { return nil, err } l.Body = wrappedKey return []*age.Stanza{l}, nil } type RSAIdentity struct { k *rsa.PrivateKey sshKey ssh.PublicKey } var _ age.Identity = &RSAIdentity{} func NewRSAIdentity(key *rsa.PrivateKey) (*RSAIdentity, error) { s, err := ssh.NewSignerFromKey(key) if err != nil { return nil, err } i := &RSAIdentity{ k: key, sshKey: s.PublicKey(), } return i, nil } func (i *RSAIdentity) Recipient() *RSARecipient { return &RSARecipient{ sshKey: i.sshKey, pubKey: &i.k.PublicKey, } } func (i *RSAIdentity) Unwrap(stanzas []*age.Stanza) ([]byte, error) { return multiUnwrap(i.unwrap, stanzas) } func (i *RSAIdentity) unwrap(block *age.Stanza) ([]byte, error) { if block.Type != "ssh-rsa" { return nil, age.ErrIncorrectIdentity } if len(block.Args) != 1 { return nil, errors.New("invalid ssh-rsa recipient block") } if block.Args[0] != sshFingerprint(i.sshKey) { return nil, age.ErrIncorrectIdentity } fileKey, err := rsa.DecryptOAEP(sha256.New(), rand.Reader, i.k, block.Body, []byte(oaepLabel)) if err != nil { return nil, fmt.Errorf("failed to decrypt file key: %v", err) } return fileKey, nil } type Ed25519Recipient struct { sshKey ssh.PublicKey theirPublicKey []byte } var _ age.Recipient = &Ed25519Recipient{} func NewEd25519Recipient(pk ssh.PublicKey) (*Ed25519Recipient, error) { if pk.Type() != "ssh-ed25519" { return nil, errors.New("SSH public key is not an Ed25519 key") } cpk, ok := pk.(ssh.CryptoPublicKey) if !ok { return nil, errors.New("pk does not implement ssh.CryptoPublicKey") } epk, ok := cpk.CryptoPublicKey().(ed25519.PublicKey) if !ok { return nil, errors.New("unexpected public key type") } mpk, err := ed25519PublicKeyToCurve25519(epk) if err != nil { return nil, fmt.Errorf("invalid Ed25519 public key: %v", err) } return &Ed25519Recipient{ sshKey: pk, theirPublicKey: mpk, }, nil } func ParseRecipient(s string) (age.Recipient, error) { pubKey, _, _, _, err := ssh.ParseAuthorizedKey([]byte(s)) if err != nil { return nil, fmt.Errorf("malformed SSH recipient: %q: %v", s, err) } var r age.Recipient switch t := pubKey.Type(); t { case "ssh-rsa": r, err = NewRSARecipient(pubKey) case "ssh-ed25519": r, err = NewEd25519Recipient(pubKey) default: return nil, fmt.Errorf("unknown SSH recipient type: %q", t) } if err != nil { return nil, fmt.Errorf("malformed SSH recipient: %q: %v", s, err) } return r, nil } func ed25519PublicKeyToCurve25519(pk ed25519.PublicKey) ([]byte, error) { // See https://blog.filippo.io/using-ed25519-keys-for-encryption and // https://pkg.go.dev/filippo.io/edwards25519#Point.BytesMontgomery. p, err := new(edwards25519.Point).SetBytes(pk) if err != nil { return nil, err } return p.BytesMontgomery(), nil } const ed25519Label = "age-encryption.org/v1/ssh-ed25519" func (r *Ed25519Recipient) Wrap(fileKey []byte) ([]*age.Stanza, error) { ephemeral := make([]byte, curve25519.ScalarSize) if _, err := rand.Read(ephemeral); err != nil { return nil, err } ourPublicKey, err := curve25519.X25519(ephemeral, curve25519.Basepoint) if err != nil { return nil, err } sharedSecret, err := curve25519.X25519(ephemeral, r.theirPublicKey) if err != nil { return nil, err } tweak := make([]byte, curve25519.ScalarSize) tH := hkdf.New(sha256.New, nil, r.sshKey.Marshal(), []byte(ed25519Label)) if _, err := io.ReadFull(tH, tweak); err != nil { return nil, err } sharedSecret, _ = curve25519.X25519(tweak, sharedSecret) l := &age.Stanza{ Type: "ssh-ed25519", Args: []string{sshFingerprint(r.sshKey), format.EncodeToString(ourPublicKey[:])}, } salt := make([]byte, 0, len(ourPublicKey)+len(r.theirPublicKey)) salt = append(salt, ourPublicKey...) salt = append(salt, r.theirPublicKey...) h := hkdf.New(sha256.New, sharedSecret, salt, []byte(ed25519Label)) wrappingKey := make([]byte, chacha20poly1305.KeySize) if _, err := io.ReadFull(h, wrappingKey); err != nil { return nil, err } wrappedKey, err := aeadEncrypt(wrappingKey, fileKey) if err != nil { return nil, err } l.Body = wrappedKey return []*age.Stanza{l}, nil } type Ed25519Identity struct { secretKey, ourPublicKey []byte sshKey ssh.PublicKey } var _ age.Identity = &Ed25519Identity{} func NewEd25519Identity(key ed25519.PrivateKey) (*Ed25519Identity, error) { s, err := ssh.NewSignerFromKey(key) if err != nil { return nil, err } i := &Ed25519Identity{ sshKey: s.PublicKey(), secretKey: ed25519PrivateKeyToCurve25519(key), } i.ourPublicKey, _ = curve25519.X25519(i.secretKey, curve25519.Basepoint) return i, nil } func ParseIdentity(pemBytes []byte) (age.Identity, error) { k, err := ssh.ParseRawPrivateKey(pemBytes) if err != nil { return nil, err } switch k := k.(type) { case *ed25519.PrivateKey: return NewEd25519Identity(*k) // ParseRawPrivateKey returns inconsistent types. See Issue 429. case ed25519.PrivateKey: return NewEd25519Identity(k) case *rsa.PrivateKey: return NewRSAIdentity(k) } return nil, fmt.Errorf("unsupported SSH identity type: %T", k) } func ed25519PrivateKeyToCurve25519(pk ed25519.PrivateKey) []byte { h := sha512.New() h.Write(pk.Seed()) out := h.Sum(nil) return out[:curve25519.ScalarSize] } func (i *Ed25519Identity) Recipient() *Ed25519Recipient { return &Ed25519Recipient{ sshKey: i.sshKey, theirPublicKey: i.ourPublicKey, } } func (i *Ed25519Identity) Unwrap(stanzas []*age.Stanza) ([]byte, error) { return multiUnwrap(i.unwrap, stanzas) } func (i *Ed25519Identity) unwrap(block *age.Stanza) ([]byte, error) { if block.Type != "ssh-ed25519" { return nil, age.ErrIncorrectIdentity } if len(block.Args) != 2 { return nil, errors.New("invalid ssh-ed25519 recipient block") } publicKey, err := format.DecodeString(block.Args[1]) if err != nil { return nil, fmt.Errorf("failed to parse ssh-ed25519 recipient: %v", err) } if len(publicKey) != curve25519.PointSize { return nil, errors.New("invalid ssh-ed25519 recipient block") } if block.Args[0] != sshFingerprint(i.sshKey) { return nil, age.ErrIncorrectIdentity } sharedSecret, err := curve25519.X25519(i.secretKey, publicKey) if err != nil { return nil, fmt.Errorf("invalid X25519 recipient: %v", err) } tweak := make([]byte, curve25519.ScalarSize) tH := hkdf.New(sha256.New, nil, i.sshKey.Marshal(), []byte(ed25519Label)) if _, err := io.ReadFull(tH, tweak); err != nil { return nil, err } sharedSecret, _ = curve25519.X25519(tweak, sharedSecret) salt := make([]byte, 0, len(publicKey)+len(i.ourPublicKey)) salt = append(salt, publicKey...) salt = append(salt, i.ourPublicKey...) h := hkdf.New(sha256.New, sharedSecret, salt, []byte(ed25519Label)) wrappingKey := make([]byte, chacha20poly1305.KeySize) if _, err := io.ReadFull(h, wrappingKey); err != nil { return nil, err } fileKey, err := aeadDecrypt(wrappingKey, block.Body) if err != nil { return nil, fmt.Errorf("failed to decrypt file key: %v", err) } return fileKey, nil } // multiUnwrap is copied from package age. It's a helper that implements // Identity.Unwrap in terms of a function that unwraps a single recipient // stanza. func multiUnwrap(unwrap func(*age.Stanza) ([]byte, error), stanzas []*age.Stanza) ([]byte, error) { for _, s := range stanzas { fileKey, err := unwrap(s) if errors.Is(err, age.ErrIncorrectIdentity) { // If we ever start returning something interesting wrapping // ErrIncorrectIdentity, we should let it make its way up through // Decrypt into NoIdentityMatchError.Errors. continue } if err != nil { return nil, err } return fileKey, nil } return nil, age.ErrIncorrectIdentity } // aeadEncrypt and aeadDecrypt are copied from package age. // // They don't limit the file key size because multi-key attacks are irrelevant // against the ssh-ed25519 recipient. Being an asymmetric recipient, it would // only allow a more efficient search for accepted public keys against a // decryption oracle, but the ssh-X recipients are not anonymous (they have a // short recipient hash). func aeadEncrypt(key, plaintext []byte) ([]byte, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } nonce := make([]byte, chacha20poly1305.NonceSize) return aead.Seal(nil, nonce, plaintext, nil), nil } func aeadDecrypt(key, ciphertext []byte) ([]byte, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } nonce := make([]byte, chacha20poly1305.NonceSize) return aead.Open(nil, nonce, ciphertext, nil) } ================================================ FILE: agessh/agessh_test.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package agessh_test import ( "bytes" "crypto/ed25519" "crypto/rand" "crypto/rsa" "reflect" "testing" "filippo.io/age/agessh" "golang.org/x/crypto/ssh" ) func TestSSHRSARoundTrip(t *testing.T) { pk, err := rsa.GenerateKey(rand.Reader, 2048) if err != nil { t.Fatal(err) } pub, err := ssh.NewPublicKey(&pk.PublicKey) if err != nil { t.Fatal(err) } r, err := agessh.NewRSARecipient(pub) if err != nil { t.Fatal(err) } i, err := agessh.NewRSAIdentity(pk) if err != nil { t.Fatal(err) } // TODO: replace this with (and go-diff) with go-cmp. if !reflect.DeepEqual(r, i.Recipient()) { t.Fatalf("i.Recipient is different from r") } fileKey := make([]byte, 16) if _, err := rand.Read(fileKey); err != nil { t.Fatal(err) } stanzas, err := r.Wrap(fileKey) if err != nil { t.Fatal(err) } out, err := i.Unwrap(stanzas) if err != nil { t.Fatal(err) } if !bytes.Equal(fileKey, out) { t.Errorf("invalid output: %x, expected %x", out, fileKey) } } func TestSSHEd25519RoundTrip(t *testing.T) { pub, priv, err := ed25519.GenerateKey(rand.Reader) if err != nil { t.Fatal(err) } sshPubKey, err := ssh.NewPublicKey(pub) if err != nil { t.Fatal(err) } r, err := agessh.NewEd25519Recipient(sshPubKey) if err != nil { t.Fatal(err) } i, err := agessh.NewEd25519Identity(priv) if err != nil { t.Fatal(err) } // TODO: replace this with (and go-diff) with go-cmp. if !reflect.DeepEqual(r, i.Recipient()) { t.Fatalf("i.Recipient is different from r") } fileKey := make([]byte, 16) if _, err := rand.Read(fileKey); err != nil { t.Fatal(err) } stanzas, err := r.Wrap(fileKey) if err != nil { t.Fatal(err) } out, err := i.Unwrap(stanzas) if err != nil { t.Fatal(err) } if !bytes.Equal(fileKey, out) { t.Errorf("invalid output: %x, expected %x", out, fileKey) } } ================================================ FILE: agessh/encrypted_keys.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package agessh import ( "crypto" "crypto/ed25519" "crypto/rsa" "fmt" "filippo.io/age" "golang.org/x/crypto/ssh" ) // EncryptedSSHIdentity is an age.Identity implementation based on a passphrase // encrypted SSH private key. // // It requests the passphrase only if the public key matches a recipient stanza. // If the application knows it will always have to decrypt the private key, it // would be simpler to use ssh.ParseRawPrivateKeyWithPassphrase directly and // pass the result to NewEd25519Identity or NewRSAIdentity. type EncryptedSSHIdentity struct { pubKey ssh.PublicKey recipient age.Recipient pemBytes []byte passphrase func() ([]byte, error) decrypted age.Identity } // NewEncryptedSSHIdentity returns a new EncryptedSSHIdentity. // // pubKey must be the public key associated with the encrypted private key, and // it must have type "ssh-ed25519" or "ssh-rsa". For OpenSSH encrypted files it // can be extracted from an ssh.PassphraseMissingError, otherwise it can often // be found in ".pub" files. // // pemBytes must be a valid input to ssh.ParseRawPrivateKeyWithPassphrase. // passphrase is a callback that will be invoked by Unwrap when the passphrase // is necessary. func NewEncryptedSSHIdentity(pubKey ssh.PublicKey, pemBytes []byte, passphrase func() ([]byte, error)) (*EncryptedSSHIdentity, error) { i := &EncryptedSSHIdentity{ pubKey: pubKey, pemBytes: pemBytes, passphrase: passphrase, } switch t := pubKey.Type(); t { case "ssh-ed25519": r, err := NewEd25519Recipient(pubKey) if err != nil { return nil, err } i.recipient = r case "ssh-rsa": r, err := NewRSARecipient(pubKey) if err != nil { return nil, err } i.recipient = r default: return nil, fmt.Errorf("unsupported SSH key type: %v", t) } return i, nil } var _ age.Identity = &EncryptedSSHIdentity{} func (i *EncryptedSSHIdentity) Recipient() age.Recipient { return i.recipient } // Unwrap implements age.Identity. If the private key is still encrypted, and // any of the stanzas match the public key, it will request the passphrase. The // decrypted private key will be cached after the first successful invocation. func (i *EncryptedSSHIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error) { if i.decrypted != nil { return i.decrypted.Unwrap(stanzas) } var match bool for _, s := range stanzas { if s.Type != i.pubKey.Type() { continue } if len(s.Args) < 1 { return nil, fmt.Errorf("invalid %v recipient block", i.pubKey.Type()) } if s.Args[0] != sshFingerprint(i.pubKey) { continue } match = true break } if !match { return nil, age.ErrIncorrectIdentity } passphrase, err := i.passphrase() if err != nil { return nil, fmt.Errorf("failed to obtain passphrase: %v", err) } k, err := ssh.ParseRawPrivateKeyWithPassphrase(i.pemBytes, passphrase) if err != nil { return nil, fmt.Errorf("failed to decrypt SSH key file: %v", err) } var pubKey interface { Equal(x crypto.PublicKey) bool } switch k := k.(type) { case *ed25519.PrivateKey: i.decrypted, err = NewEd25519Identity(*k) pubKey = k.Public().(ed25519.PublicKey) // ParseRawPrivateKey returns inconsistent types. See Issue 429. case ed25519.PrivateKey: i.decrypted, err = NewEd25519Identity(k) pubKey = k.Public().(ed25519.PublicKey) case *rsa.PrivateKey: i.decrypted, err = NewRSAIdentity(k) pubKey = &k.PublicKey default: return nil, fmt.Errorf("unexpected SSH key type: %T", k) } if err != nil { return nil, fmt.Errorf("invalid SSH key: %v", err) } if exp := i.pubKey.(ssh.CryptoPublicKey).CryptoPublicKey(); !pubKey.Equal(exp) { return nil, fmt.Errorf("mismatched private and public SSH key") } return i.decrypted.Unwrap(stanzas) } ================================================ FILE: armor/armor.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // Package armor provides a strict, streaming implementation of the ASCII // armoring format for age files. // // It's PEM with type "AGE ENCRYPTED FILE", 64 character columns, no headers, // and strict base64 decoding. package armor import ( "bufio" "bytes" "encoding/base64" "errors" "fmt" "io" "filippo.io/age/internal/format" ) const ( Header = "-----BEGIN AGE ENCRYPTED FILE-----" Footer = "-----END AGE ENCRYPTED FILE-----" ) type armoredWriter struct { started, closed bool encoder *format.WrappedBase64Encoder dst io.Writer } func (a *armoredWriter) Write(p []byte) (int, error) { if !a.started { if _, err := io.WriteString(a.dst, Header+"\n"); err != nil { return 0, err } } a.started = true return a.encoder.Write(p) } func (a *armoredWriter) Close() error { if a.closed { return errors.New("ArmoredWriter already closed") } a.closed = true if err := a.encoder.Close(); err != nil { return err } footer := Footer + "\n" if !a.encoder.LastLineIsEmpty() { footer = "\n" + footer } _, err := io.WriteString(a.dst, footer) return err } func NewWriter(dst io.Writer) io.WriteCloser { // TODO: write a test with aligned and misaligned sizes, and 8 and 10 steps. return &armoredWriter{ dst: dst, encoder: format.NewWrappedBase64Encoder(base64.StdEncoding, dst), } } type armoredReader struct { r *bufio.Reader started bool unread []byte // backed by buf buf [format.BytesPerLine]byte err error } func NewReader(r io.Reader) io.Reader { return &armoredReader{r: bufio.NewReader(r)} } func (r *armoredReader) Read(p []byte) (int, error) { if len(r.unread) > 0 { n := copy(p, r.unread) r.unread = r.unread[n:] return n, nil } if r.err != nil { return 0, r.err } getLine := func() ([]byte, error) { line, err := r.r.ReadBytes('\n') if err == io.EOF && len(line) == 0 { return nil, io.ErrUnexpectedEOF } else if err != nil && err != io.EOF { return nil, err } line = bytes.TrimSuffix(line, []byte("\n")) line = bytes.TrimSuffix(line, []byte("\r")) return line, nil } const maxWhitespace = 1024 drainTrailing := func() error { buf, err := io.ReadAll(io.LimitReader(r.r, maxWhitespace)) if err != nil { return err } if len(bytes.TrimSpace(buf)) != 0 { return errors.New("trailing data after armored file") } if len(buf) == maxWhitespace { return errors.New("too much trailing whitespace") } return io.EOF } var removedWhitespace int for !r.started { line, err := getLine() if err != nil { return 0, r.setErr(err) } // Ignore leading whitespace. if len(bytes.TrimSpace(line)) == 0 { removedWhitespace += len(line) + 1 if removedWhitespace > maxWhitespace { return 0, r.setErr(errors.New("too much leading whitespace")) } continue } if string(line) != Header { return 0, r.setErr(fmt.Errorf("invalid first line: %q", line)) } r.started = true } line, err := getLine() if err != nil { return 0, r.setErr(err) } if string(line) == Footer { return 0, r.setErr(drainTrailing()) } if len(line) == 0 { return 0, r.setErr(errors.New("empty line in armored data")) } if len(line) > format.ColumnsPerLine { return 0, r.setErr(errors.New("column limit exceeded")) } r.unread = r.buf[:] n, err := base64.StdEncoding.Strict().Decode(r.unread, line) if err != nil { return 0, r.setErr(err) } r.unread = r.unread[:n] if n < format.BytesPerLine { line, err := getLine() if err != nil { return 0, r.setErr(err) } if string(line) != Footer { return 0, r.setErr(fmt.Errorf("invalid closing line: %q", line)) } r.setErr(drainTrailing()) } nn := copy(p, r.unread) r.unread = r.unread[nn:] return nn, nil } type Error struct { err error } func (e *Error) Error() string { return "invalid armor: " + e.err.Error() } func (e *Error) Unwrap() error { return e.err } func (r *armoredReader) setErr(err error) error { if err != io.EOF { err = &Error{err} } r.err = err return err } ================================================ FILE: armor/armor_test.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. //go:build go1.18 package armor_test import ( "bytes" "crypto/rand" "encoding/pem" "fmt" "io" "log" "os" "path/filepath" "strings" "testing" "filippo.io/age" "filippo.io/age/armor" "filippo.io/age/internal/format" ) func ExampleNewWriter() { publicKey := "age1cy0su9fwf3gf9mw868g5yut09p6nytfmmnktexz2ya5uqg9vl9sss4euqm" recipient, err := age.ParseX25519Recipient(publicKey) if err != nil { log.Fatalf("Failed to parse public key %q: %v", publicKey, err) } buf := &bytes.Buffer{} armorWriter := armor.NewWriter(buf) w, err := age.Encrypt(armorWriter, recipient) if err != nil { log.Fatalf("Failed to create encrypted file: %v", err) } if _, err := io.WriteString(w, "Black lives matter."); err != nil { log.Fatalf("Failed to write to encrypted file: %v", err) } if err := w.Close(); err != nil { log.Fatalf("Failed to close encrypted file: %v", err) } if err := armorWriter.Close(); err != nil { log.Fatalf("Failed to close armor: %v", err) } fmt.Printf("%s[...]", buf.Bytes()[:35]) // Output: // -----BEGIN AGE ENCRYPTED FILE----- // [...] } var privateKey = "AGE-SECRET-KEY-184JMZMVQH3E6U0PSL869004Y3U2NYV7R30EU99CSEDNPH02YUVFSZW44VU" func ExampleNewReader() { fileContents := `-----BEGIN AGE ENCRYPTED FILE----- YWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IFgyNTUxOSB4YWdhZHZ0WG1PZldDT1hD K3RPRzFkUlJnWlFBQlUwemtjeXFRMFp6V1VFCnRzZFV3a3Vkd1dSUWw2eEtrRkVv SHcvZnp6Q3lqLy9HMkM4ZjUyUGdDZjQKLS0tIDlpVUpuVUQ5YUJyUENFZ0lNSTB2 ekUvS3E5WjVUN0F5ZWR1ejhpeU5rZUUKsvPGYt7vf0o1kyJ1eVFMz1e4JnYYk1y1 kB/RRusYjn+KVJ+KTioxj0THtzZPXcjFKuQ1 -----END AGE ENCRYPTED FILE-----` // DO NOT hardcode the private key. Store it in a secret storage solution, // on disk if the local machine is trusted, or have the user provide it. identity, err := age.ParseX25519Identity(privateKey) if err != nil { log.Fatalf("Failed to parse private key %q: %v", privateKey, err) } out := &bytes.Buffer{} f := strings.NewReader(fileContents) armorReader := armor.NewReader(f) r, err := age.Decrypt(armorReader, identity) if err != nil { log.Fatalf("Failed to open encrypted file: %v", err) } if _, err := io.Copy(out, r); err != nil { log.Fatalf("Failed to read encrypted file: %v", err) } fmt.Printf("File contents: %q\n", out.Bytes()) // Output: // File contents: "Black lives matter." } func TestArmor(t *testing.T) { t.Run("PartialLine", func(t *testing.T) { testArmor(t, 611) }) t.Run("FullLine", func(t *testing.T) { testArmor(t, 10*format.BytesPerLine) }) } func testArmor(t *testing.T, size int) { buf := &bytes.Buffer{} w := armor.NewWriter(buf) plain := make([]byte, size) rand.Read(plain) if _, err := w.Write(plain); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } block, _ := pem.Decode(buf.Bytes()) if block == nil { t.Fatal("PEM decoding failed") } if len(block.Headers) != 0 { t.Error("unexpected headers") } if block.Type != "AGE ENCRYPTED FILE" { t.Errorf("unexpected type %q", block.Type) } if !bytes.Equal(block.Bytes, plain) { t.Error("PEM decoded value doesn't match") } if !bytes.Equal(buf.Bytes(), pem.EncodeToMemory(block)) { t.Error("PEM re-encoded value doesn't match") } r := armor.NewReader(buf) out, err := io.ReadAll(r) if err != nil { t.Fatal(err) } if !bytes.Equal(out, plain) { t.Error("decoded value doesn't match") } } func FuzzMalleability(f *testing.F) { tests, err := filepath.Glob("../testdata/testkit/*") if err != nil { f.Fatal(err) } for _, test := range tests { contents, err := os.ReadFile(test) if err != nil { f.Fatal(err) } header, contents, ok := bytes.Cut(contents, []byte("\n\n")) if !ok { f.Fatal("testkit file without header") } if bytes.Contains(header, []byte("armored: yes")) { f.Add(contents) } } f.Fuzz(func(t *testing.T, data []byte) { r := armor.NewReader(bytes.NewReader(data)) content, err := io.ReadAll(r) if err != nil { if _, ok := err.(*armor.Error); !ok { t.Errorf("error type is %T: %v", err, err) } t.Skip() } buf := &bytes.Buffer{} w := armor.NewWriter(buf) if _, err := w.Write(content); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } if !bytes.Equal(normalize(buf.Bytes()), normalize(data)) { t.Error("re-encoded output different from input") } }) } func normalize(f []byte) []byte { f = bytes.TrimSpace(f) f = bytes.Replace(f, []byte("\r\n"), []byte("\n"), -1) return f } ================================================ FILE: cmd/age/age.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main import ( "bufio" "bytes" "errors" "flag" "fmt" "io" "iter" "os" "path/filepath" "regexp" "runtime/debug" "slices" "strings" "unicode" "filippo.io/age" "filippo.io/age/agessh" "filippo.io/age/armor" "filippo.io/age/internal/term" "filippo.io/age/plugin" ) const usage = `Usage: age [--encrypt] (-r RECIPIENT | -R PATH)... [--armor] [-o OUTPUT] [INPUT] age [--encrypt] --passphrase [--armor] [-o OUTPUT] [INPUT] age --decrypt [-i PATH]... [-o OUTPUT] [INPUT] Options: -e, --encrypt Encrypt the input to the output. Default if omitted. -d, --decrypt Decrypt the input to the output. -o, --output OUTPUT Write the result to the file at path OUTPUT. -a, --armor Encrypt to a PEM encoded format. -p, --passphrase Encrypt with a passphrase. -r, --recipient RECIPIENT Encrypt to the specified RECIPIENT. Can be repeated. -R, --recipients-file PATH Encrypt to recipients listed at PATH. Can be repeated. -i, --identity PATH Use the identity file at PATH. Can be repeated. INPUT defaults to standard input, and OUTPUT defaults to standard output. If OUTPUT exists, it will be overwritten. RECIPIENT can be an age public key generated by age-keygen ("age1...") or an SSH public key ("ssh-ed25519 AAAA...", "ssh-rsa AAAA..."). Recipient files contain one or more recipients, one per line. Empty lines and lines starting with "#" are ignored as comments. "-" may be used to read recipients from standard input. Identity files contain one or more secret keys ("AGE-SECRET-KEY-1..."), one per line, or an SSH key. Empty lines and lines starting with "#" are ignored as comments. Passphrase encrypted age files can be used as identity files. Multiple key files can be provided, and any unused ones will be ignored. "-" may be used to read identities from standard input. When --encrypt is specified explicitly, -i can also be used to encrypt to an identity file symmetrically, instead or in addition to normal recipients. Example: $ age-keygen -o key.txt Public key: age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p $ tar cvz ~/data | age -r age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p > data.tar.gz.age $ age --decrypt -i key.txt -o data.tar.gz data.tar.gz.age` // stdinInUse is used to ensure only one of input, recipients, or identities // file is read from stdin. It's a singleton like os.Stdin. var stdinInUse bool type multiFlag []string func (f *multiFlag) String() string { return fmt.Sprint(*f) } func (f *multiFlag) Set(value string) error { *f = append(*f, value) return nil } type identityFlag struct { Type, Value string } // identityFlags tracks -i and -j flags, preserving their relative order, so // that "age -d -j agent -i encrypted-fallback-keys.age" behaves as expected. type identityFlags []identityFlag func (f *identityFlags) addIdentityFlag(value string) error { *f = append(*f, identityFlag{Type: "i", Value: value}) return nil } func (f *identityFlags) addPluginFlag(value string) error { *f = append(*f, identityFlag{Type: "j", Value: value}) return nil } // Version can be set at link time to override debug.BuildInfo.Main.Version when // building manually without git history. It should look like "v1.2.3". var Version string func main() { flag.Usage = func() { fmt.Fprintf(os.Stderr, "%s\n", usage) } if len(os.Args) == 1 { flag.Usage() os.Exit(1) } var ( outFlag string decryptFlag, encryptFlag bool passFlag, versionFlag, armorFlag bool recipientFlags multiFlag recipientsFileFlags multiFlag identityFlags identityFlags ) flag.BoolVar(&versionFlag, "version", false, "print the version") flag.BoolVar(&decryptFlag, "d", false, "decrypt the input") flag.BoolVar(&decryptFlag, "decrypt", false, "decrypt the input") flag.BoolVar(&encryptFlag, "e", false, "encrypt the input") flag.BoolVar(&encryptFlag, "encrypt", false, "encrypt the input") flag.BoolVar(&passFlag, "p", false, "use a passphrase") flag.BoolVar(&passFlag, "passphrase", false, "use a passphrase") flag.StringVar(&outFlag, "o", "", "output to `FILE` (default stdout)") flag.StringVar(&outFlag, "output", "", "output to `FILE` (default stdout)") flag.BoolVar(&armorFlag, "a", false, "generate an armored file") flag.BoolVar(&armorFlag, "armor", false, "generate an armored file") flag.Var(&recipientFlags, "r", "recipient (can be repeated)") flag.Var(&recipientFlags, "recipient", "recipient (can be repeated)") flag.Var(&recipientsFileFlags, "R", "recipients file (can be repeated)") flag.Var(&recipientsFileFlags, "recipients-file", "recipients file (can be repeated)") flag.Func("i", "identity (can be repeated)", identityFlags.addIdentityFlag) flag.Func("identity", "identity (can be repeated)", identityFlags.addIdentityFlag) flag.Func("j", "data-less plugin (can be repeated)", identityFlags.addPluginFlag) flag.Parse() if versionFlag { if buildInfo, ok := debug.ReadBuildInfo(); ok && Version == "" { Version = buildInfo.Main.Version } fmt.Println(Version) return } if flag.NArg() > 1 { var hints []string quotedArgs := strings.Trim(fmt.Sprintf("%q", flag.Args()), "[]") // If the second argument looks like a flag, suggest moving the first // argument to the back (as long as the arguments don't need quoting). if strings.HasPrefix(flag.Arg(1), "-") { hints = append(hints, "the input file must be specified after all flags") safe := true unsafeShell := regexp.MustCompile(`[^\w@%+=:,./-]`) if slices.ContainsFunc(os.Args, unsafeShell.MatchString) { safe = false } if safe { i := len(os.Args) - flag.NArg() newArgs := append([]string{}, os.Args[:i]...) newArgs = append(newArgs, os.Args[i+1:]...) newArgs = append(newArgs, os.Args[i]) hints = append(hints, "did you mean:") hints = append(hints, " "+strings.Join(newArgs, " ")) } } else { hints = append(hints, "only a single input file may be specified at a time") } errorWithHint("too many INPUT arguments: "+quotedArgs, hints...) } switch { case decryptFlag: if encryptFlag { errorf("-e/--encrypt can't be used with -d/--decrypt") } if armorFlag { errorWithHint("-a/--armor can't be used with -d/--decrypt", "note that armored files are detected automatically, try again without -a/--armor") } if passFlag { errorWithHint("-p/--passphrase can't be used with -d/--decrypt", "note that password protected files are detected automatically") } if len(recipientFlags) > 0 { errorWithHint("-r/--recipient can't be used with -d/--decrypt", "did you mean to use -i/--identity to specify a private key?") } if len(recipientsFileFlags) > 0 { errorWithHint("-R/--recipients-file can't be used with -d/--decrypt", "did you mean to use -i/--identity to specify a private key?") } default: // encrypt if len(identityFlags) > 0 && !encryptFlag { errorWithHint("-i/--identity and -j can't be used in encryption mode unless symmetric encryption is explicitly selected with -e/--encrypt", "did you forget to specify -d/--decrypt?") } if len(recipientFlags)+len(recipientsFileFlags)+len(identityFlags) == 0 && !passFlag { errorWithHint("missing recipients", "did you forget to specify -r/--recipient, -R/--recipients-file or -p/--passphrase?") } if len(recipientFlags) > 0 && passFlag { errorf("-p/--passphrase can't be combined with -r/--recipient") } if len(recipientsFileFlags) > 0 && passFlag { errorf("-p/--passphrase can't be combined with -R/--recipients-file") } if len(identityFlags) > 0 && passFlag { errorf("-p/--passphrase can't be combined with -i/--identity and -j") } } warnDuplicates(slices.Values(recipientFlags), "recipient") warnDuplicates(slices.Values(recipientsFileFlags), "recipients file") warnDuplicates(func(yield func(string) bool) { for _, f := range identityFlags { if f.Type == "i" && !yield(f.Value) { return } } }, "identity file") var inUseFiles []string for _, i := range identityFlags { if i.Type != "i" { continue } inUseFiles = append(inUseFiles, absPath(i.Value)) } for _, f := range recipientsFileFlags { inUseFiles = append(inUseFiles, absPath(f)) } var in io.Reader = os.Stdin var out io.Writer = os.Stdout if name := flag.Arg(0); name != "" && name != "-" { inUseFiles = append(inUseFiles, absPath(name)) f, err := os.Open(name) if err != nil { errorf("failed to open input file %q: %v", name, err) } defer f.Close() in = f } else { stdinInUse = true if decryptFlag && term.IsTerminal(os.Stdin) { // If the input comes from a TTY, assume it's armored, and buffer up // to the END line (or EOF/EOT) so that a password prompt or the // output don't get in the way of typing the input. See Issue 364. buf, err := bufferTerminalInput(in) if err != nil { errorf("failed to buffer terminal input: %v", err) } in = buf } } if name := outFlag; name != "" && name != "-" { for _, f := range inUseFiles { if f == absPath(name) { errorf("input and output file are the same: %q", name) } } f := newLazyOpener(name) defer func() { if err := f.Close(); err != nil { errorf("failed to close output file %q: %v", name, err) } }() out = f } else if term.IsTerminal(os.Stdout) { buf := &bytes.Buffer{} defer func() { if out == buf { io.Copy(os.Stdout, buf) } }() if name != "-" { if decryptFlag { // Buffer the output to check it's printable. out = buf defer func() { if bytes.ContainsFunc(buf.Bytes(), func(r rune) bool { return r != '\n' && r != '\r' && r != '\t' && unicode.IsControl(r) }) { errorWithHint("refusing to output binary to the terminal", `force anyway with "-o -"`) } }() } else if !armorFlag { // If the output wouldn't be armored, refuse to send binary to // the terminal unless explicitly requested with "-o -". errorWithHint("refusing to output binary to the terminal", "did you mean to use -a/--armor?", `force anyway with "-o -"`) } } if in == os.Stdin && term.IsTerminal(os.Stdin) { // If the input comes from a TTY and output will go to a TTY, // buffer it up so it doesn't get in the way of typing the input. out = buf } } switch { case decryptFlag && len(identityFlags) == 0: decryptPass(in, out) case decryptFlag: decryptNotPass(identityFlags, in, out) case passFlag: encryptPass(in, out, armorFlag) default: encryptNotPass(recipientFlags, recipientsFileFlags, identityFlags, in, out, armorFlag) } } func passphrasePromptForEncryption() (string, error) { pass, err := term.ReadSecret("Enter passphrase (leave empty to autogenerate a secure one):") if err != nil { return "", fmt.Errorf("could not read passphrase: %v", err) } p := string(pass) if p == "" { var words []string for range 10 { words = append(words, randomWord()) } p = strings.Join(words, "-") err := printfToTerminal("using autogenerated passphrase %q", p) if err != nil { return "", fmt.Errorf("could not print passphrase: %v", err) } } else { confirm, err := term.ReadSecret("Confirm passphrase:") if err != nil { return "", fmt.Errorf("could not read passphrase: %v", err) } if string(confirm) != p { return "", fmt.Errorf("passphrases didn't match") } } return p, nil } func encryptNotPass(recs, files []string, identities identityFlags, in io.Reader, out io.Writer, armor bool) { var recipients []age.Recipient for _, arg := range recs { r, err := parseRecipient(arg) if err, ok := err.(gitHubRecipientError); ok { errorWithHint(err.Error(), "instead, use recipient files like", " curl -O https://github.com/"+err.username+".keys", " age -R "+err.username+".keys") } if err != nil { errorf("%v", err) } recipients = append(recipients, r) } for _, name := range files { recs, err := parseRecipientsFile(name) if err != nil { errorf("failed to parse recipient file %q: %v", name, err) } recipients = append(recipients, recs...) } for _, f := range identities { switch f.Type { case "i": ids, err := parseIdentitiesFile(f.Value) if err != nil { errorf("reading %q: %v", f.Value, err) } r, err := identitiesToRecipients(ids) if err != nil { errorf("internal error processing %q: %v", f.Value, err) } recipients = append(recipients, r...) case "j": id, err := plugin.NewIdentityWithoutData(f.Value, plugin.NewTerminalUI(printf, warningf)) if err != nil { errorf("initializing %q: %v", f.Value, err) } recipients = append(recipients, id.Recipient()) } } encrypt(recipients, in, out, armor) } func encryptPass(in io.Reader, out io.Writer, armor bool) { pass, err := passphrasePromptForEncryption() if err != nil { errorf("%v", err) } r, err := age.NewScryptRecipient(pass) if err != nil { errorf("%v", err) } testOnlyConfigureScryptIdentity(r) encrypt([]age.Recipient{r}, in, out, armor) } var testOnlyConfigureScryptIdentity = func(*age.ScryptRecipient) {} func encrypt(recipients []age.Recipient, in io.Reader, out io.Writer, withArmor bool) { if withArmor { a := armor.NewWriter(out) defer func() { if err := a.Close(); err != nil { errorf("%v", err) } }() out = a } w, err := age.Encrypt(out, recipients...) if e := new(plugin.NotFoundError); errors.As(err, &e) { errorWithHint(err.Error(), fmt.Sprintf("you might want to install the %q plugin", e.Name), "visit https://age-encryption.org/awesome#plugins for a list of available plugins") } else if err != nil { errorf("%v", err) } if _, err := io.Copy(w, in); err != nil { errorf("%v", err) } if err := w.Close(); err != nil { errorf("%v", err) } } // crlfMangledIntro and utf16MangledIntro are the intro lines of the age format // after mangling by various versions of PowerShell redirection, truncated to // the length of the correct intro line. See issue 290. const crlfMangledIntro = "age-encryption.org/v1" + "\r" const utf16MangledIntro = "\xff\xfe" + "a\x00g\x00e\x00-\x00e\x00n\x00c\x00r\x00y\x00p\x00" type rejectScryptIdentity struct{} func (rejectScryptIdentity) Unwrap(stanzas []*age.Stanza) ([]byte, error) { if len(stanzas) != 1 || stanzas[0].Type != "scrypt" { return nil, age.ErrIncorrectIdentity } errorWithHint("file is passphrase-encrypted but identities were specified with -i/--identity or -j", "remove all -i/--identity/-j flags to decrypt passphrase-encrypted files") panic("unreachable") } func decryptNotPass(flags identityFlags, in io.Reader, out io.Writer) { var identities []age.Identity for _, f := range flags { switch f.Type { case "i": ids, err := parseIdentitiesFile(f.Value) if err != nil { errorf("reading %q: %v", f.Value, err) } identities = append(identities, ids...) case "j": id, err := plugin.NewIdentityWithoutData(f.Value, plugin.NewTerminalUI(printf, warningf)) if err != nil { errorf("initializing %q: %v", f.Value, err) } identities = append(identities, id) } } identities = append(identities, rejectScryptIdentity{}) decrypt(identities, in, out) } func decryptPass(in io.Reader, out io.Writer) { identities := []age.Identity{ // If there is an scrypt recipient (it will have to be the only one and) // this identity will be invoked. lazyScryptIdentity, } decrypt(identities, in, out) } func decrypt(identities []age.Identity, in io.Reader, out io.Writer) { rr := bufio.NewReader(in) if intro, _ := rr.Peek(len(crlfMangledIntro)); string(intro) == crlfMangledIntro || string(intro) == utf16MangledIntro { errorWithHint("invalid header intro", "it looks like this file was corrupted by PowerShell redirection", "consider using -o or -a to encrypt files in PowerShell") } const maxWhitespace = 1024 start, _ := rr.Peek(maxWhitespace + len(armor.Header)) if strings.HasPrefix(string(bytes.TrimSpace(start)), armor.Header) { in = armor.NewReader(rr) } else { in = rr } r, err := age.Decrypt(in, identities...) if e := new(plugin.NotFoundError); errors.As(err, &e) { errorWithHint(err.Error(), fmt.Sprintf("you might want to install the %q plugin", e.Name), "visit https://age-encryption.org/awesome#plugins for a list of available plugins") } else if errors.As(err, new(*age.NoIdentityMatchError)) && len(identities) == 1 && identities[0] == lazyScryptIdentity { errorWithHint("the file is not passphrase-encrypted, identities are required", "specify identities with -i/--identity or -j to decrypt this file") } else if err != nil { errorf("%v", err) } out.Write(nil) // trigger the lazyOpener even if r is empty if _, err := io.Copy(out, r); err != nil { errorf("%v", err) } } var lazyScryptIdentity = &LazyScryptIdentity{passphrasePromptForDecryption} func passphrasePromptForDecryption() (string, error) { pass, err := term.ReadSecret("Enter passphrase:") if err != nil { return "", fmt.Errorf("could not read passphrase: %v", err) } return string(pass), nil } func identitiesToRecipients(ids []age.Identity) ([]age.Recipient, error) { var recipients []age.Recipient for _, id := range ids { switch id := id.(type) { case *age.X25519Identity: recipients = append(recipients, id.Recipient()) case *age.HybridIdentity: recipients = append(recipients, id.Recipient()) case *plugin.Identity: recipients = append(recipients, id.Recipient()) case *agessh.RSAIdentity: recipients = append(recipients, id.Recipient()) case *agessh.Ed25519Identity: recipients = append(recipients, id.Recipient()) case *agessh.EncryptedSSHIdentity: recipients = append(recipients, id.Recipient()) case *EncryptedIdentity: r, err := id.Recipients() if err != nil { return nil, err } recipients = append(recipients, r...) default: return nil, fmt.Errorf("unexpected identity type: %T", id) } } return recipients, nil } type lazyOpener struct { name string f *os.File err error } func newLazyOpener(name string) io.WriteCloser { return &lazyOpener{name: name} } func (l *lazyOpener) Write(p []byte) (n int, err error) { if l.f == nil && l.err == nil { l.f, l.err = os.Create(l.name) } if l.err != nil { return 0, l.err } return l.f.Write(p) } func (l *lazyOpener) Close() error { if l.f != nil { return l.f.Close() } return nil } func absPath(name string) string { if abs, err := filepath.Abs(name); err == nil { return abs } return name } func warnDuplicates(s iter.Seq[string], name string) { seen := make(map[string]bool) warned := make(map[string]bool) for e := range s { if seen[e] && !warned[e] { warningf("duplicate %s %q", name, e) warned[e] = true } seen[e] = true } } ================================================ FILE: cmd/age/age_test.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main import ( "os" "os/exec" "path/filepath" "sync" "testing" "filippo.io/age" "filippo.io/age/plugin" "github.com/rogpeppe/go-internal/testscript" ) func TestMain(m *testing.M) { testscript.Main(m, map[string]func(){ "age": func() { testOnlyConfigureScryptIdentity = func(r *age.ScryptRecipient) { r.SetWorkFactor(10) } testOnlyFixedRandomWord = "four" main() }, "age-plugin-test": func() { p, _ := plugin.New("test") p.HandleRecipient(func(data []byte) (age.Recipient, error) { return testPlugin{}, nil }) p.HandleIdentity(func(data []byte) (age.Identity, error) { return testPlugin{}, nil }) os.Exit(p.Main()) }, }) } type testPlugin struct{} func (testPlugin) Wrap(fileKey []byte) ([]*age.Stanza, error) { return []*age.Stanza{{Type: "test", Body: fileKey}}, nil } func (testPlugin) Unwrap(ss []*age.Stanza) ([]byte, error) { if len(ss) == 1 && ss[0].Type == "test" { return ss[0].Body, nil } return nil, age.ErrIncorrectIdentity } var buildExtraCommands = sync.OnceValue(func() error { bindir := filepath.SplitList(os.Getenv("PATH"))[0] // Build age-keygen and age-plugin-pq into the test binary directory. cmd := exec.Command("go", "build", "-o", bindir) if testing.CoverMode() != "" { cmd.Args = append(cmd.Args, "-cover") } cmd.Args = append(cmd.Args, "filippo.io/age/cmd/age-keygen") cmd.Args = append(cmd.Args, "filippo.io/age/extra/age-plugin-pq") cmd.Args = append(cmd.Args, "filippo.io/age/cmd/age-plugin-batchpass") cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr return cmd.Run() }) func TestScript(t *testing.T) { testscript.Run(t, testscript.Params{ Dir: "testdata", Setup: func(e *testscript.Env) error { return buildExtraCommands() }, // TODO: enable AGEDEBUG=plugin without breaking stderr checks. }) } ================================================ FILE: cmd/age/encrypted_keys.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main import ( "bytes" "errors" "fmt" "filippo.io/age" ) // LazyScryptIdentity is an age.Identity that requests a passphrase only if it // encounters an scrypt stanza. After obtaining a passphrase, it delegates to // ScryptIdentity. type LazyScryptIdentity struct { Passphrase func() (string, error) } var _ age.Identity = &LazyScryptIdentity{} func (i *LazyScryptIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error) { for _, s := range stanzas { if s.Type == "scrypt" && len(stanzas) != 1 { return nil, errors.New("an scrypt recipient must be the only one") } } if len(stanzas) != 1 || stanzas[0].Type != "scrypt" { return nil, age.ErrIncorrectIdentity } pass, err := i.Passphrase() if err != nil { return nil, fmt.Errorf("could not read passphrase: %v", err) } ii, err := age.NewScryptIdentity(pass) if err != nil { return nil, err } fileKey, err = ii.Unwrap(stanzas) if errors.Is(err, age.ErrIncorrectIdentity) { // ScryptIdentity returns ErrIncorrectIdentity for an incorrect // passphrase, which would lead Decrypt to returning "no identity // matched any recipient". That makes sense in the API, where there // might be multiple configured ScryptIdentity. Since in cmd/age there // can be only one, return a better error message. return nil, fmt.Errorf("incorrect passphrase") } return fileKey, err } type EncryptedIdentity struct { Contents []byte Passphrase func() (string, error) NoMatchWarning func() identities []age.Identity } var _ age.Identity = &EncryptedIdentity{} func (i *EncryptedIdentity) Recipients() ([]age.Recipient, error) { if i.identities == nil { if err := i.decrypt(); err != nil { return nil, err } } return identitiesToRecipients(i.identities) } func (i *EncryptedIdentity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error) { if i.identities == nil { if err := i.decrypt(); err != nil { return nil, err } } for _, id := range i.identities { fileKey, err = id.Unwrap(stanzas) if errors.Is(err, age.ErrIncorrectIdentity) { continue } if err != nil { return nil, err } return fileKey, nil } i.NoMatchWarning() return nil, age.ErrIncorrectIdentity } func (i *EncryptedIdentity) decrypt() error { d, err := age.Decrypt(bytes.NewReader(i.Contents), &LazyScryptIdentity{i.Passphrase}) if e := new(age.NoIdentityMatchError); errors.As(err, &e) { return fmt.Errorf("identity file is encrypted with age but not with a passphrase") } if err != nil { return fmt.Errorf("failed to decrypt identity file: %v", err) } i.identities, err = parseIdentities(d) return err } ================================================ FILE: cmd/age/parse.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main import ( "bufio" "encoding/base64" "fmt" "io" "os" "strings" "unicode/utf8" "filippo.io/age" "filippo.io/age/agessh" "filippo.io/age/armor" "filippo.io/age/internal/term" "filippo.io/age/plugin" "filippo.io/age/tag" "golang.org/x/crypto/cryptobyte" "golang.org/x/crypto/ssh" ) type gitHubRecipientError struct { username string } func (gitHubRecipientError) Error() string { return `"github:" recipients were removed from the design` } func parseRecipient(arg string) (age.Recipient, error) { switch { case strings.HasPrefix(arg, "age1tag1") || strings.HasPrefix(arg, "age1tagpq1"): return tag.ParseRecipient(arg) case strings.HasPrefix(arg, "age1pq1"): return age.ParseHybridRecipient(arg) case strings.HasPrefix(arg, "age1") && strings.Count(arg, "1") > 1: return plugin.NewRecipient(arg, plugin.NewTerminalUI(printf, warningf)) case strings.HasPrefix(arg, "age1"): return age.ParseX25519Recipient(arg) case strings.HasPrefix(arg, "ssh-"): return agessh.ParseRecipient(arg) case strings.HasPrefix(arg, "github:"): name := strings.TrimPrefix(arg, "github:") return nil, gitHubRecipientError{name} } return nil, fmt.Errorf("unknown recipient type: %q", arg) } func parseRecipientsFile(name string) ([]age.Recipient, error) { var f *os.File if name == "-" { if stdinInUse { return nil, fmt.Errorf("standard input is used for multiple purposes") } stdinInUse = true f = os.Stdin } else { var err error f, err = os.Open(name) if err != nil { return nil, fmt.Errorf("failed to open recipient file: %v", err) } defer f.Close() } const recipientFileSizeLimit = 16 << 20 // 16 MiB const lineLengthLimit = 8 << 10 // 8 KiB, same as sshd(8) var recs []age.Recipient scanner := bufio.NewScanner(io.LimitReader(f, recipientFileSizeLimit)) var n int for scanner.Scan() { n++ line := scanner.Text() if strings.HasPrefix(line, "#") || line == "" { continue } if !utf8.ValidString(line) { return nil, fmt.Errorf("%q: recipients file is not valid UTF-8", name) } if len(line) > lineLengthLimit { return nil, fmt.Errorf("%q: line %d is too long", name, n) } r, err := parseRecipient(line) if err != nil { if t, ok := sshKeyType(line); ok { // Skip unsupported but valid SSH public keys with a warning. warningf("recipients file %q: ignoring unsupported SSH key of type %q at line %d", name, t, n) continue } if strings.HasPrefix(line, "AGE-") { return nil, fmt.Errorf("%q: error at line %d: apparent identity found in recipients file", name, n) } // Hide the error since it might unintentionally leak the contents // of confidential files. return nil, fmt.Errorf("%q: malformed recipient at line %d", name, n) } recs = append(recs, r) } if err := scanner.Err(); err != nil { return nil, fmt.Errorf("%q: failed to read recipients file: %v", name, err) } if len(recs) == 0 { return nil, fmt.Errorf("%q: no recipients found", name) } return recs, nil } func sshKeyType(s string) (string, bool) { // TODO: also ignore options? And maybe support multiple spaces and tabs as // field separators like OpenSSH? fields := strings.Split(s, " ") if len(fields) < 2 { return "", false } key, err := base64.StdEncoding.DecodeString(fields[1]) if err != nil { return "", false } k := cryptobyte.String(key) var typeLen uint32 var typeBytes []byte if !k.ReadUint32(&typeLen) || !k.ReadBytes(&typeBytes, int(typeLen)) { return "", false } if t := fields[0]; t == string(typeBytes) { return t, true } return "", false } // parseIdentitiesFile parses a file that contains age or SSH keys. It returns // one or more of *[age.X25519Identity], *[age.HybridIdentity], // *[agessh.RSAIdentity], *[agessh.Ed25519Identity], // *[agessh.EncryptedSSHIdentity], or *[EncryptedIdentity]. func parseIdentitiesFile(name string) ([]age.Identity, error) { var f *os.File if name == "-" { if stdinInUse { return nil, fmt.Errorf("standard input is used for multiple purposes") } stdinInUse = true f = os.Stdin } else { var err error f, err = os.Open(name) if err != nil { return nil, fmt.Errorf("failed to open file: %v", err) } defer f.Close() } b := bufio.NewReader(f) p, _ := b.Peek(14) // length of "age-encryption" and "-----BEGIN AGE" peeked := string(p) switch { // An age encrypted file, plain or armored. case peeked == "age-encryption" || peeked == "-----BEGIN AGE": var r io.Reader = b if peeked == "-----BEGIN AGE" { r = armor.NewReader(r) } const privateKeySizeLimit = 1 << 24 // 16 MiB contents, err := io.ReadAll(io.LimitReader(r, privateKeySizeLimit)) if err != nil { return nil, fmt.Errorf("failed to read %q: %v", name, err) } if len(contents) == privateKeySizeLimit { return nil, fmt.Errorf("failed to read %q: file too long", name) } return []age.Identity{&EncryptedIdentity{ Contents: contents, Passphrase: func() (string, error) { pass, err := term.ReadSecret(fmt.Sprintf("Enter passphrase for identity file %q:", name)) if err != nil { return "", fmt.Errorf("could not read passphrase: %v", err) } return string(pass), nil }, NoMatchWarning: func() { warningf("encrypted identity file %q didn't match file's recipients", name) }, }}, nil // Another PEM file, possibly an SSH private key. case strings.HasPrefix(peeked, "-----BEGIN"): const privateKeySizeLimit = 1 << 14 // 16 KiB contents, err := io.ReadAll(io.LimitReader(b, privateKeySizeLimit)) if err != nil { return nil, fmt.Errorf("failed to read %q: %v", name, err) } if len(contents) == privateKeySizeLimit { return nil, fmt.Errorf("failed to read %q: file too long", name) } return parseSSHIdentity(name, contents) // An unencrypted age identity file. default: ids, err := parseIdentities(b) if err != nil { return nil, fmt.Errorf("failed to read %q: %v", name, err) } return ids, nil } } func parseIdentity(s string) (age.Identity, error) { switch { case strings.HasPrefix(s, "AGE-PLUGIN-"): return plugin.NewIdentity(s, plugin.NewTerminalUI(printf, warningf)) case strings.HasPrefix(s, "AGE-SECRET-KEY-1"): return age.ParseX25519Identity(s) case strings.HasPrefix(s, "AGE-SECRET-KEY-PQ-1"): return age.ParseHybridIdentity(s) default: return nil, fmt.Errorf("unknown identity type") } } // parseIdentities is like [age.ParseIdentities], but supports plugin identities. func parseIdentities(f io.Reader) ([]age.Identity, error) { const privateKeySizeLimit = 1 << 24 // 16 MiB var ids []age.Identity scanner := bufio.NewScanner(io.LimitReader(f, privateKeySizeLimit)) var n int for scanner.Scan() { n++ line := scanner.Text() if strings.HasPrefix(line, "#") || line == "" { continue } if !utf8.ValidString(line) { return nil, fmt.Errorf("identities file is not valid UTF-8") } i, err := parseIdentity(line) if err != nil { if strings.HasPrefix(line, "age1") { return nil, fmt.Errorf("error at line %d: apparent recipient found in identities file", n) } return nil, fmt.Errorf("error at line %d: %v", n, err) } ids = append(ids, i) } if err := scanner.Err(); err != nil { return nil, fmt.Errorf("failed to read identities file: %v", err) } if len(ids) == 0 { return nil, fmt.Errorf("no identities found") } return ids, nil } func parseSSHIdentity(name string, pemBytes []byte) ([]age.Identity, error) { id, err := agessh.ParseIdentity(pemBytes) if sshErr, ok := err.(*ssh.PassphraseMissingError); ok { pubKey := sshErr.PublicKey if pubKey == nil { pubKey, err = readPubFile(name) if err != nil { return nil, err } } passphrasePrompt := func() ([]byte, error) { pass, err := term.ReadSecret(fmt.Sprintf("Enter passphrase for %q:", name)) if err != nil { return nil, fmt.Errorf("could not read passphrase for %q: %v", name, err) } return pass, nil } i, err := agessh.NewEncryptedSSHIdentity(pubKey, pemBytes, passphrasePrompt) if err != nil { return nil, err } return []age.Identity{i}, nil } if err != nil { return nil, fmt.Errorf("malformed SSH identity in %q: %v", name, err) } return []age.Identity{id}, nil } func readPubFile(name string) (ssh.PublicKey, error) { if name == "-" { return nil, fmt.Errorf(`failed to obtain public key for "-" SSH key Use a file for which the corresponding ".pub" file exists, or convert the private key to a modern format with "ssh-keygen -p -m RFC4716"`) } f, err := os.Open(name + ".pub") if err != nil { return nil, fmt.Errorf(`failed to obtain public key for %q SSH key: %v Ensure %q exists, or convert the private key %q to a modern format with "ssh-keygen -p -m RFC4716"`, name, err, name+".pub", name) } defer f.Close() contents, err := io.ReadAll(f) if err != nil { return nil, fmt.Errorf("failed to read %q: %v", name+".pub", err) } pubKey, _, _, _, err := ssh.ParseAuthorizedKey(contents) if err != nil { return nil, fmt.Errorf("failed to parse %q: %v", name+".pub", err) } return pubKey, nil } ================================================ FILE: cmd/age/testdata/armor.txt ================================================ age -d -i key.txt armored_with_leading_and_trailing_whitespace.txt stdout test -- key.txt -- # created: 2025-12-23T22:21:12+01:00 # public key: age15w9kgvgggmfra4sz6vk39kz4mveuq2sfv5vmcu090y0k2sluepaqv7z2fv AGE-SECRET-KEY-18J6FVYJE2AFSJ0RPH6M29GMUU62UVRSCNWUJZSGETH6R38Q5AZ3S2DHAZ9 -- armored_with_leading_and_trailing_whitespace.txt -- -----BEGIN AGE ENCRYPTED FILE----- YWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IFgyNTUxOSA5ODhFNHR6RVg0SGVHZFBM clBEclEzZ3NvOGhqVE9tcFZnbTc2c3R5a0Q4ClZjVzBLNjdxRElZV3E0Z3ZpZ255 T3JWTFBHRFA2cytpWWtkeU45dDRadmcKLS0tIHV3L3hOVmJjL0hMRXBQa05lMlRs ZW45TndPeE9GcmRNeWFkR3YxeHg0YzQKJBp6KRlFFUE8jbAQUBlcAwaaQcPAflJD pWGoOjYP33gTxJHNPg== -----END AGE ENCRYPTED FILE----- ================================================ FILE: cmd/age/testdata/batchpass.txt ================================================ # encrypt and decrypt with AGE_PASSPHRASE env AGE_PASSPHRASE_WORK_FACTOR=5 env AGE_PASSPHRASE=password age -e -j batchpass -o test.age input age -d -j batchpass test.age cmp stdout input # decrypt with AGE_PASSPHRASE_MAX_WORK_FACTOR env AGE_PASSPHRASE_MAX_WORK_FACTOR=10 age -d -j batchpass test.age cmp stdout input # AGE_PASSPHRASE_MAX_WORK_FACTOR lower than work factor env AGE_PASSPHRASE_MAX_WORK_FACTOR=3 ! age -d -j batchpass test.age stderr 'work factor' env AGE_PASSPHRASE_MAX_WORK_FACTOR= # error: both AGE_PASSPHRASE and AGE_PASSPHRASE_FD set env AGE_PASSPHRASE=password env AGE_PASSPHRASE_FD=3 ! age -e -j batchpass -a input stderr 'mutually exclusive' # error: neither AGE_PASSPHRASE nor AGE_PASSPHRASE_FD set env AGE_PASSPHRASE= env AGE_PASSPHRASE_FD= ! age -e -j batchpass -a test.age stderr 'must be set' # error: incorrect passphrase env AGE_PASSPHRASE=wrongpassword ! age -d -j batchpass test.age stderr 'incorrect passphrase' # error: encrypting to other recipients along with passphrase env AGE_PASSPHRASE=password ! age -e -j batchpass -r age1gc2zwslg9j25pg9e9ld7623aewc2gjzquzgq90m75r75myqdt5cq3yudvh -a input stderr 'incompatible recipients' ! age -e -r age1gc2zwslg9j25pg9e9ld7623aewc2gjzquzgq90m75r75myqdt5cq3yudvh -j batchpass -a input stderr 'incompatible recipients' # decrypt with native scrypt [!linux] [!darwin] skip # no pty support [darwin] [go1.20] skip # https://go.dev/issue/61779 ttyin terminal age -d test.age cmp stdout input -- terminal -- password password -- input -- test ================================================ FILE: cmd/age/testdata/duplicates.txt ================================================ # Test duplicate recipient detection age -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -r age1yv2sxrjnyymx4qkn3ehdd5zdq4xnrea5ljm4hsmgxn5tpv985anqkrwqa7 -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -o test.age input stderr 'warning: duplicate recipient "age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85"' # Test duplicates separated by different argument age -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -a -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -o test2.age input stderr 'warning: duplicate recipient "age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85"' # Test duplicate recipients file detection age -R recipients1.txt -R recipients2.txt -R recipients1.txt -o test3.age input stderr 'warning: duplicate recipients file "recipients1.txt"' # Test duplicates separated by output flag age -R recipients1.txt -o test4.age -R recipients1.txt input stderr 'warning: duplicate recipients file "recipients1.txt"' # First create an encrypted file for decrypt tests age -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -o encrypted.age input # Test duplicate identity file detection (decrypt mode) age -d -i key1.txt -i key2.txt -i key1.txt encrypted.age stderr 'warning: duplicate identity file "key1.txt"' # Test duplicates separated by different argument in decrypt mode age -d -i key1.txt -o test.out -i key1.txt encrypted.age stderr 'warning: duplicate identity file "key1.txt"' # Test no warning when no duplicates age -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -r age1yv2sxrjnyymx4qkn3ehdd5zdq4xnrea5ljm4hsmgxn5tpv985anqkrwqa7 -o test5.age input ! stderr 'warning: duplicate' # Test multiple duplicates (same value repeated 3+ times) age -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -r age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -o test6.age input stderr 'warning: duplicate recipient "age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85"' -- input -- test data -- recipients1.txt -- age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 -- recipients2.txt -- age1yv2sxrjnyymx4qkn3ehdd5zdq4xnrea5ljm4hsmgxn5tpv985anqkrwqa7 -- key1.txt -- # created: 2025-12-22T22:06:22+01:00 # public key: age1jh0u9yam5jhql7vy4acz90p0rhqcr0rcyu4zm85s9sdcwrs7rfgshtdg85 AGE-SECRET-KEY-1WRM2S8SP3XSKLLXAXS489EXZNKCKRZWYQLQ8D2NRNQWCVAPSMA9SC5JWZQ -- key2.txt -- # created: 2025-12-22T22:06:27+01:00 # public key: age1yv2sxrjnyymx4qkn3ehdd5zdq4xnrea5ljm4hsmgxn5tpv985anqkrwqa7 AGE-SECRET-KEY-1WZ3MRPAWEWR4DG474H460MXX7J2T0TEYNJ0SKQDMKP02JU7UJ9UQFGLZCE ================================================ FILE: cmd/age/testdata/ed25519.txt ================================================ # encrypt and decrypt a file with -R age -R key.pem.pub -o test.age input age -d -i key.pem test.age cmp stdout input ! stderr . # encrypt and decrypt a file with -i age -e -i key.pem -o test.age input age -d -i key.pem test.age cmp stdout input ! stderr . # encrypt and decrypt a file with the wrong key age -R otherkey.pem.pub -o test.age input ! age -d -i key.pem test.age stderr 'no identity matched any of the recipients' ! stdout . -- input -- test -- key.pem -- -----BEGIN OPENSSH PRIVATE KEY----- b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW QyNTUxOQAAACB/aTuac9tiWRGrKEtixFlryYlGCPTOpdbmXN9RRmDF2gAAAKDgV/GC4Ffx ggAAAAtzc2gtZWQyNTUxOQAAACB/aTuac9tiWRGrKEtixFlryYlGCPTOpdbmXN9RRmDF2g AAAECvFoQXQzXgJLQ+Gz4PfEcfyZwC2gUjOiWTD//mTPyD8H9pO5pz22JZEasoS2LEWWvJ iUYI9M6l1uZc31FGYMXaAAAAG2ZpbGlwcG9AQmlzdHJvbWF0aC1NMS5sb2NhbAEC -----END OPENSSH PRIVATE KEY----- -- key.pem.pub -- ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIH9pO5pz22JZEasoS2LEWWvJiUYI9M6l1uZc31FGYMXa -- otherkey.pem.pub -- ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJFlMdZUMrWjJ3hh60MLALXSqUdAjBo/qEMJzvpekpoM ================================================ FILE: cmd/age/testdata/encrypted_keys.txt ================================================ # TODO: age-encrypted private keys, multiple identities, -i ordering, -e -i, # age file password prompt during encryption [!linux] [!darwin] skip # no pty support [darwin] [go1.20] skip # https://go.dev/issue/61779 # use an encrypted OpenSSH private key without .pub file age -R key_ed25519.pub -o ed25519.age input rm key_ed25519.pub ttyin terminal age -d -i key_ed25519 ed25519.age cmp stdout input ! stderr . # -e -i with an encrypted OpenSSH private key age -e -i key_ed25519 -o ed25519.age input ttyin terminal age -d -i key_ed25519 ed25519.age cmp stdout input # a file encrypted to the wrong key does not ask for the password age -R key_ed25519_other.pub -o ed25519_other.age input ! age -d -i key_ed25519 ed25519_other.age stderr 'no identity matched any of the recipients' # use an encrypted legacy PEM private key with a .pub file age -R key_rsa_legacy.pub -o rsa_legacy.age input ttyin terminal age -d -i key_rsa_legacy rsa_legacy.age cmp stdout input ! stderr . age -R key_rsa_other.pub -o rsa_other.age input ! age -d -i key_rsa_legacy rsa_other.age stderr 'no identity matched any of the recipients' # -e -i with an encrypted legacy PEM private key age -e -i key_rsa_legacy -o rsa_legacy.age input ttyin terminal age -d -i key_rsa_legacy rsa_legacy.age cmp stdout input # legacy PEM private key without a .pub file causes an error rm key_rsa_legacy.pub ! age -d -i key_rsa_legacy rsa_legacy.age stderr 'key_rsa_legacy.pub' # mismatched .pub file causes an error cp key_rsa_legacy key_rsa_other ttyin terminal ! age -d -i key_rsa_other rsa_other.age stderr 'mismatched private and public SSH key' # buffer armored ciphertext before prompting if stdin is the terminal ttyin terminal age -e -i key_ed25519 -a -o test.age input exec cat test.age terminal # concatenated ciphertext + password ttyin -stdin stdout age -d -i key_ed25519 ttyout 'Enter passphrase' ! stderr . cmp stdout input -- input -- test -- terminal -- password -- key_ed25519 -- -----BEGIN OPENSSH PRIVATE KEY----- b3BlbnNzaC1rZXktdjEAAAAACmFlczI1Ni1jdHIAAAAGYmNyeXB0AAAAGAAAABCuvb97i7 U6Dz4+4SaF3kK1AAAAEAAAAAEAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIKaVctg4/hmFbfof Tv+yrC2IweO/Dd2AVDijFpaMO9fmAAAAoMO7yEnisRmzFdiExNt3XTYuLdP9m3jgOCroiF TtBhh1lAB2qggzWExMRP3Ak8+AloXEcWiACwBYnqwxhQMh0RDCDKC/H/4SXO+ds4HFWil+ 4bGF9wYZFU7IEjIK91CPGJ6YoWPn9dSdEjjbuCJtOMwHsysGyw5n/qSFPmSAPmA4YL2OzM WFOJ5gB5o1LKZkDTcdt7kPziIoVd5QkqpnYsE= -----END OPENSSH PRIVATE KEY----- -- key_ed25519.pub -- ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKaVctg4/hmFbfofTv+yrC2IweO/Dd2AVDijFpaMO9fm -- key_ed25519_other.pub -- ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINbTd+xfSBYKR/1Hp7FsoxwQAdIOk1Khye6ALBj7e1CV -- key_rsa_legacy -- -----BEGIN RSA PRIVATE KEY----- Proc-Type: 4,ENCRYPTED DEK-Info: AES-128-CBC,8045E7CF19D7794F4ADF5AC63179D985 OESHhWCho337W1Ajg+iMbsZx/FPtHM3YPHu/d1U51ERIUh0wVof2SK0ooENokr6g O3fcv9Xga+Na4Ez+gsFRsIZOdqrJq+QBH0CAKi+Mz4KsU7teAobUBJgRB31Wt7eI 39KGZeaBJLMQ0FzQkDx5MCOg98iu9rt+Pg1bH8X88wV4vOv+tG4nmqgdpDmouo1Q uW1TJxrdPhkINjaPZZ7gvjS8wuG9+qwQY76I0hGun9secf4VZDysqUnUp8UHYovR dbvKCbglQy18mGL4kREJ/hH/9/maefS+pTMb2UX0onp9j7l3yNSvL4A4xW85ii6x liVMnZvLvbfPtI7jjZtC8CjshRkZke4fSZF2nZP7zK2qVcqDFCtemaks+0i2ksel D8clUKhBmq23VNAt+iy1stwHBporuaE6kEVJail5WPpgdfQjifpaMbTsZgOK+vGL GKi8vSJWfMU3lTf/N++ks2FWxdq0TgQirsKsQ5mWobfxc1XehvvdJj8hUtArrP32 d4ge5DXPpmtkCzrc1+wt8Py/ANl9jV6c+4fCbpQ2snyzdFEhFtXHCEpMguN9MhKI gaZIfAxvYcQr8Gwew/IB02Phda9tvDiedHvyHGJmSy/87fR6ECh47VDFL/UYu4jG 0hRtAZMMddGNfoosnO6OKBd09cgvXKCsUrbpAI7dF5TP5ItDkVb08hW446jBdgS9 7QqB0rPmlAjsJi7fsrDw7Nq9pOdqqCEwUMc9Lztnv66aX1d/Y2vQm9mrsDbyZKqn g621rg7E4UHf7EGiDblfS234+TsNvwZ6sEbivU+3zqglPiOF71m6D0cKgaUZPOua GNdyQz5e73hYa+NJ76IZ+IqkoJAFXBkd1nWcN6DUBYiKvqd4qO9xD+JvNtiFlQ9d pyO9t4FTGvySh8CKyEUEdtj+2ftCIuZaUD2L5YJU1tlQV0EH42InOmkmphbHkW5v lNAoZAny1Z0P6O0gn7xtVrgd7paVQfDCJtkvsm5zR6Yei5FUgY/9NPaRotzuZVAY EfQC7JPdSdb5yusnXh7B9jGkgxhMIb6EPFFjIZ4iaV1RVgINSisGMSFzlqOz702b Cawsr9nD438cjzMNYEmrihZZBjHon6hHrLmM9Aj2xgprsoNLP1jJQ6WpZDlrYsj0 XS0tSJmh0pM4Ey6j1VWNoaOxVseYLW7J9wGVfH/HJAc2k6Wg46P2e8lMT6Sj4YsT EguDhUjXrgePC53ohcSF+I6x35Q1D6ttMnc3ODzmIcCisxAvWdAqi1yRlnBotRwg S2vq3HU0yJFG8pJqw4vU9A9DlaMMT+ejEH+9xVwAWM+7n2lJcgthtWuShZCE6BB+ jVobSlTMArzQj4klTSbew1m9Waa6kKDezsAY66mryVNofCCeYDOBRecCm5JyMnWf WBVnNx+kZ/YyvYeBcSh34u8rkjqGpzfM/oPE7GwIoZvbAirjLohL7u8oq2bfAYG0 /xIPwPJw1O3o5PHeu84bVIRqcKzGeaVL+5aUiZP9uNGUpqJWA5q2Sa5BOXV46yqO DIS8q7uPCSbt5mPXPDGJ1CupCdA1stUf2kb0cDJ+LpUbPND9SebBlxSuR1D/YGqv wlzfN5Usv/h/XNl98bYtpY8/skKPecyx3wG3VtwWH/5XVhvHz4TENjlKv/L2pbUC Dv83WcL1N/i+jerYxDRmGe3NQOvyW4JaNzzjgb74T7rE1/3lf6qkmUHjxfo4VZAF L/q2782OUs5Qt4/pYAIISzLdBw6XtTjZHirqa6YNrFvGucB3NG49AC0b1Z0acfrS iimC2TvZpwunlLbyz2SQQL2c1zQ3U/Yfh2F1Zt8o6kK3RgKSSx57rK6nV7hXMGGp C4HV3nLetZg8HexicqeRANLXuUDbCSpN8K4nW5G2g/yKPfsQHBV/RWEDfhndykja +SmoY5IB+2zEbCC3MWiP9ZdIcCYOsq8wDZESMMW40DlVICjrf6UOqQ+ogci20qLS CmpgmOPAaBZJG/sBU79eHUSjPCK6yDpSyc30oVn8FnoBTmOpt7R++Ub8RJxReXBt +6o0NXYCJNaeVnk1bE4iavkJrXJCZvu44VBLS0WUs9W8TD4Iq8kNHsfQsfOuBXnQ ncgoIe9HppnMGNoSzjYBNL/rprlbaOE55TkPqiQsiskRcaoeY53aTxoIykHmoj8G wJo/00IR+NYir7tr03Vriw+uywPPGucVJGWTUGsNbHlS5j941IltflIf6FitElNr JxVuJLgYiP3JhmWpdqA/uidYJMbIjunpn/8rVLrAil04SCSfUmaCdl7dkQ9x+3Mf Erm699vIBQwvv0i+mcwKEvqSrhhNQ2F7vrb7NL8I2wUEPgQbv1PxSV6X0aYcxYVI -----END RSA PRIVATE KEY----- -- key_rsa_legacy.pub -- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCky7Clp8I3LVoqZWtat+QR6KmM0evFilmFhwenINIBbb8eS3ftDSkQy2YRrlAvO3h4EZffOIxANGL/yKVlRCIzvjsphi+tTHscZsQhwMnLEmxEayTq20hZKcwNA8TQdh2TW/w0KZmNZcxlTn4IK8W16komHcoH/qrRiXq8z3ROcfnv3Q4Hll9MUCwBkfy2DdBpWUMidQ1dAK4i3vXdseF74hJ0jFbPtS5mlpOsJZa0sdH1dnEl5M8wZS3PxyzM6JMkgzG7INp4sO/xGIisjl/QuSh2Fu93/EogdGXxIZChniUfzBx1DaHlerPPNSMP+uLbaOIAQrIPozhfdUdsCFDMoB7/PA6g1WVYZWAqjBZZW/GMOzPhih57NIFBSyMTzMi1KS6OBvYJvPf4IcvOa3May9ylLG/wZVhrHlQPbSsbRrraVtJ1P4gGQJ5U4d2AD2q+XtMb5f2i/holMXTVQl7Fa7RYi1TblDuW5OZCvmIawePBXAYbPg0OVFs3vAVEuAM= -- key_rsa_other.pub -- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDQiCWw2W++gX4wcwpDo6QIouwQ9PPwCVe7QPICzxztG27mzeKRM4xT2LURGSaQqg7OYIUTGrLqNsaLZW+FHHQlRAVv1LEbdEFa5JermBMJ5j/HxamE/7oV60gMRlgKW+4IZhVMPgRZaaXU0YPb9oACdMNM8kPkc5JaOJ8iO6B1RViybjLD+tsEEPXLp3Mrj+sJqs+IvNlJKXdeefOjNrGmLHKIFdHiWlZ+aAW+QLfMQiNXoTbGybFUSpNEbmK/1ITiRAly94NoUK9LoriueXR+WJIm9wP4SfHw+hMBz1cywdF2wwKmWWegizV/USEmhyNXUzHZzjbkgE84DrIq+NA7SUmw6C8ClMjdnRnnoIyga99yMIrYMny1KW/bk1NK4u6Tv17E+FFOS3vf2Gcj01/jOmAUIQwL8MjAHhnsZ4XAA5NHa2NRGWm+hw7fx5uX42Gyz8HidFda5Lij1pASBcx4U3qwb62X+IVN50jGIP6kRNmGtMLY1JgaoGDDkw9r6mU= ================================================ FILE: cmd/age/testdata/hybrid.txt ================================================ # encrypt and decrypt a file with -r age -r age1pq1044e3hfmq2tltgck54m0gnpv8rfrwkdxjgl38psnwg8zfyv4uqdu63kk0u94ztt0q35k9dzuwgv405kxq6due2sre2kfsjftf7k2vz2mdpetku9pufy9d6ny6k5ss0cghpxdxrux0yd5xy40f8fu8ch9xn2rczyek2pqetqk0l9fqj0e3hfhkyfmcf9j6cpe5mf5stt9cymfq3xm276x4sramhn8srr42g78q9rkmqesevy33p4kdhkuggl99x9zx7j05uflx3s8q558xeaq9q9ctxqx52rzg6yffwykxngvxf7g3n83ddawagq2lnk59kcnexm54jrsmkjk9nemlge9v6p7fxu5z6yvq3ghpet8ww2c3h9fylvjx6j9njwz744376ap5r3xcpzh7qlk0kq3gknzfqhmxmjqypf6xz6geffdmy25apzsfr4ce0x825njkf62mgzx0x9n3zt0490u4dnt4468zse4zvd9sv0ycx2u2wsseuy4yymrg0nmfuxcwq9q0jykq7g5f59vunf95vnmcw336ksrh43fgapsd40u4227ymx56xtudtrte39twnq6fdfdj4p9pgx7pcqdk953za76fqcnvatx2cmywurag7ky4y8ecq5lvf25rydhxg6gmcn6vf78vtsqw79hp3mzv2u4v4jzn0nk50kl4gpv7k60cgz79c6k30jzy8dyetqtwg04tguxkv2p4hqj02yvsz2szaqdn9flu24rhth3v0t33023nwy27gt0x32eqpa5tpz6ygz3yzcsa3w889drpynzd5hlywuk9dwgafuax7upfnnxch4znrx4vactasg32u7vl886pxfswskk7wjgqkggrewtnaecfusl3nmg0xxh8e5nl5eft0xqwj5rk9ajn2j6yxehhgg5k6kpw5pk382hxmpu8wcd3rqx6m8905c7f8v0x2z9gyduxtqp2fdy9w2z4g2rrgu4d5cqes5tnwag007h2f326s3j9p6970xyd73rv5awx27zzezrax467c6vuye62ha88pzhw9xytjpezw3vg3l6x4k9rxwm9f6lwj6j7r9makg59rhgt0355s3jx9vw3raz5qdk5cnpny56q5h3dyd75suskuz63wmmfp9333tx4ry38vnh7jxy0j0cka99y7v2dmyjldjy0mqjetcefsmmg3pw0h9ll0rtskpmxz2cs8vmx6lu4v5rjtzpzgaqt46cwvnmhy5e3ye0tv6sre342lwg0tfd0yjkfz2haqc3hprpqf5ce8c9lx076dnk5cukn3tu38jgprrxt9sk9nqzt8grvkc4qzlg8jjf638v07ej9cf4eu48kphrgyjy83qm822xq8v9k22zwa7txr439x74j2f9ay7frkwtfdwn02enyx8stjpr4wgg25n5tj7uxyx0dqt3hnrqf7dcgt9fqnkjgemjfzyck6pawewptcayxm49sq3477f4cvm2p8fmg27rcmwm5l2vmzvdmymvkrr3aywu04y3zlhs7awu3r9u9lseheqpffvm2xf8y6w2qaj9g22pcu0sdsnqseusrxq9awru5lyqxnzftlslgpe3njegxkze98rveswp3u0xgx69wkg38vgp4k55lwwgv5l7ccv503mh9q23nud4xtm499xq276u40rxyrzaqfyuz2f3v5qr2vq00xs4g3ruynmq0c6nprvjcwqc5zrdn4cnzeeuwumjvqfjdpxr739n4cqcwytc8pjmfcj2qs3l2a8p5fzq7nvtng2jvvklx0x5ypnlkeuegsm587f6d4dkwel2es0lwwt88y2jdg8enjyph02tnjyndlx34h52fngjk96ggtu6vcxqkreqcxs4gwa8ww40t0kzlxfzyfhtjmfdm5fcrr5pt2xm4yslfynr0h9wkranhyadxf33kjn9xpg2fq5hnlq0 -o test.age input age -d -i key.txt test.age cmp stdout input ! stderr . # encrypt and decrypt a file with -i age -e -i key.txt -o test.age input age -d -i key.txt test.age cmp stdout input ! stderr . # encrypt and decrypt a file with the wrong key age -r age12phkzssndd5axajas2h74vtge62c86xjhd6u9anyanqhzvdg6sps0xthgl -o test.age input ! age -d -i key.txt test.age stderr 'no identity matched any of the recipients' age -r age1pq13tgqupu990y5qlwwjy4zrzwvxg54cq89x9pxzdjenv4cl7affsqeerksrc6ufw3ndp4h5p3l5hm2jekkd7uay2mlh9eqg3sjcwmv5dcrwguc8djf83qr8gswtdrpav3jpw47kgkh6z0rnfk92xyqeyce48t02n4qz68augry3r3nd4rpdsw998vnnxzd2vepypktx2wxhfvd56jw7p32te6ttcyhc7tkqy2ks77jtjl8cgyal43pcd3g9wkcsgytccqtcnzcucjjdadpr0v7ye8u9fqusq6cq2ah0e4ejrltc8sk6763d7mjkuchmc5tkx6xztygqjx4ldxqh7jzkkyuv6ywt07ys4x09eq7gat4wuznrvgs3pkxjju8t9n0gpfqrsv658m5v09ltqc3c5z30n43ld43dwe5dn8nsk89f43tzsw2zta5kvl95zv0a94tc5y9r4ncj8g63fgljzhdxl96eg39rgd56yuvr2xdvavkk93a85n99jpjeqkfveprqc7eqft0wp7qgxcgsrwcdymgp0cqaj93jp4ckln36ylcwdzew234esa2awty25zc6pmc0jcpkrfuuptr9z5a4kx9ff4ppfff2lw95um853tcg47fa444er9k9j4e8vy5hfjx626j3tz3kc94jl8r66ahfprwtcyxae3swe9xxjhx5dfnt53n5fs2ut83t597wscjg9jc4f6h4uen2ll2ne30w7uvts8vuc5mpcfpp9espa78y0f8588m62kzez5kxxtcxykdkrnjx08w5az3pr6g6dsykwazcxtetpkq85mg7kay84z58slmvxmq56342pm6v8y3evr5wvc9g4j87jfhmryymkz9wk2en2v6tfy83rz657t0w7p3va46jt22f29u9ggzt9nu6qtguw4cp7cpj572ccyenw5rdh43h6s54g73gvxapsq3hw5yfkgttcyhkrjf9ykzd3wm5zsqgp5fca0nr56dnqe3kqrszasagqne0a83cguzwj9aw456jaxg9rurq4n4f6qec4srd0rxqfqc6rw22c2p4xyg25pls4dmxvce2fah8m6shue84preky2h0c4sa9y9tjuzn20gr9aav96e689nqx23s7zz0lvhq925jdkn04cdpzfscvhh93vh9f2tmwkzsq7pq0ncjk8g8cu75u77lyej46a4m2fefy8v2x4nzay05kulhyzk69520r7fdg3fzh0z7ysequcltr94hyf88h46hfujk30x9jp8u0pcjywh06g7tv483ypmc3pm3x3z4h9ph66lx228t3r96hyt764yxe2rn5clnfxkj3k5wf5hffehj58y56qyykwayk6qt9skvctxw20v9xy5ppnld3lushqpsutxht7cqygypdn5d2ppdgaerqzgehyrpdwzkhu0qe8w3u5h6htz8aa5zfpzy4s7sl8zdv3q0gq8ez08p86e4v3m82882yvawrvyrcxewrznwkvvez8m5aj6ktgvynyy0kc2trmtjzvjlxdf06e3rjmf55lwxrucfwu2sxdtnte83fgq0tvr2juv3pfqp8ddsrnckzqcfcvjp02mfg5y4aqlsunxpfcrdm46fphwsslrudwrfh542xg62kphca6h3xxqn538pprkknt35y00ygvrse5mxpvnstvcrnak5qduhf5dqslkn0yeadgpq6tv4wzy98kdjdzp22cpq6dy3kve856y2qlk7elyqyzj7ezpnh3vjwwmcm7ctp23k2sct86jd46ztplsq5vdjg9lyspxt0k8qx5udu9lwgulzapn3kdg7yd2zdz5dqf9933mpzwc32x8uxn8h2v5hlhdd4qk0uvwxhxyul8keaw39pz2avywk3wfly6veet9pjnj7nqecrgz824whs9sf7wl2shxk9kvkteht4z9x3w2gc6hqz5y -o test.age input ! age -d -i key.txt test.age stderr 'no identity matched any of the recipients' # cannot mix hybrid and X25519 recipients ! age -r age1pq1044e3hfmq2tltgck54m0gnpv8rfrwkdxjgl38psnwg8zfyv4uqdu63kk0u94ztt0q35k9dzuwgv405kxq6due2sre2kfsjftf7k2vz2mdpetku9pufy9d6ny6k5ss0cghpxdxrux0yd5xy40f8fu8ch9xn2rczyek2pqetqk0l9fqj0e3hfhkyfmcf9j6cpe5mf5stt9cymfq3xm276x4sramhn8srr42g78q9rkmqesevy33p4kdhkuggl99x9zx7j05uflx3s8q558xeaq9q9ctxqx52rzg6yffwykxngvxf7g3n83ddawagq2lnk59kcnexm54jrsmkjk9nemlge9v6p7fxu5z6yvq3ghpet8ww2c3h9fylvjx6j9njwz744376ap5r3xcpzh7qlk0kq3gknzfqhmxmjqypf6xz6geffdmy25apzsfr4ce0x825njkf62mgzx0x9n3zt0490u4dnt4468zse4zvd9sv0ycx2u2wsseuy4yymrg0nmfuxcwq9q0jykq7g5f59vunf95vnmcw336ksrh43fgapsd40u4227ymx56xtudtrte39twnq6fdfdj4p9pgx7pcqdk953za76fqcnvatx2cmywurag7ky4y8ecq5lvf25rydhxg6gmcn6vf78vtsqw79hp3mzv2u4v4jzn0nk50kl4gpv7k60cgz79c6k30jzy8dyetqtwg04tguxkv2p4hqj02yvsz2szaqdn9flu24rhth3v0t33023nwy27gt0x32eqpa5tpz6ygz3yzcsa3w889drpynzd5hlywuk9dwgafuax7upfnnxch4znrx4vactasg32u7vl886pxfswskk7wjgqkggrewtnaecfusl3nmg0xxh8e5nl5eft0xqwj5rk9ajn2j6yxehhgg5k6kpw5pk382hxmpu8wcd3rqx6m8905c7f8v0x2z9gyduxtqp2fdy9w2z4g2rrgu4d5cqes5tnwag007h2f326s3j9p6970xyd73rv5awx27zzezrax467c6vuye62ha88pzhw9xytjpezw3vg3l6x4k9rxwm9f6lwj6j7r9makg59rhgt0355s3jx9vw3raz5qdk5cnpny56q5h3dyd75suskuz63wmmfp9333tx4ry38vnh7jxy0j0cka99y7v2dmyjldjy0mqjetcefsmmg3pw0h9ll0rtskpmxz2cs8vmx6lu4v5rjtzpzgaqt46cwvnmhy5e3ye0tv6sre342lwg0tfd0yjkfz2haqc3hprpqf5ce8c9lx076dnk5cukn3tu38jgprrxt9sk9nqzt8grvkc4qzlg8jjf638v07ej9cf4eu48kphrgyjy83qm822xq8v9k22zwa7txr439x74j2f9ay7frkwtfdwn02enyx8stjpr4wgg25n5tj7uxyx0dqt3hnrqf7dcgt9fqnkjgemjfzyck6pawewptcayxm49sq3477f4cvm2p8fmg27rcmwm5l2vmzvdmymvkrr3aywu04y3zlhs7awu3r9u9lseheqpffvm2xf8y6w2qaj9g22pcu0sdsnqseusrxq9awru5lyqxnzftlslgpe3njegxkze98rveswp3u0xgx69wkg38vgp4k55lwwgv5l7ccv503mh9q23nud4xtm499xq276u40rxyrzaqfyuz2f3v5qr2vq00xs4g3ruynmq0c6nprvjcwqc5zrdn4cnzeeuwumjvqfjdpxr739n4cqcwytc8pjmfcj2qs3l2a8p5fzq7nvtng2jvvklx0x5ypnlkeuegsm587f6d4dkwel2es0lwwt88y2jdg8enjyph02tnjyndlx34h52fngjk96ggtu6vcxqkreqcxs4gwa8ww40t0kzlxfzyfhtjmfdm5fcrr5pt2xm4yslfynr0h9wkranhyadxf33kjn9xpg2fq5hnlq0 -r age12phkzssndd5axajas2h74vtge62c86xjhd6u9anyanqhzvdg6sps0xthgl -o test.age input stderr 'incompatible' ! age -r age12phkzssndd5axajas2h74vtge62c86xjhd6u9anyanqhzvdg6sps0xthgl -r age1pq1044e3hfmq2tltgck54m0gnpv8rfrwkdxjgl38psnwg8zfyv4uqdu63kk0u94ztt0q35k9dzuwgv405kxq6due2sre2kfsjftf7k2vz2mdpetku9pufy9d6ny6k5ss0cghpxdxrux0yd5xy40f8fu8ch9xn2rczyek2pqetqk0l9fqj0e3hfhkyfmcf9j6cpe5mf5stt9cymfq3xm276x4sramhn8srr42g78q9rkmqesevy33p4kdhkuggl99x9zx7j05uflx3s8q558xeaq9q9ctxqx52rzg6yffwykxngvxf7g3n83ddawagq2lnk59kcnexm54jrsmkjk9nemlge9v6p7fxu5z6yvq3ghpet8ww2c3h9fylvjx6j9njwz744376ap5r3xcpzh7qlk0kq3gknzfqhmxmjqypf6xz6geffdmy25apzsfr4ce0x825njkf62mgzx0x9n3zt0490u4dnt4468zse4zvd9sv0ycx2u2wsseuy4yymrg0nmfuxcwq9q0jykq7g5f59vunf95vnmcw336ksrh43fgapsd40u4227ymx56xtudtrte39twnq6fdfdj4p9pgx7pcqdk953za76fqcnvatx2cmywurag7ky4y8ecq5lvf25rydhxg6gmcn6vf78vtsqw79hp3mzv2u4v4jzn0nk50kl4gpv7k60cgz79c6k30jzy8dyetqtwg04tguxkv2p4hqj02yvsz2szaqdn9flu24rhth3v0t33023nwy27gt0x32eqpa5tpz6ygz3yzcsa3w889drpynzd5hlywuk9dwgafuax7upfnnxch4znrx4vactasg32u7vl886pxfswskk7wjgqkggrewtnaecfusl3nmg0xxh8e5nl5eft0xqwj5rk9ajn2j6yxehhgg5k6kpw5pk382hxmpu8wcd3rqx6m8905c7f8v0x2z9gyduxtqp2fdy9w2z4g2rrgu4d5cqes5tnwag007h2f326s3j9p6970xyd73rv5awx27zzezrax467c6vuye62ha88pzhw9xytjpezw3vg3l6x4k9rxwm9f6lwj6j7r9makg59rhgt0355s3jx9vw3raz5qdk5cnpny56q5h3dyd75suskuz63wmmfp9333tx4ry38vnh7jxy0j0cka99y7v2dmyjldjy0mqjetcefsmmg3pw0h9ll0rtskpmxz2cs8vmx6lu4v5rjtzpzgaqt46cwvnmhy5e3ye0tv6sre342lwg0tfd0yjkfz2haqc3hprpqf5ce8c9lx076dnk5cukn3tu38jgprrxt9sk9nqzt8grvkc4qzlg8jjf638v07ej9cf4eu48kphrgyjy83qm822xq8v9k22zwa7txr439x74j2f9ay7frkwtfdwn02enyx8stjpr4wgg25n5tj7uxyx0dqt3hnrqf7dcgt9fqnkjgemjfzyck6pawewptcayxm49sq3477f4cvm2p8fmg27rcmwm5l2vmzvdmymvkrr3aywu04y3zlhs7awu3r9u9lseheqpffvm2xf8y6w2qaj9g22pcu0sdsnqseusrxq9awru5lyqxnzftlslgpe3njegxkze98rveswp3u0xgx69wkg38vgp4k55lwwgv5l7ccv503mh9q23nud4xtm499xq276u40rxyrzaqfyuz2f3v5qr2vq00xs4g3ruynmq0c6nprvjcwqc5zrdn4cnzeeuwumjvqfjdpxr739n4cqcwytc8pjmfcj2qs3l2a8p5fzq7nvtng2jvvklx0x5ypnlkeuegsm587f6d4dkwel2es0lwwt88y2jdg8enjyph02tnjyndlx34h52fngjk96ggtu6vcxqkreqcxs4gwa8ww40t0kzlxfzyfhtjmfdm5fcrr5pt2xm4yslfynr0h9wkranhyadxf33kjn9xpg2fq5hnlq0 -o test.age input stderr 'incompatible' # convert to plugin identity and use plugin exec age-plugin-pq -identity -o key-plugin.txt key.txt age -e -i key.txt -o test.age input age -d -i key-plugin.txt test.age cmp stdout input ! stderr . age -e -i key-plugin.txt -o test.age input age -d -i key.txt test.age cmp stdout input ! stderr . -- input -- test -- key.txt -- # created: 2025-11-17T13:27:37+01:00 # public key: age1pq1044e3hfmq2tltgck54m0gnpv8rfrwkdxjgl38psnwg8zfyv4uqdu63kk0u94ztt0q35k9dzuwgv405kxq6due2sre2kfsjftf7k2vz2mdpetku9pufy9d6ny6k5ss0cghpxdxrux0yd5xy40f8fu8ch9xn2rczyek2pqetqk0l9fqj0e3hfhkyfmcf9j6cpe5mf5stt9cymfq3xm276x4sramhn8srr42g78q9rkmqesevy33p4kdhkuggl99x9zx7j05uflx3s8q558xeaq9q9ctxqx52rzg6yffwykxngvxf7g3n83ddawagq2lnk59kcnexm54jrsmkjk9nemlge9v6p7fxu5z6yvq3ghpet8ww2c3h9fylvjx6j9njwz744376ap5r3xcpzh7qlk0kq3gknzfqhmxmjqypf6xz6geffdmy25apzsfr4ce0x825njkf62mgzx0x9n3zt0490u4dnt4468zse4zvd9sv0ycx2u2wsseuy4yymrg0nmfuxcwq9q0jykq7g5f59vunf95vnmcw336ksrh43fgapsd40u4227ymx56xtudtrte39twnq6fdfdj4p9pgx7pcqdk953za76fqcnvatx2cmywurag7ky4y8ecq5lvf25rydhxg6gmcn6vf78vtsqw79hp3mzv2u4v4jzn0nk50kl4gpv7k60cgz79c6k30jzy8dyetqtwg04tguxkv2p4hqj02yvsz2szaqdn9flu24rhth3v0t33023nwy27gt0x32eqpa5tpz6ygz3yzcsa3w889drpynzd5hlywuk9dwgafuax7upfnnxch4znrx4vactasg32u7vl886pxfswskk7wjgqkggrewtnaecfusl3nmg0xxh8e5nl5eft0xqwj5rk9ajn2j6yxehhgg5k6kpw5pk382hxmpu8wcd3rqx6m8905c7f8v0x2z9gyduxtqp2fdy9w2z4g2rrgu4d5cqes5tnwag007h2f326s3j9p6970xyd73rv5awx27zzezrax467c6vuye62ha88pzhw9xytjpezw3vg3l6x4k9rxwm9f6lwj6j7r9makg59rhgt0355s3jx9vw3raz5qdk5cnpny56q5h3dyd75suskuz63wmmfp9333tx4ry38vnh7jxy0j0cka99y7v2dmyjldjy0mqjetcefsmmg3pw0h9ll0rtskpmxz2cs8vmx6lu4v5rjtzpzgaqt46cwvnmhy5e3ye0tv6sre342lwg0tfd0yjkfz2haqc3hprpqf5ce8c9lx076dnk5cukn3tu38jgprrxt9sk9nqzt8grvkc4qzlg8jjf638v07ej9cf4eu48kphrgyjy83qm822xq8v9k22zwa7txr439x74j2f9ay7frkwtfdwn02enyx8stjpr4wgg25n5tj7uxyx0dqt3hnrqf7dcgt9fqnkjgemjfzyck6pawewptcayxm49sq3477f4cvm2p8fmg27rcmwm5l2vmzvdmymvkrr3aywu04y3zlhs7awu3r9u9lseheqpffvm2xf8y6w2qaj9g22pcu0sdsnqseusrxq9awru5lyqxnzftlslgpe3njegxkze98rveswp3u0xgx69wkg38vgp4k55lwwgv5l7ccv503mh9q23nud4xtm499xq276u40rxyrzaqfyuz2f3v5qr2vq00xs4g3ruynmq0c6nprvjcwqc5zrdn4cnzeeuwumjvqfjdpxr739n4cqcwytc8pjmfcj2qs3l2a8p5fzq7nvtng2jvvklx0x5ypnlkeuegsm587f6d4dkwel2es0lwwt88y2jdg8enjyph02tnjyndlx34h52fngjk96ggtu6vcxqkreqcxs4gwa8ww40t0kzlxfzyfhtjmfdm5fcrr5pt2xm4yslfynr0h9wkranhyadxf33kjn9xpg2fq5hnlq0 AGE-SECRET-KEY-PQ-16XDSLZ3XCSZ3236YJ5J0T9NAPLZTP96LJKQCVHJYUDTQVJR5J5PQTDPQCX ================================================ FILE: cmd/age/testdata/keygen.txt ================================================ exec age-keygen stdout '# created: 20' stdout '# public key: age1' stdout 'AGE-SECRET-KEY-1' stderr 'Public key: age1' exec age-keygen -pq stdout '# created: 20' stdout '# public key: age1pq1' stdout 'AGE-SECRET-KEY-PQ-1' stderr 'Public key: age1pq1' exec age-keygen -pq -o key.txt ! stdout . stderr 'Public key: age1pq1' grep '# created: 20' key.txt grep '# public key: age1pq1' key.txt grep 'AGE-SECRET-KEY-PQ-1' key.txt stdin key.txt exec age-keygen -y stdout age1pq1 exec age-keygen -y key.txt stdout age1pq1 ================================================ FILE: cmd/age/testdata/output_file.txt ================================================ # https://github.com/FiloSottile/age/issues/57 age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o test.age input ! age -o test.out -d -i wrong.txt test.age ! exists test.out ! age -o test.out -d test.age ! exists test.out ! age -o test.out -d -i notexist test.age ! exists test.out ! age -o test.out -d -i wrong.txt notexist ! exists test.out ! age -o test.out -r BAD ! exists test.out ! age -o test.out -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef notexist ! exists test.out ! age -o test.out -p notexist ! exists test.out # https://github.com/FiloSottile/age/issues/555 age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o empty.age empty exists empty.age age -d -i key.txt empty.age ! stdout . ! stderr . age -d -i key.txt -o new empty.age ! stderr . cmp new empty # https://github.com/FiloSottile/age/issues/491 cp input inputcopy ! age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o inputcopy inputcopy stderr 'input and output file are the same' cmp inputcopy input ! age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o ./inputcopy inputcopy stderr 'input and output file are the same' cmp inputcopy input mkdir foo ! age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o inputcopy foo/../inputcopy stderr 'input and output file are the same' cmp inputcopy input cp key.txt keycopy age -e -i keycopy -o test.age input ! age -d -i keycopy -o keycopy test.age stderr 'input and output file are the same' cmp key.txt keycopy [!linux] [!darwin] skip # no pty support [darwin] [go1.20] skip # https://go.dev/issue/61779 ttyin terminal ! age -p -o inputcopy inputcopy stderr 'input and output file are the same' cmp inputcopy input # https://github.com/FiloSottile/age/issues/159 ttyin terminal age -p -a -o test.age input ttyin terminalwrong ! age -o test.out -d test.age ttyout 'Enter passphrase' stderr 'incorrect passphrase' ! exists test.out -- terminal -- password password -- terminalwrong -- wrong -- input -- age -- empty -- -- key.txt -- # created: 2021-02-02T13:09:43+01:00 # public key: age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef AGE-SECRET-KEY-1EGTZVFFV20835NWYV6270LXYVK2VKNX2MMDKWYKLMGR48UAWX40Q2P2LM0 -- wrong.txt -- # created: 2024-06-16T12:14:00+02:00 # public key: age10k7vsqmeg3sp8elfyq5ts55feg4huarpcaf9dmljn9umydg3gymsvx4dp9 AGE-SECRET-KEY-1NPX08S4LELW9K68FKU0U05XXEKG6X7GT004TPNYLF86H3M00D3FQ3VQQNN ================================================ FILE: cmd/age/testdata/pkcs8.txt ================================================ # https://github.com/FiloSottile/age/discussions/428 # encrypt and decrypt a file with an Ed25519 key encoded with PKCS#8 age -e -i key.pem -o test.age input age -d -i key.pem test.age cmp stdout input ! stderr . -- input -- test -- key.pem -- -----BEGIN PRIVATE KEY----- MC4CAQAwBQYDK2VwBCIEIJT4Wpo+YG11yybKL/bYXQW7ekz4PAsmV/4tfmY1vU7x -----END PRIVATE KEY----- ================================================ FILE: cmd/age/testdata/plugin.txt ================================================ # encrypt and decrypt a file with a test plugin age -r age1test10qdmzv9q -o test.age input age -d -i key.txt test.age cmp stdout input ! stderr . # very long identity and recipient age -R long-recipient.txt -o test.age input age -d -i long-key.txt test.age cmp stdout input ! stderr . # check that path separators are rejected chmod 755 age-plugin-pwn/pwn mkdir $TMPDIR/age-plugin-pwn cp age-plugin-pwn/pwn $TMPDIR/age-plugin-pwn/pwn ! age -r age1pwn/pwn19gt89dfz input ! age -d -i pwn-identity.txt test.age ! age -d -j pwn/pwn test.age ! exists pwn # check plugin not found hint ! age -r age1nonexistentplugin1pt5d8z -o test1.age stderr /awesome#plugins ! age -d -i nonexistent-identity.txt test.age stderr /awesome#plugins -- input -- test -- key.txt -- AGE-PLUGIN-TEST-10Q32NLXM -- long-recipient.txt -- age1test10pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7qj6rl8p -- long-key.txt -- AGE-PLUGIN-TEST-10PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7RC0PU8S7Q5U8SUD -- pwn-identity.txt -- AGE-PLUGIN-PWN/PWN-19GYK4WLY -- age-plugin-pwn/pwn -- #!/bin/sh touch "$WORK/pwn" -- nonexistent-identity.txt -- AGE-PLUGIN-NONEXISTENTPLUGIN-1R4XFW4 ================================================ FILE: cmd/age/testdata/rsa.txt ================================================ # encrypt and decrypt a file with -R age -R key.pem.pub -o test.age input age -d -i key.pem test.age cmp stdout input ! stderr . # encrypt and decrypt a file with -i age -e -i key.pem -o test.age input age -d -i key.pem test.age cmp stdout input ! stderr . # encrypt and decrypt a file with the wrong key age -R otherkey.pem.pub -o test.age input ! age -d -i key.pem test.age stderr 'no identity matched any of the recipients' -- input -- test -- key.pem -- -----BEGIN OPENSSH PRIVATE KEY----- b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn NhAAAAAwEAAQAAAYEA1C04rdClHoW4oG4bEGmaNqFy4DLoPJ0358w4XH+XBM3TiWcheouW kUG6m1yDmHk0t0oaaf4hOnetKovdyQQX73gGaq++rSu5VSvH7LbwABoG6PS/UbuZ4Vl9B0 5WVDqHVE9hNK4AHqBc373GU2mo8z5opKxEprmiS3HSd3K2wiMqL5E8XPOSm0p/isuYK57X VUexl73tB7iIMLklxjcjtP4REMoQhHKOMOdy2Q15dw5cYG+drtEArBRYkCZmd0Vp2ws9pj YzPVaOSkbdqSeLu+JVbH1wrwKhuBrA3eVlwjUTWkO4FHcNXkp773Mt4cXhKizTfbR2hQox Lsj31301Xd7dEpV63sqDW1e+a2L2dhemi8cjDMrPuW6Z19Lbti0quAb4+cSLAaJI4BHd1F 8o9XhK7EHVCdIIIQDKVzo1WyEsDwBjL1LB9rpxm4732sZyue0uygFzmM544QX+WsiJXgHP uC1Q/ynjLRm6ZMl16MwvY8B/XGQWxlOAbRJQG84fAAAFmEwAjV1MAI1dAAAAB3NzaC1yc2 EAAAGBANQtOK3QpR6FuKBuGxBpmjahcuAy6DydN+fMOFx/lwTN04lnIXqLlpFBuptcg5h5 NLdKGmn+ITp3rSqL3ckEF+94Bmqvvq0ruVUrx+y28AAaBuj0v1G7meFZfQdOVlQ6h1RPYT SuAB6gXN+9xlNpqPM+aKSsRKa5oktx0ndytsIjKi+RPFzzkptKf4rLmCue11VHsZe97Qe4 iDC5JcY3I7T+ERDKEIRyjjDnctkNeXcOXGBvna7RAKwUWJAmZndFadsLPaY2Mz1WjkpG3a kni7viVWx9cK8CobgawN3lZcI1E1pDuBR3DV5Ke+9zLeHF4Sos0320doUKMS7I99d9NV3e 3RKVet7Kg1tXvmti9nYXpovHIwzKz7lumdfS27YtKrgG+PnEiwGiSOAR3dRfKPV4SuxB1Q nSCCEAylc6NVshLA8AYy9Swfa6cZuO99rGcrntLsoBc5jOeOEF/lrIiV4Bz7gtUP8p4y0Z umTJdejML2PAf1xkFsZTgG0SUBvOHwAAAAMBAAEAAAGBAKytAOu0Wi009sTZ1vzMdMzxJ+ R+ibKK4Oysr1HYJLesKvQwEncBE1C0BYJbEF4OhnCExmpsf+5tZ2iw25a01iX1sIMy9CNK 6lH+h36Gg1wR0n3Ucb+6xck4YyCHCIsT9v8OezW8Riympe8RK07HNtB/gfpCmLx3ZzWvNH Ix0bq9k5+Su2WKdU4cmyACAZ2+b9DfwBCWaUlXTL8abzuZtF2gR5M6X6bq8/2o3zb2WFwk O9nf/JxBTCK/jDQEjG+U9MyGxZIW5DeG1nNFtOzJoT8krIkeSOjQ5XQrkjCw+yihSCWMG+ s+SKO77u30SO7OCENsFIXpUzpt6+JmazlXjLW/OdYNooQMHtqCZzVMRgxiy3gDGF35YvgV VnP5gVEW9HEZ0kD+x4Rl2kB6bV7jMi8BXrazQ1EmTasJFg1pv6iRJWzY1JoP2kRfgiHGL6 OqgrXakqo3hMJuz+JRU2/hlF13743MiIxpcbaaRqURoWuNRLHitVWE35/XVCez0C6OwQAA AMEAoh106+3JbiZI19iRICR247IoOLpSSed98eQj+l3OYfJ86cQipSjxdSPWcP58yyyElY d9q6K16sDTLAlRJzF7MFxSc80JY6RgFq/Sy4Jm0/Z10wwJhTgOkxq6IynzLnO7goRirE31 jxGif4nI2IYEQvv6MOD8TWA4axxGMw2StYB6P4R5peozf81oR6m79ERIDSkrm0RYYn931r gVuxvo3ABVxMtg1lV80LJMayy87Oi8BehGBxMBgsKtQaH8+5h7AAAAwQD+8lJpBcrrHQKk 3o2XAZxB5Fool4f2iuZWTxA1vq0/TCUcEodrdWfLuDeVbDsFemW0vBSkKzf4NlZSs2DAKl YWT6y18eyDyJXn0TNVTeO3F5mkkX5spqbjDcESSs3whIuDqXU++3sII7iMzGw50tDP4Dw6 TViEVM3anpeqlAbkciR5o9IJx3nRcGh81Bs4gticcRF0vqiJoAhNlSZXR1XMjevwt68i+4 RKPPQsTM7uJLm236VUhDivO1OJcBTLW7MAAADBANUNqH+//G4gIruBO3BsIvbzDw0DgRam R1tqqn4g53boiv1RPtUJ2GbkCsisy5pU+JdTN7ekFEF8KWuunjImkfVyAiTFsHHmOoXV3Z EX0mNDXOlKOP2YAIMrDt5CkPdEh6qQG21LCZXTWmwheZ9iN2vOl/fKqUW9lqd/kTe6WsON hIpZhs2+oz54Riq1ZwzO9NkcYrvZoDKbDopL1r2ibw0mkgCJrxpWi0Yt2Iooh4GXXqP5C9 T8hrZCbrVJkjKd5QAAABtmaWxpcHBvQEJpc3Ryb21hdGgtTTEubG9jYWwBAgMEBQY= -----END OPENSSH PRIVATE KEY----- -- key.pem.pub -- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDULTit0KUehbigbhsQaZo2oXLgMug8nTfnzDhcf5cEzdOJZyF6i5aRQbqbXIOYeTS3Shpp/iE6d60qi93JBBfveAZqr76tK7lVK8fstvAAGgbo9L9Ru5nhWX0HTlZUOodUT2E0rgAeoFzfvcZTaajzPmikrESmuaJLcdJ3crbCIyovkTxc85KbSn+Ky5grntdVR7GXve0HuIgwuSXGNyO0/hEQyhCEco4w53LZDXl3Dlxgb52u0QCsFFiQJmZ3RWnbCz2mNjM9Vo5KRt2pJ4u74lVsfXCvAqG4GsDd5WXCNRNaQ7gUdw1eSnvvcy3hxeEqLNN9tHaFCjEuyPfXfTVd3t0SlXreyoNbV75rYvZ2F6aLxyMMys+5bpnX0tu2LSq4Bvj5xIsBokjgEd3UXyj1eErsQdUJ0gghAMpXOjVbISwPAGMvUsH2unGbjvfaxnK57S7KAXOYznjhBf5ayIleAc+4LVD/KeMtGbpkyXXozC9jwH9cZBbGU4BtElAbzh8= -- otherkey.pem.pub -- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDF0OPu95EY25O5KmYFLIkiZZFKUlfvaRgmfIT6OcZvPRXBzo0MS/lcrYvAc0RsUVbZ1B3Y9oWmKt/IMXTztCXiza70rO1NI7ciayv5svY/wGMoveutddhA64IjrQKs4m+6Qmjs/dYTnfsk1BzmXrdRKUSqH6c4Id7pRLC1ySLu+4og3nTTpBRBpg+uSkc4Ua6ce6A6RX14PPJ+TAXMfZyKNyaubQhgzLB/CfdXxZqWdAnyooiE7fb6CEB5uppnA5BpPdcWAkSixbwxRHbRC+OSCqMOV6+z+NlO/qSOKJcXfCQnJP/qjJTJde0dYhXG4RILOzIkGVieGJJONDXvj61mMj568IhJz0AEf/UMhvEL79iJ6yZW82Go/zcYkDDfd3KRE3pW+6p9Onu3XqOiQABS+9rEVRBnqYsPajiHBIanBeXpWKGbjznakvxhdRifhOWwAsQDfLmGzh+JnV1vOUjyxKtLNv9zi/oeuYCaIyF7F6en8LMbYSz8YONMZygGxMU= ================================================ FILE: cmd/age/testdata/scrypt.txt ================================================ [!linux] [!darwin] skip # no pty support [darwin] [go1.20] skip # https://go.dev/issue/61779 # encrypt with a provided passphrase stdin input ttyin terminal age -p -o test.age ttyout 'Enter passphrase' ! stderr . ! stdout . # decrypt with a provided passphrase ttyin terminal age -d test.age ttyout 'Enter passphrase' ! stderr . cmp stdout input # decrypt with the wrong passphrase ttyin wrong ! age -d test.age stderr 'incorrect passphrase' # encrypt with a generated passphrase stdin input ttyin empty age -p -o test.age ! stderr . ! stdout . ttyin autogenerated age -d test.age cmp stdout input # fail when -i is present ttyin terminal ! age -d -i key.txt test.age stderr 'file is passphrase-encrypted but identities were specified' # fail when passphrases don't match ttyin wrong ! age -p -o fail.age stderr 'passphrases didn''t match' ! exists fail.age # fail when -i is missing age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o test.age input ! age -d test.age stderr 'file is not passphrase-encrypted, identities are required' -- terminal -- password password -- wrong -- PASSWORD password -- input -- test -- key.txt -- # created: 2021-02-02T13:09:43+01:00 # public key: age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef AGE-SECRET-KEY-1EGTZVFFV20835NWYV6270LXYVK2VKNX2MMDKWYKLMGR48UAWX40Q2P2LM0 -- autogenerated -- four-four-four-four-four-four-four-four-four-four -- empty -- ================================================ FILE: cmd/age/testdata/terminal.txt ================================================ [!linux] [!darwin] skip # no pty support [darwin] [go1.20] skip # https://go.dev/issue/61779 # controlling terminal is used instead of stdin/stderr ttyin terminal age -p -o test.age input ! stderr . # autogenerated passphrase is printed to terminal ttyin empty age -p -o test.age input ttyout 'autogenerated passphrase' ! stderr . # with no controlling terminal, stdin terminal is used ## TODO: enable once https://golang.org/issue/53601 is fixed ## and Noctty is added to testscript. # noctty # ttyin -stdin terminal # age -p -o test.age input # ! stderr . # no terminal causes an error ## TODO: enable once https://golang.org/issue/53601 is fixed ## and Noctty is added to testscript. # noctty # ! age -p -o test.age input # stderr 'standard input is not a terminal' # prompt for password before plaintext if stdin is the terminal exec cat terminal input # concatenated password + input ttyin -stdin stdout age -p -a -o test.age ttyout 'Enter passphrase' ! stderr . # check the file was encrypted correctly ttyin terminal age -d test.age cmp stdout input # buffer armored ciphertext before prompting if stdin is the terminal ttyin terminal age -p -a -o test.age input exec cat test.age terminal # concatenated ciphertext + password ttyin -stdin stdout age -d ttyout 'Enter passphrase' ! stderr . cmp stdout input -- input -- test -- terminal -- password password -- empty -- ================================================ FILE: cmd/age/testdata/usage.txt ================================================ # -help age -p -help ! stdout . stderr 'Usage:' # -h age -p -h ! stdout . stderr 'Usage:' # unknown flag ! age -p -this-flag-does-not-exist ! stdout . stderr 'flag provided but not defined' stderr 'Usage:' # no arguments ! age ! stdout . stderr 'Usage:' ================================================ FILE: cmd/age/testdata/x25519.txt ================================================ # encrypt and decrypt a file with -r age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o test.age input age -d -i key.txt test.age cmp stdout input ! stderr . # encrypt and decrypt a file with -i age -e -i key.txt -o test.age input age -d -i key.txt test.age cmp stdout input ! stderr . # encrypt and decrypt a file with the wrong key age -r age12phkzssndd5axajas2h74vtge62c86xjhd6u9anyanqhzvdg6sps0xthgl -o test.age input ! age -d -i key.txt test.age stderr 'no identity matched any of the recipients' # decrypt an empty file ! age -d -i key.txt empty stderr empty -- empty -- -- input -- test -- key.txt -- # created: 2021-02-02T13:09:43+01:00 # public key: age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef AGE-SECRET-KEY-1EGTZVFFV20835NWYV6270LXYVK2VKNX2MMDKWYKLMGR48UAWX40Q2P2LM0 ================================================ FILE: cmd/age/tui.go ================================================ // Copyright 2021 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main // This file implements the terminal UI of cmd/age. The rules are: // // - Anything that requires user interaction goes to the terminal, // and is erased afterwards if possible. This UI would be possible // to replace with a pinentry with no output or UX changes. // // - Everything else goes to standard error with an "age:" prefix. // No capitalized initials and no periods at the end. // // The one exception is the autogenerated passphrase, which goes to // the terminal, since we really want it to reach the user only. import ( "bytes" "fmt" "io" "log" "os" "filippo.io/age/armor" "filippo.io/age/internal/term" ) // l is a logger with no prefixes. var l = log.New(os.Stderr, "", 0) func printf(format string, v ...any) { l.Printf("age: "+format, v...) } func errorf(format string, v ...any) { l.Printf("age: error: "+format, v...) l.Printf("age: report unexpected or unhelpful errors at https://filippo.io/age/report") os.Exit(1) } func warningf(format string, v ...any) { l.Printf("age: warning: "+format, v...) } func errorWithHint(error string, hints ...string) { l.Printf("age: error: %s", error) for _, hint := range hints { l.Printf("age: hint: %s", hint) } l.Printf("age: report unexpected or unhelpful errors at https://filippo.io/age/report") os.Exit(1) } func printfToTerminal(format string, v ...any) error { return term.WithTerminal(func(_, out *os.File) error { _, err := fmt.Fprintf(out, "age: "+format+"\n", v...) return err }) } func bufferTerminalInput(in io.Reader) (io.Reader, error) { buf := &bytes.Buffer{} if _, err := buf.ReadFrom(ReaderFunc(func(p []byte) (n int, err error) { if bytes.Contains(buf.Bytes(), []byte(armor.Footer+"\n")) { return 0, io.EOF } return in.Read(p) })); err != nil { return nil, err } return buf, nil } type ReaderFunc func(p []byte) (n int, err error) func (f ReaderFunc) Read(p []byte) (n int, err error) { return f(p) } ================================================ FILE: cmd/age/wordlist.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main import ( "crypto/rand" "encoding/binary" "strings" ) var testOnlyFixedRandomWord string func randomWord() string { if testOnlyFixedRandomWord != "" { return testOnlyFixedRandomWord } buf := make([]byte, 2) if _, err := rand.Read(buf); err != nil { panic(err) } n := binary.BigEndian.Uint16(buf) return wordlist[int(n)%2048] } // wordlist is the BIP39 list of 2048 english words, and it's used to generate // the suggested passphrases. var wordlist = strings.Split(`abandon ability able about above absent absorb abstract absurd abuse access accident account accuse achieve acid acoustic acquire across act action actor actress actual adapt add addict address adjust admit adult advance advice aerobic affair afford afraid again age agent agree ahead aim air airport aisle alarm album alcohol alert alien all alley allow almost alone alpha already also alter always amateur amazing among amount amused analyst anchor ancient anger angle angry animal ankle announce annual another answer antenna antique anxiety any apart apology appear apple approve april arch arctic area arena argue arm armed armor army around arrange arrest arrive arrow art artefact artist artwork ask aspect assault asset assist assume asthma athlete atom attack attend attitude attract auction audit august aunt author auto autumn average avocado avoid awake aware away awesome awful awkward axis baby bachelor bacon badge bag balance balcony ball bamboo banana banner bar barely bargain barrel base basic basket battle beach bean beauty because become beef before begin behave behind believe below belt bench benefit best betray better between beyond bicycle bid bike bind biology bird birth bitter black blade blame blanket blast bleak bless blind blood blossom blouse blue blur blush board boat body boil bomb bone bonus book boost border boring borrow boss bottom bounce box boy bracket brain brand brass brave bread breeze brick bridge brief bright bring brisk broccoli broken bronze broom brother brown brush bubble buddy budget buffalo build bulb bulk bullet bundle bunker burden burger burst bus business busy butter buyer buzz cabbage cabin cable cactus cage cake call calm camera camp can canal cancel candy cannon canoe canvas canyon capable capital captain car carbon card cargo carpet carry cart case cash casino castle casual cat catalog catch category cattle caught cause caution cave ceiling celery cement census century cereal certain chair chalk champion change chaos chapter charge chase chat cheap check cheese chef cherry chest chicken chief child chimney choice choose chronic chuckle chunk churn cigar cinnamon circle citizen city civil claim clap clarify claw clay clean clerk clever click client cliff climb clinic clip clock clog close cloth cloud clown club clump cluster clutch coach coast coconut code coffee coil coin collect color column combine come comfort comic common company concert conduct confirm congress connect consider control convince cook cool copper copy coral core corn correct cost cotton couch country couple course cousin cover coyote crack cradle craft cram crane crash crater crawl crazy cream credit creek crew cricket crime crisp critic crop cross crouch crowd crucial cruel cruise crumble crunch crush cry crystal cube culture cup cupboard curious current curtain curve cushion custom cute cycle dad damage damp dance danger daring dash daughter dawn day deal debate debris decade december decide decline decorate decrease deer defense define defy degree delay deliver demand demise denial dentist deny depart depend deposit depth deputy derive describe desert design desk despair destroy detail detect develop device devote diagram dial diamond diary dice diesel diet differ digital dignity dilemma dinner dinosaur direct dirt disagree discover disease dish dismiss disorder display distance divert divide divorce dizzy doctor document dog doll dolphin domain donate donkey donor door dose double dove draft dragon drama drastic draw dream dress drift drill drink drip drive drop drum dry duck dumb dune during dust dutch duty dwarf dynamic eager eagle early earn earth easily east easy echo ecology economy edge edit educate effort egg eight either elbow elder electric elegant element elephant elevator elite else embark embody embrace emerge emotion employ empower empty enable enact end endless endorse enemy energy enforce engage engine enhance enjoy enlist enough enrich enroll ensure enter entire entry envelope episode equal equip era erase erode erosion error erupt escape essay essence estate eternal ethics evidence evil evoke evolve exact example excess exchange excite exclude excuse execute exercise exhaust exhibit exile exist exit exotic expand expect expire explain expose express extend extra eye eyebrow fabric face faculty fade faint faith fall false fame family famous fan fancy fantasy farm fashion fat fatal father fatigue fault favorite feature february federal fee feed feel female fence festival fetch fever few fiber fiction field figure file film filter final find fine finger finish fire firm first fiscal fish fit fitness fix flag flame flash flat flavor flee flight flip float flock floor flower fluid flush fly foam focus fog foil fold follow food foot force forest forget fork fortune forum forward fossil foster found fox fragile frame frequent fresh friend fringe frog front frost frown frozen fruit fuel fun funny furnace fury future gadget gain galaxy gallery game gap garage garbage garden garlic garment gas gasp gate gather gauge gaze general genius genre gentle genuine gesture ghost giant gift giggle ginger giraffe girl give glad glance glare glass glide glimpse globe gloom glory glove glow glue goat goddess gold good goose gorilla gospel gossip govern gown grab grace grain grant grape grass gravity great green grid grief grit grocery group grow grunt guard guess guide guilt guitar gun gym habit hair half hammer hamster hand happy harbor hard harsh harvest hat have hawk hazard head health heart heavy hedgehog height hello helmet help hen hero hidden high hill hint hip hire history hobby hockey hold hole holiday hollow home honey hood hope horn horror horse hospital host hotel hour hover hub huge human humble humor hundred hungry hunt hurdle hurry hurt husband hybrid ice icon idea identify idle ignore ill illegal illness image imitate immense immune impact impose improve impulse inch include income increase index indicate indoor industry infant inflict inform inhale inherit initial inject injury inmate inner innocent input inquiry insane insect inside inspire install intact interest into invest invite involve iron island isolate issue item ivory jacket jaguar jar jazz jealous jeans jelly jewel job join joke journey joy judge juice jump jungle junior junk just kangaroo keen keep ketchup key kick kid kidney kind kingdom kiss kit kitchen kite kitten kiwi knee knife knock know lab label labor ladder lady lake lamp language laptop large later latin laugh laundry lava law lawn lawsuit layer lazy leader leaf learn leave lecture left leg legal legend leisure lemon lend length lens leopard lesson letter level liar liberty library license life lift light like limb limit link lion liquid list little live lizard load loan lobster local lock logic lonely long loop lottery loud lounge love loyal lucky luggage lumber lunar lunch luxury lyrics machine mad magic magnet maid mail main major make mammal man manage mandate mango mansion manual maple marble march margin marine market marriage mask mass master match material math matrix matter maximum maze meadow mean measure meat mechanic medal media melody melt member memory mention menu mercy merge merit merry mesh message metal method middle midnight milk million mimic mind minimum minor minute miracle mirror misery miss mistake mix mixed mixture mobile model modify mom moment monitor monkey monster month moon moral more morning mosquito mother motion motor mountain mouse move movie much muffin mule multiply muscle museum mushroom music must mutual myself mystery myth naive name napkin narrow nasty nation nature near neck need negative neglect neither nephew nerve nest net network neutral never news next nice night noble noise nominee noodle normal north nose notable note nothing notice novel now nuclear number nurse nut oak obey object oblige obscure observe obtain obvious occur ocean october odor off offer office often oil okay old olive olympic omit once one onion online only open opera opinion oppose option orange orbit orchard order ordinary organ orient original orphan ostrich other outdoor outer output outside oval oven over own owner oxygen oyster ozone pact paddle page pair palace palm panda panel panic panther paper parade parent park parrot party pass patch path patient patrol pattern pause pave payment peace peanut pear peasant pelican pen penalty pencil people pepper perfect permit person pet phone photo phrase physical piano picnic picture piece pig pigeon pill pilot pink pioneer pipe pistol pitch pizza place planet plastic plate play please pledge pluck plug plunge poem poet point polar pole police pond pony pool popular portion position possible post potato pottery poverty powder power practice praise predict prefer prepare present pretty prevent price pride primary print priority prison private prize problem process produce profit program project promote proof property prosper protect proud provide public pudding pull pulp pulse pumpkin punch pupil puppy purchase purity purpose purse push put puzzle pyramid quality quantum quarter question quick quit quiz quote rabbit raccoon race rack radar radio rail rain raise rally ramp ranch random range rapid rare rate rather raven raw razor ready real reason rebel rebuild recall receive recipe record recycle reduce reflect reform refuse region regret regular reject relax release relief rely remain remember remind remove render renew rent reopen repair repeat replace report require rescue resemble resist resource response result retire retreat return reunion reveal review reward rhythm rib ribbon rice rich ride ridge rifle right rigid ring riot ripple risk ritual rival river road roast robot robust rocket romance roof rookie room rose rotate rough round route royal rubber rude rug rule run runway rural sad saddle sadness safe sail salad salmon salon salt salute same sample sand satisfy satoshi sauce sausage save say scale scan scare scatter scene scheme school science scissors scorpion scout scrap screen script scrub sea search season seat second secret section security seed seek segment select sell seminar senior sense sentence series service session settle setup seven shadow shaft shallow share shed shell sheriff shield shift shine ship shiver shock shoe shoot shop short shoulder shove shrimp shrug shuffle shy sibling sick side siege sight sign silent silk silly silver similar simple since sing siren sister situate six size skate sketch ski skill skin skirt skull slab slam sleep slender slice slide slight slim slogan slot slow slush small smart smile smoke smooth snack snake snap sniff snow soap soccer social sock soda soft solar soldier solid solution solve someone song soon sorry sort soul sound soup source south space spare spatial spawn speak special speed spell spend sphere spice spider spike spin spirit split spoil sponsor spoon sport spot spray spread spring spy square squeeze squirrel stable stadium staff stage stairs stamp stand start state stay steak steel stem step stereo stick still sting stock stomach stone stool story stove strategy street strike strong struggle student stuff stumble style subject submit subway success such sudden suffer sugar suggest suit summer sun sunny sunset super supply supreme sure surface surge surprise surround survey suspect sustain swallow swamp swap swarm swear sweet swift swim swing switch sword symbol symptom syrup system table tackle tag tail talent talk tank tape target task taste tattoo taxi teach team tell ten tenant tennis tent term test text thank that theme then theory there they thing this thought three thrive throw thumb thunder ticket tide tiger tilt timber time tiny tip tired tissue title toast tobacco today toddler toe together toilet token tomato tomorrow tone tongue tonight tool tooth top topic topple torch tornado tortoise toss total tourist toward tower town toy track trade traffic tragic train transfer trap trash travel tray treat tree trend trial tribe trick trigger trim trip trophy trouble truck true truly trumpet trust truth try tube tuition tumble tuna tunnel turkey turn turtle twelve twenty twice twin twist two type typical ugly umbrella unable unaware uncle uncover under undo unfair unfold unhappy uniform unique unit universe unknown unlock until unusual unveil update upgrade uphold upon upper upset urban urge usage use used useful useless usual utility vacant vacuum vague valid valley valve van vanish vapor various vast vault vehicle velvet vendor venture venue verb verify version very vessel veteran viable vibrant vicious victory video view village vintage violin virtual virus visa visit visual vital vivid vocal voice void volcano volume vote voyage wage wagon wait walk wall walnut want warfare warm warrior wash wasp waste water wave way wealth weapon wear weasel weather web wedding weekend weird welcome west wet whale what wheat wheel when where whip whisper wide width wife wild will win window wine wing wink winner winter wire wisdom wise wish witness wolf woman wonder wood wool word work world worry worth wrap wreck wrestle wrist write wrong yard year yellow you young youth zebra zero zone zoo`, " ") ================================================ FILE: cmd/age-inspect/inspect.go ================================================ // Copyright 2025 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main import ( "encoding/json" "flag" "fmt" "log" "os" "runtime/debug" "filippo.io/age/internal/inspect" ) const usage = `Usage: age-inspect [--json] [INPUT] Options: --json Output machine-readable JSON. INPUT defaults to standard input. "-" may be used as INPUT to explicitly read from standard input.` // Version can be set at link time to override debug.BuildInfo.Main.Version when // building manually without git history. It should look like "v1.2.3". var Version string func main() { flag.Usage = func() { fmt.Fprintf(os.Stderr, "%s\n", usage) } var ( versionFlag bool jsonFlag bool ) flag.BoolVar(&versionFlag, "version", false, "print the version") flag.BoolVar(&jsonFlag, "json", false, "output machine-readable JSON") flag.Parse() if versionFlag { if buildInfo, ok := debug.ReadBuildInfo(); ok && Version == "" { Version = buildInfo.Main.Version } fmt.Println(Version) return } if flag.NArg() > 1 { flag.Usage() os.Exit(1) } in := os.Stdin var fileSize int64 = -1 if name := flag.Arg(0); name != "" && name != "-" { f, err := os.Open(name) if err != nil { errorf("failed to open input file %q: %v", name, err) } defer f.Close() in = f if stat, err := f.Stat(); err == nil && stat.Mode().IsRegular() { fileSize = stat.Size() } } data, err := inspect.Inspect(in, fileSize) if err != nil { errorf("inspection failed: %v", err) } if jsonFlag { enc := json.NewEncoder(os.Stdout) enc.SetIndent("", " ") if err := enc.Encode(data); err != nil { errorf("failed to encode JSON output: %v", err) } } else { name := flag.Arg(0) if name == "" { name = "" } fmt.Printf("%s is an age file, version %q.\n", name, data.Version) fmt.Printf("\n") if data.Armor { fmt.Printf("This file is ASCII-armored.\n") fmt.Printf("\n") } fmt.Printf("This file is encrypted to the following recipient types:\n") for _, t := range data.StanzaTypes { fmt.Printf(" - %q\n", t) } fmt.Printf("\n") switch data.Postquantum { case "yes": fmt.Printf("This file uses post-quantum encryption.\n") fmt.Printf("\n") case "no": fmt.Printf("This file does NOT use post-quantum encryption.\n") fmt.Printf("\n") } fmt.Printf("Size breakdown (assuming it decrypts successfully):\n") fmt.Printf("\n") fmt.Printf(" Header % 12d bytes\n", data.Sizes.Header) if data.Armor { fmt.Printf(" Armor overhead % 12d bytes\n", data.Sizes.Armor) } fmt.Printf(" Encryption overhead % 12d bytes\n", data.Sizes.Overhead) fmt.Printf(" Payload % 12d bytes\n", data.Sizes.MinPayload) fmt.Printf(" -------------------\n") total := data.Sizes.Header + data.Sizes.Overhead + data.Sizes.MinPayload + data.Sizes.Armor fmt.Printf(" Total % 12d bytes\n", total) fmt.Printf("\n") fmt.Printf("Tip: for machine-readable output, use --json.\n") } } // l is a logger with no prefixes. var l = log.New(os.Stderr, "", 0) func errorf(format string, v ...any) { l.Printf("age-inspect: error: "+format, v...) l.Printf("age-inspect: report unexpected or unhelpful errors at https://filippo.io/age/report") os.Exit(1) } ================================================ FILE: cmd/age-keygen/keygen.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main import ( "flag" "fmt" "io" "log" "os" "runtime/debug" "time" "filippo.io/age" "golang.org/x/term" ) const usage = `Usage: age-keygen [-pq] [-o OUTPUT] age-keygen -y [-o OUTPUT] [INPUT] Options: -pq Generate a post-quantum hybrid ML-KEM-768 + X25519 key pair. (This might become the default in the future.) -o, --output OUTPUT Write the result to the file at path OUTPUT. -y Convert an identity file to a recipients file. age-keygen generates a new native X25519 or, with the -pq flag, post-quantum hybrid ML-KEM-768 + X25519 key pair, and outputs it to standard output or to the OUTPUT file. If an OUTPUT file is specified, the public key is printed to standard error. If OUTPUT already exists, it is not overwritten. In -y mode, age-keygen reads an identity file from INPUT or from standard input and writes the corresponding recipient(s) to OUTPUT or to standard output, one per line, with no comments. Examples: $ age-keygen # created: 2021-01-02T15:30:45+01:00 # public key: age1lvyvwawkr0mcnnnncaghunadrqkmuf9e6507x9y920xxpp866cnql7dp2z AGE-SECRET-KEY-1N9JEPW6DWJ0ZQUDX63F5A03GX8QUW7PXDE39N8UYF82VZ9PC8UFS3M7XA9 $ age-keygen -pq # created: 2025-11-17T12:15:17+01:00 # public key: age1pq1pd[... 1950 more characters ...] AGE-SECRET-KEY-PQ-1XXC4XS9DXHZ6TREKQTT3XECY8VNNU7GJ83C3Y49D0GZ3ZUME4JWS6QC3EF $ age-keygen -o key.txt Public key: age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p $ age-keygen -y key.txt age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p` // Version can be set at link time to override debug.BuildInfo.Main.Version when // building manually without git history. It should look like "v1.2.3". var Version string func main() { log.SetFlags(0) flag.Usage = func() { fmt.Fprintf(os.Stderr, "%s\n", usage) } var outFlag string var pqFlag, versionFlag, convertFlag bool flag.BoolVar(&versionFlag, "version", false, "print the version") flag.BoolVar(&pqFlag, "pq", false, "generate a post-quantum key pair") flag.BoolVar(&convertFlag, "y", false, "convert identities to recipients") flag.StringVar(&outFlag, "o", "", "output to `FILE` (default stdout)") flag.StringVar(&outFlag, "output", "", "output to `FILE` (default stdout)") flag.Parse() if versionFlag { if buildInfo, ok := debug.ReadBuildInfo(); ok && Version == "" { Version = buildInfo.Main.Version } fmt.Println(Version) return } if len(flag.Args()) != 0 && !convertFlag { errorf("too many arguments") } if len(flag.Args()) > 1 && convertFlag { errorf("too many arguments") } if pqFlag && convertFlag { errorf("-pq cannot be used with -y") } out := os.Stdout if outFlag != "" { f, err := os.OpenFile(outFlag, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600) if err != nil { errorf("failed to open output file %q: %v", outFlag, err) } defer func() { if err := f.Close(); err != nil { errorf("failed to close output file %q: %v", outFlag, err) } }() out = f } in := os.Stdin if inFile := flag.Arg(0); inFile != "" && inFile != "-" { f, err := os.Open(inFile) if err != nil { errorf("failed to open input file %q: %v", inFile, err) } defer f.Close() in = f } if convertFlag { convert(in, out) } else { if fi, err := out.Stat(); err == nil && fi.Mode().IsRegular() && fi.Mode().Perm()&0004 != 0 { warning("writing secret key to a world-readable file") } generate(out, pqFlag) } } func generate(out *os.File, pq bool) { var i age.Identity var r age.Recipient if pq { k, err := age.GenerateHybridIdentity() if err != nil { errorf("internal error: %v", err) } i = k r = k.Recipient() } else { k, err := age.GenerateX25519Identity() if err != nil { errorf("internal error: %v", err) } i = k r = k.Recipient() } if !term.IsTerminal(int(out.Fd())) { fmt.Fprintf(os.Stderr, "Public key: %s\n", r) } fmt.Fprintf(out, "# created: %s\n", time.Now().Format(time.RFC3339)) fmt.Fprintf(out, "# public key: %s\n", r) fmt.Fprintf(out, "%s\n", i) } func convert(in io.Reader, out io.Writer) { ids, err := age.ParseIdentities(in) if err != nil { errorf("failed to parse input: %v", err) } if len(ids) == 0 { errorf("no identities found in the input") } for _, id := range ids { switch id := id.(type) { case *age.X25519Identity: fmt.Fprintf(out, "%s\n", id.Recipient()) case *age.HybridIdentity: fmt.Fprintf(out, "%s\n", id.Recipient()) default: errorf("internal error: unexpected identity type: %T", id) } } } func errorf(format string, v ...any) { log.Printf("age-keygen: error: "+format, v...) log.Fatalf("age-keygen: report unexpected or unhelpful errors at https://filippo.io/age/report") } func warning(msg string) { log.Printf("age-keygen: warning: %s", msg) } ================================================ FILE: cmd/age-plugin-batchpass/plugin-batchpass.go ================================================ package main import ( "errors" "flag" "fmt" "io" "log" "os" "runtime/debug" "strconv" "strings" "filippo.io/age" "filippo.io/age/plugin" ) const usage = `age-plugin-batchpass is an age plugin that enables non-interactive passphrase-based encryption and decryption using environment variables. WARNING: IN 90% OF CASES, YOU DON'T NEED THIS PLUGIN. This functionality is not built into the age CLI because most applications should use native keys instead of scripting passphrase-based encryption. Humans are notoriously bad at remembering and generating strong passphrases. age uses scrypt to partially mitigate this, which is necessarily very slow. If a computer will be doing the remembering anyway, you can and should use native keys instead. There is no need to manage separate public and private keys, you encrypt directly to the private key: $ age-keygen -o key.txt $ age -e -i key.txt file.txt > file.txt.age $ age -d -i key.txt file.txt.age > file.txt Likewise, you can store a native identity string in an environment variable or through your CI secrets manager and use it to encrypt and decrypt files non-interactively: $ export AGE_SECRET=$(age-keygen) $ age -e -i <(echo "$AGE_SECRET") file.txt > file.txt.age $ age -d -i <(echo "$AGE_SECRET") file.txt.age > file.txt The age CLI also natively supports passphrase-encrypted identity files, so you can use that functionality to non-interactively encrypt multiple files such that you will be able to decrypt them later by entering the same passphrase: $ age-keygen -pq | age -p -o encrypted-identity.txt Public key: age1pq1cd[... 1950 more characters ...] Enter passphrase (leave empty to autogenerate a secure one): age: using autogenerated passphrase "eternal-erase-keen-suffer-fog-exclude-huge-scorpion-escape-scrub" $ age -r age1pq1cd[... 1950 more characters ...] file.txt > file.txt.age $ age -d -i encrypted-identity.txt file.txt.age > file.txt Enter passphrase for identity file "encrypted-identity.txt": Finally, when using this plugin care should be taken not to let the password be persisted in the shell history or leaked to other users on multi-user systems. Usage: $ AGE_PASSPHRASE=password age -e -j batchpass file.txt > file.txt.age $ AGE_PASSPHRASE=password age -d -j batchpass file.txt.age > file.txt Alternatively, you can use AGE_PASSPHRASE_FD to read the passphrase from a file descriptor. Trailing newlines are stripped from the file contents. When encrypting, you can set AGE_PASSPHRASE_WORK_FACTOR to adjust the scrypt work factor (between 1 and 30, default 18). Higher values are more secure but slower. When decrypting, you can set AGE_PASSPHRASE_MAX_WORK_FACTOR to limit the maximum scrypt work factor accepted (between 1 and 30, default 30). This can be used to avoid very slow decryptions.` // Version can be set at link time to override debug.BuildInfo.Main.Version when // building manually without git history. It should look like "v1.2.3". var Version string func main() { flag.Usage = func() { fmt.Fprintf(os.Stderr, "%s\n", usage) } p, err := plugin.New("batchpass") if err != nil { log.Fatal(err) } p.RegisterFlags(nil) versionFlag := flag.Bool("version", false, "print the version") flag.Parse() if *versionFlag { if buildInfo, ok := debug.ReadBuildInfo(); ok && Version == "" { Version = buildInfo.Main.Version } fmt.Println(Version) return } p.HandleIdentityAsRecipient(func(data []byte) (age.Recipient, error) { if len(data) != 0 { return nil, fmt.Errorf("batchpass identity does not take any payload") } pass, err := passphrase() if err != nil { return nil, err } r, err := age.NewScryptRecipient(pass) if err != nil { return nil, fmt.Errorf("failed to create scrypt recipient: %v", err) } if envWorkFactor := os.Getenv("AGE_PASSPHRASE_WORK_FACTOR"); envWorkFactor != "" { workFactor, err := strconv.Atoi(envWorkFactor) if err != nil { return nil, fmt.Errorf("invalid AGE_PASSPHRASE_WORK_FACTOR: %v", err) } if workFactor > 30 || workFactor < 1 { return nil, fmt.Errorf("AGE_PASSPHRASE_WORK_FACTOR must be between 1 and 30") } r.SetWorkFactor(workFactor) } return r, nil }) p.HandleIdentity(func(data []byte) (age.Identity, error) { if len(data) != 0 { return nil, fmt.Errorf("batchpass identity does not take any payload") } pass, err := passphrase() if err != nil { return nil, err } maxWorkFactor := 0 if envMaxWorkFactor := os.Getenv("AGE_PASSPHRASE_MAX_WORK_FACTOR"); envMaxWorkFactor != "" { maxWorkFactor, err = strconv.Atoi(envMaxWorkFactor) if err != nil { return nil, fmt.Errorf("invalid AGE_PASSPHRASE_MAX_WORK_FACTOR: %v", err) } if maxWorkFactor > 30 || maxWorkFactor < 1 { return nil, fmt.Errorf("AGE_PASSPHRASE_MAX_WORK_FACTOR must be between 1 and 30") } } return &batchpassIdentity{password: pass, maxWorkFactor: maxWorkFactor}, nil }) os.Exit(p.Main()) } type batchpassIdentity struct { password string maxWorkFactor int } func (i *batchpassIdentity) Unwrap(stanzas []*age.Stanza) ([]byte, error) { for _, s := range stanzas { if s.Type == "scrypt" && len(stanzas) != 1 { return nil, errors.New("an scrypt recipient must be the only one") } } if len(stanzas) != 1 || stanzas[0].Type != "scrypt" { // Don't fallback to other identities, this plugin should mostly be used // in isolation, from the CLI. return nil, fmt.Errorf("file is not passphrase-encrypted") } ii, err := age.NewScryptIdentity(i.password) if err != nil { return nil, err } if i.maxWorkFactor != 0 { ii.SetMaxWorkFactor(i.maxWorkFactor) } fileKey, err := ii.Unwrap(stanzas) if errors.Is(err, age.ErrIncorrectIdentity) { // ScryptIdentity returns ErrIncorrectIdentity to make it possible to // try multiple passphrases from the API. If a user is invoking this // plugin, it's safe to say they expect it to be the only mechanism to // decrypt a passphrase-protected file. return nil, fmt.Errorf("incorrect passphrase") } return fileKey, err } func passphrase() (string, error) { envPASSPHRASE := os.Getenv("AGE_PASSPHRASE") envFD := os.Getenv("AGE_PASSPHRASE_FD") if envPASSPHRASE != "" && envFD != "" { return "", fmt.Errorf("AGE_PASSPHRASE and AGE_PASSPHRASE_FD are mutually exclusive") } if envPASSPHRASE == "" && envFD == "" { return "", fmt.Errorf("either AGE_PASSPHRASE or AGE_PASSPHRASE_FD must be set") } if envPASSPHRASE != "" { return envPASSPHRASE, nil } fd, err := strconv.Atoi(envFD) if err != nil { return "", fmt.Errorf("invalid AGE_PASSPHRASE_FD: %v", err) } f := os.NewFile(uintptr(fd), "AGE_PASSPHRASE_FD") if f == nil { return "", fmt.Errorf("failed to open file descriptor %d", fd) } defer f.Close() const maxPassphraseSize = 1024 * 1024 // 1 MiB b, err := io.ReadAll(io.LimitReader(f, maxPassphraseSize+1)) if err != nil { return "", fmt.Errorf("failed to read passphrase from fd %d: %v", fd, err) } if len(b) > maxPassphraseSize { return "", fmt.Errorf("passphrase from fd %d is too long", fd) } return strings.TrimRight(string(b), "\r\n"), nil } ================================================ FILE: doc/age-inspect.1 ================================================ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 .TH "AGE\-INSPECT" "1" "December 2025" "" .SH "NAME" \fBage\-inspect\fR \- inspect age(1) encrypted files .SH "SYNOPSIS" \fBage\-inspect\fR [\fB\-\-json\fR] [\fIINPUT\fR] .SH "DESCRIPTION" \fBage\-inspect\fR reads an age(1) encrypted file from \fIINPUT\fR (or standard input) and displays metadata about it without decrypting\. .P This includes the recipient types, whether it uses post\-quantum encryption, and a size breakdown of the file components\. .SH "OPTIONS" .TP \fB\-\-json\fR Output machine\-readable JSON instead of human\-readable text\. .TP \fB\-\-version\fR Print the version and exit\. .SH "JSON FORMAT" When \fB\-\-json\fR is specified, the output is a JSON object with these fields: .IP "\[ci]" 4 \fBversion\fR: The age format version (e\.g\., \fB"age\-encryption\.org/v1"\fR)\. .IP "\[ci]" 4 \fBpostquantum\fR: Whether the file uses post\-quantum encryption: \fB"yes"\fR, \fB"no"\fR, or \fB"unknown"\fR\. .IP "\[ci]" 4 \fBarmor\fR: Boolean indicating whether the file is ASCII\-armored\. .IP "\[ci]" 4 \fBstanza_types\fR: Array of recipient stanza type strings (e\.g\., \fB["X25519"]\fR or \fB["mlkem768x25519"]\fR)\. .IP "\[ci]" 4 \fBsizes\fR: Object containing size information in bytes: .IP "\[ci]" 4 \fBheader\fR: Size of the age header\. .IP "\[ci]" 4 \fBarmor\fR: Armor encoding overhead (0 if not armored)\. .IP "\[ci]" 4 \fBoverhead\fR: Stream encryption overhead\. .IP "\[ci]" 4 \fBmin_payload\fR, \fBmax_payload\fR: Payload size bounds (currently always matching)\. .IP "\[ci]" 4 \fBmin_padding\fR, \fBmax_padding\fR: Padding size bounds (currently always 0)\. .IP "" 0 .IP The fields add up to the total size of the file\. .IP "" 0 .SH "EXAMPLES" Inspect an encrypted file: .IP "" 4 .nf $ age\-inspect secrets\.age secrets\.age is an age file, version "age\-encryption\.org/v1"\. This file is encrypted to the following recipient types: \- "mlkem768x25519" This file uses post\-quantum encryption\. Size breakdown (assuming it decrypts successfully): Header 1627 bytes Encryption overhead 32 bytes Payload 42 bytes \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Total 1701 bytes Tip: for machine\-readable output, use \-\-json\. .fi .IP "" 0 .P Get JSON output for scripting: .IP "" 4 .nf $ age\-inspect \-\-json secrets\.age { "version": "age\-encryption\.org/v1", "postquantum": "yes", "armor": false, "stanza_types": [ "mlkem768x25519" ], "sizes": { "header": 1627, "armor": 0, "overhead": 32, "min_payload": 42, "max_payload": 42, "min_padding": 0, "max_padding": 0 } } .fi .IP "" 0 .SH "SEE ALSO" age(1), age\-keygen(1) .SH "AUTHORS" Filippo Valsorda \fIage@filippo\.io\fR ================================================ FILE: doc/age-inspect.1.html ================================================ age-inspect(1) - inspect age(1) encrypted files
  1. age-inspect(1)
  3. age-inspect(1)

NAME

age-inspect - inspect age(1) encrypted files

SYNOPSIS

age-inspect [--json] [INPUT]

DESCRIPTION

age-inspect reads an age(1) encrypted file from INPUT (or standard input) and displays metadata about it without decrypting.

This includes the recipient types, whether it uses post-quantum encryption, and a size breakdown of the file components.

OPTIONS

--json
Output machine-readable JSON instead of human-readable text.
--version
Print the version and exit.

JSON FORMAT

When --json is specified, the output is a JSON object with these fields:

  • version: The age format version (e.g., "age-encryption.org/v1").

  • postquantum: Whether the file uses post-quantum encryption: "yes", "no", or "unknown".

  • armor: Boolean indicating whether the file is ASCII-armored.

  • stanza_types: Array of recipient stanza type strings (e.g., ["X25519"] or ["mlkem768x25519"]).

  • sizes: Object containing size information in bytes:

    • header: Size of the age header.
    • armor: Armor encoding overhead (0 if not armored).
    • overhead: Stream encryption overhead.
    • min_payload, max_payload: Payload size bounds (currently always matching).
    • min_padding, max_padding: Padding size bounds (currently always 0).

    The fields add up to the total size of the file.

EXAMPLES

Inspect an encrypted file:

$ age-inspect secrets.age
secrets.age is an age file, version "age-encryption.org/v1".

This file is encrypted to the following recipient types:
- "mlkem768x25519"

This file uses post-quantum encryption.

Size breakdown (assuming it decrypts successfully):

    Header                      1627 bytes
    Encryption overhead           32 bytes
    Payload                       42 bytes
                        -------------------
    Total                       1701 bytes

Tip: for machine-readable output, use --json.

Get JSON output for scripting:

$ age-inspect --json secrets.age
{
    "version": "age-encryption.org/v1",
    "postquantum": "yes",
    "armor": false,
    "stanza_types": [
        "mlkem768x25519"
    ],
    "sizes": {
        "header": 1627,
        "armor": 0,
        "overhead": 32,
        "min_payload": 42,
        "max_payload": 42,
        "min_padding": 0,
        "max_padding": 0
    }
}

SEE ALSO

age(1), age-keygen(1)

AUTHORS

Filippo Valsorda age@filippo.io

  2. December 2025
  3. age-inspect(1)
================================================ FILE: doc/age-inspect.1.ronn ================================================ age-inspect(1) -- inspect age(1) encrypted files ==================================================== ## SYNOPSIS `age-inspect` [`--json`] [] ## DESCRIPTION `age-inspect` reads an age(1) encrypted file from (or standard input) and displays metadata about it without decrypting. This includes the recipient types, whether it uses post-quantum encryption, and a size breakdown of the file components. ## OPTIONS * `--json`: Output machine-readable JSON instead of human-readable text. * `--version`: Print the version and exit. ## JSON FORMAT When `--json` is specified, the output is a JSON object with these fields: * `version`: The age format version (e.g., `"age-encryption.org/v1"`). * `postquantum`: Whether the file uses post-quantum encryption: `"yes"`, `"no"`, or `"unknown"`. * `armor`: Boolean indicating whether the file is ASCII-armored. * `stanza_types`: Array of recipient stanza type strings (e.g., `["X25519"]` or `["mlkem768x25519"]`). * `sizes`: Object containing size information in bytes: * `header`: Size of the age header. * `armor`: Armor encoding overhead (0 if not armored). * `overhead`: Stream encryption overhead. * `min_payload`, `max_payload`: Payload size bounds (currently always matching). * `min_padding`, `max_padding`: Padding size bounds (currently always 0). The fields add up to the total size of the file. ## EXAMPLES Inspect an encrypted file: $ age-inspect secrets.age secrets.age is an age file, version "age-encryption.org/v1". This file is encrypted to the following recipient types: - "mlkem768x25519" This file uses post-quantum encryption. Size breakdown (assuming it decrypts successfully): Header 1627 bytes Encryption overhead 32 bytes Payload 42 bytes ------------------- Total 1701 bytes Tip: for machine-readable output, use --json. Get JSON output for scripting: $ age-inspect --json secrets.age { "version": "age-encryption.org/v1", "postquantum": "yes", "armor": false, "stanza_types": [ "mlkem768x25519" ], "sizes": { "header": 1627, "armor": 0, "overhead": 32, "min_payload": 42, "max_payload": 42, "min_padding": 0, "max_padding": 0 } } ## SEE ALSO age(1), age-keygen(1) ## AUTHORS Filippo Valsorda ================================================ FILE: doc/age-keygen.1 ================================================ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 .TH "AGE\-KEYGEN" "1" "December 2025" "" .SH "NAME" \fBage\-keygen\fR \- generate age(1) key pairs .SH "SYNOPSIS" \fBage\-keygen\fR [\fB\-pq\fR] [\fB\-o\fR \fIOUTPUT\fR] .br \fBage\-keygen\fR \fB\-y\fR [\fB\-o\fR \fIOUTPUT\fR] [\fIINPUT\fR] .br .SH "DESCRIPTION" \fBage\-keygen\fR generates a new native age(1) key pair, and outputs the identity to standard output or to the \fIOUTPUT\fR file\. The output includes the public key and the current time as comments\. .P If the output is not going to a terminal, \fBage\-keygen\fR prints the public key to standard error\. .SH "OPTIONS" .TP \fB\-pq\fR Generate a post\-quantum hybrid ML\-KEM\-768 + X25519 key pair\. .IP In the future, this might become the default\. .TP \fB\-o\fR, \fB\-\-output\fR=\fIOUTPUT\fR Write the identity to \fIOUTPUT\fR instead of standard output\. .IP If \fIOUTPUT\fR already exists, it is not overwritten\. .TP \fB\-y\fR Read an identity file from \fIINPUT\fR or from standard input and output the corresponding recipient(s), one per line, with no comments\. .TP \fB\-\-version\fR Print the version and exit\. .SH "EXAMPLES" Generate a new post\-quantum identity: .IP "" 4 .nf $ age\-keygen \-pq # created: 2025\-11\-17T13:39:06+01:00 # public key: age1pq167[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] AGE\-SECRET\-KEY\-PQ\-1K30MYPZAHAXHR22YHH27EGDVLU0QNSUH3DSV7J7NR3X6D9LHXNWSDLTV4T .fi .IP "" 0 .P Generate a new traditional identity: .IP "" 4 .nf $ age\-keygen # created: 2021\-01\-02T15:30:45+01:00 # public key: age1lvyvwawkr0mcnnnncaghunadrqkmuf9e6507x9y920xxpp866cnql7dp2z AGE\-SECRET\-KEY\-1N9JEPW6DWJ0ZQUDX63F5A03GX8QUW7PXDE39N8UYF82VZ9PC8UFS3M7XA9 .fi .IP "" 0 .P Write a new post\-quantum identity to \fBkey\.txt\fR: .IP "" 4 .nf $ age\-keygen \-pq \-o key\.txt Public key: age1pq1cd[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] .fi .IP "" 0 .P Convert an identity to a recipient: .IP "" 4 .nf $ age\-keygen \-y key\.txt age1pq1cd[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] .fi .IP "" 0 .SH "SEE ALSO" age(1), age\-inspect(1) .SH "AUTHORS" Filippo Valsorda \fIage@filippo\.io\fR ================================================ FILE: doc/age-keygen.1.html ================================================ age-keygen(1) - generate age(1) key pairs
  1. age-keygen(1)
  3. age-keygen(1)

NAME

age-keygen - generate age(1) key pairs

SYNOPSIS

age-keygen [-pq] [-o OUTPUT]
age-keygen -y [-o OUTPUT] [INPUT]

DESCRIPTION

age-keygen generates a new native age(1) key pair, and outputs the identity to standard output or to the OUTPUT file. The output includes the public key and the current time as comments.

If the output is not going to a terminal, age-keygen prints the public key to standard error.

OPTIONS

-pq
Generate a post-quantum hybrid ML-KEM-768 + X25519 key pair.

In the future, this might become the default.

-o, --output=OUTPUT
Write the identity to OUTPUT instead of standard output.

If OUTPUT already exists, it is not overwritten.

-y
Read an identity file from INPUT or from standard input and output the corresponding recipient(s), one per line, with no comments.
--version
Print the version and exit.

EXAMPLES

Generate a new post-quantum identity:

$ age-keygen -pq
# created: 2025-11-17T13:39:06+01:00
# public key: age1pq167[... 1950 more characters ...]
AGE-SECRET-KEY-PQ-1K30MYPZAHAXHR22YHH27EGDVLU0QNSUH3DSV7J7NR3X6D9LHXNWSDLTV4T

Generate a new traditional identity:

$ age-keygen
# created: 2021-01-02T15:30:45+01:00
# public key: age1lvyvwawkr0mcnnnncaghunadrqkmuf9e6507x9y920xxpp866cnql7dp2z
AGE-SECRET-KEY-1N9JEPW6DWJ0ZQUDX63F5A03GX8QUW7PXDE39N8UYF82VZ9PC8UFS3M7XA9

Write a new post-quantum identity to key.txt:

$ age-keygen -pq -o key.txt
Public key: age1pq1cd[... 1950 more characters ...]

Convert an identity to a recipient:

$ age-keygen -y key.txt
age1pq1cd[... 1950 more characters ...]

SEE ALSO

age(1), age-inspect(1)

AUTHORS

Filippo Valsorda age@filippo.io

  2. December 2025
  3. age-keygen(1)
================================================ FILE: doc/age-keygen.1.ronn ================================================ age-keygen(1) -- generate age(1) key pairs ==================================================== ## SYNOPSIS `age-keygen` [`-pq`] [`-o` ]
`age-keygen` `-y` [`-o` ] []
## DESCRIPTION `age-keygen` generates a new native age(1) key pair, and outputs the identity to standard output or to the file. The output includes the public key and the current time as comments. If the output is not going to a terminal, `age-keygen` prints the public key to standard error. ## OPTIONS * `-pq`: Generate a post-quantum hybrid ML-KEM-768 + X25519 key pair. In the future, this might become the default. * `-o`, `--output`=: Write the identity to instead of standard output. If already exists, it is not overwritten. * `-y`: Read an identity file from or from standard input and output the corresponding recipient(s), one per line, with no comments. * `--version`: Print the version and exit. ## EXAMPLES Generate a new post-quantum identity: $ age-keygen -pq # created: 2025-11-17T13:39:06+01:00 # public key: age1pq167[... 1950 more characters ...] AGE-SECRET-KEY-PQ-1K30MYPZAHAXHR22YHH27EGDVLU0QNSUH3DSV7J7NR3X6D9LHXNWSDLTV4T Generate a new traditional identity: $ age-keygen # created: 2021-01-02T15:30:45+01:00 # public key: age1lvyvwawkr0mcnnnncaghunadrqkmuf9e6507x9y920xxpp866cnql7dp2z AGE-SECRET-KEY-1N9JEPW6DWJ0ZQUDX63F5A03GX8QUW7PXDE39N8UYF82VZ9PC8UFS3M7XA9 Write a new post-quantum identity to `key.txt`: $ age-keygen -pq -o key.txt Public key: age1pq1cd[... 1950 more characters ...] Convert an identity to a recipient: $ age-keygen -y key.txt age1pq1cd[... 1950 more characters ...] ## SEE ALSO age(1), age-inspect(1) ## AUTHORS Filippo Valsorda ================================================ FILE: doc/age-plugin-batchpass.1 ================================================ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 .TH "AGE\-PLUGIN\-BATCHPASS" "1" "December 2025" "" .SH "NAME" \fBage\-plugin\-batchpass\fR \- non\-interactive passphrase encryption plugin for age(1) .SH "SYNOPSIS" \fBage\fR \fB\-e\fR \fB\-j\fR \fBbatchpass\fR .br \fBage\fR \fB\-d\fR \fB\-j\fR \fBbatchpass\fR .br .SH "DESCRIPTION" \fBage\-plugin\-batchpass\fR is an age(1) plugin that enables non\-interactive passphrase\-based encryption and decryption using environment variables\. .SH "WARNING" This functionality is not built into the age CLI because most applications should use native keys instead of scripting passphrase\-based encryption\. .P Humans are notoriously bad at remembering and generating strong passphrases\. age uses scrypt to partially mitigate this, which is necessarily very slow\. .P If a computer will be doing the remembering anyway, you can and should use native keys instead\. There is no need to manage separate public and private keys, you encrypt directly to the private key: .IP "" 4 .nf $ age\-keygen \-o key\.txt $ age \-e \-i key\.txt file\.txt > file\.txt\.age $ age \-d \-i key\.txt file\.txt\.age > file\.txt .fi .IP "" 0 .P Likewise, you can store a native identity string in an environment variable or through your CI secrets manager and use it to encrypt and decrypt files non\-interactively: .IP "" 4 .nf $ export AGE_SECRET=$(age\-keygen) $ age \-e \-i <(echo "$AGE_SECRET") file\.txt > file\.txt\.age $ age \-d \-i <(echo "$AGE_SECRET") file\.txt\.age > file\.txt .fi .IP "" 0 .P The age CLI also natively supports passphrase\-encrypted identity files, so you can use that functionality to non\-interactively encrypt multiple files such that you will be able to decrypt them later by entering the same passphrase: .IP "" 4 .nf $ age\-keygen \-pq | age \-p \-o encrypted\-identity\.txt Public key: age1pq1cd[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] Enter passphrase (leave empty to autogenerate a secure one): age: using autogenerated passphrase "eternal\-erase\-keen\-suffer\-fog\-exclude\-huge\-scorpion\-escape\-scrub" $ age \-r age1pq1cd[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] file\.txt > file\.txt\.age $ age \-d \-i encrypted\-identity\.txt file\.txt\.age > file\.txt Enter passphrase for identity file "encrypted\-identity\.txt": .fi .IP "" 0 .P Finally, when using this plugin care should be taken not to let the password be persisted in the shell history or leaked to other users on multi\-user systems\. .SH "ENVIRONMENT" .TP \fBAGE_PASSPHRASE\fR The passphrase to use for encryption or decryption\. Mutually exclusive with \fBAGE_PASSPHRASE_FD\fR\. .TP \fBAGE_PASSPHRASE_FD\fR A file descriptor number to read the passphrase from\. Trailing newlines are stripped from the file contents\. Mutually exclusive with \fBAGE_PASSPHRASE\fR\. .TP \fBAGE_PASSPHRASE_WORK_FACTOR\fR The scrypt work factor to use when encrypting\. Must be between 1 and 30\. Default is 18\. Higher values are more secure but slower\. .TP \fBAGE_PASSPHRASE_MAX_WORK_FACTOR\fR The maximum scrypt work factor to accept when decrypting\. Must be between 1 and 30\. Default is 30\. Can be used to avoid very slow decryptions\. .SH "EXAMPLES" Encrypt a file with a passphrase: .IP "" 4 .nf $ AGE_PASSPHRASE=secret age \-e \-j batchpass file\.txt > file\.txt\.age .fi .IP "" 0 .P Decrypt a file with a passphrase: .IP "" 4 .nf $ AGE_PASSPHRASE=secret age \-d \-j batchpass file\.txt\.age > file\.txt .fi .IP "" 0 .P Read the passphrase from a file descriptor: .IP "" 4 .nf $ AGE_PASSPHRASE_FD=3 age \-e \-j batchpass file\.txt 3< passphrase\.txt > file\.txt\.age .fi .IP "" 0 .SH "SEE ALSO" age(1) .SH "AUTHORS" Filippo Valsorda \fIage@filippo\.io\fR ================================================ FILE: doc/age-plugin-batchpass.1.html ================================================ age-plugin-batchpass(1) - non-interactive passphrase encryption plugin for age(1)
  1. age-plugin-batchpass(1)
  3. age-plugin-batchpass(1)

NAME

age-plugin-batchpass - non-interactive passphrase encryption plugin for age(1)

SYNOPSIS

age -e -j batchpass
age -d -j batchpass

DESCRIPTION

age-plugin-batchpass is an age(1) plugin that enables non-interactive passphrase-based encryption and decryption using environment variables.

WARNING

This functionality is not built into the age CLI because most applications should use native keys instead of scripting passphrase-based encryption.

Humans are notoriously bad at remembering and generating strong passphrases. age uses scrypt to partially mitigate this, which is necessarily very slow.

If a computer will be doing the remembering anyway, you can and should use native keys instead. There is no need to manage separate public and private keys, you encrypt directly to the private key:

$ age-keygen -o key.txt
$ age -e -i key.txt file.txt > file.txt.age
$ age -d -i key.txt file.txt.age > file.txt

Likewise, you can store a native identity string in an environment variable or through your CI secrets manager and use it to encrypt and decrypt files non-interactively:

$ export AGE_SECRET=$(age-keygen)
$ age -e -i <(echo "$AGE_SECRET") file.txt > file.txt.age
$ age -d -i <(echo "$AGE_SECRET") file.txt.age > file.txt

The age CLI also natively supports passphrase-encrypted identity files, so you can use that functionality to non-interactively encrypt multiple files such that you will be able to decrypt them later by entering the same passphrase:

$ age-keygen -pq | age -p -o encrypted-identity.txt
Public key: age1pq1cd[... 1950 more characters ...]
Enter passphrase (leave empty to autogenerate a secure one):
age: using autogenerated passphrase "eternal-erase-keen-suffer-fog-exclude-huge-scorpion-escape-scrub"
$ age -r age1pq1cd[... 1950 more characters ...] file.txt > file.txt.age
$ age -d -i encrypted-identity.txt file.txt.age > file.txt
Enter passphrase for identity file "encrypted-identity.txt":

Finally, when using this plugin care should be taken not to let the password be persisted in the shell history or leaked to other users on multi-user systems.

ENVIRONMENT

AGE_PASSPHRASE
The passphrase to use for encryption or decryption. Mutually exclusive with AGE_PASSPHRASE_FD.
AGE_PASSPHRASE_FD
A file descriptor number to read the passphrase from. Trailing newlines are stripped from the file contents. Mutually exclusive with AGE_PASSPHRASE.
AGE_PASSPHRASE_WORK_FACTOR
The scrypt work factor to use when encrypting. Must be between 1 and 30. Default is 18. Higher values are more secure but slower.
AGE_PASSPHRASE_MAX_WORK_FACTOR
The maximum scrypt work factor to accept when decrypting. Must be between 1 and 30. Default is 30. Can be used to avoid very slow decryptions.

EXAMPLES

Encrypt a file with a passphrase:

$ AGE_PASSPHRASE=secret age -e -j batchpass file.txt > file.txt.age

Decrypt a file with a passphrase:

$ AGE_PASSPHRASE=secret age -d -j batchpass file.txt.age > file.txt

Read the passphrase from a file descriptor:

$ AGE_PASSPHRASE_FD=3 age -e -j batchpass file.txt 3< passphrase.txt > file.txt.age

SEE ALSO

age(1)

AUTHORS

Filippo Valsorda age@filippo.io

  2. December 2025
  3. age-plugin-batchpass(1)
================================================ FILE: doc/age-plugin-batchpass.1.ronn ================================================ age-plugin-batchpass(1) -- non-interactive passphrase encryption plugin for age(1) ================================================================================== ## SYNOPSIS `age` `-e` `-j` `batchpass`
`age` `-d` `-j` `batchpass`
## DESCRIPTION `age-plugin-batchpass` is an age(1) plugin that enables non-interactive passphrase-based encryption and decryption using environment variables. ## WARNING This functionality is not built into the age CLI because most applications should use native keys instead of scripting passphrase-based encryption. Humans are notoriously bad at remembering and generating strong passphrases. age uses scrypt to partially mitigate this, which is necessarily very slow. If a computer will be doing the remembering anyway, you can and should use native keys instead. There is no need to manage separate public and private keys, you encrypt directly to the private key: $ age-keygen -o key.txt $ age -e -i key.txt file.txt > file.txt.age $ age -d -i key.txt file.txt.age > file.txt Likewise, you can store a native identity string in an environment variable or through your CI secrets manager and use it to encrypt and decrypt files non-interactively: $ export AGE_SECRET=$(age-keygen) $ age -e -i <(echo "$AGE_SECRET") file.txt > file.txt.age $ age -d -i <(echo "$AGE_SECRET") file.txt.age > file.txt The age CLI also natively supports passphrase-encrypted identity files, so you can use that functionality to non-interactively encrypt multiple files such that you will be able to decrypt them later by entering the same passphrase: $ age-keygen -pq | age -p -o encrypted-identity.txt Public key: age1pq1cd[... 1950 more characters ...] Enter passphrase (leave empty to autogenerate a secure one): age: using autogenerated passphrase "eternal-erase-keen-suffer-fog-exclude-huge-scorpion-escape-scrub" $ age -r age1pq1cd[... 1950 more characters ...] file.txt > file.txt.age $ age -d -i encrypted-identity.txt file.txt.age > file.txt Enter passphrase for identity file "encrypted-identity.txt": Finally, when using this plugin care should be taken not to let the password be persisted in the shell history or leaked to other users on multi-user systems. ## ENVIRONMENT * `AGE_PASSPHRASE`: The passphrase to use for encryption or decryption. Mutually exclusive with `AGE_PASSPHRASE_FD`. * `AGE_PASSPHRASE_FD`: A file descriptor number to read the passphrase from. Trailing newlines are stripped from the file contents. Mutually exclusive with `AGE_PASSPHRASE`. * `AGE_PASSPHRASE_WORK_FACTOR`: The scrypt work factor to use when encrypting. Must be between 1 and 30. Default is 18. Higher values are more secure but slower. * `AGE_PASSPHRASE_MAX_WORK_FACTOR`: The maximum scrypt work factor to accept when decrypting. Must be between 1 and 30. Default is 30. Can be used to avoid very slow decryptions. ## EXAMPLES Encrypt a file with a passphrase: $ AGE_PASSPHRASE=secret age -e -j batchpass file.txt > file.txt.age Decrypt a file with a passphrase: $ AGE_PASSPHRASE=secret age -d -j batchpass file.txt.age > file.txt Read the passphrase from a file descriptor: $ AGE_PASSPHRASE_FD=3 age -e -j batchpass file.txt 3< passphrase.txt > file.txt.age ## SEE ALSO age(1) ## AUTHORS Filippo Valsorda ================================================ FILE: doc/age.1 ================================================ .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 .TH "AGE" "1" "December 2025" "" .SH "NAME" \fBage\fR \- simple, modern, and secure file encryption .SH "SYNOPSIS" \fBage\fR [\fB\-\-encrypt\fR] (\fB\-r\fR \fIRECIPIENT\fR | \fB\-R\fR \fIPATH\fR)\|\.\|\.\|\. [\fB\-\-armor\fR] [\fB\-o\fR \fIOUTPUT\fR] [\fIINPUT\fR] .br \fBage\fR [\fB\-\-encrypt\fR] \fB\-\-passphrase\fR [\fB\-\-armor\fR] [\fB\-o\fR \fIOUTPUT\fR] [\fIINPUT\fR] .br \fBage\fR \fB\-\-decrypt\fR [\fB\-i\fR \fIPATH\fR | \fB\-j\fR \fIPLUGIN\fR]\|\.\|\.\|\. [\fB\-o\fR \fIOUTPUT\fR] [\fIINPUT\fR] .br .SH "DESCRIPTION" \fBage\fR encrypts or decrypts \fIINPUT\fR to \fIOUTPUT\fR\. The \fIINPUT\fR argument is optional and defaults to standard input\. Only a single \fIINPUT\fR file may be specified\. If \fB\-o\fR is not specified, \fIOUTPUT\fR defaults to standard output\. .P If \fB\-p\fR/\fB\-\-passphrase\fR is specified, the file is encrypted with a passphrase requested interactively\. Otherwise, it's encrypted to one or more \fIRECIPIENTS\fR specified with \fB\-r\fR/\fB\-\-recipient\fR or \fB\-R\fR/\fB\-\-recipients\-file\fR\. Every recipient can decrypt the file\. .P In \fB\-d\fR/\fB\-\-decrypt\fR mode, passphrase\-encrypted files are detected automatically and the passphrase is requested interactively\. Otherwise, one or more \fIIDENTITIES\fR specified with \fB\-i\fR/\fB\-\-identity\fR are used to decrypt the file\. .P \fBage\fR encrypted files are binary and not malleable, with around 200 bytes of overhead per recipient, plus 16 bytes every 64KiB of plaintext\. .SH "OPTIONS" .TP \fB\-o\fR, \fB\-\-output\fR=\fIOUTPUT\fR Write encrypted or decrypted file to \fIOUTPUT\fR instead of standard output\. If \fIOUTPUT\fR already exists it will be overwritten\. .IP If encrypting without \fB\-\-armor\fR, \fBage\fR will refuse to output binary to a TTY\. This can be forced by specifying \fB\-\fR as \fIOUTPUT\fR\. .TP \fB\-\-version\fR Print the version and exit\. .SS "Encryption options" .TP \fB\-e\fR, \fB\-\-encrypt\fR Encrypt \fIINPUT\fR to \fIOUTPUT\fR\. This is the default\. .TP \fB\-r\fR, \fB\-\-recipient\fR=\fIRECIPIENT\fR Encrypt to the explicitly specified \fIRECIPIENT\fR\. See the \fIRECIPIENTS AND IDENTITIES\fR section for possible recipient formats\. .IP This option can be repeated and combined with other recipient flags, and the file can be decrypted by all provided recipients independently\. .TP \fB\-R\fR, \fB\-\-recipients\-file\fR=\fIPATH\fR Encrypt to the \fIRECIPIENTS\fR listed in the file at \fIPATH\fR, one per line\. Empty lines and lines starting with \fB#\fR are ignored as comments\. .IP If \fIPATH\fR is \fB\-\fR, the recipients are read from standard input\. In this case, the \fIINPUT\fR argument must be specified\. .IP This option can be repeated and combined with other recipient flags, and the file can be decrypted by all provided recipients independently\. .TP \fB\-p\fR, \fB\-\-passphrase\fR Encrypt with a passphrase, requested interactively from the terminal\. \fBage\fR will offer to auto\-generate a secure passphrase\. .IP This option can't be used with other recipient flags\. .TP \fB\-a\fR, \fB\-\-armor\fR Encrypt to an ASCII\-only "armored" encoding\. .IP \fBage\fR armor is a strict version of PEM with type \fBAGE ENCRYPTED FILE\fR, canonical "strict" Base64, no headers, and no support for leading and trailing extra data\. .IP Decryption transparently detects and decodes ASCII armoring\. .TP \fB\-i\fR, \fB\-\-identity\fR=\fIPATH\fR Encrypt to the \fIRECIPIENTS\fR corresponding to the \fIIDENTITIES\fR listed in the file at \fIPATH\fR\. This is equivalent to converting the file at \fIPATH\fR to a recipients file with \fBage\-keygen \-y\fR and then passing that to \fB\-R\fR/\fB\-\-recipients\-file\fR\. .IP For the format of \fIPATH\fR, see the definition of \fB\-i\fR/\fB\-\-identity\fR in the \fIDecryption options\fR section\. .IP \fB\-e\fR/\fB\-\-encrypt\fR must be explicitly specified when using \fB\-i\fR/\fB\-\-identity\fR in encryption mode to avoid confusion\. .TP \fB\-j\fR \fIPLUGIN\fR Encrypt using the data\-less \fIplugin\fR \fIPLUGIN\fR\. .IP This is equivalent to using \fB\-i\fR/\fB\-\-identity\fR with a file that contains a single plugin \fBIDENTITY\fR that encodes no plugin\-specific data\. .IP \fB\-e\fR/\fB\-\-encrypt\fR must be explicitly specified when using \fB\-j\fR in encryption mode to avoid confusion\. .SS "Decryption options" .TP \fB\-d\fR, \fB\-\-decrypt\fR Decrypt \fIINPUT\fR to \fIOUTPUT\fR\. .IP If \fIINPUT\fR is passphrase encrypted, it will be automatically detected and the passphrase will be requested interactively\. Otherwise, the \fIIDENTITIES\fR specified with \fB\-i\fR/\fB\-\-identity\fR are used\. .IP ASCII armoring is transparently detected and decoded\. .TP \fB\-i\fR, \fB\-\-identity\fR=\fIPATH\fR Decrypt using the \fIIDENTITIES\fR at \fIPATH\fR\. .IP \fIPATH\fR may be one of the following: .IP a\. A file listing \fIIDENTITIES\fR one per line\. Empty lines and lines starting with "\fB#\fR" are ignored as comments\. .IP b\. A passphrase encrypted age file, containing \fIIDENTITIES\fR one per line like above\. The passphrase is requested interactively\. Note that passphrase\-protected identity files are not necessary for most use cases, where access to the encrypted identity file implies access to the whole system\. .IP c\. An SSH private key file, in PKCS#1, PKCS#8, or OpenSSH format\. If the private key is password\-protected, the password is requested interactively only if the SSH identity matches the file\. See the \fISSH keys\fR section for more information, including supported key types\. .IP d\. "\fB\-\fR", causing one of the options above to be read from standard input\. In this case, the \fIINPUT\fR argument must be specified\. .IP This option can be repeated\. Identities are tried in the order in which are provided, and the first one matching one of the file's recipients is used\. Unused identities are ignored, but it is an error if the \fIINPUT\fR file is passphrase\-encrypted and \fB\-i\fR/\fB\-\-identity\fR is specified\. .TP \fB\-j\fR \fIPLUGIN\fR Decrypt using the data\-less \fIplugin\fR \fIPLUGIN\fR\. .IP This is equivalent to using \fB\-i\fR/\fB\-\-identity\fR with a file that contains a single plugin \fBIDENTITY\fR that encodes no plugin\-specific data\. .SH "RECIPIENTS AND IDENTITIES" \fBRECIPIENTS\fR are public values, like a public key, that a file can be encrypted to\. \fBIDENTITIES\fR are private values, like a private key, that allow decrypting a file encrypted to the corresponding \fBRECIPIENT\fR\. .SS "Native keys" Native \fBage\fR key pairs are generated with age\-keygen(1), and provide small encodings and strong encryption based on X25519 for classic keys, and X25519 + ML\-KEM\-768 for post\-quantum hybrid keys\. The post\-quantum hybrid keys are secure against future quantum computers and are the recommended recipient type for most applications\. .P A hybrid \fBRECIPIENT\fR encoding begins with \fBage1pq1\fR and looks like the following: .IP "" 4 .nf age1pq167[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] .fi .IP "" 0 .P A hybrid \fBIDENTITY\fR encoding begins with \fBAGE\-SECRET\-KEY\-PQ\-1\fR and looks like the following: .IP "" 4 .nf AGE\-SECRET\-KEY\-PQ\-1K30MYPZAHAXHR22YHH27EGDVLU0QNSUH3DSV7J7NR3X6D9LHXNWSDLTV4T .fi .IP "" 0 .P A classic \fBRECIPIENT\fR encoding begins with \fBage1\fR and looks like the following: .IP "" 4 .nf age1gde3ncmahlqd9gg50tanl99r960llztrhfapnmx853s4tjum03uqfssgdh .fi .IP "" 0 .P A classic \fBIDENTITY\fR encoding begins with \fBAGE\-SECRET\-KEY\-1\fR and looks like the following: .IP "" 4 .nf AGE\-SECRET\-KEY\-1KTYK6RVLN5TAPE7VF6FQQSKZ9HWWCDSKUGXXNUQDWZ7XXT5YK5LSF3UTKQ .fi .IP "" 0 .P A file can't be encrypted to both post\-quantum and classic keys, as that would defeat the post\-quantum security of the encryption\. .P An encrypted file can't be linked to the native recipient it's encrypted to without access to the corresponding identity\. .SS "SSH keys" As a convenience feature, \fBage\fR also supports encrypting to RSA or Ed25519 ssh(1) keys\. RSA keys must be at least 2048 bits\. This feature employs more complex cryptography, and should only be used when a native key is not available for the recipient\. Note that SSH keys might not be protected long\-term by the recipient, since they are revokable when used only for authentication\. .P A \fBRECIPIENT\fR encoding is an SSH public key in \fBauthorized_keys\fR format (see the \fBAUTHORIZED_KEYS FILE FORMAT\fR section of sshd(8)), starting with \fBssh\-rsa\fR or \fBssh\-ed25519\fR, like the following: .IP "" 4 .nf ssh\-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDULTit0KUehbi[\|\.\|\.\|\.]GU4BtElAbzh8= ssh\-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIH9pO5pz22JZEas[\|\.\|\.\|\.]l1uZc31FGYMXa .fi .IP "" 0 .P The comment at the end of the line, if present, is ignored\. .P In recipient files passed to \fB\-R\fR/\fB\-\-recipients\-file\fR, unsupported but valid SSH public keys are ignored with a warning, to facilitate using \fBauthorized_keys\fR or GitHub \fB\.keys\fR files\. (See \fIEXAMPLES\fR\.) .P An \fBIDENTITY\fR is an SSH private key \fIfile\fR passed individually to \fB\-i\fR/\fB\-\-identity\fR\. Note that keys held on hardware tokens such as YubiKeys or accessed via ssh\-agent(1) are not supported\. .P An encrypted file \fIcan\fR be linked to the SSH public key it was encrypted to\. This is so that \fBage\fR can identify the correct SSH private key before requesting its password, if any\. .SS "Plugins" \fBage\fR can be extended through plugins\. A plugin is only loaded if a corresponding \fBRECIPIENT\fR or \fBIDENTITY\fR is specified\. (Simply decrypting a file encrypted with a plugin will not cause it to load, for security reasons among others\.) .P A \fBRECIPIENT\fR for a plugin named \fBexample\fR starts with \fBage1example1\fR, while an \fBIDENTITY\fR starts with \fBAGE\-PLUGIN\-EXAMPLE\-1\fR\. They both encode arbitrary plugin\-specific data, and are generated by the plugin\. .P When either is specified, \fBage\fR searches for \fBage\-plugin\-example\fR in the PATH and executes it to perform the file header encryption or decryption\. The plugin may request input from the user through \fBage\fR to complete the operation\. .P Plugins can be freely mixed with other plugins or natively supported keys\. .P A plugin is not bound to only encrypt or decrypt files meant for or generated by the plugin\. For example, a plugin can be used to decrypt files encrypted to a native X25519 \fBRECIPIENT\fR or even with a passphrase\. Similarly, a plugin can encrypt a file such that it can be decrypted without the use of any plugin\. .P Plugins for which the \fBIDENTITY\fR/\fBRECIPIENT\fR distinction doesn't make sense (such as a symmetric encryption plugin) may generate only an \fBIDENTITY\fR and instruct the user to perform encryption with the \fB\-e\fR/\fB\-\-encrypt\fR and \fB\-i\fR/\fB\-\-identity\fR flags\. Plugins for which the concept of separate identities doesn't make sense (such as a password\-encryption plugin) may instruct the user to use the \fB\-j\fR flag\. .P \fBage\fR can natively encrypt to recipients starting with \fBage1tag1\fR (using P\-256 ECDH) or \fBage1tagpq1\fR (using the ML\-KEM\-768 + P\-256 post\-quantum hybrid)\. These are intended to be the public side of private keys held in hardware\. .P They are directly supported to avoid the need to install the plugin, which may be platform\-specific, on the encrypting side\. .P The tag reduces privacy, by allowing an observer to correlate files with a recipient (but not files amongst them without knowledge of the recipient), but this is also a desirable property for hardware keys that require user interaction for each decryption operation\. .SH "EXIT STATUS" \fBage\fR will exit 0 if and only if encryption or decryption are successful for the full length of the input\. .P If an error occurs during decryption, partial output might still be generated, but only if it was possible to securely authenticate it\. No unauthenticated output is ever released\. .SH "BACKWARDS COMPATIBILITY" Files encrypted with a stable version (not alpha, beta, or release candidate) of \fBage\fR, or with any v1\.0\.0 beta or release candidate, will decrypt with any later version of the tool\. .P If decrypting older files poses a security risk, doing so might cause an error by default\. In this case, a flag will be provided to force the operation\. .SH "EXAMPLES" Generate a new post\-quantum identity, encrypt data, and decrypt: .IP "" 4 .nf $ age\-keygen \-pq \-o key\.txt Public key: age1pq167[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] $ tar cvz ~/data | age \-r age1pq167[\|\.\|\.\|\.] > data\.tar\.gz\.age $ age \-d \-o data\.tar\.gz \-i key\.txt data\.tar\.gz\.age .fi .IP "" 0 .P Encrypt \fBexample\.jpg\fR to multiple recipients and output to \fBexample\.jpg\.age\fR: .IP "" 4 .nf $ age \-o example\.jpg\.age \-r age1pq167[\|\.\|\.\|\.] \-r age1pq1e3[\|\.\|\.\|\.] example\.jpg .fi .IP "" 0 .P Encrypt to a list of recipients: .IP "" 4 .nf $ cat > recipients\.txt # Alice age1pq167[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] # Bob age1pq1e3[\|\.\|\.\|\. 1950 more characters \|\.\|\.\|\.] $ age \-R recipients\.txt example\.jpg > example\.jpg\.age .fi .IP "" 0 .P Encrypt and decrypt a file using a passphrase: .IP "" 4 .nf $ age \-p secrets\.txt > secrets\.txt\.age Enter passphrase (leave empty to autogenerate a secure one): Using the autogenerated passphrase "release\-response\-step\-brand\-wrap\-ankle\-pair\-unusual\-sword\-train"\. $ age \-d secrets\.txt\.age > secrets\.txt Enter passphrase: .fi .IP "" 0 .P Encrypt and decrypt with a passphrase\-protected identity file: .IP "" 4 .nf $ age\-keygen | age \-p > key\.age Public key: age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5 Enter passphrase (leave empty to autogenerate a secure one): Using the autogenerated passphrase "hip\-roast\-boring\-snake\-mention\-east\-wasp\-honey\-input\-actress"\. $ age \-r age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5 secrets\.txt > secrets\.txt\.age $ age \-d \-i key\.age secrets\.txt\.age > secrets\.txt Enter passphrase for identity file "key\.age": .fi .IP "" 0 .P Encrypt and decrypt with an SSH public key: .IP "" 4 .nf $ age \-R ~/\.ssh/id_ed25519\.pub example\.jpg > example\.jpg\.age $ age \-d \-i ~/\.ssh/id_ed25519 example\.jpg\.age > example\.jpg .fi .IP "" 0 .P Encrypt and decrypt with age\-plugin\-yubikey: .IP "" 4 .nf $ age\-plugin\-yubikey # run interactive setup, generate identity file and obtain recipient $ age \-r age1yubikey1qwt50d05nh5vutpdzmlg5wn80xq5negm4uj9ghv0snvdd3yysf5yw3rhl3t secrets\.txt > secrets\.txt\.age $ age \-d \-i age\-yubikey\-identity\-388178f3\.txt secrets\.txt\.age .fi .IP "" 0 .P Encrypt to the SSH keys of a GitHub user: .IP "" 4 .nf $ curl https://github\.com/benjojo\.keys | age \-R \- example\.jpg > example\.jpg\.age .fi .IP "" 0 .SH "SEE ALSO" age\-keygen(1), age\-inspect(1) .SH "AUTHORS" Filippo Valsorda \fIage@filippo\.io\fR ================================================ FILE: doc/age.1.html ================================================ age(1) - simple, modern, and secure file encryption
  1. age(1)
  3. age(1)

NAME

age - simple, modern, and secure file encryption

SYNOPSIS

age [--encrypt] (-r RECIPIENT | -R PATH)... [--armor] [-o OUTPUT] [INPUT]
age [--encrypt] --passphrase [--armor] [-o OUTPUT] [INPUT]
age --decrypt [-i PATH | -j PLUGIN]... [-o OUTPUT] [INPUT]

DESCRIPTION

age encrypts or decrypts INPUT to OUTPUT. The INPUT argument is optional and defaults to standard input. Only a single INPUT file may be specified. If -o is not specified, OUTPUT defaults to standard output.

If -p/--passphrase is specified, the file is encrypted with a passphrase requested interactively. Otherwise, it's encrypted to one or more RECIPIENTS specified with -r/--recipient or -R/--recipients-file. Every recipient can decrypt the file.

In -d/--decrypt mode, passphrase-encrypted files are detected automatically and the passphrase is requested interactively. Otherwise, one or more IDENTITIES specified with -i/--identity are used to decrypt the file.

age encrypted files are binary and not malleable, with around 200 bytes of overhead per recipient, plus 16 bytes every 64KiB of plaintext.

OPTIONS

-o, --output=OUTPUT
Write encrypted or decrypted file to OUTPUT instead of standard output. If OUTPUT already exists it will be overwritten.

If encrypting without --armor, age will refuse to output binary to a TTY. This can be forced by specifying - as OUTPUT.

--version
Print the version and exit.

Encryption options

-e, --encrypt
Encrypt INPUT to OUTPUT. This is the default.
-r, --recipient=RECIPIENT
Encrypt to the explicitly specified RECIPIENT. See the RECIPIENTS AND IDENTITIES section for possible recipient formats.

This option can be repeated and combined with other recipient flags, and the file can be decrypted by all provided recipients independently.

-R, --recipients-file=PATH
Encrypt to the RECIPIENTS listed in the file at PATH, one per line. Empty lines and lines starting with # are ignored as comments.

If PATH is -, the recipients are read from standard input. In this case, the INPUT argument must be specified.

This option can be repeated and combined with other recipient flags, and the file can be decrypted by all provided recipients independently.

-p, --passphrase
Encrypt with a passphrase, requested interactively from the terminal. age will offer to auto-generate a secure passphrase.

This option can't be used with other recipient flags.

-a, --armor
Encrypt to an ASCII-only "armored" encoding.

age armor is a strict version of PEM with type AGE ENCRYPTED FILE, canonical "strict" Base64, no headers, and no support for leading and trailing extra data.

Decryption transparently detects and decodes ASCII armoring.

-i, --identity=PATH
Encrypt to the RECIPIENTS corresponding to the IDENTITIES listed in the file at PATH. This is equivalent to converting the file at PATH to a recipients file with age-keygen -y and then passing that to -R/--recipients-file.

For the format of PATH, see the definition of -i/--identity in the Decryption options section.

-e/--encrypt must be explicitly specified when using -i/--identity in encryption mode to avoid confusion.

-j PLUGIN
Encrypt using the data-less plugin PLUGIN.

This is equivalent to using -i/--identity with a file that contains a single plugin IDENTITY that encodes no plugin-specific data.

-e/--encrypt must be explicitly specified when using -j in encryption mode to avoid confusion.

Decryption options

-d, --decrypt
Decrypt INPUT to OUTPUT.

If INPUT is passphrase encrypted, it will be automatically detected and the passphrase will be requested interactively. Otherwise, the IDENTITIES specified with -i/--identity are used.

ASCII armoring is transparently detected and decoded.

-i, --identity=PATH
Decrypt using the IDENTITIES at PATH.

PATH may be one of the following:

a. A file listing IDENTITIES one per line. Empty lines and lines starting with "#" are ignored as comments.

b. A passphrase encrypted age file, containing IDENTITIES one per line like above. The passphrase is requested interactively. Note that passphrase-protected identity files are not necessary for most use cases, where access to the encrypted identity file implies access to the whole system.

c. An SSH private key file, in PKCS#1, PKCS#8, or OpenSSH format. If the private key is password-protected, the password is requested interactively only if the SSH identity matches the file. See the SSH keys section for more information, including supported key types.

d. "-", causing one of the options above to be read from standard input. In this case, the INPUT argument must be specified.

This option can be repeated. Identities are tried in the order in which are provided, and the first one matching one of the file's recipients is used. Unused identities are ignored, but it is an error if the INPUT file is passphrase-encrypted and -i/--identity is specified.

-j PLUGIN
Decrypt using the data-less plugin PLUGIN.

This is equivalent to using -i/--identity with a file that contains a single plugin IDENTITY that encodes no plugin-specific data.

RECIPIENTS AND IDENTITIES

RECIPIENTS are public values, like a public key, that a file can be encrypted to. IDENTITIES are private values, like a private key, that allow decrypting a file encrypted to the corresponding RECIPIENT.

Native keys

Native age key pairs are generated with age-keygen(1), and provide small encodings and strong encryption based on X25519 for classic keys, and X25519 + ML-KEM-768 for post-quantum hybrid keys. The post-quantum hybrid keys are secure against future quantum computers and are the recommended recipient type for most applications.

A hybrid RECIPIENT encoding begins with age1pq1 and looks like the following:

age1pq167[... 1950 more characters ...]

A hybrid IDENTITY encoding begins with AGE-SECRET-KEY-PQ-1 and looks like the following:

AGE-SECRET-KEY-PQ-1K30MYPZAHAXHR22YHH27EGDVLU0QNSUH3DSV7J7NR3X6D9LHXNWSDLTV4T

A classic RECIPIENT encoding begins with age1 and looks like the following:

age1gde3ncmahlqd9gg50tanl99r960llztrhfapnmx853s4tjum03uqfssgdh

A classic IDENTITY encoding begins with AGE-SECRET-KEY-1 and looks like the following:

AGE-SECRET-KEY-1KTYK6RVLN5TAPE7VF6FQQSKZ9HWWCDSKUGXXNUQDWZ7XXT5YK5LSF3UTKQ

A file can't be encrypted to both post-quantum and classic keys, as that would defeat the post-quantum security of the encryption.

An encrypted file can't be linked to the native recipient it's encrypted to without access to the corresponding identity.

SSH keys

As a convenience feature, age also supports encrypting to RSA or Ed25519 ssh(1) keys. RSA keys must be at least 2048 bits. This feature employs more complex cryptography, and should only be used when a native key is not available for the recipient. Note that SSH keys might not be protected long-term by the recipient, since they are revokable when used only for authentication.

A RECIPIENT encoding is an SSH public key in authorized_keys format (see the AUTHORIZED_KEYS FILE FORMAT section of sshd(8)), starting with ssh-rsa or ssh-ed25519, like the following:

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDULTit0KUehbi[...]GU4BtElAbzh8=
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIH9pO5pz22JZEas[...]l1uZc31FGYMXa

The comment at the end of the line, if present, is ignored.

In recipient files passed to -R/--recipients-file, unsupported but valid SSH public keys are ignored with a warning, to facilitate using authorized_keys or GitHub .keys files. (See EXAMPLES.)

An IDENTITY is an SSH private key file passed individually to -i/--identity. Note that keys held on hardware tokens such as YubiKeys or accessed via ssh-agent(1) are not supported.

An encrypted file can be linked to the SSH public key it was encrypted to. This is so that age can identify the correct SSH private key before requesting its password, if any.

Plugins

age can be extended through plugins. A plugin is only loaded if a corresponding RECIPIENT or IDENTITY is specified. (Simply decrypting a file encrypted with a plugin will not cause it to load, for security reasons among others.)

A RECIPIENT for a plugin named example starts with age1example1, while an IDENTITY starts with AGE-PLUGIN-EXAMPLE-1. They both encode arbitrary plugin-specific data, and are generated by the plugin.

When either is specified, age searches for age-plugin-example in the PATH and executes it to perform the file header encryption or decryption. The plugin may request input from the user through age to complete the operation.

Plugins can be freely mixed with other plugins or natively supported keys.

A plugin is not bound to only encrypt or decrypt files meant for or generated by the plugin. For example, a plugin can be used to decrypt files encrypted to a native X25519 RECIPIENT or even with a passphrase. Similarly, a plugin can encrypt a file such that it can be decrypted without the use of any plugin.

Plugins for which the IDENTITY/RECIPIENT distinction doesn't make sense (such as a symmetric encryption plugin) may generate only an IDENTITY and instruct the user to perform encryption with the -e/--encrypt and -i/--identity flags. Plugins for which the concept of separate identities doesn't make sense (such as a password-encryption plugin) may instruct the user to use the -j flag.

Tagged recipients

age can natively encrypt to recipients starting with age1tag1 (using P-256 ECDH) or age1tagpq1 (using the ML-KEM-768 + P-256 post-quantum hybrid). These are intended to be the public side of private keys held in hardware.

They are directly supported to avoid the need to install the plugin, which may be platform-specific, on the encrypting side.

The tag reduces privacy, by allowing an observer to correlate files with a recipient (but not files amongst them without knowledge of the recipient), but this is also a desirable property for hardware keys that require user interaction for each decryption operation.

EXIT STATUS

age will exit 0 if and only if encryption or decryption are successful for the full length of the input.

If an error occurs during decryption, partial output might still be generated, but only if it was possible to securely authenticate it. No unauthenticated output is ever released.

BACKWARDS COMPATIBILITY

Files encrypted with a stable version (not alpha, beta, or release candidate) of age, or with any v1.0.0 beta or release candidate, will decrypt with any later version of the tool.

If decrypting older files poses a security risk, doing so might cause an error by default. In this case, a flag will be provided to force the operation.

EXAMPLES

Generate a new post-quantum identity, encrypt data, and decrypt:

$ age-keygen -pq -o key.txt
Public key: age1pq167[... 1950 more characters ...]

$ tar cvz ~/data | age -r age1pq167[...] > data.tar.gz.age

$ age -d -o data.tar.gz -i key.txt data.tar.gz.age

Encrypt example.jpg to multiple recipients and output to example.jpg.age:

$ age -o example.jpg.age -r age1pq167[...] -r age1pq1e3[...] example.jpg

Encrypt to a list of recipients:

$ cat > recipients.txt
# Alice
age1pq167[... 1950 more characters ...]
# Bob
age1pq1e3[... 1950 more characters ...]

$ age -R recipients.txt example.jpg > example.jpg.age

Encrypt and decrypt a file using a passphrase:

$ age -p secrets.txt > secrets.txt.age
Enter passphrase (leave empty to autogenerate a secure one):
Using the autogenerated passphrase "release-response-step-brand-wrap-ankle-pair-unusual-sword-train".

$ age -d secrets.txt.age > secrets.txt
Enter passphrase:

Encrypt and decrypt with a passphrase-protected identity file:

$ age-keygen | age -p > key.age
Public key: age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5
Enter passphrase (leave empty to autogenerate a secure one):
Using the autogenerated passphrase "hip-roast-boring-snake-mention-east-wasp-honey-input-actress".

$ age -r age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5 secrets.txt > secrets.txt.age

$ age -d -i key.age secrets.txt.age > secrets.txt
Enter passphrase for identity file "key.age":

Encrypt and decrypt with an SSH public key:

$ age -R ~/.ssh/id_ed25519.pub example.jpg > example.jpg.age

$ age -d -i ~/.ssh/id_ed25519 example.jpg.age > example.jpg

Encrypt and decrypt with age-plugin-yubikey:

$ age-plugin-yubikey # run interactive setup, generate identity file and obtain recipient

$ age -r age1yubikey1qwt50d05nh5vutpdzmlg5wn80xq5negm4uj9ghv0snvdd3yysf5yw3rhl3t secrets.txt > secrets.txt.age

$ age -d -i age-yubikey-identity-388178f3.txt secrets.txt.age

Encrypt to the SSH keys of a GitHub user:

$ curl https://github.com/benjojo.keys | age -R - example.jpg > example.jpg.age

SEE ALSO

age-keygen(1), age-inspect(1)

AUTHORS

Filippo Valsorda age@filippo.io

  2. December 2025
  3. age(1)
================================================ FILE: doc/age.1.ronn ================================================ age(1) -- simple, modern, and secure file encryption ==================================================== ## SYNOPSIS `age` [`--encrypt`] (`-r` | `-R` )... [`--armor`] [`-o` ] []
`age` [`--encrypt`] `--passphrase` [`--armor`] [`-o` ] []
`age` `--decrypt` [`-i` | `-j` ]... [`-o` ] []
## DESCRIPTION `age` encrypts or decrypts to . The argument is optional and defaults to standard input. Only a single file may be specified. If `-o` is not specified, defaults to standard output. If `-p`/`--passphrase` is specified, the file is encrypted with a passphrase requested interactively. Otherwise, it's encrypted to one or more [RECIPIENTS][RECIPIENTS AND IDENTITIES] specified with `-r`/`--recipient` or `-R`/`--recipients-file`. Every recipient can decrypt the file. In `-d`/`--decrypt` mode, passphrase-encrypted files are detected automatically and the passphrase is requested interactively. Otherwise, one or more [IDENTITIES][RECIPIENTS AND IDENTITIES] specified with `-i`/`--identity` are used to decrypt the file. `age` encrypted files are binary and not malleable, with around 200 bytes of overhead per recipient, plus 16 bytes every 64KiB of plaintext. ## OPTIONS * `-o`, `--output`=: Write encrypted or decrypted file to instead of standard output. If already exists it will be overwritten. If encrypting without `--armor`, `age` will refuse to output binary to a TTY. This can be forced by specifying `-` as . * `--version`: Print the version and exit. ### Encryption options * `-e`, `--encrypt`: Encrypt to . This is the default. * `-r`, `--recipient`=: Encrypt to the explicitly specified . See the [RECIPIENTS AND IDENTITIES][] section for possible recipient formats. This option can be repeated and combined with other recipient flags, and the file can be decrypted by all provided recipients independently. * `-R`, `--recipients-file`=: Encrypt to the [RECIPIENTS][RECIPIENTS AND IDENTITIES] listed in the file at , one per line. Empty lines and lines starting with `#` are ignored as comments. If is `-`, the recipients are read from standard input. In this case, the argument must be specified. This option can be repeated and combined with other recipient flags, and the file can be decrypted by all provided recipients independently. * `-p`, `--passphrase`: Encrypt with a passphrase, requested interactively from the terminal. `age` will offer to auto-generate a secure passphrase. This option can't be used with other recipient flags. * `-a`, `--armor`: Encrypt to an ASCII-only "armored" encoding. `age` armor is a strict version of PEM with type `AGE ENCRYPTED FILE`, canonical "strict" Base64, no headers, and no support for leading and trailing extra data. Decryption transparently detects and decodes ASCII armoring. * `-i`, `--identity`=: Encrypt to the [RECIPIENTS][RECIPIENTS AND IDENTITIES] corresponding to the [IDENTITIES][RECIPIENTS AND IDENTITIES] listed in the file at . This is equivalent to converting the file at to a recipients file with `age-keygen -y` and then passing that to `-R`/`--recipients-file`. For the format of , see the definition of `-i`/`--identity` in the [Decryption options][] section. `-e`/`--encrypt` must be explicitly specified when using `-i`/`--identity` in encryption mode to avoid confusion. * `-j` : Encrypt using the data-less [plugin][Plugins] . This is equivalent to using `-i`/`--identity` with a file that contains a single plugin `IDENTITY` that encodes no plugin-specific data. `-e`/`--encrypt` must be explicitly specified when using `-j` in encryption mode to avoid confusion. ### Decryption options * `-d`, `--decrypt`: Decrypt to . If is passphrase encrypted, it will be automatically detected and the passphrase will be requested interactively. Otherwise, the [IDENTITIES][RECIPIENTS AND IDENTITIES] specified with `-i`/`--identity` are used. ASCII armoring is transparently detected and decoded. * `-i`, `--identity`=: Decrypt using the [IDENTITIES][RECIPIENTS AND IDENTITIES] at . may be one of the following: a\. A file listing [IDENTITIES][RECIPIENTS AND IDENTITIES] one per line. Empty lines and lines starting with "`#`" are ignored as comments. b\. A passphrase encrypted age file, containing [IDENTITIES][RECIPIENTS AND IDENTITIES] one per line like above. The passphrase is requested interactively. Note that passphrase-protected identity files are not necessary for most use cases, where access to the encrypted identity file implies access to the whole system. c\. An SSH private key file, in PKCS#1, PKCS#8, or OpenSSH format. If the private key is password-protected, the password is requested interactively only if the SSH identity matches the file. See the [SSH keys][] section for more information, including supported key types. d\. "`-`", causing one of the options above to be read from standard input. In this case, the argument must be specified. This option can be repeated. Identities are tried in the order in which are provided, and the first one matching one of the file's recipients is used. Unused identities are ignored, but it is an error if the file is passphrase-encrypted and `-i`/`--identity` is specified. * `-j` : Decrypt using the data-less [plugin][Plugins] . This is equivalent to using `-i`/`--identity` with a file that contains a single plugin `IDENTITY` that encodes no plugin-specific data. ## RECIPIENTS AND IDENTITIES `RECIPIENTS` are public values, like a public key, that a file can be encrypted to. `IDENTITIES` are private values, like a private key, that allow decrypting a file encrypted to the corresponding `RECIPIENT`. ### Native keys Native `age` key pairs are generated with age-keygen(1), and provide small encodings and strong encryption based on X25519 for classic keys, and X25519 + ML-KEM-768 for post-quantum hybrid keys. The post-quantum hybrid keys are secure against future quantum computers and are the recommended recipient type for most applications. A hybrid `RECIPIENT` encoding begins with `age1pq1` and looks like the following: age1pq167[... 1950 more characters ...] A hybrid `IDENTITY` encoding begins with `AGE-SECRET-KEY-PQ-1` and looks like the following: AGE-SECRET-KEY-PQ-1K30MYPZAHAXHR22YHH27EGDVLU0QNSUH3DSV7J7NR3X6D9LHXNWSDLTV4T A classic `RECIPIENT` encoding begins with `age1` and looks like the following: age1gde3ncmahlqd9gg50tanl99r960llztrhfapnmx853s4tjum03uqfssgdh A classic `IDENTITY` encoding begins with `AGE-SECRET-KEY-1` and looks like the following: AGE-SECRET-KEY-1KTYK6RVLN5TAPE7VF6FQQSKZ9HWWCDSKUGXXNUQDWZ7XXT5YK5LSF3UTKQ A file can't be encrypted to both post-quantum and classic keys, as that would defeat the post-quantum security of the encryption. An encrypted file can't be linked to the native recipient it's encrypted to without access to the corresponding identity. ### SSH keys As a convenience feature, `age` also supports encrypting to RSA or Ed25519 ssh(1) keys. RSA keys must be at least 2048 bits. This feature employs more complex cryptography, and should only be used when a native key is not available for the recipient. Note that SSH keys might not be protected long-term by the recipient, since they are revokable when used only for authentication. A `RECIPIENT` encoding is an SSH public key in `authorized_keys` format (see the `AUTHORIZED_KEYS FILE FORMAT` section of sshd(8)), starting with `ssh-rsa` or `ssh-ed25519`, like the following: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDULTit0KUehbi[...]GU4BtElAbzh8= ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIH9pO5pz22JZEas[...]l1uZc31FGYMXa The comment at the end of the line, if present, is ignored. In recipient files passed to `-R`/`--recipients-file`, unsupported but valid SSH public keys are ignored with a warning, to facilitate using `authorized_keys` or GitHub `.keys` files. (See [EXAMPLES][].) An `IDENTITY` is an SSH private key _file_ passed individually to `-i`/`--identity`. Note that keys held on hardware tokens such as YubiKeys or accessed via ssh-agent(1) are not supported. An encrypted file _can_ be linked to the SSH public key it was encrypted to. This is so that `age` can identify the correct SSH private key before requesting its password, if any. ### Plugins `age` can be extended through plugins. A plugin is only loaded if a corresponding `RECIPIENT` or `IDENTITY` is specified. (Simply decrypting a file encrypted with a plugin will not cause it to load, for security reasons among others.) A `RECIPIENT` for a plugin named `example` starts with `age1example1`, while an `IDENTITY` starts with `AGE-PLUGIN-EXAMPLE-1`. They both encode arbitrary plugin-specific data, and are generated by the plugin. When either is specified, `age` searches for `age-plugin-example` in the PATH and executes it to perform the file header encryption or decryption. The plugin may request input from the user through `age` to complete the operation. Plugins can be freely mixed with other plugins or natively supported keys. A plugin is not bound to only encrypt or decrypt files meant for or generated by the plugin. For example, a plugin can be used to decrypt files encrypted to a native X25519 `RECIPIENT` or even with a passphrase. Similarly, a plugin can encrypt a file such that it can be decrypted without the use of any plugin. Plugins for which the `IDENTITY`/`RECIPIENT` distinction doesn't make sense (such as a symmetric encryption plugin) may generate only an `IDENTITY` and instruct the user to perform encryption with the `-e`/`--encrypt` and `-i`/`--identity` flags. Plugins for which the concept of separate identities doesn't make sense (such as a password-encryption plugin) may instruct the user to use the `-j` flag. #### Tagged recipients `age` can natively encrypt to recipients starting with `age1tag1` (using P-256 ECDH) or `age1tagpq1` (using the ML-KEM-768 + P-256 post-quantum hybrid). These are intended to be the public side of private keys held in hardware. They are directly supported to avoid the need to install the plugin, which may be platform-specific, on the encrypting side. The tag reduces privacy, by allowing an observer to correlate files with a recipient (but not files amongst them without knowledge of the recipient), but this is also a desirable property for hardware keys that require user interaction for each decryption operation. ## EXIT STATUS `age` will exit 0 if and only if encryption or decryption are successful for the full length of the input. If an error occurs during decryption, partial output might still be generated, but only if it was possible to securely authenticate it. No unauthenticated output is ever released. ## BACKWARDS COMPATIBILITY Files encrypted with a stable version (not alpha, beta, or release candidate) of `age`, or with any v1.0.0 beta or release candidate, will decrypt with any later version of the tool. If decrypting older files poses a security risk, doing so might cause an error by default. In this case, a flag will be provided to force the operation. ## EXAMPLES Generate a new post-quantum identity, encrypt data, and decrypt: $ age-keygen -pq -o key.txt Public key: age1pq167[... 1950 more characters ...] $ tar cvz ~/data | age -r age1pq167[...] > data.tar.gz.age $ age -d -o data.tar.gz -i key.txt data.tar.gz.age Encrypt `example.jpg` to multiple recipients and output to `example.jpg.age`: $ age -o example.jpg.age -r age1pq167[...] -r age1pq1e3[...] example.jpg Encrypt to a list of recipients: $ cat > recipients.txt # Alice age1pq167[... 1950 more characters ...] # Bob age1pq1e3[... 1950 more characters ...] $ age -R recipients.txt example.jpg > example.jpg.age Encrypt and decrypt a file using a passphrase: $ age -p secrets.txt > secrets.txt.age Enter passphrase (leave empty to autogenerate a secure one): Using the autogenerated passphrase "release-response-step-brand-wrap-ankle-pair-unusual-sword-train". $ age -d secrets.txt.age > secrets.txt Enter passphrase: Encrypt and decrypt with a passphrase-protected identity file: $ age-keygen | age -p > key.age Public key: age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5 Enter passphrase (leave empty to autogenerate a secure one): Using the autogenerated passphrase "hip-roast-boring-snake-mention-east-wasp-honey-input-actress". $ age -r age1yhm4gctwfmrpz87tdslm550wrx6m79y9f2hdzt0lndjnehwj0ukqrjpyx5 secrets.txt > secrets.txt.age $ age -d -i key.age secrets.txt.age > secrets.txt Enter passphrase for identity file "key.age": Encrypt and decrypt with an SSH public key: $ age -R ~/.ssh/id_ed25519.pub example.jpg > example.jpg.age $ age -d -i ~/.ssh/id_ed25519 example.jpg.age > example.jpg Encrypt and decrypt with age-plugin-yubikey: $ age-plugin-yubikey # run interactive setup, generate identity file and obtain recipient $ age -r age1yubikey1qwt50d05nh5vutpdzmlg5wn80xq5negm4uj9ghv0snvdd3yysf5yw3rhl3t secrets.txt > secrets.txt.age $ age -d -i age-yubikey-identity-388178f3.txt secrets.txt.age Encrypt to the SSH keys of a GitHub user: $ curl https://github.com/benjojo.keys | age -R - example.jpg > example.jpg.age ## SEE ALSO age-keygen(1), age-inspect(1) ## AUTHORS Filippo Valsorda ================================================ FILE: extra/age-plugin-pq/plugin-pq.go ================================================ package main import ( "flag" "fmt" "io" "log" "os" "runtime/debug" "filippo.io/age" "filippo.io/age/internal/bech32" "filippo.io/age/plugin" ) const usage = `Usage: age-plugin-pq -identity [-o OUTPUT] [INPUT] Options: -identity Convert one or more native post-quantum identities from INPUT or from standard input to plugin identities. -o, --output OUTPUT Write the result to the file at path OUTPUT instead of standard output. age-plugin-pq is an age plugin for post-quantum hybrid ML-KEM-768 + X25519 recipients and identities. These are supported natively by age v1.3.0 and later, but this plugin can be placed in $PATH to add support to any version and implementation of age that supports plugins. Recipients work out of the box, while identities need to be converted to plugin identities with -identity. If OUTPUT already exists, it is not overwritten.` // Version can be set at link time to override debug.BuildInfo.Main.Version when // building manually without git history. It should look like "v1.2.3". var Version string func main() { log.SetFlags(0) p, err := plugin.New("pq") if err != nil { errorf("failed to create plugin: %v", err) } p.RegisterFlags(nil) flag.Usage = func() { fmt.Fprintf(os.Stderr, "%s\n", usage) } var outFlag string var versionFlag, identityFlag bool flag.BoolVar(&versionFlag, "version", false, "print the version") flag.BoolVar(&identityFlag, "identity", false, "convert identities to plugin identities") flag.StringVar(&outFlag, "o", "", "output to `FILE` (default stdout)") flag.StringVar(&outFlag, "output", "", "output to `FILE` (default stdout)") flag.Parse() if versionFlag { if buildInfo, ok := debug.ReadBuildInfo(); ok && Version == "" { Version = buildInfo.Main.Version } fmt.Println(Version) return } if identityFlag { if len(flag.Args()) > 1 { errorf("too many arguments") } out := os.Stdout if outFlag != "" { f, err := os.OpenFile(outFlag, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600) if err != nil { errorf("failed to open output file %q: %v", outFlag, err) } defer func() { if err := f.Close(); err != nil { errorf("failed to close output file %q: %v", outFlag, err) } }() out = f } if fi, err := out.Stat(); err == nil && fi.Mode().IsRegular() && fi.Mode().Perm()&0004 != 0 { warning("writing secret key to a world-readable file") } in := os.Stdin if inFile := flag.Arg(0); inFile != "" && inFile != "-" { f, err := os.Open(inFile) if err != nil { errorf("failed to open input file %q: %v", inFile, err) } defer f.Close() in = f } convert(in, out) return } p.HandleRecipientEncoding(func(s string) (age.Recipient, error) { return age.ParseHybridRecipient(s) }) p.HandleIdentity(func(data []byte) (age.Identity, error) { // Convert from a AGE-PLUGIN-PQ-1... payload to a // AGE-SECRET-KEY-PQ-1... identity encoding. s, err := bech32.Encode("AGE-SECRET-KEY-PQ-", data) if err != nil { return nil, err } return age.ParseHybridIdentity(s) }) p.HandleIdentityAsRecipient(func(data []byte) (age.Recipient, error) { s, err := bech32.Encode("AGE-SECRET-KEY-PQ-", data) if err != nil { return nil, err } i, err := age.ParseHybridIdentity(s) if err != nil { return nil, err } return i.Recipient(), nil }) os.Exit(p.Main()) } func convert(in io.Reader, out io.Writer) { ids, err := age.ParseIdentities(in) if err != nil { errorf("failed to parse identities: %v", err) } for i, id := range ids { hybridID, ok := id.(*age.HybridIdentity) if !ok { errorf("identity #%d is not a post-quantum hybrid identity", i+1) } _, data, err := bech32.Decode(hybridID.String()) if err != nil { errorf("failed to decode identity #%d: %v", i+1, err) } fmt.Fprintln(out, plugin.EncodeIdentity("pq", data)) } } func errorf(format string, v ...any) { log.Printf("age-plugin-pq: error: "+format, v...) log.Fatalf("age-plugin-pq: report unexpected or unhelpful errors at https://filippo.io/age/report") } func warning(msg string) { log.Printf("age-plugin-pq: warning: %s", msg) } ================================================ FILE: extra/age-plugin-tag/plugin-tag.go ================================================ package main import ( "flag" "fmt" "log" "os" "runtime/debug" "filippo.io/age" "filippo.io/age/plugin" "filippo.io/age/tag" ) const usage = `age-plugin-tag is an age plugin for P-256 tagged recipients. These are supported natively by age v1.3.0 and later, but this plugin can be placed in $PATH to add support to any version and implementation of age that supports plugins. Usually, tagged recipients are the public side of private keys held in hardware, where the identity side is handled by a different plugin.` // Version can be set at link time to override debug.BuildInfo.Main.Version when // building manually without git history. It should look like "v1.2.3". var Version string func main() { flag.Usage = func() { fmt.Fprintf(os.Stderr, "%s\n", usage) } p, err := plugin.New("tag") if err != nil { log.Fatal(err) } p.RegisterFlags(nil) versionFlag := flag.Bool("version", false, "print the version") flag.Parse() if *versionFlag { if buildInfo, ok := debug.ReadBuildInfo(); ok && Version == "" { Version = buildInfo.Main.Version } fmt.Println(Version) return } p.HandleRecipient(func(b []byte) (age.Recipient, error) { return tag.NewClassicRecipient(b) }) os.Exit(p.Main()) } ================================================ FILE: extra/age-plugin-tagpq/plugin-tagpq.go ================================================ package main import ( "flag" "fmt" "log" "os" "runtime/debug" "filippo.io/age" "filippo.io/age/plugin" "filippo.io/age/tag" ) const usage = `age-plugin-tagpq is an age plugin for ML-KEM-768 + P-256 post-quantum hybrid tagged recipients. These are supported natively by age v1.3.0 and later, but this plugin can be placed in $PATH to add support to any version and implementation of age that supports plugins. Usually, tagged recipients are the public side of private keys held in hardware, where the identity side is handled by a different plugin.` // Version can be set at link time to override debug.BuildInfo.Main.Version when // building manually without git history. It should look like "v1.2.3". var Version string func main() { flag.Usage = func() { fmt.Fprintf(os.Stderr, "%s\n", usage) } p, err := plugin.New("tagpq") if err != nil { log.Fatal(err) } p.RegisterFlags(nil) versionFlag := flag.Bool("version", false, "print the version") flag.Parse() if *versionFlag { if buildInfo, ok := debug.ReadBuildInfo(); ok && Version == "" { Version = buildInfo.Main.Version } fmt.Println(Version) return } p.HandleRecipient(func(b []byte) (age.Recipient, error) { return tag.NewHybridRecipient(b) }) os.Exit(p.Main()) } ================================================ FILE: go.mod ================================================ module filippo.io/age go 1.24.0 // Release build version. toolchain go1.25.5 require ( filippo.io/edwards25519 v1.1.0 filippo.io/hpke v0.4.0 filippo.io/nistec v0.0.4 golang.org/x/crypto v0.45.0 golang.org/x/sys v0.38.0 golang.org/x/term v0.37.0 ) // Test dependencies. require ( c2sp.org/CCTV/age v0.0.0-20251208015420-e9274a7bdbfd github.com/rogpeppe/go-internal v1.14.1 golang.org/x/tools v0.39.0 // indirect ) ================================================ FILE: go.sum ================================================ c2sp.org/CCTV/age v0.0.0-20251208015420-e9274a7bdbfd h1:ZLsPO6WdZ5zatV4UfVpr7oAwLGRZ+sebTUruuM4Ra3M= c2sp.org/CCTV/age v0.0.0-20251208015420-e9274a7bdbfd/go.mod h1:SrHC2C7r5GkDk8R+NFVzYy/sdj0Ypg9htaPXQq5Cqeo= filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= filippo.io/hpke v0.4.0 h1:p575VVQ6ted4pL+it6M00V/f2qTZITO0zgmdKCkd5+A= filippo.io/hpke v0.4.0/go.mod h1:EmAN849/P3qdeK+PCMkDpDm83vRHM5cDipBJ8xbQLVY= filippo.io/nistec v0.0.4 h1:F14ZHT5htWlMnQVPndX9ro9arf56cBhQxq4LnDI491s= filippo.io/nistec v0.0.4/go.mod h1:PK/lw8I1gQT4hUML4QGaqljwdDaFcMyFKSXN7kjrtKI= github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q= golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4= golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc= golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= golang.org/x/term v0.37.0 h1:8EGAD0qCmHYZg6J17DvsMy9/wJ7/D/4pV/wfnld5lTU= golang.org/x/term v0.37.0/go.mod h1:5pB4lxRNYYVZuTLmy8oR2BH8dflOR+IbTYFD8fi3254= golang.org/x/tools v0.39.0 h1:ik4ho21kwuQln40uelmciQPp9SipgNDdrafrYA4TmQQ= golang.org/x/tools v0.39.0/go.mod h1:JnefbkDPyD8UU2kI5fuf8ZX4/yUeh9W877ZeBONxUqQ= ================================================ FILE: internal/bech32/bech32.go ================================================ // Copyright (c) 2017 Takatoshi Nakagawa // Copyright (c) 2019 The age Authors // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. // Package bech32 is a modified version of the reference implementation of BIP173. package bech32 import ( "fmt" "strings" ) var charset = "qpzry9x8gf2tvdw0s3jn54khce6mua7l" var generator = []uint32{0x3b6a57b2, 0x26508e6d, 0x1ea119fa, 0x3d4233dd, 0x2a1462b3} func polymod(values []byte) uint32 { chk := uint32(1) for _, v := range values { top := chk >> 25 chk = (chk & 0x1ffffff) << 5 chk = chk ^ uint32(v) for i := range 5 { bit := top >> i & 1 if bit == 1 { chk ^= generator[i] } } } return chk } func hrpExpand(hrp string) []byte { h := []byte(strings.ToLower(hrp)) var ret []byte for _, c := range h { ret = append(ret, c>>5) } ret = append(ret, 0) for _, c := range h { ret = append(ret, c&31) } return ret } func verifyChecksum(hrp string, data []byte) bool { return polymod(append(hrpExpand(hrp), data...)) == 1 } func createChecksum(hrp string, data []byte) []byte { values := append(hrpExpand(hrp), data...) values = append(values, []byte{0, 0, 0, 0, 0, 0}...) mod := polymod(values) ^ 1 ret := make([]byte, 6) for p := range ret { shift := 5 * (5 - p) ret[p] = byte(mod>>shift) & 31 } return ret } func convertBits(data []byte, frombits, tobits byte, pad bool) ([]byte, error) { var ret []byte acc := uint32(0) bits := byte(0) maxv := byte(1<>frombits != 0 { return nil, fmt.Errorf("invalid data range: data[%d]=%d (frombits=%d)", idx, value, frombits) } acc = acc<= tobits { bits -= tobits ret = append(ret, byte(acc>>bits)&maxv) } } if pad { if bits > 0 { ret = append(ret, byte(acc<<(tobits-bits))&maxv) } } else if bits >= frombits { return nil, fmt.Errorf("illegal zero padding") } else if byte(acc<<(tobits-bits))&maxv != 0 { return nil, fmt.Errorf("non-zero padding") } return ret, nil } // Encode encodes the HRP and a bytes slice to Bech32. If the HRP is uppercase, // the output will be uppercase. func Encode(hrp string, data []byte) (string, error) { values, err := convertBits(data, 8, 5, true) if err != nil { return "", err } if len(hrp) < 1 { return "", fmt.Errorf("invalid HRP: %q", hrp) } for p, c := range hrp { if c < 33 || c > 126 { return "", fmt.Errorf("invalid HRP character: hrp[%d]=%d", p, c) } } if strings.ToUpper(hrp) != hrp && strings.ToLower(hrp) != hrp { return "", fmt.Errorf("mixed case HRP: %q", hrp) } lower := strings.ToLower(hrp) == hrp hrp = strings.ToLower(hrp) var ret strings.Builder ret.WriteString(hrp) ret.WriteString("1") for _, p := range values { ret.WriteByte(charset[p]) } for _, p := range createChecksum(hrp, values) { ret.WriteByte(charset[p]) } if lower { return ret.String(), nil } return strings.ToUpper(ret.String()), nil } // Decode decodes a Bech32 string. If the string is uppercase, the HRP will be uppercase. func Decode(s string) (hrp string, data []byte, err error) { if strings.ToLower(s) != s && strings.ToUpper(s) != s { return "", nil, fmt.Errorf("mixed case") } pos := strings.LastIndex(s, "1") if pos < 1 || pos+7 > len(s) { return "", nil, fmt.Errorf("separator '1' at invalid position: pos=%d, len=%d", pos, len(s)) } hrp = s[:pos] for p, c := range hrp { if c < 33 || c > 126 { return "", nil, fmt.Errorf("invalid character human-readable part: s[%d]=%d", p, c) } } s = strings.ToLower(s) for p, c := range s[pos+1:] { d := strings.IndexRune(charset, c) if d == -1 { return "", nil, fmt.Errorf("invalid character data part: s[%d]=%v", p, c) } data = append(data, byte(d)) } if !verifyChecksum(hrp, data) { return "", nil, fmt.Errorf("invalid checksum") } data, err = convertBits(data[:len(data)-6], 5, 8, false) if err != nil { return "", nil, err } return hrp, data, nil } ================================================ FILE: internal/bech32/bech32_test.go ================================================ // Copyright (c) 2013-2017 The btcsuite developers // Copyright (c) 2016-2017 The Lightning Network Developers // Copyright (c) 2019 The age Authors // // Permission to use, copy, modify, and distribute this software for any // purpose with or without fee is hereby granted, provided that the above // copyright notice and this permission notice appear in all copies. // // THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES // WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF // MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR // ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN // ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF // OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. package bech32_test import ( "strings" "testing" "filippo.io/age/internal/bech32" ) func TestBech32(t *testing.T) { tests := []struct { str string valid bool }{ {"A12UEL5L", true}, // empty {"a12uel5l", true}, {"an83characterlonghumanreadablepartthatcontainsthenumber1andtheexcludedcharactersbio1tt5tgs", true}, {"abcdef1qpzry9x8gf2tvdw0s3jn54khce6mua7lmqqqxw", true}, {"11qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqc8247j", true}, {"split1checkupstagehandshakeupstreamerranterredcaperred2y9e3w", true}, // invalid checksum {"split1checkupstagehandshakeupstreamerranterredcaperred2y9e2w", false}, // invalid character (space) in hrp {"s lit1checkupstagehandshakeupstreamerranterredcaperredp8hs2p", false}, {"split1cheo2y9e2w", false}, // invalid character (o) in data part {"split1a2y9w", false}, // too short data part {"1checkupstagehandshakeupstreamerranterredcaperred2y9e3w", false}, // empty hrp // invalid character (DEL) in hrp {"spl" + string(rune(127)) + "t1checkupstagehandshakeupstreamerranterredcaperred2y9e3w", false}, // long vectors that we do accept despite the spec, see Issue 453 {"long10pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7rc0pu8s7qfcsvr0", true}, {"an84characterslonghumanreadablepartthatcontainsthenumber1andtheexcludedcharactersbio1569pvx", true}, // BIP 173 invalid vectors. {"pzry9x0s0muk", false}, {"1pzry9x0s0muk", false}, {"x1b4n0q5v", false}, {"li1dgmt3", false}, {"de1lg7wt\xff", false}, {"A1G7SGD8", false}, {"10a06t8", false}, {"1qzzfhee", false}, } for _, test := range tests { str := test.str hrp, decoded, err := bech32.Decode(str) if !test.valid { // Invalid string decoding should result in error. if err == nil { t.Errorf("expected decoding to fail for invalid string %v", test.str) } continue } // Valid string decoding should result in no error. if err != nil { t.Errorf("expected string to be valid bech32: %v", err) } // Check that it encodes to the same string. encoded, err := bech32.Encode(hrp, decoded) if err != nil { t.Errorf("encoding failed: %v", err) } if encoded != str { t.Errorf("expected data to encode to %v, but got %v", str, encoded) } // Flip a bit in the string an make sure it is caught. pos := strings.LastIndexAny(str, "1") flipped := str[:pos+1] + string((str[pos+1] ^ 1)) + str[pos+2:] if _, _, err = bech32.Decode(flipped); err == nil { t.Error("expected decoding to fail") } } } ================================================ FILE: internal/format/format.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // Package format implements the age file format. package format import ( "bufio" "bytes" "encoding/base64" "errors" "fmt" "io" "strings" ) type Header struct { Recipients []*Stanza MAC []byte } // Stanza is assignable to age.Stanza, and if this package is made public, // age.Stanza can be made a type alias of this type. type Stanza struct { Type string Args []string Body []byte } var b64 = base64.RawStdEncoding.Strict() func DecodeString(s string) ([]byte, error) { // CR and LF are ignored by DecodeString, but we don't want any malleability. if strings.ContainsAny(s, "\n\r") { return nil, errors.New(`unexpected newline character`) } return b64.DecodeString(s) } var EncodeToString = b64.EncodeToString const ColumnsPerLine = 64 const BytesPerLine = ColumnsPerLine / 4 * 3 // NewWrappedBase64Encoder returns a WrappedBase64Encoder that writes to dst. func NewWrappedBase64Encoder(enc *base64.Encoding, dst io.Writer) *WrappedBase64Encoder { w := &WrappedBase64Encoder{dst: dst} w.enc = base64.NewEncoder(enc, WriterFunc(w.writeWrapped)) return w } type WriterFunc func(p []byte) (int, error) func (f WriterFunc) Write(p []byte) (int, error) { return f(p) } // WrappedBase64Encoder is a standard base64 encoder that inserts an LF // character every ColumnsPerLine bytes. It does not insert a newline neither at // the beginning nor at the end of the stream, but it ensures the last line is // shorter than ColumnsPerLine, which means it might be empty. type WrappedBase64Encoder struct { enc io.WriteCloser dst io.Writer written int buf bytes.Buffer } func (w *WrappedBase64Encoder) Write(p []byte) (int, error) { return w.enc.Write(p) } func (w *WrappedBase64Encoder) Close() error { return w.enc.Close() } func (w *WrappedBase64Encoder) writeWrapped(p []byte) (int, error) { if w.buf.Len() != 0 { panic("age: internal error: non-empty WrappedBase64Encoder.buf") } for len(p) > 0 { toWrite := min(ColumnsPerLine-(w.written%ColumnsPerLine), len(p)) n, _ := w.buf.Write(p[:toWrite]) w.written += n p = p[n:] if w.written%ColumnsPerLine == 0 { w.buf.Write([]byte("\n")) } } if _, err := w.buf.WriteTo(w.dst); err != nil { // We always return n = 0 on error because it's hard to work back to the // input length that ended up written out. Not ideal, but Write errors // are not recoverable anyway. return 0, err } return len(p), nil } // LastLineIsEmpty returns whether the last output line was empty, either // because no input was written, or because a multiple of BytesPerLine was. // // Calling LastLineIsEmpty before Close is meaningless. func (w *WrappedBase64Encoder) LastLineIsEmpty() bool { return w.written%ColumnsPerLine == 0 } const intro = "age-encryption.org/v1\n" var stanzaPrefix = []byte("->") var footerPrefix = []byte("---") func (r *Stanza) Marshal(w io.Writer) error { if _, err := w.Write(stanzaPrefix); err != nil { return err } for _, a := range append([]string{r.Type}, r.Args...) { if _, err := io.WriteString(w, " "+a); err != nil { return err } } if _, err := io.WriteString(w, "\n"); err != nil { return err } ww := NewWrappedBase64Encoder(b64, w) if _, err := ww.Write(r.Body); err != nil { return err } if err := ww.Close(); err != nil { return err } _, err := io.WriteString(w, "\n") return err } func (h *Header) MarshalWithoutMAC(w io.Writer) error { if _, err := io.WriteString(w, intro); err != nil { return err } for _, r := range h.Recipients { if err := r.Marshal(w); err != nil { return err } } _, err := fmt.Fprintf(w, "%s", footerPrefix) return err } func (h *Header) Marshal(w io.Writer) error { if err := h.MarshalWithoutMAC(w); err != nil { return err } mac := b64.EncodeToString(h.MAC) _, err := fmt.Fprintf(w, " %s\n", mac) return err } type StanzaReader struct { r *bufio.Reader err error } func NewStanzaReader(r *bufio.Reader) *StanzaReader { return &StanzaReader{r: r} } func (r *StanzaReader) ReadStanza() (s *Stanza, err error) { // Read errors are unrecoverable. if r.err != nil { return nil, r.err } defer func() { r.err = err }() s = &Stanza{} line, err := r.r.ReadBytes('\n') if err != nil { return nil, fmt.Errorf("failed to read line: %w", err) } if !bytes.HasPrefix(line, stanzaPrefix) { return nil, fmt.Errorf("malformed stanza opening line: %q", line) } prefix, args := splitArgs(line) if prefix != string(stanzaPrefix) || len(args) < 1 { return nil, fmt.Errorf("malformed stanza: %q", line) } for _, a := range args { if !isValidString(a) { return nil, fmt.Errorf("malformed stanza: %q", line) } } s.Type = args[0] s.Args = args[1:] for { line, err := r.r.ReadBytes('\n') if err != nil { return nil, fmt.Errorf("failed to read line: %w", err) } b, err := DecodeString(strings.TrimSuffix(string(line), "\n")) if err != nil { if bytes.HasPrefix(line, footerPrefix) || bytes.HasPrefix(line, stanzaPrefix) { return nil, fmt.Errorf("malformed body line %q: stanza ended without a short line\nnote: this might be a file encrypted with an old beta version of age or rage; use age v1.0.0-beta6 or rage to decrypt it", line) } return nil, errorf("malformed body line %q: %v", line, err) } if len(b) > BytesPerLine { return nil, errorf("malformed body line %q: too long", line) } s.Body = append(s.Body, b...) if len(b) < BytesPerLine { // A stanza body always ends with a short line. return s, nil } } } type ParseError struct { err error } func (e *ParseError) Error() string { return "parsing age header: " + e.err.Error() } func (e *ParseError) Unwrap() error { return e.err } func errorf(format string, a ...any) error { return &ParseError{fmt.Errorf(format, a...)} } // Parse returns the header and a Reader that begins at the start of the // payload. func Parse(input io.Reader) (*Header, io.Reader, error) { h := &Header{} rr := bufio.NewReader(input) line, err := rr.ReadString('\n') if err == io.EOF { return nil, nil, errorf("file is empty") } else if err != nil { return nil, nil, errorf("failed to read intro: %w", err) } if line != intro { return nil, nil, errorf("unexpected intro: %q", line) } sr := NewStanzaReader(rr) for { peek, err := rr.Peek(len(footerPrefix)) if err != nil { return nil, nil, errorf("failed to read header: %w", err) } if bytes.Equal(peek, footerPrefix) { line, err := rr.ReadBytes('\n') if err != nil { return nil, nil, fmt.Errorf("failed to read header: %w", err) } prefix, args := splitArgs(line) if prefix != string(footerPrefix) || len(args) != 1 { return nil, nil, errorf("malformed closing line: %q", line) } h.MAC, err = DecodeString(args[0]) if err != nil || len(h.MAC) != 32 { return nil, nil, errorf("malformed closing line %q: %v", line, err) } break } s, err := sr.ReadStanza() if err != nil { return nil, nil, fmt.Errorf("failed to parse header: %w", err) } h.Recipients = append(h.Recipients, s) } // If input is a bufio.Reader, rr might be equal to input because // bufio.NewReader short-circuits. In this case we can just return it (and // we would end up reading the buffer twice if we prepended the peek below). if rr == input { return h, rr, nil } // Otherwise, unwind the bufio overread and return the unbuffered input. buf, err := rr.Peek(rr.Buffered()) if err != nil { return nil, nil, errorf("internal error: %v", err) } payload := io.MultiReader(bytes.NewReader(buf), input) return h, payload, nil } func splitArgs(line []byte) (string, []string) { l := strings.TrimSuffix(string(line), "\n") parts := strings.Split(l, " ") return parts[0], parts[1:] } func isValidString(s string) bool { if len(s) == 0 { return false } for _, c := range s { if c < 33 || c > 126 { return false } } return true } ================================================ FILE: internal/format/format_test.go ================================================ // Copyright 2021 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. //go:build go1.18 package format_test import ( "bytes" "io" "os" "path/filepath" "testing" "filippo.io/age/internal/format" ) func TestStanzaMarshal(t *testing.T) { s := &format.Stanza{ Type: "test", Args: []string{"1", "2", "3"}, Body: nil, // empty } buf := &bytes.Buffer{} s.Marshal(buf) if exp := "-> test 1 2 3\n\n"; buf.String() != exp { t.Errorf("wrong empty stanza encoding: expected %q, got %q", exp, buf.String()) } buf.Reset() s.Body = []byte("AAA") s.Marshal(buf) if exp := "-> test 1 2 3\nQUFB\n"; buf.String() != exp { t.Errorf("wrong normal stanza encoding: expected %q, got %q", exp, buf.String()) } buf.Reset() s.Body = bytes.Repeat([]byte("A"), format.BytesPerLine) s.Marshal(buf) if exp := "-> test 1 2 3\nQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFB\n\n"; buf.String() != exp { t.Errorf("wrong 64 columns stanza encoding: expected %q, got %q", exp, buf.String()) } } func FuzzMalleability(f *testing.F) { tests, err := filepath.Glob("../../testdata/testkit/*") if err != nil { f.Fatal(err) } for _, test := range tests { contents, err := os.ReadFile(test) if err != nil { f.Fatal(err) } _, contents, ok := bytes.Cut(contents, []byte("\n\n")) if !ok { f.Fatal("testkit file without header") } f.Add(contents) } f.Fuzz(func(t *testing.T, data []byte) { h, payload, err := format.Parse(bytes.NewReader(data)) if err != nil { if h != nil { t.Error("h != nil on error") } if payload != nil { t.Error("payload != nil on error") } t.Skip() } w := &bytes.Buffer{} if err := h.Marshal(w); err != nil { t.Fatal(err) } if _, err := io.Copy(w, payload); err != nil { t.Fatal(err) } if !bytes.Equal(w.Bytes(), data) { t.Error("Marshal output different from input") } }) } ================================================ FILE: internal/inspect/inspect.go ================================================ package inspect import ( "bufio" "bytes" "fmt" "io" "strings" "filippo.io/age/armor" "filippo.io/age/internal/format" "filippo.io/age/internal/stream" ) type Metadata struct { Version string `json:"version"` Postquantum string `json:"postquantum"` // "yes" or "no" or "unknown" Armor bool `json:"armor"` StanzaTypes []string `json:"stanza_types"` Sizes struct { Header int64 `json:"header"` Armor int64 `json:"armor"` Overhead int64 `json:"overhead"` // Currently, we don't do any padding, not MinPayload == MaxPayload and // MinPadding == MaxPadding == 0, but that might change in the future. MinPayload int64 `json:"min_payload"` MaxPayload int64 `json:"max_payload"` MinPadding int64 `json:"min_padding"` MaxPadding int64 `json:"max_padding"` } `json:"sizes"` } func Inspect(r io.Reader, fileSize int64) (*Metadata, error) { data := &Metadata{ Version: "age-encryption.org/v1", Postquantum: "unknown", } tr := &trackReader{r: r} br := bufio.NewReader(tr) const maxWhitespace = 1024 start, _ := br.Peek(maxWhitespace + len(armor.Header)) if strings.HasPrefix(string(bytes.TrimSpace(start)), armor.Header) { r = armor.NewReader(br) data.Armor = true } else { r = br } hdr, rest, err := format.Parse(r) if err != nil { return nil, fmt.Errorf("failed to read header: %w", err) } buf := &bytes.Buffer{} if err := hdr.Marshal(buf); err != nil { return nil, fmt.Errorf("failed to re-serialize header: %w", err) } data.Sizes.Header = int64(buf.Len()) for _, s := range hdr.Recipients { data.StanzaTypes = append(data.StanzaTypes, s.Type) switch s.Type { case "X25519", "ssh-rsa", "ssh-ed25519", "age-encryption.org/p256tag", "piv-p256": data.Postquantum = "no" case "mlkem768x25519", "scrypt", "age-encryption.org/mlkem768p256tag": if data.Postquantum != "no" { data.Postquantum = "yes" } } } // If fileSize is not provided, or if it's the size of the armored file // (which can have LF or CRLF line endings, varying its size), read to // the end to determine it. if fileSize == -1 || data.Armor { n, err := io.Copy(io.Discard, rest) if err != nil { return nil, fmt.Errorf("failed to read rest of file: %w", err) } fileSize = data.Sizes.Header + n if !tr.done { panic("trackReader not done after io.Copy") } if tr.count != fileSize && !data.Armor { panic("trackReader count mismatch") } data.Sizes.Armor = tr.count - fileSize } data.Sizes.Overhead, err = streamOverhead(fileSize - data.Sizes.Header) if err != nil { return nil, fmt.Errorf("failed to compute stream overhead: %w", err) } data.Sizes.MinPayload = fileSize - data.Sizes.Header - data.Sizes.Overhead data.Sizes.MaxPayload = data.Sizes.MinPayload return data, nil } type trackReader struct { r io.Reader count int64 done bool } func (tr *trackReader) Read(p []byte) (int, error) { n, err := tr.r.Read(p) tr.count += int64(n) if err == io.EOF { tr.done = true } else if tr.done { panic("non-EOF read after EOF") } return n, err } func streamOverhead(payloadSize int64) (int64, error) { const streamNonceSize = 16 if payloadSize < streamNonceSize { return 0, fmt.Errorf("encrypted size too small: %d", payloadSize) } encryptedSize := payloadSize - streamNonceSize plaintextSize, err := stream.PlaintextSize(encryptedSize) if err != nil { return 0, err } return payloadSize - plaintextSize, nil } ================================================ FILE: internal/inspect/inspect_test.go ================================================ package inspect import ( "fmt" "testing" "filippo.io/age/internal/stream" ) func TestStreamOverhead(t *testing.T) { tests := []struct { payloadSize int64 want int64 wantErr bool }{ {payloadSize: 0, wantErr: true}, {payloadSize: 15, wantErr: true}, {payloadSize: 16, wantErr: true}, {payloadSize: 16 + 15, wantErr: true}, {payloadSize: 16 + 16, want: 16 + 16}, // empty plaintext {payloadSize: 16 + 1 + 16, want: 16 + 16}, {payloadSize: 16 + stream.ChunkSize + 16, want: 16 + 16}, {payloadSize: 16 + stream.ChunkSize + 16 + 1, wantErr: true}, {payloadSize: 16 + stream.ChunkSize + 16 + 15, wantErr: true}, {payloadSize: 16 + stream.ChunkSize + 16 + 16, wantErr: true}, // empty final chunk {payloadSize: 16 + stream.ChunkSize + 16 + 1 + 16, want: 16 + 16 + 16}, } for _, tt := range tests { name := "payloadSize=" + fmt.Sprint(tt.payloadSize) t.Run(name, func(t *testing.T) { got, gotErr := streamOverhead(tt.payloadSize) if gotErr != nil { if !tt.wantErr { t.Errorf("streamOverhead() failed: %v", gotErr) } return } if tt.wantErr { t.Fatal("streamOverhead() succeeded unexpectedly") } if got != tt.want { t.Errorf("streamOverhead() = %v, want %v", got, tt.want) } }) } } ================================================ FILE: internal/stream/stream.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // Package stream implements a variant of the STREAM chunked encryption scheme. package stream import ( "bytes" "crypto/cipher" "encoding/binary" "errors" "fmt" "io" "sync/atomic" "golang.org/x/crypto/chacha20poly1305" ) const ChunkSize = 64 * 1024 func EncryptedChunkCount(encryptedSize int64) (int64, error) { chunks := (encryptedSize + encChunkSize - 1) / encChunkSize plaintextSize := encryptedSize - chunks*chacha20poly1305.Overhead expChunks := (plaintextSize + ChunkSize - 1) / ChunkSize // Empty plaintext, the only case that allows (and requires) an empty chunk. if plaintextSize == 0 { expChunks = 1 } if expChunks != chunks { return 0, fmt.Errorf("invalid encrypted payload size: %d", encryptedSize) } return chunks, nil } func PlaintextSize(encryptedSize int64) (int64, error) { chunks, err := EncryptedChunkCount(encryptedSize) if err != nil { return 0, err } plaintextSize := encryptedSize - chunks*chacha20poly1305.Overhead return plaintextSize, nil } type DecryptReader struct { a cipher.AEAD src io.Reader unread []byte // decrypted but unread data, backed by buf buf [encChunkSize]byte err error nonce [chacha20poly1305.NonceSize]byte } const ( encChunkSize = ChunkSize + chacha20poly1305.Overhead lastChunkFlag = 0x01 ) func NewDecryptReader(key []byte, src io.Reader) (*DecryptReader, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } return &DecryptReader{a: aead, src: src}, nil } func (r *DecryptReader) Read(p []byte) (int, error) { if len(r.unread) > 0 { n := copy(p, r.unread) r.unread = r.unread[n:] return n, nil } if r.err != nil { return 0, r.err } if len(p) == 0 { return 0, nil } last, err := r.readChunk() if err != nil { r.err = err return 0, err } n := copy(p, r.unread) r.unread = r.unread[n:] if last { // Ensure there is an EOF after the last chunk as expected. In other // words, check for trailing data after a full-length final chunk. // Hopefully, the underlying reader supports returning EOF even if it // had previously returned an EOF to ReadFull. if _, err := r.src.Read(make([]byte, 1)); err == nil { r.err = errors.New("trailing data after end of encrypted file") } else if err != io.EOF { r.err = fmt.Errorf("non-EOF error reading after end of encrypted file: %w", err) } else { r.err = io.EOF } } return n, nil } // readChunk reads the next chunk of ciphertext from r.src and makes it available // in r.unread. last is true if the chunk was marked as the end of the message. // readChunk must not be called again after returning a last chunk or an error. func (r *DecryptReader) readChunk() (last bool, err error) { if len(r.unread) != 0 { panic("stream: internal error: readChunk called with dirty buffer") } in := r.buf[:] n, err := io.ReadFull(r.src, in) switch { case err == io.EOF: // A message can't end without a marked chunk. This message is truncated. return false, io.ErrUnexpectedEOF case err == io.ErrUnexpectedEOF: // The last chunk can be short, but not empty unless it's the first and // only chunk. if !nonceIsZero(&r.nonce) && n == r.a.Overhead() { return false, errors.New("last chunk is empty, try age v1.0.0, and please consider reporting this") } in = in[:n] last = true setLastChunkFlag(&r.nonce) case err != nil: return false, err } outBuf := make([]byte, 0, ChunkSize) out, err := r.a.Open(outBuf, r.nonce[:], in, nil) if err != nil && !last { // Check if this was a full-length final chunk. last = true setLastChunkFlag(&r.nonce) out, err = r.a.Open(outBuf, r.nonce[:], in, nil) } if err != nil { return false, errors.New("failed to decrypt and authenticate payload chunk, file may be corrupted or tampered with") } incNonce(&r.nonce) r.unread = r.buf[:copy(r.buf[:], out)] return last, nil } func incNonce(nonce *[chacha20poly1305.NonceSize]byte) { for i := len(nonce) - 2; i >= 0; i-- { nonce[i]++ if nonce[i] != 0 { return } } // The counter is 88 bits, this is unreachable. panic("stream: chunk counter wrapped around") } func nonceForChunk(chunkIndex int64) *[chacha20poly1305.NonceSize]byte { var nonce [chacha20poly1305.NonceSize]byte binary.BigEndian.PutUint64(nonce[3:11], uint64(chunkIndex)) return &nonce } func setLastChunkFlag(nonce *[chacha20poly1305.NonceSize]byte) { nonce[len(nonce)-1] = lastChunkFlag } func nonceIsZero(nonce *[chacha20poly1305.NonceSize]byte) bool { return *nonce == [chacha20poly1305.NonceSize]byte{} } type EncryptWriter struct { a cipher.AEAD dst io.Writer buf bytes.Buffer nonce [chacha20poly1305.NonceSize]byte err error } func NewEncryptWriter(key []byte, dst io.Writer) (*EncryptWriter, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } return &EncryptWriter{a: aead, dst: dst}, nil } func (w *EncryptWriter) Write(p []byte) (n int, err error) { if w.err != nil { return 0, w.err } if len(p) == 0 { return 0, nil } total := len(p) for len(p) > 0 { n := min(len(p), ChunkSize-w.buf.Len()) w.buf.Write(p[:n]) p = p[n:] // Only flush if there's a full chunk with bytes still to write, or we // can't know if this is the last chunk yet. if w.buf.Len() == ChunkSize && len(p) > 0 { if err := w.flushChunk(notLastChunk); err != nil { w.err = err return 0, err } } } return total, nil } // Close flushes the last chunk. It does not close the underlying Writer. func (w *EncryptWriter) Close() error { if w.err != nil { return w.err } w.err = w.flushChunk(lastChunk) if w.err != nil { return w.err } w.err = errors.New("stream.Writer is already closed") return nil } const ( lastChunk = true notLastChunk = false ) func (w *EncryptWriter) flushChunk(last bool) error { if !last && w.buf.Len() != ChunkSize { panic("stream: internal error: flush called with partial chunk") } if last { setLastChunkFlag(&w.nonce) } w.buf.Grow(chacha20poly1305.Overhead) ciphertext := w.a.Seal(w.buf.Bytes()[:0], w.nonce[:], w.buf.Bytes(), nil) _, err := w.dst.Write(ciphertext) incNonce(&w.nonce) w.buf.Reset() return err } type EncryptReader struct { a cipher.AEAD src io.Reader // The first ready bytes of buf are already encrypted. This may be less than // buf.Len(), because we need to over-read to know if a chunk is the last. ready int buf bytes.Buffer nonce [chacha20poly1305.NonceSize]byte err error } func NewEncryptReader(key []byte, src io.Reader) (*EncryptReader, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } return &EncryptReader{a: aead, src: src}, nil } func (r *EncryptReader) Read(p []byte) (int, error) { if r.ready > 0 { n, err := r.buf.Read(p[:min(len(p), r.ready)]) r.ready -= n return n, err } if r.err != nil { return 0, r.err } if len(p) == 0 { return 0, nil } if err := r.feedBuffer(); err != nil { r.err = err return 0, err } n, err := r.buf.Read(p[:min(len(p), r.ready)]) r.ready -= n return n, err } // feedBuffer reads and encrypts the next chunk from r.src and appends it to // r.buf. It sets r.ready to the number of newly available bytes in r.buf. func (r *EncryptReader) feedBuffer() error { if r.ready > 0 { panic("stream: internal error: feedBuffer called with dirty buffer") } // CopyN will use r.buf.ReadFrom/WriteTo to fill the buffer directly. // We need ChunkSize + 1 bytes to determine if this is the last chunk. _, err := io.CopyN(&r.buf, r.src, int64(ChunkSize-r.buf.Len()+1)) if err != nil && err != io.EOF { return err } if last := r.buf.Len() <= ChunkSize; last { setLastChunkFlag(&r.nonce) // After Grow, we know r.buf.Bytes() has enough capacity for the // overhead. We encrypt in place and then do a Write to include the // overhead in the buffer. r.buf.Grow(chacha20poly1305.Overhead) plaintext := r.buf.Bytes() r.a.Seal(plaintext[:0], r.nonce[:], plaintext, nil) incNonce(&r.nonce) r.buf.Write(plaintext[len(plaintext) : len(plaintext)+chacha20poly1305.Overhead]) r.ready = r.buf.Len() r.err = io.EOF return nil } // Same, but accounting for the tail byte which will remain unencrypted and // needs to be shifted past the overhead. if r.buf.Len() != ChunkSize+1 { panic("stream: internal error: unexpected buffer length") } tailByte := r.buf.Bytes()[ChunkSize] r.buf.Grow(chacha20poly1305.Overhead) plaintext := r.buf.Bytes()[:ChunkSize] r.a.Seal(plaintext[:0], r.nonce[:], plaintext, nil) incNonce(&r.nonce) r.buf.Write(plaintext[len(plaintext)+1 : len(plaintext)+chacha20poly1305.Overhead]) r.buf.WriteByte(tailByte) r.ready = ChunkSize + chacha20poly1305.Overhead return nil } type DecryptReaderAt struct { a cipher.AEAD src io.ReaderAt size int64 chunks int64 cache atomic.Pointer[cachedChunk] } type cachedChunk struct { off int64 data []byte } func NewDecryptReaderAt(key []byte, src io.ReaderAt, size int64) (*DecryptReaderAt, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } // Check that size is valid by decrypting the final chunk. chunks, err := EncryptedChunkCount(size) if err != nil { return nil, err } finalChunkIndex := chunks - 1 finalChunkOff := finalChunkIndex * encChunkSize finalChunkSize := size - finalChunkOff finalChunk := make([]byte, finalChunkSize) if _, err := src.ReadAt(finalChunk, finalChunkOff); err != nil { return nil, fmt.Errorf("failed to read final chunk: %w", err) } nonce := nonceForChunk(finalChunkIndex) setLastChunkFlag(nonce) plaintext, err := aead.Open(finalChunk[:0], nonce[:], finalChunk, nil) if err != nil { return nil, fmt.Errorf("failed to decrypt and authenticate final chunk: %w", err) } cache := &cachedChunk{off: finalChunkOff, data: plaintext} plaintextSize := size - chunks*chacha20poly1305.Overhead r := &DecryptReaderAt{a: aead, src: src, size: plaintextSize, chunks: chunks} r.cache.Store(cache) return r, nil } func (r *DecryptReaderAt) ReadAt(p []byte, off int64) (n int, err error) { if off < 0 || off > r.size { return 0, fmt.Errorf("offset out of range [0:%d]: %d", r.size, off) } if len(p) == 0 { return 0, nil } var cacheUpdate *cachedChunk chunk := make([]byte, encChunkSize) for len(p) > 0 && off < r.size { chunkIndex := off / ChunkSize chunkOff := chunkIndex * encChunkSize encSize := r.size + r.chunks*chacha20poly1305.Overhead chunkSize := min(encSize-chunkOff, encChunkSize) cached := r.cache.Load() var plaintext []byte if cached != nil && cached.off == chunkOff { plaintext = cached.data cacheUpdate = nil } else { nn, err := r.src.ReadAt(chunk[:chunkSize], chunkOff) if err == io.EOF { if int64(nn) != chunkSize { err = io.ErrUnexpectedEOF } else { err = nil } } if err != nil { return n, fmt.Errorf("failed to read chunk at offset %d: %w", chunkOff, err) } nonce := nonceForChunk(chunkIndex) if chunkIndex == r.chunks-1 { setLastChunkFlag(nonce) } plaintext, err = r.a.Open(chunk[:0], nonce[:], chunk[:chunkSize], nil) if err != nil { return n, fmt.Errorf("failed to decrypt and authenticate chunk at offset %d: %w", chunkOff, err) } cacheUpdate = &cachedChunk{off: chunkOff, data: plaintext} } plainChunkOff := int(off - chunkIndex*ChunkSize) copySize := min(len(plaintext)-plainChunkOff, len(p)) copy(p, plaintext[plainChunkOff:plainChunkOff+copySize]) p = p[copySize:] off += int64(copySize) n += copySize } if cacheUpdate != nil { r.cache.Store(cacheUpdate) } if off == r.size { return n, io.EOF } return n, nil } ================================================ FILE: internal/stream/stream_test.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package stream_test import ( "bytes" "crypto/rand" "fmt" "io" "testing" "testing/iotest" "filippo.io/age/internal/stream" "golang.org/x/crypto/chacha20poly1305" ) const cs = stream.ChunkSize func TestRoundTrip(t *testing.T) { for _, length := range []int{0, 1000, cs - 1, cs, cs + 1, cs + 100, 2 * cs, 2*cs + 500} { for _, stepSize := range []int{512, 600, 1000, cs - 1, cs, cs + 1} { t.Run(fmt.Sprintf("len=%d,step=%d", length, stepSize), func(t *testing.T) { testRoundTrip(t, stepSize, length) }) } } length, stepSize := 2*cs+500, 1 t.Run(fmt.Sprintf("len=%d,step=%d", length, stepSize), func(t *testing.T) { testRoundTrip(t, stepSize, length) }) } func testRoundTrip(t *testing.T, stepSize, length int) { src := make([]byte, length) if _, err := rand.Read(src); err != nil { t.Fatal(err) } key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } var ciphertext []byte t.Run("EncryptWriter", func(t *testing.T) { buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } var n int for n < length { b := min(length-n, stepSize) nn, err := w.Write(src[n : n+b]) if err != nil { t.Fatal(err) } if nn != b { t.Errorf("Write returned %d, expected %d", nn, b) } n += nn nn, err = w.Write(src[n:n]) if err != nil { t.Fatal(err) } if nn != 0 { t.Errorf("Write returned %d, expected 0", nn) } } if err := w.Close(); err != nil { t.Error("Close returned an error:", err) } ciphertext = buf.Bytes() }) t.Run("DecryptReader", func(t *testing.T) { r, err := stream.NewDecryptReader(key, bytes.NewReader(ciphertext)) if err != nil { t.Fatal(err) } var n int readBuf := make([]byte, stepSize) for n < length { nn, err := r.Read(readBuf) if err != nil { t.Fatalf("Read error at index %d: %v", n, err) } if !bytes.Equal(readBuf[:nn], src[n:n+nn]) { t.Errorf("wrong data at indexes %d - %d", n, n+nn) } n += nn } t.Run("TestReader", func(t *testing.T) { if length > 1000 && testing.Short() { t.Skip("skipping slow iotest.TestReader on long input") } r, _ := stream.NewDecryptReader(key, bytes.NewReader(ciphertext)) if err := iotest.TestReader(r, src); err != nil { t.Error("iotest.TestReader error on DecryptReader:", err) } }) }) t.Run("DecryptReaderAt", func(t *testing.T) { rAt, err := stream.NewDecryptReaderAt(key, bytes.NewReader(ciphertext), int64(len(ciphertext))) if err != nil { t.Fatal(err) } rr := io.NewSectionReader(rAt, 0, int64(len(ciphertext))) var n int readBuf := make([]byte, stepSize) for n < length { nn, err := rr.Read(readBuf) if n+nn == length && err == io.EOF { err = nil } if err != nil { t.Fatalf("ReadAt error at index %d: %v", n, err) } if !bytes.Equal(readBuf[:nn], src[n:n+nn]) { t.Errorf("wrong data at indexes %d - %d", n, n+nn) } n += nn } t.Run("TestReader", func(t *testing.T) { if length > 1000 && testing.Short() { t.Skip("skipping slow iotest.TestReader on long input") } rr := io.NewSectionReader(rAt, 0, int64(len(src))) if err := iotest.TestReader(rr, src); err != nil { t.Error("iotest.TestReader error on DecryptReaderAt:", err) } }) }) t.Run("EncryptReader", func(t *testing.T) { er, err := stream.NewEncryptReader(key, bytes.NewReader(src)) if err != nil { t.Fatal(err) } var n int readBuf := make([]byte, stepSize) for { nn, err := er.Read(readBuf) if nn == 0 && err == io.EOF { break } else if err != nil { t.Fatalf("EncryptReader Read error at index %d: %v", n, err) } if !bytes.Equal(readBuf[:nn], ciphertext[n:n+nn]) { t.Errorf("EncryptReader wrong data at indexes %d - %d", n, n+nn) } n += nn } if n != len(ciphertext) { t.Errorf("EncryptReader read %d bytes, expected %d", n, len(ciphertext)) } t.Run("TestReader", func(t *testing.T) { if length > 1000 && testing.Short() { t.Skip("skipping slow iotest.TestReader on long input") } er, _ := stream.NewEncryptReader(key, bytes.NewReader(src)) if err := iotest.TestReader(er, ciphertext); err != nil { t.Error("iotest.TestReader error on EncryptReader:", err) } }) }) } // trackingReaderAt wraps an io.ReaderAt and tracks whether ReadAt was called. type trackingReaderAt struct { r io.ReaderAt called bool } func (t *trackingReaderAt) ReadAt(p []byte, off int64) (int, error) { t.called = true return t.r.ReadAt(p, off) } func (t *trackingReaderAt) reset() { t.called = false } func TestDecryptReaderAt(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } // Create plaintext spanning exactly 3 chunks: 2 full chunks + partial third // Chunk 0: [0, cs) // Chunk 1: [cs, 2*cs) // Chunk 2: [2*cs, 2*cs+500) plaintextSize := 2*cs + 500 plaintext := make([]byte, plaintextSize) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } // Encrypt buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() // Create tracking ReaderAt tracker := &trackingReaderAt{r: bytes.NewReader(ciphertext)} // Create DecryptReaderAt (this reads and caches the final chunk) ra, err := stream.NewDecryptReaderAt(key, tracker, int64(len(ciphertext))) if err != nil { t.Fatal(err) } tracker.reset() // Helper to check reads checkRead := func(name string, off int64, size int, wantN int, wantEOF bool, wantSrcRead bool) { t.Helper() tracker.reset() p := make([]byte, size) n, err := ra.ReadAt(p, off) if wantEOF { if err != io.EOF { t.Errorf("%s: got err=%v, want EOF", name, err) } } else { if err != nil { t.Errorf("%s: got err=%v, want nil", name, err) } } if n != wantN { t.Errorf("%s: got n=%d, want %d", name, n, wantN) } if tracker.called != wantSrcRead { t.Errorf("%s: src.ReadAt called=%v, want %v", name, tracker.called, wantSrcRead) } // Verify data correctness if n > 0 && off >= 0 && off < int64(plaintextSize) { end := int(off) + n if end > plaintextSize { end = plaintextSize } if !bytes.Equal(p[:n], plaintext[off:end]) { t.Errorf("%s: data mismatch", name) } } } // Test 1: Read from final chunk (cached by constructor) checkRead("final chunk (cached)", int64(2*cs+100), 100, 100, false, false) // Test 2: Read spanning second and third chunk checkRead("span chunks 1-2", int64(cs+cs-50), 100, 100, false, true) // Test 3: Read from final chunk again (cached from test 2) // When reading across chunks 1-2 in test 2, the loop processes chunk 1 then chunk 2, // so chunk 2 ends up in the cache. checkRead("final chunk after span", int64(2*cs+200), 100, 100, false, false) // Test 4: Read from final chunk again (now cached) checkRead("final chunk (cached again)", int64(2*cs+50), 50, 50, false, false) // Test 5: Read from first chunk (not cached) checkRead("first chunk", 0, 100, 100, false, true) // Test 6: Read from first chunk again (now cached) checkRead("first chunk (cached)", 50, 100, 100, false, false) // Test 7: Read spanning all chunks tracker.reset() p := make([]byte, plaintextSize) n, err := ra.ReadAt(p, 0) if err != io.EOF { t.Errorf("span all: got err=%v, want EOF", err) } if n != plaintextSize { t.Errorf("span all: got n=%d, want %d", n, plaintextSize) } if !bytes.Equal(p, plaintext) { t.Errorf("span all: data mismatch") } // Test 8: Read beyond the end (offset > size) tracker.reset() p = make([]byte, 100) n, err = ra.ReadAt(p, int64(plaintextSize+100)) if err == nil { t.Error("beyond end: expected error, got nil") } if n != 0 { t.Errorf("beyond end: got n=%d, want 0", n) } // Test 9: Read with off = size (should return 0, EOF) tracker.reset() p = make([]byte, 100) n, err = ra.ReadAt(p, int64(plaintextSize)) if err != io.EOF { t.Errorf("off=size: got err=%v, want EOF", err) } if n != 0 { t.Errorf("off=size: got n=%d, want 0", n) } // Test 10: Read spanning last chunk and beyond tracker.reset() p = make([]byte, 1000) // request more than available n, err = ra.ReadAt(p, int64(2*cs+400)) if err != io.EOF { t.Errorf("span last+beyond: got err=%v, want EOF", err) } wantN := 500 - 400 // only 100 bytes available from offset 2*cs+400 if n != wantN { t.Errorf("span last+beyond: got n=%d, want %d", n, wantN) } if !bytes.Equal(p[:n], plaintext[2*cs+400:]) { t.Error("span last+beyond: data mismatch") } // Test 11: Read spanning second+last chunk and beyond tracker.reset() p = make([]byte, cs+1000) // request more than available n, err = ra.ReadAt(p, int64(cs+100)) if err != io.EOF { t.Errorf("span 1-2+beyond: got err=%v, want EOF", err) } wantN = plaintextSize - (cs + 100) if n != wantN { t.Errorf("span 1-2+beyond: got n=%d, want %d", n, wantN) } if !bytes.Equal(p[:n], plaintext[cs+100:]) { t.Error("span 1-2+beyond: data mismatch") } // Test 12: Negative offset tracker.reset() p = make([]byte, 100) n, err = ra.ReadAt(p, -1) if err == nil { t.Error("negative offset: expected error, got nil") } if n != 0 { t.Errorf("negative offset: got n=%d, want 0", n) } // Test 13: Zero-length read in the middle tracker.reset() p = make([]byte, 0) n, err = ra.ReadAt(p, 100) if err != nil { t.Errorf("zero-length middle: got err=%v, want nil", err) } if n != 0 { t.Errorf("zero-length middle: got n=%d, want 0", n) } // Test 14: Zero-length read at end tracker.reset() p = make([]byte, 0) n, err = ra.ReadAt(p, int64(plaintextSize)) if err != nil { t.Errorf("zero-length end: got err=%v, want nil", err) } if n != 0 { t.Errorf("zero-length end: got n=%d, want 0", n) } // Test 15: Read exactly one chunk at chunk boundary checkRead("exact chunk at boundary", int64(cs), cs, cs, false, true) // Test 16: Read one byte at each chunk boundary checkRead("one byte at start", 0, 1, 1, false, true) checkRead("one byte at cs-1", int64(cs-1), 1, 1, false, false) // cached from test 15 checkRead("one byte at cs", int64(cs), 1, 1, false, true) checkRead("one byte at 2*cs-1", int64(2*cs-1), 1, 1, false, false) // same chunk checkRead("one byte at 2*cs", int64(2*cs), 1, 1, false, true) checkRead("last byte", int64(plaintextSize-1), 1, 1, true, false) // same chunk, EOF because we reach end // Test 17: Read crossing exactly one chunk boundary checkRead("cross boundary 0-1", int64(cs-50), 100, 100, false, true) checkRead("cross boundary 1-2", int64(2*cs-50), 100, 100, false, true) } func TestDecryptReaderAtEmpty(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } // Create empty encrypted file buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() tracker := &trackingReaderAt{r: bytes.NewReader(ciphertext)} ra, err := stream.NewDecryptReaderAt(key, tracker, int64(len(ciphertext))) if err != nil { t.Fatal(err) } tracker.reset() // Test 1: Read from empty file at offset 0 p := make([]byte, 100) n, err := ra.ReadAt(p, 0) if err != io.EOF { t.Errorf("empty read: got err=%v, want EOF", err) } if n != 0 { t.Errorf("empty read: got n=%d, want 0", n) } // Test 2: Zero-length read from empty file p = make([]byte, 0) n, err = ra.ReadAt(p, 0) if err != nil { t.Errorf("empty zero-length: got err=%v, want nil", err) } if n != 0 { t.Errorf("empty zero-length: got n=%d, want 0", n) } // Test 3: Read beyond empty file p = make([]byte, 100) n, err = ra.ReadAt(p, 1) if err == nil { t.Error("empty beyond: expected error, got nil") } if n != 0 { t.Errorf("empty beyond: got n=%d, want 0", n) } } func TestDecryptReaderAtSingleChunk(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } // Single chunk, not full plaintext := make([]byte, 1000) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() tracker := &trackingReaderAt{r: bytes.NewReader(ciphertext)} ra, err := stream.NewDecryptReaderAt(key, tracker, int64(len(ciphertext))) if err != nil { t.Fatal(err) } tracker.reset() // All reads should use cache (final chunk = only chunk) p := make([]byte, 100) n, err := ra.ReadAt(p, 0) if err != nil { t.Errorf("single chunk start: got err=%v, want nil", err) } if n != 100 { t.Errorf("single chunk start: got n=%d, want 100", n) } if tracker.called { t.Error("single chunk start: unexpected src.ReadAt call") } if !bytes.Equal(p[:n], plaintext[:100]) { t.Error("single chunk start: data mismatch") } // Read at end n, err = ra.ReadAt(p, 900) if err != io.EOF { t.Errorf("single chunk end: got err=%v, want EOF", err) } if n != 100 { t.Errorf("single chunk end: got n=%d, want 100", n) } if tracker.called { t.Error("single chunk end: unexpected src.ReadAt call") } if !bytes.Equal(p[:n], plaintext[900:]) { t.Error("single chunk end: data mismatch") } } func TestDecryptReaderAtFullChunks(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } // Exactly 2 full chunks plaintext := make([]byte, 2*cs) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() tracker := &trackingReaderAt{r: bytes.NewReader(ciphertext)} ra, err := stream.NewDecryptReaderAt(key, tracker, int64(len(ciphertext))) if err != nil { t.Fatal(err) } tracker.reset() // Read last byte of second chunk (cached) p := make([]byte, 1) n, err := ra.ReadAt(p, int64(2*cs-1)) if err != io.EOF { t.Errorf("last byte: got err=%v, want EOF", err) } if n != 1 { t.Errorf("last byte: got n=%d, want 1", n) } if tracker.called { t.Error("last byte: unexpected src.ReadAt call (should be cached)") } if p[0] != plaintext[2*cs-1] { t.Error("last byte: data mismatch") } // Read at exactly the boundary between chunks p = make([]byte, 100) n, err = ra.ReadAt(p, int64(cs-50)) if err != nil { t.Errorf("boundary: got err=%v, want nil", err) } if n != 100 { t.Errorf("boundary: got n=%d, want 100", n) } if !bytes.Equal(p, plaintext[cs-50:cs+50]) { t.Error("boundary: data mismatch") } } func TestDecryptReaderAtWrongKey(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } plaintext := make([]byte, 1000) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() // Try to decrypt with wrong key wrongKey := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(wrongKey); err != nil { t.Fatal(err) } _, err = stream.NewDecryptReaderAt(wrongKey, bytes.NewReader(ciphertext), int64(len(ciphertext))) if err == nil { t.Error("wrong key: expected error, got nil") } } func TestDecryptReaderAtInvalidSize(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } plaintext := make([]byte, 1000) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() // Wrong size (too small) _, err = stream.NewDecryptReaderAt(key, bytes.NewReader(ciphertext), int64(len(ciphertext)-1)) if err == nil { t.Error("wrong size (small): expected error, got nil") } // Wrong size (too large) _, err = stream.NewDecryptReaderAt(key, bytes.NewReader(ciphertext), int64(len(ciphertext)+1)) if err == nil { t.Error("wrong size (large): expected error, got nil") } // Size that would imply empty final chunk (invalid) // This would be: one full encrypted chunk + just overhead invalidSize := int64(cs + chacha20poly1305.Overhead + chacha20poly1305.Overhead) _, err = stream.NewDecryptReaderAt(key, bytes.NewReader(make([]byte, invalidSize)), invalidSize) if err == nil { t.Error("invalid size (empty final chunk): expected error, got nil") } } func TestDecryptReaderAtTruncated(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } plaintext := make([]byte, 2*cs+500) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() // Truncate ciphertext but lie about size truncated := ciphertext[:len(ciphertext)-100] _, err = stream.NewDecryptReaderAt(key, bytes.NewReader(truncated), int64(len(ciphertext))) if err == nil { t.Error("truncated: expected error, got nil") } } func TestDecryptReaderAtTruncatedChunk(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } // Create 4 chunks: 3 full + 1 partial plaintext := make([]byte, 3*cs+500) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() // Truncate to 3 chunks (remove the actual final chunk) // The third chunk was NOT encrypted with the last chunk flag, // so decryption should fail when we try to use it as the final chunk. encChunkSize := cs + 16 // ChunkSize + Overhead truncatedSize := int64(3 * encChunkSize) truncated := ciphertext[:truncatedSize] _, err = stream.NewDecryptReaderAt(key, bytes.NewReader(truncated), truncatedSize) if err == nil { t.Error("truncated at chunk boundary: expected error, got nil") } } func TestDecryptReaderAtConcurrent(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } // Create plaintext spanning 3 chunks: 2 full + partial plaintextSize := 2*cs + 500 plaintext := make([]byte, plaintextSize) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } // Encrypt buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := buf.Bytes() ra, err := stream.NewDecryptReaderAt(key, bytes.NewReader(ciphertext), int64(len(ciphertext))) if err != nil { t.Fatal(err) } t.Run("same chunk", func(t *testing.T) { t.Parallel() const goroutines = 10 const iterations = 100 errc := make(chan error, goroutines) for g := range goroutines { go func(id int) { for i := range iterations { off := int64((id*iterations + i) % 500) p := make([]byte, 100) n, err := ra.ReadAt(p, off) if err != nil { errc <- fmt.Errorf("goroutine %d iter %d: %v", id, i, err) return } if n != 100 { errc <- fmt.Errorf("goroutine %d iter %d: n=%d, want 100", id, i, n) return } if !bytes.Equal(p, plaintext[off:off+100]) { errc <- fmt.Errorf("goroutine %d iter %d: data mismatch", id, i) return } } errc <- nil }(g) } for range goroutines { if err := <-errc; err != nil { t.Error(err) } } }) t.Run("different chunks", func(t *testing.T) { t.Parallel() const goroutines = 10 const iterations = 100 errc := make(chan error, goroutines) for g := range goroutines { go func(id int) { for i := range iterations { // Each goroutine reads from a different chunk based on id chunkIdx := id % 3 off := int64(chunkIdx*cs + (i % 400)) size := 100 if off+int64(size) > int64(plaintextSize) { size = plaintextSize - int(off) } p := make([]byte, size) n, err := ra.ReadAt(p, off) if n == size && err == io.EOF { err = nil // EOF at end is acceptable } if err != nil { errc <- fmt.Errorf("goroutine %d iter %d: off=%d: %v", id, i, off, err) return } if n != size { errc <- fmt.Errorf("goroutine %d iter %d: n=%d, want %d", id, i, n, size) return } if !bytes.Equal(p[:n], plaintext[off:off+int64(n)]) { errc <- fmt.Errorf("goroutine %d iter %d: data mismatch", id, i) return } } errc <- nil }(g) } for range goroutines { if err := <-errc; err != nil { t.Error(err) } } }) t.Run("across chunks", func(t *testing.T) { t.Parallel() const goroutines = 10 const iterations = 100 errc := make(chan error, goroutines) for g := range goroutines { go func(id int) { for i := range iterations { // Read across chunk boundaries boundary := (id%2 + 1) * cs // either cs or 2*cs off := int64(boundary - 50 + (i % 30)) size := 100 if off+int64(size) > int64(plaintextSize) { size = plaintextSize - int(off) } if size <= 0 { continue } p := make([]byte, size) n, err := ra.ReadAt(p, off) if n == size && err == io.EOF { err = nil } if err != nil { errc <- fmt.Errorf("goroutine %d iter %d: off=%d size=%d: %v", id, i, off, size, err) return } if n != size { errc <- fmt.Errorf("goroutine %d iter %d: n=%d, want %d", id, i, n, size) return } if !bytes.Equal(p[:n], plaintext[off:off+int64(n)]) { errc <- fmt.Errorf("goroutine %d iter %d: data mismatch", id, i) return } } errc <- nil }(g) } for range goroutines { if err := <-errc; err != nil { t.Error(err) } } }) } func TestDecryptReaderAtCorrupted(t *testing.T) { key := make([]byte, chacha20poly1305.KeySize) if _, err := rand.Read(key); err != nil { t.Fatal(err) } plaintext := make([]byte, 2*cs+500) if _, err := rand.Read(plaintext); err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } ciphertext := bytes.Clone(buf.Bytes()) // Corrupt final chunk - should fail in constructor corruptedFinal := bytes.Clone(ciphertext) corruptedFinal[len(corruptedFinal)-10] ^= 0xFF _, err = stream.NewDecryptReaderAt(key, bytes.NewReader(corruptedFinal), int64(len(corruptedFinal))) if err == nil { t.Error("corrupted final: expected error, got nil") } // Corrupt first chunk - should fail on read corruptedFirst := bytes.Clone(ciphertext) corruptedFirst[10] ^= 0xFF ra, err := stream.NewDecryptReaderAt(key, bytes.NewReader(corruptedFirst), int64(len(corruptedFirst))) if err != nil { t.Fatalf("corrupted first constructor: unexpected error: %v", err) } p := make([]byte, 100) _, err = ra.ReadAt(p, 0) if err == nil { t.Error("corrupted first read: expected error, got nil") } } ================================================ FILE: internal/term/term.go ================================================ package term import ( "fmt" "os" "runtime" "golang.org/x/term" ) // enableVirtualTerminalProcessing tries to enable virtual terminal processing // on Windows. If it fails, avoid using escape sequences to prevent weird // characters being printed to the console. var enableVirtualTerminalProcessing func(out *os.File) error // clearLine clears the current line on the terminal, or opens a new line if // terminal escape codes don't work. func clearLine(out *os.File) { const ( CUI = "\033[" // Control Sequence Introducer CPL = CUI + "F" // Cursor Previous Line EL = CUI + "K" // Erase in Line ) // First, open a new line, which is guaranteed to work everywhere. Then, try // to erase the line above with escape codes, if possible. // // (We use CRLF instead of LF to work around an apparent bug in WSL2's // handling of CONOUT$. Only when running a Windows binary from WSL2, the // cursor would not go back to the start of the line with a simple LF. // Honestly, it's impressive CONIN$ and CONOUT$ work at all inside WSL2.) fmt.Fprintf(out, "\r\n") if enableVirtualTerminalProcessing == nil || enableVirtualTerminalProcessing(out) == nil { fmt.Fprintf(out, CPL+EL) } } // WithTerminal runs f with the terminal input and output files, if available. // WithTerminal does not open a non-terminal stdin, so the caller does not need // to check if stdin is in use. func WithTerminal(f func(in, out *os.File) error) error { if runtime.GOOS == "windows" { in, err := os.OpenFile("CONIN$", os.O_RDWR, 0) if err != nil { return err } defer in.Close() out, err := os.OpenFile("CONOUT$", os.O_WRONLY, 0) if err != nil { return err } defer out.Close() return f(in, out) } else if tty, err := os.OpenFile("/dev/tty", os.O_RDWR, 0); err == nil { defer tty.Close() return f(tty, tty) } else if term.IsTerminal(int(os.Stdin.Fd())) { return f(os.Stdin, os.Stdin) } else { return fmt.Errorf("standard input is not a terminal, and /dev/tty is not available: %v", err) } } // ReadSecret reads a value from the terminal with no echo. The prompt is ephemeral. func ReadSecret(prompt string) (s []byte, err error) { err = WithTerminal(func(in, out *os.File) error { fmt.Fprintf(out, "%s ", prompt) defer clearLine(out) s, err = term.ReadPassword(int(in.Fd())) return err }) return } // ReadPublic reads a value from the terminal. The prompt is ephemeral. func ReadPublic(prompt string) (s []byte, err error) { err = WithTerminal(func(in, out *os.File) error { fmt.Fprintf(out, "%s ", prompt) defer clearLine(out) oldState, err := term.MakeRaw(int(in.Fd())) if err != nil { return err } defer term.Restore(int(in.Fd()), oldState) t := term.NewTerminal(in, "") line, err := t.ReadLine() s = []byte(line) return err }) return } // ReadCharacter reads a single character from the terminal with no echo. The // prompt is ephemeral. func ReadCharacter(prompt string) (c byte, err error) { err = WithTerminal(func(in, out *os.File) error { fmt.Fprintf(out, "%s ", prompt) defer clearLine(out) oldState, err := term.MakeRaw(int(in.Fd())) if err != nil { return err } defer term.Restore(int(in.Fd()), oldState) b := make([]byte, 1) if _, err := in.Read(b); err != nil { return err } c = b[0] return nil }) return } // IsTerminal returns whether the given file is a terminal. func IsTerminal(f *os.File) bool { return term.IsTerminal(int(f.Fd())) } ================================================ FILE: internal/term/term_windows.go ================================================ // Copyright 2022 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package term import ( "errors" "os" "syscall" "golang.org/x/sys/windows" ) func init() { enableVirtualTerminalProcessing = func(out *os.File) error { // Some instances of the Windows Console (e.g., cmd.exe and Windows PowerShell) // do not have the virtual terminal processing enabled, which is necessary to // make terminal escape sequences work. For this reason the clearLine function // may not properly work. Here we enable the virtual terminal processing, if // possible. // // See https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences. const ( ENABLE_PROCESSED_OUTPUT uint32 = 0x1 ENABLE_VIRTUAL_TERMINAL_PROCESSING uint32 = 0x4 ) kernel32DLL := windows.NewLazySystemDLL("Kernel32.dll") setConsoleMode := kernel32DLL.NewProc("SetConsoleMode") var mode uint32 if err := syscall.GetConsoleMode(syscall.Handle(out.Fd()), &mode); err != nil { return err } mode |= ENABLE_PROCESSED_OUTPUT mode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING // If the SetConsoleMode function fails, the return value is zero. // See https://learn.microsoft.com/en-us/windows/console/setconsolemode#return-value. if ret, _, _ := setConsoleMode.Call(out.Fd(), uintptr(mode)); ret == 0 { return errors.New("SetConsoleMode failed") } return nil } } ================================================ FILE: logo/README.md ================================================ The logos available in this folder are Copyright 2021 Filippo Valsorda. Permission is granted to use the logos as long as they are unaltered, are not combined with other text or graphic, and are not used to imply your project is endorsed by or affiliated with the age project. This permission can be revoked or rescinded for any reason and at any time, selectively or otherwise. If you require different terms, please email age-logo@filippo.io. The logos were designed by [Studiovagante](https://www.studiovagante.it). ================================================ FILE: parse.go ================================================ // Copyright 2021 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package age import ( "bufio" "fmt" "io" "strings" "unicode/utf8" ) // ParseIdentities parses a file with one or more private key encodings, one per // line. Empty lines and lines starting with "#" are ignored. // // This is the same syntax as the private key files accepted by the CLI, except // the CLI also accepts SSH private keys, which are not recommended for the // average application, and plugins, which involve invoking external programs. // // Currently, all returned values are of type *[X25519Identity] or // *[HybridIdentity], but different types might be returned in the future. func ParseIdentities(f io.Reader) ([]Identity, error) { const privateKeySizeLimit = 1 << 24 // 16 MiB var ids []Identity scanner := bufio.NewScanner(io.LimitReader(f, privateKeySizeLimit)) var n int for scanner.Scan() { n++ line := scanner.Text() if strings.HasPrefix(line, "#") || line == "" { continue } if !utf8.ValidString(line) { return nil, fmt.Errorf("identities file is not valid UTF-8") } i, err := parseIdentity(line) if err != nil { return nil, fmt.Errorf("error at line %d: %v", n, err) } ids = append(ids, i) } if err := scanner.Err(); err != nil { return nil, fmt.Errorf("failed to read identities file: %v", err) } if len(ids) == 0 { return nil, fmt.Errorf("no identities found") } return ids, nil } func parseIdentity(arg string) (Identity, error) { switch { case strings.HasPrefix(arg, "AGE-SECRET-KEY-1"): return ParseX25519Identity(arg) case strings.HasPrefix(arg, "AGE-SECRET-KEY-PQ-1"): return ParseHybridIdentity(arg) default: return nil, fmt.Errorf("unknown identity type: %q", arg) } } // ParseRecipients parses a file with one or more public key encodings, one per // line. Empty lines and lines starting with "#" are ignored. // // This is the same syntax as the recipients files accepted by the CLI, except // the CLI also accepts SSH recipients, which are not recommended for the // average application, tagged recipients, which have different privacy // properties, and plugins, which involve invoking external programs. // // Currently, all returned values are of type *[X25519Recipient] or // *[HybridRecipient] but different types might be returned in the future. func ParseRecipients(f io.Reader) ([]Recipient, error) { const recipientFileSizeLimit = 1 << 24 // 16 MiB var recs []Recipient scanner := bufio.NewScanner(io.LimitReader(f, recipientFileSizeLimit)) var n int for scanner.Scan() { n++ line := scanner.Text() if strings.HasPrefix(line, "#") || line == "" { continue } if !utf8.ValidString(line) { return nil, fmt.Errorf("recipients file is not valid UTF-8") } r, err := parseRecipient(line) if err != nil { return nil, fmt.Errorf("error at line %d: %v", n, err) } recs = append(recs, r) } if err := scanner.Err(); err != nil { return nil, fmt.Errorf("failed to read recipients file: %v", err) } if len(recs) == 0 { return nil, fmt.Errorf("no recipients found") } return recs, nil } func parseRecipient(arg string) (Recipient, error) { switch { case strings.HasPrefix(arg, "age1pq1"): return ParseHybridRecipient(arg) case strings.HasPrefix(arg, "age1"): return ParseX25519Recipient(arg) default: return nil, fmt.Errorf("unknown recipient type: %q", arg) } } ================================================ FILE: plugin/client.go ================================================ // Copyright 2021 Google LLC // // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file or at // https://developers.google.com/open-source/licenses/bsd package plugin import ( "bufio" "crypto/rand" "errors" "fmt" "io" mathrand "math/rand/v2" "os" "path/filepath" "strconv" "strings" "time" exec "golang.org/x/sys/execabs" "filippo.io/age" "filippo.io/age/internal/format" ) type Recipient struct { name string encoding string ui *ClientUI // identity is true when encoding is an identity string. identity bool } var _ age.Recipient = &Recipient{} var _ age.RecipientWithLabels = &Recipient{} func NewRecipient(s string, ui *ClientUI) (*Recipient, error) { name, _, err := ParseRecipient(s) if err != nil { return nil, err } return &Recipient{ name: name, encoding: s, ui: ui, }, nil } // Name returns the plugin name, which is used in the recipient ("age1name1...") // and identity ("AGE-PLUGIN-NAME-1...") encodings, as well as in the plugin // binary name ("age-plugin-name"). func (r *Recipient) Name() string { return r.name } // String returns the recipient encoding string ("age1name1...") or // "" if r was created by [Identity.Recipient]. func (r *Recipient) String() string { if r.identity { return "" } return r.encoding } func (r *Recipient) Wrap(fileKey []byte) (stanzas []*age.Stanza, err error) { stanzas, _, err = r.WrapWithLabels(fileKey) return } func (r *Recipient) WrapWithLabels(fileKey []byte) (stanzas []*age.Stanza, labels []string, err error) { defer func() { if err != nil { err = fmt.Errorf("%s plugin: %w", r.name, err) } }() conn, err := openClientConnection(r.name, "recipient-v1") if err != nil { return nil, nil, fmt.Errorf("couldn't start plugin: %w", err) } defer conn.Close() // Phase 1: client sends recipient or identity and file key addType := "add-recipient" if r.identity { addType = "add-identity" } if err := writeStanza(conn, addType, r.encoding); err != nil { return nil, nil, err } if _, err := writeGrease(conn); err != nil { return nil, nil, err } if err := writeStanzaWithBody(conn, "wrap-file-key", fileKey); err != nil { return nil, nil, err } if err := writeStanza(conn, "extension-labels"); err != nil { return nil, nil, err } if err := writeStanza(conn, "done"); err != nil { return nil, nil, err } // Phase 2: plugin responds with stanzas sr := format.NewStanzaReader(bufio.NewReader(conn)) ReadLoop: for { s, err := r.ui.readStanza(r.name, sr) if err != nil { return nil, nil, err } switch s.Type { case "recipient-stanza": if len(s.Args) < 2 { return nil, nil, fmt.Errorf("malformed recipient stanza: unexpected argument count") } n, err := strconv.Atoi(s.Args[0]) if err != nil { return nil, nil, fmt.Errorf("malformed recipient stanza: invalid index") } // We only send a single file key, so the index must be 0. if n != 0 { return nil, nil, fmt.Errorf("malformed recipient stanza: unexpected index") } stanzas = append(stanzas, &age.Stanza{ Type: s.Args[1], Args: s.Args[2:], Body: s.Body, }) if err := writeStanza(conn, "ok"); err != nil { return nil, nil, err } case "labels": if labels != nil { return nil, nil, fmt.Errorf("repeated labels stanza") } labels = s.Args if err := writeStanza(conn, "ok"); err != nil { return nil, nil, err } case "error": if err := writeStanza(conn, "ok"); err != nil { return nil, nil, err } return nil, nil, fmt.Errorf("%s", s.Body) case "done": break ReadLoop default: if ok, err := r.ui.handle(r.name, conn, s); err != nil { return nil, nil, err } else if !ok { if err := writeStanza(conn, "unsupported"); err != nil { return nil, nil, err } } } } if len(stanzas) == 0 { return nil, nil, fmt.Errorf("received zero recipient stanzas") } return stanzas, labels, nil } type Identity struct { name string encoding string ui *ClientUI } var _ age.Identity = &Identity{} func NewIdentity(s string, ui *ClientUI) (*Identity, error) { name, _, err := ParseIdentity(s) if err != nil { return nil, err } return &Identity{ name: name, encoding: s, ui: ui, }, nil } func NewIdentityWithoutData(name string, ui *ClientUI) (*Identity, error) { s := EncodeIdentity(name, nil) if s == "" { return nil, fmt.Errorf("invalid plugin name: %q", name) } return &Identity{ name: name, encoding: s, ui: ui, }, nil } // Name returns the plugin name, which is used in the recipient ("age1name1...") // and identity ("AGE-PLUGIN-NAME-1...") encodings, as well as in the plugin // binary name ("age-plugin-name"). func (i *Identity) Name() string { return i.name } // String returns the identity encoding string ("AGE-PLUGIN-NAME-1..."). func (i *Identity) String() string { return i.encoding } // Recipient returns a Recipient wrapping this identity. When that Recipient is // used to encrypt a file key, the identity encoding is provided as-is to the // plugin, which is expected to support encrypting to identities. func (i *Identity) Recipient() *Recipient { return &Recipient{ name: i.name, encoding: i.encoding, identity: true, ui: i.ui, } } func (i *Identity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error) { defer func() { if err != nil { err = fmt.Errorf("%s plugin: %w", i.name, err) } }() conn, err := openClientConnection(i.name, "identity-v1") if err != nil { return nil, fmt.Errorf("couldn't start plugin: %w", err) } defer conn.Close() // Phase 1: client sends the plugin the identity string and the stanzas if err := writeStanza(conn, "add-identity", i.encoding); err != nil { return nil, err } if _, err := writeGrease(conn); err != nil { return nil, err } for _, rs := range stanzas { s := &format.Stanza{ Type: "recipient-stanza", Args: append([]string{"0", rs.Type}, rs.Args...), Body: rs.Body, } if err := s.Marshal(conn); err != nil { return nil, err } } if err := writeStanza(conn, "done"); err != nil { return nil, err } // Phase 2: plugin responds with various commands and a file key sr := format.NewStanzaReader(bufio.NewReader(conn)) ReadLoop: for { s, err := i.ui.readStanza(i.name, sr) if err != nil { return nil, err } switch s.Type { case "file-key": if len(s.Args) != 1 { return nil, fmt.Errorf("malformed file-key stanza: unexpected arguments count") } n, err := strconv.Atoi(s.Args[0]) if err != nil { return nil, fmt.Errorf("malformed file-key stanza: invalid index") } // We only send a single file key, so the index must be 0. if n != 0 { return nil, fmt.Errorf("malformed file-key stanza: unexpected index") } if fileKey != nil { return nil, fmt.Errorf("received duplicated file-key stanza") } fileKey = s.Body if err := writeStanza(conn, "ok"); err != nil { return nil, err } case "error": if err := writeStanza(conn, "ok"); err != nil { return nil, err } return nil, fmt.Errorf("%s", s.Body) case "done": break ReadLoop default: if ok, err := i.ui.handle(i.name, conn, s); err != nil { return nil, err } else if !ok { if err := writeStanza(conn, "unsupported"); err != nil { return nil, err } } } } if fileKey == nil { return nil, age.ErrIncorrectIdentity } return fileKey, nil } // ClientUI holds callbacks that will be invoked by (Un)Wrap if the plugin // wishes to interact with the user. If any of them is nil or returns an error, // failure will be reported to the plugin, but note that the error is otherwise // discarded. Implementations are encouraged to display errors to the user // before returning them. type ClientUI struct { // DisplayMessage displays the message, which is expected to have lowercase // initials and no final period. DisplayMessage func(name, message string) error // RequestValue requests a secret or public input, with the provided prompt. RequestValue func(name, prompt string, secret bool) (string, error) // Confirm requests a confirmation with the provided prompt. The yes and no // value are the choices provided to the user. no may be empty. The return // value indicates whether the user selected the yes or no option. Confirm func(name, prompt, yes, no string) (choseYes bool, err error) // WaitTimer is invoked once (Un)Wrap has been waiting for 5 seconds on the // plugin, for example because the plugin is waiting for an external event // (e.g. a hardware token touch). Unlike the other callbacks, WaitTimer runs // in a separate goroutine, and if missing it's simply ignored. WaitTimer func(name string) } func (c *ClientUI) handle(name string, conn *clientConnection, s *format.Stanza) (ok bool, err error) { switch s.Type { case "msg": if c.DisplayMessage == nil { return true, writeStanza(conn, "fail") } if err := c.DisplayMessage(name, string(s.Body)); err != nil { return true, writeStanza(conn, "fail") } return true, writeStanza(conn, "ok") case "request-secret", "request-public": if c.RequestValue == nil { return true, writeStanza(conn, "fail") } secret, err := c.RequestValue(name, string(s.Body), s.Type == "request-secret") if err != nil { return true, writeStanza(conn, "fail") } return true, writeStanzaWithBody(conn, "ok", []byte(secret)) case "confirm": if len(s.Args) != 1 && len(s.Args) != 2 { return true, fmt.Errorf("malformed confirm stanza: unexpected number of arguments") } if c.Confirm == nil { return true, writeStanza(conn, "fail") } yes, err := format.DecodeString(s.Args[0]) if err != nil { return true, fmt.Errorf("malformed confirm stanza: invalid YES option encoding") } var no []byte if len(s.Args) == 2 { no, err = format.DecodeString(s.Args[1]) if err != nil { return true, fmt.Errorf("malformed confirm stanza: invalid NO option encoding") } } choseYes, err := c.Confirm(name, string(s.Body), string(yes), string(no)) if err != nil { return true, writeStanza(conn, "fail") } result := "yes" if !choseYes { result = "no" } return true, writeStanza(conn, "ok", result) default: return false, nil } } // readStanza calls r.ReadStanza and, if set, invokes WaitTimer in a separate // goroutine if the call takes longer than 5 seconds. func (c *ClientUI) readStanza(name string, r *format.StanzaReader) (*format.Stanza, error) { if c.WaitTimer != nil { defer time.AfterFunc(5*time.Second, func() { c.WaitTimer(name) }).Stop() } return r.ReadStanza() } type clientConnection struct { cmd *exec.Cmd io.Reader // stdout io.Writer // stdin close func() } // NotFoundError is returned by [Recipient.Wrap] and [Identity.Unwrap] when the // plugin binary cannot be found. type NotFoundError struct { // Name is the plugin (not binary) name. Name string // Err is the underlying error, usually an [exec.Error] wrapping // [exec.ErrNotFound]. Err error } func (e *NotFoundError) Error() string { return fmt.Sprintf("%q plugin not found: %v", e.Name, e.Err) } func (e *NotFoundError) Unwrap() error { return e.Err } var testOnlyPluginPath string func openClientConnection(name, protocol string) (*clientConnection, error) { path := "age-plugin-" + name if testOnlyPluginPath != "" { path = filepath.Join(testOnlyPluginPath, path) } else if strings.ContainsRune(name, os.PathSeparator) { return nil, fmt.Errorf("invalid plugin name: %q", name) } cmd := exec.Command(path, "--age-plugin="+protocol) stdout, err := cmd.StdoutPipe() if err != nil { return nil, err } stdin, err := cmd.StdinPipe() if err != nil { return nil, err } cc := &clientConnection{ cmd: cmd, Reader: stdout, Writer: stdin, close: func() { stdin.Close() stdout.Close() }, } if os.Getenv("AGEDEBUG") == "plugin" { cc.Reader = io.TeeReader(cc.Reader, os.Stderr) cc.Writer = io.MultiWriter(cc.Writer, os.Stderr) cmd.Stderr = os.Stderr } // We don't want the plugins to rely on the working directory for anything // as different clients might treat it differently, so we set it to an empty // temporary directory. cmd.Dir = os.TempDir() if err := cmd.Start(); err != nil { if errors.Is(err, exec.ErrNotFound) { return nil, &NotFoundError{Name: name, Err: err} } return nil, err } return cc, nil } func (cc *clientConnection) Close() error { // Close stdin and stdout and send SIGINT (if supported) to the plugin, // then wait for it to cleanup and exit. cc.close() cc.cmd.Process.Signal(os.Interrupt) return cc.cmd.Wait() } func writeStanza(conn io.Writer, t string, args ...string) error { s := &format.Stanza{Type: t, Args: args} return s.Marshal(conn) } func writeStanzaWithBody(conn io.Writer, t string, body []byte) error { s := &format.Stanza{Type: t, Body: body} return s.Marshal(conn) } func writeGrease(conn io.Writer) (sent bool, err error) { if mathrand.IntN(3) == 0 { return false, nil } s := &format.Stanza{Type: fmt.Sprintf("grease-%x", mathrand.Int())} for i := 0; i < mathrand.IntN(3); i++ { s.Args = append(s.Args, fmt.Sprintf("%d", mathrand.IntN(100))) } if mathrand.IntN(2) == 0 { s.Body = make([]byte, mathrand.IntN(100)) rand.Read(s.Body) } return true, s.Marshal(conn) } ================================================ FILE: plugin/client_test.go ================================================ // Copyright 2023 The age Authors // // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file or at // https://developers.google.com/open-source/licenses/bsd package plugin import ( "bytes" "errors" "io" "os" "os/exec" "path/filepath" "runtime" "strings" "testing" "filippo.io/age" "filippo.io/age/internal/bech32" ) func TestMain(m *testing.M) { switch filepath.Base(os.Args[0]) { case "age-plugin-test": p, _ := New("test") p.HandleRecipient(func(data []byte) (age.Recipient, error) { return testRecipient{}, nil }) os.Exit(p.Main()) case "age-plugin-testpqc": p, _ := New("testpqc") p.HandleRecipient(func(data []byte) (age.Recipient, error) { return testPQCRecipient{}, nil }) os.Exit(p.Main()) case "age-plugin-error": p, _ := New("error") p.HandleRecipient(func(data []byte) (age.Recipient, error) { return nil, errors.New("oh my, an error occurred") }) p.HandleIdentity(func(data []byte) (age.Identity, error) { return nil, errors.New("oh my, an error occurred") }) os.Exit(p.Main()) default: os.Exit(m.Run()) } } type testRecipient struct{} func (testRecipient) Wrap(fileKey []byte) ([]*age.Stanza, error) { return []*age.Stanza{{Type: "test", Body: fileKey}}, nil } type testPQCRecipient struct{} var _ age.RecipientWithLabels = testPQCRecipient{} func (testPQCRecipient) Wrap(fileKey []byte) ([]*age.Stanza, error) { return []*age.Stanza{{Type: "test", Body: fileKey}}, nil } func (testPQCRecipient) WrapWithLabels(fileKey []byte) ([]*age.Stanza, []string, error) { return []*age.Stanza{{Type: "test", Body: fileKey}}, []string{"postquantum"}, nil } func TestLabels(t *testing.T) { if runtime.GOOS == "windows" { t.Skip("Windows support is TODO") } temp := t.TempDir() testOnlyPluginPath = temp t.Cleanup(func() { testOnlyPluginPath = "" }) ex, err := os.Executable() if err != nil { t.Fatal(err) } if err := os.Link(ex, filepath.Join(temp, "age-plugin-test")); err != nil { t.Fatal(err) } if err := os.Chmod(filepath.Join(temp, "age-plugin-test"), 0755); err != nil { t.Fatal(err) } if err := os.Link(ex, filepath.Join(temp, "age-plugin-testpqc")); err != nil { t.Fatal(err) } if err := os.Chmod(filepath.Join(temp, "age-plugin-testpqc"), 0755); err != nil { t.Fatal(err) } name, err := bech32.Encode("age1test", nil) if err != nil { t.Fatal(err) } testPlugin, err := NewRecipient(name, &ClientUI{}) if err != nil { t.Fatal(err) } namePQC, err := bech32.Encode("age1testpqc", nil) if err != nil { t.Fatal(err) } testPluginPQC, err := NewRecipient(namePQC, &ClientUI{}) if err != nil { t.Fatal(err) } if _, err := age.Encrypt(io.Discard, testPluginPQC); err != nil { t.Errorf("expected one pqc to work, got %v", err) } if _, err := age.Encrypt(io.Discard, testPluginPQC, testPluginPQC); err != nil { t.Errorf("expected two pqc to work, got %v", err) } if _, err := age.Encrypt(io.Discard, testPluginPQC, testPlugin); err == nil { t.Errorf("expected one pqc and one normal to fail") } if _, err := age.Encrypt(io.Discard, testPlugin, testPluginPQC); err == nil { t.Errorf("expected one pqc and one normal to fail") } } func TestNotFound(t *testing.T) { if runtime.GOOS == "windows" { t.Skip("Windows support is TODO") } r := EncodeRecipient("nonexistentplugin", nil) t.Log(r) testPluginRecipient, err := NewRecipient(r, &ClientUI{}) if err != nil { t.Fatal(err) } var e *NotFoundError if _, err := age.Encrypt(io.Discard, testPluginRecipient); err == nil { t.Errorf("expected error for nonexistent plugin") } else if !errors.As(err, &e) { t.Errorf("expected NotFoundError, got %T: %v", err, err) } else if e.Name != "nonexistentplugin" { t.Errorf("expected NotFoundError.Name to be nonexistentplugin, got %q", e.Name) } else if !errors.Is(err, exec.ErrNotFound) { t.Errorf("expected error to wrap exec.ErrNotFound, got: %v", err) } buf := &bytes.Buffer{} id, err := age.GenerateHybridIdentity() if err != nil { t.Fatal(err) } w, err := age.Encrypt(buf, id.Recipient()) if err != nil { t.Fatal(err) } w.Close() i := EncodeIdentity("nonexistentplugin", nil) t.Log(i) testPluginIdentity, err := NewIdentity(i, &ClientUI{}) if err != nil { t.Fatal(err) } if _, err := age.Decrypt(buf, testPluginIdentity); err == nil { t.Errorf("expected error for nonexistent plugin") } else if errors.As(err, new(*age.NoIdentityMatchError)) { t.Errorf("expected NotFoundError, got NoIdentityMatchError: %v", err) } else if !errors.As(err, &e) { t.Errorf("expected NotFoundError, got %T: %v", err, err) } else if e.Name != "nonexistentplugin" { t.Errorf("expected NotFoundError.Name to be nonexistentplugin, got %q", e.Name) } else if !errors.Is(err, exec.ErrNotFound) { t.Errorf("expected error to wrap exec.ErrNotFound, got: %v", err) } } func TestPluginError(t *testing.T) { if runtime.GOOS == "windows" { t.Skip("Windows support is TODO") } temp := t.TempDir() testOnlyPluginPath = temp t.Cleanup(func() { testOnlyPluginPath = "" }) ex, err := os.Executable() if err != nil { t.Fatal(err) } if err := os.Link(ex, filepath.Join(temp, "age-plugin-error")); err != nil { t.Fatal(err) } if err := os.Chmod(filepath.Join(temp, "age-plugin-error"), 0755); err != nil { t.Fatal(err) } r := EncodeRecipient("error", nil) testPluginRecipient, err := NewRecipient(r, &ClientUI{}) if err != nil { t.Fatal(err) } if _, err := age.Encrypt(io.Discard, testPluginRecipient); err == nil { t.Errorf("expected error from plugin") } else if !strings.Contains(err.Error(), "oh my, an error occurred") { t.Errorf("expected plugin error, got: %v", err) } buf := &bytes.Buffer{} id, err := age.GenerateHybridIdentity() if err != nil { t.Fatal(err) } w, err := age.Encrypt(buf, id.Recipient()) if err != nil { t.Fatal(err) } w.Close() i := EncodeIdentity("error", nil) testPluginIdentity, err := NewIdentity(i, &ClientUI{}) if err != nil { t.Fatal(err) } if _, err := age.Decrypt(buf, testPluginIdentity); err == nil { t.Errorf("expected error from plugin") } else if !strings.Contains(err.Error(), "oh my, an error occurred") { t.Errorf("expected plugin error, got: %v", err) } } ================================================ FILE: plugin/encode.go ================================================ // Copyright 2023 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package plugin import ( "crypto/ecdh" "crypto/mlkem" "fmt" "strings" "filippo.io/age/internal/bech32" "filippo.io/hpke" ) // EncodeIdentity encodes a plugin identity string for a plugin with the given // name. If the name is invalid, it returns an empty string. func EncodeIdentity(name string, data []byte) string { if !validPluginName(name) { return "" } s, _ := bech32.Encode("AGE-PLUGIN-"+strings.ToUpper(name)+"-", data) return s } // ParseIdentity decodes a plugin identity string. It returns the plugin name // in lowercase and the encoded data. func ParseIdentity(s string) (name string, data []byte, err error) { hrp, data, err := bech32.Decode(s) if err != nil { return "", nil, fmt.Errorf("invalid identity encoding: %v", err) } if !strings.HasPrefix(hrp, "AGE-PLUGIN-") || !strings.HasSuffix(hrp, "-") { return "", nil, fmt.Errorf("not a plugin identity: %v", err) } name = strings.TrimSuffix(strings.TrimPrefix(hrp, "AGE-PLUGIN-"), "-") name = strings.ToLower(name) if !validPluginName(name) { return "", nil, fmt.Errorf("invalid plugin name: %q", name) } return name, data, nil } // EncodeRecipient encodes a plugin recipient string for a plugin with the given // name. If the name is invalid, it returns an empty string. func EncodeRecipient(name string, data []byte) string { if !validPluginName(name) { return "" } s, _ := bech32.Encode("age1"+strings.ToLower(name), data) return s } // ParseRecipient decodes a plugin recipient string. It returns the plugin name // in lowercase and the encoded data. func ParseRecipient(s string) (name string, data []byte, err error) { hrp, data, err := bech32.Decode(s) if err != nil { return "", nil, fmt.Errorf("invalid recipient encoding: %v", err) } if !strings.HasPrefix(hrp, "age1") { return "", nil, fmt.Errorf("not a plugin recipient: %v", err) } name = strings.TrimPrefix(hrp, "age1") if !validPluginName(name) { return "", nil, fmt.Errorf("invalid plugin name: %q", name) } return name, data, nil } func validPluginName(name string) bool { if name == "" { return false } allowed := "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-._" for _, r := range name { if !strings.ContainsRune(allowed, r) { return false } } return true } // EncodeX25519Recipient encodes a native X25519 recipient from a // [crypto/ecdh.X25519] public key. It's meant for plugins that implement // identities that are compatible with native recipients. func EncodeX25519Recipient(pk *ecdh.PublicKey) (string, error) { if pk.Curve() != ecdh.X25519() { return "", fmt.Errorf("wrong ecdh Curve") } return bech32.Encode("age", pk.Bytes()) } // EncodeHybridRecipient encodes a native MLKEM768-X25519 recipient from a // [crypto/mlkem.EncapsulationKey768] and a [crypto/ecdh.X25519] public key. // It's meant for plugins that implement identities that are compatible with // native recipients. func EncodeHybridRecipient(pq *mlkem.EncapsulationKey768, t *ecdh.PublicKey) (string, error) { if t.Curve() != ecdh.X25519() { return "", fmt.Errorf("wrong ecdh Curve") } pk, err := hpke.NewHybridPublicKey(pq, t) if err != nil { return "", fmt.Errorf("failed to create hybrid public key: %v", err) } return bech32.Encode("age1pq", pk.Bytes()) } ================================================ FILE: plugin/example_test.go ================================================ package plugin_test import ( "log" "os" "filippo.io/age" "filippo.io/age/plugin" ) type Recipient struct{} func (r *Recipient) Wrap(fileKey []byte) ([]*age.Stanza, error) { panic("unimplemented") } func NewRecipient(data []byte) (*Recipient, error) { return &Recipient{}, nil } type Identity struct{} func (i *Identity) Unwrap(s []*age.Stanza) ([]byte, error) { panic("unimplemented") } func NewIdentity(data []byte) (*Identity, error) { return &Identity{}, nil } func ExamplePlugin_main() { p, err := plugin.New("example") if err != nil { log.Fatal(err) } p.HandleRecipient(func(data []byte) (age.Recipient, error) { return NewRecipient(data) }) p.HandleIdentity(func(data []byte) (age.Identity, error) { return NewIdentity(data) }) os.Exit(p.Main()) } ================================================ FILE: plugin/plugin.go ================================================ // Package plugin implements the age plugin protocol. // // [Recipient] and [Indentity] are plugin clients, that execute plugin binaries to // perform encryption and decryption operations. // // [Plugin] is a framework for writing age plugins, that exposes an [age.Recipient] // and/or [age.Identity] implementation as a plugin binary. package plugin import ( "bufio" "errors" "flag" "fmt" "io" "os" "strconv" "filippo.io/age" "filippo.io/age/internal/format" ) // TODO: add plugin test framework. // Plugin is a framework for writing age plugins. It allows exposing regular // [age.Recipient] and [age.Identity] implementations as plugins, and handles // all the protocol details. type Plugin struct { name string fs *flag.FlagSet sm *string recipient func([]byte) (age.Recipient, error) idAsRecipient func([]byte) (age.Recipient, error) identity func([]byte) (age.Identity, error) stdin io.Reader stdout, stderr io.Writer sr *format.StanzaReader // broken is set if the protocol broke down during an interaction function // called by a Recipient or Identity. broken bool } // New creates a new Plugin with the given name. // // For example, a plugin named "frood" would be invoked as "age-plugin-frood". func New(name string) (*Plugin, error) { return &Plugin{name: name, stdin: os.Stdin, stdout: os.Stdout, stderr: os.Stderr}, nil } // Name returns the name of the plugin. func (p *Plugin) Name() string { return p.name } // RegisterFlags registers the plugin's flags with the given [flag.FlagSet], or // with the default [flag.CommandLine] if fs is nil. It must be called before // [flag.Parse] and [Plugin.Main]. // // This allows the plugin to expose additional flags when invoked manually, for // example to implement a keygen mode. func (p *Plugin) RegisterFlags(fs *flag.FlagSet) { if fs == nil { fs = flag.CommandLine } p.fs = fs p.sm = fs.String("age-plugin", "", "age-plugin state machine") } // HandleRecipient registers a function to parse recipients of the form // age1name1... into [age.Recipient] values. data is the decoded Bech32 payload. // // If the returned Recipient implements [age.RecipientWithLabels], Plugin will // use it and enforce consistency across every returned stanza in an execution. // If the client supports labels, they will be passed through the protocol. // // It must be called before [Plugin.Main], and can be called at most once. // Otherwise, it panics. func (p *Plugin) HandleRecipient(f func(data []byte) (age.Recipient, error)) { if p.recipient != nil { panic("HandleRecipient called twice") } p.recipient = f } // HandleIdentityAsRecipient registers a function to parse identities of the // form AGE-PLUGIN-NAME-1... into [age.Recipient] values, for when identities // are used as recipients. data is the decoded Bech32 payload. // // If the returned Recipient implements [age.RecipientWithLabels], Plugin will // use it and enforce consistency across every returned stanza in an execution. // If the client supports labels, they will be passed through the protocol. // // It must be called before [Plugin.Main], and can be called at most once. // Otherwise, it panics. func (p *Plugin) HandleIdentityAsRecipient(f func(data []byte) (age.Recipient, error)) { if p.idAsRecipient != nil { panic("HandleIdentityAsRecipient called twice") } p.idAsRecipient = f } // HandleIdentity registers a function to parse identities of the form // AGE-PLUGIN-NAME-1... into [age.Identity] values. data is the decoded Bech32 // payload. // // It must be called before [Plugin.Main], and can be called at most once. // Otherwise, it panics. func (p *Plugin) HandleIdentity(f func(data []byte) (age.Identity, error)) { if p.identity != nil { panic("HandleIdentity called twice") } p.identity = f } // HandleRecipientEncoding is like [Plugin.HandleRecipient] but provides the // full recipient encoding string to the callback. // // It allows using functions like ParseRecipient directly. func (p *Plugin) HandleRecipientEncoding(f func(recipient string) (age.Recipient, error)) { p.HandleRecipient(func(data []byte) (age.Recipient, error) { return f(EncodeRecipient(p.name, data)) }) } // HandleIdentityEncodingAsRecipient is like [Plugin.HandleIdentityAsRecipient] but // provides the full identity encoding string to the callback. func (p *Plugin) HandleIdentityEncodingAsRecipient(f func(identity string) (age.Recipient, error)) { p.HandleIdentityAsRecipient(func(data []byte) (age.Recipient, error) { return f(EncodeIdentity(p.name, data)) }) } // HandleIdentityEncoding is like [Plugin.HandleIdentity] but provides the // full identity encoding string to the callback. // // It allows using functions like ParseIdentity directly. func (p *Plugin) HandleIdentityEncoding(f func(identity string) (age.Identity, error)) { p.HandleIdentity(func(data []byte) (age.Identity, error) { return f(EncodeIdentity(p.name, data)) }) } // Main runs the plugin protocol. It returns an exit code to pass to os.Exit. // // It automatically calls [Plugin.RegisterFlags] and [flag.Parse] if they were // not called before. func (p *Plugin) Main() int { if p.fs == nil { p.RegisterFlags(nil) } if !p.fs.Parsed() { p.fs.Parse(os.Args[1:]) } if *p.sm == "recipient-v1" { return p.RecipientV1() } if *p.sm == "identity-v1" { return p.IdentityV1() } fmt.Fprintf(p.stderr, "unknown state machine %q", *p.sm) return 4 } // SetIO sets the plugin's input and output streams, which default to // stdin/stdout/stderr. // // It must be called before [Plugin.Main]. func (p *Plugin) SetIO(stdin io.Reader, stdout, stderr io.Writer) { p.stdin = stdin p.stdout = stdout p.stderr = stderr } // RecipientV1 implements the recipient-v1 state machine. It returns an exit // code to pass to os.Exit. // // Most plugins should call [Plugin.Main] instead of this method. func (p *Plugin) RecipientV1() int { if p.recipient == nil && p.idAsRecipient == nil { return p.fatalf("recipient-v1 not supported") } var recipientStrings, identityStrings []string var fileKeys [][]byte var supportsLabels bool p.sr = format.NewStanzaReader(bufio.NewReader(p.stdin)) ReadLoop: for { s, err := p.sr.ReadStanza() if err != nil { return p.fatalf("failed to read stanza: %v", err) } switch s.Type { case "add-recipient": if err := expectStanzaWithNoBody(s, 1); err != nil { return p.fatalf("%v", err) } recipientStrings = append(recipientStrings, s.Args[0]) case "add-identity": if err := expectStanzaWithNoBody(s, 1); err != nil { return p.fatalf("%v", err) } identityStrings = append(identityStrings, s.Args[0]) case "extension-labels": if err := expectStanzaWithNoBody(s, 0); err != nil { return p.fatalf("%v", err) } supportsLabels = true case "wrap-file-key": if err := expectStanzaWithBody(s, 0); err != nil { return p.fatalf("%v", err) } fileKeys = append(fileKeys, s.Body) case "done": if err := expectStanzaWithNoBody(s, 0); err != nil { return p.fatalf("%v", err) } break ReadLoop default: // Unsupported stanzas in uni-directional phases are ignored. } } if len(recipientStrings)+len(identityStrings) == 0 { return p.fatalf("no recipients or identities provided") } if len(fileKeys) == 0 { return p.fatalf("no file keys provided") } var recipients, identities []age.Recipient for i, s := range recipientStrings { name, data, err := ParseRecipient(s) if err != nil { return p.recipientError(i, err) } if name != p.name { return p.recipientError(i, fmt.Errorf("unsupported plugin name: %q", name)) } if p.recipient == nil { return p.recipientError(i, fmt.Errorf("recipient encodings not supported")) } r, err := p.recipient(data) if err != nil { return p.recipientError(i, err) } recipients = append(recipients, r) } for i, s := range identityStrings { name, data, err := ParseIdentity(s) if err != nil { return p.identityError(i, err) } if name != p.name { return p.identityError(i, fmt.Errorf("unsupported plugin name: %q", name)) } if p.idAsRecipient == nil { return p.identityError(i, fmt.Errorf("identity encodings not supported")) } r, err := p.idAsRecipient(data) if err != nil { return p.identityError(i, err) } identities = append(identities, r) } // Technically labels should be per-file key, but the client-side protocol // extension shipped like this, and it doesn't feel worth making a v2. var labels []string stanzas := make([][]*age.Stanza, len(fileKeys)) for i, fk := range fileKeys { for j, r := range recipients { ss, ll, err := wrapWithLabels(r, fk) if p.broken { return 2 } else if err != nil { return p.recipientError(j, err) } if i == 0 && j == 0 { labels = ll } else if err := checkLabels(ll, labels); err != nil { return p.recipientError(j, err) } stanzas[i] = append(stanzas[i], ss...) } for j, r := range identities { ss, ll, err := wrapWithLabels(r, fk) if p.broken { return 2 } else if err != nil { return p.identityError(j, err) } if i == 0 && j == 0 && len(recipients) == 0 { labels = ll } else if err := checkLabels(ll, labels); err != nil { return p.identityError(j, err) } stanzas[i] = append(stanzas[i], ss...) } } if sent, err := writeGrease(p.stdout); err != nil { return p.fatalf("failed to write grease: %v", err) } else if sent { if err := expectUnsupported(p.sr); err != nil { return p.fatalf("%v", err) } } if supportsLabels { if err := writeStanza(p.stdout, "labels", labels...); err != nil { return p.fatalf("failed to write labels stanza: %v", err) } if err := expectOk(p.sr); err != nil { return p.fatalf("%v", err) } } for i, ss := range stanzas { for _, s := range ss { if err := (&format.Stanza{Type: "recipient-stanza", Args: append([]string{fmt.Sprint(i), s.Type}, s.Args...), Body: s.Body}).Marshal(p.stdout); err != nil { return p.fatalf("failed to write recipient-stanza: %v", err) } if err := expectOk(p.sr); err != nil { return p.fatalf("%v", err) } } if sent, err := writeGrease(p.stdout); err != nil { return p.fatalf("failed to write grease: %v", err) } else if sent { if err := expectUnsupported(p.sr); err != nil { return p.fatalf("%v", err) } } } if err := writeStanza(p.stdout, "done"); err != nil { return p.fatalf("failed to write done stanza: %v", err) } return 0 } func wrapWithLabels(r age.Recipient, fileKey []byte) ([]*age.Stanza, []string, error) { if r, ok := r.(age.RecipientWithLabels); ok { return r.WrapWithLabels(fileKey) } s, err := r.Wrap(fileKey) return s, nil, err } func checkLabels(ll, labels []string) error { if !slicesEqual(ll, labels) { return fmt.Errorf("labels %q do not match previous recipients %q", ll, labels) } return nil } // IdentityV1 implements the identity-v1 state machine. It returns an exit code // to pass to os.Exit. // // Most plugins should call [Plugin.Main] instead of this method. func (p *Plugin) IdentityV1() int { if p.identity == nil { return p.fatalf("identity-v1 not supported") } var files [][]*age.Stanza var identityStrings []string p.sr = format.NewStanzaReader(bufio.NewReader(p.stdin)) ReadLoop: for { s, err := p.sr.ReadStanza() if err != nil { return p.fatalf("failed to read stanza: %v", err) } switch s.Type { case "add-identity": if err := expectStanzaWithNoBody(s, 1); err != nil { return p.fatalf("%v", err) } identityStrings = append(identityStrings, s.Args[0]) case "recipient-stanza": if len(s.Args) < 2 { return p.fatalf("recipient-stanza stanza has %d arguments, want >=2", len(s.Args)) } i, err := strconv.Atoi(s.Args[0]) if err != nil { return p.fatalf("failed to parse recipient-stanza stanza argument: %v", err) } ss := &age.Stanza{Type: s.Args[1], Args: s.Args[2:], Body: s.Body} switch i { case len(files): files = append(files, []*age.Stanza{ss}) case len(files) - 1: files[len(files)-1] = append(files[len(files)-1], ss) default: return p.fatalf("unexpected file index %d, previous was %d", i, len(files)-1) } case "done": if err := expectStanzaWithNoBody(s, 0); err != nil { return p.fatalf("%v", err) } break ReadLoop default: // Unsupported stanzas in uni-directional phases are ignored. } } if len(identityStrings) == 0 { return p.fatalf("no identities provided") } if len(files) == 0 { return p.fatalf("no stanzas provided") } var identities []age.Identity for i, s := range identityStrings { name, data, err := ParseIdentity(s) if err != nil { return p.identityError(i, err) } if name != p.name { return p.identityError(i, fmt.Errorf("unsupported plugin name: %q", name)) } if p.identity == nil { return p.identityError(i, fmt.Errorf("identity encodings not supported")) } r, err := p.identity(data) if err != nil { return p.identityError(i, err) } identities = append(identities, r) } for i, ss := range files { if sent, err := writeGrease(p.stdout); err != nil { return p.fatalf("failed to write grease: %v", err) } else if sent { if err := expectUnsupported(p.sr); err != nil { return p.fatalf("%v", err) } } // TODO: there should be a mechanism to let the plugin decide the order // in which identities are tried. for _, id := range identities { fk, err := id.Unwrap(ss) if p.broken { return 2 } else if errors.Is(err, age.ErrIncorrectIdentity) { continue } else if err != nil { if err := p.writeError([]string{"stanza", fmt.Sprint(i), "0"}, err); err != nil { return p.fatalf("%v", err) } // Note that we don't exit here, as the protocol allows // continuing with other files. break } s := &format.Stanza{Type: "file-key", Args: []string{fmt.Sprint(i)}, Body: fk} if err := s.Marshal(p.stdout); err != nil { return p.fatalf("failed to write file-key: %v", err) } if err := expectOk(p.sr); err != nil { return p.fatalf("%v", err) } break } } if err := writeStanza(p.stdout, "done"); err != nil { return p.fatalf("failed to write done stanza: %v", err) } return 0 } // DisplayMessage requests that the client display a message to the user. The // message should start with a lowercase letter and have no final period. // DisplayMessage returns an error if the client can't display the message, and // may return before the message has been displayed to the user. // // It must only be called by a Wrap or Unwrap method invoked by [Plugin.Main]. func (p *Plugin) DisplayMessage(message string) error { if err := writeStanzaWithBody(p.stdout, "msg", []byte(message)); err != nil { return p.fatalInteractf("failed to write msg stanza: %v", err) } s, err := readOkOrFail(p.sr) if err != nil { return p.fatalInteractf("%v", err) } if s.Type == "fail" { return fmt.Errorf("client failed to display message") } if err := expectStanzaWithNoBody(s, 0); err != nil { return p.fatalInteractf("%v", err) } return nil } // RequestValue requests a secret or public input from the user through the // client, with the provided prompt. It returns an error if the client can't // request the input or if the user dismisses the prompt. // // It must only be called by a Wrap or Unwrap method invoked by [Plugin.Main]. func (p *Plugin) RequestValue(prompt string, secret bool) (string, error) { t := "request-public" if secret { t = "request-secret" } if err := writeStanzaWithBody(p.stdout, t, []byte(prompt)); err != nil { return "", p.fatalInteractf("failed to write stanza: %v", err) } s, err := readOkOrFail(p.sr) if err != nil { return "", p.fatalInteractf("%v", err) } if s.Type == "fail" { return "", fmt.Errorf("client failed to request value") } if err := expectStanzaWithBody(s, 0); err != nil { return "", p.fatalInteractf("%v", err) } return string(s.Body), nil } // Confirm requests a confirmation from the user through the client, with the // provided prompt. The yes and no value are the choices provided to the user. // no may be empty. The return value choseYes indicates whether the user // selected the yes or no option. Confirm returns an error if the client can't // request the confirmation. // // It must only be called by a Wrap or Unwrap method invoked by [Plugin.Main]. func (p *Plugin) Confirm(prompt, yes, no string) (choseYes bool, err error) { args := []string{format.EncodeToString([]byte(yes))} if no != "" { args = append(args, format.EncodeToString([]byte(no))) } s := &format.Stanza{Type: "confirm", Args: args, Body: []byte(prompt)} if err := s.Marshal(p.stdout); err != nil { return false, p.fatalInteractf("failed to write confirm stanza: %v", err) } s, err = readOkOrFail(p.sr) if err != nil { return false, p.fatalInteractf("%v", err) } if s.Type == "fail" { return false, fmt.Errorf("client failed to request confirmation") } if err := expectStanzaWithNoBody(s, 1); err != nil { return false, p.fatalInteractf("%v", err) } return s.Args[0] == "yes", nil } // fatalInteractf prints the error to stderr and sets the broken flag, so the // Wrap/Unwrap caller can exit with an error. func (p *Plugin) fatalInteractf(format string, args ...any) error { p.broken = true fmt.Fprintf(p.stderr, format, args...) return fmt.Errorf(format, args...) } func (p *Plugin) fatalf(format string, args ...any) int { fmt.Fprintf(p.stderr, format, args...) return 1 } func expectStanzaWithNoBody(s *format.Stanza, wantArgs int) error { if len(s.Args) != wantArgs { return fmt.Errorf("%s stanza has %d arguments, want %d", s.Type, len(s.Args), wantArgs) } if len(s.Body) != 0 { return fmt.Errorf("%s stanza has %d bytes of body, want 0", s.Type, len(s.Body)) } return nil } func expectStanzaWithBody(s *format.Stanza, wantArgs int) error { if len(s.Args) != wantArgs { return fmt.Errorf("%s stanza has %d arguments, want %d", s.Type, len(s.Args), wantArgs) } if len(s.Body) == 0 { return fmt.Errorf("%s stanza has 0 bytes of body, want >0", s.Type) } return nil } func (p *Plugin) recipientError(idx int, err error) int { if err := p.writeError([]string{"recipient", fmt.Sprint(idx)}, err); err != nil { return p.fatalf("%v", err) } return 3 } func (p *Plugin) identityError(idx int, err error) int { if err := p.writeError([]string{"identity", fmt.Sprint(idx)}, err); err != nil { return p.fatalf("%v", err) } return 3 } func expectOk(sr *format.StanzaReader) error { ok, err := sr.ReadStanza() if err != nil { return fmt.Errorf("failed to read OK stanza: %v", err) } if ok.Type != "ok" { return fmt.Errorf("expected OK stanza, got %q", ok.Type) } return expectStanzaWithNoBody(ok, 0) } func readOkOrFail(sr *format.StanzaReader) (*format.Stanza, error) { s, err := sr.ReadStanza() if err != nil { return nil, fmt.Errorf("failed to read response stanza: %v", err) } switch s.Type { case "fail": if err := expectStanzaWithNoBody(s, 0); err != nil { return nil, fmt.Errorf("%v", err) } return s, nil case "ok": return s, nil default: return nil, fmt.Errorf("expected ok or fail stanza, got %q", s.Type) } } func expectUnsupported(sr *format.StanzaReader) error { unsupported, err := sr.ReadStanza() if err != nil { return fmt.Errorf("failed to read unsupported stanza: %v", err) } if unsupported.Type != "unsupported" { return fmt.Errorf("expected unsupported stanza, got %q", unsupported.Type) } return expectStanzaWithNoBody(unsupported, 0) } func (p *Plugin) writeError(args []string, err error) error { s := &format.Stanza{Type: "error", Args: args} s.Body = []byte(err.Error()) if err := s.Marshal(p.stdout); err != nil { return fmt.Errorf("failed to write error stanza: %v", err) } if err := expectOk(p.sr); err != nil { return fmt.Errorf("%v", err) } return nil } func slicesEqual(s1, s2 []string) bool { if len(s1) != len(s2) { return false } for i := range s1 { if s1[i] != s2[i] { return false } } return true } ================================================ FILE: plugin/tui.go ================================================ package plugin import ( "errors" "fmt" "filippo.io/age/internal/term" ) // NewTerminalUI returns a [ClientUI] that uses the terminal to request inputs, // and the provided functions to display messages and errors. // // The terminal is reached directly through /dev/tty or CONIN$/CONOUT$, // bypassing standard input and output, so this UI can be used even when // standard input or output are redirected. func NewTerminalUI(printf, warningf func(format string, v ...any)) *ClientUI { return &ClientUI{ DisplayMessage: func(name, message string) error { printf("%s plugin: %s", name, message) return nil }, RequestValue: func(name, message string, isSecret bool) (s string, err error) { defer func() { if err != nil { warningf("could not read value for age-plugin-%s: %v", name, err) } }() if isSecret { secret, err := term.ReadSecret(message) if err != nil { return "", err } return string(secret), nil } else { public, err := term.ReadPublic(message) if err != nil { return "", err } return string(public), nil } }, Confirm: func(name, message, yes, no string) (choseYes bool, err error) { defer func() { if err != nil { warningf("could not read value for age-plugin-%s: %v", name, err) } }() if no == "" { message += fmt.Sprintf(" (press enter for %q)", yes) _, err := term.ReadSecret(message) if err != nil { return false, err } return true, nil } message += fmt.Sprintf(" (press [1] for %q or [2] for %q)", yes, no) for { selection, err := term.ReadCharacter(message) if err != nil { return false, err } switch selection { case '1': return true, nil case '2': return false, nil case '\x03': // CTRL-C return false, errors.New("user cancelled prompt") default: warningf("reading value for age-plugin-%s: invalid selection %q", name, selection) } } }, WaitTimer: func(name string) { printf("waiting on %s plugin...", name) }, } } ================================================ FILE: pq.go ================================================ // Copyright 2025 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package age import ( "errors" "fmt" "strings" "filippo.io/age/internal/bech32" "filippo.io/age/internal/format" "filippo.io/hpke" "golang.org/x/crypto/chacha20poly1305" ) const pqLabel = "age-encryption.org/mlkem768x25519" // HybridRecipient is the standard age public key. Messages encrypted to // this recipient can be decrypted with the corresponding [HybridIdentity]. // // This recipient is safe against future cryptographically-relevant quantum // computers, and can only be used along with other post-quantum recipients. // // This recipient is anonymous, in the sense that an attacker can't tell from // the message alone if it is encrypted to a certain recipient. type HybridRecipient struct { pk hpke.PublicKey } var _ Recipient = &HybridRecipient{} // newHybridRecipient returns a new [HybridRecipient] from a raw HPKE public key. func newHybridRecipient(publicKey []byte) (*HybridRecipient, error) { pk, err := hpke.MLKEM768X25519().NewPublicKey(publicKey) if err != nil { return nil, errors.New("invalid MLKEM768-X25519 public key") } return &HybridRecipient{pk: pk}, nil } // ParseHybridRecipient returns a new [HybridRecipient] from a Bech32 public key // encoding with the "age1pq1" prefix. func ParseHybridRecipient(s string) (*HybridRecipient, error) { t, k, err := bech32.Decode(s) if err != nil { return nil, fmt.Errorf("malformed recipient %q: %v", s, err) } if t != "age1pq" { return nil, fmt.Errorf("malformed recipient %q: invalid type %q", s, t) } r, err := newHybridRecipient(k) if err != nil { return nil, fmt.Errorf("malformed recipient %q: %v", s, err) } return r, nil } func (r *HybridRecipient) Wrap(fileKey []byte) ([]*Stanza, error) { s, _, err := r.WrapWithLabels(fileKey) return s, err } // WrapWithLabels implements [RecipientWithLabels], returning a single // "postquantum" label. This ensures a HybridRecipient can't be mixed with other // recipients that would defeat its post-quantum security. // // To unsafely bypass this restriction, wrap HybridRecipient in a [Recipient] // type that doesn't expose WrapWithLabels. func (r *HybridRecipient) WrapWithLabels(fileKey []byte) ([]*Stanza, []string, error) { enc, s, err := hpke.NewSender(r.pk, hpke.HKDFSHA256(), hpke.ChaCha20Poly1305(), []byte(pqLabel)) if err != nil { return nil, nil, fmt.Errorf("failed to set up HPKE sender: %v", err) } ct, err := s.Seal(nil, fileKey) if err != nil { return nil, nil, fmt.Errorf("failed to encrypt file key: %v", err) } l := &Stanza{ Type: "mlkem768x25519", Args: []string{format.EncodeToString(enc)}, Body: ct, } return []*Stanza{l}, []string{"postquantum"}, nil } // String returns the Bech32 public key encoding of r. func (r *HybridRecipient) String() string { s, _ := bech32.Encode("age1pq", r.pk.Bytes()) return s } // HybridIdentity is the standard age private key, which can decrypt messages // encrypted to the corresponding [HybridRecipient]. type HybridIdentity struct { k hpke.PrivateKey } var _ Identity = &HybridIdentity{} // newHybridIdentity returns a new [HybridIdentity] from a raw HPKE private key. func newHybridIdentity(secretKey []byte) (*HybridIdentity, error) { k, err := hpke.MLKEM768X25519().NewPrivateKey(secretKey) if err != nil { return nil, errors.New("invalid MLKEM768-X25519 secret key") } return &HybridIdentity{k: k}, nil } // GenerateHybridIdentity randomly generates a new [HybridIdentity]. func GenerateHybridIdentity() (*HybridIdentity, error) { k, err := hpke.MLKEM768X25519().GenerateKey() if err != nil { return nil, fmt.Errorf("failed to generate post-quantum identity: %v", err) } return &HybridIdentity{k: k}, nil } // ParseHybridIdentity returns a new [HybridIdentity] from a Bech32 private key // encoding with the "AGE-SECRET-KEY-PQ-1" prefix. func ParseHybridIdentity(s string) (*HybridIdentity, error) { t, k, err := bech32.Decode(s) if err != nil { return nil, fmt.Errorf("malformed secret key: %v", err) } if t != "AGE-SECRET-KEY-PQ-" { return nil, fmt.Errorf("malformed secret key: unknown type %q", t) } r, err := newHybridIdentity(k) if err != nil { return nil, fmt.Errorf("malformed secret key: %v", err) } return r, nil } func (i *HybridIdentity) Unwrap(stanzas []*Stanza) ([]byte, error) { return multiUnwrap(i.unwrap, stanzas) } func (i *HybridIdentity) unwrap(block *Stanza) ([]byte, error) { if block.Type != "mlkem768x25519" { return nil, ErrIncorrectIdentity } if len(block.Args) != 1 { return nil, errors.New("invalid mlkem768x25519 recipient block") } enc, err := format.DecodeString(block.Args[0]) if err != nil { return nil, fmt.Errorf("failed to parse mlkem768x25519 recipient: %v", err) } if len(block.Body) != fileKeySize+chacha20poly1305.Overhead { return nil, errIncorrectCiphertextSize } r, err := hpke.NewRecipient(enc, i.k, hpke.HKDFSHA256(), hpke.ChaCha20Poly1305(), []byte(pqLabel)) if err != nil { // MLKEM768-X25519 does implicit rejection, so a mismatched key does not // hit this error path, but is only detected later when trying to open. return nil, fmt.Errorf("invalid mlkem768x25519 recipient: %v", err) } fileKey, err := r.Open(nil, block.Body) if err != nil { return nil, ErrIncorrectIdentity } return fileKey, nil } // Recipient returns the public [HybridRecipient] value corresponding to i. func (i *HybridIdentity) Recipient() *HybridRecipient { return &HybridRecipient{pk: i.k.PublicKey()} } // String returns the Bech32 private key encoding of i. func (i *HybridIdentity) String() string { b, _ := i.k.Bytes() s, _ := bech32.Encode("AGE-SECRET-KEY-PQ-", b) return strings.ToUpper(s) } ================================================ FILE: primitives.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package age import ( "crypto/hmac" "crypto/sha256" "errors" "io" "filippo.io/age/internal/format" "golang.org/x/crypto/chacha20poly1305" "golang.org/x/crypto/hkdf" ) // aeadEncrypt encrypts a message with a one-time key. func aeadEncrypt(key, plaintext []byte) ([]byte, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } // The nonce is fixed because this function is only used in places where the // spec guarantees each key is only used once (by deriving it from values // that include fresh randomness), allowing us to save the overhead. // For the code that encrypts the actual payload, look at the // filippo.io/age/internal/stream package. nonce := make([]byte, chacha20poly1305.NonceSize) return aead.Seal(nil, nonce, plaintext, nil), nil } var errIncorrectCiphertextSize = errors.New("encrypted value has unexpected length") // aeadDecrypt decrypts a message of an expected fixed size. // // The message size is limited to mitigate multi-key attacks, where a ciphertext // can be crafted that decrypts successfully under multiple keys. Short // ciphertexts can only target two keys, which has limited impact. func aeadDecrypt(key []byte, size int, ciphertext []byte) ([]byte, error) { aead, err := chacha20poly1305.New(key) if err != nil { return nil, err } if len(ciphertext) != size+aead.Overhead() { return nil, errIncorrectCiphertextSize } nonce := make([]byte, chacha20poly1305.NonceSize) return aead.Open(nil, nonce, ciphertext, nil) } func headerMAC(fileKey []byte, hdr *format.Header) ([]byte, error) { h := hkdf.New(sha256.New, fileKey, nil, []byte("header")) hmacKey := make([]byte, 32) if _, err := io.ReadFull(h, hmacKey); err != nil { return nil, err } hh := hmac.New(sha256.New, hmacKey) if err := hdr.MarshalWithoutMAC(hh); err != nil { return nil, err } return hh.Sum(nil), nil } func streamKey(fileKey, nonce []byte) []byte { h := hkdf.New(sha256.New, fileKey, nonce, []byte("payload")) streamKey := make([]byte, chacha20poly1305.KeySize) if _, err := io.ReadFull(h, streamKey); err != nil { panic("age: internal error: failed to read from HKDF: " + err.Error()) } return streamKey } ================================================ FILE: recipients_test.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package age_test import ( "bytes" "crypto/rand" "io" "testing" "filippo.io/age" ) func TestX25519RoundTrip(t *testing.T) { i, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } r := i.Recipient() if r1, err := age.ParseX25519Recipient(r.String()); err != nil { t.Fatal(err) } else if r1.String() != r.String() { t.Errorf("recipient did not round-trip through parsing: got %q, want %q", r1, r) } if i1, err := age.ParseX25519Identity(i.String()); err != nil { t.Fatal(err) } else if i1.String() != i.String() { t.Errorf("identity did not round-trip through parsing: got %q, want %q", i1, i) } fileKey := make([]byte, 16) if _, err := rand.Read(fileKey); err != nil { t.Fatal(err) } stanzas, err := r.Wrap(fileKey) if err != nil { t.Fatal(err) } out, err := i.Unwrap(stanzas) if err != nil { t.Fatal(err) } if !bytes.Equal(fileKey, out) { t.Errorf("invalid output: %x, expected %x", out, fileKey) } } func TestHybridRoundTrip(t *testing.T) { i, err := age.GenerateHybridIdentity() if err != nil { t.Fatal(err) } r := i.Recipient() if r1, err := age.ParseHybridRecipient(r.String()); err != nil { t.Fatal(err) } else if r1.String() != r.String() { t.Errorf("recipient did not round-trip through parsing: got %q, want %q", r1, r) } if i1, err := age.ParseHybridIdentity(i.String()); err != nil { t.Fatal(err) } else if i1.String() != i.String() { t.Errorf("identity did not round-trip through parsing: got %q, want %q", i1, i) } fileKey := make([]byte, 16) if _, err := rand.Read(fileKey); err != nil { t.Fatal(err) } stanzas, err := r.Wrap(fileKey) if err != nil { t.Fatal(err) } out, err := i.Unwrap(stanzas) if err != nil { t.Fatal(err) } if !bytes.Equal(fileKey, out) { t.Errorf("invalid output: %x, expected %x", out, fileKey) } } func TestHybridMixingRestrictions(t *testing.T) { x25519, err := age.GenerateX25519Identity() if err != nil { t.Fatal(err) } hybrid, err := age.GenerateHybridIdentity() if err != nil { t.Fatal(err) } // Hybrid recipients can be used together. if _, err := age.Encrypt(io.Discard, hybrid.Recipient(), hybrid.Recipient()); err != nil { t.Errorf("expected two hybrid recipients to work, got %v", err) } // Hybrid and X25519 recipients cannot be mixed. if _, err := age.Encrypt(io.Discard, hybrid.Recipient(), x25519.Recipient()); err == nil { t.Error("expected hybrid mixed with X25519 to fail") } if _, err := age.Encrypt(io.Discard, x25519.Recipient(), hybrid.Recipient()); err == nil { t.Error("expected X25519 mixed with hybrid to fail") } } func TestScryptRoundTrip(t *testing.T) { password := "twitch.tv/filosottile" r, err := age.NewScryptRecipient(password) if err != nil { t.Fatal(err) } r.SetWorkFactor(15) i, err := age.NewScryptIdentity(password) if err != nil { t.Fatal(err) } fileKey := make([]byte, 16) if _, err := rand.Read(fileKey); err != nil { t.Fatal(err) } stanzas, err := r.Wrap(fileKey) if err != nil { t.Fatal(err) } out, err := i.Unwrap(stanzas) if err != nil { t.Fatal(err) } if !bytes.Equal(fileKey, out) { t.Errorf("invalid output: %x, expected %x", out, fileKey) } } ================================================ FILE: scrypt.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package age import ( "crypto/rand" "encoding/hex" "errors" "fmt" "regexp" "strconv" "filippo.io/age/internal/format" "golang.org/x/crypto/chacha20poly1305" "golang.org/x/crypto/scrypt" ) const scryptLabel = "age-encryption.org/v1/scrypt" // ScryptRecipient is a password-based recipient. Anyone with the password can // decrypt the message. // // If a ScryptRecipient is used, it must be the only recipient for the file: it // can't be mixed with other recipient types and can't be used multiple times // for the same file. // // Its use is not recommended for automated systems, which should prefer // [HybridRecipient] or [X25519Recipient]. type ScryptRecipient struct { password []byte workFactor int } var _ Recipient = &ScryptRecipient{} // NewScryptRecipient returns a new ScryptRecipient with the provided password. func NewScryptRecipient(password string) (*ScryptRecipient, error) { if len(password) == 0 { return nil, errors.New("passphrase can't be empty") } r := &ScryptRecipient{ password: []byte(password), // TODO: automatically scale this to 1s (with a min) in the CLI. workFactor: 18, // 1s on a modern machine } return r, nil } // SetWorkFactor sets the scrypt work factor to 2^logN. // It must be called before Wrap. // // If SetWorkFactor is not called, a reasonable default is used. func (r *ScryptRecipient) SetWorkFactor(logN int) { if logN > 30 || logN < 1 { panic("age: SetWorkFactor called with illegal value") } r.workFactor = logN } const scryptSaltSize = 16 func (r *ScryptRecipient) Wrap(fileKey []byte) ([]*Stanza, error) { salt := make([]byte, scryptSaltSize) if _, err := rand.Read(salt[:]); err != nil { return nil, err } logN := r.workFactor l := &Stanza{ Type: "scrypt", Args: []string{format.EncodeToString(salt), strconv.Itoa(logN)}, } salt = append([]byte(scryptLabel), salt...) k, err := scrypt.Key(r.password, salt, 1< 30 || logN < 1 { panic("age: SetMaxWorkFactor called with illegal value") } i.maxWorkFactor = logN } func (i *ScryptIdentity) Unwrap(stanzas []*Stanza) ([]byte, error) { for _, s := range stanzas { if s.Type == "scrypt" && len(stanzas) != 1 { return nil, errors.New("an scrypt recipient must be the only one") } } for _, s := range stanzas { if s.Type != "scrypt" { continue } return i.unwrap(s) } return nil, fmt.Errorf("%w: file is not passphrase-encrypted", ErrIncorrectIdentity) } var digitsRe = regexp.MustCompile(`^[1-9][0-9]*$`) func (i *ScryptIdentity) unwrap(block *Stanza) ([]byte, error) { if block.Type != "scrypt" { return nil, errors.New("internal error: unwrap called on non-scrypt stanza") } if len(block.Args) != 2 { return nil, errors.New("invalid scrypt recipient block") } salt, err := format.DecodeString(block.Args[0]) if err != nil { return nil, fmt.Errorf("failed to parse scrypt salt: %v", err) } if len(salt) != scryptSaltSize { return nil, errors.New("invalid scrypt recipient block") } if w := block.Args[1]; !digitsRe.MatchString(w) { return nil, fmt.Errorf("scrypt work factor encoding invalid: %q", w) } logN, err := strconv.Atoi(block.Args[1]) if err != nil { return nil, fmt.Errorf("failed to parse scrypt work factor: %v", err) } if logN > i.maxWorkFactor { return nil, fmt.Errorf("scrypt work factor too large: %v", logN) } if logN <= 0 { // unreachable return nil, fmt.Errorf("invalid scrypt work factor: %v", logN) } salt = append([]byte(scryptLabel), salt...) k, err := scrypt.Key(i.password, salt, 1< X25519 8hrlM+ZBG3Dd4fF2+a583zdTIWDk8/R41kCYZsvwTW4 yO4PYdlMWDJ+CxgUNRqY5Z0T/m+g3FCh5jIxGLbCVXc --- I/imevZzy8120JSzmJnmn/KMk3p5A11V83Nk41m9NPE p6$RS,ZʲsMaw8 Az"r\w41;u ================================================ FILE: testdata/example.zip.age ================================================ age-encryption.org/v1 -> X25519 5CD81lZA72aQi0v6EnniOGkwaswpZ0AxCZNdiUVzP04 ol9DvdkiZWeRI4vMKRBVNxowDKwir4UPqYinSM5zqUI --- 2tyNGCaPoT6UnuOy7sQJf1eXn4pb7z2ukSgTDIxrJxU W dtUbT0(yKAPdr1M~ kX>c܍[$9, G{턚Ftk*}9TޱhLЏW-RdˣHSdUĚFsÈ2y+)]/,k=8(XRA01RY k4N6tvbc _F0dvx $X~ / ================================================ FILE: testdata/example_keys.txt ================================================ # Test key for ExampleParseIdentities. AGE-SECRET-KEY-184JMZMVQH3E6U0PSL869004Y3U2NYV7R30EU99CSEDNPH02YUVFSZW44VU ================================================ FILE: testkit_test.go ================================================ // Copyright 2022 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. //go:build go1.18 package age_test import ( "bytes" "compress/zlib" "crypto/sha256" "encoding/hex" "errors" "io" "io/fs" "strings" "testing" "filippo.io/age" "filippo.io/age/armor" "filippo.io/age/internal/format" "filippo.io/age/internal/inspect" "filippo.io/age/internal/stream" "golang.org/x/crypto/chacha20poly1305" "golang.org/x/crypto/hkdf" agetest "c2sp.org/CCTV/age" ) func forEachVector(t *testing.T, f func(t *testing.T, v *vector)) { tests, err := fs.ReadDir(agetest.Vectors, ".") if err != nil { t.Fatal(err) } for _, test := range tests { name := test.Name() contents, err := fs.ReadFile(agetest.Vectors, name) if err != nil { t.Fatal(err) } t.Run(name, func(t *testing.T) { t.Parallel() f(t, parseVector(t, contents)) }) } } type vector struct { expect string payloadHash *[32]byte fileKey *[16]byte identities []age.Identity armored bool file []byte } func parseVector(t *testing.T, test []byte) *vector { var z bool v := &vector{file: test} for { line, rest, ok := bytes.Cut(v.file, []byte("\n")) if !ok { t.Fatal("invalid test file: no payload") } v.file = rest if len(line) == 0 { break } key, value, _ := strings.Cut(string(line), ": ") switch key { case "expect": switch value { case "success": case "HMAC failure": case "header failure": case "armor failure": case "payload failure": case "no match": default: t.Fatal("invalid test file: unknown expect value:", value) } v.expect = value case "payload": h, err := hex.DecodeString(value) if err != nil { t.Fatal(err) } v.payloadHash = (*[32]byte)(h) case "file key": h, err := hex.DecodeString(value) if err != nil { t.Fatal(err) } v.fileKey = (*[16]byte)(h) case "identity": var i age.Identity i, err := age.ParseX25519Identity(value) if err != nil { i, err = age.ParseHybridIdentity(value) } if err != nil { t.Fatal(err) } v.identities = append(v.identities, i) case "passphrase": i, err := age.NewScryptIdentity(value) if err != nil { t.Fatal(err) } v.identities = append(v.identities, i) case "armored": v.armored = true case "compressed": if value != "zlib" { t.Fatal("invalid test file: unknown compression:", value) } z = true case "comment": t.Log(value) default: t.Fatal("invalid test file: unknown header key:", key) } } if z { r, err := zlib.NewReader(bytes.NewReader(v.file)) if err != nil { t.Fatal(err) } b, err := io.ReadAll(r) if err != nil { t.Fatal(err) } if err := r.Close(); err != nil { t.Fatal(err) } v.file = b } return v } func TestVectors(t *testing.T) { forEachVector(t, func(t *testing.T, v *vector) { var plaintext []byte t.Run("Decrypt", func(t *testing.T) { plaintext = testDecrypt(t, v) }) t.Run("DecryptReaderAt", func(t *testing.T) { testDecryptReaderAt(t, v, plaintext) }) t.Run("Inspect", func(t *testing.T) { testInspect(t, v, plaintext) }) t.Run("RoundTrip", func(t *testing.T) { testVectorRoundTrip(t, v) }) }) } func testDecrypt(t *testing.T, v *vector) []byte { var in io.Reader = bytes.NewReader(v.file) if v.armored { in = armor.NewReader(in) } r, err := age.Decrypt(in, v.identities...) if err != nil && strings.HasSuffix(err.Error(), "bad header MAC") { if v.expect == "HMAC failure" { t.Log(err) return nil } t.Fatalf("expected %s, got HMAC error", v.expect) } else if e := new(armor.Error); errors.As(err, &e) { if v.expect == "armor failure" { t.Log(err) return nil } t.Fatalf("expected %s, got: %v", v.expect, err) } else if _, ok := err.(*age.NoIdentityMatchError); ok { if v.expect == "no match" { t.Log(err) return nil } t.Fatalf("expected %s, got: %v", v.expect, err) } else if err != nil { if v.expect == "header failure" { t.Log(err) return nil } t.Fatalf("expected %s, got: %v", v.expect, err) } else if v.expect != "success" && v.expect != "payload failure" && v.expect != "armor failure" { t.Fatalf("expected %s, got success", v.expect) } out, err := io.ReadAll(r) if err != nil && v.expect == "success" { t.Fatalf("expected %s, got: %v", v.expect, err) } else if err != nil { t.Log(err) if v.expect == "armor failure" { if e := new(armor.Error); !errors.As(err, &e) { t.Errorf("expected armor.Error, got %T", err) } } if v.payloadHash != nil && sha256.Sum256(out) != *v.payloadHash { t.Errorf("partial payload hash mismatch, read %d bytes", len(out)) } return out } else if v.expect != "success" { t.Fatalf("expected %s, got success", v.expect) } if sha256.Sum256(out) != *v.payloadHash { t.Error("payload hash mismatch") } return out } func testDecryptReaderAt(t *testing.T, v *vector, plaintext []byte) { if v.armored { t.Skip("armor.NewReader does not implement ReaderAt") } rAt, s, err := age.DecryptReaderAt(bytes.NewReader(v.file), int64(len(v.file)), v.identities...) switch v.expect { case "success": if err != nil { t.Fatalf("expected success, got: %v", err) } if int64(len(plaintext)) != s { t.Errorf("unexpected size: got %d, want %d", s, len(plaintext)) } case "payload failure": // DecryptReaderAt detects some (but not all) payload failures upfront, // either from the size of the payload, or by decrypting the last chunk // to authenticate its size. if err != nil { t.Log(err) return } default: if err != nil { t.Log(err) return } t.Fatalf("expected %s, got success", v.expect) } out, err := io.ReadAll(io.NewSectionReader(rAt, 0, s)) if v.expect == "success" { if err != nil { t.Fatalf("expected success, got: %v", err) } } else { if err == nil { t.Fatalf("expected %s, got success", v.expect) } t.Log(err) // We can't check the partial payload hash, because the ReaderAt will // notice errors that a linearly scanning Reader could not. For example, // if there are two final chunks, the linear Reader will decrypt the // first one and then error out on the second, while the ReaderAt will // decrypt the second one to check the size, and then know that the // first chunk could not be the last one. Instead, check that the // prefix, if any, matches. if !bytes.HasPrefix(plaintext, out) { t.Errorf("partial payload prefix mismatch, read %d bytes", len(out)) } return } if sha256.Sum256(out) != *v.payloadHash { t.Error("payload hash mismatch") } } func testInspect(t *testing.T, v *vector, plaintext []byte) { if v.expect != "success" { t.Skip("invalid file, can't inspect") } for _, fileSize := range []int64{int64(len(v.file)), -1} { metadata, err := inspect.Inspect(bytes.NewReader(v.file), fileSize) if err != nil { t.Fatalf("inspect failed: %v", err) } if metadata.Armor != v.armored { t.Errorf("unexpected armor: %v", metadata.Armor) } if metadata.Armor && metadata.Sizes.Armor == 0 { t.Errorf("expected non-zero armor size") } if metadata.Sizes.Armor+metadata.Sizes.Header+metadata.Sizes.Overhead+metadata.Sizes.MinPayload != int64(len(v.file)) { t.Errorf("size breakdown does not add up to file size") } if metadata.Sizes.MinPayload != int64(len(plaintext)) { t.Errorf("unexpected payload size: got %d, want %d", metadata.Sizes.MinPayload, len(plaintext)) } if metadata.Sizes.MaxPayload != metadata.Sizes.MinPayload { t.Errorf("unexpected max payload size: got %d, want %d", metadata.Sizes.MaxPayload, metadata.Sizes.MinPayload) } if metadata.Sizes.MinPadding != 0 || metadata.Sizes.MaxPadding != 0 { t.Errorf("unexpected padding sizes: got min %d max %d, want 0", metadata.Sizes.MinPadding, metadata.Sizes.MaxPadding) } } } // testVectorsRoundTrip checks that any (valid) armor, header, and/or STREAM // payload in the test vectors re-encodes identically. func testVectorRoundTrip(t *testing.T, v *vector) { if v.armored { if v.expect == "armor failure" { t.Skip("invalid armor, nothing to round-trip") } t.Run("armor", func(t *testing.T) { payload, err := io.ReadAll(armor.NewReader(bytes.NewReader(v.file))) if err != nil { t.Fatal(err) } buf := &bytes.Buffer{} w := armor.NewWriter(buf) if _, err := w.Write(payload); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } // Armor format is not perfectly strict: CRLF ↔ LF and trailing and // leading spaces are allowed and won't round-trip. expect := bytes.Replace(v.file, []byte("\r\n"), []byte("\n"), -1) expect = bytes.TrimSpace(expect) expect = append(expect, '\n') if !bytes.Equal(buf.Bytes(), expect) { t.Error("got a different armor encoding") } }) // Armor tests are not interesting beyond their armor encoding. return } if v.expect == "header failure" { t.Skip("invalid header, nothing to round-trip") } hdr, p, err := format.Parse(bytes.NewReader(v.file)) if err != nil { t.Fatal(err) } payload, err := io.ReadAll(p) if err != nil { t.Fatal(err) } t.Run("header", func(t *testing.T) { buf := &bytes.Buffer{} if err := hdr.Marshal(buf); err != nil { t.Fatal(err) } buf.Write(payload) if !bytes.Equal(buf.Bytes(), v.file) { t.Error("got a different header+payload encoding") } }) if v.expect != "success" { return } t.Run("STREAM", func(t *testing.T) { nonce, payload := payload[:16], payload[16:] key := streamKey(v.fileKey[:], nonce) r, err := stream.NewDecryptReader(key, bytes.NewReader(payload)) if err != nil { t.Fatal(err) } plaintext, err := io.ReadAll(r) if err != nil { t.Fatal(err) } rAt, err := stream.NewDecryptReaderAt(key, bytes.NewReader(payload), int64(len(payload))) if err != nil { t.Fatal(err) } plaintextAt, err := io.ReadAll(io.NewSectionReader(rAt, 0, int64(len(plaintext)))) if err != nil { t.Fatal(err) } if !bytes.Equal(plaintextAt, plaintext) { t.Errorf("got a different plaintext from DecryptReaderAt") } buf := &bytes.Buffer{} w, err := stream.NewEncryptWriter(key, buf) if err != nil { t.Fatal(err) } if _, err := w.Write(plaintext); err != nil { t.Fatal(err) } if err := w.Close(); err != nil { t.Fatal(err) } if !bytes.Equal(buf.Bytes(), payload) { t.Error("got a different STREAM ciphertext") } er, err := stream.NewEncryptReader(key, bytes.NewReader(plaintext)) if err != nil { t.Fatal(err) } ciphertext, err := io.ReadAll(er) if err != nil { t.Fatal(err) } if !bytes.Equal(ciphertext, payload) { t.Error("got a different STREAM ciphertext from EncryptReader") } }) } func streamKey(fileKey, nonce []byte) []byte { h := hkdf.New(sha256.New, fileKey, nonce, []byte("payload")) streamKey := make([]byte, chacha20poly1305.KeySize) if _, err := io.ReadFull(h, streamKey); err != nil { panic("age: internal error: failed to read from HKDF: " + err.Error()) } return streamKey } ================================================ FILE: x25519.go ================================================ // Copyright 2019 The age Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package age import ( "crypto/rand" "crypto/sha256" "errors" "fmt" "io" "strings" "filippo.io/age/internal/bech32" "filippo.io/age/internal/format" "golang.org/x/crypto/chacha20poly1305" "golang.org/x/crypto/curve25519" "golang.org/x/crypto/hkdf" ) const x25519Label = "age-encryption.org/v1/X25519" // X25519Recipient is the standard age pre-quantum public key. Messages // encrypted to this recipient can be decrypted with the corresponding // [X25519Identity]. For post-quantum resistance, use [HybridRecipient]. // // This recipient is anonymous, in the sense that an attacker can't tell from // the message alone if it is encrypted to a certain recipient. type X25519Recipient struct { theirPublicKey []byte } var _ Recipient = &X25519Recipient{} // newX25519RecipientFromPoint returns a new X25519Recipient from a raw Curve25519 point. func newX25519RecipientFromPoint(publicKey []byte) (*X25519Recipient, error) { if len(publicKey) != curve25519.PointSize { return nil, errors.New("invalid X25519 public key") } r := &X25519Recipient{ theirPublicKey: make([]byte, curve25519.PointSize), } copy(r.theirPublicKey, publicKey) return r, nil } // ParseX25519Recipient returns a new X25519Recipient from a Bech32 public key // encoding with the "age1" prefix. func ParseX25519Recipient(s string) (*X25519Recipient, error) { t, k, err := bech32.Decode(s) if err != nil { return nil, fmt.Errorf("malformed recipient %q: %v", s, err) } if t != "age" { return nil, fmt.Errorf("malformed recipient %q: invalid type %q", s, t) } r, err := newX25519RecipientFromPoint(k) if err != nil { return nil, fmt.Errorf("malformed recipient %q: %v", s, err) } return r, nil } func (r *X25519Recipient) Wrap(fileKey []byte) ([]*Stanza, error) { ephemeral := make([]byte, curve25519.ScalarSize) if _, err := rand.Read(ephemeral); err != nil { return nil, err } ourPublicKey, err := curve25519.X25519(ephemeral, curve25519.Basepoint) if err != nil { return nil, err } sharedSecret, err := curve25519.X25519(ephemeral, r.theirPublicKey) if err != nil { return nil, err } l := &Stanza{ Type: "X25519", Args: []string{format.EncodeToString(ourPublicKey)}, } salt := make([]byte, 0, len(ourPublicKey)+len(r.theirPublicKey)) salt = append(salt, ourPublicKey...) salt = append(salt, r.theirPublicKey...) h := hkdf.New(sha256.New, sharedSecret, salt, []byte(x25519Label)) wrappingKey := make([]byte, chacha20poly1305.KeySize) if _, err := io.ReadFull(h, wrappingKey); err != nil { return nil, err } wrappedKey, err := aeadEncrypt(wrappingKey, fileKey) if err != nil { return nil, err } l.Body = wrappedKey return []*Stanza{l}, nil } // String returns the Bech32 public key encoding of r. func (r *X25519Recipient) String() string { s, _ := bech32.Encode("age", r.theirPublicKey) return s } // X25519Identity is the standard pre-quantum age private key, which can decrypt // messages encrypted to the corresponding [X25519Recipient]. For post-quantum // resistance, use [HybridIdentity]. type X25519Identity struct { secretKey, ourPublicKey []byte } var _ Identity = &X25519Identity{} // newX25519IdentityFromScalar returns a new X25519Identity from a raw Curve25519 scalar. func newX25519IdentityFromScalar(secretKey []byte) (*X25519Identity, error) { if len(secretKey) != curve25519.ScalarSize { return nil, errors.New("invalid X25519 secret key") } i := &X25519Identity{ secretKey: make([]byte, curve25519.ScalarSize), } copy(i.secretKey, secretKey) i.ourPublicKey, _ = curve25519.X25519(i.secretKey, curve25519.Basepoint) return i, nil } // GenerateX25519Identity randomly generates a new X25519Identity. func GenerateX25519Identity() (*X25519Identity, error) { secretKey := make([]byte, curve25519.ScalarSize) if _, err := rand.Read(secretKey); err != nil { return nil, fmt.Errorf("internal error: %v", err) } return newX25519IdentityFromScalar(secretKey) } // ParseX25519Identity returns a new X25519Identity from a Bech32 private key // encoding with the "AGE-SECRET-KEY-1" prefix. func ParseX25519Identity(s string) (*X25519Identity, error) { t, k, err := bech32.Decode(s) if err != nil { return nil, fmt.Errorf("malformed secret key: %v", err) } if t != "AGE-SECRET-KEY-" { return nil, fmt.Errorf("malformed secret key: unknown type %q", t) } r, err := newX25519IdentityFromScalar(k) if err != nil { return nil, fmt.Errorf("malformed secret key: %v", err) } return r, nil } func (i *X25519Identity) Unwrap(stanzas []*Stanza) ([]byte, error) { return multiUnwrap(i.unwrap, stanzas) } func (i *X25519Identity) unwrap(block *Stanza) ([]byte, error) { if block.Type != "X25519" { return nil, ErrIncorrectIdentity } if len(block.Args) != 1 { return nil, errors.New("invalid X25519 recipient block") } publicKey, err := format.DecodeString(block.Args[0]) if err != nil { return nil, fmt.Errorf("failed to parse X25519 recipient: %v", err) } if len(publicKey) != curve25519.PointSize { return nil, errors.New("invalid X25519 recipient block") } sharedSecret, err := curve25519.X25519(i.secretKey, publicKey) if err != nil { return nil, fmt.Errorf("invalid X25519 recipient: %v", err) } salt := make([]byte, 0, len(publicKey)+len(i.ourPublicKey)) salt = append(salt, publicKey...) salt = append(salt, i.ourPublicKey...) h := hkdf.New(sha256.New, sharedSecret, salt, []byte(x25519Label)) wrappingKey := make([]byte, chacha20poly1305.KeySize) if _, err := io.ReadFull(h, wrappingKey); err != nil { return nil, err } fileKey, err := aeadDecrypt(wrappingKey, fileKeySize, block.Body) if err == errIncorrectCiphertextSize { return nil, errors.New("invalid X25519 recipient block: incorrect file key size") } else if err != nil { return nil, ErrIncorrectIdentity } return fileKey, nil } // Recipient returns the public X25519Recipient value corresponding to i. func (i *X25519Identity) Recipient() *X25519Recipient { r := &X25519Recipient{} r.theirPublicKey = i.ourPublicKey return r } // String returns the Bech32 private key encoding of i. func (i *X25519Identity) String() string { s, _ := bech32.Encode("AGE-SECRET-KEY-", i.secretKey) return strings.ToUpper(s) }