-def sign(self) ‑> bool
+def sign(self, **kwargs) ‑> bool
Sign the certificate
+**kwargs_EX.NotSignedExceptiondef sign(self) -> bool:
+def sign(self, **kwargs) -> bool:
"""Sign the certificate
+ Args:
+ **kwargs: Arguments to pass to the signature signing method
+ ex. hash_alg for RSA signatures
+
Raises:
_EX.NotSignedException: The certificate could not be signed
@@ -2700,7 +2718,7 @@ Returns
bool: Whether successful
"""
if self.can_sign():
- self.footer.signature.sign(data=self.get_signable())
+ self.footer.signature.sign(data=self.get_signable(), **kwargs)
return True
raise _EX.NotSignedException("There was an error while signing the certificate")
diff --git a/docs/fields.html b/docs/fields.html
index 26ffaf1..7f078dd 100644
--- a/docs/fields.html
+++ b/docs/fields.html
@@ -66,7 +66,7 @@ Module sshkey_tools.fields
long_to_bytes,
random_keyid,
random_serial,
- str_to_timedelta,
+ str_to_time_delta,
)
NoneType = type(None)
@@ -168,7 +168,7 @@ Module sshkey_tools.fields
"""
Validates if the field is set when required
"""
- if self.DEFAULT == self.value is None:
+ if self.DEFAULT and self.value is None:
return _EX.InvalidFieldDataException(
f"{self.get_name()} is a required field"
)
@@ -294,22 +294,23 @@ Module sshkey_tools.fields
DEFAULT = b""
@classmethod
- def encode(cls, value: bytes) -> bytes:
+ def encode(cls, value: bytes, encoding: str = "utf-8") -> bytes:
"""
Encodes a string or bytestring into a packed byte string
Args:
value (Union[str, bytes]): The string/bytestring to encode
- encoding (str): The encoding to user for the string
+ encoding (str): The optional encoding, not used when passing
+ a byte value.
Returns:
bytes: Packed byte string containing the source data
"""
cls.__validate_type__(value, True)
- return pack(">I", len(value)) + ensure_bytestring(value)
+ return pack(">I", len(value)) + ensure_bytestring(value, encoding)
@staticmethod
- def decode(data: bytes) -> Tuple[bytes, bytes]:
+ def decode(data: bytes, encoding: str = None) -> Tuple[bytes, bytes]:
"""
Unpacks the next string from a packed byte string
@@ -321,6 +322,10 @@ Module sshkey_tools.fields
string and remainder of the data
"""
length = unpack(">I", data[:4])[0] + 4
+
+ if encoding is not None:
+ return ensure_string(data[4:length], encoding), data[length:]
+
return ensure_bytestring(data[4:length]), data[length:]
@@ -344,8 +349,7 @@ Module sshkey_tools.fields
Returns:
bytes: Packed byte string containing the source data
"""
- cls.__validate_type__(value, True)
- return BytestringField.encode(ensure_bytestring(value, encoding))
+ return super().encode(value, encoding)
@staticmethod
def decode(data: bytes, encoding: str = "utf-8") -> Tuple[str, bytes]:
@@ -359,9 +363,7 @@ Module sshkey_tools.fields
tuple(bytes, bytes): The next block of bytes from the packed byte
string and remainder of the data
"""
- value, data = BytestringField.decode(data)
-
- return value.decode(encoding), data
+ return BytestringField.decode(data, encoding)
class Integer32Field(CertificateField):
@@ -498,9 +500,9 @@ Module sshkey_tools.fields
if isinstance(value, str):
if value == "forever":
- return Integer64Field.encode(MAX_INT64)
+ return Integer64Field.encode(MAX_INT64 - 1)
- value = int(datetime.now() + str_to_timedelta(value))
+ value = int((datetime.now() + str_to_time_delta(value)).timestamp())
if isinstance(value, datetime):
value = int(value.timestamp())
@@ -779,7 +781,7 @@ Module sshkey_tools.fields
return True
-class NonceField(StringField):
+class NonceField(BytestringField):
"""
Contains the nonce for the certificate, randomly generated
this protects the integrity of the private key, especially
@@ -1321,8 +1323,11 @@ Module sshkey_tools.fields
def __table__(self) -> tuple:
msg = "No signature"
- if self.is_signed:
+ if self.is_signed and self.private_key is not None:
msg = f"Signed with private key {self.private_key.get_fingerprint()}"
+
+ if self.is_signed and self.private_key is None:
+ msg = "Signed with: See pubkey fingerprint above"
return ("Signature", msg)
@@ -1379,7 +1384,7 @@ Module sshkey_tools.fields
"""
return self.private_key is not None
- def sign(self, data: bytes) -> None:
+ def sign(self, data: bytes, **kwargs) -> None:
"""
Placeholder signing function
"""
@@ -1931,22 +1936,23 @@ Inherited members
DEFAULT = b""
@classmethod
- def encode(cls, value: bytes) -> bytes:
+ def encode(cls, value: bytes, encoding: str = "utf-8") -> bytes:
"""
Encodes a string or bytestring into a packed byte string
Args:
value (Union[str, bytes]): The string/bytestring to encode
- encoding (str): The encoding to user for the string
+ encoding (str): The optional encoding, not used when passing
+ a byte value.
Returns:
bytes: Packed byte string containing the source data
"""
cls.__validate_type__(value, True)
- return pack(">I", len(value)) + ensure_bytestring(value)
+ return pack(">I", len(value)) + ensure_bytestring(value, encoding)
@staticmethod
- def decode(data: bytes) -> Tuple[bytes, bytes]:
+ def decode(data: bytes, encoding: str = None) -> Tuple[bytes, bytes]:
"""
Unpacks the next string from a packed byte string
@@ -1958,6 +1964,10 @@ Inherited members
string and remainder of the data
"""
length = unpack(">I", data[:4])[0] + 4
+
+ if encoding is not None:
+ return ensure_string(data[4:length], encoding), data[length:]
+
return ensure_bytestring(data[4:length]), data[length:]
-def decode(data: bytes) ‑> Tuple[bytes, bytes]
+def decode(data: bytes, encoding: str = None) ‑> Tuple[bytes, bytes]
Unpacks the next string from a packed byte string
@@ -2002,7 +2013,7 @@@staticmethod
-def decode(data: bytes) -> Tuple[bytes, bytes]:
+def decode(data: bytes, encoding: str = None) -> Tuple[bytes, bytes]:
"""
Unpacks the next string from a packed byte string
@@ -2014,11 +2025,15 @@ Returns
string and remainder of the data
"""
length = unpack(">I", data[:4])[0] + 4
+
+ if encoding is not None:
+ return ensure_string(data[4:length], encoding), data[length:]
+
return ensure_bytestring(data[4:length]), data[length:]
-def encode(value: bytes) ‑> bytes
+def encode(value: bytes, encoding: str = 'utf-8') ‑> bytes
Encodes a string or bytestring into a packed byte string
@@ -2027,7 +2042,8 @@value : Union[str, bytes]encoding : str@classmethod
-def encode(cls, value: bytes) -> bytes:
+def encode(cls, value: bytes, encoding: str = "utf-8") -> bytes:
"""
Encodes a string or bytestring into a packed byte string
Args:
value (Union[str, bytes]): The string/bytestring to encode
- encoding (str): The encoding to user for the string
+ encoding (str): The optional encoding, not used when passing
+ a byte value.
Returns:
bytes: Packed byte string containing the source data
"""
cls.__validate_type__(value, True)
- return pack(">I", len(value)) + ensure_bytestring(value)StringField:
decodeencodeencodefactoryfrom_decodeget_nameclass NonceField(StringField):
+class NonceField(BytestringField):
"""
Contains the nonce for the certificate, randomly generated
this protects the integrity of the private key, especially
@@ -5415,7 +5432,6 @@ Inherited members
Ancestors
@@ -5467,14 +5483,14 @@ Returns
Inherited members
@@ -5608,7 +5624,7 @@ Inherited members
StringField:
decodeencodeencodefactoryfrom_decodeget_nameInherited members
StringField:
decodeencodeencodefactoryfrom_decodeget_nameInherited members
def __table__(self) -> tuple:
msg = "No signature"
- if self.is_signed:
+ if self.is_signed and self.private_key is not None:
msg = f"Signed with private key {self.private_key.get_fingerprint()}"
+
+ if self.is_signed and self.private_key is None:
+ msg = "Signed with: See pubkey fingerprint above"
return ("Signature", msg)
@@ -6439,7 +6458,7 @@ Inherited members
"""
return self.private_key is not None
- def sign(self, data: bytes) -> None:
+ def sign(self, data: bytes, **kwargs) -> None:
"""
Placeholder signing function
"""
@@ -6599,7 +6618,7 @@ Methods
-def sign(self, data: bytes) ‑> None
+def sign(self, data: bytes, **kwargs) ‑> None
-
Placeholder signing function
@@ -6607,7 +6626,7 @@ Methods
Expand source code
-def sign(self, data: bytes) -> None:
+def sign(self, data: bytes, **kwargs) -> None:
"""
Placeholder signing function
"""
@@ -6658,8 +6677,7 @@ Inherited members
Returns:
bytes: Packed byte string containing the source data
"""
- cls.__validate_type__(value, True)
- return BytestringField.encode(ensure_bytestring(value, encoding))
+ return super().encode(value, encoding)
@staticmethod
def decode(data: bytes, encoding: str = "utf-8") -> Tuple[str, bytes]:
@@ -6673,9 +6691,7 @@ Inherited members
tuple(bytes, bytes): The next block of bytes from the packed byte
string and remainder of the data
"""
- value, data = BytestringField.decode(data)
-
- return value.decode(encoding), data
+ return BytestringField.decode(data, encoding)
Ancestors
@@ -6685,7 +6701,6 @@ Ancestors
Subclasses
@@ -6700,12 +6715,50 @@ Class variables
+Static methods
+
+
+def encode(value: str, encoding: str = 'utf-8')
+-
+
Encodes a string or bytestring into a packed byte string
+Args
+
+value : Union[str, bytes]- The string/bytestring to encode
+encoding : str- The encoding to user for the string
+
+Returns
+
+bytes- Packed byte string containing the source data
+
+
+
+Expand source code
+
+@classmethod
+def encode(cls, value: str, encoding: str = "utf-8"):
+ """
+ Encodes a string or bytestring into a packed byte string
+
+ Args:
+ value (Union[str, bytes]): The string/bytestring to encode
+ encoding (str): The encoding to user for the string
+
+ Returns:
+ bytes: Packed byte string containing the source data
+ """
+ return super().encode(value, encoding)
+
+
+
Inherited members
BytestringField:
-
diff --git a/docs/index.html b/docs/index.html
index 4fdfdc2..dfa4a21 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -46,12 +46,7 @@
OpenSSH Certificates
- Export certificates to file, string or bytes
Roadmap
-
-- [x] Rewrite certificate field functionality for simpler usage
-- [ ] Re-add functionality for changing RSA hash method
-- [ ] Add CLI functionality
-- [ ] Convert to/from putty format (keys only)
-
+See issues for planned features and fixes
Installation
With pip
pip3 install sshkey-tools
@@ -481,6 +476,11 @@ Loading, re-cre
Changelog
+0.9.1
+
+- Updated documentation
+- Fix for bug where exception would occur when trying to export a key without a comment set
+
0.9
- Adjustments to certificate field handling for easier usage/syntax autocompletion
@@ -585,6 +585,7 @@ Index
- Creating, signing and verifying certificates
- Loading, re-creating and verifying existing certificates
- Changelog
+- 0.9.1
- 0.9
- 0.8.2
- 0.8.1
diff --git a/docs/keys.html b/docs/keys.html
index 93e41c9..afa1da6 100644
--- a/docs/keys.html
+++ b/docs/keys.html
@@ -55,7 +55,7 @@ Module sshkey_tools.keys
from cryptography.hazmat.primitives.asymmetric import rsa as _RSA
from . import exceptions as _EX
-from .utils import ensure_bytestring, ensure_string
+from .utils import ensure_bytestring, ensure_string, nullsafe_getattr
from .utils import md5_fingerprint as _FP_MD5
from .utils import sha256_fingerprint as _FP_SHA256
from .utils import sha512_fingerprint as _FP_SHA512
@@ -158,12 +158,15 @@ Module sshkey_tools.keys
_SERIALIZATION.Encoding.OpenSSH,
_SERIALIZATION.PublicFormat.OpenSSH,
]
+
+ # Ensure comment is not None
+ self.comment = nullsafe_getattr(self, "comment", "")
@classmethod
def from_class(
cls,
key_class: PubkeyClasses,
- comment: Union[str, bytes] = None,
+ comment: Union[str, bytes] = "",
key_type: Union[str, bytes] = None,
) -> "PublicKey":
"""
@@ -295,7 +298,7 @@ Module sshkey_tools.keys
return " ".join(
[
ensure_string(self.serialize(), encoding),
- ensure_string(getattr(self, "comment", ""), encoding),
+ ensure_string(nullsafe_getattr(self, "comment", ""), encoding),
]
)
@@ -2893,12 +2896,15 @@ Returns
_SERIALIZATION.Encoding.OpenSSH,
_SERIALIZATION.PublicFormat.OpenSSH,
]
+
+ # Ensure comment is not None
+ self.comment = nullsafe_getattr(self, "comment", "")
@classmethod
def from_class(
cls,
key_class: PubkeyClasses,
- comment: Union[str, bytes] = None,
+ comment: Union[str, bytes] = "",
key_type: Union[str, bytes] = None,
) -> "PublicKey":
"""
@@ -3030,7 +3036,7 @@ Returns
return " ".join(
[
ensure_string(self.serialize(), encoding),
- ensure_string(getattr(self, "comment", ""), encoding),
+ ensure_string(nullsafe_getattr(self, "comment", ""), encoding),
]
)
@@ -3104,7 +3110,7 @@ Returns
-def from_class(key_class: Union[cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey, cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey, cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey, cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey], comment: Union[str, bytes] = None, key_type: Union[str, bytes] = None) ‑> PublicKey
+def from_class(key_class: Union[cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey, cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey, cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey, cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PublicKey], comment: Union[str, bytes] = '', key_type: Union[str, bytes] = None) ‑> PublicKey
-
Creates a new SSH Public key from a cryptography class
@@ -3135,7 +3141,7 @@ Returns
def from_class(
cls,
key_class: PubkeyClasses,
- comment: Union[str, bytes] = None,
+ comment: Union[str, bytes] = "",
key_type: Union[str, bytes] = None,
) -> "PublicKey":
"""
@@ -3380,7 +3386,7 @@ Returns
return " ".join(
[
ensure_string(self.serialize(), encoding),
- ensure_string(getattr(self, "comment", ""), encoding),
+ ensure_string(nullsafe_getattr(self, "comment", ""), encoding),
]
)
diff --git a/docs/utils.html b/docs/utils.html
index 4be0c87..e953cf9 100644
--- a/docs/utils.html
+++ b/docs/utils.html
@@ -33,13 +33,15 @@ Module sshkey_tools.utils
import hashlib as hl
import sys
import datetime
-import pytimeparse2
+
from base64 import b64encode
from random import randint
from secrets import randbits
from typing import Dict, List, Union
from uuid import uuid4
+from pytimeparse2 import parse as time_parse
+
NoneType = type(None)
@@ -260,6 +262,22 @@ Module sshkey_tools.utils
)
+def nullsafe_getattr(obj, attr: str, default):
+ """
+ Null-safe getattr, ensuring the result is not None.
+ If the result is None, the default value is returned instead.
+
+ Args:
+ obj: The object
+ attr: The attribute to get
+ default: The default value
+ """
+ att = getattr(obj, attr, default)
+ if att is None:
+ att = default
+
+ return att
+
def join_dicts(*dicts) -> dict:
"""
Joins two or more dictionaries together.
@@ -283,7 +301,7 @@ Module sshkey_tools.utils
return return_dict
-def str_to_timedelta(str_delta: str) -> datetime.timedelta:
+def str_to_time_delta(str_delta: str) -> datetime.timedelta:
"""Uses the package pytimeparse2 by wroberts/onegreyonewhite
to convert a string into a timedelta object.
Examples:
@@ -328,10 +346,12 @@ Module sshkey_tools.utils
datetime.timedelta: The time delta object
"""
try:
- parsed = pytimeparse2.parse(str_delta, as_timedelta=True, raise_exception=True)
+ parsed = time_parse(str_delta, as_timedelta=True, raise_exception=True)
return parsed
- except Exception as e:
- raise ValueError(f"Could not parse time delta string {str_delta} : {e}") from e
+ except Exception as ex:
+ raise ValueError(
+ f"Could not parse time delta string {str_delta} : {ex}"
+ ) from ex
@@ -718,6 +738,42 @@ Returns
)
+
+def nullsafe_getattr(obj, attr: str, default)
+-
+
Null-safe getattr, ensuring the result is not None.
+If the result is None, the default value is returned instead.
+Args
+
+obj- The object
+attr- The attribute to get
+default- The default value
+
+
+
+Expand source code
+
+def nullsafe_getattr(obj, attr: str, default):
+ """
+ Null-safe getattr, ensuring the result is not None.
+ If the result is None, the default value is returned instead.
+
+ Args:
+ obj: The object
+ attr: The attribute to get
+ default: The default value
+ """
+ att = getattr(obj, attr, default)
+ if att is None:
+ att = default
+
+ return att
+
+
def random_keyid() ‑> str
Returns
)
-
-def str_to_timedelta(str_delta: str) ‑> datetime.timedelta
+
+def str_to_time_delta(str_delta: str) ‑> datetime.timedelta
-
Uses the package pytimeparse2 by wroberts/onegreyonewhite
@@ -894,7 +950,7 @@
Returns
Expand source code
-def str_to_timedelta(str_delta: str) -> datetime.timedelta:
+def str_to_time_delta(str_delta: str) -> datetime.timedelta:
"""Uses the package pytimeparse2 by wroberts/onegreyonewhite
to convert a string into a timedelta object.
Examples:
@@ -939,10 +995,12 @@ Returns
datetime.timedelta: The time delta object
"""
try:
- parsed = pytimeparse2.parse(str_delta, as_timedelta=True, raise_exception=True)
+ parsed = time_parse(str_delta, as_timedelta=True, raise_exception=True)
return parsed
- except Exception as e:
- raise ValueError(f"Could not parse time delta string {str_delta} : {e}") from e
+ except Exception as ex:
+ raise ValueError(
+ f"Could not parse time delta string {str_delta} : {ex}"
+ ) from ex
@@ -972,11 +1030,12 @@ Index
join_dictslong_to_bytesmd5_fingerprintnullsafe_getattrrandom_keyidrandom_serialsha256_fingerprintsha512_fingerprintstr_to_timedeltastr_to_time_delta