-
Notifications
You must be signed in to change notification settings - Fork 5
Restrict supported Web eID token formats #77
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
src/WebEid.Security.Tests/Validator/VersionValidators/AuthTokenVersionTest.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright © 2025-2025 Estonian Information System Authority | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
| namespace WebEid.Security.Tests.Validator.VersionValidators | ||
| { | ||
| using NUnit.Framework; | ||
| using WebEid.Security.Validator.VersionValidators; | ||
|
|
||
| public class AuthTokenVersionTest | ||
| { | ||
| [TestCase("web-eid:1", 1, 0, true)] | ||
| [TestCase("web-eid:1.0", 1, 0, true)] | ||
| [TestCase("web-eid:1.1", 1, 0, true)] | ||
| [TestCase("web-eid:1.1", 1, 1, true)] | ||
| [TestCase("web-eid:1.999", 1, 1, true)] | ||
| [TestCase("web-eid:2.0", 2, 0, true)] | ||
| [TestCase("web-eid:2.3", 2, 1, true)] | ||
| [TestCase("web-eid:1.0", 1, 1, false)] | ||
| [TestCase("web-eid:1", 1, 1, false)] | ||
| [TestCase("web-eid:2", 1, 0, false)] | ||
| [TestCase("web-eid:1.5", 2, 0, false)] | ||
| [TestCase("web-eid:1.00", 1, 0, false)] | ||
| [TestCase("web-eid:1.000", 1, 0, false)] | ||
| [TestCase("web-eid:01", 1, 0, false)] | ||
| [TestCase("web-eid:1.", 1, 0, false)] | ||
| [TestCase("web-eid:1.1.0", 1, 0, false)] | ||
| [TestCase("web-eid:0.9", 1, 0, false)] | ||
| [TestCase("webauthn:1", 1, 0, false)] | ||
| public void WhenFormatMatchesRequiredMajorAndAtLeastRequiredMinorThenSupportsReturnsExpected( | ||
| string format, int requiredMajorVersion, int requiredMinorVersion, bool expected) => | ||
| Assert.That( | ||
| AuthTokenVersion.Supports(format, requiredMajorVersion, requiredMinorVersion), | ||
| Is.EqualTo(expected)); | ||
|
|
||
| [Test] | ||
| public void WhenFormatIsNullThenSupportsReturnsFalse() => | ||
| Assert.That(AuthTokenVersion.Supports(null, 1, 0), Is.False); | ||
|
|
||
| [TestCase("web-eid:1", 1, 0, true)] | ||
| [TestCase("web-eid:1.0", 1, 0, true)] | ||
| [TestCase("web-eid:1.1", 1, 1, true)] | ||
| [TestCase("web-eid:2.0", 2, 0, true)] | ||
| [TestCase("web-eid:1.1", 1, 0, false)] | ||
| [TestCase("web-eid:1.2", 1, 1, false)] | ||
| [TestCase("web-eid:1.0", 1, 1, false)] | ||
| [TestCase("web-eid:1", 2, 0, false)] | ||
| [TestCase("web-eid:1.00", 1, 0, false)] | ||
| [TestCase("web-eid:01", 1, 0, false)] | ||
| [TestCase("webauthn:1", 1, 0, false)] | ||
| public void WhenFormatMatchesRequiredMajorAndExactMinorThenSupportsExactlyReturnsExpected( | ||
| string format, int requiredMajorVersion, int requiredMinorVersion, bool expected) => | ||
| Assert.That( | ||
| AuthTokenVersion.SupportsExactly(format, requiredMajorVersion, requiredMinorVersion), | ||
| Is.EqualTo(expected)); | ||
|
|
||
| [Test] | ||
| public void WhenFormatIsNullThenSupportsExactlyReturnsFalse() => | ||
| Assert.That(AuthTokenVersion.SupportsExactly(null, 1, 0), Is.False); | ||
| } | ||
| } |
87 changes: 87 additions & 0 deletions
87
src/WebEid.Security/Validator/VersionValidators/AuthTokenVersion.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * Copyright © 2025-2025 Estonian Information System Authority | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
| namespace WebEid.Security.Validator.VersionValidators | ||
| { | ||
| using System.Globalization; | ||
| using System.Text.RegularExpressions; | ||
|
|
||
| /// <summary> | ||
| /// Utility for matching Web eID authentication token format version strings of the form | ||
| /// <c>web-eid:<major>[.<minor>]</c>, e.g. <c>web-eid:1</c> or <c>web-eid:1.1</c>. | ||
| /// </summary> | ||
| internal static partial class AuthTokenVersion | ||
| { | ||
| // Matches 'web-eid:<major>' with an optional canonical '.<minor>', where both numbers have no leading | ||
| // zeros ('0' or '[1-9]\d*') and are at most 9 digits so that they always fit in an int. Non-canonical | ||
| // spellings such as 'web-eid:1.00' or 'web-eid:01' are rejected so that ambiguous version numbers cannot | ||
| // bypass the more specific validators. | ||
| [GeneratedRegex(@"^web-eid:(0|[1-9]\d{0,8})(?:\.(0|[1-9]\d{0,8}))?$")] | ||
| private static partial Regex TokenFormatRegex(); | ||
|
|
||
| /// <summary> | ||
| /// Returns whether the given token format has exactly the required major version and a minor version that | ||
| /// is greater than or equal to the required minor version. A missing minor version is treated as 0. | ||
| /// Backwards-compatible minor version changes are supported within the same major version, while an | ||
| /// incompatible major version change is not. | ||
| /// </summary> | ||
| internal static bool Supports(string format, int requiredExactMajorVersion, int requiredMinimalMinorVersion) | ||
| { | ||
| var version = Parse(format); | ||
| return version.HasValue && | ||
| version.Value.Major == requiredExactMajorVersion && | ||
| version.Value.Minor >= requiredMinimalMinorVersion; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns whether the given token format has exactly the required major version and exactly the required | ||
| /// minor version. A missing minor version is treated as 0. | ||
| /// </summary> | ||
| internal static bool SupportsExactly(string format, int requiredExactMajorVersion, int requiredExactMinorVersion) | ||
| { | ||
| var version = Parse(format); | ||
| return version.HasValue && | ||
| version.Value.Major == requiredExactMajorVersion && | ||
| version.Value.Minor == requiredExactMinorVersion; | ||
| } | ||
|
|
||
| private static (int Major, int Minor)? Parse(string format) | ||
| { | ||
| if (format == null) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| var match = TokenFormatRegex().Match(format); | ||
| if (!match.Success) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| var major = int.Parse(match.Groups[1].Value, CultureInfo.InvariantCulture); | ||
| var minor = match.Groups[2].Success | ||
| ? int.Parse(match.Groups[2].Value, CultureInfo.InvariantCulture) | ||
| : 0; | ||
|
|
||
| return (major, minor); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.