-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Interfaces for SCTs, feedback wanted #3467
Changes from 9 commits
e02ddc0
8852e90
2931bee
a11685d
dcdf912
008ba6f
b097102
1140330
c49f07e
d8dfedb
d695dc9
97d58ab
860890f
f2d1baf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
Certificate Transparency | ||
======================== | ||
|
||
.. currentmodule:: cryptography.x509.certificate_transparency | ||
|
||
Certificate Transparency is a set of protocols specified in :rfc:`6962` which | ||
allow X.509 certificates to be sent to append-only logs and have small | ||
cryptographic proofs that a certificate has been publicly logged. This allows | ||
for external auditing of the certificates that a certificate authority has | ||
issued. | ||
|
||
.. class:: SignedCertificateTimestamp | ||
|
||
.. versionadded:: 1.9 | ||
|
||
SignedCertificateTimestamps (SCTs) are small cryptographically signed | ||
assertions that the specified certificate has been submitted to a | ||
Certificate Transparency Log, and that it will be part of the public log | ||
within some time period. | ||
|
||
.. attribute:: version | ||
|
||
:type: :class:`~cryptography.x509.certificate_transparency.Version` | ||
|
||
The SCT version as an enumeration. Currently only one version has been | ||
specified. | ||
|
||
.. attribute:: log_id | ||
|
||
:type: bytes | ||
|
||
An opaque identifier, indicating which log this SCT is from. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: Mention this is the hash of the log's public key? Or could refer to the RFC. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good call. |
||
|
||
.. attribute:: timestamp | ||
|
||
:type: :class:`datetime.datetime` | ||
|
||
A naïve datetime representing the timestamp at which the log asserts | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The timestamps from logs are always in UTC. Not sure how it affects this field, if at all. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @reaperhulk what do you think? The There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That is exactly why. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We document that as stating they're naïve datetimes representing UTC in the x509 docs. |
||
the certificate had been submitted to it. | ||
|
||
.. attribute:: entry_type | ||
|
||
:type: | ||
:class:`~cryptography.x509.certificate_transparency.LogEntryType` | ||
|
||
The type of submission to the log that this SCT is for. Log submissions | ||
can either be certificates themselves or "pre-certificates" which | ||
indicate a binding-intent to issue a certificate for the same data, | ||
with SCTs embedded in it. | ||
|
||
|
||
.. class:: Version | ||
|
||
.. versionadded:: 1.9 | ||
|
||
An enumeration for SignedCertificateTimestamp versions. | ||
|
||
.. attribute:: v1 | ||
|
||
For version 1 SignedCertificateTimestamps. | ||
|
||
.. class:: LogEntryType | ||
|
||
.. versionadded:: 1.9 | ||
|
||
An enumeration for SignedCertificateTimestamp log entry types. | ||
|
||
.. attribute:: X509_CERTIFICATE | ||
|
||
For SCTs corresponding to X.509 certificates. | ||
|
||
.. attribute:: PRE_CERTIFICATE | ||
|
||
For SCTs corresponding to pre-certificates. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# This file is dual licensed under the terms of the Apache License, Version | ||
# 2.0, and the BSD License. See the LICENSE file in the root of this repository | ||
# for complete details. | ||
|
||
from __future__ import absolute_import, division, print_function | ||
|
||
import abc | ||
from enum import Enum | ||
|
||
import six | ||
|
||
|
||
class LogEntryType(Enum): | ||
X509_CERTIFICATE = 0 | ||
PRE_CERTIFICATE = 1 | ||
|
||
|
||
class Version(Enum): | ||
v1 = 0 | ||
|
||
|
||
@six.add_metaclass(abc.ABCMeta) | ||
class SignedCertificateTimestamp(object): | ||
@abc.abstractproperty | ||
def version(self): | ||
""" | ||
Returns the SCT version. | ||
""" | ||
|
||
@abc.abstractproperty | ||
def log_id(self): | ||
""" | ||
Returns an identifier indicating which log this SCT is for. | ||
""" | ||
|
||
@abc.abstractproperty | ||
def timestamp(self): | ||
""" | ||
Returns the timestamp for this SCT. | ||
""" | ||
|
||
@abc.abstractproperty | ||
def entry_type(self): | ||
""" | ||
Returns whether this is an SCT for a certificate or pre-certificate. | ||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the acceptable time period something each log decides?