Giter VIP home page Giter VIP logo

keymaster's Introduction

Keymaster

There is no password, only Zuul.


Build Status

Keymaster provides an easy way to upload your SSH keys to services like Github and Bitbucket. It's useful for authorizing machines from which you can't easily access a web browser or your LastPass account.

How it works:

  1. You upload your public key to the web app using one of our clients (coming soon):
    • CLI
    • Eclipse plugin
    • IntelliJ plugin
    • GUI
  2. The client returns a short URL that can be accessed from any computer.
  3. You use the link to authenticate with Github and Bitbucket to install your key.
  4. After a short time, the link expires and your key disappears from the server. Privacy protected!

Note:

This repository is for setting up the Keymaster server. If you simply want to use the service as a client, you can visit our website or download the command line tool.


The app is written in Flask and connects to a Postgres database. Nginx is used as a proxy to serve static content and pass uWSGI requests on to Flask.

Server requirements:

  • Linux with systemd (for now)
  • Python 2.7
  • Postgres server with development headers
  • Nginx
  • libpcre3 and libpcre3-dev
  • Bower

Server installation:

  1. Install dependencies
    1. Install Python 2.7, headers, PCRE, Nginx, Postgres through your preferred package manager
    2. sudo pip install -r requirements.txt
    3. bower install
  2. Set up your database
    1. Create a Postgres user and database for Keymaster
    2. psql -d <database> -U <user> -f db_init.sql
  3. Configure uWSGI
    1. Update paths, usernames, and groups in daemon/keymaster.ini and daemon/keymaster.service
    2. Copy or symlink daemon/keymaster.service to /etc/systemd/system/keymaster.service
    3. sudo service keymaster start
    4. sudo service keymaster enable
  4. Configure Nginx passthrough
    1. Update paths in daemon/keymaster.nginx
    2. Copy or symlink daemon/keymaster.nginx to /etc/nginx/conf.d/keymaster
    3. sudo service nginx restart
  5. Copy config.spec.py to config.py and update the built-in settings.

REST API for developing clients

  • POST /k uploads a key to the site. Form Parameters
    • public_key: the text of the public key to upload. Response: A URL to the "key installation" page.
  • GET /k/<key_id>/raw fetches the raw text of a key.
  • POST /k/<key_id>/extend extends the expiration of a key by 30 minutes.
  • POST /k/<key_id>/expire immediately causes a key to expire.

Python API for developing connectors

Extend the Connector object. Implement the start_key_install and finish_key_install functions to start the OAuth flow, pass the key along, and install it. The name and logo properties define the UI and branding for the service.

keymaster's People

Contributors

sodle avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.