Skip to content

Add PKCS11 related flags: --rsh-pkcs11-label, --rsh-pkcs11-path #299

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add PKCS11 related flags: --rsh-pkcs11-label, --rsh-pkcs11-path #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions cli/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,8 @@ Not after (expires): %s (%s)
AddGlobalFlag("rsh-insecure", "", "Disable SSL verification", false, false)
AddGlobalFlag("rsh-client-cert", "", "Path to a PEM encoded client certificate", "", false)
AddGlobalFlag("rsh-client-key", "", "Path to a PEM encoded private key", "", false)
AddGlobalFlag("rsh-pkcs11-label", "", "Label of the PKCS11 token", "", false)
AddGlobalFlag("rsh-pkcs11-path", "", "Path to the PKCS11 library", "", false)
AddGlobalFlag("rsh-ca-cert", "", "Path to a PEM encoded CA cert", "", false)
AddGlobalFlag("rsh-ignore-status-code", "", "Do not set exit code from HTTP status code", false, false)
AddGlobalFlag("rsh-retry", "", "Number of times to retry on certain failures", 2, false)
Expand Down Expand Up @@ -764,6 +766,12 @@ func Run() (returnErr error) {
if caCert, _ := GlobalFlags.GetString("rsh-ca-cert"); caCert != "" {
viper.Set("rsh-ca-cert", caCert)
}
if pkcs11Label, _ := GlobalFlags.GetString("rsh-pkcs11-label"); pkcs11Label != "" {
viper.Set("rsh-pkcs11-label", pkcs11Label)
}
if pkcs11Path, _ := GlobalFlags.GetString("rsh-pkcs11-path"); pkcs11Path != "" {
viper.Set("rsh-pkcs11-path", pkcs11Path)
}
if query, _ := GlobalFlags.GetStringArray("rsh-query"); len(query) > 0 {
viper.Set("rsh-query", query)
}
Expand Down
10 changes: 10 additions & 0 deletions cli/request.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,16 @@ func MakeRequest(req *http.Request, options ...requestOption) (*http.Response, e
if caCert := viper.GetString("rsh-ca-cert"); caCert != "" {
config.TLS.CACert = caCert
}
if pkcs11Label := viper.GetString("rsh-pkcs11-label"); pkcs11Label != "" {
config.TLS.PKCS11 = &PKCS11Config{
Label: pkcs11Label,
}
}
if pkcs11Path := viper.GetString("rsh-pkcs11-path"); pkcs11Path != "" {
if config.TLS.PKCS11 != nil && config.TLS.PKCS11.Label != "" {
config.TLS.PKCS11.Path = pkcs11Path
}
}

if config.TLS.InsecureSkipVerify {
LogWarning("Disabling TLS security checks")
Expand Down
32 changes: 17 additions & 15 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,23 @@ You can quickly determine which is being used via `restish localhost -v 2>&1 | g

The global options in addition to `--help` and `--version` are:

| Argument | Env Var | Example | Description |
| --------------------------- | ------------------- | ------------------- | ------------------------------------------------------------------------------------------ |
| `-f`, `--rsh-filter` | `RSH_FILTER` | `body.users[].id` | Filter response via [Shorthand query](https://github.com/danielgtaylor/shorthand#querying) |
| `-H`, `--rsh-header` | `RSH_HEADER` | `Version:2020-05` | Set a header name/value |
| `--rsh-insecure` | `RSH_INSECURE` | | Disable TLS certificate checks |
| `--rsh-client-cert` | `RSH_CLIENT_CERT` | `/etc/ssl/cert.pem` | Path to a PEM encoded client certificate |
| `--rsh-client-key` | `RSH_CLIENT_KEY` | `/etc/ssl/key.pem` | Path to a PEM encoded private key |
| `--rsh-ca-cert` | `RSH_CA_CERT` | `/etc/ssl/ca.pem` | Path to a PEM encoded CA certificate |
| `--rsh-no-paginate` | `RSH_NO_PAGINATE` | | Disable automatic `next` link pagination |
| `-o`, `--rsh-output-format` | `RSH_OUTPUT_FORMAT` | `json` | [Output format](/output.md), defaults to `auto` |
| `-p`, `--rsh-profile` | `RSH_PROFILE` | `testing` | Auth profile name, defaults to `default` |
| `-q`, `--rsh-query` | `RSH_QUERY` | `search=foo` | Set a query parameter |
| `-r`, `--rsh-raw` | `RSH_RAW` | | Raw output for shell processing |
| `-s`, `--rsh-server` | `RSH_SERVER` | `https://foo.com` | Override API server base URL |
| `-v`, `--rsh-verbose` | `RSH_VERBOSE` | | Enable verbose output |
| Argument | Env Var | Example | Description |
| --------------------------- | ------------------- | --------------------------------------| ------------------------------------------------------------------------------------------ |
| `-f`, `--rsh-filter` | `RSH_FILTER` | `body.users[].id` | Filter response via [Shorthand query](https://github.com/danielgtaylor/shorthand#querying) |
| `-H`, `--rsh-header` | `RSH_HEADER` | `Version:2020-05` | Set a header name/value |
| `--rsh-insecure` | `RSH_INSECURE` | | Disable TLS certificate checks |
| `--rsh-client-cert` | `RSH_CLIENT_CERT` | `/etc/ssl/cert.pem` | Path to a PEM encoded client certificate |
| `--rsh-client-key` | `RSH_CLIENT_KEY` | `/etc/ssl/key.pem` | Path to a PEM encoded private key |
| `--rsh-ca-cert` | `RSH_CA_CERT` | `/etc/ssl/ca.pem` | Path to a PEM encoded CA certificate |
| `--rsh-pkcs11-label` | `RSH_PKCS11_LABEL` | | Label of the PKCS11 token |
| `--rsh-pkcs11-path` | `RSH_PKCS11_PATH` | `/usr/lib/pkcs11/opensc-pkcs11.so` | Path to the PKCS11 library |
| `--rsh-no-paginate` | `RSH_NO_PAGINATE` | | Disable automatic `next` link pagination |
| `-o`, `--rsh-output-format` | `RSH_OUTPUT_FORMAT` | `json` | [Output format](/output.md), defaults to `auto` |
| `-p`, `--rsh-profile` | `RSH_PROFILE` | `testing` | Auth profile name, defaults to `default` |
| `-q`, `--rsh-query` | `RSH_QUERY` | `search=foo` | Set a query parameter |
| `-r`, `--rsh-raw` | `RSH_RAW` | | Raw output for shell processing |
| `-s`, `--rsh-server` | `RSH_SERVER` | `https://foo.com` | Override API server base URL |
| `-v`, `--rsh-verbose` | `RSH_VERBOSE` | | Enable verbose output |

Configuration file keys are the same as long-form arguments without the `--` prefix.

Expand Down