Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KBS: add a guide for HTTPS kbs usage #340

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions kbs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ The KBS can use HTTPS. This requires a crypto backend.
`HTTPS_CRYPTO` determines which backend will be used.
The options are `rustls` and `openssl`. The default is `rustls`.

If you want a self-signed cert for test cases, please refer to [the document](docs/self-signed-https.md).

### Policy Engine

The KBS has a policy engine to determine when a resource should be released.
Expand Down
134 changes: 134 additions & 0 deletions kbs/docs/self-signed-https.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Use a Self-Signed Cert to Leverage HTTPS

This guide will take the following goals
- Generate a private key and a self-signed HTTPS certificate of the public part of the private key.
- Use the private key and the cert to launch KBS
- Use KBS client tool to access the KBS HTTPS server

## Generate a self-signed certificate

```bash
# Edit a crt configuration. You can change the following items to any you want
cat << localhost.crt > EOF
[req]
default_bits = 2048
default_keyfile = localhost.key
distinguished_name = req_distinguished_name
req_extensions = req_ext
x509_extensions = v3_ca

[req_distinguished_name]
countryName = Country Name (2 letter code)
countryName_default = CN
stateOrProvinceName = State or Province Name (full name)
stateOrProvinceName_default = Zhejiang
localityName = Locality Name (eg, city)
localityName_default = Hangzhou
organizationName = Organization Name (eg, company)
organizationName_default = localhost
organizationalUnitName = organizationalunit
organizationalUnitName_default = Development
commonName = Common Name (e.g. server FQDN or YOUR name)
commonName_default = localhost
commonName_max = 64

[req_ext]
subjectAltName = @alt_names

[v3_ca]
subjectAltName = @alt_names

[alt_names]
DNS.1 = localhost
DNS.2 = 127.0.0.1
EOF

# generate the private key and self-signed cert
openssl req -x509 -nodes -days 365 \
-newkey rsa:2048 \
-keyout localhost.key \
-out localhost.crt \
-config localhost.conf \
-passin pass:
```
## Generate resource retrieve key pair

```bash
openssl genpkey -algorithm ed25519 > private.key
openssl pkey -in private.key -pubout -out public.pub
```

## Launch KBS server
Set up a `kbs-config.toml`
```bash
cat << kbs-config.toml > EOF
private_key = "/etc/key.pem"
certificate = "/etc/cert.pem"

sockets = ["0.0.0.0:8080"]

auth_public_key = "/etc/public.pub"

insecure_api = true

[attestation_token_config]
attestation_token_type = "CoCo"

[repository_config]
type = "LocalFs"
dir_path = "/opt/confidential-containers/kbs/repository"

[as_config]
work_dir = "/opt/confidential-containers/attestation-service"
policy_engine = "opa"
rvps_store_type = "LocalFs"
attestation_token_broker = "Simple"

[as_config.attestation_token_config]
duration_min = 5

[as_config.rvps_config]
store_type = "LocalFs"
remote_addr = ""

[policy_engine_config]
policy_path = "/opa/confidential-containers/kbs/policy.rego"
EOF
```

Use docker to run KBS-built-in-as
```bash
docker run -it --rm \
-v $(pwd)/kbs-config.toml:/etc/kbs-config.toml \
-v $(pwd)/localhost.key:/etc/key.pem \
-v $(pwd)/localhost.crt:/etc/cert.pem \
-v $(pwd)/public.pub:/etc/public.pub \
--env RUST_LOG=debug \
-p 8080:8080 \
kbs:coco-as \
kbs --config-file /etc/kbs-config.toml
```

`kbs:coco-as` is built from `docker build -t kbs:coco-as . -f kbs/docker/Dockerfile`, also can use a staged image from https://github.com/confidential-containers/kbs/pkgs/container/staged-images%2Fkbs

## Use client tool to access

```bash
echo testdata > dummy_data
kbs-client --cert-file localhost.crt \
--url https://localhost:8080 \
config \
--auth-private-key private.key \
set-resource \
--resource-file dummy_data \
--path default/test/dummy
```

and the result
```plaintext
Set resource success
```

shows it succeeded.

**The port mapping is very important as the FQDN inside the cert is set as `localhost`.** We must ensure the URI used on the client tool set is the same as the one inside the certificate's CommonName.
Loading