CA3003: Przegląd kodu pod kątem podatności na wstrzykiwanie ścieżek plików

Przyczyna

Potencjalnie niezaufane dane wejściowe żądania HTTP docierają do ścieżki operacji pliku.

Domyślnie ta reguła analizuje całą bazę kodu, ale można to skonfigurować.

Opis reguły

Podczas pracy z niezaufanymi danymi wejściowymi z żądań internetowych należy pamiętać o używaniu danych wejściowych kontrolowanych przez użytkownika podczas określania ścieżek do plików. Osoba atakująca może odczytać niezamierzony plik, co spowoduje ujawnienie informacji poufnych danych. Lub osoba atakująca może mieć możliwość zapisu w niezamierzonym pliku, co powoduje nieautoryzowaną modyfikację poufnych danych lub naruszenie bezpieczeństwa serwera. Typową techniką atakującą jest przechodzenie ścieżki w celu uzyskania dostępu do plików spoza zamierzonego katalogu.

Ta reguła próbuje znaleźć dane wejściowe z żądań HTTP docierających do ścieżki w operacji pliku.

Jak naprawić naruszenia

• Jeśli to możliwe, ogranicz ścieżki plików na podstawie danych wejściowych użytkownika do jawnie znanej listy bezpiecznych. Jeśli na przykład aplikacja musi uzyskiwać dostęp tylko do "red.txt", "green.txt" lub "blue.txt", zezwalaj tylko na te wartości.
• Sprawdź niezaufane nazwy plików i sprawdź, czy nazwa jest poprawnie sformułowana.
• Podczas określania ścieżek użyj pełnych nazw ścieżek.
• Unikaj potencjalnie niebezpiecznych konstrukcji, takich jak zmienne środowiskowe ścieżki.
• Zaakceptuj tylko długie nazwy plików i zweryfikuj długą nazwę, jeśli użytkownik przesyła krótkie nazwy.
• Ogranicz wprowadzanie danych wejściowych przez użytkownika końcowego do prawidłowych znaków.
• Odrzuć nazwy, w których przekroczono długość MAX_PATH.
• Obsługuj nazwy plików dosłownie, bez żadnej interpretacji.
• Określ, czy nazwa pliku reprezentuje plik lub urządzenie.

Kiedy pomijać ostrzeżenia

Jeśli sprawdzono dane wejściowe zgodnie z opisem w poprzedniej sekcji, możesz pominąć to ostrzeżenie.

Konfigurowanie kodu do analizowania

Użyj poniższych opcji, aby skonfigurować, na które części bazy kodu ma być stosowana ta reguła.

• Wykluczanie określonych symboli
• Wykluczanie określonych typów i ich typów pochodnych

Możesz skonfigurować te opcje tylko dla tej reguły, dla wszystkich reguł, do których mają zastosowanie, lub dla wszystkich reguł w tej kategorii (Security), do których mają zastosowanie. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Wyklucz określone symbole

Z analizy można wykluczyć określone symbole, takie jak typy i metody, ustawiając opcję excluded_symbol_names. Aby na przykład określić, że reguła nie powinna być uruchamiana w żadnym kodzie w typach o nazwie MyType, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Dozwolone formaty nazw symboli w wartości opcji (oddzielone przez |):

• Tylko nazwa symbolu (zawiera wszystkie symbole o nazwie, niezależnie od typu zawierającego lub przestrzeni nazw).
• W pełni kwalifikowane nazwy w formacie identyfikatora dokumentacji symbolu. Każda nazwa symbolu wymaga prefiksu określającego rodzaj symbolu, takiego jak M: dla metody, T: dla typów i N: dla przestrzeni nazw.
• .ctor dla konstruktorów i .cctor dla konstruktorów statycznych.

Przykłady:

Wyklucz określone typy i ich pochodne typy

Określone typy i ich typy pochodne można wykluczyć z analizy, ustawiając opcję excluded_type_names_with_derived_types. Aby na przykład określić, że reguła nie powinna być uruchamiana na żadnych metodach w typach nazwanych MyType i ich typach pochodnych, dodaj następującą parę klucz-wartość do pliku .editorconfig w projekcie:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

Dozwolone formaty nazw symboli w wartości opcji (oddzielone przez |):

• Podaj tylko nazwę typu (obejmuje wszystkie typy o tej nazwie, bez względu na typ zawierający lub przestrzeń nazw).
• W pełni kwalifikowane nazwy w formacie dokumentacyjnego identyfikatora symbolu, z opcjonalnym prefiksem T:.

Przykłady:

Przykłady pseudokodu

Naruszenie

using System;
using System.IO;

public partial class WebForm : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {
        string userInput = Request.Params["UserInput"];
        // Assume the following directory structure:
        //   wwwroot\currentWebDirectory\user1.txt
        //   wwwroot\currentWebDirectory\user2.txt
        //   wwwroot\secret\allsecrets.txt
        // There is nothing wrong if the user inputs:
        //   user1.txt
        // However, if the user input is:
        //   ..\secret\allsecrets.txt
        // Then an attacker can now see all the secrets.

        // Avoid this:
        using (File.Open(userInput, FileMode.Open))
        {
            // Read a file with the name supplied by user
            // Input through request's query string and display
            // The content to the webpage.
        }
    }
}

Imports System
Imports System.IO

Partial Public Class WebForm
    Inherits System.Web.UI.Page

    Protected Sub Page_Load(sender As Object, e As EventArgs)
        Dim userInput As String = Me.Request.Params("UserInput")
        ' Assume the following directory structure:
        '   wwwroot\currentWebDirectory\user1.txt
        '   wwwroot\currentWebDirectory\user2.txt
        '   wwwroot\secret\allsecrets.txt
        ' There is nothing wrong if the user inputs:
        '   user1.txt
        ' However, if the user input is:
        '   ..\secret\allsecrets.txt
        ' Then an attacker can now see all the secrets.

        ' Avoid this:
        Using File.Open(userInput, FileMode.Open)
            ' Read a file with the name supplied by user
            ' Input through request's query string and display
            ' The content to the webpage.
        End Using
    End Sub
End Class