RSA 密钥生成

代码示例： auth-jwt-rs256

RSA (Rivest–Shamir–Adleman) 是一种广泛使用的公钥密码系统，可实现安全的数据传输、数字签名和密钥交换。

RS256 是 RSA 加密算法的一部分，它利用 SHA-256 进行哈希处理，并使用密钥（通常为 2048 位、4096 位或更高）来保护数字通信。

在 JSON Web Token 身份验证领域，RS256 起着至关重要的作用，因为 JWT 的完整性和真实性可以通过签名机制（如 RS256，其中使用公钥/私钥对）进行验证。这确保了令牌中包含的信息保持防篡改且可信。

在本节中，您将学习如何生成此类密钥，并将其与 Ktor 提供的 Authentication JWT 插件结合使用。

生成 RSA 私钥

要生成私钥，您可以使用 OpenSSL、ssh-keygen 或您选择的其他用于创建身份验证密钥对的工具。出于演示目的，我们将使用 OpenSSL。

在新的终端窗口中，运行以下命令：

openssl genpkey 命令使用 RSA 算法生成一个私有的 2048 位密钥，并将其存储在指定的文件中，此处为 ktor.pk8。该文件的内容是 Base64 编码的，因此在派生公钥之前需要对其进行解码。

要使用来自 代码示例 的私钥，请导航到 src/main/resources 中的 application.conf 文件，并将私钥提取到一个新的 .pk8 文件中。

派生公钥

为了从之前生成的私钥中派生出公钥，您需要执行以下步骤：

1. 解码私钥。
2. 提取公钥。
3. 以 PEM 格式保存公钥。

要使用 OpenSSL 执行此操作，请运行以下命令：

• openssl rsa：这是用于处理 RSA 密钥的 OpenSSL 命令。在此上下文中，它用于执行与 RSA 密钥相关的操作。
• -in ktor.pk8：此选项指定输入文件 (ktor.pk8)，OpenSSL 应从中读取 RSA 私钥。
• -pubout：此选项指示 OpenSSL 输出与输入文件中提供的私钥相对应的公钥。
• |：管道 (|) 符号用于将前一个命令的输出（由 openssl rsa 生成的公钥）重定向到 tee 命令。
• tee ktor.spki：tee 是一个命令行实用程序，它从标准输入读取并写入标准输出和一个或多个文件。命令的这一部分指示 tee 将接收到的输入写入名为 ktor.spki 的文件。因此，公钥既会显示在终端上，也会保存在 ktor.spki 文件中。

有了公钥，您现在可以派生其指数和模数值。

提取模数和指数属性

现在您已经有了密钥对，您需要提取公钥的 e（指数）和 n（模数）属性，以便在 jwks.json 文件中使用它们。这需要以下步骤：

1. 从您创建的 .spki 文件中读取公钥。
2. 以易于阅读的格式显示有关密钥的信息。

要使用 OpenSSL 执行此操作，请运行以下命令：

• pkey：这是用于处理私钥和公钥的 OpenSSL 命令行实用程序。
• -in ktor.spki：指定包含 PEM 格式公钥的输入文件。在这种情况下，输入文件是 ktor.spki。
• -pubin：指示输入文件包含公钥。如果没有此选项，OpenSSL 将假设输入文件包含私钥。
• -noout：此选项防止 OpenSSL 输出编码后的公钥。该命令将仅显示有关公钥的信息，实际的密钥不会打印到控制台。
• -text：请求 OpenSSL 显示密钥的文本表示形式。这包括密钥类型、大小等详细信息，以及以易于阅读的形式显示的实际密钥数据。

预期的输出如下所示：

$ openssl pkey -in ktor.spki -pubin -noout -text
RSA Public-Key: (512 bit)
Modulus:
    00:b5:f2:5a:2e:bc:d7:20:b5:20:d5:4d:cd:d4:a5:
    7c:c8:9a:fd:d8:61:e7:e4:eb:58:65:1e:ea:5a:4d:
    4c:73:87:32:e0:91:a3:92:56:2e:a7:bc:1e:32:30:
    43:f5:fd:db:05:5a:08:b2:25:15:5f:ac:4d:71:82:
    2b:d0:87:b4:01
Exponent: 65537 (0x10001)

转换并编码模数和指数属性

在上一步中，您提取了 jwks.json 文件所需的 n 和 e 属性。但是，它们是十六进制格式。您现在需要将指数和模数的十六进制表示转换为它们各自的 Base64URL 编码。

指数

指数属性的十六进制值为 0x10001。要将该值转换为 Base64URL，请使用以下命令：

• echo 010001：命令的这一部分使用 echo 命令将字符串 "010001"（代表 RSA 密钥的公共指数 (e)）输出到标准输出。
• |：| 字符是一个管道，它获取前一个命令的输出并将其作为输入传递给后一个命令。
• xxd -p -r：此命令用于将十六进制转换为二进制。它接收十六进制输入并产生相应的二进制输出。
• | base64：命令的这一部分获取上一步的二进制输出，并使用 base64 命令将其编码为 Base64 格式。

NOTE

请注意，通过在左侧添加一个额外的 0，使用了偶数个十六进制数字。

这是上述指数值的预期输出：

$ echo 010001 | xxd -p -r | base64
AQAB

指数的 Base64URL 编码值为 AQAB，在这种情况下不需要进一步处理。在其他情况下，您可能需要按照下一步所示使用 tr 命令。

模数

对于 n 属性，您将使用 tr 实用程序进一步处理模数的十六进制表示。

NOTE

请注意，前导 00 字节已被省略。模数中的前导 00 字节与 RSA 公钥的 ASN.1 编码有关。在整数的 ASN.1 DER 编码中，如果整数的最高有效位为 0，则移除前导零字节。这是 ASN.1 编码规则的标准部分。 在 RSA 公钥的上下文中，模数是一个大端序整数，当以 DER 编码表示时，它遵循这些规则。移除前导零字节是为了确保根据 DER 规则正确解释该整数。

• echo "b5:f2:5a:2e:bc:d7:20:b5:20:d5:4d:cd:d4:a5: \ ... "：命令的这一部分回显一个多行十六进制字符串，代表一系列字节。每行末尾的反斜杠表示换行。
• tr -d ": "：tr 命令用于删除参数列表中指定的字符。在这里，它从十六进制字符串中移除冒号、空格和换行符，使其成为一个连续的十六进制数字字符串。
• xxd -p -r：xxd 是一个用于创建二进制文件的十六进制转储或将十六进制转储转换回二进制的实用程序。-p 选项指定没有行号或 ASCII 字符列的纯十六进制转储。-r 选项反转操作，将十六进制转换回二进制。
• base64：将上一步的二进制输出编码为 Base64 格式。
• tr +/ -_：将 Base64 输出中的 + 和 / 字符分别转换为 - 和 _。这是 URL 安全的 Base64 编码的常见修改。
• tr -d "= "：从最终的 Base64 编码字符串中移除任何等号 (=) 和换行符。

上述命令的输出为：

$ echo "b5:f2:5a:2e:bc:d7:20:b5:20:d5:4d:cd:d4:a5:
    7c:c8:9a:fd:d8:61:e7:e4:eb:58:65:1e:ea:5a:4d:
    4c:73:87:32:e0:91:a3:92:56:2e:a7:bc:1e:32:30:
    43:f5:fd:db:05:5a:08:b2:25:15:5f:ac:4d:71:82:
    2b:d0:87:b4:01" | tr -d ": 
" | xxd -p -r | base64 | tr +/ -_ | tr -d "=
"
tfJaLrzXILUg1U3N1KV8yJr92GHn5OtYZR7qWk1Mc4cy4JGjklYup7weMjBD9f3bBVoIsiUVX6xNcYIr0Ie0AQ

通过正确利用 tr 命令，模数字段已被编码为可在 jwks.json 文件中使用的 Base64URL 字符串。

填充 jwks.json 文件

在之前的步骤中，您收集了以下必要信息：

1. 一个 RSA 密钥对。
2. 以 Base64URL 格式表示的 RSA 公钥模数。
3. 以 Base64URL 格式表示的 RSA 公钥指数。

有了这些信息，您现在可以使用以下属性填充 Ktor 项目的 jwks.json 文件：

• e 和 n 值使用您在前面步骤中生成的 Base64URL 编码值。
• 密钥 ID（在这种情况下，kid 是从示例项目中派生的）。
• kty 属性为 RSA。

{
  "keys": [
    {
      "kty": "RSA",
      "e": "AQAB",
      "kid": "6f8856ed-9189-488f-9011-0ff4b6c08edc",
      "n":"tfJaLrzXILUg1U3N1KV8yJr92GHn5OtYZR7qWk1Mc4cy4JGjklYup7weMjBD9f3bBVoIsiUVX6xNcYIr0Ie0AQ"
    }
  ]
}

剩下的唯一步骤是指定您的私钥，以便您的 Ktor 项目可以将其用于身份验证。

定义私钥

设置好公钥信息后，最后一步是让您的 Ktor 项目能够访问您的私钥。

假设您已将私钥（即您在开始时生成的 .pk8 文件中的内容）提取到系统的环境变量中（在本例中名为 jwt_pk），那么您的 resources/application.conf 文件的 jwt 部分应类似于：

jwt {
  privateKey = ${jwt_pk}
  issuer = "http://0.0.0.0:8080/"
  audience = "http://0.0.0.0:8080/login"
  realm = "MyProject"
}