Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow Jwt payload to be the empty string. #2745

Merged
merged 1 commit into from
Jul 26, 2024
+175 −75
Merged

Allow Jwt payload to be the empty string. #2745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Microsoft.IdentityModel.JsonWebTokens/Json/JsonWebToken.PayloadClaimSet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ internal JsonClaimSet CreatePayloadClaimSet(byte[] bytes, int length)

internal JsonClaimSet CreatePayloadClaimSet(ReadOnlySpan<byte> byteSpan)
{
if (byteSpan.Length == 0)
return new JsonClaimSet([]);

Utf8JsonReader reader = new(byteSpan);
if (!JsonSerializerPrimitives.IsReaderAtTokenType(ref reader, JsonTokenType.StartObject, true))
throw LogHelper.LogExceptionMessage(
Expand Down
7 changes: 3 additions & 4 deletions src/Microsoft.IdentityModel.JsonWebTokens/JsonWebToken.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public JsonWebToken(ReadOnlyMemory<char> encodedTokenMemory)
/// Initializes a new instance of the <see cref="JsonWebToken"/> class where the header contains the crypto algorithms applied to the encoded header and payload.
/// </summary>
/// <param name="header">A string containing JSON which represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT.</param>
/// <param name="payload">A string containing JSON which represents the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value }.</param>
/// <param name="payload">A string containing JSON which represents the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value }. Can be the empty.</param>
brentschmaltz marked this conversation as resolved.
Show resolved Hide resolved
/// <remarks>
/// See: <see href="https://datatracker.ietf.org/doc/html/rfc7519"/> (JWT).
/// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515"/> (JWS).
Expand All @@ -124,14 +124,13 @@ public JsonWebToken(ReadOnlyMemory<char> encodedTokenMemory)
/// </para>
/// </remarks>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="header"/> is null or empty.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="payload"/> is null or empty.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="payload"/> is null.</exception>
public JsonWebToken(string header, string payload)
{
if (string.IsNullOrEmpty(header))
throw LogHelper.LogArgumentNullException(nameof(header));

if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));
_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));

var encodedHeader = Base64UrlEncoder.Encode(header);
var encodedPayload = Base64UrlEncoder.Encode(payload);
Expand Down
46 changes: 16 additions & 30 deletions src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.CreateToken.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
using Microsoft.IdentityModel.Abstractions;
using Microsoft.IdentityModel.Logging;
using Microsoft.IdentityModel.Tokens;
using Microsoft.IdentityModel.Tokens.Json;
using JsonPrimitives = Microsoft.IdentityModel.Tokens.Json.JsonSerializerPrimitives;
using TokenLogMessages = Microsoft.IdentityModel.Tokens.LogMessages;

Expand All @@ -34,10 +33,9 @@ public partial class JsonWebTokenHandler : TokenHandler
/// <returns>A JWS in Compact Serialization format.</returns>
public virtual string CreateToken(string payload)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));
_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));

return CreateToken(
return CreateToken(
payload,
null,
null,
Expand All @@ -59,9 +57,7 @@ public virtual string CreateToken(
string payload,
IDictionary<string, object> additionalHeaderClaims)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));

_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));
_ = additionalHeaderClaims ?? throw LogHelper.LogArgumentNullException(nameof(additionalHeaderClaims));

return CreateToken(payload,
Expand All @@ -85,9 +81,7 @@ public virtual string CreateToken(
string payload,
SigningCredentials signingCredentials)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));

_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));
_ = signingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(signingCredentials));

return CreateToken(
Expand Down Expand Up @@ -118,9 +112,7 @@ public virtual string CreateToken(
SigningCredentials signingCredentials,
IDictionary<string, object> additionalHeaderClaims)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));

_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));
_ = signingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(signingCredentials));
_ = additionalHeaderClaims ?? throw LogHelper.LogArgumentNullException(nameof(additionalHeaderClaims));

Expand Down Expand Up @@ -296,9 +288,7 @@ public virtual string CreateToken(
string payload,
EncryptingCredentials encryptingCredentials)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));

_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));
_ = encryptingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(encryptingCredentials));

return CreateToken(
Expand Down Expand Up @@ -329,9 +319,7 @@ public virtual string CreateToken(
EncryptingCredentials encryptingCredentials,
IDictionary<string, object> additionalHeaderClaims)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));

_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));
_ = encryptingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(encryptingCredentials));
_ = additionalHeaderClaims ?? throw LogHelper.LogArgumentNullException(nameof(additionalHeaderClaims));

Expand Down Expand Up @@ -360,9 +348,7 @@ public virtual string CreateToken(
SigningCredentials signingCredentials,
EncryptingCredentials encryptingCredentials)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));

_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));
_ = signingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(signingCredentials));
_ = encryptingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(encryptingCredentials));

Expand Down Expand Up @@ -397,9 +383,7 @@ public virtual string CreateToken(
EncryptingCredentials encryptingCredentials,
IDictionary<string, object> additionalHeaderClaims)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));

_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));
_ = signingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(signingCredentials));
_ = encryptingCredentials ?? throw LogHelper.LogArgumentNullException(nameof(encryptingCredentials));
_ = additionalHeaderClaims ?? throw LogHelper.LogArgumentNullException(nameof(additionalHeaderClaims));
Expand All @@ -420,14 +404,16 @@ public virtual string CreateToken(
/// <param name="payload">A string containing JSON which represents the JWT token payload.</param>
/// <param name="encryptingCredentials">The security key and algorithm that will be used to encrypt the JWT.</param>
/// <param name="compressionAlgorithm">The compression algorithm that will be used to compress the JWT token payload.</param>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="payload"/> is null.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="encryptingCredentials"/> is null.</exception>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="compressionAlgorithm"/> is null or empty.</exception>
/// <returns>A JWE in Compact Serialization format.</returns>
public virtual string CreateToken(
string payload,
EncryptingCredentials encryptingCredentials,
string compressionAlgorithm)
{
if (string.IsNullOrEmpty(payload))
throw LogHelper.LogArgumentNullException(nameof(payload));
_ = payload ?? throw LogHelper.LogArgumentNullException(nameof(payload));

if (string.IsNullOrEmpty(compressionAlgorithm))
throw LogHelper.LogArgumentNullException(nameof(compressionAlgorithm));
Expand Down Expand Up @@ -462,7 +448,7 @@ public virtual string CreateToken(
EncryptingCredentials encryptingCredentials,
string compressionAlgorithm)
{
if (string.IsNullOrEmpty(payload))
if (payload == null)
throw LogHelper.LogArgumentNullException(nameof(payload));

if (string.IsNullOrEmpty(compressionAlgorithm))
Expand Down Expand Up @@ -507,7 +493,7 @@ public virtual string CreateToken(
IDictionary<string, object> additionalHeaderClaims,
IDictionary<string, object> additionalInnerHeaderClaims)
{
if (string.IsNullOrEmpty(payload))
if (payload == null)
throw LogHelper.LogArgumentNullException(nameof(payload));

if (string.IsNullOrEmpty(compressionAlgorithm))
Expand Down Expand Up @@ -552,7 +538,7 @@ public virtual string CreateToken(
string compressionAlgorithm,
IDictionary<string, object> additionalHeaderClaims)
{
if (string.IsNullOrEmpty(payload))
if (payload == null)
throw LogHelper.LogArgumentNullException(nameof(payload));

if (string.IsNullOrEmpty(compressionAlgorithm))
Expand Down
Loading