JSON Web Token and its family (JSON Web Signature, JSON Web Encryption and JSON Web Key) in Ruby

Kyle Drake 00d9c3d34e drop_activesupport branch 8 years ago
lib acc409b313 Remove ActiveSupport 9 years ago
spec 00d9c3d34e drop_activesupport branch 8 years ago
.gitignore 9033983eee rm gemfile.lock from repo 12 years ago
.gitmodules 90f6947927 make submodule readonly 12 years ago
.rspec 8afa3a3104 first commit 13 years ago
.travis.yml 06b6670601 goodbye ruby 1.9.3 9 years ago
Gemfile 80e765253f allow skipping verification when decoding 12 years ago
LICENSE 8afa3a3104 first commit 13 years ago
README.md eaf0532ce4 link 9 years ago
Rakefile 69e6dc8fb7 goodbye 1.8 10 years ago
VERSION caaa29be43 v1.5.2 9 years ago
json-jwt.gemspec acc409b313 Remove ActiveSupport 9 years ago

README.md

JSON::JWT

JSON Web Token and its family (JSON Web Signature, JSON Web Encryption and JSON Web Key) in Ruby

Build Status

Installation

gem install json-jwt

Resources

Examples

require 'json/jwt'

private_key = OpenSSL::PKey::RSA.new <<-PEM
-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEAyBKIFSH8dP6bDkGBziB6RXTTfZVTaaNSWNtIzDmgRFi6FbLo
 :
-----END RSA PRIVATE KEY-----
PEM

public_key = OpenSSL::PKey::RSA.new <<-PEM
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyBKIFSH8dP6bDkGBziB6
 :
-----END PUBLIC KEY-----
PEM

# Sign & Encode
claim = {
  iss: 'nov',
  exp: 1.week.from_now,
  nbf: Time.now
}
jws = JSON::JWT.new(claim).sign(private_key, :RS256)
jws.to_s

# Decode & Verify
input = "jwt_header.jwt_claims.jwt_signature"
JSON::JWT.decode(input, public_key)

For more details, read Documentation Wiki.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2011 nov matake. See LICENSE for details.