added some comments

[sfa.git] / util / credential.py

diff --git a/util/credential.py b/util/credential.py
index 1353f8a..f5016f0 100644 (file)
--- a/util/credential.py
+++ b/util/credential.py
@@ -1,3 +1,10 @@
+# credential.py
+#
+# implements GENI credentials
+#
+# Credentials are layered on top of certificates, and are essentially a
+# certificate that stores a tuple of parameters.
+
 from cert import *
 from rights import *
 from gid import *
@@ -5,6 +12,10 @@ import xmlrpclib
 
 # Credential is a tuple:
 #     (GIDCaller, GIDObject, LifeTime, Privileges, Delegate)
+#
+# These fields are encoded using xmlrpc into the subjectAltName field of the
+# x509 certificate. Note: Call encode() once the fields have been filled in
+# to perform this encoding.
 
 class Credential(Certificate):
     uuid = None