Skip to main content

rest api for cubicweb

Project description

Summary

This cube allows a client to forge signed HTTP resquests that are then recognized as valid by the CubicWeb web server, ie. the request is handled as an authenticated user. For example, it can be used to start an operation using an authenticated user.

It’s usually used alongside with cubicweb-rqlcontroller and cwclientlib.

This cube aims at make it easy to write REST-like APIs for CW.

Long story short: cubicweb-signedrequest allows you to make authenticated HTTP requests simply by addind a properly forged HTTP header in your request.

Warning

cubicweb-signedrequest is very ticklish about time: your request will be refused is the Date header if not very accurate. Also, for security reasons, you won’t have any detail on why your request has been denied.

How to use signed HTTP requests in your CubicWeb app?

This cube aims at making it possible to use tokens to authenticate to a CubicWeb application. It provides a Token entity that have a unique token_id attribute and a generated (secret) token. This Token entity is related to a CWUser (using the token_for_user relation).

It’s the possible to make authenticated HTTP requests (authenticated as this CWUser) by adding a Authorization header to the HTTP request. This header is computed as a HMAC hash with:

  • the secret token as key,
  • the concatenation os method + url + all the signed headers.

By default, the method is the Cubicweb string, and the signed headers are ‘Content-MD5’, ‘Content-Type’ and ‘Date’.

The doc/sreq_example.py script is an simple python script showing how to forge such a HTTP GET request using urllib2.

Please read the documentation of cwclientlib for examples of how it can be used.

Project details


Release history Release notifications

This version
History Node

0.3.1

History Node

0.3.0

History Node

0.2.1

History Node

0.2.0

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cubicweb-signedrequest-0.3.1.tar.gz (17.3 kB) Copy SHA256 hash SHA256 Source None Feb 12, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page