tink README

The project's README from github.com/tink-crypto/tink. As one markdown file: README.md.

Tink

NOTE: Tink moved to github.com/tink-crypto and this repo is no longer active!

As planned, we have split Tink into multiple GitHub repositories that are hosted at github.com/tink-crypto. As a consequence, we made this repository read-only and it is not going to be maintained moving forward.

A multi-language, cross-platform library that provides cryptographic APIs that are secure, easy to use correctly, and hard(er) to misuse. See also: https://developers.google.com/tink.

Index

  1. Introduction
  2. Current status
  3. Getting started
  4. Learn more
  5. Contact and mailing list
  6. Maintainers

Introduction

Using crypto in your application shouldn't have to feel like juggling chainsaws in the dark. Tink is a crypto library written by a group of cryptographers and security engineers at Google. It was born out of our extensive experience working with Google's product teams, fixing weaknesses in implementations, and providing simple APIs that can be used safely without needing a crypto background.

Tink provides secure APIs that are easy to use correctly and hard(er) to misuse. It reduces common crypto pitfalls with user-centered design, careful implementation and code reviews, and extensive testing. At Google, Tink is one of the standard crypto libraries, and has been deployed in hundreds of products and systems.

To get a quick overview of Tink design please take a look at slides from a talk about Tink presented at Real World Crypto 2019.

Current status

Java/Android, C++, Obj-C, Go, and Python are field tested and ready for production. The latest version is 1.7.0, released on 2022-08-09.

Javascript/Typescript is in an alpha state and should only be used for testing. Please see the intent to remove statement here.

Ubuntu macOS
Kokoro Ubuntu Kokoro macOS

Getting started

Documentation for the project is located at https://developers.google.com/tink. Currently, it details a variety of common usage scenarios and covers the Java and Python implementations. The site will be populated with more content over time.

Alternatively, you can look at all of the examples which demonstrate performing simple tasks using Tink in a variety of languages.

pip3 install tink
go get github.com/google/tink/go/...
<dependency>
  <groupId>com.google.crypto.tink</groupId>
  <artifactId>tink</artifactId>
  <version>1.7.0</version>
</dependency>
dependencies {
  implementation 'com.google.crypto.tink:tink-android:1.7.0'
}
cd /path/to/your/Xcode project/
pod init
pod 'Tink', '1.7.0'
pod install

Learn more

Community-driven ports

Out of the box Tink supports a wide range of languages, but it still doesn't support every language. Fortunately, some users like Tink so much that they've ported it to their favorite languages! Below you can find notable ports.

WARNING While we usually review these ports, until further notice, we do not maintain them and have no plan to support them in the foreseeable future.

Contact and mailing list

If you want to contribute, please read CONTRIBUTING and send us pull requests. You can also report bugs or file feature requests.

If you'd like to talk to the developers or get notified about major product updates, you may want to subscribe to our mailing list.

Maintainers

Tink is maintained by (A-Z):

Alumni:

tink (tink-crypto/tink)

Searching Database…

13.5K ·GitHub
archived
Что это такое?Tink — это криптографическая библиотека с открытым исходным кодом, чьи API спроектированы так, чтобы быть безопасными, простыми в правильном использовании и сложными в неправильном. Её создали криптографы и инженеры по безопасности в Google.
Это библиотека, которую я подключаю к своему приложению, или отдельный инструмент?Это библиотека: вы добавляете её в своё приложение и вызываете её криптографические API из собственного кода. Один и тот же дизайн API реализован нативно на нескольких языках и работает на разных платформах.
С чего мне начать?Прочитайте сайт документации проекта — там разобраны типичные сценарии использования, пока для Java и Python. У каждого языка есть свой HOW-TO, а в папке examples в репозитории показаны простые задачи на разных языках.
Из каких языков программирования я могу её использовать?Java/Android, C++, Objective-C, Go и Python проверены в бою и готовы для продакшена. JavaScript/TypeScript находится в статусе alpha и годится только для тестов, а сторонние порты вроде Clojure команда открыто не поддерживает.
Этот репозиторий на GitHub — тот самый, который мне нужен?Нет — Tink разделена на несколько репозиториев в организации github.com/tink-crypto. Этот исходный репозиторий доступен только для чтения и больше не будет поддерживаться, так что берите нужный язык из tink-crypto.
Её реально используют в продакшене или это пока эксперимент?Библиотека проверена в бою: в Google Tink — одна из стандартных криптографических библиотек, она развёрнута в сотнях продуктов и систем.
Почему Google создала новую криптографическую библиотеку вместо использования существующих?Она выросла из опыта команды по исправлению слабых мест в криптографии продуктовых команд Google. Целью были простые API, которыми можно безопасно пользоваться без подготовки в криптографии, а типичные ошибки сведены к минимуму за счёт дизайна, ориентированного на пользователя, аккуратной реализации, код-ревью и обширного тестирования.
Она помогает с управлением ключами, или мне придётся настраивать это самому?Управление ключами — полноценная часть проекта: в документации ему посвящён отдельный раздел, а специально для работы с ключами есть сопутствующий инструмент под названием 'Tinkey'.
Какой здесь самый свежий релиз?В этом репозитории это версия 1.7.0, выпущенная 2022-08-09. Поскольку проект разделился на репозитории по языкам в github.com/tink-crypto, более свежие версии ищите там.
What are similar projects?RestKit, libsodium, grpc, jjwt, matrix, fmdb, wcdb, CryptoSwift
Size
59.6 MB
Stars
13.5K
Age
12y
Commits · 90 Days