Updated README.md
This commit is contained in:
Jeff Alyanak
parent
2af1e8d5a7
commit
5c10ada13c
97
README.md
97
README.md
|
|
@ -1,48 +1,105 @@
|
|||
# BitBetter
|
||||
|
||||
This project is a tool to modify bitwardens core dll to allow me to self license.
|
||||
Beware this does janky IL magic to rewrite the bitwarden core dll and install my self signed certificate.
|
||||
BitBetter is is a tool to modify bitwardens core dll to allow you to generate your own individual and organisation licenses. Please see the FAQ below for details on why this software was created.
|
||||
|
||||
Yes, there still are quite a few things that need to be fixed. Updates and Organization Buiness Name is hardcoded to Bitbetter, are the first to things to fix.. Better handling of the User-GUID comes to mind too.
|
||||
_Beware! BitBetter does janky IL magic to rewrite the bitwarden core dll and install a self signed certificate. Use at your own risk!_
|
||||
|
||||
Credit to https://github.com/h44z/BitBetter and https://github.com/jakeswenson/BitBetter
|
||||
|
||||
## Building
|
||||
# Table of Contents
|
||||
1. [Getting Started](#getting-started)
|
||||
+ [Pre-requisites](#pre-requisites)
|
||||
+ [Setting up BitBetter](#setting-up-bitbetter)
|
||||
+ [Building BitBetter](#building-bitbetter)
|
||||
+ [Generating Signed Licenses](#generating-signed-licenses)
|
||||
2. [FAQ](#faq-questions-you-might-have-)
|
||||
3. [Footnotes](#footnotes)
|
||||
|
||||
To build your own `bitwarden/api` & `bitwarden/identity` images run
|
||||
# Getting Started
|
||||
The following instructions are for unix-based systems (Linux, BSD, macOS), it is possible to use a Windows systems assuming you are able to enable and install [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
|
||||
|
||||
## Pre-requisites
|
||||
Aside from docker, which you also need for Bitwarden, BitBetter requires the following:
|
||||
|
||||
* openssl (probably already installed on most Linux or WSL systems)
|
||||
* dotnet-sdk-2.1 (install instructions can be found [here](https://dotnet.microsoft.com/download/linux-package-manager/rhel/sdk-2.1.604))
|
||||
|
||||
## Setting up BitBetter
|
||||
With your pre-requisites installed, begin the installation of BitBetter by downloading it through Github or using the git command:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/online-stuff/BitBetter.git
|
||||
```
|
||||
|
||||
First, we need to add the correct version of Newtonsoft.Json to the license generator and the BitBetter docker directories.
|
||||
|
||||
```bash
|
||||
cd BitBetter/src/licenseGen/
|
||||
dotnet add package Newtonsoft.Json --version 11.0.0
|
||||
|
||||
cd ../bitBetter
|
||||
dotnet add package Newtonsoft.Json --version 11.0.0
|
||||
```
|
||||
## Building BitBetter
|
||||
|
||||
Now that you've set up your build environment, you can run the main `BitBetter/build.sh` script to generate a modified version of the `bitwarden/api` and `bitwarden/identity` docker images.
|
||||
|
||||
From the BitBetter directory, simply run:
|
||||
```bash
|
||||
./build.sh
|
||||
```
|
||||
|
||||
In your `bwdata/docker/docker-compose.yml` replace each reference to `bitwarden/api:x.xx.x` with `bitbetter/api` and each reference to `bitwarden/identity:x.xx.x` with `bitbetter/identity` and the start bitwarden as normal.
|
||||
This will create a new self-signed certificate in the `.keys` directory one does not already exist and then create a modified version of the official `bitwarden/api` called `bitbetter/api` and a modified version of the `bitwarden/identity` called `bitbetter/identity`. You may now simply edit your bitwarden docker-compose.yml to utilize the modified image.
|
||||
|
||||
## Issuing your own licenses
|
||||
Edit your `/path/to/bwdata/docker/docker-compose.yml`.
|
||||
|
||||
The repo is setup to replace the licesning signing cert in bitwarden.core with your own personal self signed cert (`cert.pfx`)
|
||||
If you want to be able to sign your own licenses obviously you'll have to replace it with your own self signed cert.
|
||||
> Replace `image: bitwarden/api:x.xx.x`<br>with `image: bitbetter/api`
|
||||
|
||||
> Replace `image: bitwarden/identity:x.xx.x`<br>with `image: bitbetter/identity`
|
||||
|
||||
### Signing licesnses
|
||||
You'll also want to edit the `/path/to/bwdata/scripts/run.sh` file. In the `function restart()` block, comment out the call to `dockerComposePull`.
|
||||
|
||||
To sign your own license you first need to generate your own singing cert using the `.keys/generate-keys.sh` script. Running this script will prompt you to enter some information about your new certificate, you may leave these at the defaults or set them to your preference. The script will then create a pkcs12 file (.pfx) containing your new key/cert.
|
||||
> Replace `dockerComposePull`<br>with `#dockerComposePull`
|
||||
|
||||
There is a tool included to generate a license (see `src/liceseGen/`), build it using:
|
||||
You can now start or restart Bitwarden as normal and the modified api will be used. <b>It is now ready to accept self-issued licenses.</b>
|
||||
|
||||
---
|
||||
**Note: Manually generating Certificate & Key**
|
||||
|
||||
If you wish to generate your self-signed cert & key manually, you can run the following commands.
|
||||
|
||||
```bash
|
||||
./src/licenseGen/build.sh
|
||||
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.cert -days 36500 -outform DER -passout pass:test
|
||||
openssl x509 -inform DER -in cert.cert -out cert.pem
|
||||
openssl pkcs12 -export -out cert.pfx -inkey key.pem -in cert.pem -passin pass:test -passout pass:test
|
||||
```
|
||||
|
||||
This tool build ontop of the bitbetter/api container image so make sure you've built that above using the root `./build.sh` script.
|
||||
Note that the password here must be `test`.<sup>[1](#f1)</sup>
|
||||
|
||||
After that you can run the tool using:
|
||||
---
|
||||
|
||||
## Generating Signed Licenses
|
||||
|
||||
There is a tool included in the directory `src/licenseGen/` that will generate new individual and organization licenses. These licenses will be accepted by the modified Bitwarden because they will be signed by the certificate you generated in earlier steps.
|
||||
|
||||
First, from the `BitBetter/src/licenseGen` directory, build the license generator.<sup>[2](#f2)</sup>
|
||||
|
||||
```bash
|
||||
./build.sh
|
||||
```
|
||||
|
||||
Now, from the `BitBetter/src/licenseGen` directory, you can run the tool to generate licenses.
|
||||
|
||||
You'll need to get a user's <b>GUID</b> in order to generate an <b>invididual license</b> and the server's <b>install ID</b> to generate an <b>Organization license</b>. These can be retrieved most easily through the Bitwarden [Admin Portal](https://help.bitwarden.com/article/admin-portal/).
|
||||
|
||||
```bash
|
||||
cd ~/BitBetter/src/licenseGen
|
||||
./run.sh ~/BitBetter/.keys/cert.pfx user "Name" "EMail" "User-GUID"
|
||||
./run.sh ~/BitBetter/.keys/cert.pfx org "Name" "EMail" "Install-ID used to install the server"
|
||||
```
|
||||
|
||||
# Questions (you might have?)
|
||||
<b>The license generator will spit out a JSON-formatted license which can then be used within the Bitwarden web front-end to license your user or org!</b>
|
||||
|
||||
# FAQ: Questions (you might have?)
|
||||
|
||||
I'll work on updates in the next couple weeks, right now, I just wanted something to start with.
|
||||
|
||||
|
|
@ -59,3 +116,9 @@ Thanks, good idea. And I did. Currently they're not focused on solving this issu
|
|||
To be clear i'm totally happy to give them my money. Offer a perpetual server license, and i'd pay for it. Let me license the server, period. Allow an orginzation to have Premium for all users.. 500 seats, let the 500 users in the orginzation have the Premium features too.
|
||||
|
||||
I'm still in the testing/evaluating phase. If I am hosting the server/data, let me license the server, period. How many licenses does one user need to have...
|
||||
|
||||
# Footnotes
|
||||
|
||||
<a name="#f1"><sup>1</sup></a> If you wish to change this you'll need to change the value that `src/licenseGen/Program.cs` uses for it's `GenerateUserLicense` and `GenerateOrgLicense` calls, but this is really unnecessary as this certificate does not represent any type of security issue.
|
||||
|
||||
<a name="#f2"><sup>2</sup></a>This tool build ontop of the `bitbetter/api` container image so make sure you've built that above using the root `./build.sh` script.
|
||||
Loading…
Reference in New Issue