File: PKG-INFO

package info (click to toggle)
python-trustme 0.6.0-1
  • links: PTS
  • area: main
  • in suites: bullseye, sid
  • size: 192 kB
  • sloc: python: 721; makefile: 12
file content (133 lines) | stat: -rw-r--r-- 5,567 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
Metadata-Version: 1.1
Name: trustme
Version: 0.6.0
Summary: #1 quality TLS certs while you wait, for the discerning tester
Home-page: https://github.com/python-trio/trustme
Author: Nathaniel J. Smith
Author-email: njs@pobox.com
License: MIT -or- Apache License 2.0
Description: .. note that this README gets 'include'ed into the main documentation
        
        ==============================================
         trustme: #1 quality TLS certs while you wait
        ==============================================
        
        .. image:: https://vignette2.wikia.nocookie.net/jadensadventures/images/1/1e/Kaa%27s_hypnotic_eyes.jpg/revision/latest?cb=20140310173415
           :width: 200px
           :align: right
        
        You wrote a cool network client or server. It encrypts connections
        using `TLS
        <https://en.wikipedia.org/wiki/Transport_Layer_Security>`__. Your test
        suite needs to make TLS connections to itself.
        
        Uh oh. Your test suite *probably* doesn't have a valid TLS
        certificate. Now what?
        
        ``trustme`` is a tiny Python package that does one thing: it gives you
        a `fake <https://martinfowler.com/bliki/TestDouble.html>`__
        certificate authority (CA) that you can use to generate fake TLS certs
        to use in your tests. Well, technically they're real certs, they're
        just signed by your CA, which nobody trusts. But you can trust
        it. Trust me.
        
        
        Vital statistics
        ================
        
        **Install:** ``pip install -U trustme``
        
        **Documentation:** https://trustme.readthedocs.io
        
        **Bug tracker and source code:** https://github.com/python-trio/trustme
        
        **Tested on:** Python 2.7 and Python 3.5+, CPython and PyPy
        
        **License:** MIT or Apache 2, your choice.
        
        **Code of conduct:** Contributors are requested to follow our `code of
        conduct
        <https://github.com/python-trio/trustme/blob/master/CODE_OF_CONDUCT.md>`__
        in all project spaces.
        
        
        Cheat sheet
        ===========
        
        .. code-block:: python
        
           import trustme
        
           # ----- Creating certs -----
        
           # Look, you just created your own certificate authority!
           ca = trustme.CA()
        
           # And now you issued a cert signed by this fake CA
           # https://en.wikipedia.org/wiki/Example.org
           server_cert = ca.issue_cert(u"test-host.example.org")
        
           # That's it!
        
           # ----- Using your shiny new certs -----
        
           # You can configure SSL context objects to trust this CA:
           ca.configure_trust(ssl_context)
           # Or configure them to present the server certificate
           server_cert.configure_cert(ssl_context)
           # You can use standard library or PyOpenSSL context objects here,
           # trustme is happy either way.
        
           # ----- or -----
                        
           # Save the PEM-encoded data to a file to use in non-Python test
           # suites:
           ca.cert_pem.write_to_path("ca.pem")
           server_cert.private_key_and_cert_chain_pem.write_to_path("server.pem")
           
           # ----- or -----
                        
           # Put the PEM-encoded data in a temporary file, for libraries that
           # insist on that:
           with ca.cert_pem.tempfile() as ca_temp_path:
               requests.get("https://...", verify=ca_temp_path)
        
        
        FAQ
        ===
        
        **Should I use these certs for anything real?** Certainly not.
        
        **Why not just use self-signed certificates?** These are more
        realistic. You don't have to disable your certificate validation code
        in your test suite, which is good, because you want to test what you
        run in production, and you would *never* disable your certificate
        validation code in production, right? Plus they're just as easy to
        work with. Actually easier, in many cases.
        
        **What if I want to test how my code handles some really weird TLS
        configuration?** Sure, I'm happy to extend the API to give more
        control over the generated certificates, at least as long as it
        doesn't turn into a second-rate re-export of everything in
        `cryptography <https://cryptography.io>`__. (If you really need a
        fully general X.509 library then they do a great job at that.) `Let's
        talk <https://github.com/python-trio/trustme/issues/new>`__, or send a
        PR.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: System :: Networking
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development :: Testing