Skip to content

Commit 77ffd8d

Browse files
authored
Merge pull request #409 from rod4n4m1/main
add instructions to verify the tarballs using cosign #406
2 parents 00ceb3e + 0e4b208 commit 77ffd8d

File tree

1 file changed

+44
-6
lines changed

1 file changed

+44
-6
lines changed

README.md

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,61 @@
77

88
## Installation
99

10-
```
10+
```shell
1111
curl -sfL http://get.kubearmor.io/ | sudo sh -s -- -b /usr/local/bin
1212
```
1313

14-
### Installing from Source
14+
### Installing From Source
1515

1616
Build karmor from source if you want to test the latest (pre-release) karmor version.
1717

18-
```
18+
```shell
1919
git clone https://github.com/kubearmor/kubearmor-client.git
2020
cd kubearmor-client
2121
make install
2222
```
2323

24-
## Usage
24+
### Steps to Verify the Binary (Recommended)
25+
26+
We sign all releases with `cosign`, therefore we recommend verifying **karmor** tarball prior to its installation.
27+
28+
Below are the instructions to verify the binary using `cosign` for version `v1.1.0`.
29+
30+
- Use an environment variable to set the **karmor** version
31+
32+
```shell
33+
export KARMOR_VERSION="1.1.0"
34+
```
35+
36+
- Download released tarball, certificate, and signature files
37+
38+
<details>
39+
<summary>Download Details</summary>
40+
41+
```shell
42+
curl -LO https://github.com/kubearmor/kubearmor-client/releases/download/v${KARMOR_VERSION}/karmor_${KARMOR_VERSION}_linux_amd64.tar.gz
43+
44+
curl -LO https://github.com/kubearmor/kubearmor-client/releases/download/v${KARMOR_VERSION}/karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.cert
2545

46+
curl -LO https://github.com/kubearmor/kubearmor-client/releases/download/v${KARMOR_VERSION}/karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.sig
2647
```
48+
49+
</details>
50+
51+
- Verify the released tarball integrity with `cosign`
52+
53+
<details>
54+
<summary>Verification Details</summary>
55+
56+
```shell
57+
cosign verify-blob karmor_${KARMOR_VERSION}_linux_amd64.tar.gz --certificate-identity=https://github.com/kubearmor/kubearmor-client/.github/workflows/release.yml@refs/tags/v${KARMOR_VERSION} --certificate-oidc-issuer=https://token.actions.githubusercontent.com --signature karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.sig --certificate karmor_${KARMOR_VERSION}_linux_amd64.tar.gz.cert
58+
```
59+
60+
</details>
61+
62+
## Usage
63+
64+
```shell
2765
CLI Utility to help manage KubeArmor
2866

2967
KubeArmor is a container-aware runtime security enforcement system that
@@ -56,6 +94,6 @@ Flags:
5694
Use "karmor [command] --help" for more information about a command.
5795
```
5896
59-
6097
## License
61-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client?ref=badge_large)
98+
99+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkubearmor%2Fkubearmor-client?ref=badge_large)

0 commit comments

Comments
 (0)