Class SteamPartnerCookies

The two cookies the partner site's achievement editor authenticates a request with.

Inheritance
object
SteamPartnerCookies
Inherited Members
Namespace: Serenity.Steam.Application
Assembly: Serenity.Steam.Application.dll
Syntax
public sealed class SteamPartnerCookies
Remarks

ToString() is deliberately redacted: this value is built from text an author pastes from their own browser session and may end up in a log line or an exception message a long way from where it was created. Printing SteamLoginSecure itself would turn a debugging aid into a credential leak.

A value that holds a control character (a line break above all) is refused: the values are sent in a Cookie request header added without validation, so a pasted value carrying a line break would inject a header of its own.

Constructors

SteamPartnerCookies(string, string)

Creates a cookie pair.

Declaration
public SteamPartnerCookies(string sessionId, string steamLoginSecure)
Parameters
Type Name Description
string sessionId

The sessionid cookie value, or empty when not found.
string steamLoginSecure

The steamLoginSecure cookie value, or empty when not found.
Exceptions
Type Condition
ArgumentException

When a value holds a control character; see ControlCharacterRejection.

Fields

ControlCharacterRejection

What an author is told when a pasted cookie value holds a line break or another control character.

Declaration
public const string ControlCharacterRejection = "A cookie value contains a line break or another control character, which a request header cannot carry. Copy only the cookie's value, on a single line."
Field Value
Type Description
string

Properties

IsComplete

Declaration
public bool IsComplete { get; }
Property Value
Type Description
bool

Whether both cookies were found.

SessionId

Declaration
public string SessionId { get; }
Property Value
Type Description
string

The sessionid cookie value, or empty when not found.

SteamLoginSecure

Declaration
public string SteamLoginSecure { get; }
Property Value
Type Description
string

The steamLoginSecure cookie value, or empty when not found.

Methods

ContainsControlCharacter(string)

Whether value, once trimmed, holds a line break or another control character.

Declaration
public static bool ContainsControlCharacter(string value)
Parameters
Type Name Description
string value
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides