Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kviklet/kviklet

A tool to provide engineers with secure access to production databases without impairing productivity.
https://github.com/kviklet/kviklet

cyber-security cybersecurity database devops mysql postgresql

Last synced: about 1 month ago
JSON representation

A tool to provide engineers with secure access to production databases without impairing productivity.

Host: GitHub
URL: https://github.com/kviklet/kviklet
Owner: kviklet
License: mit
Created: 2023-09-04T13:49:22.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-22T10:36:59.000Z (8 months ago)
Last Synced: 2024-04-22T11:45:58.549Z (8 months ago)
Topics: cyber-security, cybersecurity, database, devops, mysql, postgresql
Language: Kotlin
Homepage:
Size: 3.55 MB
Stars: 137
Watchers: 1
Forks: 2
Open Issues: 7
Metadata Files:
- Readme: Readme.md
- License: LICENSE

Awesome Lists containing this project

README

# Kviklet

[Kviklet.dev](https://kviklet.dev) | [Release Notes](https://github.com/kviklet/kviklet/releases)

Secure access to production environments without impairing developer productivity.

![Kviklet](images/ExecutedRequest_light.png#gh-light-mode-only)
![Kviklet](images/ExecutedRequest_dark.png#gh-dark-mode-only)

Kviklet (pronounced Quick-let) embraces the **Four-Eyes Principle** and a high level of configurability, to allow a **Pull Request-like Review and Approval** flow for individual SQL statements or Database sessions. This allows engineering teams to self regulate on who gets access to what data and when. This allow your organization to stay secure and compliant while still allowing for modern empowering true to DevOps workflows.

Kviklet is a self hosted docker container, that provides you with a Single Page Web app that you can login to create your SQL requests or approve the ones of others.

We currently support **Postgres**, **MySQL**, **MS SQL Server** and **MongoDB**.

## Features

Kviklet ships with a variety of features that an engineering team needs to manage their production database access in a **simple but secure** manner:

- **SSO (Google)**: Log into Kviklet without the need for a username or password. No more shared credentials for DB access.
- **LDAP Support**: Log into Kviklet with your LDAP credentials.
- **Review/Approval Flow**: Leave Comments and Suggestions on other developers data requests.
- **Temporary Access (1h)**: Execute any statement on a db for 1h after having been approved
- **Single Query**: Execute a singular statement. Allows the reviewer to review your query before execution.
- **Auditlog**: Singular plane that logs all executed statements with Author, reason for execution etc.
- **RBAC**: Configure which team has access to which database/table to as fine of a granularity as the DB Engine allows.
- **Postgres Proxy**: Start a proxy server to use the DB Client of your choice, but everything will be stored in the Kviklet Auditlog.
- **Kubernetes Exec**: Execute a statement on a pod in your kubernetes cluster. (Currently only supports Execution of a single command no live session yet)

## Feature by Database/Connection Type

Most features are available for all databases (SSO, LDAP, RBAC, Review/Approval Flow, Auditlog, etc.). But some features are restricted, either because it simply hasn't been built yet or because it makes no sense for that specific purpose. The following table shows which features are available for which database type:

| Database | Statement Review | Temporary Access | Proxy(Beta) | Explain Plan |
| ---------- | ---------------- | ---------------- | ----------- | ------------ |
| Postgres | &check; | &check; | &check; | &check; |
| MySQL | &check; | &check; | &cross; | &check; |
| MariaDB | &check; | &check; | &cross; | &check; |
| SQL Server | &check; | &check; | &cross; | &check; |
| MongoDB | &check; | &check; | &cross; | &cross; |
| Kubernetes | &check; | &cross; | &cross; | &cross; |

## Setup

Kviklet ships as a simple docker container.
You can find the available verions under [Releases](https://github.com/kviklet/kviklet/releases). We recommend to regularly update the version you are using as we continue to build new features.
The latest one currently is `ghcr.io/kviklet/kviklet:0.5.0`, you can also use `:main` but it might happen every now and then that we accidentally merge something buggythough we try to avoid that.

### Quick Start

If you just want to try out how it works:

1. Here is a minimal docker-compose.yaml:

```
services:
postgres:
image: postgres:16
restart: always
environment:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: postgres
ports:
- "5432:5432"
volumes:
- ./postgres-data:/var/lib/postgresql/data
# - ./sample_data.sql:/docker-entrypoint-initdb.d/init.sql

kviklet-postgres:
image: postgres:16
restart: always
environment:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: kviklet
ports:
- "5433:5432"
volumes:
- ./kviklet-postgres-data:/var/lib/postgresql/data

kviklet:
image: ghcr.io/kviklet/kviklet:main
ports:
- "80:8080"
environment:
- SPRING_DATASOURCE_URL=jdbc:postgresql://kviklet-postgres:5432/kviklet
- SPRING_DATASOURCE_USERNAME=postgres
- SPRING_DATASOURCE_PASSWORD=postgres
- [email protected]
- INITIAL_USER_PASSWORD=admin
depends_on:
- kviklet-postgres
```

2. Run the `docker-compose.yml` via `docker-compose up -d`. Kviklet should spin up on port 80 so just got to `localhost` and play around. The admin login is [email protected] with `admin` as password.

3. The docker-compose contains an extra postgres database for which you can setup a connection in Kviklet. To make this database contain some data, uncomment this line:

```
- ./sample_data.sql:/docker-entrypoint-initdb.d/init.sql
```

And create a sample_data.sql file:

```sql
CREATE TABLE Locations (
Name VARCHAR(100) NOT NULL,
Address VARCHAR(255) NOT NULL,
City VARCHAR(100) NOT NULL,
Country VARCHAR(100) NOT NULL,
PostalCode VARCHAR(20) NOT NULL
);

alter table public.Locations
owner to postgres;

INSERT INTO public.Locations (Name, Address, City, Country, PostalCode) VALUES
('Central Park', '59th to 110th St', 'New York', 'USA', '10022'),
('Eiffel Tower', 'Champ de Mars, 5 Avenue Anatole', 'Paris', 'France', '75007'),
('Colosseum', 'Piazza del Colosseo, 1', 'Rome', 'Italy', '00184'),
('Sydney Opera House', 'Bennelong Point', 'Sydney', 'Australia', '2000'),
('Great Wall of China', 'Huairou District', 'Beijing', 'China', '101405');
```

Or just log in with your database client of choice and create some data yourself.

### DB Setup

Kviklet needs it's own postgres database (or at least schema) to save metadata about queries, connections, approvals, etc.
You can find their official image here: https://hub.docker.com/_/postgres, or use a cloud hosted version by your cloud provider of choice.

When starting the kviklet container you will then need to set these three environment variables accordingly:

```
SPRING_DATASOURCE_PASSWORD = password
SPRING_DATASOURCE_USERNAME = username
SPRING_DATASOURCE_URL = jdbc:postgresql://[host]:[port]/[database]?currentSchema=[schema]
```

### Initial User

You will need an intial admin user for configuration purposes. For this set the 2 env variables:
`INITIAL_USER_EMAIL` and `INITIAL_USER_PASSWORD` so that you can login into the web interface. You can change the password afterwards via the UI.
Example:

```
[email protected]
INITIAL_USER_PASSWORD=someverysecurepassword
```

We publish our containers do the github packages for now, so with all this set you can run `ghcr.io/kviklet/kviklet:main` don't forget to map port `8080` which is the default port Kviklet spins up on.

An example docker run could looks like this:

```
docker run \
-e SPRING_DATASOURCE_PASSWORD=postgres \
-e SPRING_DATASOURCE_USERNAME=postgres \
-e SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/Kviklet \
-e [email protected] \
-e INITIAL_USER_PASSWORD=someverysecurepassword \
--network host \
ghcr.io/kviklet/kviklet:main
```

### SSO

#### Google

If you want to setup SSO for your Kviklet instance (which makes a lot of sense since otherwise you have to manage passwords again).
You need to setup these 3 environment variables:

```
KVIKLET_IDENTITYPROVIDER_CLIENTID
KVIKLET_IDENTITYPROVIDER_CLIENTSECRET
KVIKLET_IDENTITYPROVIDER_TYPE=google
```

The google client id and secret you can easily get by following google instructions here:
https://developers.google.com/identity/gsi/web/guides/get-google-api-clientid

For valid redirect URIs, you should configure: https://[kviklet_host]/api/login/oauth2/code/google
For Allowed Origins, simply your hosted kviklet url.

After setting those environment variables everyone in your organization can login with the sign in with google button. But they wont have any permissions by default, you will have to assign them a role after they log in once.

#### Keycloak

If you want to setup SSO with Keycloak instead you need to set these 4 environment variables:

```
KVIKLET_IDENTITYPROVIDER_CLIENTID
KVIKLET_IDENTITYPROVIDER_CLIENTSECRET
KVIKLET_IDENTITYPROVIDER_TYPE=keycloak
KVIKLET_IDENTITYPROVIDER_ISSUERURI=http://[host]:[port]/realms/[realm]
```

You get the client id and secret when you create an application in keycloack.
For valid redirect URIs, you should configure: https://[kviklet_host]/api/login/oauth2/code/keycloak
For Allowed Origins, simply your hosted kviklet url.

After setting those environment variables the login page should show a Login with Keycloak button that redirects to your keycloak instance. We do currently not support role sync yet so you will have to manage roles directly in kviklet manually for now.

#### Other OIDC providers

Other OIDC providers should work similarly to Keycloak, note that the `redirect URI` will change depending on they type you choose, so if you choose `gitlab` it will be `https://[kviklet_host]/api/login/oauth2/code/gitlab`.
If you run into issues feel free to create an issue, we have not tried every single OIDC provider out there (yet) and there might be slight differences in the implementation that might require updates on Kviklets side.

### LDAP

Kviklet supports LDAP authentication. To enable and configure LDAP, you can override the following environment variables:

```
LDAP_ENABLED=true
LDAP_URL=ldap://your-ldap-server:389
LDAP_BASE=dc=your,dc=domain,dc=com
LDAP_PRINCIPAL=cn=admin,dc=your,dc=domain,dc=com
LDAP_PASSWORD=your-admin-password
LDAP_UNIQUE_IDENTIFIER_ATTRIBUTE=uid
LDAP_EMAIL_ATTRIBUTE=mail
LDAP_FULL_NAME_ATTRIBUTE=cn
LDAP_USER_OU=people
LDAP_SEARCH_BASE=ou=people
```

Here's what each setting means:

- `LDAP_ENABLED`: Set to `true` to enable LDAP authentication.
- `LDAP_URL`: The URL of your LDAP server.
- `LDAP_BASE`: The base DN for LDAP searches.
- `LDAP_PRINCIPAL`: The DN of the admin user for binding to the LDAP server.
- `LDAP_PASSWORD`: The password for the admin user.
- `LDAP_UNIQUE_IDENTIFIER_ATTRIBUTE`: The LDAP attribute used as the unique identifier for users (default: "uid").
- `LDAP_EMAIL_ATTRIBUTE`: The LDAP attribute that contains the user's email address (default: "mail").
- `LDAP_FULL_NAME_ATTRIBUTE`: The LDAP attribute that contains the user's full name (default: "cn").
- `LDAP_USER_OU`: The Organizational Unit (OU) where user accounts are stored (default: "people").
- `LDAP_SEARCH_BASE`: Allows to override the base DN for user searches (default: "ou=people"). If you use FreeIPA you might need to set this to e.g. `cn=users`. If set LDAP_USER_OU is ignored.

You can customize these attributes to match your LDAP schema. After configuring LDAP, users will be able to log in using their LDAP credentials. The first time an LDAP user logs in, a corresponding user account will be created in Kviklet with default permissions. An admin will need to assign appropriate roles to these users after their first login.

## Configuration

### Connections

After starting Kviklet you first have to configure a database connection. Go to Settings -> Databases -> Add Connection.

![Add Connection](images/CreateConnection_light.png#gh-light-mode-only)
![Add Connection](images/CreateConnection_dark.png#gh-dark-mode-only)

Here you can configure how many reviews are required to run Requests on this connection. You can also configure how often a request can be run. The default is 1 and we recommend to stick to this for most use cases. As a special config, setting this to 0 any request on the connection can be run an infinite amount of times.

### Roles

Kviklet ships with 3 roles, Default, Admins and Developers.

- The default role provides Read access to all connections, and Requests. This role is assigned to every user and cannot be removed. You can however alter the permissions of this role however you like.
- Admins have the permission to create and edit connections, as well as adding new Users and setting their permissions.
- Developers can create Requests as well as approve and comment on them and of course execute the actual statements.

You can customize Roles and e.g. give a role only access to a specific connection or a group of DB connections.
This is useful e.g. if you have different teams with different databases and want to controll access to those more granularly.

#### Creating a new Role

Creating a new role works as follows. Go to Settings -> Roles -> Add Role.

![Add Role](images/CreateRole_light.png#gh-light-mode-only)
![Add Role](images/CreateRole_dark.png#gh-dark-mode-only)

The default settings are not as relevant for most roles and you can just give User Read and RoleView Access and leave it at that.
More interesting is the adding of individual permissions for Connections. Here you first add a selector to select specific connections. This can either be a specific id or you use wildcards with `*` to match multiple connections. E.g. if you want to have a role that has access to all dev databases (in case you also manage acces to those with kviklet) you'd use a selector like `dev-*` and ensure the ids of the connections are set correctly.

You can of course also make up a system that you use for your different teams inside of your organization.

### Notifications

You can configure Kviklet to send notifications to a channel in Slack or Teams. This is useful to notify your team about new requests that need to be reviewed. You can configure this in Settings -> General -> Notification Settings.

#### Slack

To configure Slack notifications you need to create a Slack App and enable webhooks for it. You can follow the instructions here: https://api.slack.com/messaging/webhooks

#### Teams

To configure Teams notifications you need to add a Webhook connector to your channel. The official microsoft docs on that are here: https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook

To enable the notifications, simply set the Webhook URL in the Kviklet Notification Settings and click save.

Currently there are notifications for:

- New Requests, that need approvals
- New approvals on requests

## Encryption

If you don't want the credentials to be stored in cleartext in the DB, I recommend that you enable database encryption on the Kviklet postgres DB itself. For most hosted providers this is a simple checkbox to click.
Nontheless I understand that if the Kviklet database is somehow compromised, this is a huge security risk. As it contains the database crendetials for potentially all your production datastores. So you can enabled encryption of the credentials at rest.

To do this simply set the two environment variables.

```
ENCRYPTION_ENABLED=true
ENCRYPTION_KEY_CURRENT=some-secret
```

Kviklet will encrypt all your existing credentials on startup, and use the secret for future connections that you create.

### Key Rotation

If you want to rotate the key you can simply add another variable for the previous key and change the current one:

```
ENCRYPTION_KEY_PREVIOUS=some-secret
ENCRYPTION_KEY_CURRENT=another-secret
```

Kviklet will re-encrypt all connections on startup, so that you can then restart the contaienr with the previous key removed.

## Experimental Features

There is two few experimental Features. That were build mostly on community/customer feedback. Feel free to try these out and leave any input that you might have. We hope to develop into this further in the future and make it work well with the core approval flow.

### Kubernetes Exec

If you want to use the Kubernetes Exec feature you have to create a separate kubernetes connection. Kviklet will use the user of the deployed pod to execute the command. So make sure that the user has the necessary permissions to execute commands on the pods that you want to access.

Kviklet also uses /bin/sh to execute the command, so you will need to make sure your pods have a shell or at least a symlink in /bin/sh. If this bothers you feel free to open an issue, we can potentially make this configurable or find another solution.

Kubernetes commands only wait for 5 seconds for output if the command takes longer than that Kviklet will wait for up to an hour before timing out the command. This is a a provisional solution, we are looking into websockets to make this more responsive and potentially enable terminal sessions.

### Proxy, Postgres only

If you create requests for temporary access. You can instead of using the web interface to run queries also enable a proxy and use the DB client of your choice.
For this the container uses ports 5438-6000 so you need to expose those.
The user can then create a temp access request, and click "Start Proxy" once it's been approved. They will get a port and a user + temporary password. With this they can login to the database. Kviklet validates the temp user and password and proxies all requests to the underlying user on the database. Any executed statements are logged in the auditlog as if they were run via the web interface.

![Postgres Proxy](images/PostgresProxy_light.png#gh-light-mode-only)
![Postgres Proxy](images/PostgresProxy_dark.png#gh-dark-mode-only)

## Questions? Contributions?

If you have any questions, feel free to create a github issue I try to answer within a reasonable amount of time and am also happy to develop feature for your use case if it fits the general vision of the tool.
Kviklet is currently fully open-source and although I dream of making it pay my bills eventually there is currently no concrete plans on how to approach this.

If you want to contribute, feel free to fork and create PRs for small things. If you plan bigger features, I'd appreciate some discussion upfront in a github issue or similar.

You can also contact me at [email protected].