From 9bf5907f61e752d9b5733ee44481441867d98b1b Mon Sep 17 00:00:00 2001 From: ojab Date: Fri, 30 Jun 2017 12:20:50 +0000 Subject: [PATCH] Fix typo in HS512256 algorithm description --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6edd953d..f63f951c 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ puts decoded_token **HMAC** (default: HS256) * HS256 - HMAC using SHA-256 hash algorithm (default) -* HS512256 - HMAC using SHA-512/256 hash algorithm (only available with RbNaCl; see note below) +* HS512256 - HMAC using SHA-512-256 hash algorithm (only available with RbNaCl; see note below) * HS384 - HMAC using SHA-384 hash algorithm * HS512 - HMAC using SHA-512 hash algorithm @@ -85,7 +85,7 @@ decoded_token = JWT.decode token, hmac_secret, true, { :algorithm => 'HS256' } puts decoded_token ``` -Note: If [RbNaCl](https://github.com/cryptosphere/rbnacl) is loadable, ruby-jwt will use it for HMAC-SHA256, HMAC-SHA512/256, and HMAC-SHA512. RbNaCl enforces a maximum key size of 32 bytes for these algorithms. +Note: If [RbNaCl](https://github.com/cryptosphere/rbnacl) is loadable, ruby-jwt will use it for HMAC-SHA256, HMAC-SHA512-256, and HMAC-SHA512. RbNaCl enforces a maximum key size of 32 bytes for these algorithms. [RbNaCl](https://github.com/cryptosphere/rbnacl) requires [libsodium](https://github.com/jedisct1/libsodium), it can installed