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
Tink
archived
What is this?Tink is an open source cryptographic library whose APIs are designed to be secure, easy to use correctly, and hard to misuse. It was built by cryptographers and security engineers at Google.
Is this a library I link into my app, or a tool I run on its own?It's a library: you add it to your application and call its cryptographic APIs from your own code. The same API design is implemented natively in several languages, and it works across platforms.
How do I get started with it?Read the project's docs site — it walks through common usage scenarios, currently for Java and Python. Each language also has its own HOW-TO, and the repo's examples folder shows simple tasks in a variety of languages.
Which programming languages can I use it from?Java/Android, C++, Objective-C, Go, and Python are field tested and ready for production. JavaScript/TypeScript is alpha and test-only, and community ports like Clojure are explicitly not maintained by the team.
Is this GitHub repo the one I should be using?No — Tink was split into multiple repositories under the github.com/tink-crypto organization. This original repo is read-only and will not be maintained going forward, so grab the language you need from tink-crypto.
Is it actually used in production, or still experimental?It's battle-tested: at Google, Tink is one of the standard crypto libraries and has been deployed in hundreds of products and systems.
Why did Google build a new crypto library instead of using existing ones?It grew out of the team's experience fixing crypto weaknesses in Google's product teams. The goal was simple APIs that can be used safely without a crypto background, with common pitfalls reduced by user-centered design, careful implementation, code reviews, and extensive testing.
Does it help with key management, or do I wire that myself?Key management is a first-class part of the project: the docs cover it separately, and there's a companion tool called 'Tinkey' specifically for managing keys.
What's the newest release here?In this repository it's version 1.7.0, released on 2022-08-09. Since the project split into per-language repos under github.com/tink-crypto, check there for anything newer.
What are similar projects?RestKit, libsodium, grpc, jjwt, matrix, fmdb, wcdb, CryptoSwift
Which topics is it in?crypto, objective-c, cryptography, google, encryption, cpp, sdk, developers, java, mobile, ios, go
Creator
tink-crypto
Size
59.6 MB
Stars
13.5K
Updated
CommitApr 17Releasev1.7.0Aug 10
Age
12y
Commits · 90 Days