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.

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

Move CNF from SHR to M.IM.Tokens #3168

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
79 changes: 5 additions & 74 deletions src/Microsoft.IdentityModel.Protocols.SignedHttpRequest/Cnf.cs
Original file line number Diff line number Diff line change
@@ -1,88 +1,19 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.IdentityModel.Logging;
using Microsoft.IdentityModel.Tokens;
using Microsoft.IdentityModel.Tokens.Json;

namespace Microsoft.IdentityModel.Protocols.SignedHttpRequest
{
/// <summary>
/// Represents the Cnf Claim
/// </summary>
internal class Cnf
internal class Cnf : Tokens.Cnf
{
internal const string ClassName = "Microsoft.IdentityModel.Protocols.SignedHttpRequest.Cnf";

public Cnf() { }

public Cnf(string json)
public Cnf() : base()
{
if (string.IsNullOrEmpty(json))
throw LogHelper.LogArgumentNullException(nameof(json));

Utf8JsonReader reader = new(Encoding.UTF8.GetBytes(json).AsSpan());
if (!JsonSerializerPrimitives.IsReaderAtTokenType(ref reader, JsonTokenType.StartObject, true))
throw LogHelper.LogExceptionMessage(
new JsonException(
LogHelper.FormatInvariant(
Tokens.LogMessages.IDX11023,
LogHelper.MarkAsNonPII("JsonTokenType.StartObject"),
LogHelper.MarkAsNonPII(reader.TokenType),
LogHelper.MarkAsNonPII(ClassName),
LogHelper.MarkAsNonPII(reader.TokenStartIndex),
LogHelper.MarkAsNonPII(reader.CurrentDepth),
LogHelper.MarkAsNonPII(reader.BytesConsumed))));

while (true)
{
if (reader.TokenType == JsonTokenType.PropertyName)
{
if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Jwk))
{
reader.Read();
JsonWebKey = JsonWebKeySerializer.Read(ref reader, new JsonWebKey());
}
else if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Kid))
{
Kid = JsonSerializerPrimitives.ReadString(ref reader, ConfirmationClaimTypes.Kid, ClassName, true);
}
else if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Jku))
{
Jku = JsonSerializerPrimitives.ReadString(ref reader, ConfirmationClaimTypes.Kid, ClassName, true);
}
else if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Jwe))
{
Jwe = JsonSerializerPrimitives.ReadString(ref reader, ConfirmationClaimTypes.Jwe, ClassName, true);
}
else
{
// this is not a property we recognize, skip it.
reader.Skip();
}
}
// We read a JsonTokenType.StartObject above, exiting and positioning reader at next token.
else if (JsonSerializerPrimitives.IsReaderAtTokenType(ref reader, JsonTokenType.EndObject, true))
break;
else if (!reader.Read())
break;
}
}

[JsonPropertyName("kid")]
public string Kid { get; set; }

[JsonPropertyName("jwe")]
public string Jwe { get; set; }

[JsonPropertyName("jku")]
public string Jku { get; set; }

[JsonPropertyName("jwk")]
public JsonWebKey JsonWebKey { get; set; }
public Cnf(string json) : base(json)
{
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,27 @@ public static class ConfirmationClaimTypes
/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.1.1
/// </summary>
public const string Cnf = "cnf";
public const string Cnf = Tokens.ConfirmationClaimTypes.Cnf;

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Jwk = "jwk";
public const string Jwk = Tokens.ConfirmationClaimTypes.Jwk;

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Jwe = "jwe";
public const string Jwe = Tokens.ConfirmationClaimTypes.Jwe;

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Jku = "jku";
public const string Jku = Tokens.ConfirmationClaimTypes.Jku;

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Kid = "kid";
public const string Kid = Tokens.ConfirmationClaimTypes.Kid;
}

internal static class ConfirmationClaimTypesUtf8Bytes
Expand Down
108 changes: 108 additions & 0 deletions src/Microsoft.IdentityModel.Tokens/Cnf.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Text;
using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.IdentityModel.Logging;
using Microsoft.IdentityModel.Tokens.Json;

namespace Microsoft.IdentityModel.Tokens
{
/// <summary>
/// Represents the Cnf Claim
/// </summary>
public class Cnf
{
private const string ClassName = "Microsoft.IdentityModel.Protocols.SignedHttpRequest.Cnf";

/// <summary>
/// Initializes a new instance of the <see cref="Cnf"/> class.
/// </summary>
public Cnf() { }

/// <summary>
/// Initializes a new instance of the <see cref="Cnf"/> class.
/// </summary>
/// <param name="json">
/// JSON representation of the Cnf Claim.
/// </param>
public Cnf(string json)
{
if (string.IsNullOrEmpty(json))
throw LogHelper.LogArgumentNullException(nameof(json));

Utf8JsonReader reader = new(Encoding.UTF8.GetBytes(json).AsSpan());
if (!JsonSerializerPrimitives.IsReaderAtTokenType(ref reader, JsonTokenType.StartObject, true))
throw LogHelper.LogExceptionMessage(
new JsonException(
LogHelper.FormatInvariant(
LogMessages.IDX11023,
LogHelper.MarkAsNonPII("JsonTokenType.StartObject"),
LogHelper.MarkAsNonPII(reader.TokenType),
LogHelper.MarkAsNonPII(ClassName),
LogHelper.MarkAsNonPII(reader.TokenStartIndex),
LogHelper.MarkAsNonPII(reader.CurrentDepth),
LogHelper.MarkAsNonPII(reader.BytesConsumed))));

while (true)
{
if (reader.TokenType == JsonTokenType.PropertyName)
{
if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Jwk))
{
reader.Read();
JsonWebKey = JsonWebKeySerializer.Read(ref reader, new JsonWebKey());
}
else if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Kid))
{
Kid = JsonSerializerPrimitives.ReadString(ref reader, ConfirmationClaimTypes.Kid, ClassName, true);
}
else if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Jku))
{
Jku = JsonSerializerPrimitives.ReadString(ref reader, ConfirmationClaimTypes.Kid, ClassName, true);
}
else if (reader.ValueTextEquals(ConfirmationClaimTypesUtf8Bytes.Jwe))
{
Jwe = JsonSerializerPrimitives.ReadString(ref reader, ConfirmationClaimTypes.Jwe, ClassName, true);
}
else
{
// this is not a property we recognize, skip it.
reader.Skip();
}
}
// We read a JsonTokenType.StartObject above, exiting and positioning reader at next token.
else if (JsonSerializerPrimitives.IsReaderAtTokenType(ref reader, JsonTokenType.EndObject, true))
break;
else if (!reader.Read())
break;
}
}

/// <summary>
/// The Kid property is used to specify the key ID of the public key used to verify the signature of the JWT.
/// </summary>
[JsonPropertyName("kid")]
public string Kid { get; internal set; }

/// <summary>
/// The Jwe property is used to specify an encrypted JSON web key.
/// </summary>
[JsonPropertyName("jwe")]
public string Jwe { get; internal set; }

/// <summary>
/// The Jku property is used to specify the location of the public key used to verify the signature of the JWT.
/// </summary>
[JsonPropertyName("jku")]
public string Jku { get; internal set; }

/// <summary>
/// The Jwk property is used to specify the public key used to verify the signature of the JWT.
/// </summary>
[JsonPropertyName("jwk")]
public JsonWebKey JsonWebKey { get; internal set; }
}
}
48 changes: 48 additions & 0 deletions src/Microsoft.IdentityModel.Tokens/ConfirmationClaimTypes.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;

namespace Microsoft.IdentityModel.Tokens
{
/// <summary>
/// Confirmation Claim ("cnf") related constants
/// https://datatracker.ietf.org/doc/html/rfc7800
/// </summary>
public static class ConfirmationClaimTypes
{
/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.1.1
/// </summary>
public const string Cnf = "cnf";

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Jwk = "jwk";

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Jwe = "jwe";

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Jku = "jku";

/// <summary>
/// https://datatracker.ietf.org/doc/html/rfc7800#section-6.2.2
/// </summary>
public const string Kid = "kid";
}

internal static class ConfirmationClaimTypesUtf8Bytes
{
public static ReadOnlySpan<byte> Cnf => "cnf"u8;
public static ReadOnlySpan<byte> Jwk => "jwk"u8;
public static ReadOnlySpan<byte> Jwe => "jwe"u8;
public static ReadOnlySpan<byte> Jku => "jku"u8;
public static ReadOnlySpan<byte> Kid => "kid"u8;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Microsoft.IdentityModel.Tokens.Cnf.Jku.set -> void
Microsoft.IdentityModel.Tokens.Cnf.JsonWebKey.set -> void
Microsoft.IdentityModel.Tokens.Cnf.Jwe.set -> void
Microsoft.IdentityModel.Tokens.Cnf.Kid.set -> void
Microsoft.IdentityModel.Protocols.SignedHttpRequest.ConfirmationClaimTypesUtf8Bytes
Microsoft.IdentityModel.Tokens.Cnf.Jku.set -> void
Microsoft.IdentityModel.Tokens.Cnf.JsonWebKey.set -> void
Microsoft.IdentityModel.Tokens.Cnf.Jwe.set -> void
Microsoft.IdentityModel.Tokens.Cnf.Kid.set -> void
13 changes: 13 additions & 0 deletions src/Microsoft.IdentityModel.Tokens/PublicAPI.Unshipped.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Microsoft.IdentityModel.Tokens.Cnf
Microsoft.IdentityModel.Tokens.Cnf.Cnf() -> void
Microsoft.IdentityModel.Tokens.Cnf.Cnf(string json) -> void
Microsoft.IdentityModel.Tokens.Cnf.Jku.get -> string
Microsoft.IdentityModel.Tokens.Cnf.JsonWebKey.get -> Microsoft.IdentityModel.Tokens.JsonWebKey
Microsoft.IdentityModel.Tokens.Cnf.Jwe.get -> string
Microsoft.IdentityModel.Tokens.Cnf.Kid.get -> string
const Microsoft.IdentityModel.Tokens.ConfirmationClaimTypes.Cnf = "cnf" -> string
const Microsoft.IdentityModel.Tokens.ConfirmationClaimTypes.Jku = "jku" -> string
const Microsoft.IdentityModel.Tokens.ConfirmationClaimTypes.Jwe = "jwe" -> string
const Microsoft.IdentityModel.Tokens.ConfirmationClaimTypes.Jwk = "jwk" -> string
const Microsoft.IdentityModel.Tokens.ConfirmationClaimTypes.Kid = "kid" -> string
Microsoft.IdentityModel.Tokens.ConfirmationClaimTypes
Loading