Skip to content
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

Dev/daknis/decorator #93

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 49 additions & 21 deletions build.proj
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

<PropertyGroup Label="ExtensionDetails">
<!-- Constants -->
<MsdoExtensionId>microsoft-security-devops-azdevops</MsdoExtensionId>
<MsdoDecoratorExtensionId>microsoft-security-devops-azdevops-decorator</MsdoDecoratorExtensionId>

<!-- Set the extension id -->
<ExtensionId Condition=" '$(ExtensionName)' == '' ">$(MsdoExtensionId)</ExtensionId>
</PropertyGroup>

<PropertyGroup Label="Directories">
<!-- Top Level Directories -->
<RepoDirectory Condition=" '$(RepoDirectory)' == '' ">$(MSBuildThisFileDirectory.TrimEnd('\\'))</RepoDirectory>
<BinDirectory Condition=" '$(BinDirectory)' == '' ">$(RepoDirectory)\bin</BinDirectory>
<LibDirectory Condition=" '$(LibDirectory)' == '' ">$(RepoDirectory)\lib</LibDirectory>
<ScriptsDirectory Condition=" '$(ScriptsDirectory)' == '' ">$(RepoDirectory)\scripts</ScriptsDirectory>
<PublishersDirectory Condition=" '$(PublishersDirectory)' == '' ">$(ScriptsDirectory)\.publishers</PublishersDirectory>
<SrcDirectory Condition=" '$(SrcDirectory)' == '' ">$(RepoDirectory)\src</SrcDirectory>
<TestDirectory Condition=" '$(TestDirectory)' == '' ">$(RepoDirectory)\test</TestDirectory>
<TestStagingDirectory Condition=" '$(TestStagingDirectory)' == '' ">$(TestDirectory)\lib</TestStagingDirectory>
Expand All @@ -17,6 +27,7 @@
<Configuration Condition=" '$(Configuration)' == '' ">debug</Configuration>

<!-- Options -->
<!-- This will match a directory name in the src directory -->
<Official Condition=" '$(Official)' == '' ">false</Official>
<RunTests Condition=" '$(RunTests)' == '' ">false</RunTests>

Expand All @@ -36,11 +47,28 @@
<SkipCompile Condition=" '$(SkipCompile)' == '' ">false</SkipCompile>
</PropertyGroup>

<PropertyGroup
Label="MsdoDecoratorConfiguration"
Condition=" '$(ExtensionId)' == '$(MsdoDecoratorExtensionId)' ">
<!-- Decorator does not have tests to run -->
<RunTests>false</RunTests>
<!-- Decorator does not contribute TypeScript -->
<SkipCompileTsc>true</SkipCompileTsc>
<!-- Decorator does not have a dependency to sideload -->
<Sideload>false</Sideload>
</PropertyGroup>

<PropertyGroup Label="ExtensionPaths">
<ExtensionBinDirectory Condition=" '$(ExtensionBinDirectory)' == '' ">$(BinDirectory)\$(ExtensionId)</ExtensionBinDirectory>
<ExtensionLibDirectory Condition=" '$(ExtensionLibDirectory)' == '' ">$(LibDirectory)\$(ExtensionId)</ExtensionLibDirectory>
<ExtensionSrcDirectory Condition=" '$(ExtensionSrcDirectory)' == '' ">$(SrcDirectory)\$(ExtensionId)</ExtensionSrcDirectory>
</PropertyGroup>

<PropertyGroup Label="BuildPaths">
<OutputDirectory Condition=" '$(OutputDirectory)' == '' ">$(BinDirectory)\$(Configuration)</OutputDirectory>
<StagingDirectory Condition=" '$(StagingDirectory)' == '' ">$(LibDirectory)\$(Configuration)</StagingDirectory>
<LibNodeModulesDirectory Condition= " '$(LibNodeModulesDirectory)' == '' ">$(LibDirectory)\node_modules</LibNodeModulesDirectory>
<RepoNodeModulesDirectory Condition= " '$(RepoNodeModulesDirectory)' == '' ">$(RepoDirectory)\node_modules</RepoNodeModulesDirectory>
<OutputDirectory Condition=" '$(OutputDirectory)' == '' ">$(ExtensionBinDirectory)\$(Configuration)</OutputDirectory>
<StagingDirectory Condition=" '$(StagingDirectory)' == '' ">$(ExtensionLibDirectory)\$(Configuration)</StagingDirectory>
<SrcNodeModulesDirectory Condition= " '$(SrcNodeModulesDirectory)' == '' ">$(ExtensionSrcDirectory)\node_modules</SrcNodeModulesDirectory>
<LibNodeModulesDirectory Condition= " '$(LibNodeModulesDirectory)' == '' ">$(ExtensionLibDirectory)\node_modules</LibNodeModulesDirectory>
</PropertyGroup>

<PropertyGroup Label="Scripts">
Expand All @@ -61,18 +89,18 @@

<PropertyGroup>
<PublisherName Condition=" '$(Official)' == 'true' AND '$(PublisherName)' == '' ">debug</PublisherName>
<ExtensionManifestFilePath>$(SrcDirectory)\$(ExtensionManifestFileName)</ExtensionManifestFilePath>
<ExtensionIconFilePath>$(SrcDirectory)\icon.png</ExtensionIconFilePath>
<ExtensionReadmeFilePath>$(SrcDirectory)\extension-readme.md</ExtensionReadmeFilePath>
<ExtensionEulaFilePath>$(SrcDirectory)\extension-eula.md</ExtensionEulaFilePath>
<ExtensionManifestFilePath>$(ExtensionSrcDirectory)\$(ExtensionManifestFileName)</ExtensionManifestFilePath>
<ExtensionIconFilePath>$(ExtensionSrcDirectory)\icon.png</ExtensionIconFilePath>
<ExtensionReadmeFilePath>$(ExtensionSrcDirectory)\extension-readme.md</ExtensionReadmeFilePath>
<ExtensionEulaFilePath>$(ExtensionSrcDirectory)\extension-eula.md</ExtensionEulaFilePath>
<CopyEula>true</CopyEula>
<StagedExtensionManifestFilePath>$(StagingDirectory)\extension-manifest.json</StagedExtensionManifestFilePath>
<OutputExtensionFileName>microsoft-security-devops-azdevops</OutputExtensionFileName>
<OutputExtensionFilePath>$(OutputDirectory)\$(OutputExtensionFileName)</OutputExtensionFilePath>
<OutputExtensionFilePath Condition=" '$(Configuration)' == 'debug'">$(OutputExtensionFilePath)-debug</OutputExtensionFilePath>
</PropertyGroup>

<ItemGroup Label="BuildTasks">
<ItemGroup Label="BuildTasks" >
<MicrosoftSecurityDevOpsV1 Include="MicrosoftSecurityDevOps">
<MajorVersion>v1</MajorVersion>
<Platform>Node</Platform>
Expand Down Expand Up @@ -112,35 +140,35 @@
</Target>

<Target
Name="NpmInstall-RepoDirectory"
Name="NpmInstall-ExtensionSrcDirectory"
Inputs="$(RepoDirectory)"
Outputs="$(RepoNodeModulesDirectory)"
Condition=" '$(NpmInstall)' == 'true' AND ('$(ForceNpmInstall)' == 'true' OR EXISTS('$(RepoNodeModulesDirectory)') != 'true')">
Outputs="$(SrcNodeModulesDirectory)"
Condition=" '$(NpmInstall)' == 'true' AND ('$(ForceNpmInstall)' == 'true' OR EXISTS('$(SrcNodeModulesDirectory)') != 'true')">
<Message Text="Intstalling npm packages in repo directory: $(RepoDirectory)..." />
<Exec Command="npm install" WorkingDirectory="$(RepoDirectory)" />
<Exec Command="npm install" WorkingDirectory="$(ExtensionSrcDirectory)" />
</Target>

<Target
Name="CompileTsc"
Condition=" '$(SkipCompileTsc)' != 'true' ">
<Message Text="Compiling Microsoft Security DevOps for Azure DevOps Extension" />
<Exec Command="npx tsc --outDir &quot;$(StagingDirectory)&quot;" WorkingDirectory="$(SrcDirectory)" />
<Exec Command="npx tsc --outDir &quot;$(StagingDirectory)&quot;" WorkingDirectory="$(ExtensionSrcDirectory)" />
</Target>

<Target
Name="Compile"
DependsOnTargets="Clean;NpmInstall-RepoDirectory;CompileTsc"
DependsOnTargets="Clean;NpmInstall-ExtensionSrcDirectory;CompileTsc"
Condition=" '$(SkipCompile)' != 'true' ">
<PropertyGroup>
<RepoPackageJsonFilePath>$(RepoDirectory)\package.json</RepoPackageJsonFilePath>
<PackageJsonFilePath>$(ExtensionSrcDirectory)\package.json</PackageJsonFilePath>
<SrcNpmrcFilePath>$(SrcDirectory)\.npmrc</SrcNpmrcFilePath>
</PropertyGroup>

<Copy SourceFiles="$(RepoPackageJsonFilePath)" DestinationFiles="$(LibDirectory)\package.json" />
<Copy SourceFiles="$(SrcNpmrcFilePath)" DestinationFiles="$(LibDirectory)\.npmrc" />
<Copy SourceFiles="$(PackageJsonFilePath)" DestinationFiles="$(ExtensionLibDirectory)\package.json" />
<Copy SourceFiles="$(SrcNpmrcFilePath)" DestinationFiles="$(ExtensionLibDirectory)\.npmrc" />
</Target>

<Target Name="CompileTests" DependsOnTargets="CleanTests;NpmInstall-RepoDirectory">
<Target Name="CompileTests" DependsOnTargets="CleanTests;NpmInstall-ExtensionSrcDirectory">
<Message Text="Compiling tests" />
<Exec Command="npx tsc --outDir &quot;$(TestStagingDirectory)&quot;" WorkingDirectory="$(TestDirectory)" />
</Target>
Expand Down Expand Up @@ -209,13 +237,13 @@
AfterTargets="Stage">

<PropertyGroup>
<BuildTaskSourceFolder>$(SrcDirectory)\%(BuildTask.Identity)</BuildTaskSourceFolder>
<BuildTaskSourceFolder>$(ExtensionSrcDirectory)\%(BuildTask.Identity)</BuildTaskSourceFolder>
<BuildTaskSourceFolder Condition=" '%(BuildTask.MajorVersion)' != '' ">$(BuildTaskSourceFolder)\%(BuildTask.MajorVersion)</BuildTaskSourceFolder>

<BuildTaskStagingFolder>$(StagingDirectory)\%(BuildTask.Identity)</BuildTaskStagingFolder>
<BuildTaskStagingFolder Condition=" '%(BuildTask.MajorVersion)' != '' ">$(BuildTaskStagingFolder)\%(BuildTask.MajorVersion)</BuildTaskStagingFolder>

<IconSourceFilePath Condition=" '%(BuildTask.IconPath)' == '' ">$(SrcDirectory)\icon.png</IconSourceFilePath>
<IconSourceFilePath Condition=" '%(BuildTask.IconPath)' == '' ">$(ExtensionSrcDirectory)\icon.png</IconSourceFilePath>
<IconStagingFilePath>$(BuildTaskStagingFolder)\icon.png</IconStagingFilePath>

<InputMapPath>$(BuildTaskSourceFolder)\inputMap.json</InputMapPath>
Expand Down
8 changes: 5 additions & 3 deletions scripts/.publishers/debug-publishers.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{
"mapping": {
"MicrosoftSecurityDevOps": "505fbc36-f364-4b95-b1c4-7a3fd78a6559"
"MicrosoftSecurityDevOps": "505fbc36-f364-4b95-b1c4-7a3fd78a6559",
"microsoft-security-devops-azdevops": "94c33865-4969-4b65-bc8a-5b21fb87bee4",
"microsoft-security-devops-azdevops-decorator": "cb4b3c9f-c50e-4ea6-8869-afb8300989d0"
},
"version": "1.10.0.0",
"version": "1.11.0.0",
"extensionId": "microsoft-security-devops-azdevops-debug",
"count": 4,
"count": 0,
"publisher": "ms-secdevops-test",
"publisherName": "debug"
}
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
{
"manifestVersion": 1,
"id": "microsoft-security-devops-azdevops-decorator-debug",
"name": "Microsoft Security DevOps Decorator",
"version": "0.1.0",
"publisher": "ms-securitydevops",
"description": "Inject the MicrosoftSecurityDevOps build task into CI/CD pipelines.",
"public": false,
"galleryFlags": [
"Preview"
],
"targets": [
{
"id": "Microsoft.VisualStudio.Services.Cloud"
}
],
"repository": {
"type": "git",
"uri": "https://github.com/microsoft/security-devops-azdevops"
},
"categories": [
"Azure Pipelines"
],
"tags": [
"MSDO",
"Security",
"Analysis",
"Microsoft Defender",
"Microsoft Defender for DevOps",
"Microsoft Defender for Cloud",
"Defender for DevOps",
"Static Analysis",
"AntiMalware",
"Bandit",
"BinSkim",
"Defender",
"ESLint",
"Iac",
"Gosec",
"Flawfinder",
"Roslyn Analyzers",
"Template Analyzer",
"Terrascan",
"Trivy",
"Windows Defender",
"SDL",
"Build Break"
],
"icons": {
"default": "icon.png"
},
"content": {
"details": {
"path": "readme.md"
}
},
"links": {
"getstarted": {
"uri": "https://aka.ms/msdo-azdevops"
},
"support": {
"uri": "mailto:mscahelp@microsoft.com"
},
"license": {
"uri": "https://github.com/microsoft/security-devops-azdevops/blob/main/LICENSE"
}
},
"branding": {
"color": "rgb(64, 64, 64)",
"theme": "dark"
},
"files": [
{
"path": "msdo-decorator.yml",
"addressable": true,
"contentType": "text/plain"
}
],
"contributions": [
{
"id": "msdo-decorator",
"type": "ms.azure-pipelines.pipeline-decorator",
"targets": [
"ms.azure-pipelines-agent-job.post-job-tasks"
],
"properties": {
"template": "msdo-decorator.yml"
}
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
{
"manifestVersion": 1,
"id": "microsoft-security-devops-azdevops-decorator",
"name": "Microsoft Security DevOps Decorator",
"version": "0.1.0",
"publisher": "ms-securitydevops",
"description": "Inject the MicrosoftSecurityDevOps build task into CI/CD pipelines.",
"public": false,
"galleryFlags": [
"Preview"
],
"targets": [
{
"id": "Microsoft.VisualStudio.Services.Cloud"
}
],
"repository": {
"type": "git",
"uri": "https://github.com/microsoft/security-devops-azdevops"
},
"categories": [
"Azure Pipelines"
],
"tags": [
"MSDO",
"Security",
"Analysis",
"Microsoft Defender",
"Microsoft Defender for DevOps",
"Microsoft Defender for Cloud",
"Defender for DevOps",
"Static Analysis",
"AntiMalware",
"Bandit",
"BinSkim",
"Defender",
"ESLint",
"Iac",
"Gosec",
"Flawfinder",
"Roslyn Analyzers",
"Template Analyzer",
"Terrascan",
"Trivy",
"Windows Defender",
"SDL",
"Build Break"
],
"icons": {
"default": "icon.png"
},
"content": {
"details": {
"path": "readme.md"
}
},
"links": {
"getstarted": {
"uri": "https://aka.ms/msdo-azdevops"
},
"support": {
"uri": "mailto:mscahelp@microsoft.com"
},
"license": {
"uri": "https://github.com/microsoft/security-devops-azdevops/blob/main/LICENSE"
}
},
"branding": {
"color": "rgb(64, 64, 64)",
"theme": "dark"
},
"files": [
{
"path": "msdo-decorator.yml",
"addressable": true,
"contentType": "text/plain"
}
],
"contributions": [
{
"id": "msdo-decorator",
"type": "ms.azure-pipelines.pipeline-decorator",
"targets": [
"ms.azure-pipelines-agent-job.post-job-tasks"
],
"properties": {
"template": "msdo-decorator.yml"
}
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**Microsoft Internal Only**

Auto injects a Codesign Validation task into Production builds.
File renamed without changes
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
steps:
- ${{ if and(ne(variables['runMicrosoftSecurityDevOps'], 'false'), not(containsValue(job.steps.*.task.id, '8d616517-6390-454f-b369-6fd038d8fe96'))) }}:
- task: MicrosoftSecurityDevOps@1
displayName: 'Microsoft Security DevOps (injected from decorator)'
condition: and(succeeded(), ne(variables['runMicrosoftSecurityDevOps'], 'false'))
17 changes: 17 additions & 0 deletions src/microsoft-security-devops-azdevops-decorator/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "microsoft-security-devops-azdevops-decorator",
"version": "0.1.0",
"description": "Microsoft Security DevOps for Azure DevOps Decorator.",
"author": "Microsoft Corporation",
"license": "MIT",
"repository": "https://github.com/microsoft/microsoft-security-devops-azdevops",
"scripts": {
"build": "dotnet build ./../../build.proj /p:ExtensionId=microsoft-security-devops-azdevops-decorator",
"compile": "dotnet build ./../../build.proj /t:Compile /p:ExtensionId=microsoft-security-devops-azdevops-decorator"
},
"dependencies": { },
"devDependencies": {
"tfx-cli": "^0.15.0",
"typescript": "^5.1.3"
}
}
Loading
Loading