-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add codeql-analysis.yml action for CodeQL analysis * Added Sanitized type to prevent CVE-117 during logging * Add using of Sanitized type in the logging
- Loading branch information
1 parent
b48c73f
commit 208e667
Showing
9 changed files
with
382 additions
and
8 deletions.
There are no files selected for viewing
This file contains 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,93 @@ | ||
# For most projects, this workflow file will not need changing; you simply need | ||
# to commit it to your repository. | ||
# | ||
# You may wish to alter this file to override the set of languages analyzed, | ||
# or to provide custom queries or build logic. | ||
# | ||
# ******** NOTE ******** | ||
# We have attempted to detect the languages in your repository. Please check | ||
# the `language` matrix defined below to confirm you have the correct set of | ||
# supported CodeQL languages. | ||
# | ||
name: "CodeQL" | ||
|
||
on: | ||
push: | ||
branches: [ "master", "develop" ] | ||
pull_request: | ||
branches: [ "master", "develop" ] | ||
schedule: | ||
- cron: '0 0 * * 1' # Weekly schedule at midnight UTC on Mondays | ||
|
||
jobs: | ||
analyze: | ||
name: Analyze (${{ matrix.language }}) | ||
# Runner size impacts CodeQL analysis time. To learn more, please see: | ||
# - https://gh.io/recommended-hardware-resources-for-running-codeql | ||
# - https://gh.io/supported-runners-and-hardware-resources | ||
# - https://gh.io/using-larger-runners (github.com only) | ||
# Consider using larger runners or machines with greater resources for possible analysis time improvements. | ||
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} | ||
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }} | ||
permissions: | ||
# required for all workflows | ||
security-events: write | ||
|
||
# required to fetch internal or private CodeQL packs | ||
packages: read | ||
|
||
# only required for workflows in private repositories | ||
actions: read | ||
contents: read | ||
|
||
strategy: | ||
fail-fast: false | ||
matrix: | ||
include: | ||
- language: csharp | ||
build-mode: autobuild | ||
# CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' | ||
# Use `c-cpp` to analyze code written in C, C++ or both | ||
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both | ||
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both | ||
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis, | ||
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning. | ||
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how | ||
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
|
||
# Initializes the CodeQL tools for scanning. | ||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v3 | ||
with: | ||
languages: ${{ matrix.language }} | ||
build-mode: ${{ matrix.build-mode }} | ||
# If you wish to specify custom queries, you can do so here or in a config file. | ||
# By default, queries listed here will override any specified in a config file. | ||
# Prefix the list here with "+" to use these queries and those in the config file. | ||
|
||
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs | ||
# queries: security-extended,security-and-quality | ||
|
||
# If the analyze step fails for one of the languages you are analyzing with | ||
# "We were unable to automatically build your code", modify the matrix above | ||
# to set the build mode to "manual" for that language. Then modify this step | ||
# to build your code. | ||
# ℹ️ Command-line programs to run using the OS shell. | ||
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | ||
- if: matrix.build-mode == 'manual' | ||
shell: bash | ||
run: | | ||
echo 'If you are using a "manual" build mode for one or more of the' \ | ||
'languages you are analyzing, replace this with the commands to build' \ | ||
'your code, for example:' | ||
echo ' make bootstrap' | ||
echo ' make release' | ||
exit 1 | ||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v3 | ||
with: | ||
category: "/language:${{matrix.language}}" |
This file contains 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 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 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 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 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 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,184 @@ | ||
// Abblix OIDC Server Library | ||
// Copyright (c) Abblix LLP. All rights reserved. | ||
// | ||
// DISCLAIMER: This software is provided 'as-is', without any express or implied | ||
// warranty. Use at your own risk. Abblix LLP is not liable for any damages | ||
// arising from the use of this software. | ||
// | ||
// LICENSE RESTRICTIONS: This code may not be modified, copied, or redistributed | ||
// in any form outside of the official GitHub repository at: | ||
// https://github.com/Abblix/OIDC.Server. All development and modifications | ||
// must occur within the official repository and are managed solely by Abblix LLP. | ||
// | ||
// Unauthorized use, modification, or distribution of this software is strictly | ||
// prohibited and may be subject to legal action. | ||
// | ||
// For full licensing terms, please visit: | ||
// | ||
// https://oidc.abblix.com/license | ||
// | ||
// CONTACT: For license inquiries or permissions, contact Abblix LLP at | ||
// [email protected] | ||
|
||
namespace Abblix.Utils.UnitTests; | ||
|
||
using Xunit; | ||
|
||
/// <summary> | ||
/// Contains unit tests for the <see cref="Sanitized"/> struct to ensure it correctly sanitizes input strings. | ||
/// </summary> | ||
public class SanitizedTests | ||
{ | ||
/// <summary> | ||
/// Tests that the original string is returned when no special characters are present. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReturnOriginalString_WhenNoSpecialCharacters() | ||
{ | ||
const string input = "HelloWorld"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(input, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that control characters are removed from the string. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldRemoveControlCharacters() | ||
{ | ||
const string input = "Hello\x01\x02\x03World"; | ||
const string expected = "HelloWorld"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that newline characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceNewline() | ||
{ | ||
const string input = "Hello\nWorld"; | ||
const string expected = "Hello\\nWorld"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that carriage return characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceCarriageReturn() | ||
{ | ||
const string input = "Hello\rWorld"; | ||
const string expected = "Hello\\rWorld"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that tab characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceTab() | ||
{ | ||
const string input = "Hello\tWorld"; | ||
const string expected = "Hello\\tWorld"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that double quote characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceDoubleQuote() | ||
{ | ||
const string input = "Hello\"World"; | ||
const string expected = "Hello\\\"World"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that single quote characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceSingleQuote() | ||
{ | ||
const string input = "Hello'World"; | ||
const string expected = "Hello\\'World"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that backslash characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceBackslash() | ||
{ | ||
const string input = "Hello\\World"; | ||
const string expected = "Hello\\\\World"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that comma characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceComma() | ||
{ | ||
const string input = "Hello,World"; | ||
const string expected = "Hello\\,World"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that semicolon characters are replaced with their escaped representation. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldReplaceSemicolon() | ||
{ | ||
const string input = "Hello;World"; | ||
const string expected = "Hello\\;World"; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that a null input returns null. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldHandleNullInput() | ||
{ | ||
const string? input = null; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Null(sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that an empty string remains unchanged. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldHandleEmptyString() | ||
{ | ||
const string input = ""; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(input, sanitizedValue.ToString()); | ||
} | ||
|
||
/// <summary> | ||
/// Tests that a string with only control characters is sanitized to an empty string. | ||
/// </summary> | ||
[Fact] | ||
public void ToString_ShouldHandleStringWithOnlyControlCharacters() | ||
{ | ||
const string input = "\x01\x02\x03"; | ||
const string expected = ""; | ||
var sanitizedValue = new Sanitized(input); | ||
Assert.Equal(expected, sanitizedValue.ToString()); | ||
} | ||
} |
Oops, something went wrong.