Secret Class

Definition

Namespace

Codebelt.SharedKernel.Security

Assemblies

Codebelt.SharedKernel.dll

Source

src/Codebelt.SharedKernel/Security/Secret.cs

Represents a Secret object that can be used for storing sensitive data.

public record Secret : Token, IEquatable<ValueObject>, IEquatable<SingleValueObject<string>>, IEquatable<Token>, IEquatable<Secret>

Inheritance

object

ValueObject

SingleValueObject<string>

Token

Secret

Implements

IEquatable<ValueObject>

IEquatable<SingleValueObject<string>>

IEquatable<Token>

IEquatable<Secret>

Inherited Members

SingleValueObject<string>.GetEqualityComponents()

SingleValueObject<string>.PrintMembers(StringBuilder)

SingleValueObject<string>.GetHashCode()

SingleValueObject<string>.Equals(object)

SingleValueObject<string>.Equals(ValueObject)

SingleValueObject<string>.Equals(SingleValueObject<string>)

SingleValueObject<string>.<Clone>$()

SingleValueObject<string>.EqualityContract

SingleValueObject<string>.Value

Examples

The following example constructs a Secret from a 32-character hex string and converts it to its UTF-8 byte representation so it can be fed to a downstream cryptographic operation. Use the implicit Guid conversion when an upstream system hands you a request id, or the implicit string conversion when the secret arrives as a header value.

using System;
using System.Security.Cryptography;
using Codebelt.SharedKernel.Security;

namespace CryptographySample;

public static class KeyDerivation
{
    public static byte[] DeriveHmacKey(string hexSecret)
    {
        var secret = new Secret(hexSecret);
        var keyMaterial = secret.ToByteArray();

        // The byte array is suitable as input for HMAC-SHA256 key derivation.
        return SHA256.HashData(keyMaterial);
    }
}

Remarks

https://martinfowler.com/eaaCatalog/valueObject.html

Constructors

Name	Description
Secret(Guid)	Initializes a new instance of the Secret class.
Secret(string)	Initializes a new instance of the Secret class.

Methods

Name	Description
ToByteArray(Action<EncodingOptions>)	Converts this instance to its equivalent byte[] representation.
ToString()	Returns a string> that represents this instance.

Operators

Name	Description
implicit operator Secret(Guid)	Performs an implicit conversion from Guid to Secret.
implicit operator Secret(string)	Performs an implicit conversion from string to Secret.

See Also

Token