Skip to content
This repository was archived by the owner on Dec 13, 2018. It is now read-only.

Commit 0403f05

Browse files
author
Nate McMaster
committed
Rename CorrelationIdCookie to CorrelationCookie
1 parent 559ad22 commit 0403f05

File tree

4 files changed

+16
-14
lines changed

4 files changed

+16
-14
lines changed

src/Microsoft.AspNetCore.Authentication/Internal/RequestPathBaseCookieBuilder.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ public override CookieOptions Build(HttpContext context, DateTimeOffset expiresF
2828

2929
var options = base.Build(context, expiresFrom);
3030

31-
options.Path = path ?? "/";
31+
options.Path = !string.IsNullOrEmpty(path)
32+
? path
33+
: "/";
3234

3335
return options;
3436
}

src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationHandler.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,11 +185,11 @@ protected virtual void GenerateCorrelationId(AuthenticationProperties properties
185185
CryptoRandom.GetBytes(bytes);
186186
var correlationId = Base64UrlTextEncoder.Encode(bytes);
187187

188-
var cookieOptions = Options.CorrelationIdCookie.Build(Context, Clock.UtcNow);
188+
var cookieOptions = Options.CorrelationCookie.Build(Context, Clock.UtcNow);
189189

190190
properties.Items[CorrelationProperty] = correlationId;
191191

192-
var cookieName = Options.CorrelationIdCookie.Name + Scheme.Name + "." + correlationId;
192+
var cookieName = Options.CorrelationCookie.Name + Scheme.Name + "." + correlationId;
193193

194194
Response.Cookies.Append(cookieName, CorrelationMarker, cookieOptions);
195195
}
@@ -209,7 +209,7 @@ protected virtual bool ValidateCorrelationId(AuthenticationProperties properties
209209

210210
properties.Items.Remove(CorrelationProperty);
211211

212-
var cookieName = Options.CorrelationIdCookie.Name + Scheme.Name + "." + correlationId;
212+
var cookieName = Options.CorrelationCookie.Name + Scheme.Name + "." + correlationId;
213213

214214
var correlationCookie = Request.Cookies[cookieName];
215215
if (string.IsNullOrEmpty(correlationCookie))
@@ -218,7 +218,7 @@ protected virtual bool ValidateCorrelationId(AuthenticationProperties properties
218218
return false;
219219
}
220220

221-
var cookieOptions = Options.CorrelationIdCookie.Build(Context, Clock.UtcNow);
221+
var cookieOptions = Options.CorrelationCookie.Build(Context, Clock.UtcNow);
222222

223223
Response.Cookies.Delete(cookieName, cookieOptions);
224224

src/Microsoft.AspNetCore.Authentication/RemoteAuthenticationOptions.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ public class RemoteAuthenticationOptions : AuthenticationSchemeOptions
1616
{
1717
internal const string CorrelationPrefix = ".AspNetCore.Correlation.";
1818

19-
private CookieBuilder _correlationIdCookieBuilder;
19+
private CookieBuilder _correlationCookieBuilder;
2020

2121
/// <summary>
2222
/// Initializes a new <see cref="RemoteAuthenticationOptions"/>.
2323
/// </summary>
2424
public RemoteAuthenticationOptions()
2525
{
26-
_correlationIdCookieBuilder = new CorrelationIdCookieBuilder(this)
26+
_correlationCookieBuilder = new CorrelationCookieBuilder(this)
2727
{
2828
Name = CorrelationPrefix,
2929
HttpOnly = true,
@@ -103,20 +103,20 @@ public override void Validate()
103103
public bool SaveTokens { get; set; }
104104

105105
/// <summary>
106-
/// Determines the settings used to create the correlation id cookie before the
106+
/// Determines the settings used to create the correlation cookie before the
107107
/// cookie gets added to the response.
108108
/// </summary>
109-
public CookieBuilder CorrelationIdCookie
109+
public CookieBuilder CorrelationCookie
110110
{
111-
get => _correlationIdCookieBuilder;
112-
set => _correlationIdCookieBuilder = value ?? throw new ArgumentNullException(nameof(value));
111+
get => _correlationCookieBuilder;
112+
set => _correlationCookieBuilder = value ?? throw new ArgumentNullException(nameof(value));
113113
}
114114

115-
private class CorrelationIdCookieBuilder : RequestPathBaseCookieBuilder
115+
private class CorrelationCookieBuilder : RequestPathBaseCookieBuilder
116116
{
117117
private readonly RemoteAuthenticationOptions _options;
118118

119-
public CorrelationIdCookieBuilder(RemoteAuthenticationOptions remoteAuthenticationOptions)
119+
public CorrelationCookieBuilder(RemoteAuthenticationOptions remoteAuthenticationOptions)
120120
{
121121
_options = remoteAuthenticationOptions;
122122
}

test/Microsoft.AspNetCore.Authentication.Test/OpenIdConnect/OpenIdConnectTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ public async Task RedirectToIdentityProvider_CorrelationIdCookieOptions_CanBeOve
143143
{
144144
AuthorizationEndpoint = "https://example.com/provider/login"
145145
};
146-
opt.CorrelationIdCookie.Path = "/";
146+
opt.CorrelationCookie.Path = "/";
147147
});
148148

149149
var server = setting.CreateTestServer();

0 commit comments

Comments
 (0)