Tink 设置

您可以从源代码构建 Tink，也可以使用特定于语言的软件包。请按照以下说明开始操作。

安装并设置完 Tink 后，请继续执行本页面末尾的后续步骤。

C++

Tink 提供以下 C++ 库：

Tink C++ (tink-cc)

Tink C++ 依赖于：

Tink C++ 支持：

  • C++ >= 14
  • 操作系统：
    • UbuntuLTS >= 20.04 (x86_64)
    • macOS 12.5 Monterey（x86_64）及更高版本
    • Windows Server 2019 或更高版本 (x86_64)
  • 编译器：
    • GCC >= 7.5.0
    • Apple Clang 14 或更高版本
    • MSVC >= 2019
  • 构建系统：

CMake

您应将 tink-cc 添加为树内依赖项。例如：

cmake_minimum_required(VERSION 3.13)
project(YourProject CXX)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_STANDARD 14)
include(FetchContent)

# Import Tink as an in-tree dependency.
FetchContent_Declare(
  tink
  URL       https://github.com/tink-crypto/tink-cc/archive/refs/tags/v2.3.0.zip
  URL_HASH  SHA256=363ce671ab5ce0b24f279d3647185597a25f407c3608db007315f79f151f436b
)
FetchContent_GetProperties(tink)
if(NOT googletest_POPULATED)
  FetchContent_Populate(tink)
    add_subdirectory(${tink_SOURCE_DIR} ${tink_BINARY_DIR} EXCLUDE_FROM_ALL)
endif()

add_executable(your_app your_app.cc)
target_link_libraries(your_app tink::static)

Bazel

Bzlmod

如果您使用的是将 Bazel 与模块搭配使用，请在 MODULE.bazel 文件中添加以下代码：

bazel_dep(name = "tink_cc", version = "2.3.0")

工作区

如果您将 Bazel 与 WORKSPACE 文件搭配使用，请在 WORKSPACE 文件中添加以下代码：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "tink_cc",
    urls = ["https://github.com/tink-crypto/tink-cc/archive/refs/tags/v2.3.0.zip"],
    strip_prefix = "tink-2.3.0",
    sha256 = "363ce671ab5ce0b24f279d3647185597a25f407c3608db007315f79f151f436b",
)

load("@tink_cc//:tink_cc_deps.bzl", "tink_cc_deps")

tink_cc_deps()

load("@tink_cc//:tink_cc_deps_init.bzl", "tink_cc_deps_init")

tink_cc_deps_init()

Tink C++ AWS KMS 扩展 (tink-cc-awskms)

Tink C++ Google Cloud KMS 依赖于：

Tink C++ AWS KMS 支持：

  • C++ >= 14
  • 操作系统：
    • UbuntuLTS >= 20.04 (x86_64)
    • macOS 12.5 Monterey（x86_64）及更高版本
  • 编译器：
    • GCC >= 7.5.0
    • Apple Clang 14 或更高版本
  • 构建系统：

Bazel

您应将以下代码添加到项目的 WORKSPACE 文件中：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "tink_cc",
    urls = ["https://github.com/tink-crypto/tink-cc/archive/refs/tags/v2.3.0.zip"],
    strip_prefix = "tink-2.3.0",
    sha256 = "363ce671ab5ce0b24f279d3647185597a25f407c3608db007315f79f151f436b",
)

load("@tink_cc//:tink_cc_deps.bzl", "tink_cc_deps")

tink_cc_deps()

load("@tink_cc//:tink_cc_deps_init.bzl", "tink_cc_deps_init")

tink_cc_deps_init()

http_archive(
    name = "tink_cc_awskms",
    urls = ["https://github.com/tink-crypto/tink-cc-awskms/archive/refs/tags/v2.0.1.zip"],
    strip_prefix = "tink-cc-awskms-2.0.1",
    sha256 = "366319b269f62af120ee312ce4c99ce3738ceb23ce3f9491b4859432f8b991a4",
)

load("@tink_cc_awskms//:tink_cc_awskms_deps.bzl", "tink_cc_awskms_deps")

tink_cc_awskms_deps()

Tink C++ Google Cloud KMS 扩展 (tink-cc-gcpkms)

Tink C++ Google Cloud KMS 依赖于：

Tink C++ Google Cloud KMS 支持：

  • C++ >= 14
  • 操作系统：
    • UbuntuLTS >= 20.04 (x86_64)
    • macOS 12.5 Monterey（x86_64）及更高版本
  • 编译器：
    • GCC >= 7.5.0
    • Apple Clang 14 或更高版本
  • 构建系统：

Bazel

您应将以下代码添加到项目的 WORKSPACE 文件中：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "tink_cc_gcpkms",
    urls = ["https://github.com/tink-crypto/tink-cc-gcpkms/releases/download/v2.3.0/tink-cc-gcpkms-2.3.0.zip"],
    strip_prefix = "tink-cc-gcpkms-2.3.0",
    sha256 = "5af0d0a502afc346bbaa40f226e8f3b28fe3f5def696cbaaa7bc13702af78901",
)

load("@tink_cc_gcpkms//:tink_cc_gcpkms_deps.bzl", "tink_cc_gcpkms_deps")

tink_cc_gcpkms_deps()

load("@tink_cc_gcpkms//:tink_cc_gcpkms_deps_init.bzl", "tink_cc_gcpkms_deps_init")

tink_cc_gcpkms_deps_init(register_go = True)

Go

Tink 提供以下 Go 库：

所有 Tink Go 库都发布为 Go 模块，可与标准 Go 工具或 Bazel 搭配使用。

Tink Go (tink-go)

Go 工具

从项目目录运行以下命令：

go get github.com/tink-crypto/tink-go/v2@v2.2.0

请参阅官方 Go 文档。

Tink Go AWS KMS 扩展程序 (tink-go-awskms)

Go 工具

从项目目录运行以下命令：

go get github.com/tink-crypto/tink-go-awskms/v2@2.1.0

请参阅官方 Go 文档。

Tink Go Google Cloud KMS 扩展程序 (tink-go-gcpkms)

Go 工具

从项目目录运行以下命令：

go get github.com/tink-crypto/tink-go-gcpkms/v2@v2.2.0

请参阅官方 Go 文档。

Tink Go HashiCorp Vault 扩展程序 (tink-go-hcvault)

Go 工具

从项目目录运行以下命令：

go get github.com/tink-crypto/tink-go-hcvault/v2@v2.2.0

请参阅官方 Go 文档。

Java

设置 Tink Java 和扩展程序

ObjC

请参阅 GitHub 上的操作方法

Python

Tink Python 库 tink-py 支持 macOS (x86-64 和 ARM64)、Linux (x86-64 和 ARM64) 和 Windows (x86-64) 上的 Python 3.8 或更高版本。最新版本为 1.10.0。您可以使用 Pip 在本地安装它，也可以与 Bazel 搭配使用。

Tink Python 支持与 AWS KMS、Google Cloud KMS 和 HashiCorp Vault 集成。

Pip

您可以通过运行以下命令，从 PyPI 为您的系统安装 Tink Python 二进制版本：

pip3 install tink==1.10.0
# Core Tink + Google Cloud KMS extension.
pip3 install tink[gcpkms]==1.10.0
# Core Tink + AWS KMS extension.
pip3 install tink[awskms]==1.10.0
# Core Tink + HashiCorp Vault KMS extension.
pip3 install tink[hcvault]==1.10.0
# Core Tink + all the KMS extensions.
pip3 install tink[all]==1.10.0

如果未针对您的环境发布二进制软件包，pip 会自动改用发布到 PyPI 的源代码分发版来构建项目。如果是这种情况，您需要安装 Bazel 或 Bazelisk 以及 protobuf 编译器，才能成功构建项目。

Bazel

Bazel 用户可以在其 WORKSPACE 文件中添加 Tink Python，如下所示：

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "tink_py",
    urls = ["https://github.com/tink-crypto/tink-py/releases/download/v1.10.0/tink-py-1.10.0.zip"],
    strip_prefix = "tink-py-1.10.0",
    sha256 = "767453aae4aad6de4fbb4162992184aa427b7b27864fe9912c270b24c673e1cc",
)

load("@tink_py//:tink_py_deps.bzl", "tink_py_deps")
tink_py_deps()

load("@rules_python//python:repositories.bzl", "py_repositories")
py_repositories()

load("@tink_py//:tink_py_deps_init.bzl", "tink_py_deps_init")
tink_py_deps_init("tink_py")

后续步骤

完成 Tink 设置后，请继续执行标准的 Tink 使用步骤：

  • 选择基元 - 根据您的用例确定要使用的基元
  • 管理密钥 - 使用外部 KMS 保护密钥、生成密钥集以及轮替密钥