File: index.rst

package info (click to toggle)
scitokens-cpp 1.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,172 kB
  • sloc: cpp: 11,717; ansic: 596; sh: 161; python: 132; makefile: 22
file content (38 lines) | stat: -rw-r--r-- 1,140 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
SciTokens C++ Library Documentation
====================================

SciTokens provide a token format for distributed authorization. The tokens are self-describing, 
can be verified in a distributed fashion (no need to contact the issuer to determine if the token is valid). 
This is convenient for a federated environment where several otherwise-independent storage endpoints 
want to delegate trust for an issuer for managing a storage allocation.

The SciTokens C++ library implements a minimal library for creating and using SciTokens from C or C++.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   api
   examples

Quick Start
-----------

This library provides both C and C++ APIs for working with SciTokens. The primary interface 
is through the C API defined in ``scitokens.h``.

Key Features:

* Create and sign SciTokens
* Validate and verify SciTokens  
* Generate Access Control Lists (ACLs) from tokens
* Support for multiple token profiles (SciTokens 1.0/2.0, WLCG, AT+JWT)
* Asynchronous token operations

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`