dexy

module
v1.0.6 Latest Latest
Warning

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

Go to latest
Published: Mar 7, 2018 License: MIT

README

Dexy

Introduction

Dexy is a simple command line tool to do 3LO authentication with an external provider and give a token back.

Installation

Linux

wget https://github.com/Chronojam/dexy/releases/download/v1.0.0/linux-amd64 -O dexy && sudo mv dexy /usr/local/bin/dexy

MacOSX

wget https://github.com/Chronojam/dexy/releases/download/v1.0.0/darwin-amd64 -O dexy && sudo mv dexy /usr/local/bin/dexy

Windows

Grab the windows binary from the release page and give it a .exe extension

Usage

Dexy works on client_id/client_secret pairs. As such you'll need to generate one and authorize it with your provider. In dex this might look like this:

staticClients:
- id: dexy
  secret: dexy-secret
  name: 'Dexy'
  redirectURIs:
  # This needs to be a local address, as dexy will start a webserver
  # for you to callback too, it will need to match the host/port in the dexy config
  - 'http://localhost.com:10000/oauth2/callback'`

Dexy also has its own configuration file, which it will search for in the following locations:

$HOME/.dexy.yaml
./.dexy.yaml
/etc/.dexy.yaml
auth:
  dex_host: "https://dex.mycompany.com"
  callback_host: "localhost"
  callback_port: 10111
  # This will generate a callbackurl like http://localhost:10111/oauth2/callback
  client_id: "dexy"
  client_secret: "dexy-secret"

It can only support a single provider at a time, if you need to change providers, you can delete the dexy token file in ~/.dexy-token.yaml

Building

Pretty self explainatory but

make test
make build

Will drop the compiled binaries under .build/

Contributing

All PR's are welcome, just open one aganist master

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL