bwv

command module
v0.0.0-...-ed45667 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: Apache-2.0 Imports: 24 Imported by: 0

README

bwv Bitwarden HTTP api

bwv is a small helper application for serving Bitwarden secrets over HTTP(S).

I created this application to primarily serve Hashicorp Vault unseal keys from my desktop over HTTP(S) to feed inside a local 3-node kubernetes cluster. See the example at the end of this document for how this may be implemented to auto-unseal Hashicorp Vault.

Note. Much of the bitwarden API and cryptography functionality is drawn from the bitw application (https://github.com/mvdan/bitw) however there is no association between the two applications and any issues found with this repo should be reported here.

Due to the integrations with KWallet, Libsecret and SystemD, this application only works on the Linux platform today. If someone knows how to integrate similar functionality on other platforms, I would welcome pull requests.

Configuration

To configure bwv to access your Bitwarden account details, you may do this in a number of ways:

Environment, kwallet and libsecrets all require the following attributes to be set exactly as seen.

In all instances, BW_CLIENTID and BW_CLIENTSECRET are optional but recommended to prevent continuous prompting for 2fa

BW_CLIENTID
BW_CLIENTSECRET
BW_PASSWORD
BW_EMAIL

Create the environment variables containing your details.

I generally avoid recommending this method as it involves credentials to be stored unencrypted inside the environment where they can be easily accessed. It would also require them to be written in plaintext to disk for service automation.

kwallet

Store the above secrets in kwallet at /Passwords/bwvault

libsecrets

Use the libsecrets manager of your choice and store the above secrets as attributes at the same /Passwords/bwvault.

The advantages of using kwallet or libsecret is that credentials are stored encrypted on disk and are generally unlocked when you unlock your computer. This reduces the chances of credential leakage.

By restricting this application to userspace, and tying the local client to BW_CLIENTSECRET drawn from any of the above 3 credential handling methods, your bitwarden secrets can remain secret even if you are running the tool on a shared computer.

Building

Clone this repo then run go build .

Commands:

Note: The commands listed here, including credential access, are only available to localhost. If you need to access credentials over the network, see the API documention below.

  • serve Run bwv server in foreground.
  • install Install the userspace systemd service
  • start Start the userspace systemd service
  • stop stop the userspace systemd service
  • status Get the status of the service (usually one of "running" or "dead")
  • remove Stop the userspace systemd service and remove it entirely.
  • genkey <ip address|cidr range> Create a 32 character random string to use as an API key, bound to the provided address or cidr range
  • revoke <key> Revokes the given key. Future iterations will allow for an ip or range to be provided if the key is lost.
  • whitelist <IP or range> Add the given IP or range to the access whitelist
  • drop <IP or range> Delete the given IP or range from the access whitelist
  • path/to/secret[?[field|property]=value Get the secret at a given path, optionally followed by specific properties to read

Usage

Run the server

$ bwv serve
2022/04/03 07:20:33 Login complete
2022/04/03 07:20:36 Master password configured
2022/04/03 07:20:36 Loading config file /home/mproffitt/.config/bwv/server.yaml
2022/04/03 07:20:36 Sync complete
2022/04/03 07:20:36 Listening for secure connections on :6277 (whitelist [127.0.0.0/24])

Retrieve a credential

$ bwv example/test
[
  {
    "fields": {
      "unseal-1": "abcdef",
      "unseal-2": "123456"
    },
    "folder_id": "804e76c5-c7fe-4a4b-94ef-ae6700d79146",
    "id": "2d29507c-72ef-493b-a09f-ae6700d83380",
    "name": "test",
    "password": "GGAPP$KoQ499hDCBHqvCxURzzS$3bp*A",
    "revision_date": "2022-03-29T13:07:09.8566667Z",
    "type": 1,
    "username": "invalid@example.com"
  }
]
Wildcards

The following wildcard patterns are currently supported

  • *, ./* both of these return all credentials which do not have a folder
  • */* return all credentials in all folders
  • */name return all credentials with name name in any folder

A future version may include more advanced search patterns.

Filtering

When only a single credential is being returned, this can be filtered to only return certain properties and/or fields by adding http query options onto the end of the path.

Note: Do not use filters with wildcards as this may give unexpected results.

If only a single property or field is being returned, this will always be identified as value in the resulting json object.

$ bwv example/test?property=password
{
  "value": "GGAPP$KoQ499hDCBHqvCxURzzS$3bp*A"
}

Multiple properties/fields can be requested either by specifying the keyword multiple times or using a comma separated string

$ bwv 'example/test?property=password&property=username&field=unseal-1,unseal-2'
{
  "password": "GGAPP$KoQ499hDCBHqvCxURzzS$3bp*A",
  "unseal-1": "abcdef",
  "unseal-2": "123456",
  "username": "invalid@example.com"
}
Whitelisting

When you first try and run bwv it will setup the server.yaml file and add 127.0.0.0/24 as the only whitelisted ip range.

To whitelist other IPs or ranges, either edit the configuration file or use the whitelist command.

$ bwv whitelist 192.168.1.8/30

HTTP only exists for running on a local network, behind a firewall where it cannot and should never be accessed from the outside world. It is serving your passwords and these should never be transmitted in plaintext, even when you trust the requesting device.

I do not recommend using the HTTP only version, even for local connections. Setting up a local CA and certificates is simple and cheap and if you need to serve externally, letsencrypt is your friend.

API tokens

When connecting to the bwv server from any address other than localhost, an API token is required. Localhost uses either your BW_CLIENTSECRET or BW_PASSWORD to achieve this with the preference being BW_CLIENTSECRET.

An api token is a random 32 character string which is stored encrypted in the server configuration. The encryption uses a pbkdf2 key derived from your master password. You are given the plaintext string which should be submitted as a Bearer token when accessing the api. See below.

To generate an API token, use the genkey command.

$ bwv genkey 192.168.1.5
2022/04/03 07:55:26 Login complete
2022/04/03 07:55:29 Master password configured
2022/04/03 07:55:29 Loading config file /home/mproffitt/.config/bwv/server.yaml

========================================
token = TQ5d0IEyOEPAtgZmV76oOc0WqpU5VdDO
========================================

Tokens can be revoked either by specifying the token, or the address the token is associated with however if the address is part of a range, the token must be used.

$ bwv revoke 192.168.1.5
2022/04/03 07:58:21 Login complete
2022/04/03 07:58:23 Master password configured
2022/04/03 07:58:23 Loading config file /home/mproffitt/.config/bwv/server.yaml
Advanced configuration

For more advanced configuration, create or edit the file at ${HOME}/.config/bwv/server.yaml in which the following properties are allowed:

  • whitelist A list of IP addresses allowed to access the service
  • cert An SSL certificate to secure your credentials in transit
  • key The SSL certificates key
  • port The port to listen on. This must be above 1024 if running in userspace. If port is 0, defaults to 6277
  • apikeys You generally do not want to touch this map. Use ./bwv genkey and ./bwv revoke to manage this.

API

The API for this application is simple.

  • /reload [INTERNAL] Tells the server to reload its config. Normally you do not need to access this endpoint.
  • /path/to/credential get the full contents at path/to/credential.
  • /path/?property=username[,password] A top level attribute from the credential such as username or password.
  • /path/?field=my-custom-field[,another-field] Fields are custom attributes set on the credential.

All API calls must be made with an API token passed along with the request as a Bearer token.

$ curl -s -H "Authorization: Bearer TQ5d0IEyOEPAtgZmV76oOc0WqpU5VdDO" "https://example.com:6277/example/test"

Failure to provide a token, using anything other than Bearer, or using a token not assigned to the address or range you are accessing the API from, will result in a 403 Permission Denied response code.

A real-world example with Hashicorp Vault

To use this to auto-unlock Hashicorp Vault, we need to create 2 items in Kubernetes, one is a configmap and the other a secret.

The configmap contains the following script:

while true; do # Until told otherwise, enter an infinite loop
  for i in 1 2 3; do # For each node in the cluster
    while true; do # until we get a response from bwv

      # get a key for the current node
      # setting v to empty string if the connection cannot be established (bwv is not running)
      v=$(wget -q -O - --header "Authorization: Bearer $BW_TOKEN" $BW_ADDR/$BW_PATH?field=unseal-$i 2>&1 | grep -v refused);
      if [ "$v" != "" ]; then
        break;
      fi;

      # if we didn't get a response, sleep for a second and try again
      sleep 1;
    done;

    # Try and unseal the vault using the current key
    vault operator unseal $(echo $v | awk -F\" "/value/{print \$4}");
  done;

  # If Vault is unsealed, break the outer loop
  if [ $(vault status | grep Sealed | awk "{print \$NF}") = false ]; then
    break;
  fi;

  # If not, sleep for a second and try again
  sleep 1;
done

Create the configmap by saving the script above as vault-unseal.sh and then running

kubectl create cm vault-unseal --from-file vault-unseal.sh --dry-run=client -o yaml | kubectl -n vault apply -f -

Create a secret in Kubernetes with the server address, the path to your vault secret as stored in bitwarden and the API key generated with bwv genkey

kubectl create secret generic vault-bitwarden --from-literal=address=https://example.com:6277 --from-literal=path=example/test --from-literal=token=cKE6o3ZyV8z4jJW1MNTisetS1vSK3pLC

Edit your vault helm chart values to include the configmap and secret.

server:
  extraSecretEnvironmentVars:
    - envName: BW_ADDR
      secretName: vault-bitwarden
      secretKey: address
    - envName: BW_PATH
      secretName: vault-bitwarden
      secretKey: path
    - envName: BW_TOKEN
      secretName: vault-bitwarden
      secretKey: token

  volumes:
    - name: vault-unseal
      configMap:
        name: vault-unseal

  volumeMounts:
     - mountPath: /vault/scripts
       name: vault-unseal

  postStart:
  - "/bin/sh"
  - "-ec"
  - "sleep 2 && cp /vault/scripts/vault-unseal.sh /tmp/unseal.sh && chmod +x /tmp/unseal.sh && /tmp/unseal.sh && rm /tmp/unseal.sh"

Apply the changes to your vault installation and restart the Vault statefulset

kubectl scale statefulsets/vault --replicas=0
helm upgrade vault hashicorp/vault -f values.yaml

When Vault is started, this script will be called and auto-unseal using the keys stored at unseal-1, unseal-2 and unseal-3.

Documentation

Overview

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Source Files

View all Source files

Directories

Path Synopsis
pkg
bitw
unix
* Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
 * Copyright 2022 Martin Proffitt <mproffitt@choclab.net> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.