source: examples/README @ 9502c50

mei_rt2mei_rt2_fix_1meiyap-rt1rt2
Last change on this file since 9502c50 was 9502c50, checked in by Mei <mei@…>, 12 years ago

1) rename examples' rr to run_query
2) updated some doc
3) add decode to creddy --roles and creddy --display --show so it will

show more useful attribute rule string

4) stub in the python script in one of the example directory

  • Property mode set to 100644
File size: 2.2 KB
Line 
1
2This directory contains various ABAC scenario that exercises
3various feature of the current implmentation with YAP prolog db.
4
5The frontend query client is abac_yap_prover.
6
7Each subdirectory has a README script which includes a description
8of the scenario, and the calls that to generate the needed credentials.
9There is a run_query script which sets up and runs couple of typical
10query using abac_yap_prover.
11
12runall, is the top level script that will cleanup and setup the
13credentials needed in each subdirectories
14
15runcheck, is the top level script that initiate the run_query script
16within each subdirectories; capture the result and diff with the
17baseline output in allout.save.
18
19abac_yap_prover
20
21Usage: abac_prover_yap
22        --keystore <keystore>
23        --role <keyid.role> --principal <keyid>
24        --oset <keyid.oset> --object <otype>
25    loads the keystore and runs the query role <-?- principal
26                                the query oset <-?- object
27        --dump <file>
28    extracts all credentials from the prolog db
29
30keystore is the location where the prover will search to load credentials.
31All accessible identity credentials and attribute credentials will be
32picked up one file at a time.
33
34role, oset, principal, and object are specified with principal's SHA1
35value extracted from the credentials that are loaded from keystore location
36using creddy. Example can be found in the run_queryscript.
37
38An actual example from balltime_rt2_typed,
39
40abac_prover_yap --keystore /home/mei/Deter/abac/examples/balltime_rt2_typed
41  --role [keyid:212146063d65264e8f27c31f0da592e386fc59aa].role:stadium
42                 ([string:'access'],[boolean:true],[time:20120228T130000])
43  --principal [keyid:49bdcd1278fce71d7c5cb3ee9138c22f7379e8e0]
44
45Currently, the dump option might fail if not enough information is
46stored in the backend db. It will be reimplemented in the near future.
47
48Two useful environment variables,
49
50DUMP_DB, extract the complete yap db to stdout
51ABAC_CN, use CN instead of SHA1 value for identifying the principals. This
52is useful for debugging purpose but will not resolve conflict when CN is not
53uniquely associated with each principal's SHA1 value.
54
55env ABAC_CN=1 runall run
56or
57env DUMP_DB=1 ABAC_CN=1 run_query
58
59
60
61
Note: See TracBrowser for help on using the repository browser.