tencentcloud-sdk-nodejs 4.0.319 → 4.0.320

package/src/services/bsca/v20210811/bsca_client.ts

@@ -0,0 +1,93 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { AbstractClient } from "../../../common/abstract_client"
+import { ClientConfig } from "../../../common/interface"
+import {
+  DescribeKBComponentVulnerabilityRequest,
+  ComponentVulnerabilityUnion,
+  LicenseUnion,
+  DescribeKBComponentVulnerabilityResponse,
+  LicenseSummary,
+  Qualifier,
+  CVSSV3Info,
+  Component,
+  DescribeKBVulnerabilityResponse,
+  DescribeKBLicenseResponse,
+  VulnerabilityUnion,
+  LicenseDetail,
+  DescribeKBVulnerabilityRequest,
+  VulnerabilityDetail,
+  DescribeKBComponentResponse,
+  VulnerabilitySummary,
+  DescribeKBLicenseRequest,
+  CVSSV2Info,
+  DescribeKBComponentRequest,
+  LicenseRestriction,
+  ComponentVulnerabilitySummary,
+  PURL,
+} from "./bsca_models"
+
+/**
+ * bsca client
+ * @class
+ */
+export class Client extends AbstractClient {
+  constructor(clientConfig: ClientConfig) {
+    super("bsca.tencentcloudapi.com", "2021-08-11", clientConfig)
+  }
+
+  /**
+   * 本接口(DescribeKBComponentVulnerability)用于在知识库中查询开源组件的漏洞信息。
+   */
+  async DescribeKBComponentVulnerability(
+    req: DescribeKBComponentVulnerabilityRequest,
+    cb?: (error: string, rep: DescribeKBComponentVulnerabilityResponse) => void
+  ): Promise<DescribeKBComponentVulnerabilityResponse> {
+    return this.request("DescribeKBComponentVulnerability", req, cb)
+  }
+
+  /**
+   * 本接口(DescribeKBComponent)用于在知识库中查询开源组件信息。本接口根据用户输入的PURL在知识库中寻找对应的开源组件，其中Name为必填字段。
+   */
+  async DescribeKBComponent(
+    req: DescribeKBComponentRequest,
+    cb?: (error: string, rep: DescribeKBComponentResponse) => void
+  ): Promise<DescribeKBComponentResponse> {
+    return this.request("DescribeKBComponent", req, cb)
+  }
+
+  /**
+   * 本接口(DescribeKBLicense)用于在知识库中查询许可证信息。
+   */
+  async DescribeKBLicense(
+    req: DescribeKBLicenseRequest,
+    cb?: (error: string, rep: DescribeKBLicenseResponse) => void
+  ): Promise<DescribeKBLicenseResponse> {
+    return this.request("DescribeKBLicense", req, cb)
+  }
+
+  /**
+   * 本接口(DescribeKBVulnerability)用于在知识库中查询漏洞详细信息，支持根据CVE ID查询或者根据Vul ID查询。
+   */
+  async DescribeKBVulnerability(
+    req: DescribeKBVulnerabilityRequest,
+    cb?: (error: string, rep: DescribeKBVulnerabilityResponse) => void
+  ): Promise<DescribeKBVulnerabilityResponse> {
+    return this.request("DescribeKBVulnerability", req, cb)
+  }
+}

package/src/services/bsca/v20210811/bsca_models.ts

@@ -0,0 +1,636 @@
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * DescribeKBComponentVulnerability请求参数结构体
+ */
+export interface DescribeKBComponentVulnerabilityRequest {
+  /**
+   * 组件的PURL，其中Name和Version为必填字段
+   */
+  PURL: PURL
+}
+
+/**
+ * 描述组件漏洞相关概览信息。
+ */
+export interface ComponentVulnerabilityUnion {
+  /**
+   * 漏洞概览信息
+   */
+  Summary: VulnerabilitySummary
+
+  /**
+   * 与组件相关的漏洞概览信息
+   */
+  SummaryInComponent: ComponentVulnerabilitySummary
+}
+
+/**
+ * 许可证详细信息。
+ */
+export interface LicenseUnion {
+  /**
+   * 许可证概览信息
+   */
+  LicenseSummary: LicenseSummary
+
+  /**
+   * 许可证详细信息
+   */
+  LicenseDetail: LicenseDetail
+}
+
+/**
+ * DescribeKBComponentVulnerability返回参数结构体
+ */
+export interface DescribeKBComponentVulnerabilityResponse {
+  /**
+      * 漏洞信息列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  VulnerabilityList: Array<ComponentVulnerabilityUnion>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 描述许可证的概览信息。
+ */
+export interface LicenseSummary {
+  /**
+   * 许可证标识符
+   */
+  Key: string
+
+  /**
+   * 许可证的SPDX标识符，见 https://spdx.org/licenses/
+   */
+  SPDXKey: string
+
+  /**
+   * 许可证短名称
+   */
+  ShortName: string
+
+  /**
+   * 许可证完整名称
+   */
+  Name: string
+
+  /**
+      * License风险等级
+<li>NotDefined</li>
+<li>LowRisk</li>
+<li>MediumRisk</li>
+<li>HighRisk</li>
+      */
+  Risk: string
+
+  /**
+   * 许可证来源URL
+   */
+  Source: string
+}
+
+/**
+ * PURL下的Qualifier属性类型，用于定义第三方组件的额外属性，见 https://github.com/package-url/purl-spec。
+ */
+export interface Qualifier {
+  /**
+   * 额外属性的名称。
+   */
+  Key: string
+
+  /**
+   * 额外属性的值。
+   */
+  Value: string
+}
+
+/**
+ * Cvssv3.0详细信息。
+ */
+export interface CVSSV3Info {
+  /**
+   * CVE评分。
+   */
+  CVSS: number
+
+  /**
+      * AttackVector 攻击途径。
+取值范围：
+<li>NETWORK 远程</li>
+<li>ADJACENT_NETWORK 近邻</li>
+<li>LOCAL 本地</li>
+<li>PHYSICAL 物理</li>
+      */
+  AttackVector: string
+
+  /**
+      * AttackComplexity 攻击复杂度。
+取值范围：
+<li>HIGH 高</li>
+<li>LOW 低</li>
+      */
+  AttackComplexity: string
+
+  /**
+      * PrivilegesRequired 触发特权。
+取值范围：
+<li>HIGH 高</li>
+<li>LOW 低</li>
+<li>NONE 无</li>
+      */
+  PrivilegesRequired: string
+
+  /**
+      * UserInteraction 交互必要性。
+取值范围：
+<li>NONE 无</li>
+<li>REQUIRED 需要</li>
+      */
+  UserInteraction: string
+
+  /**
+      * Scope 绕过安全边界。
+取值范围：
+<li>UNCHANGED 否</li>
+<li>CHANGED 能</li>
+      */
+  Scope: string
+
+  /**
+      * ConfidentialityImpact 机密性影响。
+取值范围：
+<li>NONE 无</li>
+<li>LOW 低</li>
+<li>HIGH 高</li>
+      */
+  ConImpact: string
+
+  /**
+      * IntegrityImpact 完整性影响。
+取值范围：
+<li>NONE 无</li>
+<li>LOW 低</li>
+<li>HIGH 高</li>
+      */
+  IntegrityImpact: string
+
+  /**
+      * AvailabilityImpact 可用性影响。
+取值范围：
+<li>NONE 无</li>
+<li>LOW 低</li>
+<li>HIGH 高</li>
+      */
+  AvailabilityImpact: string
+}
+
+/**
+ * 描述一个第三方组件的源信息。
+ */
+export interface Component {
+  /**
+   * 第三方组件的PURL
+   */
+  PURL: PURL
+
+  /**
+   * 第三方组件的主页
+   */
+  Homepage: string
+
+  /**
+   * 第三方组件的简介
+   */
+  Summary: string
+
+  /**
+      * 第三方组件的别名列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  NicknameList: Array<string>
+
+  /**
+      * 第三方组件的代码位置列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CodeLocationList: Array<string>
+
+  /**
+   * 第三方组件的许可证表达式
+   */
+  LicenseExpression: string
+}
+
+/**
+ * DescribeKBVulnerability返回参数结构体
+ */
+export interface DescribeKBVulnerabilityResponse {
+  /**
+      * 漏洞详细信息列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  VulnerabilityDetailList: Array<VulnerabilityUnion>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DescribeKBLicense返回参数结构体
+ */
+export interface DescribeKBLicenseResponse {
+  /**
+      * 许可证列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  LicenseList: Array<LicenseUnion>
+
+  /**
+   * 用于匹配的License表达式
+   */
+  NormalizedLicenseExpression: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 描述漏洞的详细信息。
+ */
+export interface VulnerabilityUnion {
+  /**
+   * 漏洞概览信息
+   */
+  Summary: VulnerabilitySummary
+
+  /**
+   * 漏洞详细信息
+   */
+  Detail: VulnerabilityDetail
+}
+
+/**
+ * 描述许可证的详细信息。
+ */
+export interface LicenseDetail {
+  /**
+   * 许可证内容
+   */
+  Content: string
+
+  /**
+   * 许可证允许信息列表
+   */
+  ConditionSet: Array<LicenseRestriction>
+
+  /**
+   * 许可证要求信息列表
+   */
+  ForbiddenSet: Array<LicenseRestriction>
+
+  /**
+   * 许可证禁止信息列表
+   */
+  PermissionSet: Array<LicenseRestriction>
+}
+
+/**
+ * DescribeKBVulnerability请求参数结构体
+ */
+export interface DescribeKBVulnerabilityRequest {
+  /**
+   * CVE ID列表（不能与Vul ID同时存在）
+   */
+  CVEID?: Array<string>
+
+  /**
+   * Vul ID列表（不能与CVE ID 同时存在）
+   */
+  VulID?: Array<string>
+}
+
+/**
+ * 描述漏洞详细信息。
+ */
+export interface VulnerabilityDetail {
+  /**
+   * 漏洞类别
+   */
+  Category: string
+
+  /**
+   * 漏洞分类
+   */
+  CategoryType: string
+
+  /**
+   * 漏洞描述
+   */
+  Description: string
+
+  /**
+   * 漏洞官方解决方案
+   */
+  OfficialSolution: string
+
+  /**
+   * 漏洞信息参考列表
+   */
+  ReferenceList: Array<string>
+
+  /**
+   * 漏洞防御方案
+   */
+  DefenseSolution: string
+
+  /**
+      * 漏洞CVSSv2信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CVSSv2Info: CVSSV2Info
+
+  /**
+      * 漏洞CVSSv3信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CVSSv3Info: CVSSV3Info
+
+  /**
+   * 漏洞提交时间
+   */
+  SubmitTime: string
+
+  /**
+   * CWE编号
+   */
+  CWEID: string
+
+  /**
+   * 漏洞CVSSv2向量
+   */
+  CVSSv2Vector: string
+
+  /**
+   * 漏洞CVSSv3向量
+   */
+  CVSSv3Vector: string
+}
+
+/**
+ * DescribeKBComponent返回参数结构体
+ */
+export interface DescribeKBComponentResponse {
+  /**
+   * 匹配的组件信息
+   */
+  Component: Component
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 描述漏洞的摘要信息。
+ */
+export interface VulnerabilitySummary {
+  /**
+   * 漏洞ID
+   */
+  VulID: string
+
+  /**
+   * 漏洞所属CVE编号
+   */
+  CVEID: string
+
+  /**
+   * 漏洞所属CNVD编号
+   */
+  CNVDID: string
+
+  /**
+   * 漏洞所属CNNVD编号
+   */
+  CNNVDID: string
+
+  /**
+   * 漏洞名称
+   */
+  Name: string
+
+  /**
+   * 该漏洞是否是需重点关注的漏洞
+   */
+  IsSuggest: boolean
+
+  /**
+      * 漏洞风险等级
+<li>Critical</li>
+<li>High</li>
+<li>Medium</li>
+<li>Low</li>
+      */
+  Severity: string
+}
+
+/**
+ * DescribeKBLicense请求参数结构体
+ */
+export interface DescribeKBLicenseRequest {
+  /**
+   * License表达式
+   */
+  LicenseExpression?: string
+}
+
+/**
+ * CVSSv2.0详细信息。
+ */
+export interface CVSSV2Info {
+  /**
+   * CVE评分。
+   */
+  CVSS: number
+
+  /**
+      * AccessVector 攻击途径。
+取值范围：
+<li>NETWORK 远程</li>
+<li>ADJACENT_NETWORK 近邻</li>
+<li>LOCAL 本地</li>
+      */
+  AccessVector: string
+
+  /**
+      * AccessComplexity 攻击复杂度。
+取值范围：
+<li>HIGH 高</li>
+<li>MEDIUM 中</li>
+<li>LOW 低</li>
+      */
+  AccessComplexity: string
+
+  /**
+      * Authentication 身份验证。
+取值范围：
+<li>MULTIPLE 多系统认证</li>
+<li>SINGLE 单系统认证</li>
+<li>NONE 无</li>
+      */
+  Authentication: string
+
+  /**
+      * ConfidentialityImpact 机密性影响。
+取值范围：
+<li>NONE 无</li>
+<li>PARTIAL 部分</li>
+<li>COMPLETE 完整</li>
+      */
+  ConImpact: string
+
+  /**
+      * IntegrityImpact 完整性影响。
+取值范围：
+<li>NONE 无</li>
+<li>PARTIAL 部分</li>
+<li>COMPLETE 完整</li>
+      */
+  IntegrityImpact: string
+
+  /**
+      * AvailabilityImpact 可用性影响。
+取值范围：
+<li>NONE 无</li>
+<li>PARTIAL 部分</li>
+<li>COMPLETE 完整</li>
+      */
+  AvailabilityImpact: string
+}
+
+/**
+ * DescribeKBComponent请求参数结构体
+ */
+export interface DescribeKBComponentRequest {
+  /**
+   * 组件的PURL
+   */
+  PURL: PURL
+}
+
+/**
+ * License约束信息。
+ */
+export interface LicenseRestriction {
+  /**
+   * license约束的名称。
+   */
+  Name: string
+
+  /**
+   * license约束的描述。
+   */
+  Description: string
+}
+
+/**
+ * 与输入组件相关的漏洞信息摘要信息。
+ */
+export interface ComponentVulnerabilitySummary {
+  /**
+      * 用于匹配漏洞的PURL
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  PURL: PURL
+
+  /**
+   * 该组件是否包含修复漏洞的官方补丁
+   */
+  CanBeFixed: boolean
+
+  /**
+   * 修复漏洞的组件版本号
+   */
+  FixedVersion: string
+
+  /**
+   * 漏洞影响的组件版本号
+   */
+  AffectedVersion: string
+
+  /**
+   * 漏洞影响组件
+   */
+  AffectedComponent: string
+
+  /**
+      * 漏洞在该产品中的风险等级
+<li>Critical</li>
+<li>High</li>
+<li>Medium</li>
+<li>Low</li>
+      */
+  RiskLevel: string
+}
+
+/**
+ * PURL(Package URL)用于定位一个产品或组件，见 https://github.com/package-url/purl-spec。
+ */
+export interface PURL {
+  /**
+   * 组件名称
+   */
+  Name: string
+
+  /**
+   * 组件所属的类型，如：github, gitlab, generic, deb, rpm, maven 等
+   */
+  Protocol?: string
+
+  /**
+   * 组件名的前缀名，如github和gitlab的用户名，deb的操作系统，maven包的group id等
+   */
+  Namespace?: string
+
+  /**
+      * 修饰组件的额外属性
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Qualifiers?: Array<Qualifier>
+
+  /**
+   * 相对于组件包根位置的子目录
+   */
+  Subpath?: string
+
+  /**
+   * 组件版本号
+   */
+  Version?: string
+}

package/src/services/bsca/v20210811/index.ts

@@ -0,0 +1,6 @@
+import * as Models from "./bsca_models"
+import { Client } from "./bsca_client"
+export const v20210811 = {
+  Client: Client,
+  Models: Models,
+}