diff options
| -rw-r--r-- | docs/README | 6 | ||||
| -rw-r--r-- | rpkid/INSTALLATION | 6 | ||||
| -rw-r--r-- | rpkid/Makefile | 7 | ||||
| -rw-r--r-- | rpkid/OPERATION | 27 | ||||
| -rw-r--r-- | rpkid/irdbd.pdf (renamed from rpkid/sample-irdb.pdf) | bin | 3500 -> 3500 bytes | |||
| -rw-r--r-- | rpkid/irdbd.sql (renamed from rpkid/sample-irdb.sql) | 5 | ||||
| -rw-r--r-- | rpkid/rpki-db-schema.pdf | bin | 7493 -> 7493 bytes | |||
| -rw-r--r-- | rpkid/rpki-db-schema.sql | 2 | ||||
| -rw-r--r-- | rpkid/rpki/__init__.py | 23 |
9 files changed, 53 insertions, 23 deletions
diff --git a/docs/README b/docs/README index 3cf48509..26bc0688 100644 --- a/docs/README +++ b/docs/README @@ -22,12 +22,6 @@ repository-engine-objects.pdf Graphviz source for " repository-structure.txt Old notes on repository structure -rpki-db-schema.pdf Current working draft of SQL objects -rpki-db-schema.sql in the RPKI engine - -sample-irbe.pdf A toy database representing the IR back end -sample-irbe.sql database - signed-manifests ASN.1 for signed manifests up-down-protocol Pointer to up-down protocol specification diff --git a/rpkid/INSTALLATION b/rpkid/INSTALLATION index 7856f85e..f3cbf392 100644 --- a/rpkid/INSTALLATION +++ b/rpkid/INSTALLATION @@ -57,12 +57,12 @@ Installation rpkid/testbed.sql. The MySQL command line client is usually the easiest way to do this, eg: - $ cd $top/scripts + $ cd $top/rpkid $ mysql -u root -p <testbed.sql To run the tests, run "make all-tests": - $ cd $top/scripts + $ cd $top/rpkid $ make all-tests If nothing explodes, your installation is probably ok. Any Python @@ -70,5 +70,5 @@ Installation __________________________________________________________________ - Generated on Thu Apr 10 09:50:53 2008 for Resource PKI Engine by + Generated on Tue Apr 29 16:40:17 2008 for Resource PKI Engine by doxygen 1.5.5 diff --git a/rpkid/Makefile b/rpkid/Makefile index 38d48b63..989b1ac4 100644 --- a/rpkid/Makefile +++ b/rpkid/Makefile @@ -59,6 +59,8 @@ dox doxygen: ${TWEAKHTML} rpki/html/Installation.html | ${HTML2TEXT} >INSTALLATION ${TWEAKHTML} rpki/html/Operation.html | ${HTML2TEXT} >OPERATION +doc:: dox + tags: find . -type f -name '*.py' ! -name relaxng.py | etags - @@ -68,8 +70,9 @@ rpki/relaxng.py: left-right-schema.rng up-down-schema.rng make-relaxng.py python make-relaxng.py >$@.tmp mv $@.tmp $@ -all:: rpki-db-schema.pdf -all:: sample-irdb.pdf +pdf: rpki-db-schema.pdf irdbd.pdf + +doc:: pdf # all-tests:: all; sh -x rootd.sh run diff --git a/rpkid/OPERATION b/rpkid/OPERATION index 76228aea..8d3b8c56 100644 --- a/rpkid/OPERATION +++ b/rpkid/OPERATION @@ -7,7 +7,13 @@ Operation These are the production-side RPKI tools, for Internet Registries (RIRs, LIRs, etc). See ../rcynic/README for relying party tools. - At present the package is intended to be run out of the scripts/ + Warning: + rpkid is still in development, and the code changes more often + than the hand-maintained portions of this documentation. The + following text was reasonably accurate at the time it was + written but may be obsolete by the time you read it. + + At present the package is intended to be run out of the rpkid/ directory. In addition to the library routines in the rpkid/rpki/ directory, the @@ -209,7 +215,7 @@ irdbd.py irdbd requires a pre-populated database to represent the IR's customers. irdbd expects this database to use the SQL schema defined in - docs/sample-irdb.sql. Once this database has been populated, the IRBE + rpkid/sample-irdb.sql. Once this database has been populated, the IRBE stub needs to create the appropriate objects in rpkid's database via the control subset of the left-right protocol, and store the linkage IDs (foreign keys into rpkid's database, basicly) in the IRDB. The @@ -278,18 +284,23 @@ irbe-cli.py parent --action= --type= --tag= --self_id= --parent_id= --bsc_id= --repository_id= --peer_contact_uri= --sia_base= --sender_name= --recipient_name= - --peer_biz_cert= --peer_biz_glue= --rekey --reissue --revoke + --bpki_cms_cert= --bpki_cms_glue= + --bpki_https_cert= --bpki_https_glue= + --rekey --reissue --revoke repository --action= --type= --tag= --self_id= --repository_id= - --bsc_id= --peer_contact_uri= --peer_biz_cert= --peer_biz_glue= + --bsc_id= --peer_contact_uri= + --bpki_cms_cert= --bpki_cms_glue= + --bpki_https_cert= --bpki_https_glue= self --action= --type= --tag= --self_id= --crl_interval= + --bpki_cert= --bpki_glue= --extension_preference= --rekey --reissue --revoke - --run_now --publish_world_now - --clear_extension_preferences + --run_now --publish_world_now + --clear_extension_preferences child --action= --type= --tag= --self_id= --child_id= - --bsc_id= --peer_biz_cert= --peer_biz_glue= --reissue + --bsc_id= --bpki_cms_cert= --bpki_cms_glue= --reissue route_origin --action= --type= --tag= --self_id= --route_origin_id= --as_number= --ipv4= --ipv6= --suppress_publication @@ -612,5 +623,5 @@ testpoke.py __________________________________________________________________ - Generated on Thu Apr 10 09:50:53 2008 for Resource PKI Engine by + Generated on Tue Apr 29 16:40:17 2008 for Resource PKI Engine by doxygen 1.5.5 diff --git a/rpkid/sample-irdb.pdf b/rpkid/irdbd.pdf Binary files differindex a2639528..71cca68a 100644 --- a/rpkid/sample-irdb.pdf +++ b/rpkid/irdbd.pdf diff --git a/rpkid/sample-irdb.sql b/rpkid/irdbd.sql index f5c8c970..07320dd0 100644 --- a/rpkid/sample-irdb.sql +++ b/rpkid/irdbd.sql @@ -14,6 +14,11 @@ -- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR -- PERFORMANCE OF THIS SOFTWARE. +-- SQL objects needed by irdbd.py. You only need this if you're using +-- irdbd.py as your IRDB; if you have a "real" backend you can do +-- anything you like so long as you implement the relevant portion of +-- the left-right protocol. + DROP TABLE IF EXISTS registrant; CREATE TABLE registrant ( diff --git a/rpkid/rpki-db-schema.pdf b/rpkid/rpki-db-schema.pdf Binary files differindex dc0d37e4..a9c50395 100644 --- a/rpkid/rpki-db-schema.pdf +++ b/rpkid/rpki-db-schema.pdf diff --git a/rpkid/rpki-db-schema.sql b/rpkid/rpki-db-schema.sql index d62e0dd2..1b4005f1 100644 --- a/rpkid/rpki-db-schema.sql +++ b/rpkid/rpki-db-schema.sql @@ -14,6 +14,8 @@ -- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR -- PERFORMANCE OF THIS SOFTWARE. +-- SQL objects needed by the RPKI engine (rpkid.py). + DROP TABLE IF EXISTS self; CREATE TABLE self ( diff --git a/rpkid/rpki/__init__.py b/rpkid/rpki/__init__.py index 00c921e3..ab215926 100644 --- a/rpkid/rpki/__init__.py +++ b/rpkid/rpki/__init__.py @@ -20,6 +20,15 @@ # since its existance defines the package, it's as sensible a place as # any to put the Doxygen mainpage. +# The "usage" text in the OPERATIONS section is a pain to keep +# syncrhonized with programs like irbe-cli.py which generate their +# usage dynamically. In theory we could address this by running each +# of these programs with the --help option, saving the resulting usage +# message to a file, and including it here using Doxygen's +# "verbinclude" command. There's a similar problem with config files, +# though, and I see no obvious way to automate them. Keeping the +# documentation with the config file options would be nice. Someday. + ## @mainpage ## ## This collection of Python modules implements a prototype of the @@ -100,14 +109,14 @@ ## easiest way to do this, eg: ## ## @verbatim -## $ cd $top/scripts +## $ cd $top/rpkid ## $ mysql -u root -p <testbed.sql ## @endverbatim ## ## To run the tests, run "make all-tests": ## ## @verbatim -## $ cd $top/scripts +## $ cd $top/rpkid ## $ make all-tests ## @endverbatim ## @@ -122,7 +131,13 @@ ## production-side RPKI tools, for Internet Registries (RIRs, LIRs, etc). ## See ../rcynic/README for relying party tools. ## -## At present the package is intended to be run out of the @c scripts/ +## @warning +## rpkid is still in development, and the code changes more often than +## the hand-maintained portions of this documentation. The following +## text was reasonably accurate at the time it was written but may be +## obsolete by the time you read it. +## +## At present the package is intended to be run out of the @c rpkid/ ## directory. ## ## In addition to the library routines in the @c rpkid/rpki/ directory, @@ -379,7 +394,7 @@ ## ## irdbd requires a pre-populated database to represent the IR's ## customers. irdbd expects this database to use the SQL schema defined -## in docs/sample-irdb.sql. Once this database has been populated, the +## in rpkid/sample-irdb.sql. Once this database has been populated, the ## IRBE stub needs to create the appropriate objects in rpkid's database ## via the control subset of the left-right protocol, and store the ## linkage IDs (foreign keys into rpkid's database, basicly) in the |