From 48aa7e5db183b19f4ebfc3e157ee4c4122267f56 Mon Sep 17 00:00:00 2001 From: Dave Grijalva Date: Tue, 26 Aug 2014 14:41:32 -0700 Subject: [PATCH] documentation --- VERSION_HISTORY.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/VERSION_HISTORY.md b/VERSION_HISTORY.md index 63ec873..7ee63ba 100644 --- a/VERSION_HISTORY.md +++ b/VERSION_HISTORY.md @@ -2,6 +2,12 @@ #### 2.0.0 +There were two major reasons for breaking backwards compatibility with this update. The first was a refactor required to expand the width of the RSA and HMAC-SHA signing implementations. There will likely be no required code changes to support this change. + +The second update, while unfortunately requiring a small change in integration, is required to open up this library to other signing methods. Not all keys used for all signing methods have a single standard on-disk representation. Requiring `[]byte` as the type for all keys proved too limiting. Additionally, this implementation allows for pre-parsed tokens to be reused, which might matter in an application that parses a high volume of tokens with a small set of keys. Backwards compatibilty has been maintained for passing `[]byte` to the RSA signing methods, but they will also accept `*rsa.PublicKey` and `*rsa.PrivateKey`. + +It is likely the only integration change required here will be to change `func(t *jwt.Token) ([]byte, error)` to `func(t *jwt.Token) (interface{}, error)` when calling `Parse`. + * **Compatibility Breaking Changes** * `SigningMethodHS256` is now `*SigningMethodHMAC` instead of `type struct` * `SigningMethodRS256` is now `*SigningMethodRSA` instead of `type struct`