pax_global_header 0000666 0000000 0000000 00000000064 13322546413 0014515 g ustar 00root root 0000000 0000000 52 comment=9e582b829b15483b90c58104da1b2133009f7d32
caucase-9e582b829b15483b90c58104da1b2133009f7d32/ 0000775 0000000 0000000 00000000000 13322546413 0017533 5 ustar 00root root 0000000 0000000 caucase-9e582b829b15483b90c58104da1b2133009f7d32/.coveragerc 0000664 0000000 0000000 00000000112 13322546413 0021646 0 ustar 00root root 0000000 0000000 [run]
branch = true
concurrency = thread
parallel = true
source = caucase
caucase-9e582b829b15483b90c58104da1b2133009f7d32/.gitignore 0000664 0000000 0000000 00000000124 13322546413 0021520 0 ustar 00root root 0000000 0000000 /htmlcov/
/cover/
/.eggs/
/.coverage
/build/
/caucase.egg-info/
/dist/
.*.swp
*.pyc
caucase-9e582b829b15483b90c58104da1b2133009f7d32/.pylintrc 0000664 0000000 0000000 00000000534 13322546413 0021402 0 ustar 00root root 0000000 0000000 [MESSAGES CONTROL]
disable=C0103,C0330,R0903,R0913,R0914,R0912,R0915,R0902
# C0103 "Invalid name "%s" (should match %s)"
# C0330 bad-continuation
# R0903 too-few-public-methods
# R0913 too-many-arguments
# R0914 too-many-locals
# R0912 too-many-branches
# R0915 too-many-statements
# R0902 too-many-instance-attributes
[FORMAT]
indent-string=" "
caucase-9e582b829b15483b90c58104da1b2133009f7d32/CHANGES.txt 0000664 0000000 0000000 00000003751 13322546413 0021352 0 ustar 00root root 0000000 0000000 ?.?.? (20??-??-??)
==================
* Add support for listening to multiple specific addresses in caucased.
* shell implementation does not rely on an external file anymore.
0.9.2 (2017-11-03)
==================
* Add support for migrating an existing CA to caucase: import CA cert and CRLs.
* Require CRL signature checks (bumps cryptography module version requirements).
* Provide CRL distribution point extension in CA certificates.
* Play nicer with http:
* Catch more errors to provide nice status codes
* Add support for "Transfer-Encoding: chunked"
* Add support for "Expect: 100-continue"
* Produce TLS-compliant certificates (domain name must be in an alternative name extension, subject is not enough).
* Reduce speed requirements in tests.
* Add shell implementation of "caucase" command.
* Certificate renewal bypasses pending CSR limits.
* caucase-manage: new command for offline database maintenance.
0.9.1 (2017-09-21)
==================
* Documentation improvements
* Packaging improvements
0.9.0 (2017-08-02)
==================
* implement the "cau" half of "caucase"
* massive rework: removal of flask dependency, removal of HTML UI, rework of
the REST API, rework of the CLI tools, rework of the WGSI application,
incomatible redesign of the database.
0.1.4 (2017-07-21)
==================
* caucase web parameter 'auto-sign-csr-amount' can be used to set how many csr must be signed automatically.
0.1.3 (2017-06-30)
==================
* add support for backup caucase database to cli
* serial is a random unique formatted hexadecimal number get from the csr_id
* allow to set custom subject (X509Name) when signing a certificate
* add new cliweb command which when required will download/update crl file from caucase web
0.1.2 (2017-05-12)
==================
* cliweb: renew now takes threshold option to check if renew is required and optional on-renew script to run after certificate renewal
0.1.1 (2017-04-27)
==================
* initial implementation of certificate authority
caucase-9e582b829b15483b90c58104da1b2133009f7d32/CONTRIBUTING.txt 0000664 0000000 0000000 00000000403 13322546413 0022200 0 ustar 00root root 0000000 0000000 - Run pylint after changing python code:
pylint caucase
- Run shellcheck after changing shell code:
shellcheck caucase.sh
- Produce coverage report from tests after changing python code:
coverage run -m caucase.test && coverage combine && coverage html
caucase-9e582b829b15483b90c58104da1b2133009f7d32/COPYING 0000664 0000000 0000000 00000104513 13322546413 0020572 0 ustar 00root root 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
caucase-9e582b829b15483b90c58104da1b2133009f7d32/MANIFEST.in 0000664 0000000 0000000 00000000044 13322546413 0021267 0 ustar 00root root 0000000 0000000 include CHANGES.txt
include COPYING
caucase-9e582b829b15483b90c58104da1b2133009f7d32/README.rst 0000664 0000000 0000000 00000031032 13322546413 0021221 0 ustar 00root root 0000000 0000000 =======
caucase
=======
Certificate Authority for Users, Certificate Authority for SErvices
Overview
========
The goal of caucase is to automate certificate issuance and renewal without
constraining how the certificate will be used.
For example, there is no assumption that the certificate will be used to
secure HTTP, nor to serve anything at all: you may need certificates to
authenticate users, or sign your mails, or secure an SQL server socket.
As an unfortunate consequence, it is not possible for caucase to automatically
validate a signing request content against a service (ex: as one could check
the certificate for an HTTPS service was requested by someone with the ability
to make it serve a special file).
This also means that, while caucase imposes RFC-recommended constraints on many
certificate fields and extensions to be worthy of trust, it imposes no
constraint at all on subject and alternate subject certificate fields.
To still allow certificates to be used, caucase uses itself to authenticate
users (humans or otherwise) who implement the validation procedure: they tell
caucase what certificates to emit. Once done, any certificate can be
prolungated at a simple request of the key holder while the to-renew
certificate is still valid (not expired, not revoked).
Bootstrapping the system (creating the first service certificate for
_`caucased` to operate on HTTPS, and creating the first user certificate to
control further certificate issuance) works by caucase automatically signing a
set number of certificates upon submission.
Vocabulary
==========
Caucase manipulates the following asymetric cryptography concepts.
- Key pair: A private key and corresponding public key. The public key can be
derived from the private key, but not the other way around. As a consequence,
the private key is itself considered to be a key pair.
- Certificate: A certificate is the assurante, by a certificate authority,
that a given public key and set of attributes belong to an authorised entity.
Abbreviated cert or crt. A certificate is by definition signed by a CA.
- Certificate Authority: An entry, arbitrarily trusted (but worthy of trust by
its actions and decision) which can issue certificates. Abbreviated CA.
- Certificate signing request: A document produced by an entity desiring to get
certified, which they send to a certificate authority. The certificate signing
request contains the public key and desired set of attributes that the CA
should pronounce itself on. The CA has all liberty to issue a different set
of attiributes, or to not issue a certificate.
- Certificate revocation list: Lists the certificates which were issued by a CA
but which should not be trusted annymore. This can happen for a variety of
reasons: the private key was compromised, or its owneing entity should not be
trusted anymore (ex: entity's permission to access to protected service was
revoked).
- PEM: A serialisation mechanism commonly used for various cryptographic data
pieces. It relies on base64 so it is 7-bits-safe (unlike DER), and is very
commonly supported. Caucase exclusively uses PEM format.
Validity period
===============
Cryptographic keys wear out as are used and and as they age.
Of course, they do not bit-rot nor become thinner with use. But each time one
uses a key and each minute an attacker had access to a public key, fractions
of the private key bits are inevitably leaked, weakening it overall.
So keys must be renewed periodically to preserve intended security level. So
there is a limited life span to each certificate, including the ones emitted by
caucase.
The unit duration for caucase-emitted certificates is the "normal" certificate
life span. It default to 93 days from the moment the certificate was signed,
or about 3 months.
Then the CA certificate has a default life span of 4 "normal" certificate
validity periods. As CA renewal happens in caucase without x509-level cross
signing (by decision, to avoid relying on intermediate CA support on
certificate presenter side and instead rely on more widespread
multi-CA-certificate support on virifier side), there is a hard lower bound of
3 validity periods, under which the CA certificate cannot be reliably renewed
without risking certificate validation issues for emitted "normal"
certificates. CA certificate renewal is composed of 2 phases:
- Passive distribution phase: current CA certificate has a remaining life span
of less than 2 "normal" certificate life spans: a new CA certificate is
generated and distributed on-demand (on "normal" certificate renewal and
issuance, on CRL retrieval with caucase tools...), but not used to sign
anything.
- Active use phase: new CA certificate is valid for more than one "normal"
certificate life span. This means that all existing certificates which are
still in active use had to be renewed at least once since the new CA
certificate exists. This means all the certificate holders had the
opportunity to learn about the new CA certificate. So the new CA certificate
starts being used to sign new certificates, and the old CA certificate falls
out of use as its signed "normal" certificates expire.
By default, all caucase tools will generate a new private key unrelated to the
previous one on each certificat renewal.
Lastly, there is another limited validity period, although not for the same
reasons: the list of revoked certificates also has a maximum life span. In
caucase, the CRL is re-generated whenever it is requested and:
- there is no previous CRL
- previous CRL expired
- any revocation happened since previous CRL was created
Commands
========
Caucase provides several commands to work with certificates.
caucase
+++++++
Reference caucase "one-shot" client.
This command is intended to be used for isolated actions:
- listing and signing pending certificate signature requests
- revoking certificates
It is also able to submit certificate signing requests, retrieve signed
certificates, requesting certificate renewals and updating both
CA certificates and revocation lists, but you may be interested in using
_`caucase-updater` for this instead.
caucase-updater
+++++++++++++++
Reference caucase certificate renewal daemon.
Monitors a key pair, corresponding CA certificate and CRL, and renew them
before expiration.
When the key-pair lacks a signed certificate, issues a pre-existing CSR to
caucase server and waits for the certificate to be issued.
caucase-probe
+++++++++++++
Caucase server availability tester.
Performs minimal checks to verify a caucase server is available at given URL.
caucase-rerequest
+++++++++++++++++
Utility allowing to re-issue a CSR using a locally-generated private key.
Intended to be used in conjunction with _`caucase-updater` when user cannot
generate the CSR on the system where the certificate is desired (ex: automated
HTTPS server deployment), where user is not the intended audience for
caucase-produced certificate:
- User generates a CSR on their own system, and signs it with any key (it will
not be needed later
- User sends the CSR to the system where the certificate is desired
- User gets caucase-rerequest to run on this CSR, producing a new private key
and a CSR similar to issued one, but signed with this new private key
- From then on, caucase-updater can take over
This way, no private key left their original system, and user could still
freely customise certificate extensions.
caucase-key-id
++++++++++++++
Utility displaying the identifier of given key, or the identifier of keys
involved in given backup file.
Allows identifying users which hold a private key candidate for restoring a
caucased backup (see _`Restoration procedure`).
caucased
++++++++
Reference caucase server daemon.
This daemon provides access to both CAU and CAS services over both HTTP and
HTTPS.
It handles its own certificate issuance and renewal, so there is no need to use
_`caucase-updater` for this service.
Backups
-------
Loosing the CA private key prevents issuing any new certificate trusted by
services which trusted the CA. Also, it prevents issuing any new CRL.
Recovering from such total loss requires starting a new CA and rolling it out
to all services which used the previous one. This is very time-costly.
So backups are required.
On the other hand, if someone gets their hand on the CA private key, they can
issue certificates for themselves, allowing them to authenticate with services
trusting the CA managed by caucase - including caucased itself if they issue a
user certificate: they can then revoke existing certificates and cause a lot of
damage.
So backups cannot happen in clear text, they must be encrypted.
But the danger of encrypted backups is that by definition they become worthless
if they cannot be decrypted. So as many (trusted) entities as possible should
be granted the ability to decrypt the backups.
The solution proposed by caucased is to encrypt produced backups in a way which
allows any of the caucase users to decrypt the archive.
As these users are already entrusted with issuing certificates, this puts
only a little more power in their hands than they already have. The little
extra power they get is that by having unrestricted access to the CA private
key they can issue certificates bypassing all caucase restrictions. The
proposed parade is to only make the backups available to a limited subset of
caucase users when there is an actual disaster, and otherwise keep it out of
their reach. This mechanism is not handled by caucase.
As there are few trusted users, caucase can keep their still-valid certificates
in its database for the duration of their validity with minimal size cost.
Backup procedure
----------------
Backups happen periodically as long as caucased is running. See
`--backup-period` and `--backup-directory`.
As discussed above, produced files should be kept out of reach of caucase
users until a disaster happens.
Restoration procedure
---------------------
See `caucased-manage --restore-backup`.
To restore, one of the trusted users must voluntarily compromise their own
private key, providing it to the administrator in charge of the restoration
procedure. Restoration procedure will hence immediately revoke their
certificate. They must also provide a CSR generated with a different private
key, so that caucase can provide them with a new certificate, so they keep
their access only via different credentials.
- admin identifies the list of keys which can decipher a backup, and broadcasts
that list to key holders
- key holders manifest themselves
- admin picks a key holder, requests them to provide their existing private key
and to generate a new key and accompanying csr
- key holder provide requested items
- admin initiates restoration with `--restore-backup` and provides key holder
with replacement certificate
- admin starts caucased, service is back online.
Backup file format
------------------
- 64bits: 'caucase\0' magic string
- 32bits LE: header length
- header: json-encoded header (see below)
- encrypted byte stream (aka payload)
Header schema (inspired from s/mime, but s/mime tools available do not
support at least iterative production or iterative generation)::
{
"description": "Caucase backup header",
"required": ["algorithm", "key_list"],
"properties": {
"cipher": {
"description": "Symetric ciher used for payload",
"required": ["name"],
"properties": {
"name":
"enum": ["aes256_cbc_pkcs7_hmac_10M_sha256"],
"type": "string"
},
"parameter": {
"description": "Name-dependend clear cipher parameter (ex: IV)",
"type": "string"
}
}
"type": "object"
},
"key_list": {
"description": "Content key, encrypted with public keys",
"minItems": 1,
"items": {
"required": ["id", "cipher", "key"],
"properties": {
"id": {
"description": "Hex-encoded sha1 hash of the public key",
"type": "string"
},
"cipher": {
"description": "Asymetric cipher used for symetric key",
"required": ["name"],
"properties": {
"name": {
"enum": ["rsa_oaep_sha1_mgf1_sha1"],
"type": "string"
}
},
"type": "object"
}
"key": {
"description": "Hex-encoded encrypted concatenation of signing and symetric encryption keys",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
caucase-9e582b829b15483b90c58104da1b2133009f7d32/TODO.rst 0000664 0000000 0000000 00000000164 13322546413 0021033 0 ustar 00root root 0000000 0000000 Eventually
==========
- Become an OCSP responder (requires support in other libraries - likely pyca/cryptography).
caucase-9e582b829b15483b90c58104da1b2133009f7d32/caucase/ 0000775 0000000 0000000 00000000000 13322546413 0021137 5 ustar 00root root 0000000 0000000 caucase-9e582b829b15483b90c58104da1b2133009f7d32/caucase/__init__.py 0000664 0000000 0000000 00000001544 13322546413 0023254 0 ustar 00root root 0000000 0000000 # This file is part of caucase
# Copyright (C) 2017-2018 Nexedi
# Alain Takoudjou
# Vincent Pelletier
#
# caucase is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# caucase is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with caucase. If not, see .
"""
Caucase - Certificate Authority for Users, Certificate Authority for SErvices
"""
caucase-9e582b829b15483b90c58104da1b2133009f7d32/caucase/ca.py 0000664 0000000 0000000 00000077535 13322546413 0022115 0 ustar 00root root 0000000 0000000 # This file is part of caucase
# Copyright (C) 2017-2018 Nexedi
# Alain Takoudjou
# Vincent Pelletier
#
# caucase is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# caucase is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with caucase. If not, see .
"""
Caucase - Certificate Authority for Users, Certificate Authority for SErvices
"""
from __future__ import absolute_import
import datetime
import json
import os
import struct
import threading
from cryptography import x509
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives import serialization, hashes, hmac
from cryptography.hazmat.primitives.asymmetric import rsa
from cryptography.hazmat.primitives.asymmetric.padding import OAEP, MGF1
from cryptography.hazmat.primitives import padding
from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
from . import utils
from .exceptions import (
CertificateVerificationError,
NotACertificateSigningRequest,
)
__all__ = ('CertificateAuthority', 'UserCertificateAuthority', 'Extension')
_cryptography_backend = default_backend()
_AUTO_SIGNED_NO = 0
_AUTO_SIGNED_YES = 1
_AUTO_SIGNED_PASSTHROUGH = 2
_SUBJECT_OID_DICT = {
# pylint: disable=bad-whitespace
'C' : x509.oid.NameOID.COUNTRY_NAME,
'O' : x509.oid.NameOID.ORGANIZATION_NAME,
'OU': x509.oid.NameOID.ORGANIZATIONAL_UNIT_NAME,
'ST': x509.oid.NameOID.STATE_OR_PROVINCE_NAME,
'CN': x509.oid.NameOID.COMMON_NAME,
'L' : x509.oid.NameOID.LOCALITY_NAME,
'SN': x509.oid.NameOID.SURNAME,
'GN': x509.oid.NameOID.GIVEN_NAME,
# pylint: enable=bad-whitespace
}
_BACKUP_MAGIC = 'caucase\0'
_CONFIG_NAME_AUTO_SIGN_CSR_AMOUNT = 'auto_sign_csr_amount'
def Extension(value, critical):
"""
Avoid oid redundant parameter when creating an extension.
"""
return x509.Extension(
oid=value.oid,
critical=critical,
value=value,
)
class CertificateAuthority(object):
"""
This class implements CA policy and lifetime logic:
- how CA key pair is generated
- what x509.3 extensions and attributes are enforced on signed certificates
- CA and CRL automated renewal
"""
def __init__(
self,
storage,
ca_subject_dict=(),
ca_key_size=2048,
crt_life_time=31 * 3, # Approximately 3 months
ca_life_period=4, # Approximately a year
crl_renew_period=0.33, # Approximately a month
crl_base_url=None,
digest_list=utils.DEFAULT_DIGEST_LIST,
auto_sign_csr_amount=0,
lock_auto_sign_csr_amount=False,
):
"""
storage (caucase.storage.Storage)
Persistent storage of certificate authority data.
ca_subject_dict (dict)
Items to use as Certificate Authority certificate subject.
Supported keys are: C, O, OU, ST, CN, L, SN, GN.
ca_key_size (int, None)
Number of bits to use as Certificate Authority key.
None to disable CA renewal.
crt_life_time (float)
Validity duration for every issued certificate, in days.
ca_life_period (float)
Number of crt_life_time periods for which Certificate Authority
certificate will be valid.
Must be greater than 3 to allow smooth rollout.
crl_renew_period (float)
Number of crt_life_time periods for which a revocation list is
valid for.
crl_base_url (str)
The CRL distribution URL to include in signed certificates.
None to not declare a CRL distribution point in generated certificates.
Revocations are be functional even if this is None.
digest_list (list of str)
List of digest algorithms considered acceptable for authenticating
renewal and revocation requests, and CA renewal list responses.
The first item will be the one used, others are accepted but not used.
auto_sign_csr_amount (int)
Automatically sign the first CSRs.
As certificate gets unconditionally emitted and only vital attributes
and extensions are forced during signature, you should choose the
smallest amount possible to get a functional service.
For a typical HTTP(S) caucase service, 1 should be enough for CAS usage
(first service certificate being to serve HTTPS for caucase), and 1 for
CAU usage (first user, which can then sign more user certificate
requests).
To verify nothing accessed the service before intended automated
requests, check issued certificate has an extension with OID:
2.25.285541874270823339875695650038637483517.0
(a message is printed when retrieving the certificate)
This mark is propagated during certificate renewal.
lock_auto_sign_csr_amount (bool)
When given with a true value, auto_sign_csr_amount is stored and the
value given on later instanciation will be ignored.
"""
self._storage = storage
self._ca_renewal_lock = threading.Lock()
if lock_auto_sign_csr_amount:
storage.setConfigOnce(
_CONFIG_NAME_AUTO_SIGN_CSR_AMOUNT,
auto_sign_csr_amount,
)
self._auto_sign_csr_amount = int(storage.getConfigOnce(
_CONFIG_NAME_AUTO_SIGN_CSR_AMOUNT,
auto_sign_csr_amount,
))
self._ca_key_size = ca_key_size
self._digest_list = digest_list
self._default_digest_class = getattr(hashes, self.digest_list[0].upper())
self._crt_life_time = datetime.timedelta(crt_life_time, 0)
self._crl_base_url = crl_base_url
self._ca_subject = x509.Name([
x509.NameAttribute(
oid=_SUBJECT_OID_DICT[key],
value=value,
)
for key, value in dict(ca_subject_dict).iteritems()
])
if ca_life_period < 3:
raise ValueError("ca_life_period must be >= 3 to allow CA rollout")
self._crl_life_time = datetime.timedelta(
crt_life_time * crl_renew_period,
0,
)
self._ca_life_time = datetime.timedelta(crt_life_time * ca_life_period, 0)
self._loadCAKeyPairList()
self._renewCAIfNeeded()
@property
def digest_list(self):
"""
Read-only access to digest_list ctor parameter.
"""
return list(self._digest_list)
def _loadCAKeyPairList(self):
ca_key_pair_list = []
for pem_key_pair in self._storage.getCAKeyPairList():
utils.validateCertAndKey(
pem_key_pair['crt_pem'],
pem_key_pair['key_pem'],
)
ca_key_pair_list.append({
'crt': utils.load_ca_certificate(pem_key_pair['crt_pem']),
'key': utils.load_privatekey(pem_key_pair['key_pem']),
})
self._ca_key_pairs_list = ca_key_pair_list
def getCertificateSigningRequest(self, csr_id):
"""
Retrieve a PEM-encoded certificate signing request.
csr_id (int)
As returned when the CSR was stored.
"""
return self._storage.getCertificateSigningRequest(csr_id)
def appendCertificateSigningRequest(self, csr_pem, override_limits=False):
"""
Store certificate signing request and return its identifier.
May trigger its signature if the quantity of submitted CSRs is less than
auto_sign_csr_amount (see __init__).
csr_pem (str)
PEM-encoded certificate signing request.
"""
try:
csr = utils.load_certificate_request(csr_pem)
except ValueError:
raise NotACertificateSigningRequest
# Note: requested_amount is None when a known CSR is re-submitted
csr_id, requested_amount = self._storage.appendCertificateSigningRequest(
csr_pem=csr_pem,
key_id=x509.SubjectKeyIdentifier.from_public_key(
csr.public_key(),
).digest.encode('hex'),
override_limits=override_limits,
)
if requested_amount is not None and \
requested_amount <= self._auto_sign_csr_amount:
# if allowed to sign this certificate automaticaly
self._createCertificate(csr_id, auto_signed=_AUTO_SIGNED_YES)
return csr_id
def deletePendingCertificateSigningRequest(self, csr_id):
"""
Reject a pending certificate signing request.
csr_id (int)
CSR id, as returned when the CSR was stored.
"""
self._storage.deletePendingCertificateSigningRequest(csr_id)
def getCertificateRequestList(self):
"""
Return the list of pending certificate signature requests, individually
PEM-encoded.
"""
return self._storage.getCertificateSigningRequestList()
def createCertificate(self, csr_id, template_csr=None):
"""
Sign a pending certificate signing request, storing produced certificate.
csr_id (int)
CSR id, as returned when the CSR was stored.
template_csr (None or X509Req)
Copy extensions and subject from this CSR instead of stored one.
Useful to renew a certificate.
Public key is always copied from stored CSR.
"""
self._createCertificate(
csr_id=csr_id,
auto_signed=_AUTO_SIGNED_NO,
template_csr=template_csr,
)
def _createCertificate(self, csr_id, auto_signed, template_csr=None):
"""
auto_signed (bool)
When True, mark certificate as having been auto-signed.
When False, prevent such mark from being set.
When None, do not filter (useful when renewing).
tempate_csr (None or X509Req)
Copy extensions and subject from this CSR instead of stored one.
Useful to renew a certificate.
Public key is always copied from stored CSR.
"""
csr_pem = self._storage.getCertificateSigningRequest(csr_id)
csr = utils.load_certificate_request(csr_pem)
if template_csr is None:
template_csr = csr
ca_key_pair = self._getCurrentCAKeypair()
ca_crt = ca_key_pair['crt']
public_key = csr.public_key()
subject_key_identifier = x509.SubjectKeyIdentifier.from_public_key(
public_key,
)
now = datetime.datetime.utcnow()
builder = x509.CertificateBuilder(
subject_name=template_csr.subject,
issuer_name=ca_crt.subject,
not_valid_before=now,
not_valid_after=now + self._crt_life_time,
serial_number=x509.random_serial_number(),
public_key=public_key,
extensions=[
Extension(
x509.BasicConstraints(
ca=False,
path_length=None,
),
critical=True, # "MAY appear as critical or non-critical"
),
Extension(
subject_key_identifier,
critical=False, # "MUST mark this extension as non-critical"
),
Extension(
x509.AuthorityKeyIdentifier.from_issuer_subject_key_identifier(
ca_crt.extensions.get_extension_for_class(
x509.SubjectKeyIdentifier,
),
),
critical=False, # "MUST mark this extension as non-critical"
),
],
)
if self._crl_base_url:
builder = builder.add_extension(
x509.CRLDistributionPoints([
x509.DistributionPoint(
full_name=[
x509.UniformResourceIdentifier(self._crl_base_url),
],
relative_name=None,
crl_issuer=None,
reasons=None,
),
]),
critical=False, # "SHOULD be non-critical"
)
try:
key_usage_extension = template_csr.extensions.get_extension_for_class(
x509.KeyUsage,
)
except x509.ExtensionNotFound:
pass
else:
key_usage = key_usage_extension.value
if key_usage.key_agreement:
encipher_only = key_usage.encipher_only
decipher_only = key_usage.decipher_only
else:
encipher_only = decipher_only = False
builder = builder.add_extension(
x509.KeyUsage(
# pylint: disable=bad-whitespace
digital_signature =key_usage.digital_signature,
content_commitment=key_usage.content_commitment,
key_encipherment =key_usage.key_encipherment,
data_encipherment =key_usage.data_encipherment,
key_agreement =key_usage.key_agreement,
key_cert_sign =False,
crl_sign =False,
encipher_only =encipher_only,
decipher_only =decipher_only,
# pylint: enable=bad-whitespace
),
# "SHOULD mark this extension critical"
critical=key_usage_extension.critical,
)
try:
extended_key_usage = template_csr.extensions.get_extension_for_class(
x509.ExtendedKeyUsage,
)
except x509.ExtensionNotFound:
pass
else:
builder = builder.add_extension(
x509.ExtendedKeyUsage(
[
x for x in extended_key_usage.value
if x != x509.oid.ExtendedKeyUsageOID.OCSP_SIGNING
]
),
critical=extended_key_usage.critical,
)
try:
subject_alt_name = template_csr.extensions.get_extension_for_class(
x509.SubjectAlternativeName,
)
except x509.ExtensionNotFound:
pass
else:
# Note: as issued certificates may be used without any subject
# validation (ex: connecting to mariadb via a variable IP), we
# voluntarily do not enforce any constraint on subjectAltName.
builder = builder.add_extension(
subject_alt_name.value,
critical=subject_alt_name.critical,
)
# subjectDirectoryAttributes ?
try:
certificate_policies = template_csr.extensions.get_extension_for_class(
x509.CertificatePolicies,
)
except x509.ExtensionNotFound:
if auto_signed == _AUTO_SIGNED_YES:
builder = builder.add_extension(
x509.CertificatePolicies([
utils.CAUCASE_POLICY_INFORMATION_AUTO_SIGNED,
]),
critical=False, # (no recommendations)
)
else:
if auto_signed == _AUTO_SIGNED_PASSTHROUGH:
# Caller is asking us to let all through, so do this.
policy_list = certificate_policies.value
else:
# Prevent any caucase extension from being smuggled, especiall the
# "auto-signed" one...
policy_list = [
x for x in certificate_policies.value
if not x.policy_identifier.dotted_string.startswith(
utils.CAUCASE_OID_TOP,
)
]
if auto_signed == _AUTO_SIGNED_YES:
# ...but do add auto-signed extension if we are auto-signing.
policy_list.append(utils.CAUCASE_POLICY_INFORMATION_AUTO_SIGNED)
builder = builder.add_extension(
x509.CertificatePolicies(policy_list),
critical=certificate_policies.critical, # (no recommendations)
)
cert_pem = utils.dump_certificate(builder.sign(
private_key=ca_key_pair['key'],
algorithm=self._default_digest_class(),
backend=_cryptography_backend,
))
self._storage.storeCertificate(csr_id, cert_pem)
return cert_pem
def getCertificate(self, csr_id):
"""
Return PEM-encoded signed certificate.
csr_id (int)
As returned when the corresponding CSR was stored.
"""
return self._storage.getCertificate(csr_id)
def _renewCAIfNeeded(self):
"""
Create a new CA certificate if latest one has less than two
ca_life_periods of validity left.
Updates self._ca_key_pairs_list .
"""
if (
self._ca_key_size is not None and not self._ca_key_pairs_list or (
self._ca_key_pairs_list[-1]['crt'].not_valid_after -
datetime.datetime.utcnow()
).total_seconds() / self._crt_life_time.total_seconds() <= 2
) and self._ca_renewal_lock.acquire(False):
try:
# No CA certificate at all or less than 2 certificate validity periods
# left with latest CA certificate. Prepare the next one so it starts
# getting distributed.
private_key = rsa.generate_private_key(
public_exponent=65537,
key_size=self._ca_key_size,
backend=_cryptography_backend,
)
if self._ca_key_pairs_list:
latest_crt = self._ca_key_pairs_list[-1]['crt']
subject = latest_crt.subject
extension_list = latest_crt.extensions
else:
# Provide a default subject extension set.
subject = self._ca_subject
extension_list = [
Extension(
x509.BasicConstraints(
ca=True,
path_length=0,
),
critical=True, # "MUST mark the extension as critical"
),
Extension(
x509.KeyUsage(
# pylint: disable=bad-whitespace
digital_signature =False,
content_commitment=False,
key_encipherment =False,
data_encipherment =False,
key_agreement =False,
key_cert_sign =True,
crl_sign =True,
encipher_only =False,
decipher_only =False,
# pylint: enable=bad-whitespace
),
critical=True, # "SHOULD mark this extension critical"
),
# Should we make use of certificate policies ? If we do, we need to enable
# this extension and fill the values.
# Extension(
# x509.PolicyConstraints(
# require_explicit_policy=,
# inhibit_policy_mapping=,
# ),
# critical=True, # MUST mark this extension as critical
# ),
]
public_key = private_key.public_key()
subject_key_identifier = x509.SubjectKeyIdentifier.from_public_key(
public_key,
)
now = datetime.datetime.utcnow()
crt_builder = x509.CertificateBuilder(
subject_name=subject,
issuer_name=subject,
not_valid_before=now,
not_valid_after=now + self._ca_life_time,
serial_number=x509.random_serial_number(),
public_key=public_key,
extensions=[
Extension(
subject_key_identifier,
critical=False, # "MUST mark this extension as non-critical"
),
Extension(
x509.AuthorityKeyIdentifier.from_issuer_subject_key_identifier(
# Dummy extension, from_issuer_subject_key_identifier accesses
# .data directly
Extension(
subject_key_identifier,
critical=False,
),
),
critical=False, # "MUST mark this extension as non-critical"
),
],
)
# Copy all extensions, except the ones which depend on the key (and
# which we just set).
skipped_extension_oid_set = (
x509.SubjectKeyIdentifier.oid,
x509.AuthorityKeyIdentifier.oid,
)
for extension in extension_list:
if extension.oid not in skipped_extension_oid_set:
crt_builder = crt_builder.add_extension(
extension.value,
extension.critical,
)
certificate = crt_builder.sign(
private_key=private_key,
algorithm=self._default_digest_class(),
backend=_cryptography_backend,
)
self._storage.appendCAKeyPair(
utils.datetime2timestamp(certificate.not_valid_after),
{
'key_pem': utils.dump_privatekey(private_key),
'crt_pem': utils.dump_certificate(certificate),
},
)
self._loadCAKeyPairList()
assert self._ca_key_pairs_list
finally:
self._ca_renewal_lock.release()
def _getCurrentCAKeypair(self):
"""
Return the currently-active CA certificate key pair.
Currently-active CA certificate is the CA to use when signing. It may not
be the latest one, as all certificate holders must know the latest one
before its use can start.
"""
self._renewCAIfNeeded()
now = datetime.datetime.utcnow()
for key_pair in reversed(self._ca_key_pairs_list):
if key_pair['crt'].not_valid_before + self._crt_life_time < now:
# This CA cert is valid for more than one certificate life time,
# we can assume clients to know it (as they had to renew their
# cert at least once since it became available) so we can start
# using it.
break
else:
# No CA cert is valid for more than one certificate life time, so just
# pick the newest one.
key_pair = self._ca_key_pairs_list[-1]
return key_pair
def getCACertificate(self):
"""
Return current CA certificate, PEM-encoded.
"""
return utils.dump_certificate(self._getCurrentCAKeypair()['crt'])
def getCACertificateList(self):
"""
Return the current list of CA certificates as X509 obbjects.
"""
self._renewCAIfNeeded()
return [x['crt'] for x in self._ca_key_pairs_list]
def getValidCACertificateChain(self):
"""
Return the CA certificate chain based on oldest CA certificate.
Each item in the chain is a wrapped dict with the following keys:
old (str)
N-1 certificate as PEM, used to check wrapper signature.
If item is the first in the chain, this is the oldest CA certificate
server still knows about.
new (str)
N certificate as PEM.
The intent is for a client knowing one CA certificate to retrieve any newer
CA certificate and autonomously decide if it may trust them: each item is
signed with the previous certificate. The oldest CA certificate is not
returned in this list, as it cannot be signed by another one.
CA user must check that there is an uninterrupted signed path from its
already-known CA certificate to use any contained "new" certificate.
It must skip any certificate pair for which it does not already trust
an ancestor certificate.
Note: the chain may contain expired CA certificates. CA user should skip
these, and consider their signature invalid for CA chain validation
purposes.
"""
self._renewCAIfNeeded()
result = []
iter_key_pair = iter(self._ca_key_pairs_list)
first_key_pair = iter_key_pair.next()
previous_crt_pem = utils.dump_certificate(first_key_pair['crt'])
previous_key = first_key_pair['key']
for key_pair in iter_key_pair:
current_crt_pem = utils.dump_certificate(key_pair['crt'])
result.append(utils.wrap(
{
'old_pem': previous_crt_pem,
'new_pem': current_crt_pem,
},
previous_key,
self.digest_list[0],
))
previous_key = key_pair['key']
previous_crt_pem = current_crt_pem
return result
def revoke(self, crt_pem):
"""
Revoke certificate.
crt_pem (str)
PEM-encoded certificat to revoke.
"""
crt = utils.load_certificate(
crt_pem,
self.getCACertificateList(),
x509.load_pem_x509_crl(
self.getCertificateRevocationList(),
_cryptography_backend,
),
)
self._storage.revoke(
serial=crt.serial_number,
expiration_date=utils.datetime2timestamp(crt.not_valid_after),
)
def revokeSerial(self, serial):
"""
Revoke a certificate by its serial only.
Revocation will expire when the latest CA certificate of this instance
expires, meaning it will stay longer in the revocation list than when
certificate expiration date can be retrieved from the certificate.
Also, there cannot be any check on the validity of the serial, typos
are accepted verbatim.
Using this method is hence not recomended.
"""
self._storage.revoke(
serial=serial,
expiration_date=utils.datetime2timestamp(max(
x.not_valid_after for x in self.getCACertificateList()
)),
)
def renew(self, crt_pem, csr_pem):
"""
Renew certificate.
crt_pem (str)
PEM-encoded certificate to renew.
csr_pem (str)
PEM-encoded certificate signing request.
"""
ca_cert_list = self.getCACertificateList()
crt = utils.load_certificate(
crt_pem,
ca_cert_list,
x509.load_pem_x509_crl(
self.getCertificateRevocationList(),
_cryptography_backend,
),
)
return self._createCertificate(
csr_id=self.appendCertificateSigningRequest(
csr_pem,
override_limits=True,
),
auto_signed=_AUTO_SIGNED_PASSTHROUGH,
# Do a dummy signature, just so we get a usable
# x509.CertificateSigningRequest instance. Use latest CA private key just
# because it is available for free (unlike generating a new one).
template_csr=x509.CertificateSigningRequestBuilder(
subject_name=crt.subject,
extensions=crt.extensions,
).sign(
private_key=self._ca_key_pairs_list[-1]['key'],
algorithm=self._default_digest_class(),
backend=_cryptography_backend,
),
)
def getCertificateRevocationList(self):
"""
Return PEM-encoded certificate revocation list.
"""
crl_pem = self._storage.getCertificateRevocationList()
if crl_pem is None:
ca_key_pair = self._getCurrentCAKeypair()
now = datetime.datetime.utcnow()
crl = x509.CertificateRevocationListBuilder(
issuer_name=ca_key_pair['crt'].issuer,
last_update=now,
next_update=now + self._crl_life_time,
extensions=[
Extension(
x509.CRLNumber(
self._storage.getNextCertificateRevocationListNumber(),
),
critical=False, # "MUST mark this extension as non-critical"
),
],
revoked_certificates=[
x509.RevokedCertificateBuilder(
serial_number=x['serial'],
revocation_date=datetime.datetime.fromtimestamp(
x['revocation_date'],
),
).build(_cryptography_backend)
for x in self._storage.getRevocationList()
],
).sign(
private_key=ca_key_pair['key'],
algorithm=self._default_digest_class(),
backend=_cryptography_backend,
)
crl_pem = crl.public_bytes(serialization.Encoding.PEM)
self._storage.storeCertificateRevocationList(
crl_pem,
expiration_date=utils.datetime2timestamp(crl.next_update),
)
return crl_pem
class UserCertificateAuthority(CertificateAuthority):
"""
Backup-able CertificateAuthority.
See backup schema in documentation.
"""
def doBackup(self, write):
"""
Backup the entire storage to given path, enciphering it using all stored
certificates.
"""
ca_cert_list = self.getCACertificateList()
crl = x509.load_pem_x509_crl(
self.getCertificateRevocationList(),
_cryptography_backend,
)
signing_key = os.urandom(32)
symetric_key = os.urandom(32)
iv = os.urandom(16)
encryptor = Cipher(
algorithms.AES(symetric_key),
modes.CBC(iv),
backend=_cryptography_backend,
).encryptor()
authenticator = hmac.HMAC(
signing_key,
hashes.SHA256(),
backend=_cryptography_backend,
)
HMAC_PAYLOAD_SIZE = 10 * 1024 * 1024
key_list = []
for crt_pem in self._storage.iterCertificates():
try:
crt = utils.load_certificate(crt_pem, ca_cert_list, crl)
except CertificateVerificationError:
continue
public_key = crt.public_key()
key_list.append({
'id': x509.SubjectKeyIdentifier.from_public_key(
public_key,
).digest.encode('hex'),
'cipher': {
'name': 'rsa_oaep_sha1_mgf1_sha1',
},
'key': public_key.encrypt(
signing_key + symetric_key,
OAEP(
mgf=MGF1(algorithm=hashes.SHA1()),
algorithm=hashes.SHA1(),
label=None,
),
).encode('hex'),
})
if not key_list:
# No users yet, backup is meaningless
return False
header = json.dumps({
'cipher': {
'name': 'aes256_cbc_pkcs7_hmac_10M_sha256',
'parameter': iv.encode('hex'),
},
'key_list': key_list,
})
padder = padding.PKCS7(128).padder()
write(_BACKUP_MAGIC)
write(struct.pack('= HMAC_PAYLOAD_SIZE:
chunk = buf[:HMAC_PAYLOAD_SIZE]
buf = buf[HMAC_PAYLOAD_SIZE:]
authenticator.update(chunk)
yield chunk
yield authenticator.copy().finalize()
if buf:
authenticator.update(buf)
yield buf
yield authenticator.finalize()
for chunk in signingIterator():
write(encryptor.update(padder.update(chunk)))
write(encryptor.update(padder.finalize()))
write(encryptor.finalize())
return True
@classmethod
def restoreBackup(
cls,
db_class,
db_path,
read,
key_pem,
csr_pem,
db_kw=(),
kw=(),
):
"""
Restore backup, revoke certificate corresponding to private key and sign
its renewal.
"""
magic = read(8)
if magic != _BACKUP_MAGIC:
raise ValueError('Invalid backup magic string')
header_len, = struct.unpack(
'= HMAC_SIGNED_SIZE:
signed = buf[:HMAC_SIGNED_SIZE]
buf = buf[HMAC_SIGNED_SIZE:]
chunk = signed[:-32]
authenticator.update(chunk)
authenticator.copy().verify(signed[-32:])
yield chunk
if buf:
chunk = buf[:-32]
authenticator.update(chunk)
authenticator.verify(buf[-32:])
yield chunk
db_class.restore(db_path=db_path, restorator=verificator())
# Now that the database is restored, use a CertificateAuthority to
# renew & revoke given private key.
self = cls(storage=db_class(db_path=db_path, **dict(db_kw)), **dict(kw))
# pylint: disable=protected-access
crt_pem = self._storage.getCertificateByKeyIdentifier(key_id)
# pylint: enable=protected-access
new_crt_pem = self.renew(crt_pem, csr_pem)
self.revoke(crt_pem)
return new_crt_pem
caucase-9e582b829b15483b90c58104da1b2133009f7d32/caucase/cli.py 0000664 0000000 0000000 00000065700 13322546413 0022270 0 ustar 00root root 0000000 0000000 # This file is part of caucase
# Copyright (C) 2017-2018 Nexedi
# Alain Takoudjou
# Vincent Pelletier
#
# caucase is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# caucase is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with caucase. If not, see .
"""
Caucase - Certificate Authority for Users, Certificate Authority for SErvices
"""
from __future__ import absolute_import
import argparse
import datetime
import httplib
import json
import os
import struct
import sys
from cryptography import x509
from cryptography.hazmat.backends import default_backend
from . import utils
from . import exceptions
from .client import (
CaucaseError,
CaucaseClient,
HTTPSOnlyCaucaseClient,
updateCAFile,
updateCRLFile,
)
_cryptography_backend = default_backend()
STATUS_ERROR = 1
STATUS_WARNING = 2
STATUS_CALLBACK_ERROR = 3
MODE_SERVICE = 'service'
MODE_USER = 'user'
class CLICaucaseClient(object):
"""
CLI functionalities
"""
# Note: this class it more to reduce local variable scopes (avoiding
# accidental mixups) in each methods than about API declaration.
def __init__(self, client):
self._client = client
def putCSR(self, csr_path_list):
"""
--send-csr
"""
for csr_path in csr_path_list:
csr_pem = utils.getCertRequest(csr_path)
# Quick sanity check
utils.load_certificate_request(csr_pem)
print self._client.createCertificateSigningRequest(csr_pem), csr_path
def getCSR(self, csr_id_path_list):
"""
--get-csr
"""
for csr_id, csr_path in csr_id_path_list:
csr_pem = self._client.getCertificateSigningRequest(int(csr_id))
with open(csr_path, 'a') as csr_file:
csr_file.write(csr_pem)
def getCRT(self, warning, error, crt_id_path_list, ca_list):
"""
--get-crt
"""
for crt_id, crt_path in crt_id_path_list:
crt_id = int(crt_id)
try:
crt_pem = self._client.getCertificate(crt_id)
except CaucaseError, e:
if e.args[0] != httplib.NOT_FOUND:
raise
try:
self._client.getCertificateSigningRequest(crt_id)
except CaucaseError, e:
if e.args[0] != httplib.NOT_FOUND:
raise
print crt_id, 'not found - maybe CSR was rejected ?'
error = True
else:
print crt_id, 'CSR still pending'
warning = True
else:
print crt_id,
if utils.isCertificateAutoSigned(utils.load_certificate(
crt_pem,
ca_list,
None,
)):
print 'was (originally) automatically approved'
else:
print 'was (originally) manually approved'
if os.path.exists(crt_path):
try:
key_pem = utils.getKey(crt_path)
except ValueError:
print >>sys.stderr, (
'Expected to find exactly one privatekey key in %s, skipping' % (
crt_path,
)
)
error = True
continue
try:
utils.validateCertAndKey(crt_pem, key_pem)
except ValueError:
print >>sys.stderr, (
'Key in %s does not match retrieved certificate, skipping'
)
error = True
continue
with open(crt_path, 'a') as crt_file:
crt_file.write(crt_pem)
return warning, error
def revokeCRT(self, error, crt_key_list):
"""
--revoke-crt
"""
for crt_path, key_path in crt_key_list:
try:
crt, key, _ = utils.getKeyPair(crt_path, key_path)
except ValueError:
print >>sys.stderr, (
'Could not find (exactly) one matching key pair in %s, skipping' % (
[x for x in set((crt_path, key_path)) if x]
)
)
error = True
continue
self._client.revokeCertificate(crt, key)
return error
def renewCRT(
self,
crt_key_list,
renewal_deadline,
key_len,
ca_certificate_list,
updated,
error,
):
"""
--renew-crt
"""
for crt_path, key_path in crt_key_list:
try:
old_crt_pem, old_key_pem, key_path = utils.getKeyPair(
crt_path,
key_path,
)
except ValueError:
print >>sys.stderr, (
'Could not find (exactly) one matching key pair in %s, skipping' % (
[x for x in set((crt_path, key_path)) if x]
)
)
error = True
continue
try:
old_crt = utils.load_certificate(
old_crt_pem,
ca_certificate_list,
None,
)
except exceptions.CertificateVerificationError:
print crt_path, (
'was not signed by this CA, revoked or otherwise invalid, skipping'
)
continue
if renewal_deadline < old_crt.not_valid_after:
print crt_path, 'did not reach renew threshold, not renewing'
continue
new_key_pem, new_crt_pem = self._client.renewCertificate(
old_crt=old_crt,
old_key=utils.load_privatekey(old_key_pem),
key_len=key_len,
)
if key_path is None:
with open(crt_path, 'w') as crt_file:
crt_file.write(new_key_pem)
crt_file.write(new_crt_pem)
else:
with open(crt_path, 'w') as crt_file, open(key_path, 'w') as key_file:
key_file.write(new_key_pem)
crt_file.write(new_crt_pem)
updated = True
return updated, error
def listCSR(self, mode):
"""
--list-csr
"""
print '-- pending', mode, 'CSRs --'
print '%20s | %s' % (
'csr_id',
'subject preview (fetch csr and check full content !)',
)
for entry in self._client.getPendingCertificateRequestList():
csr = utils.load_certificate_request(entry['csr'])
print '%20s | %r' % (
entry['id'],
csr.subject,
)
print '-- end of pending', mode, 'CSRs --'
def signCSR(self, csr_id_list):
"""
--sign-csr
"""
for csr_id in csr_id_list:
self._client.createCertificate(int(csr_id))
def signCSRWith(self, csr_id_path_list):
"""
--sign-csr-with
"""
for csr_id, csr_path in csr_id_path_list:
self._client.createCertificate(
int(csr_id),
template_csr=utils.getCertRequest(csr_path),
)
def rejectCSR(self, csr_id_list):
"""
--reject-csr
"""
for csr_id in csr_id_list:
self._client.deletePendingCertificateRequest(int(csr_id))
def revokeOtherCRT(self, crt_list):
"""
--revoke-other-crt
"""
error = False
for crt_path in crt_list:
try:
# Note: also raises when there are serveral certs. This is intended:
# revoking many certs from a single file seems a dubious use-case
# (especially in the automated issuance context, which is supposed to
# be caucase's main target), with high risk if carried without
# questions (too many certificates revoked, or asingle unexpected one
# among these, ...) and unambiguous solution is easy (if a human is
# involved, as is likely the case, more or less directly, for
# authenticated revocations).
crt_pem = utils.getCert(crt_path)
except ValueError:
print >>sys.stderr, (
'Could not load a single certificate in %s, skipping' % (
crt_path,
)
)
self._client.revokeCertificate(crt_pem)
return error
def revokeSerial(self, serial_list):
"""
--revoke-serial
"""
for serial in serial_list:
self._client.revokeSerial(serial)
def main(argv=None):
"""
Command line caucase client entry point.
"""
parser = argparse.ArgumentParser(description='caucase')
# XXX: currently, it is the server which chooses which digest is used to sign
# stuff.
# Should clients be able to tell it how to sign (and server could reject) ?
parser.add_argument(
'--ca-url',
required=True,
metavar='URL',
help='caucase service HTTP base URL.',
)
parser.add_argument(
'--ca-crt',
default='cas.crt.pem',
metavar='CRT_PATH',
help='Services CA certificate file location. default: %(default)s',
)
parser.add_argument(
'--user-ca-crt',
default='cau.crt.pem',
metavar='CRT_PATH',
help='Users CA certificate file location. default: %(default)s',
)
parser.add_argument(
'--crl',
default='cas.crl.pem',
metavar='CRL_PATH',
help='Services certificate revocation list location. default: %(default)s',
)
parser.add_argument(
'--user-crl',
default='cau.crl.pem',
metavar='CRL_PATH',
help='Users certificate revocation list location. default: %(default)s',
)
parser.add_argument(
'--threshold',
default=31,
type=float,
help='The remaining certificate validity period, in days, under '
'which a renew is desired. default: %(default)s',
)
parser.add_argument(
'--key-len',
default=2048,
type=int,
metavar='BITLENGTH',
help='Number of bits to use when generating a new private key. '
'default: %(default)s',
)
parser.add_argument(
'--on-renew',
metavar='EXECUTABLE_PATH',
help='Path of an executable file to call after any renewal (CA cert, '
'certificate, revocation list).',
)
parser.add_argument(
'--user-key',
metavar='KEY_PATH',
help='User private key and certificate bundled in a single file to '
'authenticate with caucase.',
)
parser.add_argument(
'--mode',
default=MODE_SERVICE,
choices=[MODE_SERVICE, MODE_USER],
help='The type of certificates you want to manipulate: '
'<%s> certificates allow managing caucase server, '
'<%s> certificates can be validated by caucase\'s CA certificate. '
'default: %%(default)s' % (
MODE_USER,
MODE_SERVICE,
)
)
anonymous_group = parser.add_argument_group(
'Anonymous actions',
'Actions which do no require authentication.',
)
anonymous_group.add_argument(
'--send-csr',
nargs='+',
metavar='CSR_PATH',
default=[],
help='Request signature of these certificate signing requests.',
)
anonymous_group.add_argument(
'--get-crt',
nargs=2,
action='append',
default=[],
metavar=('CSR_ID', 'CRT_PATH'),
help='Retrieve the certificate identified by '
'identifier and store it at given path. '
'If CRT_PATH exists and contains the private key corresponding to '
'received certificate, certificate will be appended to that file. '
'Can be given multiple times.',
)
anonymous_group.add_argument(
'--revoke-crt',
nargs=2,
action='append',
default=[],
metavar=('CRT_PATH', 'KEY_PATH'),
help='Revoke certificate. If CRT_PATH file contains both a certificate '
'and a key, KEY_PATH is ignored. '
'Can be given multiple times.',
)
anonymous_group.add_argument(
'--renew-crt',
nargs=2,
default=[],
action='append',
metavar=('CRT_PATH', 'KEY_PATH'),
help='Renew certificates in-place if they exceed THRESHOLD. '
'If CRT_PATH file contains both certificate and key, KEY_PATH is ignored '
'and CRT_PATH receives both the new key and the new certificate. '
'Can be given multiple times.',
)
anonymous_group.add_argument(
'--get-csr',
nargs=2,
default=[],
action='append',
metavar=('CSR_ID', 'CSR_PATH'),
help='Retrieve certificate signing request and append to CSR_PATH. '
'Should only be needed before deciding to sign or reject the request. '
'Can be given multiple times.',
)
anonymous_group.add_argument(
'--update-user',
action='store_true',
help='Update or create user CA and CRL. '
'Should only be needed by the https server in front of caucase.'
)
authenticated_group = parser.add_argument_group(
'Authenticated actions',
'Actions which require an authentication. Requires --user-key .',
)
authenticated_group.add_argument(
'--list-csr',
action='store_true',
help='List certificate signing requests currently pending on server.',
)
authenticated_group.add_argument(
'--sign-csr',
nargs='+',
default=[],
metavar='CSR_ID',
help='Sign pending certificate signing requests.',
)
authenticated_group.add_argument(
'--sign-csr-with',
nargs=2,
default=[],
action='append',
metavar=('CSR_ID', 'CSR_PATH'),
help='Sign pending certificate signing request, but use provided CSR for '
'requested subject and extensions instead of stored CSR. '
'Can be given multiple times.',
)
authenticated_group.add_argument(
'--reject-csr',
nargs='+',
default=[],
metavar='CSR_ID',
help='Reject these pending certificate signing requests.',
)
authenticated_group.add_argument(
'--revoke-other-crt',
nargs='+',
default=[],
metavar='CRT_PATH',
help='Revoke certificate without needing access to their private key.'
)
authenticated_group.add_argument(
'--revoke-serial',
nargs='+',
default=[],
metavar='SERIAL',
type=int,
help='Revoke certificate by serial number, without needing the '
'certificate at all. DANGEROUS: typos will not be detected ! '
'COSTLY: revocation will stay in the revocation list until all '
'currently valid CA certificates have expired. '
'Use --revoke and --revoke-other-crt whenever possible.',
)
args = parser.parse_args(argv)
sign_csr_id_set = set(args.sign_csr)
sign_with_csr_id_set = {x for x, _ in args.sign_csr_with}
if (
sign_csr_id_set.intersection(args.reject_csr) or
sign_with_csr_id_set.intersection(args.reject_csr) or
sign_csr_id_set.intersection(sign_with_csr_id_set)
):
print >>sys.stderr, (
'A given CSR_ID cannot be in more than one of --sign-csr, '
'--sign-csr-with and --reject-csr'
)
raise SystemExit(STATUS_ERROR)
updated = False
warning = False
error = False
finished = False
cau_url = args.ca_url + '/cau'
cas_url = args.ca_url + '/cas'
try:
# Get a working, up-to-date CAS CA certificate file.
updated |= updateCAFile(cas_url, args.ca_crt)
# --update-user, CA part
if args.update_user or args.mode == MODE_USER:
updated |= updateCAFile(cau_url, args.user_ca_crt)
client = CLICaucaseClient(
client=CaucaseClient(
ca_url={
MODE_SERVICE: cas_url,
MODE_USER: cau_url,
}[args.mode],
ca_crt_pem_list=utils.getCertList(args.ca_crt),
user_key=args.user_key,
),
)
ca_list = [
utils.load_ca_certificate(x)
for x in utils.getCertList({
MODE_SERVICE: args.ca_crt,
MODE_USER: args.user_ca_crt,
}[args.mode])
]
client.putCSR(args.send_csr)
client.getCSR(args.get_csr)
warning, error = client.getCRT(warning, error, args.get_crt, ca_list)
error = client.revokeCRT(error, args.revoke_crt)
updated, error = client.renewCRT(
crt_key_list=args.renew_crt,
renewal_deadline=datetime.datetime.utcnow() + datetime.timedelta(
args.threshold,
0,
),
key_len=args.key_len,
ca_certificate_list=ca_list,
updated=updated,
error=error,
)
client.signCSR(args.sign_csr)
client.signCSRWith(args.sign_csr_with)
client.rejectCSR(args.reject_csr)
error |= client.revokeOtherCRT(args.revoke_other_crt)
client.revokeSerial(args.revoke_serial)
# show latest CSR list status
if args.list_csr:
client.listCSR(args.mode)
# update our CRL after all revocations we were requested
updated |= updateCRLFile(cas_url, args.crl, [
utils.load_ca_certificate(x)
for x in utils.getCertList(args.ca_crt)
])
# --update-user, CRL part
if args.update_user:
updated |= updateCRLFile(cau_url, args.user_crl, [
utils.load_ca_certificate(x)
for x in utils.getCertList(args.user_ca_crt)
])
finished = True
finally:
if updated and args.on_renew:
status = os.system(args.on_renew)
# Avoid raising if we arrived here because of an exception, to not hide
# the original problem.
if finished and status:
raise SystemExit(STATUS_CALLBACK_ERROR)
if error:
raise SystemExit(STATUS_ERROR)
if warning:
raise SystemExit(STATUS_WARNING)
def probe(argv=None):
"""
Verify basic caucase server functionality
"""
parser = argparse.ArgumentParser(
description='caucase probe - Verify basic caucase server functionality',
)
parser.add_argument(
'ca_url',
nargs=1,
help='caucase service HTTP base URL.',
)
ca_url, = parser.parse_args(argv).ca_url
cas_url = ca_url + '/cas'
http_client = CaucaseClient(
ca_url=cas_url,
)
http_ca_pem = http_client.getCACertificate()
https_ca_pem = HTTPSOnlyCaucaseClient(
ca_url=cas_url,
ca_crt_pem_list=[http_ca_pem],
).getCACertificate()
# Retrieve again in case there was a renewal between both calls - we do
# not expect 2 renewals in very short succession.
http2_ca_pem = http_client.getCACertificate()
if https_ca_pem not in (http_ca_pem, http2_ca_pem):
raise ValueError('http and https do not serve the same caucase database')
def updater(argv=None, until=utils.until):
"""
Bootstrap certificate and companion files and keep them up-to-date.
"""
parser = argparse.ArgumentParser(
description='caucase updater - '
'Bootstrap certificate and companion files and keep them up-to-date',
)
parser.add_argument(
'--ca-url',
required=True,
metavar='URL',
help='caucase service HTTP base URL.',
)
parser.add_argument(
'--cas-ca',
required=True,
metavar='CRT_PATH',
help='Service CA certificate file location used to verify connection '
'to caucase. Will be maintained up-to-date. '
'default: %(default)s',
)
parser.add_argument(
'--threshold',
default=31,
type=float,
help='The remaining certificate validity period, in days, under '
'which a renew is desired. default: %(default)s',
)
parser.add_argument(
'--key-len',
default=2048,
type=int,
metavar='BITLENGTH',
help='Number of bits to use when generating a new private key. '
'default: %(default)s',
)
parser.add_argument(
'--on-renew',
metavar='EXECUTABLE_PATH',
help='Path of an executable file to call after any renewal (CA cert, '
'certificate, revocation list).',
)
parser.add_argument(
'--max-sleep',
default=31,
type=float,
help='Maximum number of days to sleep for. Allows refreshing the CRL '
'more often on sensitive services. default: %(default)s',
)
parser.add_argument(
'--mode',
default=MODE_SERVICE,
choices=[MODE_SERVICE, MODE_USER],
help='The type of certificates you want to manipulate: '
'<%s> certificates allow managing caucase server, '
'<%s> certificates can be validated by caucase\'s CA certificate. '
'default: %%(default)s' % (
MODE_USER,
MODE_SERVICE,
)
)
parser.add_argument(
'--csr',
metavar='CSR_PATH',
help='Path of your CSR to use for initial request of a certificate for '
'MODE. Ignored once a certificate exists at the location given by '
'--crt .',
)
parser.add_argument(
'--key',
metavar='KEY_PATH',
help='Path of your private key file. Must always exist when this command '
'is started. Will be updated on certificate renewal. If not provided, '
'both key and certificate will be stored in the file pointed at by '
'--crt .',
)
parser.add_argument(
'--crt',
metavar='CRT_PATH',
help='Path of your certificate for MODE. Will be renewed before '
'expiration.',
)
parser.add_argument(
'--ca',
required=True,
metavar='CRT_PATH',
help='Path of your CA certificate for MODE. '
'Will be maintained up-to-date.'
)
parser.add_argument(
'--crl',
required=True,
metavar='CRT_PATH',
help='Path of your certificate revocation list for MODE. '
'Will be maintained up-to-date.'
)
args = parser.parse_args(argv)
try:
cas_url = args.ca_url + '/cas'
ca_url = {
MODE_SERVICE: cas_url,
MODE_USER: args.ca_url + '/cau',
}[args.mode]
threshold = datetime.timedelta(args.threshold, 0)
max_sleep = datetime.timedelta(args.max_sleep, 0)
updated = updateCAFile(cas_url, args.cas_ca) and args.cas_ca == args.ca
client = CaucaseClient(
ca_url=ca_url,
ca_crt_pem_list=utils.getCertList(args.cas_ca)
)
if args.crt and not utils.hasOneCert(args.crt):
print 'Bootstraping...'
csr_pem = utils.getCertRequest(args.csr)
# Quick sanity check before bothering server
utils.load_certificate_request(csr_pem)
csr_id = client.createCertificateSigningRequest(csr_pem)
print 'Waiting for signature of', csr_id
while True:
try:
crt_pem = client.getCertificate(csr_id)
except CaucaseError, e:
if e.args[0] != httplib.NOT_FOUND:
raise
# If server does not know our CSR anymore, getCSR will raise.
# If it does, we were likely rejected, so exit by letting exception
# through.
client.getCertificateSigningRequest(csr_id)
# Still here ? Ok, wait a bit and try again.
until(datetime.datetime.utcnow() + datetime.timedelta(0, 60))
else:
with open(args.crt, 'a') as crt_file:
crt_file.write(crt_pem)
updated = True
break
print 'Bootstrap done'
next_deadline = datetime.datetime.utcnow()
while True:
print 'Next wake-up at', next_deadline.strftime(
'%Y-%m-%d %H:%M:%S +0000'
)
now = until(next_deadline)
next_deadline = now + max_sleep
if args.cas_ca != args.ca and updateCAFile(cas_url, args.cas_ca):
client = CaucaseClient(
ca_url=ca_url,
ca_crt_pem_list=utils.getCertList(args.cas_ca)
)
if updateCAFile(ca_url, args.ca):
print 'Got new CA'
updated = True
# Note: CRL expiration should happen several time during CA renewal
# period, so it should not be needed to keep track of CA expiration
# for next deadline.
ca_crt_list = [
utils.load_ca_certificate(x)
for x in utils.getCertList(args.ca)
]
if updateCRLFile(ca_url, args.crl, ca_crt_list):
print 'Got new CRL'
updated = True
next_deadline = min(
next_deadline,
utils.load_crl(open(args.crl).read(), ca_crt_list).next_update,
)
if args.crt:
crt_pem, key_pem, key_path = utils.getKeyPair(args.crt, args.key)
crt = utils.load_certificate(crt_pem, ca_crt_list, None)
if crt.not_valid_after - threshold <= now:
print 'Renewing', args.crt
new_key_pem, new_crt_pem = client.renewCertificate(
old_crt=crt,
old_key=utils.load_privatekey(key_pem),
key_len=args.key_len,
)
if key_path is None:
with open(args.crt, 'w') as crt_file:
crt_file.write(new_key_pem)
crt_file.write(new_crt_pem)
else:
with open(
args.crt,
'w',
) as crt_file, open(
key_path,
'w',
) as key_file:
key_file.write(new_key_pem)
crt_file.write(new_crt_pem)
crt = utils.load_certificate(utils.getCert(args.crt), ca_crt_list, None)
updated = True
next_deadline = min(
next_deadline,
crt.not_valid_after - threshold,
)
if updated:
if args.on_renew is not None:
status = os.system(args.on_renew)
if status:
print >>sys.stderr, 'Renewal hook exited with status:', status
raise SystemExit(STATUS_ERROR)
updated = False
except (utils.SleepInterrupt, SystemExit):
# Not intercepting KeyboardInterrupt so interrupting outside of
# interruptibleSleep shows where the script got interrupted.
pass
def rerequest(argv=None):
"""
Produce a new private key and sign a CSR created by copying an existing,
well-signed CSR.
"""
parser = argparse.ArgumentParser(
description='caucase rerequest - '
'Produce a new private key and sign a CSR created by copying an existing, '
'well-signed CSR.',
)
parser.add_argument(
'--template',
required=True,
type=argparse.FileType('r'),
help='Existing PEM-encodd CSR to use as a template.',
)
parser.add_argument(
'--csr',
required=True,
help='Path of produced PEM-encoded CSR.',
)
parser.add_argument(
'--key',
required=True,
help='Path of produced PEM-encoded private key.',
)
parser.add_argument(
'--key-len',
default=2048,
type=int,
metavar='BITLENGTH',
help='Number of bits to use when generating a new private key. '
'default: %(default)s',
)
args = parser.parse_args(argv)
template = utils.load_certificate_request(
utils.getCertRequest(args.template.name),
)
key = utils.generatePrivateKey(key_len=args.key_len)
csr_pem = utils.dump_certificate_request(
x509.CertificateSigningRequestBuilder(
subject_name=template.subject,
extensions=template.extensions,
).sign(
private_key=key,
algorithm=utils.DEFAULT_DIGEST_CLASS(),
backend=_cryptography_backend,
),
)
key_pem = utils.dump_privatekey(key)
orig_umask = os.umask(0177)
try:
with open(args.key, 'w') as key_file:
key_file.write(key_pem)
finally:
os.umask(orig_umask)
with open(args.csr, 'w') as csr_file:
csr_file.write(csr_pem)
def key_id(argv=None):
"""
Displays key identifier from private key, and the list of acceptable key
identifiers for a given backup file.
"""
parser = argparse.ArgumentParser(
description='caucase key id - '
'Displays key identifier from private key, and the list of acceptable key'
'identifiers for a given backup file.',
)
parser.add_argument(
'--private-key',
nargs='+',
default=(),
help='PEM-encoded keys to display the identifier of.',
)
parser.add_argument(
'--backup',
nargs='+',
default=(),
help='Caucase backup files to display acceptable deciphering key '
'identifiers of.',
)
args = parser.parse_args(argv)
for key_path in args.private_key:
print key_path, x509.SubjectKeyIdentifier.from_public_key(
utils.load_privatekey(open(key_path).read()).public_key(),
).digest.encode('hex')
for backup_path in args.backup:
print backup_path
with open(backup_path) as backup_file:
magic = backup_file.read(8)
if magic != 'caucase\0':
raise ValueError('Invalid backup magic string')
header_len, = struct.unpack(
'