1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Essentials.Accounts
* File: AccountSecConfig.cs
*
* AccountSecConfig.cs is part of VNLib.Plugins.Essentials.Accounts which is part
* of the larger VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials.Accounts is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Essentials.Accounts is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System;
using System.Text.Json.Serialization;
using FluentValidation;
using VNLib.Plugins.Extensions.Loading;
using VNLib.Plugins.Extensions.Validation;
namespace VNLib.Plugins.Essentials.Accounts.SecurityProvider
{
internal sealed class AccountSecConfig : IOnConfigValidation
{
private static IValidator<AccountSecConfig> _validator { get; } = GetValidator();
private static IValidator<AccountSecConfig> GetValidator()
{
InlineValidator<AccountSecConfig> val = new();
//Cookie domain may be null/emmpty
val.RuleFor(c => c.CookieDomain);
//Cookie path may be empty or null
val.RuleFor(c => c.CookiePath);
val.RuleFor(c => c.AuthorizationValidFor)
.GreaterThan(TimeSpan.FromMinutes(1))
.WithMessage("The authorization should be valid for at-least 1 minute");
val.RuleFor(C => C.ClientStatusCookieName)
.Length(1, 50)
.AlphaNumericOnly();
//header name is required, but not allowed to contain "illegal" chars
val.RuleFor(c => c.TokenHeaderName)
.NotEmpty()
.IllegalCharacters();
val.RuleFor(c => c.PubKeyCookieName)
.Length(1, 50)
.IllegalCharacters();
//Signing keys are base32 encoded and stored in the session, we dont want to take up too much space
val.RuleFor(c => c.PubKeySigningKeySize)
.InclusiveBetween(8, 512)
.WithMessage("Your public key signing key should be between 8 and 512 bytes");
//Time difference doesnt need to be validated, it may be 0 to effectively disable it
val.RuleFor(c => c.SignedTokenTimeDiff);
val.RuleFor(c => c.TokenKeySize)
.InclusiveBetween(8, 512)
.WithMessage("You should choose an OTP symmetric key size between 8 and 512 bytes");
val.RuleFor(c => c.WebSessionValidForSeconds)
.InclusiveBetween((uint)1, uint.MaxValue)
.WithMessage("You must specify a valid value for a web session timeout in seconds");
val.RuleForEach(c => c.AllowedOrigins)
.Matches(@"^https?://[a-z0-9\-\.]+$")
.WithMessage("The allowed origins must be valid http(s) urls");
return val;
}
/// <summary>
/// The domain all authoization cookies will be set for
/// </summary>
[JsonPropertyName("cookie_domain")]
public string CookieDomain { get; set; } = "";
/// <summary>
/// The path all authorization cookies will be set for
/// </summary>
[JsonPropertyName("cookie_path")]
public string? CookiePath { get; set; } = "/";
/// <summary>
/// The amount if time new authorizations are valid for. This also
/// sets the duration of client cookies.
/// </summary>
[JsonIgnore]
internal TimeSpan AuthorizationValidFor { get; set; } = TimeSpan.FromMinutes(60);
/// <summary>
/// The name of the cookie used to set the client's login status message
/// </summary>
[JsonPropertyName("status_cookie_name")]
public string ClientStatusCookieName { get; set; } = "li";
/// <summary>
/// The name of the header used by the client to send the one-time use
/// authorization token
/// </summary>
[JsonPropertyName("otp_header_name")]
public string TokenHeaderName { get; set; } = "X-Web-Token";
/// <summary>
/// The size (in bytes) of the symmetric key used
/// by the client to sign token messages
/// </summary>
[JsonPropertyName("otp_key_size")]
public int TokenKeySize { get; set; } = 64;
/// <summary>
/// The name of the cookie that stores the user's signed public encryption key
/// </summary>
[JsonPropertyName("pubkey_cookie_name")]
public string PubKeyCookieName { get; set; } = "client_id";
/// <summary>
/// The size (in bytes) of the randomly generated key
/// used to sign the user's public key
/// </summary>
[JsonPropertyName("pubkey_signing_key_size")]
public int PubKeySigningKeySize { get; set; } = 32;
/// <summary>
/// The allowed time difference in the issuance time of the client's signed
/// one time use tokens
/// </summary>
[JsonIgnore]
internal TimeSpan SignedTokenTimeDiff { get; set; } = TimeSpan.FromSeconds(30);
/// <summary>
/// The amount of time a web session is valid for
/// </summary>
[JsonPropertyName("session_valid_for_sec")]
public uint WebSessionValidForSeconds { get; set; } = 3600;
[JsonPropertyName("otp_time_diff_sec")]
public uint SigTokenTimeDifSeconds
{
get => (uint)SignedTokenTimeDiff.TotalSeconds;
set => SignedTokenTimeDiff = TimeSpan.FromSeconds(value);
}
/// <summary>
/// Enforce that the client's token is only valid for the origin
/// it was read from. Will break sites hosted from multiple origins
/// </summary>
[JsonPropertyName("strict_origin")]
public bool EnforceSameOriginToken { get; set; } = true;
/// <summary>
/// Enable/disable origin verification for the client's token
/// </summary>
[JsonIgnore]
public bool VerifyOrigin => AllowedOrigins != null && AllowedOrigins.Length > 0;
/// <summary>
/// The list of origins that are allowed to send requests to the server
/// </summary>
[JsonPropertyName("allowed_origins")]
public string[]? AllowedOrigins { get; set; }
/// <summary>
/// Enforce strict path checking for the client's token
/// </summary>
[JsonPropertyName("strict_path")]
public bool VerifyPath { get; set; } = true;
/// <summary>
/// Enforce strict user-agent strings for authorized users
/// </summary>
[JsonPropertyName("strict_user_agent")]
public bool StrictUserAgent { get; set; } = true;
void IOnConfigValidation.Validate()
{
//Validate the current instance
_validator.ValidateAndThrow(this);
}
}
}
|
