PyJWT/PyJWT.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "# PyJWT\n",
    "\n",
    "*A Python implementation of RFC 7519 (JSON Web Tokens)*\n",
    "\n",
    "https://pyjwt.readthedocs.io/\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## JSON Web Tokens (JWTs)\n",
    "\n",
    "JSON Web Tokens are an open, industry standard RFC 7519 method for representing claims securely between two parties.\n",
    "\n",
    "https://tools.ietf.org/html/rfc7519"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "### Introduction Video:\n",
    "\n",
    "https://jwt.io/introduction/\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Important!\n",
    "\n",
    "JWT contents are:\n",
    "\n",
    "- Signed (using HMAC or key pair)\n",
    "- *Not* Encrypted!\n",
    "\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Used For\n",
    "\n",
    "- Authentication\n",
    "- Information exchange"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Token Structure\n",
    "\n",
    "**Three-part string:**\n",
    "`xxxx.yyyy.zzzz`\n",
    "\n",
    "- Header\n",
    "- Payload\n",
    "- Signature\n",
    "\n",
    "**Example:**\n",
    "`eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ`"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Header\n",
    "\n",
    "```\n",
    "{\n",
    "  \"alg\": \"HS256\",\n",
    "  \"typ\": \"JWT\"\n",
    "}\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Payload\n",
    "\n",
    "```\n",
    "{\n",
    "  \"sub\": \"1234567890\",\n",
    "  \"name\": \"John Doe\",\n",
    "  \"admin\": true\n",
    "}\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Signature\n",
    "\n",
    "**HMAC SHA256**\n",
    "\n",
    "- base64UrlEncode(header) + \".\" + base64UrlEncode(payload)\n",
    "- secret"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Claims\n",
    "\n",
    "- Reserved\n",
    "  - iss (issuer)\n",
    "  - iat (issued time)\n",
    "  - exp (expiration)\n",
    "  - sub (subject)\n",
    "- Public (registered)\n",
    "- Private"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Example Payload\n",
    "\n",
    "```\n",
    "{\n",
    "   # 'Private' claims:\n",
    "   'actions': [\n",
    "\t   'get',\n",
    "\t   'complete',\n",
    "\t   ],\n",
    "   # JWT reserved claims:\n",
    "   'sub': thing_id,\n",
    "   'iat': datetime.utcnow(),\n",
    "   'exp': datetime.utcnow() + token_ttl,\n",
    "   'iss': 'CLEPY',\n",
    "}\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## Installing\n",
    "\n",
    "`pip install PyJWT`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Imports\n",
    "\n",
    "import jwt\n",
    "from datetime import datetime, timedelta"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Settings\n",
    "\n",
    "token_ttl = timedelta(days=1)\n",
    "secret = 'This is a totally insecure secret.'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Payload\n",
    "\n",
    "thing_id = 1234\n",
    "\n",
    "payload = {\n",
    "    'actions': [\n",
    "                'get',\n",
    "                'complete',\n",
    "                ],\n",
    "    'sub': thing_id,\n",
    "    'iat': datetime.utcnow(),\n",
    "    'exp': datetime.utcnow() + token_ttl,\n",
    "    'iss': 'CLEPY',\n",
    "    }\n",
    "payload"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Encode\n",
    "\n",
    "token = jwt.encode(payload, secret)\n",
    "token"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Decode\n",
    "\n",
    "jwt.decode(token, key=secret)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Don't Verify\n",
    "\n",
    "options = {\n",
    "           'verify_signature': False,\n",
    "           }\n",
    "jwt.decode(token, options=options)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Shorter TTL\n",
    "\n",
    "short_ttl = timedelta(seconds=10)\n",
    "payload2 = {\n",
    "    'actions': [\n",
    "                'get',\n",
    "                'complete',\n",
    "                ],\n",
    "    'sub': thing_id,\n",
    "    'iat': datetime.utcnow(),\n",
    "    'exp': datetime.utcnow() + short_ttl,\n",
    "    'iss': 'CLEPY',\n",
    "    }\n",
    "token2 = jwt.encode(payload2, secret)\n",
    "token2 "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Try after 10s\n",
    "\n",
    "jwt.decode(token2, key=secret)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Ignore sig and exp\n",
    "\n",
    "options = {\n",
    "           'verify_signature': False,\n",
    "           'verify_exp': False,\n",
    "           }\n",
    "jwt.decode(token2, options=options)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false,
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "outputs": [],
   "source": [
    "# Verify issuer\n",
    "\n",
    "jwt.decode(token, key=secret, issuer='CLEPY')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "slideshow": {
     "slide_type": "slide"
    }
   },
   "source": [
    "## More info\n",
    "\n",
    "https://jwt.io/"
   ]
  }
 ],
 "metadata": {
  "celltoolbar": "Slideshow",
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.5.2"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}