[gentoo-commits] proj/api:master commit in: files/gentoo-keys/seeds/

[Brian Dolbec]

commit:     09e075daf36042e7ea411ec550b86041b21990fe
Author:     Brian Dolbec <dolsen <AT> gentoo <DOT> org>
AuthorDate: Fri Dec 27 00:10:37 2013 +0000
Commit:     Brian Dolbec <brian.dolbec <AT> gmail <DOT> com>
CommitDate: Fri Dec 27 00:10:37 2013 +0000
URL:        http://sources.gentoo.org/gitweb/?p=proj/api.git;a=commit;h=09e075da

Add a README with seed file field descriptions

---
 files/gentoo-keys/seeds/README | 58 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)

diff --git a/files/gentoo-keys/seeds/README b/files/gentoo-keys/seeds/README
new file mode 100644
index 0000000..9bf5301
--- /dev/null
+++ b/files/gentoo-keys/seeds/README
@@ -0,0 +1,58 @@
+
+
+This README is to describle the current form of the seed files
+and the fields data they contain.
+
+CAUTION:  These specs are not to be considered stable and
+are likely to change in the future.
+
+============================================================
+Python file excerpt of the GKEY named tuple class used to
+represent the data in the seed file.
+=============================================================
+
+
+# some constants used in gkeyldap/actions.py
+# they map the index values of the GKEY input data fields
+NICK = 0
+NAME = 1
+KEYID = 2
+LONGKEYID = 3
+KEYDIR = 4
+FINGERPRINT = 5
+
+# set some defaults
+KEY_LEN = {
+    'keyid': 8,
+    'longkeyid': 16,
+}
+
+
+class GKEY(namedtuple('GKEY', ['nick', 'name', 'keyid', 'longkeyid',
+    'keydir', 'fingerprint'])):
+    '''Class to hold the relavent info about a key'''
+
+    field_types = {'nick': str, 'name': str, 'keyid': list,
+        'longkeyid': list, 'keydir': str, 'fingerprint': list}
+    field_separator = "|"
+    list_separator = ":"
+    __slots__ = ()
+
+
+=============================================================
+
+Current fileds data in the seed files are:
+
+=============================================================
+
+field-0|field-1|field-2|filed-3|field-4|field-5
+
+['nick', 'name', 'keyid', 'longkeyid', 'keydir', 'fingerprint']
+
+fields2,3,5 may be lists with a ":" separating list members.
+This is going to change to use a "," as the list separator.
+
+Also, the keyid and longkeyid fileds are likely to be dropped, as version 3
+gpg key types will not be used/allowed.
+Therefore since the keyid and longkeyid are just substrings of the fingerprint.
+They do not need to be tracked.