在 C# 中使用 JSONWebKey 或 JSONWebKeySet 解密 JSONWebToken

Question

我在 Internet 上四处游荡，尝试各种解决方案，但所有解决方案都以各种方式出现问题。我写这篇文章是希望 Whosebug 上熟悉类似工作流程的人或 Microsoft.IdentityModel.JsonWebTokens 团队的人可以介入以提供帮助。

我想做的是解密由 JSONWebKey (JWK) 加密的 OAuth 访问令牌，以便我可以读取声明数据。现在我停留在解密步骤。我在 OS X 上使用 C#，在 Visual Studio 上使用 Mac。我尝试过的方法包括使用较旧的 JWT 库并尝试通过 round-about 方式创建各种 RSA object。但是，我想做的是类似以下的事情：

using System;
using System.Linq;
using Microsoft.IdentityModel.JsonWebTokens;
using Microsoft.IdentityModel.Tokens;
using System.Security.Cryptography;
using Microsoft.AspNetCore.WebUtilities;

namespace jwtdecoder {
    class Program {
        static void Main(string[] args) {
            
            /* Exact string of a token retrieved from the IDP/OAuth server. */
            String token = "BASE64EncodedTokenGoesHere";

            /* Trust me that we have a valid JWKS string here that has all the properties mentioned in the RSA params below 
             * and uses RSA OAEP 256 */
            String jwks = "JWKSSTRINGGOESHERE";


            /* Get our basic objects from the Strings above. */
            JsonWebKeySet exampleJWKS = new JsonWebKeySet(jwks);
            JsonWebKey exampleJWK = exampleJWKS.Keys.First();
            JsonWebToken exampleJWT = new JsonWebToken(token);

            /* Create RSA from Elements in JWK */
            RSAParameters rsap = new RSAParameters{
                Modulus = WebEncoders.Base64UrlDecode(exampleJWK.N),
                Exponent = WebEncoders.Base64UrlDecode(exampleJWK.E),
                D = WebEncoders.Base64UrlDecode(exampleJWK.D),
                P = WebEncoders.Base64UrlDecode(exampleJWK.P),
                Q = WebEncoders.Base64UrlDecode(exampleJWK.Q),
                DP = WebEncoders.Base64UrlDecode(exampleJWK.DP),
                DQ = WebEncoders.Base64UrlDecode(exampleJWK.DQ),
                InverseQ = WebEncoders.Base64UrlDecode(exampleJWK.QI)
            };
            RSA rsa = RSA.Create();
            rsa.ImportParameters(rsap);
            RsaSecurityKey rsakey = new RsaSecurityKey(rsa);

            /* Create a JSON Token Handler and Try Decrypting the Token */
            JsonWebTokenHandler exampleHandler = new JsonWebTokenHandler();
            TokenValidationParameters validationParameters = new TokenValidationParameters {
                ValidateAudience = false,
                ValidateIssuer = false,
                RequireSignedTokens = false, /* Have also tried with this set to True */
                TokenDecryptionKey = rsakey
            };

            String clearToken = exampleHandler.DecryptToken(exampleJWT, validationParameters);
            /* The line above results in an error
             * "IDX10609: Decryption failed. No Keys tried: token: 'System.String'."
             */
        }
    }
}

我的 IDP/OAuth 服务器是 Micro Focus / NetIQ Access Manager，使用我在其外部生成的 JSON Web 密钥（并作为新的资源服务器导入）。但是，我认为细节与问题无关。当我在 C# 中创建 JSONWebKey 和 JSONWebToken objects 时，我看到了我期望看到的属性，并且没有出现异常。我还可以使用 non-C# 工具解码（而不是解密）令牌字符串，并查看我期望的 header 属性等。

具体来说，上面header代码中的例子JWTobject如下：

{{ "alg": "RSA-OAEP-256", "enc": "A128CBC-HS256", "typ": "JWT", "cty": "JWT", "zip": "DEF", "kid": "5BbVY7F77gz9LWE4tUjXwNFt9qhINvWBR7Pkm1ZJlEA" }}

exampleJWT object 还具有以下属性，其值看起来是编码的或加密的：EncodedHeader、EncodedToken、EncryptedKey、CipherText 和 AuthenticationTag 目前object中没有明文索赔数据或日期数据。

我的想法是，我没有为 Decrypt 方法正确设置代码以正确应用 JSONWebToken RSA 信息，以便可以将令牌转换为明文。但是，正如我所说，我使用其他 C# 类和方法尝试了一系列不同的方法，其中 none 已经取得了更大的成功。我很想知道我对这个过程的根本误解是什么。提前谢谢你。

下面回答 Michal 的问题：四个点（当 base-64 编码时），所以五个部分。

Answer 1

感谢 Michal 确认我所做的应该有效，并鼓励我调试 JSONWebToken Nuget 包。由于 NuGet 包中不包含调试信息，因此我从源代码构建 Microsoft.IdentityModel.JsonWebTokens 并逐步解决了问题。

有两个问题，都是致命的。

JWT 解密密钥 ID 需要与提供的解密密钥 ID 匹配，我没有将 KID 从 JWKS 复制到 RSA 对象。在修复此问题时，我还复制了密钥大小，尽管默认值会起作用。我的示例代码需要更改如下：
```
/* Existing code. */
RSA rsa = RSA.Create();
rsa.ImportParameters(rsap);
RsaSecurityKey rsakey = new RsaSecurityKey(rsa);
/* New stuff here. */
rsakey.KeyId = exampleJWK.KeyId;
rsa.KeySize = exampleJWK.KeySize;
```
第二个问题应该会在几个月后在包含 Microsoft.IdentityModel.JsonWebTokens 命名空间的 ADAL 库的未来版本中得到解决。尽管 dotnet 通常在所有平台上都支持 RSA-OAEP-256，但它尚不支持 ADAL 的 JSONWebToken 实现。
跨平台支持说明：
https://docs.microsoft.com/en-us/dotnet/standard/security/cross-platform-cryptography
GitHub 关于 ADAL 和 RSA-OAEP-256 的问题：
https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/issues/1293

我使用 RSA_15 生成并安装了一个新的 JWKS，从 Access Manager 中获取了一个新的 OAuth JWT，并且我的代码有效。最后，我得到了一个字符串，我可以将其放入一个新的 JSONWebToken 对象中，并且所有字段（声明、日期等）都存在且正确。

对于那些想知道这一切意义何在的人，我真的很喜欢 C# 和 Microsoft 的更新库，但更喜欢在 Mac 上开发并部署到 Linux。我真的很喜欢 NAM（访问管理器）作为本地 SAML/OAuth 解决方案。但我想使用它们在资源服务器/应用程序中解密令牌，而不是将它们发送回 NAM 进行验证和解密（更快且移动部件更少）。所以现在我可以做到了。一旦库支持 RSA-OAEP-256，我将替换 JWKS 以获得更好的安全性。

最后，回答 Michal 的最后一个问题，根据异常中 System.string 引用上方的 GitHub link 是当前实现的一部分，但显然不应该是。

Answer 2

大约 3 周前，我运行也进入了这个问题。

如您所知，IdentityModel 目前不支持 RSA-OAEP-256。在实现之前使用 RSA_15 对我来说不是一个选项，但是 .NET 支持 RSA-OAEP-256，所以我利用 CryptoProviderFactory 将其委托给我自己的实现（这基本上是对Decrypt).

首先你需要使用 ICryptoProvider 接口实现一个 class:

public class CryptoProvider : ICryptoProvider
{
    public bool IsSupportedAlgorithm(string algorithm, params object[] args)
    {
      if (algorithm == "RSA-OAEP-256")
        return true;

      return false;
    }

    public object Create(string algorithm, params object[] args)
    {
      if (algorithm.Equals("RSA-OAEP-256"))
        return new RsaOaepKeyWrapProvider(args[0] as SecurityKey, algorithm, (bool)args[1]);

      return null;
    }

    public void Release(object cryptoInstance)
    {
      throw new NotImplementedException();
    }
}

然后您需要从 KeyWrapProvider 派生：

public class RsaOaepKeyWrapProvider : KeyWrapProvider
{
    public RsaOaepKeyWrapProvider(SecurityKey key, string algorithm, bool willUnwrap)
    {
      Key = key;
      Algorithm = algorithm;
    }

    protected override void Dispose(bool disposing)
    {
    }

    public override byte[] UnwrapKey(byte[] keyBytes)
    {
      //Get your RSA Object
      var rsa = CryptoConfig.GetRSA();
      return rsa.Decrypt(keyBytes, RSAEncryptionPadding.OaepSHA256);
    }

    //We don't need Key Wrapping
    public override byte[] WrapKey(byte[] keyBytes)
    {
      throw new NotImplementedException();
    }

    public override string Algorithm { get; }
    public override string Context { get; set; }
    public override SecurityKey Key { get; }
}

最后您需要将 rsakey.CryptoProviderFactory 设置为 CryptoProvider class.

的一个实例

除了并非所有 KeyWrapProvider 都受支持这一事实之外，IdentityModel.Tokens 还缺乏对使用 AES-GCM 的身份验证加密的支持。通过对上述实现进行一些调整，您也可以支持它。当这最终在库中实现时，您只需删除额外的代码，而无需更改其他实现。

在 C# 中使用 JSONWebKey 或 JSONWebKeySet 解密 JSONWebToken

Decrypting JSONWebToken Using JSONWebKey or JSONWebKeySet in C#

c#

rsa

jwt

adal