github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/malwareExecuteScan.yaml (about)

     1  metadata:
     2    name: malwareExecuteScan
     3    description: Performs a malware scan using the [SAP Malware Scanning Service](https://help.sap.com/viewer/b416237f818c4e2e827f6118640079f8/LATEST/en-US/b7c9b86fe724458086a502df3160f380.html).
     4    longDescription: |
     5      Performs a malware scan using the [SAP Malware Scanning Service](https://help.sap.com/viewer/b416237f818c4e2e827f6118640079f8/LATEST/en-US/b7c9b86fe724458086a502df3160f380.html).
     6  spec:
     7    inputs:
     8      secrets:
     9        - name: malwareScanCredentialsId
    10          description: Jenkins 'Username with password' credentials ID containing the technical user/password credential used to communicate with the malwarescanning service.
    11          type: jenkins
    12      params:
    13        - name: buildTool
    14          type: string
    15          description: "Defines the tool which is used for building the artifact."
    16          mandatory: true
    17          scope:
    18            - GENERAL
    19            - PARAMETERS
    20            - STAGES
    21            - STEPS
    22          resourceRef:
    23            - name: commonPipelineEnvironment
    24              param: buildTool
    25        - name: dockerConfigJSON
    26          type: string
    27          description: Path to the file `.docker/config.json` - this is typically provided by your CI/CD system. You can find more details about the Docker credentials in the [Docker documentation](https://docs.docker.com/engine/reference/commandline/login/).
    28          scope:
    29            - PARAMETERS
    30            - STAGES
    31            - STEPS
    32          secret: true
    33          resourceRef:
    34            - name: commonPipelineEnvironment
    35              param: custom/dockerConfigJSON
    36            - name: dockerConfigJsonCredentialsId
    37              type: secret
    38            - type: vaultSecretFile
    39              name: dockerConfigFileVaultSecretName
    40              default: docker-config
    41        - name: containerRegistryPassword
    42          description: "For `buildTool: docker`: Password for container registry access - typically provided by the CI/CD environment."
    43          type: string
    44          scope:
    45            - PARAMETERS
    46            - STAGES
    47            - STEPS
    48          secret: true
    49          resourceRef:
    50            - name: commonPipelineEnvironment
    51              param: container/repositoryPassword
    52            - name: commonPipelineEnvironment
    53              param: custom/repositoryPassword
    54        - name: containerRegistryUser
    55          description: "For `buildTool: docker`: Username for container registry access - typically provided by the CI/CD environment."
    56          type: string
    57          scope:
    58            - PARAMETERS
    59            - STAGES
    60            - STEPS
    61          secret: true
    62          resourceRef:
    63            - name: commonPipelineEnvironment
    64              param: container/repositoryUsername
    65            - name: commonPipelineEnvironment
    66              param: custom/repositoryUsername
    67        - name: host
    68          type: string
    69          description: "malware scanning host."
    70          scope:
    71            - PARAMETERS
    72            - STAGES
    73            - STEPS
    74          mandatory: true
    75        - name: username
    76          type: string
    77          description: "User"
    78          scope:
    79            - PARAMETERS
    80            - STAGES
    81            - STEPS
    82          mandatory: true
    83          secret: true
    84          resourceRef:
    85            - name: malwareScanCredentialsId
    86              type: secret
    87              param: username
    88            - name: malwareScanUsernameVaultSecretName
    89              type: vaultSecret
    90              default: malware-scan
    91        - name: password
    92          type: string
    93          description: "Password"
    94          scope:
    95            - PARAMETERS
    96            - STAGES
    97            - STEPS
    98          mandatory: true
    99          secret: true
   100          resourceRef:
   101            - name: malwareScanCredentialsId
   102              type: secret
   103              param: password
   104            - name: malwareScanPasswordVaultSecretName
   105              type: vaultSecret
   106              default: malware-scan
   107        - name: scanImage
   108          type: string
   109          description: "For `buildTool: docker`: Defines the docker image which should be scanned."
   110          resourceRef:
   111            - name: commonPipelineEnvironment
   112              param: container/imageNameTag
   113          scope:
   114            - PARAMETERS
   115            - STAGES
   116            - STEPS
   117        - name: scanImageRegistryUrl
   118          type: string
   119          description: "For `buildTool: docker`: Defines the registry where the scanImage is located."
   120          resourceRef:
   121            - name: commonPipelineEnvironment
   122              param: container/registryUrl
   123          scope:
   124            - PARAMETERS
   125            - STAGES
   126            - STEPS
   127        - name: scanFile
   128          aliases:
   129            - name: file
   130              deprecated: true
   131          type: string
   132          description: "The file which is scanned for malware"
   133          scope:
   134            - PARAMETERS
   135            - STAGES
   136            - STEPS
   137        - name: timeout
   138          type: string
   139          description: "timeout for http layer in seconds"
   140          scope:
   141            - PARAMETERS
   142            - STAGES
   143            - STEPS
   144          mandatory: false
   145          default: 600
   146        - name: reportFileName
   147          type: string
   148          description: The file name of the report to be created
   149          scope:
   150            - PARAMETERS
   151            - STAGES
   152            - STEPS
   153          default: malwarescan_report.json
   154    outputs:
   155      resources:
   156        - name: reports
   157          type: reports
   158          params:
   159            - filePattern: "**/toolrun_malwarescan_*.json"
   160              type: malwarescan
   161            - paramRef: reportFileName
   162              type: malwarescan