Google Git
Sign in
fuchsia / third_party / tink / refs/tags/v1.1.1
tage1aea445e879ae276430e366fa60def31069f989
taggerTink Team <noreply@google.com>Fri May 25 15:30:25 2018 -0700
object068112c13712e04ca035d7232873ca0a3e60d0a6 
Tink version 1.1.1
commit068112c13712e04ca035d7232873ca0a3e60d0a6[log] [tgz]
authorCharles Lee <ckl@google.com>Fri May 25 09:32:23 2018 -0700
committerCharley Lee <ckl@google.com>Fri May 25 15:28:42 2018 -0700
treef5ae5d59d6d99dbcc41a1077e7427092baa9bc9a
parentd8691d3e81d3dbd6a4402eb2cabc807aa297fe24 [diff]
Additional documentation cleanup.

PiperOrigin-RevId: 198059513
GitOrigin-RevId: b0d86b91c0a596d6e87d36bdc1e1876b77a23b7f
4 files changed
tree: f5ae5d59d6d99dbcc41a1077e7427092baa9bc9a
  1. apps/
  2. cc/
  3. docs/
  4. examples/
  5. go/
  6. java/
  7. kokoro/
  8. maven/
  9. objc/
  10. proto/
  11. testdata/
  12. third_party/
  13. tools/
  14. .gitignore
  15. BUILD.bazel
  16. LICENSE
  17. README.md
  18. WORKSPACE
README.md

Tink

UbuntumacOS
Kokoro UbuntuKokoro macOS

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. It reduces common crypto pitfalls with user-centered design, careful implementation and code reviews, and extensive testing. You can add features like encryption, decryption and signing to your application with Tink - the same library AdMob, Google Pay, the Android Search App and several Google products also use to secure their applications.

Getting started

TIP The easiest way to get started with Tink is to install Bazel, then build, run and play with the hello world examples.

Tink performs cryptographic tasks via so-called primitives, each of which is defined via a corresponding interface that specifies the functionality of the primitive. For example, symmetric key encryption is offered via an AEAD-primitive (Authenticated Encryption with Associated Data), that supports two operations:

  • encrypt(plaintext, associated_data), which encrypts the given plaintext (using associated_data as additional AEAD-input) and returns the resulting ciphertext
  • decrypt(ciphertext, associated_data), which decrypts the given ciphertext (using associated_data as additional AEAD-input) and returns the resulting plaintext

Before implementations of primitives can be used, they must be registered at runtime with Tink, so that Tink “knows” the desired implementations. Here's how you can register all implementations of all primitives in Tink for Java 1.1.0:

    import com.google.crypto.tink.Config;
    import com.google.crypto.tink.config.TinkConfig;

    Config.register(TinkConfig.TINK_1_1_0);

After implementations of primitives have been registered, the basic use of Tink proceeds in three steps:

  1. Load or generate the cryptographic key material (a Keyset in Tink terms).
  2. Use the key material to get an instance of the chosen primitive.
  3. Use that primitive to accomplish the cryptographic task.

Here is how these steps would look like when encrypting or decrypting with an AEAD primitive in Java:

    import com.google.crypto.tink.Aead;
    import com.google.crypto.tink.KeysetHandle;
    import com.google.crypto.tink.aead.AeadFactory;
    import com.google.crypto.tink.aead.AeadKeyTemplates;

    // 1. Generate the key material.
    KeysetHandle keysetHandle = KeysetHandle.generateNew(
        AeadKeyTemplates.AES128_GCM);

    // 2. Get the primitive.
    Aead aead = AeadFactory.getPrimitive(keysetHandle);

    // 3. Use the primitive.
    byte[] ciphertext = aead.encrypt(plaintext, aad);

Current Status

Learn More

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 new tests, you may want to subscribe to our mailing list. To join, simply send an empty email to tink-users+subscribe@googlegroups.com.

Maintainers

Tink is maintained by:

  • Daniel Bleichenbacher
  • Thai Duong
  • Quan Nguyen
  • Bartosz Przydatek