Настройка Тинка

Вы можете собрать Tink из исходного кода или использовать пакеты для конкретного языка. Следующие инструкции помогут вам начать работу.

После завершения установки и настройки Tink перейдите к следующим шагам в конце этой страницы.

С++

Tink предоставляет следующие библиотеки C++:

Тинк C++ (тинк-cc)

Tink C++ зависит от:

Tink C++ поддерживает:

  • С++ >= 14
  • ОС:
    • UbuntuLTS >= 20.04 (x86_64)
    • macOS >= 12,5 Монтерей (x86_64)
    • Windows Server >= 2019 (x86_64)
  • Компилятор:
    • GCC >= 7.5.0
    • Яблочный звон >= 14
    • МСВК >= 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 с модулями, добавьте в файл 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 поддерживает:

  • С++ >= 14
  • ОС:
    • UbuntuLTS >= 20.04 (x86_64)
    • macOS >= 12,5 Монтерей (x86_64)
  • Компилятор:
    • GCC >= 7.5.0
    • Яблочный звон >= 14
  • Система сборки:

Базель

Вы должны добавить следующее в файл 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 поддерживает:

  • С++ >= 14
  • ОС:
    • UbuntuLTS >= 20.04 (x86_64)
    • macOS >= 12,5 Монтерей (x86_64)
  • Компилятор:
    • GCC >= 7.5.0
    • Яблочный звон >= 14
  • Система сборки:

Базель

Вы должны добавить следующее в файл 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.2.0/tink-cc-gcpkms-2.2.0.zip"],
    strip_prefix = "tink-cc-gcpkms-2.2.0",
    sha256 = "ffb9d05c64ca28b5eb54fe79e7c3f93fad68f00e45f74f6b9ce1bd3a32b3d6fd",
)

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)

Идти

Tink предоставляет следующие библиотеки Go:

Все библиотеки Tink Go публикуются в виде модулей Go, которые можно использовать со стандартными инструментами Go или Bazel .

Тинк-гоу (тинк-гоу)

Перейти к оснастке

Запуск следующей команды из каталога вашего проекта:

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

См. официальную документацию Go .

Расширение Tink Go AWS KMS (tink-go-awskms)

Перейти к оснастке

Запустите следующую команду из каталога вашего проекта:

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

См. официальную документацию Go .

Расширение Tink Go Google Cloud KMS (tink-go-gcpkms)

Перейти к оснастке

Запустите следующую команду из каталога вашего проекта:

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

См. официальную документацию Go .

Расширение Tink Go HashiCorp Vault (tink-go-hcvault)

Перейти к оснастке

Запустите следующую команду из каталога вашего проекта:

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

См. официальную документацию Go .

Ява

Tink предоставляет следующие библиотеки Java:

Java-версия Tink поддерживает Java 8 или новее. Вы можете либо включить артефакты Tink Java Maven в свой проект Maven или Gradle , либо использовать Bazel .

Tink Android полностью поддерживается, начиная с уровня API 24. Ожидается, что большинство частей Tink будут работать, начиная с уровня API 21. Части, в которых Tink не работает «из коробки» с уровнем API 21:

  • Для библиотеки JWT требуется уровень API 24, поскольку она использует такие классы, как java.util.Optional . Этого ограничения можно избежать с помощью обессахаривания .
  • Классы в com.google.crypto.tink.integration.android полностью протестированы только начиная с уровня API 23.
  • Некоторые API в com.google.crypto.tink.streamingaead используют SeekableByteBufferChannel , который доступен только с уровня API 24.

Отметим, что по техническим причинам мы тестируем Tink на Android только во внутренней инфраструктуре Google. Мы не ожидаем каких-либо проблем из-за этого, но если у вас возникнут какие-либо проблемы, сообщите о проблеме.

Tink Android не требует настройки proguard.

Тинк Ява (тинк-джава)

Мавен

Вы можете подключить Tink Java и библиотеку Tink Android с помощью Maven :

<dependency>
  <groupId>com.google.crypto.tink</groupId>
  <artifactId>tink</artifactId>
  <version>1.15.0</version>
</dependency>

Если вы ориентируетесь на Android, вы можете использовать tink-android из Gradle, используя: 

dependencies {
  implementation 'com.google.crypto.tink:tink-android:1.15.0'
}

Базель

Рекомендуемый способ, которым пользователи Bazel могут добавить Tink Java в качестве зависимости, — это установить артефакт выпуска Maven с помощью инструмента rules_jvm_external в своем файле WORKSPACE :

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

RULES_JVM_EXTERNAL_TAG = "6.1"
RULES_JVM_EXTERNAL_SHA ="d31e369b854322ca5098ea12c69d7175ded971435e55c18dd9dd5f29cc5249ac"

http_archive(
    name = "rules_jvm_external",
    strip_prefix = "rules_jvm_external-%s" % RULES_JVM_EXTERNAL_TAG,
    sha256 = RULES_JVM_EXTERNAL_SHA,
    url = "https://github.com/bazelbuild/rules_jvm_external/releases/download/%s/rules_jvm_external-%s.tar.gz" % (RULES_JVM_EXTERNAL_TAG, RULES_JVM_EXTERNAL_TAG)
)

load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")

rules_jvm_external_deps()

load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")

rules_jvm_external_setup()

load("@rules_jvm_external//:defs.bzl", "maven_install")

maven_install(
    artifacts = [
        "com.google.crypto.tink:tink:1.15.0",
        # ... other dependencies ...
    ],
    repositories = [
        "https://maven.google.com",
        "https://repo1.maven.org/maven2",
    ],
)

Если вы хотите собрать tink-java из исходного кода, например, чтобы закрепить конкретный коммит, вы можете включить его как http_archive в свой файл WORKSPACE : 

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

TINK_COMMIT="f4127f6b6ab9c367d41ade1f50db6f0ef9909044"
TINK_SHA256="e246f848f7749e37f558955ecb50345b04d79ddb9d8d1e8ae19f61e8de530582"

http_archive(
    name = "tink_java",
    urls = ["https://github.com/tink-crypto/tink-java/archive/%s.zip" % TINK_COMMIT],
    strip_prefix = "tink-%s" % TINK_COMMIT,
    sha256 = TINK_SHA256
)

load("@tink_java//:tink_java_deps.bzl", "TINK_MAVEN_ARTIFACTS", "tink_java_deps")

tink_java_deps()

load("@tink_java//:tink_java_deps_init.bzl", "tink_java_deps_init")

tink_java_deps_init()

# rules_jvm_external is imported and initialized by tink_java_deps and
# tink_java_deps_init.
load("@rules_jvm_external//:defs.bzl", "maven_install")

maven_install(
  artifacts = TINK_MAVEN_ARTIFACTS + # ... other dependencies ...
  repositories = [
      "https://maven.google.com",
      "https://repo1.maven.org/maven2",
  ],
)

Расширение Tink Java AWS KMS (tink-java-awskms)

Мавен

Вы можете подключить Tink Java и библиотеку Tink Android с помощью Maven : 

<dependencies>
  <dependency>
    <groupId>com.google.crypto.tink</groupId>
    <artifactId>tink-awskms</artifactId>
    <version>1.10.1</version>
  </dependency>
</dependencies>

Базель

Вы можете установить артефакт com.google.crypto.tink:tink-awskms Maven вместе с com.google.crypto.tink:tink с помощью инструмента rules_jvm_external .

# ...

maven_install(
    artifacts = [
        "com.google.crypto.tink:tink:1.15.0",
        "com.google.crypto.tink:tink-awskms:1.10.1",
        # ... other dependencies ...
    ],
    repositories = [
        "https://maven.google.com",
        "https://repo1.maven.org/maven2",
    ],
)

Альтернативно вы можете включить его как зависимость http_archive : 

# ...

http_archive(
    name = "tink_java",
    urls = ["https://github.com/tink-crypto/tink-java/releases/download/v1.15.0/tink-java-1.15.0.zip"],
    strip_prefix = "tink-java-1.15.0",
    sha256 = "e246f848f7749e37f558955ecb50345b04d79ddb9d8d1e8ae19f61e8de530582",
)

load("@tink_java//:tink_java_deps.bzl", "TINK_MAVEN_ARTIFACTS", "tink_java_deps")

tink_java_deps()

load("@tink_java//:tink_java_deps_init.bzl", "tink_java_deps_init")

tink_java_deps_init()

http_archive(
    name = "tink_java_awskms",
    urls = ["https://github.com/tink-crypto/tink-java-awskms/releases/download/v1.10.1/tink-java-awskms-1.10.1.zip"],
    strip_prefix = "tink-java-awskms-1.10.1",
    sha256 = "5f08f3a343fb2028784ee2344e102cf4f753b4d23252318b3f8ac48208d3e2fa",
)

load("@tink_java_awskms//:tink_java_awskms_deps.bzl", "TINK_JAVA_AWSKMS_MAVEN_ARTIFACTS")

maven_install(
    artifacts = TINK_MAVEN_ARTIFACTS + TINK_JAVA_AWSKMS_MAVEN_ARTIFACTS + [
        # ... other dependencies ...
    ],
    repositories = [
        "https://maven.google.com",
        "https://repo1.maven.org/maven2",
    ],
)

Расширение Tink Java Google Cloud KMS (tink-java-gcpkms)

Мавен 

<dependencies>
  <dependency>
    <groupId>com.google.crypto.tink</groupId>
    <artifactId>tink-gcpkms</artifactId>
    <version>1.10.0/version>
  </dependency>
</dependencies>

Базель

Вы можете установить артефакт com.google.crypto.tink:tink-gcpkms Maven вместе с com.google.crypto.tink:tink с помощью инструмента rules_jvm_external .

# ...

maven_install(
    artifacts = [
        "com.google.crypto.tink:tink:1.15.0",
        "com.google.crypto.tink:tink-gcpkms:1.10.0",
        # ... other dependencies ...
    ],
    repositories = [
        "https://maven.google.com",
        "https://repo1.maven.org/maven2",
    ],
)

Альтернативно вы можете включить его как зависимость http_archive : 

# ...

http_archive(
    name = "tink_java",
    urls = ["https://github.com/tink-crypto/tink-java/releases/download/v1.15.0/tink-java-1.15.0.zip"],
    strip_prefix = "tink-java-1.15.0",
    sha256 = "e246f848f7749e37f558955ecb50345b04d79ddb9d8d1e8ae19f61e8de530582",
)

load("@tink_java//:tink_java_deps.bzl", "TINK_MAVEN_ARTIFACTS", "tink_java_deps")

tink_java_deps()

load("@tink_java//:tink_java_deps_init.bzl", "tink_java_deps_init")

tink_java_deps_init()

http_archive(
    name = "tink_java_gcpkms",
    urls = ["https://github.com/tink-crypto/tink-java-gcpkms/releases/download/v1.10.0/tink-java-gcpkms-1.10.0.zip"],
    strip_prefix = "tink-java-gcpkms-1.10.0",
    sha256 = "ad85625cc4409f2f6ab13a8eef39c965501585e9323d59652cce322b3d2c09a2",
)

load("@tink_java_gcpkms//:tink_java_gcpkms_deps.bzl", "TINK_JAVA_GCPKMS_MAVEN_ARTIFACTS")

maven_install(
    artifacts =  TINK_MAVEN_ARTIFACTS + TINK_JAVA_GCPKMS_MAVEN_ARTIFACTS + [
        # ... other dependencies ...
    ],
    repositories = [
        "https://maven.google.com",
        "https://repo1.maven.org/maven2",
    ],
)

Расширения Tink Java Apps (tink-java-apps)

Мавен 

<dependency>
  <groupId>com.google.crypto.tink</groupId>
  <artifactId>apps-webpush</artifactId>
  <version>1.11.0</version>
</dependency>

<dependency>
  <groupId>com.google.crypto.tink</groupId>
  <artifactId>apps-paymentmethodtoken</artifactId>
  <version>1.11.0</version>
</dependency>

<dependency>
  <groupId>com.google.crypto.tink</groupId>
  <artifactId>apps-rewardedads</artifactId>
  <version>1.11.0</version>
</dependency>

Базель

Вы можете установить любой из артефактов com.google.crypto.tink:apps-* Maven с помощью инструмента rules_jvm_external . 

# ...

maven_install(
    artifacts = [
        "com.google.crypto.tink:apps-webpush:1.11.0",
        "com.google.crypto.tink:apps-paymentmethodtoken:1.11.0",
        "com.google.crypto.tink:apps-rewardedads:1.11.0",
        # ... other dependencies ...
    ],
    repositories = [
        "https://maven.google.com",
        "https://repo1.maven.org/maven2",
    ],
)

Объект

См . HOWTO на GitHub.

Питон

Библиотека Tink Python, Tink-py поддерживает Python 3.8 или новее в macOS (x86-64 и ARM64), Linux (x86-64 и ARM64) и Windows (x86-64). Последняя версия — 1.10.0 . Его можно установить локально с помощью Pip или использовать с Bazel .

Tink Python обеспечивает интеграцию с AWS KMS , Google Cloud KMS и HashiCorp Vault .

Пип

Вы можете установить двоичную версию Tink Python для своей системы из PyPI , выполнив следующую команду:

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 могут включить Tink Python в свой файл WORKSPACE следующим образом: 

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, создавайте наборы ключей и меняйте ключи.