Opcje konfiguracji YAML w celu dostosowania zadań kompilacji
Uwaga
Od 31 grudnia 2022 r. rozszerzenie Microsoft Security Code Analysis (MSCA) zostało wycofane. Narzędzie MSCA jest zastępowane przez rozszerzenie DevOps usługi Azure DevOps firmy Microsoft. Postępuj zgodnie z instrukcjami w temacie Konfigurowanie , aby zainstalować i skonfigurować rozszerzenie.
W tym artykule wymieniono wszystkie opcje konfiguracji YAML dostępne w każdym z zadań kompilacji. Artykuł rozpoczyna się od zadań dotyczących narzędzi do analizy kodu zabezpieczeń. Kończy się on zadaniami przetwarzania końcowego.
Zadanie skanera chroniącego przed złośliwym oprogramowaniem
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| InputType | pickList | zawsze | Prawda | Podstawowy | Podstawowa, niestandardowa | |
| Typ skanowania | pickList | InputType = Basic | Prawda | CustomScan | CustomScan, FullSystemScan, QuickScan, YourConfiguredScan | Typ skanowania, który ma być używany do skanowania oprogramowania chroniącego przed złośliwym kodem. |
| FileDirPath | filePath | ScanType = CustomScan | Prawda | $(Build.StagingDirectory) | Wskazuje plik lub katalog do skanowania. | |
| DisableRemediation | boolean | ScanType = CustomScan | Fałsz | prawda | Po zaznaczeniu: 1) Wykluczenia plików są ignorowane. 2) Pliki archiwum są skanowane. 3) Akcje nie są stosowane po wykryciu. 4) Wpisy dziennika zdarzeń nie są zapisywane po wykryciu. 5) Wykrycia z niestandardowego skanowania nie są wyświetlane w interfejsie użytkownika. 6) Dane wyjściowe konsoli będą wyświetlać listę wykryć z niestandardowego skanowania. | |
| BootSectorScan | boolean | ScanType = CustomScan | Fałsz | fałsz | Jeśli to pole jest zaznaczone, włącza skanowanie sektorów rozruchowych. | |
| Argumenty | string | InputType = Custom | Prawda | -Scan -ScanType 3 -DisableRemediation -File $(Build.StagingDirectory) | Argumenty wiersza polecenia, w których argument -File jest ścieżką bezwzględną lub względną ścieżką do elementu $(Build.StagingDirectory) wstępnie zdefiniowanego w agencie kompilacji. Uwaga: jeśli nie podasz argumentu -File jako ostatniego argumentu, wartość domyślna to $(Build.StagingDirectory). Możesz również podać własne argumenty dozwolone przez narzędzie MpCmdRun.exe. Aby uzyskać więcej informacji na temat argumentów wiersza polecenia dla tego narzędzia, wprowadź -h lub -? w polu Argumenty i wykonaj zadanie kompilacji. |
|
| EnableServices | boolean | zawsze | Prawda | fałsz | Jeśli to pole wyboru, spróbuje włączyć wymagane usługi dla usługi Windows Update w przypadku ich wyłączenia. UWAGA: Upewnij się, że zasady grupy nie wyłączają usług, a konto, w ramach którego działa ta kompilacja, ma uprawnienia administratora. |
|
| SupportLogOnError | boolean | zawsze | Prawda | fałsz | Jeśli to pole wyboru, zbierze pliki pomocy technicznej na potrzeby diagnostyki po wystąpieniu błędu. Może to potrwać kilka minut. UWAGA: Upewnij się, że konto, w ramach którego działa ta kompilacja, ma uprawnienia administratora. |
|
| TreatSignatureUpdateFailureAs | pickList | zawsze | Prawda | Ostrzeżenie | Błąd, Standardowa, Ostrzeżenie | Poziom dziennika używany, jeśli nie można zaktualizować podpisu w czasie wykonywania. W przypadku ustawienia opcji Błąd niepowodzenie aktualizacji podpisu zakończy się niepowodzeniem zadania kompilacji. Należy pamiętać, że aktualizacja podpisu często kończy się niepowodzeniem na hostowanych agentach kompilacji, mimo że podpis może być stosunkowo aktualny (mniej niż 3 godziny). |
| SignatureFreshness | pickList | zawsze | Prawda | UpToDate | OneDay, ThreeDays, TwoDays, UpToDate | Maksymalny dozwolony wiek sygnatury ochrony przed złośliwym kodem. Jeśli nie można zaktualizować podpisu i jest starszy niż ta wartość, zadanie kompilacji będzie zachowywać się zgodnie z wybraną wartością w polu Validate Signatures Age As (Weryfikuj wiek podpisów jako ). Uwaga: jeśli wybierzesz opcję Aktualna, podpisy mogą mieć maksymalnie 3 godziny. |
| TreatStaleSignatureAs | pickList | zawsze | Prawda | Błąd | Błąd, Standardowa, Ostrzeżenie | Poziom dziennika używany, jeśli wiek podpisu jest starszy niż wybrany wiek podpisu oprogramowania chroniącego przed złośliwym kodem. Nieaktualny podpis może być traktowany jako ostrzeżenie lub informacyjne , aby kontynuować skanowanie oprogramowania chroniącego przed złośliwym kodem, ale nie jest to zalecane. |
BinSkim, zadanie
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| InputType | pickList | zawsze | Prawda | Podstawowy | Podstawowa, Wiersz polecenia | |
| Argumenty | string | InputType = CommandLine | Prawda | Argumenty wiersza polecenia BinSkim w warstwie Standardowa do wykonania. Ścieżka wyjściowa zostanie usunięta i zastąpiona. Aby uzyskać więcej informacji na temat argumentów wiersza polecenia dla tego narzędzia, wprowadź pomoc w polu Argumenty i wykonaj zadanie kompilacji. |
||
| Function | pickList | InputType = Basic | Prawda | analizować | analyze, dump, exportConfig, exportRules | |
| AnalyzeTarget | filePath | InputType = Basic && Function = analyze | Prawda | $(Build.ArtifactStagingDirectory)*.dll; $(Build.ArtifactStagingDirectory)*.exe |
Co najmniej jeden specyfikator pliku, katalogu lub wzorca filtru rozpoznawany jako jeden lub więcej plików binarnych do przeanalizowania. (';' rozdzielona lista) | |
| AnalyzeSymPath | string | InputType = Basic && Function = analyze | Fałsz | Ścieżka do pliku symboli dla obiektu docelowego. | ||
| AnalyzeConfigPath | string | InputType = Basic && Function = analyze | Fałsz | domyślna | Ścieżka do pliku zasad, który będzie używany do konfigurowania analizy. Przekaż wartość "default", aby użyć wbudowanych ustawień. | |
| AnalyzePluginPath | string | InputType = Basic && Function = analyze | Fałsz | Ścieżka do wtyczki, która zostanie wywołana względem wszystkich obiektów docelowych w zestawie analiz. | ||
| AnalyzeRecurse | boolean | InputType = Basic && Function = analyze | Fałsz | prawda | Powtarzaj do podkatalogów podczas oceniania argumentów specyfikatora pliku. | |
| AnalyzeVerbose | boolean | InputType = Basic && Function = analyze | Fałsz | fałsz | Emituj pełne dane wyjściowe. Wynikowy kompleksowy raport został zaprojektowany w celu zapewnienia odpowiednich dowodów na potrzeby scenariuszy zgodności. | |
| Funkcja AnalyzeHashes | boolean | InputType = Basic && Function = analyze | Fałsz | fałsz | Dane wyjściowe algorytmu SHA-256 skrótu celów analizy podczas emitowania raportów SARIF. | |
| AnalyzeStatistics | boolean | InputType = Basic && Function = analyze | Fałsz | fałsz | Generowanie chronometrażu i innych statystyk dla sesji analizy. | |
| AnalyzeEnvironment | boolean | InputType = Basic && Function = analyze | Fałsz | fałsz | Szczegóły środowiska komputera dziennika uruchamiania do pliku wyjściowego. OSTRZEŻENIE: Ta opcja rejestruje potencjalnie poufne informacje (takie jak wszystkie wartości zmiennych środowiskowych) do dowolnego emitowanego dziennika. | |
| ExportRulesOutputType | pickList | InputType = Basic && Function = exportRules | Fałsz | SARIF | SARIF, SonarQube | Typ pliku deskryptora reguł do danych wyjściowych. Zostanie on uwzględniony w folderze dzienników BinSkim opublikowanym przez zadanie kompilacji Publish Security Analysis Logs (Publikowanie dzienników analizy zabezpieczeń). |
| ZrzutTarget | filePath | InputType = Basic && Function = zrzut | Prawda | $(Build.ArtifactStagingDirectory) | Co najmniej jeden specyfikator pliku, katalogu lub wzorca filtru rozpoznawany jako jeden lub więcej plików binarnych do przeanalizowania. (';' rozdzielona lista) | |
| DumpRecurse | boolean | InputType = Basic && Function = zrzut | Fałsz | prawda | Powtarzaj do podkatalogów podczas oceniania argumentów specyfikatora pliku. | |
| DumpVerbose | boolean | InputType = Basic && Function = zrzut | Fałsz | prawda | Emituj pełne dane wyjściowe. Wynikowy kompleksowy raport został zaprojektowany w celu zapewnienia odpowiednich dowodów na potrzeby scenariuszy zgodności. | |
| toolVersion | pickList | zawsze | Fałsz | Najnowsze | 1.5.0, najnowsza, najnowsza wersja | Wersja narzędzia do uruchomienia. |
Zadanie skanera poświadczeń
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| outputFormat | pickList | zawsze | Fałsz | pre | csv, pre, tsv | Format wyjściowy pliku wyników skanera poświadczeń. |
| toolVersion | pickList | zawsze | Fałsz | Najnowsze | 1.27.7, najnowsze, najnowsze wersje wstępne | Wersja narzędzia do uruchomienia. |
| scanFolder | filePath | zawsze | Fałsz | $(Build.SourcesDirectory) | Folder w repozytorium do skanowania pod kątem poświadczeń. | |
| searchersFileType | pickList | zawsze | Fałsz | Wartość domyślna | Niestandardowe, domyślne, domyślne i niestandardowe | Opcje lokalizowania pliku wyszukiwania używanego do skanowania. |
| searchersFile | filePath | searchersFileType == Custom OR searchersFileType == DefaultAndCustom | Fałsz | Plik konfiguracji funkcji wyszukiwania skanera poświadczeń do wykonania. Wiele wartości można dołączać i używać, udostępniając rozdzielaną przecinkami listę ścieżek do plików wyszukiwania skanera poświadczeń. | ||
| suppressionsFile | filePath | zawsze | Fałsz | Plik pomijania skanera poświadczeń do użycia w celu pomijania problemów w dzienniku danych wyjściowych. | ||
| suppressAsError | boolean | zawsze | Fałsz | fałsz | Pominięte dopasowania będą wyjściowe do pliku wyjściowego [-O]-matches. [-f] zamiast domyślnego pominiętego pliku wyjściowego [-O]-suppressed. [-f]. (Wartości domyślne to "Fałsz") | |
| verboseOutput | boolean | zawsze | Fałsz | fałsz | Pełne informacje wyjściowe. | |
| batchSize | string | zawsze | Fałsz | Liczba równoczesnych wątków używanych do równoległego uruchamiania skanerów poświadczeń. (Wartość domyślna to 20) Wartość musi należeć do zakresu od 1 do 2147483647. |
||
| regexMatchTimeoutInSeconds | string | zawsze | Fałsz | Ilość czasu w sekundach na podjęcie próby dopasowania wyszukiwania przed porzuceniem sprawdzania. Dodaje -Co RegexMatchTimeoutInSeconds=<Value> do wiersza polecenia. |
||
| fileScanReadBufferSize | string | zawsze | Fałsz | Rozmiar buforu podczas odczytywania zawartości w bajtach. (Wartości domyślne do 524288) Dodaje -Co FileScanReadBufferSize=<Value> do wiersza polecenia. |
||
| maxFileScanReadBytes | string | zawsze | Fałsz | Maksymalna liczba bajtów do odczytu z danego pliku podczas analizy zawartości. (Wartości domyślne do 104857600) Dodaje -Co MaxFileScanReadBytes=<Value> do wiersza polecenia. |
Roslyn Analyzers, zadanie
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| userProvideBuildInfo | pickList | zawsze | Prawda | auto | auto, msBuildInfo | Opcje dla użytkownika zapewniające wersję programu MSBuild, architekturę MSBuild i kompilowanie wiersza polecenia na potrzeby analizy Roslyn. W przypadku wybrania opcji Auto to zadanie pobierze informacje o kompilacji z poprzednich zadań MSBuild, VSBuild i/lub .NET Core (na potrzeby kompilacji) w tym samym potoku. |
| msBuildVersion | pickList | userProvideBuildInfo == msBuildInfo | Prawda | 16.0 | 15.0, 16.0 | Wersja programu MSBuild. |
| msBuildArchitecture | pickList | userProvideBuildInfo == msBuildInfo | Prawda | x86 | DotNetCore, x64, x86 | Architektura MSBuild. Uwaga: Jeśli wiersz polecenia kompilacji wywołuje dotnet.exe kompilacji, wybierz opcję Via .NET Core (Za pośrednictwem platformy .NET Core ). |
| msBuildCommandline | string | userProvideBuildInfo == msBuildInfo | Prawda | Kompletny wiersz polecenia kompilacji do kompilowania rozwiązania lub projektów. Uwagi: wiersz polecenia powinien zaczynać się od pełnej ścieżki do MSBuild.exe lub dotnet.exe. Polecenie zostanie uruchomione z elementem $(Build.SourcesDirectory) jako katalog roboczy. |
||
| rulesetName | pickList | zawsze | Fałsz | Zalecane | Niestandardowe, Brak, Zalecane, Wymagane | Nazwany zestaw reguł do użycia. Jeśli Ruleset Configured In Your Visual Studio Project File(s) zostanie wybrany, zostanie użyty wstępnie skonfigurowany zestaw reguł w plikach projektu programu VS. W przypadku Custom wybrania można ustawić niestandardową opcję ścieżki zestawu reguł. |
| rulesetVersion | pickList | rulesetName == Required OR rulesetName == Zalecane | Fałsz | Najnowsze | 8.0, 8.1, 8.2, latest, latestprerelease | Wersja wybranego zestawu reguł SDL. |
| customRuleset | string | rulesetName = Niestandardowy | Fałsz | Dostępna ścieżka do zestawu reguł do użycia. Ścieżki względne zostaną znormalizowane do katalogu głównego repozytorium źródłowego ($(Build.SourcesDirectory)).Jeśli zestaw reguł określa Rules z ustawioną wartością ErrorActions , zadanie kompilacji zakończy się niepowodzeniem. Aby użyć zestawu reguł, który to robi, sprawdź Continue on error w zadaniu kompilacji Control Options. |
||
| microsoftAnalyzersVersion | pickList | zawsze | Fałsz | Najnowsze | 2.9.3, 2.9.4, 2.9.6, latest, latest, latestprerelease | Wersja pakietu Microsoft.CodeAnalysis.FxCopAnalyzers do uruchomienia. |
| suppressionFileForCompilerWarnings | filePath | zawsze | Fałsz | Plik pomijania pomijający ostrzeżenia kompilatora C# i VB. Plik w postaci zwykłego tekstu z każdym identyfikatorem ostrzeżenia wymieniony w osobnym wierszu. W przypadku ostrzeżeń kompilatora określ tylko część liczbową identyfikatora ostrzeżenia. Na przykład 1018 będzie pomijać CS1018, a CA1501 będzie pomijać CA1501. Ścieżka pliku względnego zostanie dołączona do katalogu głównego repozytorium źródłowego ( $(Build.SourcesDirectory)). |
TSLint, zadanie
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| RuleLibrary | pickList | zawsze | Prawda | tslint | custom, microsoft, tslint | Wszystkie wyniki obejmują reguły dostarczane z wybraną wersją TSLint (tylko podstawowa). Tylko podstawowy — tylko reguły dostarczane z TSLint. Uwzględnij reguły firmy Microsoft — pliki do pobrania tslint-microsoft-contrib i zawierają jego reguły, które mają być dostępne do użycia w przebiegu TSLint. Wybranie tej opcji powoduje ukrycie Type Checking pola wyboru, ponieważ jest ono wymagane przez reguły firmy Microsoft i będzie automatycznie używane. To również odkryje Microsoft Contribution Version pole, zezwalając na wybranie wersji tslint-microsoft-contrib z narzędzia npm .Uwzględnij Rules Directory reguły niestandardowe — umożliwia ukrycie pola, które akceptuje dostępną ścieżkę do katalogu reguł TSLint, które mają być dostępne do użycia w przebiegu TSLint.Uwaga: wartość domyślna została zmieniona na tslint, ponieważ wielu użytkowników napotkało problemy z konfigurowaniem zestawu reguł firmy Microsoft. Aby uzyskać określoną konfigurację wersji, zobacz tslint-microsoft-contrib w witrynie GitHub. |
| RulesDirectory | string | RegułaLibrary == niestandardowa | Prawda | Dostępny katalog zawierający dodatkowe reguły TSLint, które mają być dostępne do użycia w przebiegu TSLint. | ||
| Zestaw reguł | pickList | RuleLibrary != microsoft | Prawda | tsrecommended | custom, tslatest, tsrecommended | Definiuje reguły do uruchamiania względem plików TypeScript. tslint:latest - Extends tslint:recommended i jest stale aktualizowany w celu uwzględnienia konfiguracji dla najnowszych reguł w każdej wersji TSLint. Użycie tej konfiguracji może spowodować wprowadzenie zmian powodujących niezgodność w wersjach pomocniczych, ponieważ włączono nowe reguły, które powodują błędy lint w kodzie. Gdy TSLint osiągnie poziom wersji głównej, zostanie zaktualizowany tak, tslint:recommended aby był identyczny z tslint:latest.tslint:zalecane - stabilny, nieco opiniowany zestaw reguł, które TSLint zachęca do ogólnego programowania w języku TypeScript. Ta konfiguracja jest zgodna z semverinstrukcjami , więc nie będzie miała zmian powodujących niezgodność w wersjach pomocniczych ani poprawek. |
| RulesetMicrosoft | pickList | RuleLibrary == microsoft | Prawda | mssdlrequired | custom, msrecommended, mssdlrecommended, mssdlrequired, tslatest, tsrecommended | Definiuje reguły do uruchamiania względem plików TypeScript. microsoft:sdl-required - Uruchom wszystkie dostępne kontrole dostarczone przez narzędzie tslint i reguły tslint-microsoft-contrib, które spełniają wymagane zasady cyklu projektowania zabezpieczeń (SDL). microsoft:sdl-recommended - Uruchom wszystkie dostępne kontrole dostarczone przez narzędzie tslint i reguły tslint-microsoft-contrib, które spełniają wymagane i zalecane zasady cyklu projektowania zabezpieczeń (SDL). microsoft:zalecane wszystkie kontrole zalecane przez twórców reguł tslint-microsoft-contrib. Obejmuje to kontrole zabezpieczeń i niezwiązane z zabezpieczeniami. tslint:latest - Extends tslint:recommended i jest stale aktualizowany w celu uwzględnienia konfiguracji dla najnowszych reguł w każdej wersji TSLint. Użycie tej konfiguracji może spowodować wprowadzenie zmian powodujących niezgodność w wersjach pomocniczych, ponieważ włączono nowe reguły, które powodują błędy lint w kodzie. Gdy TSLint osiągnie poziom wersji głównej, zostanie zaktualizowany tak, tslint:recommended aby był identyczny z tslint:latest.tslint:zalecane - stabilny, nieco opiniowany zestaw reguł, które TSLint zachęca do ogólnego programowania w języku TypeScript. Ta konfiguracja jest zgodna z semverinstrukcjami , więc nie będzie miała zmian powodujących niezgodność w wersjach pomocniczych ani poprawek. |
| RulesetFile | string | Ruleset == custom OR RulesetMicrosoft == custom | Prawda | Plik konfiguracji określający, które reguły mają być uruchamiane. Ścieżka do konfiguracji zostanie dodana jako ścieżka reguł niestandardowych. |
||
| FileSelectionType | pickList | zawsze | Prawda | fileGlob | fileGlob, projectFile | |
| Pliki | string | FileSelectionType == fileGlob | Prawda | .Ts | Plik glob , który określa, które pliki mają być przetwarzane. Ścieżki są względne względem Build.SourcesDirectory wartości.Biblioteka kontrybucjna firmy Microsoft wymaga użycia pliku projektu. Jeśli używasz biblioteki Kontrybucj firmy Microsoft z opcją File Glob Pattern , zostanie wygenerowany plik projektu. |
|
| ECMAScriptVersion | pickList | FileSelectionType == fileGlob && RuleLibrary == microsoft | Prawda | ES3 | ES2015, ES2016, ES2017, ES3, ES5, ES6, ESNext | Docelowa wersja języka ECMAScript skonfigurowana za pomocą kompilatora języka TypeScript. W przypadku korzystania z pliku projektu jest to pole compilerOptions.target pliku tsconfig.json TypeScript. |
| Projekt | string | FileSelectionType == projectFile | Prawda | Ścieżka do pliku tsconfig.json , który określa pliki TypeScript do uruchamiania TSLint na. Ścieżki są względne względem Build.SourcesDirectory wartości. |
||
| Sprawdzanie typu | boolean | RuleLibrary != microsoft && FileSelectionType == projectFile | Fałsz | prawda | Włącza sprawdzanie typów podczas uruchamiania reguł linting. | |
| ExcludeFiles | string | zawsze | Fałsz | Glob, który wskazuje pliki do wykluczenia z lintingu. Ścieżki są względne względem Build.SourcesDirectory wartości. Wiele wartości można określić rozdzielając średnikami. |
||
| OutputFormat | pickList | zawsze | Prawda | json | checkstyle, codeFrame, filesList, json, msbuild, pmd, proza, stylowy, pełny, vso | Formater używany do generowania danych wyjściowych. Należy pamiętać, że format JSON jest zgodny z funkcją Post Analysis. |
| NodeMemory | string | zawsze | Fałsz | Jawna ilość pamięci w mb/s do przydzielenia do węzła na potrzeby uruchamiania TSLint. Przykład: 8000 Mapuje na opcję interfejsu --max_old_space=<value> wiersza polecenia dla węzła v8 option, czyli . |
||
| ToolVersion | pickList | RuleLibrary != microsoft | Prawda | latest | 4.0.0, 4.0.1, 4.0.2, 4.1.0, 4.1.1, 4.2.0, 4.3.0, 4.3.1, 4.4.0, 4.4.1, 4.4.2, 4.5.0, 4.5.1, 5.0.0, 5.1.0, 5.2.0, 5.3.0, 5.3.2, 5.4.0, 5.4.1, 5.4.2, 5.4.3, 5.5.0, najnowsze | Wersja narzędzia TSLint do pobrania i uruchomienia. |
| TypeScriptVersion | pickList | zawsze | Prawda | latest | 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.9.0, 0.9.1, 0.9.5, 0.9.7, 1.0.0, 1.0.1, 1.3.0, 1.4.1, 1.5.3, 1.6.2, 1.7.3, 1.7.5, 1.8.0, 1.8.10, 1.8.2, 1.8.5, 1.8.6, 1.8.7, 1.8.9, 1.9.0, 2.0.0, 2.0.10, 2.0.2, 2.0.3, 2.0.6, 2.0.7, 2.0.8, 2.0.9, 2.1.1, 2.1.4, 2.1.5, 2.1.6, 2.2.0, 2.2.1, niestandardowe, najnowsze | Wersja języka TypeScript do pobrania i użycia. Uwaga: musi to być ta sama wersja języka TypeScript, co jest używane do kompilowania kodu. |
| TypeScriptVersionCustom | string | TypeScriptVersion == niestandardowe | Prawda | latest | Wersja języka TypeScript do pobrania i użycia. Uwaga: musi to być ta sama wersja języka TypeScript, co jest używane do kompilowania kodu. |
|
| MicrosoftContribVersion | pickList | RuleLibrary == microsoft | latest | 4.0.0, 4.0.1, 5.0.0, 5.0.1, najnowsza wersja | Wersja polecenia tslint-microsoft-contrib (reguły SDL) do pobrania i użycia. Uwaga: zostanie wybrana wersja narzędzia tslint zgodna z wersją wybraną dla polecenia tslint-microsoft-contrib. Aktualizacje polecenia tslint-microsoft-contrib będą bramowane przez to zadanie kompilacji do czasu wystąpienia okresu testowania. |
Zadanie Publikowanie dzienników analizy zabezpieczeń
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| ArtifactName | string | zawsze | Prawda | CodeAnalysisLogs | Nazwa artefaktu do utworzenia. | |
| ArtifactType | pickList | zawsze | Prawda | Kontener | Kontener, FilePath | Typ artefaktu do utworzenia. |
| TargetPath | string | ArtifactType = FilePath | Fałsz | \my\share$(Build.DefinitionName) $(Build.BuildNumber) |
Udział plików, do którego mają być skopiowane pliki | |
| AllTools | boolean | zawsze | Prawda | prawda | Opublikuj wyniki wygenerowane przez wszystkie zadania kompilacji narzędzia Secure Development Tools. | |
| Oprogramowanie chroniące przed złośliwym kodem | boolean | AllTools = false | Prawda | prawda | Publikowanie wyników generowanych przez zadania kompilacji oprogramowania AntiMalware. | |
| BinSkim | boolean | AllTools = false | Prawda | prawda | Publikowanie wyników generowanych przez zadania kompilacji BinSkim. | |
| CredScan | boolean | AllTools = false | Prawda | prawda | Publikowanie wyników generowanych przez zadania kompilacji skanera poświadczeń. | |
| RoslynAnalyzers | boolean | AllTools = false | Prawda | fałsz | Publikowanie wyników generowanych przez zadania kompilacji narzędzia Roslyn Analyzers. | |
| TSLint | boolean | AllTools = false | Prawda | prawda | Publikowanie wyników generowanych przez zadania kompilacji TSLint. Należy pamiętać, że w raportach obsługiwane są tylko dzienniki TSLint w formacie JSON. Jeśli wybrano inny format, zaktualizuj odpowiednio zadanie kompilacji TSLint. | |
| ToolLogsNotFoundAction | lista wyboru | zawsze | Prawda | Standardowa | Błąd, Brak, Standardowa, Ostrzeżenie | Akcja do wykonania, gdy nie znaleziono dzienników wybranego narzędzia (lub dowolnego narzędzia, jeśli zaznaczono wszystkie narzędzia), co oznacza, że narzędzie nie zostało uruchomione. Opcje: Brak: Komunikat jest zapisywany do pełnego strumienia wyjściowego dostępnego tylko przez ustawienie zmiennej VSTS system.debug na wartość true. Standardowa: (Ustawienie domyślne) Zapisuje standardowy komunikat wyjściowy, który nie został znaleziony dla narzędzia. Ostrzeżenie: Zapisuje żółty komunikat ostrzegawczy, że nie znaleziono żadnych dzienników dla narzędzia, które jest wyświetlane na stronie podsumowania kompilacji jako ostrzeżenie. Błąd: Zapisuje czerwony komunikat o błędzie i zgłasza wyjątek, powodując niezgodność kompilacji. Użyj tej opcji, aby upewnić się, że poszczególne narzędzia są wybierane, aby upewnić się, które narzędzia były uruchomione. |
Zadanie Raport zabezpieczeń
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| VstsConsole | boolean | zawsze | Fałsz | prawda | Zapisz wyniki w konsoli potoku. | |
| TsvFile | boolean | zawsze | Fałsz | prawda | Wygeneruj plik tsv (wartości rozdzielone tabulatorami) z jednym wierszem na znaleziony wynik i tabulatory oddzielające informacje dla wyniku. | |
| Plik HTML | boolean | zawsze | Fałsz | prawda | Wygeneruj plik raportu HTML. | |
| AllTools | boolean | zawsze | Prawda | fałsz | Wyniki raportu generowane przez wszystkie zadania kompilacji narzędzia Secure Development Tools. | |
| BinSkim | boolean | AllTools = false | Prawda | fałsz | Wyniki raportu generowane przez zadania kompilacji BinSkim. | |
| BinSkimBreakOn | pickList | AllTools = true OR BinSkim = true | Prawda | Błąd | Błąd, WarningAbove | Poziom wyników do raportowania. |
| CredScan | boolean | AllTools = false | Prawda | fałsz | Wyniki raportu generowane przez zadania kompilacji skanera poświadczeń. | |
| RoslynAnalyzers | boolean | AllTools = false | Prawda | fałsz | Wyniki raportu generowane przez zadania kompilacji narzędzia Roslyn Analyzer. | |
| RoslynAnalyzersBreakOn | pickList | AllTools = true OR RoslynAnalyzers = true | Prawda | Błąd | Błąd, WarningAbove | Poziom wyników do raportowania. |
| TSLint | boolean | AllTools = false | Prawda | fałsz | Wyniki raportu generowane przez zadania kompilacji TSLint. Należy pamiętać, że w raportach obsługiwane są tylko dzienniki TSLint w formacie JSON. Jeśli wybrano inny format, zaktualizuj odpowiednio zadanie kompilacji TSLint. | |
| TSLintBreakOn | pickList | AllTools = true OR TSLint = true | Prawda | Błąd | Błąd, WarningAbove | Poziom wyników do raportowania. |
| ToolLogsNotFoundAction | lista wyboru | zawsze | Prawda | Standardowa | Błąd, Brak, Standardowa, Ostrzeżenie | Akcja do wykonania, gdy nie znaleziono dzienników wybranego narzędzia (lub dowolnego narzędzia, jeśli zaznaczono wszystkie narzędzia), co oznacza, że narzędzie nie zostało uruchomione. Opcje: Brak: Komunikat jest zapisywany do pełnego strumienia wyjściowego dostępnego tylko przez ustawienie zmiennej VSTS system.debug na wartość true. Standardowa: (Ustawienie domyślne) Zapisuje standardowy komunikat wyjściowy, który nie został znaleziony dla narzędzia. Ostrzeżenie: Zapisuje żółty komunikat ostrzegawczy, że nie znaleziono żadnych dzienników dla narzędzia, które jest wyświetlane na stronie podsumowania kompilacji jako ostrzeżenie. Błąd: Zapisuje czerwony komunikat o błędzie i zgłasza wyjątek, powodując niezgodność kompilacji. Użyj tej opcji, aby upewnić się, że poszczególne narzędzia są wybierane, aby upewnić się, które narzędzia były uruchomione. |
| CustomLogsFolder | string | zawsze | Fałsz | Folder podstawowy, w którym znajdują się dzienniki narzędzi analizy; poszczególne pliki dziennika będą znajdować się w podfolderach nazwanych po każdym narzędziu pod tą ścieżką. |
Zadanie po analizie
| InputType | Type | Odpowiedni | Wymagane | Wartość domyślna | Opcje (dla list wyboru) | Opis |
|---|---|---|---|---|---|---|
| AllTools | boolean | zawsze | Prawda | fałsz | Przerwij kompilację, jeśli jakiekolwiek problemy zostaną znalezione przez dowolne zadanie kompilacji Analizy kodu zabezpieczeń firmy Microsoft. | |
| BinSkim | boolean | AllTools = false | Prawda | fałsz | Przerwij kompilację, jeśli zostaną znalezione jakiekolwiek problemy BinSkim, zgodnie z wybraną opcją Przerwij w. | |
| BinSkimBreakOn | pickList | AllTools = true OR BinSkim = true | Prawda | Błąd | Błąd, WarningAbove | Poziom problemów, aby przerwać kompilację. |
| CredScan | boolean | AllTools = false | Prawda | fałsz | Przerwij kompilację, jeśli zostaną znalezione problemy ze skanerem poświadczeń. | |
| RoslynAnalyzers | boolean | AllTools = false | Prawda | fałsz | Przerwij kompilację, jeśli zostaną znalezione jakiekolwiek problemy z analizatorami Roslyn. | |
| RoslynAnalyzersBreakOn | pickList | AllTools = true OR RoslynAnalyzers = true | Prawda | Błąd | Błąd, WarningAbove | Poziom problemów, aby przerwać kompilację. |
| TSLint | boolean | AllTools = false | Prawda | fałsz | Przerwij kompilację, jeśli zostaną znalezione jakiekolwiek problemy z TSLint. Należy pamiętać, że tylko dzienniki TSLint w formacie JSON są obsługiwane na potrzeby analizy po analizie. Jeśli wybrano inny format, zaktualizuj odpowiednio zadanie kompilacji TSLint. | |
| TSLintBreakOn | pickList | AllTools = true OR TSLint = true | Prawda | Błąd | Błąd, WarningAbove | Poziom problemów, aby przerwać kompilację. |
| VstsConsole | boolean | zawsze | Fałsz | prawda | Zapisz wyniki w konsoli potoku. | |
| ToolLogsNotFoundAction | lista wyboru | zawsze | Prawda | Standardowa | Błąd, Brak, Standardowa, Ostrzeżenie | Akcja do wykonania, gdy nie znaleziono dzienników wybranego narzędzia (lub dowolnego narzędzia, jeśli zaznaczono wszystkie narzędzia), co oznacza, że narzędzie nie zostało uruchomione. Opcje: Brak: Komunikat jest zapisywany do pełnego strumienia wyjściowego dostępnego tylko przez ustawienie zmiennej VSTS system.debug na wartość true. Standardowa: (Ustawienie domyślne) Zapisuje standardowy komunikat wyjściowy, który nie został znaleziony dla narzędzia. Ostrzeżenie: Zapisuje żółty komunikat ostrzegawczy, że nie znaleziono żadnych dzienników dla narzędzia, które jest wyświetlane na stronie podsumowania kompilacji jako ostrzeżenie. Błąd: Zapisuje czerwony komunikat o błędzie i zgłasza wyjątek, powodując niezgodność kompilacji. Użyj tej opcji, aby upewnić się, że poszczególne narzędzia są wybierane, aby upewnić się, które narzędzia były uruchomione. |
Następne kroki
Jeśli masz dodatkowe pytania dotyczące rozszerzenia Analizy kodu zabezpieczeń i oferowanych narzędzi, zapoznaj się z naszą stroną często zadawanych pytań.