spiffe 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. spiffe-0.1.0/LICENSE +201 -0
  2. spiffe-0.1.0/PKG-INFO +111 -0
  3. spiffe-0.1.0/README.md +88 -0
  4. spiffe-0.1.0/pyproject.toml +53 -0
  5. spiffe-0.1.0/src/spiffe/__init__.py +12 -0
  6. spiffe-0.1.0/src/spiffe/bundle/__init__.py +3 -0
  7. spiffe-0.1.0/src/spiffe/bundle/jwt_bundle/__init__.py +3 -0
  8. spiffe-0.1.0/src/spiffe/bundle/jwt_bundle/errors.py +39 -0
  9. spiffe-0.1.0/src/spiffe/bundle/jwt_bundle/jwt_bundle.py +151 -0
  10. spiffe-0.1.0/src/spiffe/bundle/jwt_bundle/jwt_bundle_set.py +86 -0
  11. spiffe-0.1.0/src/spiffe/bundle/x509_bundle/__init__.py +3 -0
  12. spiffe-0.1.0/src/spiffe/bundle/x509_bundle/errors.py +46 -0
  13. spiffe-0.1.0/src/spiffe/bundle/x509_bundle/x509_bundle.py +214 -0
  14. spiffe-0.1.0/src/spiffe/bundle/x509_bundle/x509_bundle_set.py +90 -0
  15. spiffe-0.1.0/src/spiffe/config.py +142 -0
  16. spiffe-0.1.0/src/spiffe/errors.py +27 -0
  17. spiffe-0.1.0/src/spiffe/proto/__init__.py +0 -0
  18. spiffe-0.1.0/src/spiffe/proto/workload.proto +164 -0
  19. spiffe-0.1.0/src/spiffe/proto/workload_pb2.py +66 -0
  20. spiffe-0.1.0/src/spiffe/proto/workload_pb2.pyi +436 -0
  21. spiffe-0.1.0/src/spiffe/proto/workload_pb2_grpc.py +288 -0
  22. spiffe-0.1.0/src/spiffe/spiffe_id/__init__.py +3 -0
  23. spiffe-0.1.0/src/spiffe/spiffe_id/spiffe_id.py +215 -0
  24. spiffe-0.1.0/src/spiffe/svid/__init__.py +3 -0
  25. spiffe-0.1.0/src/spiffe/svid/errors.py +82 -0
  26. spiffe-0.1.0/src/spiffe/svid/jwt_svid.py +184 -0
  27. spiffe-0.1.0/src/spiffe/svid/jwt_svid_validator.py +150 -0
  28. spiffe-0.1.0/src/spiffe/svid/x509_svid.py +310 -0
  29. spiffe-0.1.0/src/spiffe/utils/__init__.py +0 -0
  30. spiffe-0.1.0/src/spiffe/utils/certificate_utils.py +284 -0
  31. spiffe-0.1.0/src/spiffe/utils/errors.py +63 -0
  32. spiffe-0.1.0/src/spiffe/workloadapi/__init__.py +3 -0
  33. spiffe-0.1.0/src/spiffe/workloadapi/errors.py +74 -0
  34. spiffe-0.1.0/src/spiffe/workloadapi/grpc/__init__.py +3 -0
  35. spiffe-0.1.0/src/spiffe/workloadapi/grpc/generic_client_interceptor.py +61 -0
  36. spiffe-0.1.0/src/spiffe/workloadapi/grpc/header_manipulator_client_interceptor.py +56 -0
  37. spiffe-0.1.0/src/spiffe/workloadapi/handle_error.py +49 -0
  38. spiffe-0.1.0/src/spiffe/workloadapi/jwt_source.py +237 -0
  39. spiffe-0.1.0/src/spiffe/workloadapi/workload_api_client.py +594 -0
  40. spiffe-0.1.0/src/spiffe/workloadapi/x509_context.py +69 -0
  41. spiffe-0.1.0/src/spiffe/workloadapi/x509_source.py +220 -0
spiffe-0.1.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
spiffe-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,111 @@
1
+ Metadata-Version: 2.1
2
+ Name: spiffe
3
+ Version: 0.1.0
4
+ Summary: Python library for SPIFFE support
5
+ License: Apache-2.0
6
+ Author: Max Lambrecht
7
+ Author-email: maxlambrecht@gmail.com
8
+ Requires-Python: >=3.9,<4.0
9
+ Classifier: License :: OSI Approved :: Apache Software License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Requires-Dist: cryptography (>=42.0,<43.0)
16
+ Requires-Dist: grpcio (>=1.62,<2.0)
17
+ Requires-Dist: pem (>=23.0,<24.0)
18
+ Requires-Dist: pyasn1 (>=0.6.0,<0.7.0)
19
+ Requires-Dist: pyasn1-modules (>=0.4.0,<0.5.0)
20
+ Requires-Dist: pyjwt[crypto] (>=2.0,<3.0)
21
+ Description-Content-Type: text/markdown
22
+
23
+ # `spiffe` Module
24
+
25
+ ## Overview
26
+
27
+ The `spiffe` module, part of the `py-spiffe` library, provides Python developers with essential tools for interacting
28
+ with
29
+ the [SPIFFE Workload API](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Workload_API.md). It streamlines
30
+ the management and validation of SPIFFE identities, including support for
31
+ both [X509-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/X509-SVID.md)
32
+ and [JWT-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md), and
33
+ [SPIFFE Bundles](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Trust_Domain_and_Bundle.md#3-spiffe-bundles).
34
+
35
+ ## Usage
36
+
37
+ Below are examples demonstrating the core functionalities of the `spiffe` module.
38
+
39
+ Prerequisites:
40
+
41
+ 1. Running [SPIRE](https://spiffe.io/spire/) or another SPIFFE Workload API implementation.
42
+ 2. `SPIFFE_ENDPOINT_SOCKET` environment variable set to the address of the Workload
43
+ API (e.g. `unix:/tmp/spire-agent/public/api.sock`). Alternatively the socket address can be
44
+ provided programmatically.
45
+
46
+ ### WorkloadApiClient
47
+
48
+ Facilitates fetching X.509 and JWT SVIDs and Bundles, and validating JWT tokens communicating with the SPIFFE Workload
49
+ API.
50
+
51
+ ```python
52
+ from spiffe import WorkloadApiClient
53
+
54
+ # Interacting with the Workload API to fetch SVIDs
55
+ with WorkloadApiClient() as client:
56
+ # Fetch a X.509 SVID
57
+ x509_svid = client.fetch_x509_svid()
58
+ print(f'SPIFFE ID: {x509_svid.spiffe_id}')
59
+ print(f'Certificate chain: {x509_svid.cert_chain}')
60
+
61
+ # Fetch a JWT SVID
62
+ jwt_svid = client.fetch_jwt_svid(audience={'test'})
63
+
64
+ # Validate JWT SVID
65
+ validated_svid = client.validate_jwt_svid(jwt_svid.token, audience='test')
66
+ print(f'Validated JWT SVID for audience `test`: {jwt_svid.spiffe_id}')
67
+
68
+ # Fetch bundles of public keys
69
+ x509_bundles = client.fetch_x509_bundles()
70
+ jwt_bundles = client.fetch_jwt_bundles
71
+ ```
72
+
73
+ ### X509Source
74
+
75
+ Automatically fetches X.509 SVIDs and Bundles from the SPIFFE Workload API and continuously receives updates. This
76
+ ensures your application always uses valid certificates without manual intervention.
77
+
78
+ ```python
79
+ from spiffe import X509Source
80
+ from spiffe import TrustDomain
81
+
82
+ with X509Source() as source:
83
+ # Access the fetched X.509 SVID
84
+ x509_svid = source.svid
85
+ print(f'SPIFFE ID: {x509_svid.spiffe_id}')
86
+ print(f'Certificate chain: {[cert for cert in x509_svid.cert_chain]}')
87
+
88
+ # Access the fetched X.509 Bundle for a specific Trust Domain
89
+ x509_bundle = source.get_bundle_for_trust_domain(TrustDomain('example.org'))
90
+ print(f'X.509 Bundle for example.org: {x509_bundle}')
91
+ ```
92
+
93
+ ### JwtSource
94
+
95
+ Facilitates the management and validation of JWT SVIDs and Bundles. It automatically fetches JWT SVIDs from the SPIFFE
96
+ Workload API and validates them against the JWT bundles for their trust domains.
97
+
98
+ ```python
99
+ from spiffe import JwtSource
100
+ from spiffe import TrustDomain
101
+ from spiffe import JwtSvid
102
+
103
+ with JwtSource() as source:
104
+ jwt_svid = source.fetch_svid(audience={'test'})
105
+ print(f'SPIFFE ID: {jwt_svid.spiffe_id}')
106
+
107
+ jwt_bundle = source.get_bundle_for_trust_domain(TrustDomain('example.org'))
108
+ validated_svid = JwtSvid.parse_and_validate(jwt_svid.token, jwt_bundle, audience={'test'})
109
+ ```
110
+
111
+
spiffe-0.1.0/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # `spiffe` Module
2
+
3
+ ## Overview
4
+
5
+ The `spiffe` module, part of the `py-spiffe` library, provides Python developers with essential tools for interacting
6
+ with
7
+ the [SPIFFE Workload API](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Workload_API.md). It streamlines
8
+ the management and validation of SPIFFE identities, including support for
9
+ both [X509-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/X509-SVID.md)
10
+ and [JWT-SVIDs](https://github.com/spiffe/spiffe/blob/main/standards/JWT-SVID.md), and
11
+ [SPIFFE Bundles](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Trust_Domain_and_Bundle.md#3-spiffe-bundles).
12
+
13
+ ## Usage
14
+
15
+ Below are examples demonstrating the core functionalities of the `spiffe` module.
16
+
17
+ Prerequisites:
18
+
19
+ 1. Running [SPIRE](https://spiffe.io/spire/) or another SPIFFE Workload API implementation.
20
+ 2. `SPIFFE_ENDPOINT_SOCKET` environment variable set to the address of the Workload
21
+ API (e.g. `unix:/tmp/spire-agent/public/api.sock`). Alternatively the socket address can be
22
+ provided programmatically.
23
+
24
+ ### WorkloadApiClient
25
+
26
+ Facilitates fetching X.509 and JWT SVIDs and Bundles, and validating JWT tokens communicating with the SPIFFE Workload
27
+ API.
28
+
29
+ ```python
30
+ from spiffe import WorkloadApiClient
31
+
32
+ # Interacting with the Workload API to fetch SVIDs
33
+ with WorkloadApiClient() as client:
34
+ # Fetch a X.509 SVID
35
+ x509_svid = client.fetch_x509_svid()
36
+ print(f'SPIFFE ID: {x509_svid.spiffe_id}')
37
+ print(f'Certificate chain: {x509_svid.cert_chain}')
38
+
39
+ # Fetch a JWT SVID
40
+ jwt_svid = client.fetch_jwt_svid(audience={'test'})
41
+
42
+ # Validate JWT SVID
43
+ validated_svid = client.validate_jwt_svid(jwt_svid.token, audience='test')
44
+ print(f'Validated JWT SVID for audience `test`: {jwt_svid.spiffe_id}')
45
+
46
+ # Fetch bundles of public keys
47
+ x509_bundles = client.fetch_x509_bundles()
48
+ jwt_bundles = client.fetch_jwt_bundles
49
+ ```
50
+
51
+ ### X509Source
52
+
53
+ Automatically fetches X.509 SVIDs and Bundles from the SPIFFE Workload API and continuously receives updates. This
54
+ ensures your application always uses valid certificates without manual intervention.
55
+
56
+ ```python
57
+ from spiffe import X509Source
58
+ from spiffe import TrustDomain
59
+
60
+ with X509Source() as source:
61
+ # Access the fetched X.509 SVID
62
+ x509_svid = source.svid
63
+ print(f'SPIFFE ID: {x509_svid.spiffe_id}')
64
+ print(f'Certificate chain: {[cert for cert in x509_svid.cert_chain]}')
65
+
66
+ # Access the fetched X.509 Bundle for a specific Trust Domain
67
+ x509_bundle = source.get_bundle_for_trust_domain(TrustDomain('example.org'))
68
+ print(f'X.509 Bundle for example.org: {x509_bundle}')
69
+ ```
70
+
71
+ ### JwtSource
72
+
73
+ Facilitates the management and validation of JWT SVIDs and Bundles. It automatically fetches JWT SVIDs from the SPIFFE
74
+ Workload API and validates them against the JWT bundles for their trust domains.
75
+
76
+ ```python
77
+ from spiffe import JwtSource
78
+ from spiffe import TrustDomain
79
+ from spiffe import JwtSvid
80
+
81
+ with JwtSource() as source:
82
+ jwt_svid = source.fetch_svid(audience={'test'})
83
+ print(f'SPIFFE ID: {jwt_svid.spiffe_id}')
84
+
85
+ jwt_bundle = source.get_bundle_for_trust_domain(TrustDomain('example.org'))
86
+ validated_svid = JwtSvid.parse_and_validate(jwt_svid.token, jwt_bundle, audience={'test'})
87
+ ```
88
+
@@ -0,0 +1,53 @@
1
+ [tool.poetry]
2
+ name = "spiffe"
3
+ version = "0.1.0"
4
+ description = "Python library for SPIFFE support"
5
+ authors = ["Max Lambrecht <maxlambrecht@gmail.com>"]
6
+ readme = "README.md"
7
+ license = "Apache-2.0"
8
+
9
+ [tool.poetry.dependencies]
10
+ python = "^3.9" # >= 3.9, < 4.0
11
+ grpcio = "^1.62"
12
+ cryptography = "^42.0"
13
+ pyjwt = { version = "^2.0", extras = ["crypto"] }
14
+ pyasn1 = "~0.6.0"
15
+ pyasn1-modules = "~0.4.0"
16
+ pem = "^23.0"
17
+
18
+ [tool.poetry.dev-dependencies]
19
+ black = "^24.3"
20
+ mypy = "^1.9"
21
+ mypy-protobuf = "^3.0"
22
+ pytest = "^8.1"
23
+ pytest-mock = "^3.0"
24
+ pre-commit = "^3.7"
25
+ flake8 = "^7.0"
26
+ testutils = { path = "../testutils" }
27
+
28
+ [build-system]
29
+ requires = ["poetry-core>=1.9.0"]
30
+ build-backend = "poetry.core.masonry.api"
31
+
32
+ # Tool configurations
33
+ [tool.black]
34
+ line-length = 95
35
+ skip-string-normalization = true
36
+ target-version = ['py39']
37
+ exclude = '''
38
+ /(
39
+ src/spiffe/proto
40
+ )/
41
+ '''
42
+
43
+ [tool.mypy]
44
+ ignore_missing_imports = true
45
+ files = ["src", "tests"]
46
+
47
+ [tool.pytest.ini_options]
48
+ addopts = [
49
+ "--doctest-modules",
50
+ ]
51
+ testpaths = [
52
+ "tests",
53
+ ]
@@ -0,0 +1,12 @@
1
+ # Re-exports main types for user convenience
2
+ from .workloadapi.x509_source import X509Source # noqa: F401
3
+ from .workloadapi.jwt_source import JwtSource # noqa: F401
4
+ from .workloadapi.workload_api_client import WorkloadApiClient # noqa: F401
5
+
6
+ from .spiffe_id.spiffe_id import SpiffeId, TrustDomain # noqa: F401
7
+ from .svid.x509_svid import X509Svid # noqa: F401
8
+ from .svid.jwt_svid import JwtSvid # noqa: F401
9
+ from .bundle.x509_bundle.x509_bundle import X509Bundle # noqa: F401
10
+ from .bundle.x509_bundle.x509_bundle_set import X509BundleSet # noqa: F401
11
+ from .bundle.jwt_bundle.jwt_bundle import JwtBundle # noqa: F401
12
+ from .bundle.jwt_bundle.jwt_bundle_set import JwtBundleSet # noqa: F401
@@ -0,0 +1,3 @@
1
+ """
2
+ Bundles Package. Contains information related to X509 and JWT Bundles.
3
+ """
@@ -0,0 +1,3 @@
1
+ """
2
+ JWT Bundle Module. Contains information for JWT Bundles.
3
+ """
@@ -0,0 +1,39 @@
1
+ """
2
+ (C) Copyright 2021 Hewlett Packard Enterprise Development LP
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
5
+ not use this file except in compliance with the License. You may obtain
6
+ a copy of the License at
7
+
8
+ https://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13
+ License for the specific language governing permissions and limitations
14
+ under the License.
15
+ """
16
+
17
+ """
18
+ This module handles JWT bundle exceptions.
19
+ """
20
+
21
+ from spiffe.errors import PySpiffeError
22
+
23
+
24
+ class JwtBundleError(PySpiffeError):
25
+ """Exception raised for JwtBundle module related errors."""
26
+
27
+
28
+ class ParseJWTBundleError(JwtBundleError):
29
+ """Error raised when unable to parse a JWT bundle from bytes."""
30
+
31
+ def __init__(self, detail: str) -> None:
32
+ super().__init__(f'Error parsing JWT bundle: {detail}')
33
+
34
+
35
+ class AuthorityNotFoundError(JwtBundleError):
36
+ """Error raised when an authority is not found for a given key ID."""
37
+
38
+ def __init__(self, key_id: str) -> None:
39
+ super().__init__(f'Authority not found for key ID: {key_id}')
@@ -0,0 +1,151 @@
1
+ """
2
+ (C) Copyright 2021 Hewlett Packard Enterprise Development LP
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
5
+ not use this file except in compliance with the License. You may obtain
6
+ a copy of the License at
7
+
8
+ https://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13
+ License for the specific language governing permissions and limitations
14
+ under the License.
15
+ """
16
+
17
+ """
18
+ JwtBundle module manages JwtBundle objects.
19
+ """
20
+
21
+ import threading
22
+ from json import JSONDecodeError
23
+ from jwt.api_jwk import PyJWKSet
24
+ from jwt.exceptions import InvalidKeyError, PyJWKSetError
25
+ from typing import Dict, Union, Optional
26
+ from cryptography.hazmat.primitives.asymmetric import ec, rsa, dsa, ed25519, ed448
27
+
28
+ from spiffe.spiffe_id.spiffe_id import TrustDomain
29
+ from spiffe.bundle.jwt_bundle.errors import JwtBundleError, ParseJWTBundleError
30
+ from spiffe.errors import ArgumentError
31
+
32
+ _PUBLIC_KEY_TYPES = Union[
33
+ dsa.DSAPublicKey,
34
+ rsa.RSAPublicKey,
35
+ ec.EllipticCurvePublicKey,
36
+ ed25519.Ed25519PublicKey,
37
+ ed448.Ed448PublicKey,
38
+ ]
39
+
40
+
41
+ class JwtBundle(object):
42
+ """Represents a JWT Bundle.
43
+
44
+ JwtBundle is a collection of trusted JWT public keys for a trust domain.
45
+ """
46
+
47
+ def __init__(
48
+ self, trust_domain: TrustDomain, jwt_authorities: Dict[str, _PUBLIC_KEY_TYPES]
49
+ ) -> None:
50
+ """Creates a JwtBundle instance.
51
+
52
+ Args:
53
+ trust_domain: The TrustDomain to associate with the JwtBundle instance.
54
+ jwt_authorities: A dictionary with key_id->PublicKey valid for the given TrustDomain.
55
+
56
+ Raises:
57
+ JWTBundleError: In case the trust_domain is empty.
58
+ """
59
+ self.lock = threading.Lock()
60
+
61
+ if not trust_domain:
62
+ raise JwtBundleError("Trust domain cannot be empty")
63
+
64
+ self._trust_domain = trust_domain
65
+ self._jwt_authorities = jwt_authorities.copy() if jwt_authorities else {}
66
+
67
+ @property
68
+ def trust_domain(self) -> TrustDomain:
69
+ """Returns the trust domain of the bundle."""
70
+ return self._trust_domain
71
+
72
+ @property
73
+ def jwt_authorities(self) -> Dict[str, _PUBLIC_KEY_TYPES]:
74
+ """Returns a copy of JWT authorities in the bundle."""
75
+ with self.lock:
76
+ return self._jwt_authorities.copy()
77
+
78
+ def get_jwt_authority(self, key_id: Optional[str]) -> Optional[_PUBLIC_KEY_TYPES]:
79
+ """Returns the authority for the specified key_id.
80
+
81
+ Args:
82
+ key_id: Key id of the token to return the correspondent authority.
83
+
84
+ Returns:
85
+ The authority associated with the supplied key_id.
86
+ None if the key_id is not found.
87
+
88
+ Raises:
89
+ ArgumentError: When key_id is not valid (empty or None).
90
+ """
91
+ if not key_id:
92
+ raise ArgumentError('key_id cannot be empty')
93
+
94
+ with self.lock:
95
+ return self._jwt_authorities.get(key_id)
96
+
97
+ @classmethod
98
+ def parse(cls, trust_domain: TrustDomain, bundle_bytes: bytes) -> 'JwtBundle':
99
+ """Parses a bundle from bytes. The data must be a standard RFC 7517 JWKS document.
100
+
101
+ Args:
102
+ trust_domain: A TrustDomain to associate to the bundle.
103
+ bundle_bytes: An array of bytes that represents a set of JWKs.
104
+
105
+ Returns:
106
+ An instance of 'JWTBundle' with the JWT authorities associated to the given trust domain.
107
+
108
+ Raises:
109
+ ArgumentError: In case the trust_domain is empty or bundle_bytes is empty.
110
+ ParseJWTBundleError: In case the set of jwt_authorities cannot be parsed from the bundle_bytes.
111
+ """
112
+
113
+ if not trust_domain:
114
+ raise ArgumentError("Trust domain cannot be empty")
115
+
116
+ if not bundle_bytes:
117
+ raise ArgumentError('Bundle bytes cannot be empty')
118
+
119
+ try:
120
+ jwks = PyJWKSet.from_json(bundle_bytes.decode('utf-8'))
121
+ except InvalidKeyError as err:
122
+ raise ParseJWTBundleError(str(err)) from err
123
+ except (PyJWKSetError, JSONDecodeError, AttributeError) as err:
124
+ raise ParseJWTBundleError(
125
+ '"bundle_bytes" does not represent a valid jwks'
126
+ ) from err
127
+
128
+ jwt_authorities = {}
129
+ for jwk in jwks.keys:
130
+ if not jwk.key_id:
131
+ raise ParseJWTBundleError(
132
+ 'Error adding authority from JWKS: "keyID" cannot be empty'
133
+ )
134
+
135
+ jwt_authorities[jwk.key_id] = jwk.key
136
+
137
+ return JwtBundle(trust_domain, jwt_authorities)
138
+
139
+ def __eq__(self, o: object) -> bool:
140
+ if not isinstance(o, JwtBundle):
141
+ return False
142
+ with self.lock:
143
+ return (
144
+ self._trust_domain.__eq__(o._trust_domain)
145
+ and self._jwt_authorities == o._jwt_authorities
146
+ )
147
+
148
+ def __hash__(self):
149
+ trust_domain_hash = hash(self.trust_domain)
150
+ authorities_hash = hash(tuple(hash(authority) for authority in self._jwt_authorities))
151
+ return hash((trust_domain_hash, authorities_hash))