Code Monkey home page Code Monkey logo

kinto-signer's Introduction

Kinto signer

travis

What does this do?

Kinto signer is a Kinto plugin that makes it possible to sign the updates of Kinto collections. In other words, it's a way to verify that the data the client has got is the data the original authors intended to distribute.

This works with two Kinto instances:

  • A, the authority (also known as "the signer"). It is where the original data are sent. The authority is configured to sign the data for a specific "origin".
  • O, the origin, which will end up distributing the data and the signatures. It is where the client retrieve the data.

schema.png

Triggering a signature on the authority

Once started, the authority is behaving like a normal Kinto server, until you ask for a signature of the collection. To trigger this signature operation, you need to add a specific field on the collection: status: "to-sign".

Here is how to do it with httpie:

echo '{"data": {"status": "to-sign"}}' | http PATCH http://0.0.0.0:8888/v1/buckets/default/collections/tasks --auth user:pass

From there, the authority will:

  1. Retrieve all records on the collection, compute a hash of the records, and generate a signature out of it.
  2. Send all local changes to the Origin server, with a signature.
  3. Update the collection metadata with status:signed.

Configuring kinto-signer

To install this plugin in a Kinto server, a few configuration variables need to be set.

Here is an example of what a configuration could look like:

kinto.includes = kinto_signer

kinto.signer.resources =
    source/collection1;destination/collection1
    source/collection2;destination/collection2
Setting name What does it do?
kinto.signer.resources The name of the buckets and collections on which signatures can be triggered and the destination where the data and the signatures will end-up.
kinto.signer.signer_backend The python dotted location to the signer to use. By default, a local ECDSA signer will be used. Choices are either kinto_signer.signer.local_ecdsa or kinto_signer.signer.autograph Have a look at the sections below for more information.

Configuration for the (default) ECDSA local signer

Setting name What does it do?
kinto.signer.ecdsa.private_key Absolute path to the ECDSA private key to use to apply the signatures
kinto.signer.ecdsa.public_key Absolute path to the ECDSA private key to use to verify the signature (useful if you just want to use the signer as a verifier)

Configuration for the Autograph signer

Kinto signer can integrate with the Autograph server. To do so, use the following settings:

Setting name What does it do?
kinto.signer.autograph.server_url The autograph server URL
kinto.signer.autograph.hawk_id The hawk identifier used to issue the requests.
kinto.signer.autograph.hawk_secret The hawk secret used to issue the requests.

Generating a keypair

To generate a new keypair, you can use the following command:

$ python -m kinto_signer.generate_keypair private.pem public.pem

Running the tests

To run the unit tests:

$ make tests

For the functional tests:

$ make run-signer
$ make functional

kinto-signer's People

Contributors

almet avatar natim avatar leplatrem avatar

Watchers

Mathieu Agopian avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.