wiki:CredPrinterDocs

Version 5 (modified by faber, 10 years ago) (diff)

--

Credential Printer

The credential printer service is an XMLRPC service to convert ABAC credentials encoded as X.509 certificates into a text format. While libabac is widely portable through swig, some programming environments cannot import the library, yet would like to see the contents of credentials. The credential printer provides access.

The example code

Installing the service

We distribute the credential printer as a python application. It depends on the standard installation and the M2Crypto package, available from several places. It also depends on libabac.

Once the prerequisites are installed, download the credential printer source and untar it, change to the cred_printer-1.00 directory and run the standard python install script (as root):

$ tar xzf cred_printer-1.00.tar.gz
$ cd cred_printer-1.00
$ sudo python ./setup.py install

This will install a python egg into your site-packages and two python scripts, cred_server.py and cred_client.py into your standard biraries directory (/usr/local/bin on FreeBSD or Ubuntu).

Because the installation runs as root, you may need to delete the distribution directory as root:

$ cd ..
$ sudo rm -rf cred_printer-1.00.tar.gz

Running the server

The server takes an optional argument, --cert and a certificate with which to identify itself under SSL/https. If omitted, the server will run under http, unencrypted and unauthenticated. If run under SSL, the server expects clients to supply a certificate, but does not vaildate it's authorization chain. This is for future expansion using ABAC authorization to the server and self-certifying identities. The directions for making a fedid certificate will also create a valid certificate for this use.

The server also takes a --port argument defining the port to listen on. By default it listens on port 13232.

Assuming that ./cert.pem contains a certificate and key for the server:

$ cred_server.py --cert ./cert.pem

starts the server under SSL/https listening on port 13232,

$ cred_server.py --port 54321 --cert ./cert.pem

starts the server under SSL/https listening on port 54321

$ cred_server.py --port 54321

starts the server under http listening on port 54321, and

$ cred_server.py

starts the server under http on port 13232.

Running the client

The client is primarily to demonstrate the server functionality, but may prove useful itself. It takes 2 optional parameters and a list of filenames, and prints the decoded credentials on the standard output.

The --url option points to the server. By default it is http://localhost:13232. It can be set explicitly by setting this option, or by setting the CRED_URL environment variable. Using an https URL without the --cert option will fail.

The --cert option specifies a file to use for an https exchange. If the option is given, any URL will be traeted as https; if omitted any URL will be treated as http. The directions for making a fedid certificate will also create a valid certificate for this use.

To try the client, start the server as an http server on the default port:

$ cred_server.py

and run the client with the contents of the examples/experiment_create directory from the abac distribution. Assuming that that directory is examples/experiment_create:

$ cred_client.py examples/experiment_create/*

produces:

000: identity 9b47d3669b99a4ce1d3a0055be002ea6a580041a Acme
001: attribute 9b47d3669b99a4ce1d3a0055be002ea6a580041a.experiment_create <- 9b47d3669b99a4ce1d3a0055be002ea6a580041a.partner.experiment_create Acme.experiment_create <- Acme.partner.experiment_create
002: attribute 9b47d3669b99a4ce1d3a0055be002ea6a580041a.partner <- f923e9f69d33b52d8bbdfd19f2ec89dde7beedd7 Acme.partner <- Globotron
003: Error, code -1
004: identity 001f3599bafb755e97855b9ee0b3487830a4ecc7 Alice
005: attribute 001f3599bafb755e97855b9ee0b3487830a4ecc7.power_user <- b9cdabc274fa38390c26829efed68eaa527b8d00 Alice.power_user <- Bob
006: Error, code -1
007: identity b9cdabc274fa38390c26829efed68eaa527b8d00 Bob
008: Error, code -1
009: identity f923e9f69d33b52d8bbdfd19f2ec89dde7beedd7 Globotron
010: attribute f923e9f69d33b52d8bbdfd19f2ec89dde7beedd7.admin <- 001f3599bafb755e97855b9ee0b3487830a4ecc7 Globotron.admin <- Alice
011: attribute f923e9f69d33b52d8bbdfd19f2ec89dde7beedd7.experiment_create <- f923e9f69d33b52d8bbdfd19f2ec89dde7beedd7.admin.power_user Globotron.experiment_create <- Globotron.admin.power_user
012: Error, code -1
013: Error, code -1

Credentials that represent identities, such as the first entry (001) above are marked as identity certificates and both the keyid (a SHA1 hash of the key as described in RFC 3280, and the certificate CN (common name) are displayed. Certificates created through [Creddy Creddy] and libCreddy put a human-readable name in the certificate CN.

Credentials that represent attribute assignments are rendered as in line 002. The attribute identifier is printed and the certificate presented in RT0 format both with keyids and human-readable names.

For data that does not represent either an identity or an attribute, the error line is printed. The code is a libabac return code. The errors in this example come from the private key files and README files in that example directory.

The Interface

The server expects an XMLRPC array of XMLRPC structs containing the credentials to represent. In the input, each struct has two fields:

id
a string used to map from input to output credentials
credential
a Binary object holding the credential bits

The ids are free form strings used to map the input to the output. The credential bits are also returned, but matching ids can be easier. {{{cred_client.py}} uses 3 digit serial numbers (the first line of the output), but an application can use any unique identifier. In fact, the server never confirms their uniqueness, but matching input to output can be tricky without it.

The server validates and translates the credentials into text and returns them in a more complex array of structs. Notice that the credentials must be validated. To decode an attribute certificate, the identity credential of the issuer must be included in the request.

The output is an array of structs with the following members:

id
a string used to map from input to output credentials (identical to input)
credential
a Binary object holding the credential bits (identical to input)
type
a string indicating what the credential encodes. Will be one of be "identity", "attribute", or "unknown".
str
a string, the representation of the attribute or identity in terms of keyids
auxstr
a string, the representation of the attribute or identity in terms of hunam-readable names (CNs). If CNs are missing or unresolvable, the keyids will be used.
errcode
an integer, the libabac return code of the attempted conversion. If this is non-zero, the str and auxstr contents are undefined. (cred_server.py sets them to the empty string, but do not rely on that.)

The output array is not guaranteed to be in the same order as the input array (and generally will not be). Use the id member to match input and output.

Just for concreteness, here is the python encoding for a simple request and response:

Request

[
   {'credential': <xmlrpclib.Binary instance at 0x28b3dacc>, 'id': '000'}, 
   {'credential': <xmlrpclib.Binary instance at 0x28b3db6c>, 'id': '001'}, 
   {'credential': <xmlrpclib.Binary instance at 0x28b3db4c>, 'id': '002'}
]

Three dicts/structs are encoded with a serial number as id and the binary of the credential.

Response

[
   {'credential': <xmlrpclib.Binary instance at 0x28b3dacc>, 'errcode': 0, 'auxstr': 'Acme', 'str': '9b47d3669b99a4ce1d3a0055be002ea6a580041a', 'type': 'identity', 'id': '000'}, 
   {'credential': <xmlrpclib.Binary instance at 0x28b3db6c>, 'errcode': 0, 'auxstr': 'Acme.partner <- f923e9f69d33b52d8bbdfd19f2ec89dde7beedd7', 'str': '9b47d3669b99a4ce1d3a0055be002ea6a580041a.partner <- f923e9f69d33b52d8bbdfd19f2ec89dde7beedd7', 'type': 'attribute', 'id': '001'}, 
   {'credential': <xmlrpclib.Binary instance at 0x28b3db4c>, 'errcode': -1, 'auxstr': '', 'str': '', 'type': 'unknown', 'id': '002'}
]

The first dict/struct is an identity, the second an attribute, and the third an invalid certificate.

Attachments (4)

Download all attachments as: .zip