Skip to content

Commit

Permalink
adds TLS 1-way documentation.
Browse files Browse the repository at this point in the history
also s/Authorization/Authentication/
  • Loading branch information
fgeller committed Mar 16, 2020
1 parent a28e116 commit a01950f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 9 deletions.
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,19 +243,29 @@ For more information: [https://github.com/Paxa/kt](https://github.com/Paxa/kt)

Use "kt [command] -help" for for information about the command.

Authorization:
Authentication:

Authorization with Kafka can be configured via a JSON file.
Authentication with Kafka can be configured via a JSON file.
You can set the file name via an "-auth" flag to each command or
set it via the environment variable KT_AUTH.


## Authorization
## Authentication / Encryption

Currently the only supported mode is TLS, please create an
[https://github.com/fgeller/kt/issues/new](issue) with details in case you need
another mode. Example for an authorization configuration that is used for the
system tests:
Authentication configuration is possibly via a JSON file. You indicate the mode
of authentication you need and provide additional information as required for
your mode.

### TLS

Required fields:

- `mode`: This needs to be set to `TLS`
- `client-certificate`: Path to your certificate
- `client-certificate-key`: Path to your certificate key
- `ca-certificate`: Path to your CA certificate

Example for an authorization configuration that is used for the system tests:


{
Expand All @@ -264,3 +274,22 @@ system tests:
"client-certificate-key": "test-secrets/kt-test.key",
"ca-certificate": "test-secrets/snakeoil-ca-1.crt"
}

### TLS one-way

Required fields:

- `mode`: This needs to be set to `TLS-1way`

Example:


{
"mode": "TLS-1way",
}

### Other modes

Please create an
[https://github.com/fgeller/kt/issues/new](issue) with details for the mode that you need.

4 changes: 2 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ The commands are:
Use "kt [command] -help" for for information about the command.
Authorization:
Authentication:
Authorization with Kafka can be configured via a JSON file.
Authentication with Kafka can be configured via a JSON file.
You can set the file name via an "-auth" flag to each command or
set it via the environment variable %s.
Expand Down

0 comments on commit a01950f

Please sign in to comment.