README.rst
httpie-jwt-auth |travis build status|_ |coveralls status|_ |codeclimate status|_ |pypi status|_
===============================================================================================
`JWTAuth (JSON Web Tokens) <https://github.com/teracyhq/httpie-jwt-auth>`_ auth plugin for
`HTTPie <https://github.com/jkbr/httpie>`_.
Installation
------------
- Latest stable version:
.. code-block:: bash
$ pip install -U httpie-jwt-auth
- Latest developing version:
.. code-block:: bash
$ pip install -U https://github.com/teracyhq/httpie-jwt-auth/archive/develop.zip
- This version requires HTTPie v1.0.0 and above. If you can not use this new version, you can use:
https://github.com/teracyhq/httpie-jwt-auth/tree/v0.2.1
Supported HTTPie Version
------------------------
- `httpie-jwt-auth (version >= 0.4.0)` supports `HTTPie (version >= 1.0.0)`
- `httpie-jwt-auth (version > 0.2.1)` supports `HTTPie (version >= 0.9.7)`
- `httpie-jwt-auth (version <= 0.2.1)` supports `HTTPie (version >= 0.9.2)`
Usage
-----
- Normal:
.. code-block:: bash
$ http --auth-type=jwt --auth="<token>" example.org -h
GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token_Prefix abc
Connection: keep-alive
Host: example.org
User-Agent: HTTPie/0.9.7
- By default, the ``Bearer`` prefix auth token is used, you can choose another prefix:
.. code-block:: bash
$ JWT_AUTH_PREFIX=JWT http --auth-type=jwt --auth="<token>" example.org -h
- Also by default, the ``Authorization`` auth header is used, but you can choose another one:
.. code-block:: bash
$ JWT_AUTH_HEADER=X-Foobar-Authorization http --auth-type=jwt --auth="<token>" example.org -h
- Sometimes you don't need to expose the JWT token on the command line, you can use the environment variable:
.. code-block:: bash
$ export JWT_AUTH_TOKEN=secret
And it should work:
.. code-block:: bash
$ http teracy.com --auth-type=jwt -v
GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Bearer secret
Connection: keep-alive
Host: teracy.com
User-Agent: HTTPie/0.9.7
You can combine the usage whatever you like for your cases.
Contributing
------------
Please create pull requests to the `develop` branch by following http://dev.teracy.org/docs/workflow.html
Developing
----------
We use Docker workflow for development now. To start developing:
- Make sure to use teracy-dev by following: http://dev.teracy.org/docs/getting_started.html
- Fork this repo and clone to `~/teracy-dev/workspace`:
.. code-block:: bash
$ cd ~/teracy-dev/workspace
$ git clone <your_forked_repo>
$ cd httpie-jwt-auth
$ git remote add upstream git@github.com:teracyhq/httpie-jwt-auth.git
- SSH into the VM to run commands as following:
.. code-block:: bash
$ cd ~/teracy-dev
$ vagrant ssh
$ ws
$ cd httpie-jwt-auth
$ docker-compose up # to test all the supported httpie versions with the most used Python version
$ docker-compose up httpie_latest # to test with the latest httpie version with the most used Python version
$ docker-compose -f docker-compose.yml -f docker-compose.py36.yml up # to test all the supported httpie versions with Python 3.6
- Register your account at https://travis-ci.org and enable `httpie-jwt-auth` repo
- Add the following settings to the travis-ci repo:
+ `DOCKER_USER` for the user or organization Docker namespace
+ `DOCKER_USERNAME` for the username of the Docker Hub
+ `DOCKER_PASSWORD` for the password of the Docker Hub
+ `IMG_REPO` for the docker repo on your `DOCKER_USER` account
+ `IMG_REPO_PREFIX` is optional
See .travis.yml for details
- Start creating new Docker images to be shared within our community
FAQs
----
#. How to load JWT token from a file?
.. code-block:: bash
$ http --auth-type=jwt --auth="$(cat mytoken.txt)" example.org
See: https://github.com/teracyhq/httpie-jwt-auth/issues/4
#. How to use auth prefix other than default `Bearer`, for example `Token_Prefix` instead?
You could use environment variable to specify `JWT_AUTH_PREFIX` for permanent prefix usage:
.. code-block:: bash
$ export JWT_AUTH_PREFIX=Token_Prefix
and it should work:
.. code-block:: bash
$ http teracy.com --auth-type=jwt --auth="abc" -v
GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token_Prefix abc
Connection: keep-alive
Host: teracy.com
User-Agent: HTTPie/0.9.7
or for one time usage only with the specified jwt auth prefix:
.. code-block:: bash
$ JWT_AUTH_PREFIX=Token_Prefix http teracy.com --auth-type=jwt --auth="abc" -v
GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: Token_Prefix abc
Connection: keep-alive
Host: teracy.com
User-Agent: HTTPie/0.9.7
Discussions
-----------
Join us:
- https://groups.google.com/forum/#!forum/teracy
- https://www.facebook.com/groups/teracy
Get our news:
- https://www.facebook.com/teracyhq
- https://twitter.com/teracyhq
Author and contributors
-----------------------
See more details at `AUTHORS.md` and `CONTRIBUTORS.md` files.
License
-------
BSD License
::
Copyright (c) Teracy, Inc. and individual contributors.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of Teracy, Inc. nor the names of its contributors may be used
to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.. |travis build status| image:: https://travis-ci.org/teracyhq/httpie-jwt-auth.png?branch=develop
.. _travis build status: https://travis-ci.org/teracyhq/httpie-jwt-auth
.. |coveralls status| image:: https://coveralls.io/repos/github/teracyhq/httpie-jwt-auth/badge.svg?branch=develop
.. _coveralls status: https://coveralls.io/github/teracyhq/httpie-jwt-auth?branch=develop
.. |codeclimate status| image:: https://codeclimate.com/github/teracyhq/httpie-jwt-auth/badges/gpa.svg
.. _codeclimate status: https://codeclimate.com/github/teracyhq/httpie-jwt-auth
.. |pypi status| image:: https://badge.fury.io/py/httpie-jwt-auth.svg
.. _pypi status: https://badge.fury.io/py/httpie-jwt-auth