ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-02-08 20:30:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add a few docstrings for accessors etc

Browse Source
This commit is contained in:
meejah 2020-12-20 23:15:14 -07:00
parent 5d4253be3e
commit 5eff6f9ddd
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/allmydata/grid_manager.py
View File

@ -29,12 +29,21 @@ class _GridManagerStorageServer(object):
) )
def add_certificate(self, certificate): def add_certificate(self, certificate):
"""
Add ``certificate``
"""
self.certificates.append(certificate) self.certificates.append(certificate)
def public_key_string(self): def public_key_string(self):
"""
:returns: the public key as a string
"""
return ed25519.string_from_verifying_key(self.public_key) return ed25519.string_from_verifying_key(self.public_key)
def marshal(self): def marshal(self):
"""
:returns: a dict suitable for JSON representing this object
"""
return { return {
u"public_key": self.public_key_string(), u"public_key": self.public_key_string(),
} }
@ -181,6 +190,9 @@ class _GridManager(object):
return self._storage_servers return self._storage_servers
def public_identity(self): def public_identity(self):
"""
:returns: public key as a string
"""
return ed25519.string_from_verifying_key(self._public_key) return ed25519.string_from_verifying_key(self._public_key)
def sign(self, name, expiry): def sign(self, name, expiry):
@ -248,6 +260,9 @@ class _GridManager(object):
) )
def marshal(self): def marshal(self):
"""
:returns: a dict suitable for JSON representing this object
"""
data = { data = {
u"grid_manager_config_version": self._version, u"grid_manager_config_version": self._version,
u"private_key": self._private_key_bytes.decode('ascii'), u"private_key": self._private_key_bytes.decode('ascii'),
@ -415,8 +430,10 @@ def create_grid_manager_verifier(keys, certs, public_key, now_fn=None, bad_cert=
bad_cert(key, alleged_cert) bad_cert(key, alleged_cert)
def validate(): def validate():
"""
:returns: True if if *any* certificate is still valid for a server
"""
now = now_fn() now = now_fn()
# if *any* certificate is still valid then we consider the server valid
for cert in valid_certs: for cert in valid_certs:
expires = datetime.utcfromtimestamp(cert['expires']) expires = datetime.utcfromtimestamp(cert['expires'])
if cert['public_key'] == public_key: if cert['public_key'] == public_key:

3
src/allmydata/scripts/admin.py
View File

@ -59,6 +59,9 @@ def derive_pubkey(options):
class AddGridManagerCertOptions(BaseOptions): class AddGridManagerCertOptions(BaseOptions):
"""
Options for add-grid-manager-cert
"""
optParameters = [ optParameters = [
['filename', 'f', None, "Filename of the certificate ('-', a dash, for stdin)"], ['filename', 'f', None, "Filename of the certificate ('-', a dash, for stdin)"],