Giter Club home page Giter Club logo

keybase's Introduction

keybase

keybase.io command line client

This is an attempt at rewriting the keybase.io command line client in Go.

Currently supported:

  • logging in
  • look up a user
  • fetch a user's public key

The api/ subpackage contains an interface to the keybase.io API; it will have a better record of supported features during development.

Things you should know about this package:

  • As long as I own this code, you will not be able to upload a private key to Keybase. Sorry, but at this time, I am unwilling to upload a private key to someone else's computer; this is non-negotiable.

Usage

keybase [-u user] [-out file] [-pub file] command [arguments]

The -u flag tells keybase what username to log in as; this is only used for authenticated commands.

Unauthenticated commands

These commands do not require logging in.

  • lookup: lookup takes a list of one or more users, and prints information about them to standard out. It will print out most available information, but it won't print out their public key to declutter standard output.
  • fetch: fetch takes a username and attempts to download the public key for the user. The file is saved in the file specified by -out, or ".pub". If the output file is "-", the key is printed to standard output.

Authenticated commands

These commands require logging in: your username should be specified with "-u", and keybase will read your password from the terminal.

  • testlogin: this command takes no arguments and just attempts to login. This is primarily useful as a test command to ensure logins work.
  • upload: this command uploads the public key specified by the -pub flag to the account; it will replace any existing key there. This public key should be an ASCII-armoured OpenPGP-exported public key.
  • delete: this command removes the user's public key from the account.

TODO

  1. Hook upload into an OpenPGP key ring, and allow the user to specify the key ID to upload by default (while allowing files.)
  2. Figure out the Go OpenPGP package to allow for signatures (i.e. the sig/post_auth endpoint.
  3. Pester the Keybase folks about verifying using this client (and encrypting and so forth).

License

This program is currently not very useful, but it (and the current API implementation) are open sourced under the ISC license. See the LICENSE file in either the project root or in the api package for the full text.

keybase's People

Contributors

kisom avatar dgryski avatar maxtaco 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.