These records will be anonymized (personal identifiers removed) but retained for legal compliance.
+
Warning: This action cannot be undone. Once confirmed, your account will be permanently deactivated and your personal data will be deleted or anonymized.
+
If you did not make this request, please ignore this email or contact our support team immediately.
+
+
This is an automated message. Please do not reply to this email.
+
+
+ """
+ await send_email(to=user_email, subject=email_subject, html=email_html)
+ except Exception as e:
+ logger.warning(f'Failed to send GDPR deletion email notification: {str(e)}')
+
return gdpr_request
@staticmethod
async def export_user_data(
db: Session,
- user_id: int,
- request_id: Optional[int] = None
+ user_id: Optional[int] = None,
+ user_email: Optional[str] = None,
+ request_id: Optional[int] = None,
+ is_anonymous: bool = False
) -> Dict[str, Any]:
- """Export all user data in JSON format."""
- user = db.query(User).filter(User.id == user_id).first()
- if not user:
- raise ValueError('User not found')
+ """Export all user data in JSON format (supports anonymous users by email)."""
+ # For authenticated users
+ if user_id and not is_anonymous:
+ user = db.query(User).filter(User.id == user_id).first()
+ if not user:
+ raise ValueError('User not found')
+ user_email = user.email
+ elif is_anonymous and user_email:
+ # For anonymous users, try to find user by email
+ user = db.query(User).filter(User.email == user_email).first()
+ if user:
+ user_id = user.id
+ is_anonymous = False # Found registered user
+ else:
+ raise ValueError('Either user_id or user_email must be provided')
# Collect all user data
- export_data = {
- 'user': {
- 'id': user.id,
- 'email': user.email,
- 'full_name': user.full_name,
- 'phone': user.phone,
- 'address': user.address,
- 'currency': getattr(user, 'currency', None),
- 'created_at': user.created_at.isoformat() if user.created_at else None,
- 'updated_at': user.updated_at.isoformat() if user.updated_at else None,
- },
- 'bookings': [],
- 'payments': [],
- 'invoices': [],
- 'reviews': [],
- 'export_date': datetime.utcnow().isoformat()
- }
-
- # Get bookings
- bookings = db.query(Booking).filter(Booking.user_id == user_id).all()
- for booking in bookings:
- export_data['bookings'].append({
- 'id': booking.id,
- 'booking_number': booking.booking_number,
- 'check_in_date': booking.check_in_date.isoformat() if booking.check_in_date else None,
- 'check_out_date': booking.check_out_date.isoformat() if booking.check_out_date else None,
- 'status': booking.status.value if hasattr(booking.status, 'value') else str(booking.status),
- 'total_price': float(booking.total_price) if booking.total_price else None,
- 'created_at': booking.created_at.isoformat() if booking.created_at else None,
- })
-
- # Get payments
- payments = db.query(Payment).filter(Payment.user_id == user_id).all()
- for payment in payments:
- export_data['payments'].append({
- 'id': payment.id,
- 'amount': float(payment.amount) if payment.amount else None,
- 'payment_method': payment.payment_method.value if hasattr(payment.payment_method, 'value') else str(payment.payment_method),
- 'payment_status': payment.payment_status.value if hasattr(payment.payment_status, 'value') else str(payment.payment_status),
- 'payment_date': payment.payment_date.isoformat() if payment.payment_date else None,
- 'created_at': payment.created_at.isoformat() if payment.created_at else None,
- })
-
- # Get invoices
- invoices = db.query(Invoice).filter(Invoice.user_id == user_id).all()
- for invoice in invoices:
- export_data['invoices'].append({
- 'id': invoice.id,
- 'invoice_number': invoice.invoice_number,
- 'total_amount': float(invoice.total_amount) if invoice.total_amount else None,
- 'status': invoice.status.value if hasattr(invoice.status, 'value') else str(invoice.status),
- 'issue_date': invoice.issue_date.isoformat() if invoice.issue_date else None,
- })
-
- # Get reviews
- reviews = db.query(Review).filter(Review.user_id == user_id).all()
- for review in reviews:
- export_data['reviews'].append({
- 'id': review.id,
- 'rating': review.rating,
- 'comment': review.comment,
- 'created_at': review.created_at.isoformat() if review.created_at else None,
- })
+ if user_id:
+ export_data = {
+ 'user': {
+ 'id': user.id,
+ 'email': user.email,
+ 'full_name': user.full_name,
+ 'phone': user.phone,
+ 'address': user.address,
+ 'currency': getattr(user, 'currency', None),
+ 'created_at': user.created_at.isoformat() if user.created_at else None,
+ 'updated_at': user.updated_at.isoformat() if user.updated_at else None,
+ },
+ 'bookings': [],
+ 'payments': [],
+ 'invoices': [],
+ 'reviews': [],
+ 'sessions': [],
+ 'export_date': datetime.utcnow().isoformat(),
+ 'is_anonymous': False
+ }
+
+ # Get bookings
+ bookings = db.query(Booking).filter(Booking.user_id == user_id).all()
+ for booking in bookings:
+ export_data['bookings'].append({
+ 'id': booking.id,
+ 'booking_number': booking.booking_number,
+ 'check_in_date': booking.check_in_date.isoformat() if booking.check_in_date else None,
+ 'check_out_date': booking.check_out_date.isoformat() if booking.check_out_date else None,
+ 'status': booking.status.value if hasattr(booking.status, 'value') else str(booking.status),
+ 'total_price': float(booking.total_price) if booking.total_price else None,
+ 'created_at': booking.created_at.isoformat() if booking.created_at else None,
+ })
+
+ # Get payments
+ payments = db.query(Payment).filter(Payment.user_id == user_id).all()
+ for payment in payments:
+ export_data['payments'].append({
+ 'id': payment.id,
+ 'amount': float(payment.amount) if payment.amount else None,
+ 'payment_method': payment.payment_method.value if hasattr(payment.payment_method, 'value') else str(payment.payment_method),
+ 'payment_status': payment.payment_status.value if hasattr(payment.payment_status, 'value') else str(payment.payment_status),
+ 'payment_date': payment.payment_date.isoformat() if payment.payment_date else None,
+ 'created_at': payment.created_at.isoformat() if payment.created_at else None,
+ })
+
+ # Get invoices
+ invoices = db.query(Invoice).filter(Invoice.user_id == user_id).all()
+ for invoice in invoices:
+ export_data['invoices'].append({
+ 'id': invoice.id,
+ 'invoice_number': invoice.invoice_number,
+ 'total_amount': float(invoice.total_amount) if invoice.total_amount else None,
+ 'status': invoice.status.value if hasattr(invoice.status, 'value') else str(invoice.status),
+ 'issue_date': invoice.issue_date.isoformat() if invoice.issue_date else None,
+ })
+
+ # Get reviews
+ reviews = db.query(Review).filter(Review.user_id == user_id).all()
+ for review in reviews:
+ export_data['reviews'].append({
+ 'id': review.id,
+ 'rating': review.rating,
+ 'comment': review.comment,
+ 'created_at': review.created_at.isoformat() if review.created_at else None,
+ })
+
+ # Get active sessions
+ try:
+ from ...auth.models.user_session import UserSession
+ sessions = db.query(UserSession).filter(UserSession.user_id == user_id).all()
+ for session in sessions:
+ export_data['sessions'].append({
+ 'id': session.id,
+ 'session_token': session.session_token[:20] + '...' if session.session_token else None, # Partial token for security
+ 'ip_address': session.ip_address,
+ 'user_agent': session.user_agent,
+ 'is_active': session.is_active if hasattr(session, 'is_active') else True,
+ 'created_at': session.created_at.isoformat() if session.created_at else None,
+ 'last_activity': session.last_activity.isoformat() if hasattr(session, 'last_activity') and session.last_activity else None,
+ 'expires_at': session.expires_at.isoformat() if hasattr(session, 'expires_at') and session.expires_at else None,
+ })
+ except Exception as e:
+ logger.warning(f'Could not fetch sessions for user: {str(e)}')
+ export_data['sessions'] = []
+ else:
+ # Anonymous user - collect data by email
+ export_data = {
+ 'user': {
+ 'email': user_email,
+ 'is_anonymous': True
+ },
+ 'bookings': [],
+ 'payments': [],
+ 'invoices': [],
+ 'reviews': [],
+ 'sessions': [],
+ 'export_date': datetime.utcnow().isoformat(),
+ 'is_anonymous': True
+ }
+
+ # Try to find bookings by guest email (if stored)
+ # Note: This depends on your booking model structure
+ # You may need to adjust based on how guest emails are stored
+ try:
+ from ...bookings.models.booking import Booking
+ # If bookings have guest_email field
+ if hasattr(Booking, 'guest_email'):
+ bookings = db.query(Booking).filter(Booking.guest_email == user_email).all()
+ for booking in bookings:
+ export_data['bookings'].append({
+ 'id': booking.id,
+ 'booking_number': booking.booking_number,
+ 'check_in_date': booking.check_in_date.isoformat() if booking.check_in_date else None,
+ 'check_out_date': booking.check_out_date.isoformat() if booking.check_out_date else None,
+ 'status': booking.status.value if hasattr(booking.status, 'value') else str(booking.status),
+ 'total_price': float(booking.total_price) if booking.total_price else None,
+ 'created_at': booking.created_at.isoformat() if booking.created_at else None,
+ })
+ except Exception as e:
+ logger.warning(f'Could not fetch bookings for anonymous user: {str(e)}')
+
+ # Get GDPR requests for this email
+ gdpr_requests = db.query(GDPRRequest).filter(GDPRRequest.user_email == user_email).all()
+ export_data['gdpr_requests'] = [{
+ 'id': req.id,
+ 'request_type': req.request_type.value,
+ 'status': req.status.value,
+ 'created_at': req.created_at.isoformat() if req.created_at else None,
+ } for req in gdpr_requests]
# Save export file
if request_id:
export_dir = Path(settings.UPLOAD_DIR) / 'gdpr_exports'
export_dir.mkdir(parents=True, exist_ok=True)
- filename = f'user_{user_id}_export_{datetime.utcnow().strftime("%Y%m%d_%H%M%S")}.json'
+ identifier = f'user_{user_id}' if user_id else f'email_{user_email.replace("@", "_at_")}'
+ filename = f'{identifier}_export_{datetime.utcnow().strftime("%Y%m%d_%H%M%S")}.json'
file_path = export_dir / filename
with open(file_path, 'w', encoding='utf-8') as f:
@@ -209,65 +414,268 @@ class GDPRService:
gdpr_request.status = GDPRRequestStatus.completed
gdpr_request.processed_at = datetime.utcnow()
db.commit()
+
+ # Send email notification that export is ready
+ try:
+ client_url = settings.CLIENT_URL or 'http://localhost:5173'
+ download_link = f"{client_url}/gdpr/export/{request_id}?token={gdpr_request.verification_token}"
+
+ email_subject = "Your Data Export is Ready - GDPR"
+ email_html = f"""
+
+
+
Your Data Export is Ready
+
Hello,
+
Your personal data export (Request ID: {request_id}) has been prepared and is ready for download.
+
+The ultimate Python library in building OAuth and OpenID Connect servers.
+JWS, JWK, JWA, JWT are included.
+
+Authlib is compatible with Python3.9+.
+
+## Migrations
+
+Authlib will deprecate `authlib.jose` module, please read:
+
+- [Migrating from `authlib.jose` to `joserfc`](https://jose.authlib.org/en/dev/migrations/authlib/)
+
+## Sponsors
+
+
+
+
+
If you want to quickly add secure token-based authentication to Python projects, feel free to check Auth0's Python SDK and free plan at auth0.com/overview.
+
+
+
+
A blogging and podcast hosting platform with minimal design but powerful features. Host your blog and Podcast with Typlog.com.
+
+
+
+
+[**Fund Authlib to access additional features**](https://docs.authlib.org/en/latest/community/funding.html)
+
+## Features
+
+Generic, spec-compliant implementation to build clients and providers:
+
+- [The OAuth 1.0 Protocol](https://docs.authlib.org/en/latest/basic/oauth1.html)
+ - [RFC5849: The OAuth 1.0 Protocol](https://docs.authlib.org/en/latest/specs/rfc5849.html)
+- [The OAuth 2.0 Authorization Framework](https://docs.authlib.org/en/latest/basic/oauth2.html)
+ - [RFC6749: The OAuth 2.0 Authorization Framework](https://docs.authlib.org/en/latest/specs/rfc6749.html)
+ - [RFC6750: The OAuth 2.0 Authorization Framework: Bearer Token Usage](https://docs.authlib.org/en/latest/specs/rfc6750.html)
+ - [RFC7009: OAuth 2.0 Token Revocation](https://docs.authlib.org/en/latest/specs/rfc7009.html)
+ - [RFC7523: JWT Profile for OAuth 2.0 Client Authentication and Authorization Grants](https://docs.authlib.org/en/latest/specs/rfc7523.html)
+ - [RFC7591: OAuth 2.0 Dynamic Client Registration Protocol](https://docs.authlib.org/en/latest/specs/rfc7591.html)
+ - [RFC7592: OAuth 2.0 Dynamic Client Registration Management Protocol](https://docs.authlib.org/en/latest/specs/rfc7592.html)
+ - [RFC7636: Proof Key for Code Exchange by OAuth Public Clients](https://docs.authlib.org/en/latest/specs/rfc7636.html)
+ - [RFC7662: OAuth 2.0 Token Introspection](https://docs.authlib.org/en/latest/specs/rfc7662.html)
+ - [RFC8414: OAuth 2.0 Authorization Server Metadata](https://docs.authlib.org/en/latest/specs/rfc8414.html)
+ - [RFC8628: OAuth 2.0 Device Authorization Grant](https://docs.authlib.org/en/latest/specs/rfc8628.html)
+ - [RFC9068: JSON Web Token (JWT) Profile for OAuth 2.0 Access Tokens](https://docs.authlib.org/en/latest/specs/rfc9068.html)
+ - [RFC9101: The OAuth 2.0 Authorization Framework: JWT-Secured Authorization Request (JAR)](https://docs.authlib.org/en/latest/specs/rfc9101.html)
+ - [RFC9207: OAuth 2.0 Authorization Server Issuer Identification](https://docs.authlib.org/en/latest/specs/rfc9207.html)
+- [Javascript Object Signing and Encryption](https://docs.authlib.org/en/latest/jose/index.html)
+ - [RFC7515: JSON Web Signature](https://docs.authlib.org/en/latest/jose/jws.html)
+ - [RFC7516: JSON Web Encryption](https://docs.authlib.org/en/latest/jose/jwe.html)
+ - [RFC7517: JSON Web Key](https://docs.authlib.org/en/latest/jose/jwk.html)
+ - [RFC7518: JSON Web Algorithms](https://docs.authlib.org/en/latest/specs/rfc7518.html)
+ - [RFC7519: JSON Web Token](https://docs.authlib.org/en/latest/jose/jwt.html)
+ - [RFC7638: JSON Web Key (JWK) Thumbprint](https://docs.authlib.org/en/latest/specs/rfc7638.html)
+ - [ ] RFC7797: JSON Web Signature (JWS) Unencoded Payload Option
+ - [RFC8037: ECDH in JWS and JWE](https://docs.authlib.org/en/latest/specs/rfc8037.html)
+ - [ ] draft-madden-jose-ecdh-1pu-04: Public Key Authenticated Encryption for JOSE: ECDH-1PU
+- [OpenID Connect 1.0](https://docs.authlib.org/en/latest/specs/oidc.html)
+ - [x] OpenID Connect Core 1.0
+ - [x] OpenID Connect Discovery 1.0
+ - [x] OpenID Connect Dynamic Client Registration 1.0
+
+Connect third party OAuth providers with Authlib built-in client integrations:
+
+- Requests
+ - [OAuth1Session](https://docs.authlib.org/en/latest/client/requests.html#requests-oauth-1-0)
+ - [OAuth2Session](https://docs.authlib.org/en/latest/client/requests.html#requests-oauth-2-0)
+ - [OpenID Connect](https://docs.authlib.org/en/latest/client/requests.html#requests-openid-connect)
+ - [AssertionSession](https://docs.authlib.org/en/latest/client/requests.html#requests-service-account)
+- HTTPX
+ - [AsyncOAuth1Client](https://docs.authlib.org/en/latest/client/httpx.html#httpx-oauth-1-0)
+ - [AsyncOAuth2Client](https://docs.authlib.org/en/latest/client/httpx.html#httpx-oauth-2-0)
+ - [OpenID Connect](https://docs.authlib.org/en/latest/client/httpx.html#httpx-oauth-2-0)
+ - [AsyncAssertionClient](https://docs.authlib.org/en/latest/client/httpx.html#async-service-account)
+- [Flask OAuth Client](https://docs.authlib.org/en/latest/client/flask.html)
+- [Django OAuth Client](https://docs.authlib.org/en/latest/client/django.html)
+- [Starlette OAuth Client](https://docs.authlib.org/en/latest/client/starlette.html)
+- [FastAPI OAuth Client](https://docs.authlib.org/en/latest/client/fastapi.html)
+
+Build your own OAuth 1.0, OAuth 2.0, and OpenID Connect providers:
+
+- Flask
+ - [Flask OAuth 1.0 Provider](https://docs.authlib.org/en/latest/flask/1/)
+ - [Flask OAuth 2.0 Provider](https://docs.authlib.org/en/latest/flask/2/)
+ - [Flask OpenID Connect 1.0 Provider](https://docs.authlib.org/en/latest/flask/2/openid-connect.html)
+- Django
+ - [Django OAuth 1.0 Provider](https://docs.authlib.org/en/latest/django/1/)
+ - [Django OAuth 2.0 Provider](https://docs.authlib.org/en/latest/django/2/)
+ - [Django OpenID Connect 1.0 Provider](https://docs.authlib.org/en/latest/django/2/openid-connect.html)
+
+## Useful Links
+
+1. Homepage: .
+2. Documentation: .
+3. Purchase Commercial License: .
+4. Blog: .
+5. Twitter: .
+6. StackOverflow: .
+7. Other Repositories: .
+8. Subscribe Tidelift: [https://tidelift.com/subscription/pkg/pypi-authlib](https://tidelift.com/subscription/pkg/pypi-authlib?utm_source=pypi-authlib&utm_medium=referral&utm_campaign=links).
+
+## Security Reporting
+
+If you found security bugs, please do not send a public issue or patch.
+You can send me email at . Attachment with patch is welcome.
+My PGP Key fingerprint is:
+
+```
+72F8 E895 A70C EBDF 4F2A DFE0 7E55 E3E0 118B 2B4C
+```
+
+Or, you can use the [Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+
+## License
+
+Authlib offers two licenses:
+
+1. BSD LICENSE
+2. COMMERCIAL-LICENSE
+
+Any project, open or closed source, can use the BSD license.
+If your company needs commercial support, you can purchase a commercial license at
+[Authlib Plans](https://authlib.org/plans). You can find more information at
+.
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/RECORD
new file mode 100644
index 00000000..7e2f0284
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/RECORD
@@ -0,0 +1,408 @@
+authlib-1.6.5.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+authlib-1.6.5.dist-info/METADATA,sha256=JSpi4anvkVQ9zL3GuZR4mvuto9yjFI39uhUnGfKGwdY,9845
+authlib-1.6.5.dist-info/RECORD,,
+authlib-1.6.5.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+authlib-1.6.5.dist-info/licenses/LICENSE,sha256=jhtIUY3pxs0Ay0jH_luAI_2Q1VUsoS6-c2Kg3zDdvkU,1514
+authlib-1.6.5.dist-info/top_level.txt,sha256=Rj3mJn0jhRuCs6x7ysI6hYE2PePbuxey6y6jswadAEY,8
+authlib/__init__.py,sha256=9F2r7k-nrTBFVDVWk0oghhIpLioCwQtt-35ppwRNfGU,487
+authlib/__pycache__/__init__.cpython-312.pyc,,
+authlib/__pycache__/consts.cpython-312.pyc,,
+authlib/__pycache__/deprecate.cpython-312.pyc,,
+authlib/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+authlib/common/__pycache__/__init__.cpython-312.pyc,,
+authlib/common/__pycache__/encoding.cpython-312.pyc,,
+authlib/common/__pycache__/errors.cpython-312.pyc,,
+authlib/common/__pycache__/security.cpython-312.pyc,,
+authlib/common/__pycache__/urls.cpython-312.pyc,,
+authlib/common/encoding.py,sha256=S80EkhVVJABStdEuZvQV1c47gQnu359fgLAFDmqLaP0,1544
+authlib/common/errors.py,sha256=L4_CDCQ7M08lrnM17QJWrLXoIeqatzRT6WcFno4FKtE,1667
+authlib/common/security.py,sha256=l1h1XneIeWVvjwqnkyaHMihXbEqh3nyBpANiCKxtd3k,514
+authlib/common/urls.py,sha256=pCB5_cGXxpQckQgKMz-vhtObT07G75B8yUMpMHvx24I,4581
+authlib/consts.py,sha256=9cqeotlkDe69rVuzp_CwFO01qxVvyzzzbB2UpHWEvDg,299
+authlib/deprecate.py,sha256=BaH7IdSK0WEmanyJAl7-Rpmvm6NJcez-Z03k0OYPXl0,506
+authlib/integrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+authlib/integrations/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/base_client/__init__.py,sha256=0nRNGKgwojLqaTwnbDfXqLiEjNY9aY4AST_zUtXy-WU,820
+authlib/integrations/base_client/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/base_client/__pycache__/async_app.cpython-312.pyc,,
+authlib/integrations/base_client/__pycache__/async_openid.cpython-312.pyc,,
+authlib/integrations/base_client/__pycache__/errors.cpython-312.pyc,,
+authlib/integrations/base_client/__pycache__/framework_integration.cpython-312.pyc,,
+authlib/integrations/base_client/__pycache__/registry.cpython-312.pyc,,
+authlib/integrations/base_client/__pycache__/sync_app.cpython-312.pyc,,
+authlib/integrations/base_client/__pycache__/sync_openid.cpython-312.pyc,,
+authlib/integrations/base_client/async_app.py,sha256=Pw3KIzxFtBG1ZXHg4hfV-D-hX0ubNU34s8bF9IHRm-g,5978
+authlib/integrations/base_client/async_openid.py,sha256=imBoGouxPu4hMwjmxCu8JMgDADZOMdpCbc_B-LSULl4,2982
+authlib/integrations/base_client/errors.py,sha256=Iniwp6d3XJ0Q3bYQcOB1tnCQhMKcYv8wLH7BAFHICAA,632
+authlib/integrations/base_client/framework_integration.py,sha256=LQFGmr0RyebVWAw1rU7cEwIYK_WiWKA00IVMxn_H5PQ,1871
+authlib/integrations/base_client/registry.py,sha256=GV0IJqZzPtsJHb-tl4t38K_Yvv3q4NPvp851V_UzDxY,4313
+authlib/integrations/base_client/sync_app.py,sha256=3dWAUHefD1-3qoaWUr9w-rOwVsnJ2jB8GiKLMoYTDp4,12791
+authlib/integrations/base_client/sync_openid.py,sha256=qtUXnzSqHZZATr3BejSBdTy51QkHg_r_i7GwWilvCHo,3165
+authlib/integrations/django_client/__init__.py,sha256=z3jiicS7KZigQKbwVsNlYyIHYKDFdiJi0848iNkl8gk,516
+authlib/integrations/django_client/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/django_client/__pycache__/apps.cpython-312.pyc,,
+authlib/integrations/django_client/__pycache__/integration.cpython-312.pyc,,
+authlib/integrations/django_client/apps.py,sha256=pUZSshw7cP9mVSN6_YD8eq_8hysSCbiPau38QBppmOM,3680
+authlib/integrations/django_client/integration.py,sha256=VTUyAp7ijC0RfPyZ5_w0yqL1LfnrTzemFG68nNd-afU,651
+authlib/integrations/django_oauth1/__init__.py,sha256=dXgyMkdXR5d6XpBnx_Wrkkrj7LebJrgQU7dK6lm84Dk,229
+authlib/integrations/django_oauth1/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/django_oauth1/__pycache__/authorization_server.cpython-312.pyc,,
+authlib/integrations/django_oauth1/__pycache__/nonce.cpython-312.pyc,,
+authlib/integrations/django_oauth1/__pycache__/resource_protector.cpython-312.pyc,,
+authlib/integrations/django_oauth1/authorization_server.py,sha256=xtI50oMRKfA5tkbuIWPQP98Wx5_-W6KZQ8NzNA4uloE,4560
+authlib/integrations/django_oauth1/nonce.py,sha256=jwhnA3SFCoGtEN7LBLv3pyKc1rWepFM9_iTSpt6BvR4,396
+authlib/integrations/django_oauth1/resource_protector.py,sha256=xSpHsX7X88IXwE4Qb0pHMPPiEag_ZalGBjFZqt9nG4o,2332
+authlib/integrations/django_oauth2/__init__.py,sha256=gmWoCspRgvmtO3VuA34-FluF5pmgbo-oQyeD1KW2rVQ,333
+authlib/integrations/django_oauth2/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/django_oauth2/__pycache__/authorization_server.cpython-312.pyc,,
+authlib/integrations/django_oauth2/__pycache__/endpoints.cpython-312.pyc,,
+authlib/integrations/django_oauth2/__pycache__/requests.cpython-312.pyc,,
+authlib/integrations/django_oauth2/__pycache__/resource_protector.cpython-312.pyc,,
+authlib/integrations/django_oauth2/__pycache__/signals.cpython-312.pyc,,
+authlib/integrations/django_oauth2/authorization_server.py,sha256=6P0pYQpS83igXm-XyUmdIfTLq0_O3kpKApEVDynHaZA,4463
+authlib/integrations/django_oauth2/endpoints.py,sha256=dlGwktdT_miFCZDKYTFaiKxBPxBlL0cGlJCsE19wBv4,1838
+authlib/integrations/django_oauth2/requests.py,sha256=Qkk-G-VLlQwfh_QA2Wq9NBQr5EYnYGUSvX_ba9WZc5g,1850
+authlib/integrations/django_oauth2/resource_protector.py,sha256=QTrO0nZWJVki2lggx80Ud9y9bM9wBTBRn4SXvchhMf0,2597
+authlib/integrations/django_oauth2/signals.py,sha256=tc_NkIL4Gx55P6qlpRU19bCkkPiMLLehLoL95pSuKw0,235
+authlib/integrations/flask_client/__init__.py,sha256=mtpFrXZD656128GjJYODkK0aLOozxIs2XYkU9WgmB5M,1765
+authlib/integrations/flask_client/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/flask_client/__pycache__/apps.cpython-312.pyc,,
+authlib/integrations/flask_client/__pycache__/integration.cpython-312.pyc,,
+authlib/integrations/flask_client/apps.py,sha256=3bHPdP3V-0Vry_1Svja_YMrCFJD_4zpAgC0R2h3jrq8,4012
+authlib/integrations/flask_client/integration.py,sha256=a2TbWN0QLEi_l2srr8RoKDRHkChmvymgugbvOTnG2dc,806
+authlib/integrations/flask_oauth1/__init__.py,sha256=IJKe9D2jZdtZ2feLWBAaef5TIGw8WYpeUVvswA1S6lk,310
+authlib/integrations/flask_oauth1/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/flask_oauth1/__pycache__/authorization_server.cpython-312.pyc,,
+authlib/integrations/flask_oauth1/__pycache__/cache.cpython-312.pyc,,
+authlib/integrations/flask_oauth1/__pycache__/resource_protector.cpython-312.pyc,,
+authlib/integrations/flask_oauth1/authorization_server.py,sha256=mogA8tai-cU2-0c1JL8av_e47SXXbaEDbk6hjD9fEkE,6146
+authlib/integrations/flask_oauth1/cache.py,sha256=iF_mvWvkv6S7n0bm5Q9kUqBIlXcmwgxx01chPZM27xo,3012
+authlib/integrations/flask_oauth1/resource_protector.py,sha256=h3nDaEc1W7eRht4jLROURCDsZfFX9Ak9JyPGWJv63Eg,3842
+authlib/integrations/flask_oauth2/__init__.py,sha256=cQ7vhDQuXp2R5IMPTpb6rR0ChKAt_tmY95mlrOjYXOc,284
+authlib/integrations/flask_oauth2/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/flask_oauth2/__pycache__/authorization_server.cpython-312.pyc,,
+authlib/integrations/flask_oauth2/__pycache__/errors.cpython-312.pyc,,
+authlib/integrations/flask_oauth2/__pycache__/requests.cpython-312.pyc,,
+authlib/integrations/flask_oauth2/__pycache__/resource_protector.cpython-312.pyc,,
+authlib/integrations/flask_oauth2/__pycache__/signals.cpython-312.pyc,,
+authlib/integrations/flask_oauth2/authorization_server.py,sha256=rWrRJh3pr6tito6OKYGTbdY4Y2OYMKyMmD20CtmVb1s,5911
+authlib/integrations/flask_oauth2/errors.py,sha256=ku67ILaSYS9i028Ipx26TYslXTK9UWiumqf07tjbICo,1085
+authlib/integrations/flask_oauth2/requests.py,sha256=DcLTETbx0OjNa8mpjRr4UKifuni1oXGQOHBlXF1WWSk,1480
+authlib/integrations/flask_oauth2/resource_protector.py,sha256=s0LbjE0nTKbEIqngEe0chphOlULh9LmzVIiEdszd7ts,3875
+authlib/integrations/flask_oauth2/signals.py,sha256=ZgwcCoNMSmrUQJHUv0uMSH9FBzdDE1izWg-0IcuKc6U,341
+authlib/integrations/httpx_client/__init__.py,sha256=rx-XuWSaX5g33eYKLuzg5loNEN5tFwOS5jaKzuU6DHY,1107
+authlib/integrations/httpx_client/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/httpx_client/__pycache__/assertion_client.cpython-312.pyc,,
+authlib/integrations/httpx_client/__pycache__/oauth1_client.cpython-312.pyc,,
+authlib/integrations/httpx_client/__pycache__/oauth2_client.cpython-312.pyc,,
+authlib/integrations/httpx_client/__pycache__/utils.cpython-312.pyc,,
+authlib/integrations/httpx_client/assertion_client.py,sha256=9G5z8bjo6tuegPQLSA8TVd87EB9Lw2kSToHD-2BqZAs,3714
+authlib/integrations/httpx_client/oauth1_client.py,sha256=gEln9rwPVCWHw-iJDTa-IsO04Qz-FClkb6jhjuMj9oM,4606
+authlib/integrations/httpx_client/oauth2_client.py,sha256=z7UPymDAHhDQmnYogjhFWqahpCpvMcHzZWhZdQ3kHZU,9215
+authlib/integrations/httpx_client/utils.py,sha256=V97V1dcy1wK7Rmr7T35C7M2zsTAOrdmG_PcU4MV0XY0,942
+authlib/integrations/requests_client/__init__.py,sha256=dJWn99gMa6NXQ0XfQSZczttF9OUX7a936L1PtHE-9mk,831
+authlib/integrations/requests_client/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/requests_client/__pycache__/assertion_session.cpython-312.pyc,,
+authlib/integrations/requests_client/__pycache__/oauth1_session.cpython-312.pyc,,
+authlib/integrations/requests_client/__pycache__/oauth2_session.cpython-312.pyc,,
+authlib/integrations/requests_client/__pycache__/utils.cpython-312.pyc,,
+authlib/integrations/requests_client/assertion_session.py,sha256=oB_wsJjJddb5aXGEQA3XMMurYh5u9m2b8MzXFaL6mmI,2073
+authlib/integrations/requests_client/oauth1_session.py,sha256=Jn_m0lOWyHTfM7onIEIKA8CX-kwtaB55KAF-358jV_U,2324
+authlib/integrations/requests_client/oauth2_session.py,sha256=sf1w6igzC5d38PBCmdKBpb_3MAiHw5sucN1Sw4OKgsc,4979
+authlib/integrations/requests_client/utils.py,sha256=k1g63rcfRsJAIyhRjIol1oe81KbZ7JO6GSrg_bqa4cE,294
+authlib/integrations/sqla_oauth2/__init__.py,sha256=swHbsKMO9RwsgLLCKFV5Q1jGpXtGvot1PhBucp5b0UM,652
+authlib/integrations/sqla_oauth2/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/sqla_oauth2/__pycache__/client_mixin.cpython-312.pyc,,
+authlib/integrations/sqla_oauth2/__pycache__/functions.cpython-312.pyc,,
+authlib/integrations/sqla_oauth2/__pycache__/tokens_mixins.cpython-312.pyc,,
+authlib/integrations/sqla_oauth2/client_mixin.py,sha256=4hTqHeS34JUFJLLvOJqpfzBGo8FysYf22BW3l_a9qpY,4371
+authlib/integrations/sqla_oauth2/functions.py,sha256=Lc_mK1LV_FonUUHXmswxlze7NPyAhs-pxW1pOGgWxXw,3156
+authlib/integrations/sqla_oauth2/tokens_mixins.py,sha256=B62cFI-jZhtIU79of6l6Lxzia6tnutZHMeZrpSLIEd8,2261
+authlib/integrations/starlette_client/__init__.py,sha256=qIPzeCFSCJ1AnCJ_I9tvmL2qDOJtaPUwgG7Mb4wz3VI,713
+authlib/integrations/starlette_client/__pycache__/__init__.cpython-312.pyc,,
+authlib/integrations/starlette_client/__pycache__/apps.cpython-312.pyc,,
+authlib/integrations/starlette_client/__pycache__/integration.cpython-312.pyc,,
+authlib/integrations/starlette_client/apps.py,sha256=3rIzMYCzdu4ajfyaHlBeFIJb6gI8lBjNl_Ry7VTT_go,4140
+authlib/integrations/starlette_client/integration.py,sha256=Dlu7w36dPrBz_-ybcwmOasGrZprQiCQ9IQqd47VeDQk,2253
+authlib/jose/__init__.py,sha256=wtdmtHrQV3a3-us9K6nVVGHrC82zSJ27FX106uUxeLI,1703
+authlib/jose/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/__pycache__/errors.cpython-312.pyc,,
+authlib/jose/__pycache__/jwk.cpython-312.pyc,,
+authlib/jose/__pycache__/util.cpython-312.pyc,,
+authlib/jose/drafts/__init__.py,sha256=AXAw9r6-6XsVbugtoJ6zFn0u85iYDssVLLbDGm-HIWU,520
+authlib/jose/drafts/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/drafts/__pycache__/_jwe_algorithms.cpython-312.pyc,,
+authlib/jose/drafts/__pycache__/_jwe_enc_cryptodome.cpython-312.pyc,,
+authlib/jose/drafts/__pycache__/_jwe_enc_cryptography.cpython-312.pyc,,
+authlib/jose/drafts/_jwe_algorithms.py,sha256=qkYzPAteYSs1jRZGc3lxBVPbYy8jFgf_O2GE-LW0xUM,7199
+authlib/jose/drafts/_jwe_enc_cryptodome.py,sha256=-Qq-JWsBrui5-UJW1QqDltsJCygvWAicSkbQqcH0jdo,1848
+authlib/jose/drafts/_jwe_enc_cryptography.py,sha256=yd63oNubl-vSMC8H_g8xFGCMa3AUEhOzrXQnGS2TBSU,1731
+authlib/jose/errors.py,sha256=NK3sAewwLTZ6eaNS4QVcpndf3oL2CySrwsF9xiTWDqs,3199
+authlib/jose/jwk.py,sha256=LqCE7K1WozgSR_UHwXEajwVJjjBwXkIKebT1Z_AzFE0,491
+authlib/jose/rfc7515/__init__.py,sha256=ub5iDwyqk1z_W1QSFqtFn6tEJvLqEgMg6ftHmGVsSvQ,367
+authlib/jose/rfc7515/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/rfc7515/__pycache__/jws.cpython-312.pyc,,
+authlib/jose/rfc7515/__pycache__/models.cpython-312.pyc,,
+authlib/jose/rfc7515/jws.py,sha256=QmpynjXy9YgMDP9V1ESSqivA3fFkoAFmoWy4DjBfr6s,13720
+authlib/jose/rfc7515/models.py,sha256=81IbGsdq9I4Qe0NIusgRia4G3CFsh70gWf2v9lT9kJA,2448
+authlib/jose/rfc7516/__init__.py,sha256=85pDv76XJrL_ZVl89Thr6ilzM9yelMWGBad20klWjDM,514
+authlib/jose/rfc7516/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/rfc7516/__pycache__/jwe.cpython-312.pyc,,
+authlib/jose/rfc7516/__pycache__/models.cpython-312.pyc,,
+authlib/jose/rfc7516/jwe.py,sha256=MTOtywMG6Ji2-PM0paW4jx4r5q1zVC0GNL3pZveGHu4,30539
+authlib/jose/rfc7516/models.py,sha256=vzYq1du-F59IqFlcGnTATVCDLEy0Tsisz5yF57tcppw,4381
+authlib/jose/rfc7517/__init__.py,sha256=RmMT_4O1d4YaqVl_5V5bM0blqXqjdKZsdYNQObtTkPc,404
+authlib/jose/rfc7517/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/rfc7517/__pycache__/_cryptography_key.cpython-312.pyc,,
+authlib/jose/rfc7517/__pycache__/asymmetric_key.cpython-312.pyc,,
+authlib/jose/rfc7517/__pycache__/base_key.cpython-312.pyc,,
+authlib/jose/rfc7517/__pycache__/jwk.cpython-312.pyc,,
+authlib/jose/rfc7517/__pycache__/key_set.cpython-312.pyc,,
+authlib/jose/rfc7517/_cryptography_key.py,sha256=bp-2kiKpzKdOWSuzMTCMhsyZdvdEUrv9nYVyNBlqqys,1361
+authlib/jose/rfc7517/asymmetric_key.py,sha256=NoCPBm8rjoW1Lonyt-LP44_TZnwceRv6DKHoRb4DDRw,6464
+authlib/jose/rfc7517/base_key.py,sha256=UCWMvQljfO2YJ7fkcVwDF2TSCSegHM_AI14KZsxEdK8,3358
+authlib/jose/rfc7517/jwk.py,sha256=1brj2H43cvLFrNQIbYtz7CPr_MCjG6amZuAgdzZWmFA,2029
+authlib/jose/rfc7517/key_set.py,sha256=5402vmOVxNplBgRTcLhj0sh09d8O8_XeyErG1yetnAs,1606
+authlib/jose/rfc7518/__init__.py,sha256=qvxQ-N7dlZu2d4qg30rH0JkNp-_eeaY0VK20vAv4V_U,963
+authlib/jose/rfc7518/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/ec_key.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/jwe_algs.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/jwe_encs.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/jwe_zips.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/jws_algs.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/oct_key.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/rsa_key.cpython-312.pyc,,
+authlib/jose/rfc7518/__pycache__/util.cpython-312.pyc,,
+authlib/jose/rfc7518/ec_key.py,sha256=IIpDO9hKzDGhOd8CxwxH08iO_6j7sR86cJBm6wN0SFw,3921
+authlib/jose/rfc7518/jwe_algs.py,sha256=tBw_lUUrs9RCYjyVi4OOu1_Fgh15Qtp-h4qHjCAc0e8,11422
+authlib/jose/rfc7518/jwe_encs.py,sha256=A0wKhj9u9hF_B51U7nHxZFQ5TskRfJ5Uube1DlvB8Aw,5093
+authlib/jose/rfc7518/jwe_zips.py,sha256=dFCRYN5J7_iHmiaB8t_FjUqRz966t2TYXrJ2lmvUJfg,1060
+authlib/jose/rfc7518/jws_algs.py,sha256=tCnBPwtlQ0gSY5LgW1F5FaKNT36kWkPHLXGxHBLLQCs,6573
+authlib/jose/rfc7518/oct_key.py,sha256=0XRdpxpFExYtlXse9ZAM6Bj-26fgZOHHBQdJoTdl1ec,2744
+authlib/jose/rfc7518/rsa_key.py,sha256=PmX2WWd3rLmwihqGhJYPW6C50aEmYghfbsZKPO_4bRU,4581
+authlib/jose/rfc7518/util.py,sha256=AMOegE7ypPLMSNF1a6hnhlHz55SmMtUbLB7ktZwRjAg,262
+authlib/jose/rfc7519/__init__.py,sha256=uK34VbVT-Rt5vFodcoyghHGPyEpepLN3PjASpT14QBU,307
+authlib/jose/rfc7519/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/rfc7519/__pycache__/claims.cpython-312.pyc,,
+authlib/jose/rfc7519/__pycache__/jwt.cpython-312.pyc,,
+authlib/jose/rfc7519/claims.py,sha256=hF6i3iBVMmbTs1Vir5tFBdjru6lNp5HdszvCbY_5-hE,8783
+authlib/jose/rfc7519/jwt.py,sha256=eRBCDh_dAEhkplDTuEIjFvTeu6M9VlAuyqiTwGRF50A,6185
+authlib/jose/rfc8037/__init__.py,sha256=v3uUtTKu4IvvusbHalhYtI1dt0OfsQQOJvZftBCS9sM,118
+authlib/jose/rfc8037/__pycache__/__init__.cpython-312.pyc,,
+authlib/jose/rfc8037/__pycache__/jws_eddsa.cpython-312.pyc,,
+authlib/jose/rfc8037/__pycache__/okp_key.cpython-312.pyc,,
+authlib/jose/rfc8037/jws_eddsa.py,sha256=Em1smAvwdGyNnHn2Hj5bL4QBFDlymXF1iY_-j6Ce9h4,717
+authlib/jose/rfc8037/okp_key.py,sha256=Ixo6Uh03HV09n_OuFxhV28bRMwKJNkRhWyRBCkz50LA,3995
+authlib/jose/util.py,sha256=24oOQ3Vnm9gUa0rDyEau9-l-F7ovzsDV6VbzxTscCiU,1357
+authlib/oauth1/__init__.py,sha256=XCfnQRF0ImgdyQitEiymsDptLP7v3VcSO1RQWzBPNPs,933
+authlib/oauth1/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth1/__pycache__/client.cpython-312.pyc,,
+authlib/oauth1/__pycache__/errors.cpython-312.pyc,,
+authlib/oauth1/client.py,sha256=PkrO_rpFDZnXQp586SkoLe7rLrz4i4ISYFBv_3UyxAk,6737
+authlib/oauth1/errors.py,sha256=pg0NaUgENjfTN_ba50_yQB9aSNe5Mte5MDlikFuypBY,46
+authlib/oauth1/rfc5849/__init__.py,sha256=Ta7spUuDIW4nBxQoDOZHUZYj42hjyl2h-T7lLq2xDeM,1136
+authlib/oauth1/rfc5849/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/authorization_server.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/base_server.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/client_auth.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/errors.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/models.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/parameters.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/resource_protector.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/rsa.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/signature.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/util.cpython-312.pyc,,
+authlib/oauth1/rfc5849/__pycache__/wrapper.cpython-312.pyc,,
+authlib/oauth1/rfc5849/authorization_server.py,sha256=y-vDQ79-CFjCl05V9kYqTDhFdCGCMZ9wY9S66mMjmBc,13924
+authlib/oauth1/rfc5849/base_server.py,sha256=BtBnisyOWP1epfzyp9A5zvMZu3rmCJazyHk9XEtpg8w,3972
+authlib/oauth1/rfc5849/client_auth.py,sha256=ovx0Hx5LfSX6hCezFPsHupIsiP0Lc0pfy80cPuwS-0k,7079
+authlib/oauth1/rfc5849/errors.py,sha256=iHVEoxrP0ieSjTJO2I9ThG2TvLs3XtRDssuCvu53OsY,2285
+authlib/oauth1/rfc5849/models.py,sha256=Pvh-7iKXU3zkMYq1nYbdAaxL3Vdg95cxmdaC5-KWxxg,3418
+authlib/oauth1/rfc5849/parameters.py,sha256=XpAcRz9MZjIUIs6IbthBK_fWzcL2Iy9jHUnFn3-W7zk,3532
+authlib/oauth1/rfc5849/resource_protector.py,sha256=sqZw4y0Eg4qsVggXyhbHMcui8nRp3OhAgtjX9eUH21U,1279
+authlib/oauth1/rfc5849/rsa.py,sha256=X2Dtld9hNnpi7RK_0sEuZXVPfi81aRyfEcKHshOmZdc,907
+authlib/oauth1/rfc5849/signature.py,sha256=7SGCVUm_Qb-MAeRYUelKVyOqfbfuu39dBkxT58HeAfs,14164
+authlib/oauth1/rfc5849/util.py,sha256=p9Kz8TkRqau3a-lQSJNCm7Dm79GG8fk5xTKjhNAEkvc,167
+authlib/oauth1/rfc5849/wrapper.py,sha256=_7Tl5K6_GkWtjXlr6o1jC-I2ZdgDem9p_nsuD4t63YQ,4073
+authlib/oauth2/__init__.py,sha256=okdXo25jYgXttumxbh7HxhhKeQAVAfdAR07BiHu7h6M,519
+authlib/oauth2/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/__pycache__/auth.cpython-312.pyc,,
+authlib/oauth2/__pycache__/base.cpython-312.pyc,,
+authlib/oauth2/__pycache__/client.cpython-312.pyc,,
+authlib/oauth2/auth.py,sha256=DsbUEgD1igRkeWNiOHdZV8FDlHTDr1nWwPZJJU8_qtM,3587
+authlib/oauth2/base.py,sha256=8ZG02kdskhdh5vfK4P2nSsnE1WcwSUxsx5banmYJyVk,2025
+authlib/oauth2/client.py,sha256=Txg4tghGHItiTE2TTzDi8r-3V6aCEf78oOgaQtUSRx8,18938
+authlib/oauth2/rfc6749/__init__.py,sha256=35h_BcWs2rFC62A0U2AlVpMZCVnD74ddZELK35VTqF8,2845
+authlib/oauth2/rfc6749/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/authenticate_client.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/authorization_server.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/errors.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/hooks.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/models.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/parameters.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/requests.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/resource_protector.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/token_endpoint.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/util.cpython-312.pyc,,
+authlib/oauth2/rfc6749/__pycache__/wrappers.cpython-312.pyc,,
+authlib/oauth2/rfc6749/authenticate_client.py,sha256=nFBxSrw62zLYl1JRON3rjCv_BUZzTivZ7HYuqnkdQmg,3985
+authlib/oauth2/rfc6749/authorization_server.py,sha256=GhuWgVVxuJ7fxwLUA-kHtLuo0DPmd0hM_sfYEV0gziA,13367
+authlib/oauth2/rfc6749/errors.py,sha256=FfT5OJJEk0RJaUjJKT1v_npN5AvCUuASqP8LtX2e4xo,7242
+authlib/oauth2/rfc6749/grants/__init__.py,sha256=7WmResYhXjt0RfzHvrh5sHOQqZURr3FphSO-dmZc9FI,1292
+authlib/oauth2/rfc6749/grants/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc6749/grants/__pycache__/authorization_code.cpython-312.pyc,,
+authlib/oauth2/rfc6749/grants/__pycache__/base.cpython-312.pyc,,
+authlib/oauth2/rfc6749/grants/__pycache__/client_credentials.cpython-312.pyc,,
+authlib/oauth2/rfc6749/grants/__pycache__/implicit.cpython-312.pyc,,
+authlib/oauth2/rfc6749/grants/__pycache__/refresh_token.cpython-312.pyc,,
+authlib/oauth2/rfc6749/grants/__pycache__/resource_owner_password_credentials.cpython-312.pyc,,
+authlib/oauth2/rfc6749/grants/authorization_code.py,sha256=CXp1RTezTAYI2yxMUtyW22HeuZb4Q_E1X_c6SRKc3ag,15604
+authlib/oauth2/rfc6749/grants/base.py,sha256=59YgBIEvYDoUUbGkk0A7lgLXeRnqCir1imvUV_YZqWc,5283
+authlib/oauth2/rfc6749/grants/client_credentials.py,sha256=dgx3jfPxrTyaY5Has7zGZw7ec6817R_KiEmlWkojODE,4016
+authlib/oauth2/rfc6749/grants/implicit.py,sha256=tCwQnM-TTxDxYzsbx3sb3BkQUpObwoA4ZjhD8XnktoE,9128
+authlib/oauth2/rfc6749/grants/refresh_token.py,sha256=Lvv_5FmZnnpw33pE4hi3vit921Yj-PH9wSw5AhVH2yU,6569
+authlib/oauth2/rfc6749/grants/resource_owner_password_credentials.py,sha256=XXjKGEGwgZlF2uhjKUWTDuwBua348rjpG_ujX0l5Aoo,5839
+authlib/oauth2/rfc6749/hooks.py,sha256=v8emOHmENAen3WbOXgmhLwHur6_i5QUgRE5NNXI_ukI,1004
+authlib/oauth2/rfc6749/models.py,sha256=PZO-owOyb1RzbmD-xdYwO_Q6Si57pqFGPqhDXiDhNVs,7773
+authlib/oauth2/rfc6749/parameters.py,sha256=-hauWerU6UlMuyVA-oxQaWc_r_y5BfDVnz7nh-oZd7E,8564
+authlib/oauth2/rfc6749/requests.py,sha256=8m2bVR9KrUGzqFRBI8aXp7h-Y3a8H6wLY5hLajYiIRM,5095
+authlib/oauth2/rfc6749/resource_protector.py,sha256=OKXtwUVn0kgK55mIzc9mGNbfUpwoOWTxb105Td5iVPE,5404
+authlib/oauth2/rfc6749/token_endpoint.py,sha256=kxjK39EHBgeD7uvJLyoLF5DAr1ef4l31jpCt6C4gYJ0,1103
+authlib/oauth2/rfc6749/util.py,sha256=--0YfF2ZVHTVMPGKD10iPqj02WeiDhXuYttX4tRleVM,1174
+authlib/oauth2/rfc6749/wrappers.py,sha256=g59stDpzoJjE6koXlwBNdGZDMgi25SxBNeJtAmtyb4I,805
+authlib/oauth2/rfc6750/__init__.py,sha256=_ytmQznohUUqnCQturfWSTt03FhUt2DFEsIwvJwJLS0,638
+authlib/oauth2/rfc6750/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc6750/__pycache__/errors.cpython-312.pyc,,
+authlib/oauth2/rfc6750/__pycache__/parameters.cpython-312.pyc,,
+authlib/oauth2/rfc6750/__pycache__/token.cpython-312.pyc,,
+authlib/oauth2/rfc6750/__pycache__/validator.cpython-312.pyc,,
+authlib/oauth2/rfc6750/errors.py,sha256=kBIL08jGmUqySRa0-KPUxdnMj1GX_eseU4bi9QS1rKI,2849
+authlib/oauth2/rfc6750/parameters.py,sha256=sCfDrLjqoyoXpwVCvtzHR7EuZZEQytark1n2p3WIU6U,1235
+authlib/oauth2/rfc6750/token.py,sha256=a8JVyne-CW9R_6tqD_aGruU938ccIOxtesoQ3670dgY,3505
+authlib/oauth2/rfc6750/validator.py,sha256=02_E1wiFTWlkLfA7NMNAh5EBzuDBl4jRBq7VmSG5hpQ,1462
+authlib/oauth2/rfc7009/__init__.py,sha256=0vDQNPYWbgeVl8sYMdDsGOxDm-wR_Bqn3kSayQC5Z08,333
+authlib/oauth2/rfc7009/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc7009/__pycache__/parameters.cpython-312.pyc,,
+authlib/oauth2/rfc7009/__pycache__/revocation.cpython-312.pyc,,
+authlib/oauth2/rfc7009/parameters.py,sha256=eR594GRPMbEe5fGd5rXnF95mzFUGTTi_ZSbe4N2lciE,821
+authlib/oauth2/rfc7009/revocation.py,sha256=N8u7g-in2pCImMzlF4XEi_2ioRp3ARO5dijL4snNVZ4,4171
+authlib/oauth2/rfc7521/__init__.py,sha256=PgfdlMuj1EqqMOYXSYgDq0QvYt--I5uKchAkdgb8l-s,67
+authlib/oauth2/rfc7521/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc7521/__pycache__/client.cpython-312.pyc,,
+authlib/oauth2/rfc7521/client.py,sha256=Ofn6V9Jj8J44--YN3Y_5OSj0va7Ve0Ujxn9zDHAMjWY,2864
+authlib/oauth2/rfc7523/__init__.py,sha256=K8UGwqfW8JDQMSANlFrANkN4wUw15ZeEnxl0g2k2ly8,857
+authlib/oauth2/rfc7523/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc7523/__pycache__/assertion.cpython-312.pyc,,
+authlib/oauth2/rfc7523/__pycache__/auth.cpython-312.pyc,,
+authlib/oauth2/rfc7523/__pycache__/client.cpython-312.pyc,,
+authlib/oauth2/rfc7523/__pycache__/jwt_bearer.cpython-312.pyc,,
+authlib/oauth2/rfc7523/__pycache__/token.cpython-312.pyc,,
+authlib/oauth2/rfc7523/__pycache__/validator.cpython-312.pyc,,
+authlib/oauth2/rfc7523/assertion.py,sha256=ZHJkmMpVIdVuhJ7JTeUVH1kO9vTEvr03XQ0RdSm0oyg,2052
+authlib/oauth2/rfc7523/auth.py,sha256=dcDyNT4Gwv-gnbh0WNiYQclP1X0EA_DTHflYsR5ddfg,3445
+authlib/oauth2/rfc7523/client.py,sha256=AEu015HgpLWdyAiLWhuCseMGdgF3Yd4-wXHdUWRFYAA,4813
+authlib/oauth2/rfc7523/jwt_bearer.py,sha256=hndsbDgOnpS-hL81KzbvsFG7v4e-UHNuocDZQj5meis,6970
+authlib/oauth2/rfc7523/token.py,sha256=olIDs43sKuVtrOis5l7tRjJS-p_ns1c1VWkf9NUgMeE,3384
+authlib/oauth2/rfc7523/validator.py,sha256=4d0FHSi8UR9pLlyYRpG8M2lW8MvYZyoOuhS-RpZoNAA,1668
+authlib/oauth2/rfc7591/__init__.py,sha256=BC7HMHZmLvgHIcpU3uRP48IHnVyeS77LADhhRw5h9aY,694
+authlib/oauth2/rfc7591/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc7591/__pycache__/claims.cpython-312.pyc,,
+authlib/oauth2/rfc7591/__pycache__/endpoint.cpython-312.pyc,,
+authlib/oauth2/rfc7591/__pycache__/errors.cpython-312.pyc,,
+authlib/oauth2/rfc7591/claims.py,sha256=wAsPmqOD-qYPrZpCJxphLOrIPEthUJPml6O8I7J26n4,12169
+authlib/oauth2/rfc7591/endpoint.py,sha256=1SeM471z3G31RPTAlQcH0AG7eEx9fcMwnm67iNwpGeA,7183
+authlib/oauth2/rfc7591/errors.py,sha256=oflYk0Qj9FBIU6eBvqgIpUMHK2dA73A8Y5UWOXZMmq4,1106
+authlib/oauth2/rfc7592/__init__.py,sha256=8oCqEJwbLOyFLq9qmEFy2WFu6-bj9rCUpJMj0ICTZSA,295
+authlib/oauth2/rfc7592/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc7592/__pycache__/endpoint.cpython-312.pyc,,
+authlib/oauth2/rfc7592/endpoint.py,sha256=CkY9RP3w4f3KXAHl4Mzqq9OtJlL7pgY8V1RyBkjHyBw,8788
+authlib/oauth2/rfc7636/__init__.py,sha256=lWumAvrbKsDAHnagFG7LgOuZvTKSUZo7nZs2CBmX49Y,342
+authlib/oauth2/rfc7636/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc7636/__pycache__/challenge.cpython-312.pyc,,
+authlib/oauth2/rfc7636/challenge.py,sha256=FjejIo_Z04pP-TAUOxcNc4PA_lywP41IwCYnNja4kvs,5790
+authlib/oauth2/rfc7662/__init__.py,sha256=usKnlDsyVkBLz3eEt0_QdE-sjOfvPoZKbCL8Yzkfl8I,403
+authlib/oauth2/rfc7662/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc7662/__pycache__/introspection.cpython-312.pyc,,
+authlib/oauth2/rfc7662/__pycache__/models.cpython-312.pyc,,
+authlib/oauth2/rfc7662/__pycache__/token_validator.cpython-312.pyc,,
+authlib/oauth2/rfc7662/introspection.py,sha256=RDDvOtwYvaqdnXzLkeOwGizb4YMbbEMAj-uR6il_9bk,5292
+authlib/oauth2/rfc7662/models.py,sha256=__VzvmldZmW-teoisACz5Zpg_EAiIGRcsjaC0cCeXhc,989
+authlib/oauth2/rfc7662/token_validator.py,sha256=pqyIpkEixMkD1PqRngYTFGdNctyq0sMzcA7CbA3q5wg,1378
+authlib/oauth2/rfc8414/__init__.py,sha256=xw7ADhba6QX6LAZB7c2XKS1XuQf9Y1NeW2vCgaVSNl4,340
+authlib/oauth2/rfc8414/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc8414/__pycache__/models.cpython-312.pyc,,
+authlib/oauth2/rfc8414/__pycache__/well_known.cpython-312.pyc,,
+authlib/oauth2/rfc8414/models.py,sha256=-c3IXwNXSYoDRy_2Z20cv8UwOLXgaFmtbJ33d8lH0tg,17594
+authlib/oauth2/rfc8414/well_known.py,sha256=3KG49E-KcDzSUBD2Ag1mfxm2rl_bRMqvJBQD21-wiOs,727
+authlib/oauth2/rfc8628/__init__.py,sha256=ImL1qoQwE4RTFcQSZTRKQPBKhEoFx2fk6qqMX24VLDg,754
+authlib/oauth2/rfc8628/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc8628/__pycache__/device_code.cpython-312.pyc,,
+authlib/oauth2/rfc8628/__pycache__/endpoint.cpython-312.pyc,,
+authlib/oauth2/rfc8628/__pycache__/errors.cpython-312.pyc,,
+authlib/oauth2/rfc8628/__pycache__/models.cpython-312.pyc,,
+authlib/oauth2/rfc8628/device_code.py,sha256=YAHw5VvlgV1brFKB1JzDKbduapqCHm9JO20QGbIqhY8,7900
+authlib/oauth2/rfc8628/endpoint.py,sha256=a6dRFcoGTbVdrBRDQZ6jox-HBFInaj0eTdY_K3B2CGo,7123
+authlib/oauth2/rfc8628/errors.py,sha256=XDh0Bw64xiaRNtggyFD5ItFgNZdve0D0n7f3cW6gi2s,922
+authlib/oauth2/rfc8628/models.py,sha256=ADXFQTABYQJXoziBCInxRpzRmzRkaJxZRKYidndIIBo,827
+authlib/oauth2/rfc8693/__init__.py,sha256=mPLmPTt-oVApxP2N1hvOMxfRY6zHvksDDrgZQH_8evU,162
+authlib/oauth2/rfc8693/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc9068/__init__.py,sha256=8JCvCUfEnHLqPkEm96MgdeVYlyCzE6fLSeAWYVWB_sc,332
+authlib/oauth2/rfc9068/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc9068/__pycache__/claims.cpython-312.pyc,,
+authlib/oauth2/rfc9068/__pycache__/introspection.cpython-312.pyc,,
+authlib/oauth2/rfc9068/__pycache__/revocation.cpython-312.pyc,,
+authlib/oauth2/rfc9068/__pycache__/token.cpython-312.pyc,,
+authlib/oauth2/rfc9068/__pycache__/token_validator.cpython-312.pyc,,
+authlib/oauth2/rfc9068/claims.py,sha256=Q0itcAFWKMMKGSBPjW5qiZ67EXsg-EouLsKryXMOjug,1981
+authlib/oauth2/rfc9068/introspection.py,sha256=z9xcX4sJZSAIIXMYjjTP-y8R6D96Tw8kJw31PhGZLQw,4385
+authlib/oauth2/rfc9068/revocation.py,sha256=txYDfyq3sQ7wNAGM3HmfscgE4vdlWkwY4FFGnPe8RiM,2650
+authlib/oauth2/rfc9068/token.py,sha256=JBH4iuCDclDv62a9F0qdh1ysg3tBEVMadmn2nA733KI,8613
+authlib/oauth2/rfc9068/token_validator.py,sha256=DLH91dL5Ocm_stf2yoCEKE-mEIN01zfrf6Suse3nYuI,6865
+authlib/oauth2/rfc9101/__init__.py,sha256=OV66ZJbs2h_iJ0iPH3UvWg_kUpCxDI2l82ul1hCUfdI,267
+authlib/oauth2/rfc9101/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc9101/__pycache__/authorization_server.cpython-312.pyc,,
+authlib/oauth2/rfc9101/__pycache__/discovery.cpython-312.pyc,,
+authlib/oauth2/rfc9101/__pycache__/errors.cpython-312.pyc,,
+authlib/oauth2/rfc9101/__pycache__/registration.cpython-312.pyc,,
+authlib/oauth2/rfc9101/authorization_server.py,sha256=E-zLhrLzLD8Wgz7Q0Tf-gxBsISIKmoTmYk66koxM6M0,10624
+authlib/oauth2/rfc9101/discovery.py,sha256=0Y3LnMCVzBBq5brWsru_A1fOJmdkNH6lUJ9mL8_yd18,443
+authlib/oauth2/rfc9101/errors.py,sha256=aZLygyagATIo1UZ2iAF3DoBYtJGB0n03hqqoKQpKpvE,999
+authlib/oauth2/rfc9101/registration.py,sha256=fkfN0Ymc7WCUTpcu4bF6WXDlKCmbioR9fElSD20VODs,1299
+authlib/oauth2/rfc9207/__init__.py,sha256=5LKVKAH596fewYYJEHYLPLrLskBmXeqboBSAoyYeccM,70
+authlib/oauth2/rfc9207/__pycache__/__init__.cpython-312.pyc,,
+authlib/oauth2/rfc9207/__pycache__/parameter.cpython-312.pyc,,
+authlib/oauth2/rfc9207/parameter.py,sha256=SfQAFDgHHkpZbzay-_7jHOIyIeQ15dIutW6m3H51M18,1696
+authlib/oidc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+authlib/oidc/__pycache__/__init__.cpython-312.pyc,,
+authlib/oidc/core/__init__.py,sha256=VSzzSDb5HIrFHnjpLQ8qwxgxLHnOqaCbHsLLnldbnO4,863
+authlib/oidc/core/__pycache__/__init__.cpython-312.pyc,,
+authlib/oidc/core/__pycache__/claims.cpython-312.pyc,,
+authlib/oidc/core/__pycache__/errors.cpython-312.pyc,,
+authlib/oidc/core/__pycache__/models.cpython-312.pyc,,
+authlib/oidc/core/__pycache__/userinfo.cpython-312.pyc,,
+authlib/oidc/core/__pycache__/util.cpython-312.pyc,,
+authlib/oidc/core/claims.py,sha256=ZN7ortm_FytflhhSNIW9LtUhbrwcnd1su_BZv691q54,11521
+authlib/oidc/core/errors.py,sha256=f-71kRG2Nf2cN95f7PCKucgCcPphITtGBhcsjcjhE6U,2892
+authlib/oidc/core/grants/__init__.py,sha256=-SjelrkrD35bnb5rIZiBpbiLxgiJtwMXHJXHr8ovQyo,243
+authlib/oidc/core/grants/__pycache__/__init__.cpython-312.pyc,,
+authlib/oidc/core/grants/__pycache__/code.cpython-312.pyc,,
+authlib/oidc/core/grants/__pycache__/hybrid.cpython-312.pyc,,
+authlib/oidc/core/grants/__pycache__/implicit.cpython-312.pyc,,
+authlib/oidc/core/grants/__pycache__/util.cpython-312.pyc,,
+authlib/oidc/core/grants/code.py,sha256=GelmhPA0jj4zK-ucXL7fAwIPfnn5Znol6wJlsJeVx1A,5681
+authlib/oidc/core/grants/hybrid.py,sha256=pIWRAGFbT9d9o4OHcPE-RtjJqOuTGbaFU0lsBG5kgAw,3430
+authlib/oidc/core/grants/implicit.py,sha256=rSG0S2jrFzK1rE247DiRyabnpbGq4UE0S6nqJKrMzZo,6619
+authlib/oidc/core/grants/util.py,sha256=prMt5LqyPLbsI6MQACkxOgmMK_WlS_C0I73jhJWETj4,4539
+authlib/oidc/core/models.py,sha256=KjBcQnNJkVYnLWYeQuwb-K_DWDst78MZRLJXjqhtMtw,1464
+authlib/oidc/core/userinfo.py,sha256=8r3WBd6H1JM_5IDW4l1zOkxqrWg_YTyGqDijShKxeLE,4354
+authlib/oidc/core/util.py,sha256=ihuKYlhQAVmK5SIhwxn5k_PqVB1q0Lmwl1tuwRTQuf4,502
+authlib/oidc/discovery/__init__.py,sha256=rapkktd4XN0t6LeHOWFPeeKEzlF6gBHvWsTK9JPLPY0,305
+authlib/oidc/discovery/__pycache__/__init__.cpython-312.pyc,,
+authlib/oidc/discovery/__pycache__/models.cpython-312.pyc,,
+authlib/oidc/discovery/__pycache__/well_known.cpython-312.pyc,,
+authlib/oidc/discovery/models.py,sha256=yzdWYQn-VfC48gywoxswge4tgnKb8uQ-UkjhVTClk1E,12442
+authlib/oidc/discovery/well_known.py,sha256=ry1VHxCmwvjmlMxOFEbSC6FsE_ttijyRcn2xUpv2CaU,574
+authlib/oidc/registration/__init__.py,sha256=lV_Og-DMFKzWWYsdK04oF83xKUGTE2gQhikPPsOdW84,77
+authlib/oidc/registration/__pycache__/__init__.cpython-312.pyc,,
+authlib/oidc/registration/__pycache__/claims.cpython-312.pyc,,
+authlib/oidc/registration/claims.py,sha256=K7Ft8GDXkVrjJrc53Ihkhn2SVN4pvEf3qiHOkzVOJ7g,17264
diff --git a/Backend/venv/lib/python3.12/site-packages/python_jose-3.3.0.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/WHEEL
similarity index 70%
rename from Backend/venv/lib/python3.12/site-packages/python_jose-3.3.0.dist-info/WHEEL
rename to Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/WHEEL
index 01b8fc7d..5f133dbb 100644
--- a/Backend/venv/lib/python3.12/site-packages/python_jose-3.3.0.dist-info/WHEEL
+++ b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/WHEEL
@@ -1,5 +1,5 @@
Wheel-Version: 1.0
-Generator: bdist_wheel (0.36.2)
+Generator: setuptools (80.9.0)
Root-Is-Purelib: true
Tag: py2-none-any
Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/licenses/LICENSE b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/licenses/LICENSE
new file mode 100644
index 00000000..42441994
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/licenses/LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017, Hsiaoming Yang
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/top_level.txt b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/top_level.txt
new file mode 100644
index 00000000..b91e7e46
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/top_level.txt
@@ -0,0 +1 @@
+authlib
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/__init__.py
new file mode 100644
index 00000000..cdf79219
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/__init__.py
@@ -0,0 +1,19 @@
+"""authlib.
+~~~~~~~
+
+The ultimate Python library in building OAuth 1.0, OAuth 2.0 and OpenID
+Connect clients and providers. It covers from low level specification
+implementation to high level framework integrations.
+
+:copyright: (c) 2017 by Hsiaoming Yang.
+:license: BSD, see LICENSE for more details.
+"""
+
+from .consts import author
+from .consts import homepage
+from .consts import version
+
+__version__ = version
+__homepage__ = homepage
+__author__ = author
+__license__ = "BSD-3-Clause"
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..95322116
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/consts.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/consts.cpython-312.pyc
new file mode 100644
index 00000000..2a394496
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/consts.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/deprecate.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/deprecate.cpython-312.pyc
new file mode 100644
index 00000000..0adad047
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/__pycache__/deprecate.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/common/__init__.py
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/h11/tests/__init__.py
rename to Backend/venv/lib/python3.12/site-packages/authlib/common/__init__.py
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..f76bf507
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/encoding.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/encoding.cpython-312.pyc
new file mode 100644
index 00000000..1d7e6d4e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/encoding.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..96547741
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/security.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/security.cpython-312.pyc
new file mode 100644
index 00000000..857b772f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/security.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/urls.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/urls.cpython-312.pyc
new file mode 100644
index 00000000..0948e330
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/common/__pycache__/urls.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/encoding.py b/Backend/venv/lib/python3.12/site-packages/authlib/common/encoding.py
new file mode 100644
index 00000000..25063dc2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/common/encoding.py
@@ -0,0 +1,66 @@
+import base64
+import json
+import struct
+
+
+def to_bytes(x, charset="utf-8", errors="strict"):
+ if x is None:
+ return None
+ if isinstance(x, bytes):
+ return x
+ if isinstance(x, str):
+ return x.encode(charset, errors)
+ if isinstance(x, (int, float)):
+ return str(x).encode(charset, errors)
+ return bytes(x)
+
+
+def to_unicode(x, charset="utf-8", errors="strict"):
+ if x is None or isinstance(x, str):
+ return x
+ if isinstance(x, bytes):
+ return x.decode(charset, errors)
+ return str(x)
+
+
+def to_native(x, encoding="ascii"):
+ if isinstance(x, str):
+ return x
+ return x.decode(encoding)
+
+
+def json_loads(s):
+ return json.loads(s)
+
+
+def json_dumps(data, ensure_ascii=False):
+ return json.dumps(data, ensure_ascii=ensure_ascii, separators=(",", ":"))
+
+
+def urlsafe_b64decode(s):
+ s += b"=" * (-len(s) % 4)
+ return base64.urlsafe_b64decode(s)
+
+
+def urlsafe_b64encode(s):
+ return base64.urlsafe_b64encode(s).rstrip(b"=")
+
+
+def base64_to_int(s):
+ data = urlsafe_b64decode(to_bytes(s, charset="ascii"))
+ buf = struct.unpack(f"{len(data)}B", data)
+ return int("".join([f"{byte:02x}" for byte in buf]), 16)
+
+
+def int_to_base64(num):
+ if num < 0:
+ raise ValueError("Must be a positive integer")
+
+ s = num.to_bytes((num.bit_length() + 7) // 8, "big", signed=False)
+ return to_unicode(urlsafe_b64encode(s))
+
+
+def json_b64encode(text):
+ if isinstance(text, dict):
+ text = json_dumps(text)
+ return urlsafe_b64encode(to_bytes(text))
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/common/errors.py
new file mode 100644
index 00000000..ece95896
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/common/errors.py
@@ -0,0 +1,62 @@
+from authlib.consts import default_json_headers
+
+
+class AuthlibBaseError(Exception):
+ """Base Exception for all errors in Authlib."""
+
+ #: short-string error code
+ error = None
+ #: long-string to describe this error
+ description = ""
+ #: web page that describes this error
+ uri = None
+
+ def __init__(self, error=None, description=None, uri=None):
+ if error is not None:
+ self.error = error
+ if description is not None:
+ self.description = description
+ if uri is not None:
+ self.uri = uri
+
+ message = f"{self.error}: {self.description}"
+ super().__init__(message)
+
+ def __repr__(self):
+ return f'<{self.__class__.__name__} "{self.error}">'
+
+
+class AuthlibHTTPError(AuthlibBaseError):
+ #: HTTP status code
+ status_code = 400
+
+ def __init__(self, error=None, description=None, uri=None, status_code=None):
+ super().__init__(error, description, uri)
+ if status_code is not None:
+ self.status_code = status_code
+
+ def get_error_description(self):
+ return self.description
+
+ def get_body(self):
+ error = [("error", self.error)]
+
+ if self.description:
+ error.append(("error_description", self.description))
+
+ if self.uri:
+ error.append(("error_uri", self.uri))
+ return error
+
+ def get_headers(self):
+ return default_json_headers[:]
+
+ def __call__(self, uri=None):
+ self.uri = uri
+ body = dict(self.get_body())
+ headers = self.get_headers()
+ return self.status_code, body, headers
+
+
+class ContinueIteration(AuthlibBaseError):
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/security.py b/Backend/venv/lib/python3.12/site-packages/authlib/common/security.py
new file mode 100644
index 00000000..42761685
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/common/security.py
@@ -0,0 +1,19 @@
+import os
+import random
+import string
+
+UNICODE_ASCII_CHARACTER_SET = string.ascii_letters + string.digits
+
+
+def generate_token(length=30, chars=UNICODE_ASCII_CHARACTER_SET):
+ rand = random.SystemRandom()
+ return "".join(rand.choice(chars) for _ in range(length))
+
+
+def is_secure_transport(uri):
+ """Check if the uri is over ssl."""
+ if os.getenv("AUTHLIB_INSECURE_TRANSPORT"):
+ return True
+
+ uri = uri.lower()
+ return uri.startswith(("https://", "http://localhost:", "http://127.0.0.1:"))
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/common/urls.py b/Backend/venv/lib/python3.12/site-packages/authlib/common/urls.py
new file mode 100644
index 00000000..e2a8b855
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/common/urls.py
@@ -0,0 +1,146 @@
+"""authlib.util.urls.
+~~~~~~~~~~~~~~~~~
+
+Wrapper functions for URL encoding and decoding.
+"""
+
+import re
+import urllib.parse as urlparse
+from urllib.parse import quote as _quote
+from urllib.parse import unquote as _unquote
+from urllib.parse import urlencode as _urlencode
+
+from .encoding import to_bytes
+from .encoding import to_unicode
+
+always_safe = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_.-"
+urlencoded = set(always_safe) | set("=&;:%+~,*@!()/?")
+INVALID_HEX_PATTERN = re.compile(r"%[^0-9A-Fa-f]|%[0-9A-Fa-f][^0-9A-Fa-f]")
+
+
+def url_encode(params):
+ encoded = []
+ for k, v in params:
+ encoded.append((to_bytes(k), to_bytes(v)))
+ return to_unicode(_urlencode(encoded))
+
+
+def url_decode(query):
+ """Decode a query string in x-www-form-urlencoded format into a sequence
+ of two-element tuples.
+
+ Unlike urlparse.parse_qsl(..., strict_parsing=True) urldecode will enforce
+ correct formatting of the query string by validation. If validation fails
+ a ValueError will be raised. urllib.parse_qsl will only raise errors if
+ any of name-value pairs omits the equals sign.
+ """
+ # Check if query contains invalid characters
+ if query and not set(query) <= urlencoded:
+ error = (
+ "Error trying to decode a non urlencoded string. "
+ "Found invalid characters: %s "
+ "in the string: '%s'. "
+ "Please ensure the request/response body is "
+ "x-www-form-urlencoded."
+ )
+ raise ValueError(error % (set(query) - urlencoded, query))
+
+ # Check for correctly hex encoded values using a regular expression
+ # All encoded values begin with % followed by two hex characters
+ # correct = %00, %A0, %0A, %FF
+ # invalid = %G0, %5H, %PO
+ if INVALID_HEX_PATTERN.search(query):
+ raise ValueError("Invalid hex encoding in query string.")
+
+ # We encode to utf-8 prior to parsing because parse_qsl behaves
+ # differently on unicode input in python 2 and 3.
+ # Python 2.7
+ # >>> urlparse.parse_qsl(u'%E5%95%A6%E5%95%A6')
+ # u'\xe5\x95\xa6\xe5\x95\xa6'
+ # Python 2.7, non unicode input gives the same
+ # >>> urlparse.parse_qsl('%E5%95%A6%E5%95%A6')
+ # '\xe5\x95\xa6\xe5\x95\xa6'
+ # but now we can decode it to unicode
+ # >>> urlparse.parse_qsl('%E5%95%A6%E5%95%A6').decode('utf-8')
+ # u'\u5566\u5566'
+ # Python 3.3 however
+ # >>> urllib.parse.parse_qsl(u'%E5%95%A6%E5%95%A6')
+ # u'\u5566\u5566'
+
+ # We want to allow queries such as "c2" whereas urlparse.parse_qsl
+ # with the strict_parsing flag will not.
+ params = urlparse.parse_qsl(query, keep_blank_values=True)
+
+ # unicode all the things
+ decoded = []
+ for k, v in params:
+ decoded.append((to_unicode(k), to_unicode(v)))
+ return decoded
+
+
+def add_params_to_qs(query, params):
+ """Extend a query with a list of two-tuples."""
+ if isinstance(params, dict):
+ params = params.items()
+
+ qs = urlparse.parse_qsl(query, keep_blank_values=True)
+ qs.extend(params)
+ return url_encode(qs)
+
+
+def add_params_to_uri(uri, params, fragment=False):
+ """Add a list of two-tuples to the uri query components."""
+ sch, net, path, par, query, fra = urlparse.urlparse(uri)
+ if fragment:
+ fra = add_params_to_qs(fra, params)
+ else:
+ query = add_params_to_qs(query, params)
+ return urlparse.urlunparse((sch, net, path, par, query, fra))
+
+
+def quote(s, safe=b"/"):
+ return to_unicode(_quote(to_bytes(s), safe))
+
+
+def unquote(s):
+ return to_unicode(_unquote(s))
+
+
+def quote_url(s):
+ return quote(s, b"~@#$&()*!+=:;,.?/'")
+
+
+def extract_params(raw):
+ """Extract parameters and return them as a list of 2-tuples.
+
+ Will successfully extract parameters from urlencoded query strings,
+ dicts, or lists of 2-tuples. Empty strings/dicts/lists will return an
+ empty list of parameters. Any other input will result in a return
+ value of None.
+ """
+ if isinstance(raw, (list, tuple)):
+ try:
+ raw = dict(raw)
+ except (TypeError, ValueError):
+ return None
+
+ if isinstance(raw, dict):
+ params = []
+ for k, v in raw.items():
+ params.append((to_unicode(k), to_unicode(v)))
+ return params
+
+ if not raw:
+ return None
+
+ try:
+ return url_decode(raw)
+ except ValueError:
+ return None
+
+
+def is_valid_url(url: str, fragments_allowed=True):
+ parsed = urlparse.urlparse(url)
+ return (
+ parsed.scheme and parsed.hostname and (fragments_allowed or not parsed.fragment)
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/consts.py b/Backend/venv/lib/python3.12/site-packages/authlib/consts.py
new file mode 100644
index 00000000..fd120ebd
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/consts.py
@@ -0,0 +1,11 @@
+name = "Authlib"
+version = "1.6.5"
+author = "Hsiaoming Yang "
+homepage = "https://authlib.org"
+default_user_agent = f"{name}/{version} (+{homepage})"
+
+default_json_headers = [
+ ("Content-Type", "application/json"),
+ ("Cache-Control", "no-store"),
+ ("Pragma", "no-cache"),
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/deprecate.py b/Backend/venv/lib/python3.12/site-packages/authlib/deprecate.py
new file mode 100644
index 00000000..5280655f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/deprecate.py
@@ -0,0 +1,18 @@
+import warnings
+
+
+class AuthlibDeprecationWarning(DeprecationWarning):
+ pass
+
+
+warnings.simplefilter("always", AuthlibDeprecationWarning)
+
+
+def deprecate(message, version=None, link_uid=None, link_file=None, stacklevel=3):
+ if version:
+ message += f"\nIt will be compatible before version {version}."
+
+ if link_uid and link_file:
+ message += f"\nRead more "
+
+ warnings.warn(AuthlibDeprecationWarning(message), stacklevel=stacklevel)
diff --git a/Backend/venv/lib/python3.12/site-packages/multipart/tests/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/__init__.py
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/multipart/tests/__init__.py
rename to Backend/venv/lib/python3.12/site-packages/authlib/integrations/__init__.py
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..3db8e8d9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__init__.py
new file mode 100644
index 00000000..e9e352db
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__init__.py
@@ -0,0 +1,29 @@
+from .errors import InvalidTokenError
+from .errors import MismatchingStateError
+from .errors import MissingRequestTokenError
+from .errors import MissingTokenError
+from .errors import OAuthError
+from .errors import TokenExpiredError
+from .errors import UnsupportedTokenTypeError
+from .framework_integration import FrameworkIntegration
+from .registry import BaseOAuth
+from .sync_app import BaseApp
+from .sync_app import OAuth1Mixin
+from .sync_app import OAuth2Mixin
+from .sync_openid import OpenIDMixin
+
+__all__ = [
+ "BaseOAuth",
+ "BaseApp",
+ "OAuth1Mixin",
+ "OAuth2Mixin",
+ "OpenIDMixin",
+ "FrameworkIntegration",
+ "OAuthError",
+ "MissingRequestTokenError",
+ "MissingTokenError",
+ "TokenExpiredError",
+ "InvalidTokenError",
+ "UnsupportedTokenTypeError",
+ "MismatchingStateError",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..3f5efec8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/async_app.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/async_app.cpython-312.pyc
new file mode 100644
index 00000000..6555e513
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/async_app.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/async_openid.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/async_openid.cpython-312.pyc
new file mode 100644
index 00000000..9dbe9bfb
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/async_openid.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..bf9b036e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/framework_integration.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/framework_integration.cpython-312.pyc
new file mode 100644
index 00000000..669f627d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/framework_integration.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/registry.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/registry.cpython-312.pyc
new file mode 100644
index 00000000..d6ec11f0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/registry.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/sync_app.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/sync_app.cpython-312.pyc
new file mode 100644
index 00000000..ecfd2e86
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/sync_app.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/sync_openid.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/sync_openid.cpython-312.pyc
new file mode 100644
index 00000000..6750ae5f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/__pycache__/sync_openid.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/async_app.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/async_app.py
new file mode 100644
index 00000000..95c7aba8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/async_app.py
@@ -0,0 +1,152 @@
+import logging
+import time
+
+from authlib.common.urls import urlparse
+
+from .errors import MissingRequestTokenError
+from .errors import MissingTokenError
+from .sync_app import OAuth1Base
+from .sync_app import OAuth2Base
+
+log = logging.getLogger(__name__)
+
+__all__ = ["AsyncOAuth1Mixin", "AsyncOAuth2Mixin"]
+
+
+class AsyncOAuth1Mixin(OAuth1Base):
+ async def request(self, method, url, token=None, **kwargs):
+ async with self._get_oauth_client() as session:
+ return await _http_request(self, session, method, url, token, kwargs)
+
+ async def create_authorization_url(self, redirect_uri=None, **kwargs):
+ """Generate the authorization url and state for HTTP redirect.
+
+ :param redirect_uri: Callback or redirect URI for authorization.
+ :param kwargs: Extra parameters to include.
+ :return: dict
+ """
+ if not self.authorize_url:
+ raise RuntimeError('Missing "authorize_url" value')
+
+ if self.authorize_params:
+ kwargs.update(self.authorize_params)
+
+ async with self._get_oauth_client() as client:
+ client.redirect_uri = redirect_uri
+ params = {}
+ if self.request_token_params:
+ params.update(self.request_token_params)
+ request_token = await client.fetch_request_token(
+ self.request_token_url, **params
+ )
+ log.debug(f"Fetch request token: {request_token!r}")
+ url = client.create_authorization_url(self.authorize_url, **kwargs)
+ state = request_token["oauth_token"]
+ return {"url": url, "request_token": request_token, "state": state}
+
+ async def fetch_access_token(self, request_token=None, **kwargs):
+ """Fetch access token in one step.
+
+ :param request_token: A previous request token for OAuth 1.
+ :param kwargs: Extra parameters to fetch access token.
+ :return: A token dict.
+ """
+ async with self._get_oauth_client() as client:
+ if request_token is None:
+ raise MissingRequestTokenError()
+ # merge request token with verifier
+ token = {}
+ token.update(request_token)
+ token.update(kwargs)
+ client.token = token
+ params = self.access_token_params or {}
+ token = await client.fetch_access_token(self.access_token_url, **params)
+ return token
+
+
+class AsyncOAuth2Mixin(OAuth2Base):
+ async def _on_update_token(self, token, refresh_token=None, access_token=None):
+ if self._update_token:
+ await self._update_token(
+ token,
+ refresh_token=refresh_token,
+ access_token=access_token,
+ )
+
+ async def load_server_metadata(self):
+ if self._server_metadata_url and "_loaded_at" not in self.server_metadata:
+ async with self.client_cls(**self.client_kwargs) as client:
+ resp = await client.request(
+ "GET", self._server_metadata_url, withhold_token=True
+ )
+ resp.raise_for_status()
+ metadata = resp.json()
+ metadata["_loaded_at"] = time.time()
+ self.server_metadata.update(metadata)
+ return self.server_metadata
+
+ async def request(self, method, url, token=None, **kwargs):
+ metadata = await self.load_server_metadata()
+ async with self._get_oauth_client(**metadata) as session:
+ return await _http_request(self, session, method, url, token, kwargs)
+
+ async def create_authorization_url(self, redirect_uri=None, **kwargs):
+ """Generate the authorization url and state for HTTP redirect.
+
+ :param redirect_uri: Callback or redirect URI for authorization.
+ :param kwargs: Extra parameters to include.
+ :return: dict
+ """
+ metadata = await self.load_server_metadata()
+ authorization_endpoint = self.authorize_url or metadata.get(
+ "authorization_endpoint"
+ )
+ if not authorization_endpoint:
+ raise RuntimeError('Missing "authorize_url" value')
+
+ if self.authorize_params:
+ kwargs.update(self.authorize_params)
+
+ async with self._get_oauth_client(**metadata) as client:
+ client.redirect_uri = redirect_uri
+ return self._create_oauth2_authorization_url(
+ client, authorization_endpoint, **kwargs
+ )
+
+ async def fetch_access_token(self, redirect_uri=None, **kwargs):
+ """Fetch access token in the final step.
+
+ :param redirect_uri: Callback or Redirect URI that is used in
+ previous :meth:`authorize_redirect`.
+ :param kwargs: Extra parameters to fetch access token.
+ :return: A token dict.
+ """
+ metadata = await self.load_server_metadata()
+ token_endpoint = self.access_token_url or metadata.get("token_endpoint")
+ async with self._get_oauth_client(**metadata) as client:
+ if redirect_uri is not None:
+ client.redirect_uri = redirect_uri
+ params = {}
+ if self.access_token_params:
+ params.update(self.access_token_params)
+ params.update(kwargs)
+ token = await client.fetch_token(token_endpoint, **params)
+ return token
+
+
+async def _http_request(ctx, session, method, url, token, kwargs):
+ request = kwargs.pop("request", None)
+ withhold_token = kwargs.get("withhold_token")
+ if ctx.api_base_url and not url.startswith(("https://", "http://")):
+ url = urlparse.urljoin(ctx.api_base_url, url)
+
+ if withhold_token:
+ return await session.request(method, url, **kwargs)
+
+ if token is None and ctx._fetch_token and request:
+ token = await ctx._fetch_token(request)
+ if token is None:
+ raise MissingTokenError()
+
+ session.token = token
+ return await session.request(method, url, **kwargs)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/async_openid.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/async_openid.py
new file mode 100644
index 00000000..63c7004b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/async_openid.py
@@ -0,0 +1,85 @@
+from authlib.jose import JsonWebKey
+from authlib.jose import JsonWebToken
+from authlib.oidc.core import CodeIDToken
+from authlib.oidc.core import ImplicitIDToken
+from authlib.oidc.core import UserInfo
+
+__all__ = ["AsyncOpenIDMixin"]
+
+
+class AsyncOpenIDMixin:
+ async def fetch_jwk_set(self, force=False):
+ metadata = await self.load_server_metadata()
+ jwk_set = metadata.get("jwks")
+ if jwk_set and not force:
+ return jwk_set
+
+ uri = metadata.get("jwks_uri")
+ if not uri:
+ raise RuntimeError('Missing "jwks_uri" in metadata')
+
+ async with self.client_cls(**self.client_kwargs) as client:
+ resp = await client.request("GET", uri, withhold_token=True)
+ resp.raise_for_status()
+ jwk_set = resp.json()
+
+ self.server_metadata["jwks"] = jwk_set
+ return jwk_set
+
+ async def userinfo(self, **kwargs):
+ """Fetch user info from ``userinfo_endpoint``."""
+ metadata = await self.load_server_metadata()
+ resp = await self.get(metadata["userinfo_endpoint"], **kwargs)
+ resp.raise_for_status()
+ data = resp.json()
+ return UserInfo(data)
+
+ async def parse_id_token(
+ self, token, nonce, claims_options=None, claims_cls=None, leeway=120
+ ):
+ """Return an instance of UserInfo from token's ``id_token``."""
+ claims_params = dict(
+ nonce=nonce,
+ client_id=self.client_id,
+ )
+ if claims_cls is None:
+ if "access_token" in token:
+ claims_params["access_token"] = token["access_token"]
+ claims_cls = CodeIDToken
+ else:
+ claims_cls = ImplicitIDToken
+
+ metadata = await self.load_server_metadata()
+ if claims_options is None and "issuer" in metadata:
+ claims_options = {"iss": {"values": [metadata["issuer"]]}}
+
+ alg_values = metadata.get("id_token_signing_alg_values_supported")
+ if not alg_values:
+ alg_values = ["RS256"]
+
+ jwt = JsonWebToken(alg_values)
+
+ jwk_set = await self.fetch_jwk_set()
+ try:
+ claims = jwt.decode(
+ token["id_token"],
+ key=JsonWebKey.import_key_set(jwk_set),
+ claims_cls=claims_cls,
+ claims_options=claims_options,
+ claims_params=claims_params,
+ )
+ except ValueError:
+ jwk_set = await self.fetch_jwk_set(force=True)
+ claims = jwt.decode(
+ token["id_token"],
+ key=JsonWebKey.import_key_set(jwk_set),
+ claims_cls=claims_cls,
+ claims_options=claims_options,
+ claims_params=claims_params,
+ )
+
+ # https://github.com/authlib/authlib/issues/259
+ if claims.get("nonce_supported") is False:
+ claims.params["nonce"] = None
+ claims.validate(leeway=leeway)
+ return UserInfo(claims)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/errors.py
new file mode 100644
index 00000000..4d5078c2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/errors.py
@@ -0,0 +1,30 @@
+from authlib.common.errors import AuthlibBaseError
+
+
+class OAuthError(AuthlibBaseError):
+ error = "oauth_error"
+
+
+class MissingRequestTokenError(OAuthError):
+ error = "missing_request_token"
+
+
+class MissingTokenError(OAuthError):
+ error = "missing_token"
+
+
+class TokenExpiredError(OAuthError):
+ error = "token_expired"
+
+
+class InvalidTokenError(OAuthError):
+ error = "token_invalid"
+
+
+class UnsupportedTokenTypeError(OAuthError):
+ error = "unsupported_token_type"
+
+
+class MismatchingStateError(OAuthError):
+ error = "mismatching_state"
+ description = "CSRF Warning! State not equal in request and response."
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/framework_integration.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/framework_integration.py
new file mode 100644
index 00000000..726bdda8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/framework_integration.py
@@ -0,0 +1,64 @@
+import json
+import time
+
+
+class FrameworkIntegration:
+ expires_in = 3600
+
+ def __init__(self, name, cache=None):
+ self.name = name
+ self.cache = cache
+
+ def _get_cache_data(self, key):
+ value = self.cache.get(key)
+ if not value:
+ return None
+ try:
+ return json.loads(value)
+ except (TypeError, ValueError):
+ return None
+
+ def _clear_session_state(self, session):
+ now = time.time()
+ for key in dict(session):
+ if "_authlib_" in key:
+ # TODO: remove in future
+ session.pop(key)
+ elif key.startswith("_state_"):
+ value = session[key]
+ exp = value.get("exp")
+ if not exp or exp < now:
+ session.pop(key)
+
+ def get_state_data(self, session, state):
+ key = f"_state_{self.name}_{state}"
+ if self.cache:
+ value = self._get_cache_data(key)
+ else:
+ value = session.get(key)
+ if value:
+ return value.get("data")
+ return None
+
+ def set_state_data(self, session, state, data):
+ key = f"_state_{self.name}_{state}"
+ if self.cache:
+ self.cache.set(key, json.dumps({"data": data}), self.expires_in)
+ else:
+ now = time.time()
+ session[key] = {"data": data, "exp": now + self.expires_in}
+
+ def clear_state_data(self, session, state):
+ key = f"_state_{self.name}_{state}"
+ if self.cache:
+ self.cache.delete(key)
+ else:
+ session.pop(key, None)
+ self._clear_session_state(session)
+
+ def update_token(self, token, refresh_token=None, access_token=None):
+ raise NotImplementedError()
+
+ @staticmethod
+ def load_config(oauth, name, params):
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/registry.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/registry.py
new file mode 100644
index 00000000..40744828
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/registry.py
@@ -0,0 +1,139 @@
+import functools
+
+from .framework_integration import FrameworkIntegration
+
+__all__ = ["BaseOAuth"]
+
+
+OAUTH_CLIENT_PARAMS = (
+ "client_id",
+ "client_secret",
+ "request_token_url",
+ "request_token_params",
+ "access_token_url",
+ "access_token_params",
+ "refresh_token_url",
+ "refresh_token_params",
+ "authorize_url",
+ "authorize_params",
+ "api_base_url",
+ "client_kwargs",
+ "server_metadata_url",
+)
+
+
+class BaseOAuth:
+ """Registry for oauth clients.
+
+ Create an instance for registry::
+
+ oauth = OAuth()
+ """
+
+ oauth1_client_cls = None
+ oauth2_client_cls = None
+ framework_integration_cls = FrameworkIntegration
+
+ def __init__(self, cache=None, fetch_token=None, update_token=None):
+ self._registry = {}
+ self._clients = {}
+ self.cache = cache
+ self.fetch_token = fetch_token
+ self.update_token = update_token
+
+ def create_client(self, name):
+ """Create or get the given named OAuth client. For instance, the
+ OAuth registry has ``.register`` a twitter client, developers may
+ access the client with::
+
+ client = oauth.create_client("twitter")
+
+ :param: name: Name of the remote application
+ :return: OAuth remote app
+ """
+ if name in self._clients:
+ return self._clients[name]
+
+ if name not in self._registry:
+ return None
+
+ overwrite, config = self._registry[name]
+ client_cls = config.pop("client_cls", None)
+
+ if client_cls and client_cls.OAUTH_APP_CONFIG:
+ kwargs = client_cls.OAUTH_APP_CONFIG
+ kwargs.update(config)
+ else:
+ kwargs = config
+
+ kwargs = self.generate_client_kwargs(name, overwrite, **kwargs)
+ framework = self.framework_integration_cls(name, self.cache)
+ if client_cls:
+ client = client_cls(framework, name, **kwargs)
+ elif kwargs.get("request_token_url"):
+ client = self.oauth1_client_cls(framework, name, **kwargs)
+ else:
+ client = self.oauth2_client_cls(framework, name, **kwargs)
+
+ self._clients[name] = client
+ return client
+
+ def register(self, name, overwrite=False, **kwargs):
+ """Registers a new remote application.
+
+ :param name: Name of the remote application.
+ :param overwrite: Overwrite existing config with framework settings.
+ :param kwargs: Parameters for :class:`RemoteApp`.
+
+ Find parameters for the given remote app class. When a remote app is
+ registered, it can be accessed with *named* attribute::
+
+ oauth.register('twitter', client_id='', ...)
+ oauth.twitter.get('timeline')
+ """
+ self._registry[name] = (overwrite, kwargs)
+ return self.create_client(name)
+
+ def generate_client_kwargs(self, name, overwrite, **kwargs):
+ fetch_token = kwargs.pop("fetch_token", None)
+ update_token = kwargs.pop("update_token", None)
+
+ config = self.load_config(name, OAUTH_CLIENT_PARAMS)
+ if config:
+ kwargs = _config_client(config, kwargs, overwrite)
+
+ if not fetch_token and self.fetch_token:
+ fetch_token = functools.partial(self.fetch_token, name)
+
+ kwargs["fetch_token"] = fetch_token
+
+ if not kwargs.get("request_token_url"):
+ if not update_token and self.update_token:
+ update_token = functools.partial(self.update_token, name)
+
+ kwargs["update_token"] = update_token
+ return kwargs
+
+ def load_config(self, name, params):
+ return self.framework_integration_cls.load_config(self, name, params)
+
+ def __getattr__(self, key):
+ try:
+ return object.__getattribute__(self, key)
+ except AttributeError as exc:
+ if key in self._registry:
+ return self.create_client(key)
+ raise AttributeError(f"No such client: {key}") from exc
+
+
+def _config_client(config, kwargs, overwrite):
+ for k in OAUTH_CLIENT_PARAMS:
+ v = config.get(k, None)
+ if k not in kwargs:
+ kwargs[k] = v
+ elif overwrite and v:
+ if isinstance(kwargs[k], dict):
+ kwargs[k].update(v)
+ else:
+ kwargs[k] = v
+ return kwargs
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/sync_app.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/sync_app.py
new file mode 100644
index 00000000..bd0e664f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/sync_app.py
@@ -0,0 +1,377 @@
+import logging
+import time
+
+from authlib.common.security import generate_token
+from authlib.common.urls import urlparse
+from authlib.consts import default_user_agent
+
+from .errors import MismatchingStateError
+from .errors import MissingRequestTokenError
+from .errors import MissingTokenError
+
+log = logging.getLogger(__name__)
+
+
+class BaseApp:
+ client_cls = None
+ OAUTH_APP_CONFIG = None
+
+ def request(self, method, url, token=None, **kwargs):
+ raise NotImplementedError()
+
+ def get(self, url, **kwargs):
+ """Invoke GET http request.
+
+ If ``api_base_url`` configured, shortcut is available::
+
+ client.get("users/lepture")
+ """
+ return self.request("GET", url, **kwargs)
+
+ def post(self, url, **kwargs):
+ """Invoke POST http request.
+
+ If ``api_base_url`` configured, shortcut is available::
+
+ client.post("timeline", json={"text": "Hi"})
+ """
+ return self.request("POST", url, **kwargs)
+
+ def patch(self, url, **kwargs):
+ """Invoke PATCH http request.
+
+ If ``api_base_url`` configured, shortcut is available::
+
+ client.patch("profile", json={"name": "Hsiaoming Yang"})
+ """
+ return self.request("PATCH", url, **kwargs)
+
+ def put(self, url, **kwargs):
+ """Invoke PUT http request.
+
+ If ``api_base_url`` configured, shortcut is available::
+
+ client.put("profile", json={"name": "Hsiaoming Yang"})
+ """
+ return self.request("PUT", url, **kwargs)
+
+ def delete(self, url, **kwargs):
+ """Invoke DELETE http request.
+
+ If ``api_base_url`` configured, shortcut is available::
+
+ client.delete("posts/123")
+ """
+ return self.request("DELETE", url, **kwargs)
+
+
+class _RequestMixin:
+ def _get_requested_token(self, request):
+ if self._fetch_token and request:
+ return self._fetch_token(request)
+
+ def _send_token_request(self, session, method, url, token, kwargs):
+ request = kwargs.pop("request", None)
+ withhold_token = kwargs.get("withhold_token")
+ if self.api_base_url and not url.startswith(("https://", "http://")):
+ url = urlparse.urljoin(self.api_base_url, url)
+
+ if withhold_token:
+ return session.request(method, url, **kwargs)
+
+ if token is None:
+ token = self._get_requested_token(request)
+
+ if token is None:
+ raise MissingTokenError()
+
+ session.token = token
+ return session.request(method, url, **kwargs)
+
+
+class OAuth1Base:
+ client_cls = None
+
+ def __init__(
+ self,
+ framework,
+ name=None,
+ fetch_token=None,
+ client_id=None,
+ client_secret=None,
+ request_token_url=None,
+ request_token_params=None,
+ access_token_url=None,
+ access_token_params=None,
+ authorize_url=None,
+ authorize_params=None,
+ api_base_url=None,
+ client_kwargs=None,
+ user_agent=None,
+ **kwargs,
+ ):
+ self.framework = framework
+ self.name = name
+ self.client_id = client_id
+ self.client_secret = client_secret
+ self.request_token_url = request_token_url
+ self.request_token_params = request_token_params
+ self.access_token_url = access_token_url
+ self.access_token_params = access_token_params
+ self.authorize_url = authorize_url
+ self.authorize_params = authorize_params
+ self.api_base_url = api_base_url
+ self.client_kwargs = client_kwargs or {}
+
+ self._fetch_token = fetch_token
+ self._user_agent = user_agent or default_user_agent
+ self._kwargs = kwargs
+
+ def _get_oauth_client(self):
+ session = self.client_cls(
+ self.client_id, self.client_secret, **self.client_kwargs
+ )
+ session.headers["User-Agent"] = self._user_agent
+ return session
+
+
+class OAuth1Mixin(_RequestMixin, OAuth1Base):
+ def request(self, method, url, token=None, **kwargs):
+ with self._get_oauth_client() as session:
+ return self._send_token_request(session, method, url, token, kwargs)
+
+ def create_authorization_url(self, redirect_uri=None, **kwargs):
+ """Generate the authorization url and state for HTTP redirect.
+
+ :param redirect_uri: Callback or redirect URI for authorization.
+ :param kwargs: Extra parameters to include.
+ :return: dict
+ """
+ if not self.authorize_url:
+ raise RuntimeError('Missing "authorize_url" value')
+
+ if self.authorize_params:
+ kwargs.update(self.authorize_params)
+
+ with self._get_oauth_client() as client:
+ client.redirect_uri = redirect_uri
+ params = self.request_token_params or {}
+ request_token = client.fetch_request_token(self.request_token_url, **params)
+ log.debug(f"Fetch request token: {request_token!r}")
+ url = client.create_authorization_url(self.authorize_url, **kwargs)
+ state = request_token["oauth_token"]
+ return {"url": url, "request_token": request_token, "state": state}
+
+ def fetch_access_token(self, request_token=None, **kwargs):
+ """Fetch access token in one step.
+
+ :param request_token: A previous request token for OAuth 1.
+ :param kwargs: Extra parameters to fetch access token.
+ :return: A token dict.
+ """
+ with self._get_oauth_client() as client:
+ if request_token is None:
+ raise MissingRequestTokenError()
+ # merge request token with verifier
+ token = {}
+ token.update(request_token)
+ token.update(kwargs)
+ client.token = token
+ params = self.access_token_params or {}
+ token = client.fetch_access_token(self.access_token_url, **params)
+ return token
+
+
+class OAuth2Base:
+ client_cls = None
+
+ def __init__(
+ self,
+ framework,
+ name=None,
+ fetch_token=None,
+ update_token=None,
+ client_id=None,
+ client_secret=None,
+ access_token_url=None,
+ access_token_params=None,
+ authorize_url=None,
+ authorize_params=None,
+ api_base_url=None,
+ client_kwargs=None,
+ server_metadata_url=None,
+ compliance_fix=None,
+ client_auth_methods=None,
+ user_agent=None,
+ **kwargs,
+ ):
+ self.framework = framework
+ self.name = name
+ self.client_id = client_id
+ self.client_secret = client_secret
+ self.access_token_url = access_token_url
+ self.access_token_params = access_token_params
+ self.authorize_url = authorize_url
+ self.authorize_params = authorize_params
+ self.api_base_url = api_base_url
+ self.client_kwargs = client_kwargs or {}
+
+ self.compliance_fix = compliance_fix
+ self.client_auth_methods = client_auth_methods
+ self._fetch_token = fetch_token
+ self._update_token = update_token
+ self._user_agent = user_agent or default_user_agent
+
+ self._server_metadata_url = server_metadata_url
+ self.server_metadata = kwargs
+
+ def _on_update_token(self, token, refresh_token=None, access_token=None):
+ raise NotImplementedError()
+
+ def _get_oauth_client(self, **metadata):
+ client_kwargs = {}
+ client_kwargs.update(self.client_kwargs)
+ client_kwargs.update(metadata)
+
+ if self.authorize_url:
+ client_kwargs["authorization_endpoint"] = self.authorize_url
+ if self.access_token_url:
+ client_kwargs["token_endpoint"] = self.access_token_url
+
+ session = self.client_cls(
+ client_id=self.client_id,
+ client_secret=self.client_secret,
+ update_token=self._on_update_token,
+ **client_kwargs,
+ )
+ if self.client_auth_methods:
+ for f in self.client_auth_methods:
+ session.register_client_auth_method(f)
+
+ if self.compliance_fix:
+ self.compliance_fix(session)
+
+ session.headers["User-Agent"] = self._user_agent
+ return session
+
+ @staticmethod
+ def _format_state_params(state_data, params):
+ if state_data is None:
+ raise MismatchingStateError()
+
+ code_verifier = state_data.get("code_verifier")
+ if code_verifier:
+ params["code_verifier"] = code_verifier
+
+ redirect_uri = state_data.get("redirect_uri")
+ if redirect_uri:
+ params["redirect_uri"] = redirect_uri
+ return params
+
+ @staticmethod
+ def _create_oauth2_authorization_url(client, authorization_endpoint, **kwargs):
+ rv = {}
+ if client.code_challenge_method:
+ code_verifier = kwargs.get("code_verifier")
+ if not code_verifier:
+ code_verifier = generate_token(48)
+ kwargs["code_verifier"] = code_verifier
+ rv["code_verifier"] = code_verifier
+ log.debug(f"Using code_verifier: {code_verifier!r}")
+
+ scope = kwargs.get("scope", client.scope)
+ scope = (
+ (scope if isinstance(scope, (list, tuple)) else scope.split())
+ if scope
+ else None
+ )
+ if scope and "openid" in scope:
+ # this is an OpenID Connect service
+ nonce = kwargs.get("nonce")
+ if not nonce:
+ nonce = generate_token(20)
+ kwargs["nonce"] = nonce
+ rv["nonce"] = nonce
+
+ url, state = client.create_authorization_url(authorization_endpoint, **kwargs)
+ rv["url"] = url
+ rv["state"] = state
+ return rv
+
+
+class OAuth2Mixin(_RequestMixin, OAuth2Base):
+ def _on_update_token(self, token, refresh_token=None, access_token=None):
+ if callable(self._update_token):
+ self._update_token(
+ token,
+ refresh_token=refresh_token,
+ access_token=access_token,
+ )
+ self.framework.update_token(
+ token,
+ refresh_token=refresh_token,
+ access_token=access_token,
+ )
+
+ def request(self, method, url, token=None, **kwargs):
+ metadata = self.load_server_metadata()
+ with self._get_oauth_client(**metadata) as session:
+ return self._send_token_request(session, method, url, token, kwargs)
+
+ def load_server_metadata(self):
+ if self._server_metadata_url and "_loaded_at" not in self.server_metadata:
+ with self.client_cls(**self.client_kwargs) as session:
+ resp = session.request(
+ "GET", self._server_metadata_url, withhold_token=True
+ )
+ resp.raise_for_status()
+ metadata = resp.json()
+
+ metadata["_loaded_at"] = time.time()
+ self.server_metadata.update(metadata)
+ return self.server_metadata
+
+ def create_authorization_url(self, redirect_uri=None, **kwargs):
+ """Generate the authorization url and state for HTTP redirect.
+
+ :param redirect_uri: Callback or redirect URI for authorization.
+ :param kwargs: Extra parameters to include.
+ :return: dict
+ """
+ metadata = self.load_server_metadata()
+ authorization_endpoint = self.authorize_url or metadata.get(
+ "authorization_endpoint"
+ )
+
+ if not authorization_endpoint:
+ raise RuntimeError('Missing "authorize_url" value')
+
+ if self.authorize_params:
+ kwargs.update(self.authorize_params)
+
+ with self._get_oauth_client(**metadata) as client:
+ if redirect_uri is not None:
+ client.redirect_uri = redirect_uri
+ return self._create_oauth2_authorization_url(
+ client, authorization_endpoint, **kwargs
+ )
+
+ def fetch_access_token(self, redirect_uri=None, **kwargs):
+ """Fetch access token in the final step.
+
+ :param redirect_uri: Callback or Redirect URI that is used in
+ previous :meth:`authorize_redirect`.
+ :param kwargs: Extra parameters to fetch access token.
+ :return: A token dict.
+ """
+ metadata = self.load_server_metadata()
+ token_endpoint = self.access_token_url or metadata.get("token_endpoint")
+ with self._get_oauth_client(**metadata) as client:
+ if redirect_uri is not None:
+ client.redirect_uri = redirect_uri
+ params = {}
+ if self.access_token_params:
+ params.update(self.access_token_params)
+ params.update(kwargs)
+ token = client.fetch_token(token_endpoint, **params)
+ return token
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/sync_openid.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/sync_openid.py
new file mode 100644
index 00000000..1ac4d540
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/base_client/sync_openid.py
@@ -0,0 +1,95 @@
+from authlib.jose import JsonWebKey
+from authlib.jose import JsonWebToken
+from authlib.jose import jwt
+from authlib.oidc.core import CodeIDToken
+from authlib.oidc.core import ImplicitIDToken
+from authlib.oidc.core import UserInfo
+
+
+class OpenIDMixin:
+ def fetch_jwk_set(self, force=False):
+ metadata = self.load_server_metadata()
+ jwk_set = metadata.get("jwks")
+ if jwk_set and not force:
+ return jwk_set
+
+ uri = metadata.get("jwks_uri")
+ if not uri:
+ raise RuntimeError('Missing "jwks_uri" in metadata')
+
+ with self.client_cls(**self.client_kwargs) as session:
+ resp = session.request("GET", uri, withhold_token=True)
+ resp.raise_for_status()
+ jwk_set = resp.json()
+
+ self.server_metadata["jwks"] = jwk_set
+ return jwk_set
+
+ def userinfo(self, **kwargs):
+ """Fetch user info from ``userinfo_endpoint``."""
+ metadata = self.load_server_metadata()
+ resp = self.get(metadata["userinfo_endpoint"], **kwargs)
+ resp.raise_for_status()
+ data = resp.json()
+ return UserInfo(data)
+
+ def parse_id_token(
+ self, token, nonce, claims_options=None, claims_cls=None, leeway=120
+ ):
+ """Return an instance of UserInfo from token's ``id_token``."""
+ if "id_token" not in token:
+ return None
+
+ load_key = self.create_load_key()
+
+ claims_params = dict(
+ nonce=nonce,
+ client_id=self.client_id,
+ )
+
+ if claims_cls is None:
+ if "access_token" in token:
+ claims_params["access_token"] = token["access_token"]
+ claims_cls = CodeIDToken
+ else:
+ claims_cls = ImplicitIDToken
+
+ metadata = self.load_server_metadata()
+ if claims_options is None and "issuer" in metadata:
+ claims_options = {"iss": {"values": [metadata["issuer"]]}}
+
+ alg_values = metadata.get("id_token_signing_alg_values_supported")
+ if alg_values:
+ _jwt = JsonWebToken(alg_values)
+ else:
+ _jwt = jwt
+
+ claims = _jwt.decode(
+ token["id_token"],
+ key=load_key,
+ claims_cls=claims_cls,
+ claims_options=claims_options,
+ claims_params=claims_params,
+ )
+ # https://github.com/authlib/authlib/issues/259
+ if claims.get("nonce_supported") is False:
+ claims.params["nonce"] = None
+
+ claims.validate(leeway=leeway)
+ return UserInfo(claims)
+
+ def create_load_key(self):
+ def load_key(header, _):
+ jwk_set = JsonWebKey.import_key_set(self.fetch_jwk_set())
+ try:
+ return jwk_set.find_by_kid(
+ header.get("kid"), use="sig", alg=header.get("alg")
+ )
+ except ValueError:
+ # re-try with new jwk set
+ jwk_set = JsonWebKey.import_key_set(self.fetch_jwk_set(force=True))
+ return jwk_set.find_by_kid(
+ header.get("kid"), use="sig", alg=header.get("alg")
+ )
+
+ return load_key
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__init__.py
new file mode 100644
index 00000000..28b5ff07
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__init__.py
@@ -0,0 +1,22 @@
+from ..base_client import BaseOAuth
+from ..base_client import OAuthError
+from .apps import DjangoOAuth1App
+from .apps import DjangoOAuth2App
+from .integration import DjangoIntegration
+from .integration import token_update
+
+
+class OAuth(BaseOAuth):
+ oauth1_client_cls = DjangoOAuth1App
+ oauth2_client_cls = DjangoOAuth2App
+ framework_integration_cls = DjangoIntegration
+
+
+__all__ = [
+ "OAuth",
+ "DjangoOAuth1App",
+ "DjangoOAuth2App",
+ "DjangoIntegration",
+ "token_update",
+ "OAuthError",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..561df2ff
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/apps.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/apps.cpython-312.pyc
new file mode 100644
index 00000000..3c43673b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/apps.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/integration.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/integration.cpython-312.pyc
new file mode 100644
index 00000000..144b1177
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/__pycache__/integration.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/apps.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/apps.py
new file mode 100644
index 00000000..9a14bc19
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/apps.py
@@ -0,0 +1,99 @@
+from django.http import HttpResponseRedirect
+
+from ..base_client import BaseApp
+from ..base_client import OAuth1Mixin
+from ..base_client import OAuth2Mixin
+from ..base_client import OAuthError
+from ..base_client import OpenIDMixin
+from ..requests_client import OAuth1Session
+from ..requests_client import OAuth2Session
+
+
+class DjangoAppMixin:
+ def save_authorize_data(self, request, **kwargs):
+ state = kwargs.pop("state", None)
+ if state:
+ self.framework.set_state_data(request.session, state, kwargs)
+ else:
+ raise RuntimeError("Missing state value")
+
+ def authorize_redirect(self, request, redirect_uri=None, **kwargs):
+ """Create a HTTP Redirect for Authorization Endpoint.
+
+ :param request: HTTP request instance from Django view.
+ :param redirect_uri: Callback or redirect URI for authorization.
+ :param kwargs: Extra parameters to include.
+ :return: A HTTP redirect response.
+ """
+ rv = self.create_authorization_url(redirect_uri, **kwargs)
+ self.save_authorize_data(request, redirect_uri=redirect_uri, **rv)
+ return HttpResponseRedirect(rv["url"])
+
+
+class DjangoOAuth1App(DjangoAppMixin, OAuth1Mixin, BaseApp):
+ client_cls = OAuth1Session
+
+ def authorize_access_token(self, request, **kwargs):
+ """Fetch access token in one step.
+
+ :param request: HTTP request instance from Django view.
+ :return: A token dict.
+ """
+ params = request.GET.dict()
+ state = params.get("oauth_token")
+ if not state:
+ raise OAuthError(description='Missing "oauth_token" parameter')
+
+ data = self.framework.get_state_data(request.session, state)
+ if not data:
+ raise OAuthError(description='Missing "request_token" in temporary data')
+
+ params["request_token"] = data["request_token"]
+ params.update(kwargs)
+ self.framework.clear_state_data(request.session, state)
+ return self.fetch_access_token(**params)
+
+
+class DjangoOAuth2App(DjangoAppMixin, OAuth2Mixin, OpenIDMixin, BaseApp):
+ client_cls = OAuth2Session
+
+ def authorize_access_token(self, request, **kwargs):
+ """Fetch access token in one step.
+
+ :param request: HTTP request instance from Django view.
+ :return: A token dict.
+ """
+ if request.method == "GET":
+ error = request.GET.get("error")
+ if error:
+ description = request.GET.get("error_description")
+ raise OAuthError(error=error, description=description)
+ params = {
+ "code": request.GET.get("code"),
+ "state": request.GET.get("state"),
+ }
+ else:
+ params = {
+ "code": request.POST.get("code"),
+ "state": request.POST.get("state"),
+ }
+
+ state_data = self.framework.get_state_data(request.session, params.get("state"))
+ self.framework.clear_state_data(request.session, params.get("state"))
+ params = self._format_state_params(state_data, params)
+
+ claims_options = kwargs.pop("claims_options", None)
+ claims_cls = kwargs.pop("claims_cls", None)
+ leeway = kwargs.pop("leeway", 120)
+ token = self.fetch_access_token(**params, **kwargs)
+
+ if "id_token" in token and "nonce" in state_data:
+ userinfo = self.parse_id_token(
+ token,
+ nonce=state_data["nonce"],
+ claims_options=claims_options,
+ claims_cls=claims_cls,
+ leeway=leeway,
+ )
+ token["userinfo"] = userinfo
+ return token
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/integration.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/integration.py
new file mode 100644
index 00000000..5f7f11da
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_client/integration.py
@@ -0,0 +1,23 @@
+from django.conf import settings
+from django.dispatch import Signal
+
+from ..base_client import FrameworkIntegration
+
+token_update = Signal()
+
+
+class DjangoIntegration(FrameworkIntegration):
+ def update_token(self, token, refresh_token=None, access_token=None):
+ token_update.send(
+ sender=self.__class__,
+ name=self.name,
+ token=token,
+ refresh_token=refresh_token,
+ access_token=access_token,
+ )
+
+ @staticmethod
+ def load_config(oauth, name, params):
+ config = getattr(settings, "AUTHLIB_OAUTH_CLIENTS", None)
+ if config:
+ return config.get(name)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__init__.py
new file mode 100644
index 00000000..7a479c80
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__init__.py
@@ -0,0 +1,5 @@
+from .authorization_server import BaseServer
+from .authorization_server import CacheAuthorizationServer
+from .resource_protector import ResourceProtector
+
+__all__ = ["BaseServer", "CacheAuthorizationServer", "ResourceProtector"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..63882900
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/authorization_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/authorization_server.cpython-312.pyc
new file mode 100644
index 00000000..b4ab1331
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/authorization_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/nonce.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/nonce.cpython-312.pyc
new file mode 100644
index 00000000..7f992de0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/nonce.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/resource_protector.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/resource_protector.cpython-312.pyc
new file mode 100644
index 00000000..49ac2f4e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/__pycache__/resource_protector.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/authorization_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/authorization_server.py
new file mode 100644
index 00000000..90195b18
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/authorization_server.py
@@ -0,0 +1,128 @@
+import logging
+
+from django.conf import settings
+from django.core.cache import cache
+from django.http import HttpResponse
+
+from authlib.common.security import generate_token
+from authlib.common.urls import url_encode
+from authlib.oauth1 import AuthorizationServer as _AuthorizationServer
+from authlib.oauth1 import OAuth1Request
+from authlib.oauth1 import TemporaryCredential
+
+from .nonce import exists_nonce_in_cache
+
+log = logging.getLogger(__name__)
+
+
+class BaseServer(_AuthorizationServer):
+ def __init__(self, client_model, token_model, token_generator=None):
+ self.client_model = client_model
+ self.token_model = token_model
+
+ if token_generator is None:
+
+ def token_generator():
+ return {
+ "oauth_token": generate_token(42),
+ "oauth_token_secret": generate_token(48),
+ }
+
+ self.token_generator = token_generator
+ self._config = getattr(settings, "AUTHLIB_OAUTH1_PROVIDER", {})
+ self._nonce_expires_in = self._config.get("nonce_expires_in", 86400)
+ methods = self._config.get("signature_methods")
+ if methods:
+ self.SUPPORTED_SIGNATURE_METHODS = methods
+
+ def get_client_by_id(self, client_id):
+ try:
+ return self.client_model.objects.get(client_id=client_id)
+ except self.client_model.DoesNotExist:
+ return None
+
+ def exists_nonce(self, nonce, request):
+ return exists_nonce_in_cache(nonce, request, self._nonce_expires_in)
+
+ def create_token_credential(self, request):
+ temporary_credential = request.credential
+ token = self.token_generator()
+ item = self.token_model(
+ oauth_token=token["oauth_token"],
+ oauth_token_secret=token["oauth_token_secret"],
+ user_id=temporary_credential.get_user_id(),
+ client_id=temporary_credential.get_client_id(),
+ )
+ item.save()
+ return item
+
+ def check_authorization_request(self, request):
+ req = self.create_oauth1_request(request)
+ self.validate_authorization_request(req)
+ return req
+
+ def create_oauth1_request(self, request):
+ if request.method == "POST":
+ body = request.POST.dict()
+ else:
+ body = None
+ url = request.build_absolute_uri()
+ return OAuth1Request(request.method, url, body, request.headers)
+
+ def handle_response(self, status_code, payload, headers):
+ resp = HttpResponse(url_encode(payload), status=status_code)
+ for k, v in headers:
+ resp[k] = v
+ return resp
+
+
+class CacheAuthorizationServer(BaseServer):
+ def __init__(self, client_model, token_model, token_generator=None):
+ super().__init__(client_model, token_model, token_generator)
+ self._temporary_expires_in = self._config.get(
+ "temporary_credential_expires_in", 86400
+ )
+ self._temporary_credential_key_prefix = self._config.get(
+ "temporary_credential_key_prefix", "temporary_credential:"
+ )
+
+ def create_temporary_credential(self, request):
+ key_prefix = self._temporary_credential_key_prefix
+ token = self.token_generator()
+
+ client_id = request.client_id
+ redirect_uri = request.redirect_uri
+ key = key_prefix + token["oauth_token"]
+ token["client_id"] = client_id
+ if redirect_uri:
+ token["oauth_callback"] = redirect_uri
+
+ cache.set(key, token, timeout=self._temporary_expires_in)
+ return TemporaryCredential(token)
+
+ def get_temporary_credential(self, request):
+ if not request.token:
+ return None
+
+ key_prefix = self._temporary_credential_key_prefix
+ key = key_prefix + request.token
+ value = cache.get(key)
+ if value:
+ return TemporaryCredential(value)
+
+ def delete_temporary_credential(self, request):
+ if request.token:
+ key_prefix = self._temporary_credential_key_prefix
+ key = key_prefix + request.token
+ cache.delete(key)
+
+ def create_authorization_verifier(self, request):
+ key_prefix = self._temporary_credential_key_prefix
+ verifier = generate_token(36)
+ credential = request.credential
+ user = request.user
+ key = key_prefix + credential.get_oauth_token()
+ credential["oauth_verifier"] = verifier
+ credential["user_id"] = user.pk
+ cache.set(key, credential, timeout=self._temporary_expires_in)
+ return verifier
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/nonce.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/nonce.py
new file mode 100644
index 00000000..a4b21c5f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/nonce.py
@@ -0,0 +1,15 @@
+from django.core.cache import cache
+
+
+def exists_nonce_in_cache(nonce, request, timeout):
+ key_prefix = "nonce:"
+ timestamp = request.timestamp
+ client_id = request.client_id
+ token = request.token
+ key = f"{key_prefix}{nonce}-{timestamp}-{client_id}"
+ if token:
+ key = f"{key}-{token}"
+
+ rv = bool(cache.get(key))
+ cache.set(key, 1, timeout=timeout)
+ return rv
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/resource_protector.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/resource_protector.py
new file mode 100644
index 00000000..21759ac3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth1/resource_protector.py
@@ -0,0 +1,68 @@
+import functools
+
+from django.conf import settings
+from django.http import JsonResponse
+
+from authlib.oauth1 import ResourceProtector as _ResourceProtector
+from authlib.oauth1.errors import OAuth1Error
+
+from .nonce import exists_nonce_in_cache
+
+
+class ResourceProtector(_ResourceProtector):
+ def __init__(self, client_model, token_model):
+ self.client_model = client_model
+ self.token_model = token_model
+
+ config = getattr(settings, "AUTHLIB_OAUTH1_PROVIDER", {})
+ methods = config.get("signature_methods", [])
+ if methods and isinstance(methods, (list, tuple)):
+ self.SUPPORTED_SIGNATURE_METHODS = methods
+
+ self._nonce_expires_in = config.get("nonce_expires_in", 86400)
+
+ def get_client_by_id(self, client_id):
+ try:
+ return self.client_model.objects.get(client_id=client_id)
+ except self.client_model.DoesNotExist:
+ return None
+
+ def get_token_credential(self, request):
+ try:
+ return self.token_model.objects.get(
+ client_id=request.client_id, oauth_token=request.token
+ )
+ except self.token_model.DoesNotExist:
+ return None
+
+ def exists_nonce(self, nonce, request):
+ return exists_nonce_in_cache(nonce, request, self._nonce_expires_in)
+
+ def acquire_credential(self, request):
+ if request.method in ["POST", "PUT"]:
+ body = request.POST.dict()
+ else:
+ body = None
+
+ url = request.build_absolute_uri()
+ req = self.validate_request(request.method, url, body, request.headers)
+ return req.credential
+
+ def __call__(self, realm=None):
+ def wrapper(f):
+ @functools.wraps(f)
+ def decorated(request, *args, **kwargs):
+ try:
+ credential = self.acquire_credential(request)
+ request.oauth1_credential = credential
+ except OAuth1Error as error:
+ body = dict(error.get_body())
+ resp = JsonResponse(body, status=error.status_code)
+ resp["Cache-Control"] = "no-store"
+ resp["Pragma"] = "no-cache"
+ return resp
+ return f(request, *args, **kwargs)
+
+ return decorated
+
+ return wrapper
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__init__.py
new file mode 100644
index 00000000..79b4773a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__init__.py
@@ -0,0 +1,9 @@
+# flake8: noqa
+
+from .authorization_server import AuthorizationServer
+from .endpoints import RevocationEndpoint
+from .resource_protector import BearerTokenValidator
+from .resource_protector import ResourceProtector
+from .signals import client_authenticated
+from .signals import token_authenticated
+from .signals import token_revoked
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..57d93aa0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/authorization_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/authorization_server.cpython-312.pyc
new file mode 100644
index 00000000..ea6bb4db
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/authorization_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/endpoints.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/endpoints.cpython-312.pyc
new file mode 100644
index 00000000..2253f467
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/endpoints.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/requests.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/requests.cpython-312.pyc
new file mode 100644
index 00000000..facdf68f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/requests.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/resource_protector.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/resource_protector.cpython-312.pyc
new file mode 100644
index 00000000..002711d8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/resource_protector.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/signals.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/signals.cpython-312.pyc
new file mode 100644
index 00000000..42a9620a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/__pycache__/signals.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/authorization_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/authorization_server.py
new file mode 100644
index 00000000..cdae210f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/authorization_server.py
@@ -0,0 +1,122 @@
+from django.conf import settings
+from django.http import HttpResponse
+from django.utils.module_loading import import_string
+
+from authlib.common.encoding import json_dumps
+from authlib.common.security import generate_token as _generate_token
+from authlib.oauth2 import AuthorizationServer as _AuthorizationServer
+from authlib.oauth2.rfc6750 import BearerTokenGenerator
+
+from .requests import DjangoJsonRequest
+from .requests import DjangoOAuth2Request
+from .signals import client_authenticated
+from .signals import token_revoked
+
+
+class AuthorizationServer(_AuthorizationServer):
+ """Django implementation of :class:`authlib.oauth2.rfc6749.AuthorizationServer`.
+ Initialize it with client model and token model::
+
+ from authlib.integrations.django_oauth2 import AuthorizationServer
+ from your_project.models import OAuth2Client, OAuth2Token
+
+ server = AuthorizationServer(OAuth2Client, OAuth2Token)
+ """
+
+ def __init__(self, client_model, token_model):
+ super().__init__()
+ self.client_model = client_model
+ self.token_model = token_model
+ self.load_config(getattr(settings, "AUTHLIB_OAUTH2_PROVIDER", {}))
+
+ def load_config(self, config):
+ self.config = config
+ scopes_supported = self.config.get("scopes_supported")
+ self.scopes_supported = scopes_supported
+ # add default token generator
+ self.register_token_generator("default", self.create_bearer_token_generator())
+
+ def query_client(self, client_id):
+ """Default method for ``AuthorizationServer.query_client``. Developers MAY
+ rewrite this function to meet their own needs.
+ """
+ try:
+ return self.client_model.objects.get(client_id=client_id)
+ except self.client_model.DoesNotExist:
+ return None
+
+ def save_token(self, token, request):
+ """Default method for ``AuthorizationServer.save_token``. Developers MAY
+ rewrite this function to meet their own needs.
+ """
+ client = request.client
+ if request.user:
+ user_id = request.user.pk
+ else:
+ user_id = client.user_id
+ item = self.token_model(client_id=client.client_id, user_id=user_id, **token)
+ item.save()
+ return item
+
+ def create_oauth2_request(self, request):
+ return DjangoOAuth2Request(request)
+
+ def create_json_request(self, request):
+ return DjangoJsonRequest(request)
+
+ def handle_response(self, status_code, payload, headers):
+ if isinstance(payload, dict):
+ payload = json_dumps(payload)
+ resp = HttpResponse(payload, status=status_code)
+ for k, v in headers:
+ resp[k] = v
+ return resp
+
+ def send_signal(self, name, *args, **kwargs):
+ if name == "after_authenticate_client":
+ client_authenticated.send(*args, sender=self.__class__, **kwargs)
+ elif name == "after_revoke_token":
+ token_revoked.send(*args, sender=self.__class__, **kwargs)
+
+ def create_bearer_token_generator(self):
+ """Default method to create BearerToken generator."""
+ conf = self.config.get("access_token_generator", True)
+ access_token_generator = create_token_generator(conf, 42)
+
+ conf = self.config.get("refresh_token_generator", False)
+ refresh_token_generator = create_token_generator(conf, 48)
+
+ conf = self.config.get("token_expires_in")
+ expires_generator = create_token_expires_in_generator(conf)
+
+ return BearerTokenGenerator(
+ access_token_generator=access_token_generator,
+ refresh_token_generator=refresh_token_generator,
+ expires_generator=expires_generator,
+ )
+
+
+def create_token_generator(token_generator_conf, length=42):
+ if callable(token_generator_conf):
+ return token_generator_conf
+
+ if isinstance(token_generator_conf, str):
+ return import_string(token_generator_conf)
+ elif token_generator_conf is True:
+
+ def token_generator(*args, **kwargs):
+ return _generate_token(length)
+
+ return token_generator
+
+
+def create_token_expires_in_generator(expires_in_conf=None):
+ data = {}
+ data.update(BearerTokenGenerator.GRANT_TYPES_EXPIRES_IN)
+ if expires_in_conf:
+ data.update(expires_in_conf)
+
+ def expires_in(client, grant_type):
+ return data.get(grant_type, BearerTokenGenerator.DEFAULT_EXPIRES_IN)
+
+ return expires_in
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/endpoints.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/endpoints.py
new file mode 100644
index 00000000..08a9d4f6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/endpoints.py
@@ -0,0 +1,56 @@
+from authlib.oauth2.rfc7009 import RevocationEndpoint as _RevocationEndpoint
+
+
+class RevocationEndpoint(_RevocationEndpoint):
+ """The revocation endpoint for OAuth authorization servers allows clients
+ to notify the authorization server that a previously obtained refresh or
+ access token is no longer needed.
+
+ Register it into authorization server, and create token endpoint response
+ for token revocation::
+
+ from django.views.decorators.http import require_http_methods
+
+ # see register into authorization server instance
+ server.register_endpoint(RevocationEndpoint)
+
+
+ @require_http_methods(["POST"])
+ def revoke_token(request):
+ return server.create_endpoint_response(
+ RevocationEndpoint.ENDPOINT_NAME, request
+ )
+ """
+
+ def query_token(self, token, token_type_hint):
+ """Query requested token from database."""
+ token_model = self.server.token_model
+ if token_type_hint == "access_token":
+ rv = _query_access_token(token_model, token)
+ elif token_type_hint == "refresh_token":
+ rv = _query_refresh_token(token_model, token)
+ else:
+ rv = _query_access_token(token_model, token)
+ if not rv:
+ rv = _query_refresh_token(token_model, token)
+
+ return rv
+
+ def revoke_token(self, token, request):
+ """Mark the give token as revoked."""
+ token.revoked = True
+ token.save()
+
+
+def _query_access_token(token_model, token):
+ try:
+ return token_model.objects.get(access_token=token)
+ except token_model.DoesNotExist:
+ return None
+
+
+def _query_refresh_token(token_model, token):
+ try:
+ return token_model.objects.get(refresh_token=token)
+ except token_model.DoesNotExist:
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/requests.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/requests.py
new file mode 100644
index 00000000..b490cb70
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/requests.py
@@ -0,0 +1,65 @@
+from collections import defaultdict
+
+from django.http import HttpRequest
+from django.utils.functional import cached_property
+
+from authlib.common.encoding import json_loads
+from authlib.oauth2.rfc6749 import JsonPayload
+from authlib.oauth2.rfc6749 import JsonRequest
+from authlib.oauth2.rfc6749 import OAuth2Payload
+from authlib.oauth2.rfc6749 import OAuth2Request
+
+
+class DjangoOAuth2Payload(OAuth2Payload):
+ def __init__(self, request: HttpRequest):
+ self._request = request
+
+ @cached_property
+ def data(self):
+ data = {}
+ data.update(self._request.GET.dict())
+ data.update(self._request.POST.dict())
+ return data
+
+ @cached_property
+ def datalist(self):
+ values = defaultdict(list)
+ for k in self._request.GET:
+ values[k].extend(self._request.GET.getlist(k))
+ for k in self._request.POST:
+ values[k].extend(self._request.POST.getlist(k))
+ return values
+
+
+class DjangoOAuth2Request(OAuth2Request):
+ def __init__(self, request: HttpRequest):
+ super().__init__(
+ method=request.method,
+ uri=request.build_absolute_uri(),
+ headers=request.headers,
+ )
+ self.payload = DjangoOAuth2Payload(request)
+ self._request = request
+
+ @property
+ def args(self):
+ return self._request.GET
+
+ @property
+ def form(self):
+ return self._request.POST
+
+
+class DjangoJsonPayload(JsonPayload):
+ def __init__(self, request: HttpRequest):
+ self._request = request
+
+ @cached_property
+ def data(self):
+ return json_loads(self._request.body)
+
+
+class DjangoJsonRequest(JsonRequest):
+ def __init__(self, request: HttpRequest):
+ super().__init__(request.method, request.build_absolute_uri(), request.headers)
+ self.payload = DjangoJsonPayload(request)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/resource_protector.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/resource_protector.py
new file mode 100644
index 00000000..3bed86c9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/resource_protector.py
@@ -0,0 +1,75 @@
+import functools
+
+from django.http import JsonResponse
+
+from authlib.oauth2 import OAuth2Error
+from authlib.oauth2 import ResourceProtector as _ResourceProtector
+from authlib.oauth2.rfc6749 import MissingAuthorizationError
+from authlib.oauth2.rfc6750 import BearerTokenValidator as _BearerTokenValidator
+
+from .requests import DjangoJsonRequest
+from .signals import token_authenticated
+
+
+class ResourceProtector(_ResourceProtector):
+ def acquire_token(self, request, scopes=None, **kwargs):
+ """A method to acquire current valid token with the given scope.
+
+ :param request: Django HTTP request instance
+ :param scopes: a list of scope values
+ :return: token object
+ """
+ req = DjangoJsonRequest(request)
+ # backward compatibility
+ kwargs["scopes"] = scopes
+ for claim in kwargs:
+ if isinstance(kwargs[claim], str):
+ kwargs[claim] = [kwargs[claim]]
+ token = self.validate_request(request=req, **kwargs)
+ token_authenticated.send(sender=self.__class__, token=token)
+ return token
+
+ def __call__(self, scopes=None, optional=False, **kwargs):
+ claims = kwargs
+ # backward compatibility
+ claims["scopes"] = scopes
+
+ def wrapper(f):
+ @functools.wraps(f)
+ def decorated(request, *args, **kwargs):
+ try:
+ token = self.acquire_token(request, **claims)
+ request.oauth_token = token
+ except MissingAuthorizationError as error:
+ if optional:
+ request.oauth_token = None
+ return f(request, *args, **kwargs)
+ return return_error_response(error)
+ except OAuth2Error as error:
+ return return_error_response(error)
+ return f(request, *args, **kwargs)
+
+ return decorated
+
+ return wrapper
+
+
+class BearerTokenValidator(_BearerTokenValidator):
+ def __init__(self, token_model, realm=None, **extra_attributes):
+ self.token_model = token_model
+ super().__init__(realm, **extra_attributes)
+
+ def authenticate_token(self, token_string):
+ try:
+ return self.token_model.objects.get(access_token=token_string)
+ except self.token_model.DoesNotExist:
+ return None
+
+
+def return_error_response(error):
+ body = dict(error.get_body())
+ resp = JsonResponse(body, status=error.status_code)
+ headers = error.get_headers()
+ for k, v in headers:
+ resp[k] = v
+ return resp
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/signals.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/signals.py
new file mode 100644
index 00000000..5d22216f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/django_oauth2/signals.py
@@ -0,0 +1,10 @@
+from django.dispatch import Signal
+
+#: signal when client is authenticated
+client_authenticated = Signal()
+
+#: signal when token is revoked
+token_revoked = Signal()
+
+#: signal when token is authenticated
+token_authenticated = Signal()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__init__.py
new file mode 100644
index 00000000..d6404acf
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__init__.py
@@ -0,0 +1,59 @@
+from werkzeug.local import LocalProxy
+
+from ..base_client import BaseOAuth
+from ..base_client import OAuthError
+from .apps import FlaskOAuth1App
+from .apps import FlaskOAuth2App
+from .integration import FlaskIntegration
+from .integration import token_update
+
+
+class OAuth(BaseOAuth):
+ oauth1_client_cls = FlaskOAuth1App
+ oauth2_client_cls = FlaskOAuth2App
+ framework_integration_cls = FlaskIntegration
+
+ def __init__(self, app=None, cache=None, fetch_token=None, update_token=None):
+ super().__init__(
+ cache=cache, fetch_token=fetch_token, update_token=update_token
+ )
+ self.app = app
+ if app:
+ self.init_app(app)
+
+ def init_app(self, app, cache=None, fetch_token=None, update_token=None):
+ """Initialize lazy for Flask app. This is usually used for Flask application
+ factory pattern.
+ """
+ self.app = app
+ if cache is not None:
+ self.cache = cache
+
+ if fetch_token:
+ self.fetch_token = fetch_token
+ if update_token:
+ self.update_token = update_token
+
+ app.extensions = getattr(app, "extensions", {})
+ app.extensions["authlib.integrations.flask_client"] = self
+
+ def create_client(self, name):
+ if not self.app:
+ raise RuntimeError("OAuth is not init with Flask app.")
+ return super().create_client(name)
+
+ def register(self, name, overwrite=False, **kwargs):
+ self._registry[name] = (overwrite, kwargs)
+ if self.app:
+ return self.create_client(name)
+ return LocalProxy(lambda: self.create_client(name))
+
+
+__all__ = [
+ "OAuth",
+ "FlaskIntegration",
+ "FlaskOAuth1App",
+ "FlaskOAuth2App",
+ "token_update",
+ "OAuthError",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..f2026b6b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/apps.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/apps.cpython-312.pyc
new file mode 100644
index 00000000..ff2ebe89
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/apps.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/integration.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/integration.cpython-312.pyc
new file mode 100644
index 00000000..8f9bf662
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/__pycache__/integration.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/apps.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/apps.py
new file mode 100644
index 00000000..148f640f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/apps.py
@@ -0,0 +1,122 @@
+from flask import g
+from flask import redirect
+from flask import request
+from flask import session
+
+from ..base_client import BaseApp
+from ..base_client import OAuth1Mixin
+from ..base_client import OAuth2Mixin
+from ..base_client import OAuthError
+from ..base_client import OpenIDMixin
+from ..requests_client import OAuth1Session
+from ..requests_client import OAuth2Session
+
+
+class FlaskAppMixin:
+ @property
+ def token(self):
+ attr = f"_oauth_token_{self.name}"
+ token = g.get(attr)
+ if token:
+ return token
+ if self._fetch_token:
+ token = self._fetch_token()
+ self.token = token
+ return token
+
+ @token.setter
+ def token(self, token):
+ attr = f"_oauth_token_{self.name}"
+ setattr(g, attr, token)
+
+ def _get_requested_token(self, *args, **kwargs):
+ return self.token
+
+ def save_authorize_data(self, **kwargs):
+ state = kwargs.pop("state", None)
+ if state:
+ self.framework.set_state_data(session, state, kwargs)
+ else:
+ raise RuntimeError("Missing state value")
+
+ def authorize_redirect(self, redirect_uri=None, **kwargs):
+ """Create a HTTP Redirect for Authorization Endpoint.
+
+ :param redirect_uri: Callback or redirect URI for authorization.
+ :param kwargs: Extra parameters to include.
+ :return: A HTTP redirect response.
+ """
+ rv = self.create_authorization_url(redirect_uri, **kwargs)
+ self.save_authorize_data(redirect_uri=redirect_uri, **rv)
+ return redirect(rv["url"])
+
+
+class FlaskOAuth1App(FlaskAppMixin, OAuth1Mixin, BaseApp):
+ client_cls = OAuth1Session
+
+ def authorize_access_token(self, **kwargs):
+ """Fetch access token in one step.
+
+ :return: A token dict.
+ """
+ params = request.args.to_dict(flat=True)
+ state = params.get("oauth_token")
+ if not state:
+ raise OAuthError(description='Missing "oauth_token" parameter')
+
+ data = self.framework.get_state_data(session, state)
+ if not data:
+ raise OAuthError(description='Missing "request_token" in temporary data')
+
+ params["request_token"] = data["request_token"]
+ params.update(kwargs)
+ self.framework.clear_state_data(session, state)
+ token = self.fetch_access_token(**params)
+ self.token = token
+ return token
+
+
+class FlaskOAuth2App(FlaskAppMixin, OAuth2Mixin, OpenIDMixin, BaseApp):
+ client_cls = OAuth2Session
+
+ def authorize_access_token(self, **kwargs):
+ """Fetch access token in one step.
+
+ :return: A token dict.
+ """
+ if request.method == "GET":
+ error = request.args.get("error")
+ if error:
+ description = request.args.get("error_description")
+ raise OAuthError(error=error, description=description)
+
+ params = {
+ "code": request.args.get("code"),
+ "state": request.args.get("state"),
+ }
+ else:
+ params = {
+ "code": request.form.get("code"),
+ "state": request.form.get("state"),
+ }
+
+ state_data = self.framework.get_state_data(session, params.get("state"))
+ self.framework.clear_state_data(session, params.get("state"))
+ params = self._format_state_params(state_data, params)
+
+ claims_options = kwargs.pop("claims_options", None)
+ claims_cls = kwargs.pop("claims_cls", None)
+ leeway = kwargs.pop("leeway", 120)
+ token = self.fetch_access_token(**params, **kwargs)
+ self.token = token
+
+ if "id_token" in token and "nonce" in state_data:
+ userinfo = self.parse_id_token(
+ token,
+ nonce=state_data["nonce"],
+ claims_options=claims_options,
+ claims_cls=claims_cls,
+ leeway=leeway,
+ )
+ token["userinfo"] = userinfo
+ return token
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/integration.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/integration.py
new file mode 100644
index 00000000..c8d8bbfb
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_client/integration.py
@@ -0,0 +1,29 @@
+from flask import current_app
+from flask.signals import Namespace
+
+from ..base_client import FrameworkIntegration
+
+_signal = Namespace()
+#: signal when token is updated
+token_update = _signal.signal("token_update")
+
+
+class FlaskIntegration(FrameworkIntegration):
+ def update_token(self, token, refresh_token=None, access_token=None):
+ token_update.send(
+ current_app,
+ name=self.name,
+ token=token,
+ refresh_token=refresh_token,
+ access_token=access_token,
+ )
+
+ @staticmethod
+ def load_config(oauth, name, params):
+ rv = {}
+ for k in params:
+ conf_key = f"{name}_{k}".upper()
+ v = oauth.app.config.get(conf_key, None)
+ if v is not None:
+ rv[k] = v
+ return rv
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__init__.py
new file mode 100644
index 00000000..dd20d920
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__init__.py
@@ -0,0 +1,8 @@
+# flake8: noqa
+
+from .authorization_server import AuthorizationServer
+from .cache import create_exists_nonce_func
+from .cache import register_nonce_hooks
+from .cache import register_temporary_credential_hooks
+from .resource_protector import ResourceProtector
+from .resource_protector import current_credential
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..bc85ae9a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/authorization_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/authorization_server.cpython-312.pyc
new file mode 100644
index 00000000..12e3d0d0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/authorization_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/cache.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/cache.cpython-312.pyc
new file mode 100644
index 00000000..d3bd3364
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/cache.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/resource_protector.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/resource_protector.cpython-312.pyc
new file mode 100644
index 00000000..6bc8bc6a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/__pycache__/resource_protector.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/authorization_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/authorization_server.py
new file mode 100644
index 00000000..8cf6afe0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/authorization_server.py
@@ -0,0 +1,168 @@
+import logging
+
+from flask import Response
+from flask import request as flask_req
+from werkzeug.utils import import_string
+
+from authlib.common.security import generate_token
+from authlib.common.urls import url_encode
+from authlib.oauth1 import AuthorizationServer as _AuthorizationServer
+from authlib.oauth1 import OAuth1Request
+
+log = logging.getLogger(__name__)
+
+
+class AuthorizationServer(_AuthorizationServer):
+ """Flask implementation of :class:`authlib.rfc5849.AuthorizationServer`.
+ Initialize it with Flask app instance, client model class and cache::
+
+ server = AuthorizationServer(app=app, query_client=query_client)
+ # or initialize lazily
+ server = AuthorizationServer()
+ server.init_app(app, query_client=query_client)
+
+ :param app: A Flask app instance
+ :param query_client: A function to get client by client_id. The client
+ model class MUST implement the methods described by
+ :class:`~authlib.oauth1.rfc5849.ClientMixin`.
+ :param token_generator: A function to generate token
+ """
+
+ def __init__(self, app=None, query_client=None, token_generator=None):
+ self.app = app
+ self.query_client = query_client
+ self.token_generator = token_generator
+
+ self._hooks = {
+ "exists_nonce": None,
+ "create_temporary_credential": None,
+ "get_temporary_credential": None,
+ "delete_temporary_credential": None,
+ "create_authorization_verifier": None,
+ "create_token_credential": None,
+ }
+ if app is not None:
+ self.init_app(app)
+
+ def init_app(self, app, query_client=None, token_generator=None):
+ if query_client is not None:
+ self.query_client = query_client
+ if token_generator is not None:
+ self.token_generator = token_generator
+
+ if self.token_generator is None:
+ self.token_generator = self.create_token_generator(app)
+
+ methods = app.config.get("OAUTH1_SUPPORTED_SIGNATURE_METHODS")
+ if methods and isinstance(methods, (list, tuple)):
+ self.SUPPORTED_SIGNATURE_METHODS = methods
+
+ self.app = app
+
+ def register_hook(self, name, func):
+ if name not in self._hooks:
+ raise ValueError('Invalid "name" of hook')
+ self._hooks[name] = func
+
+ def create_token_generator(self, app):
+ token_generator = app.config.get("OAUTH1_TOKEN_GENERATOR")
+
+ if isinstance(token_generator, str):
+ token_generator = import_string(token_generator)
+ else:
+ length = app.config.get("OAUTH1_TOKEN_LENGTH", 42)
+
+ def token_generator():
+ return generate_token(length)
+
+ secret_generator = app.config.get("OAUTH1_TOKEN_SECRET_GENERATOR")
+ if isinstance(secret_generator, str):
+ secret_generator = import_string(secret_generator)
+ else:
+ length = app.config.get("OAUTH1_TOKEN_SECRET_LENGTH", 48)
+
+ def secret_generator():
+ return generate_token(length)
+
+ def create_token():
+ return {
+ "oauth_token": token_generator(),
+ "oauth_token_secret": secret_generator(),
+ }
+
+ return create_token
+
+ def get_client_by_id(self, client_id):
+ return self.query_client(client_id)
+
+ def exists_nonce(self, nonce, request):
+ func = self._hooks["exists_nonce"]
+ if callable(func):
+ timestamp = request.timestamp
+ client_id = request.client_id
+ token = request.token
+ return func(nonce, timestamp, client_id, token)
+
+ raise RuntimeError('"exists_nonce" hook is required.')
+
+ def create_temporary_credential(self, request):
+ func = self._hooks["create_temporary_credential"]
+ if callable(func):
+ token = self.token_generator()
+ return func(token, request.client_id, request.redirect_uri)
+ raise RuntimeError('"create_temporary_credential" hook is required.')
+
+ def get_temporary_credential(self, request):
+ func = self._hooks["get_temporary_credential"]
+ if callable(func):
+ return func(request.token)
+
+ raise RuntimeError('"get_temporary_credential" hook is required.')
+
+ def delete_temporary_credential(self, request):
+ func = self._hooks["delete_temporary_credential"]
+ if callable(func):
+ return func(request.token)
+
+ raise RuntimeError('"delete_temporary_credential" hook is required.')
+
+ def create_authorization_verifier(self, request):
+ func = self._hooks["create_authorization_verifier"]
+ if callable(func):
+ verifier = generate_token(36)
+ func(request.credential, request.user, verifier)
+ return verifier
+
+ raise RuntimeError('"create_authorization_verifier" hook is required.')
+
+ def create_token_credential(self, request):
+ func = self._hooks["create_token_credential"]
+ if callable(func):
+ temporary_credential = request.credential
+ token = self.token_generator()
+ return func(token, temporary_credential)
+
+ raise RuntimeError('"create_token_credential" hook is required.')
+
+ def check_authorization_request(self):
+ req = self.create_oauth1_request(None)
+ self.validate_authorization_request(req)
+ return req
+
+ def create_authorization_response(self, request=None, grant_user=None):
+ return super().create_authorization_response(request, grant_user)
+
+ def create_token_response(self, request=None):
+ return super().create_token_response(request)
+
+ def create_oauth1_request(self, request):
+ if request is None:
+ request = flask_req
+ if request.method in ("POST", "PUT"):
+ body = request.form.to_dict(flat=True)
+ else:
+ body = None
+ return OAuth1Request(request.method, request.url, body, request.headers)
+
+ def handle_response(self, status_code, payload, headers):
+ return Response(url_encode(payload), status=status_code, headers=headers)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/cache.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/cache.py
new file mode 100644
index 00000000..63f2951f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/cache.py
@@ -0,0 +1,88 @@
+from authlib.oauth1 import TemporaryCredential
+
+
+def register_temporary_credential_hooks(
+ authorization_server, cache, key_prefix="temporary_credential:"
+):
+ """Register temporary credential related hooks to authorization server.
+
+ :param authorization_server: AuthorizationServer instance
+ :param cache: Cache instance
+ :param key_prefix: key prefix for temporary credential
+ """
+
+ def create_temporary_credential(token, client_id, redirect_uri):
+ key = key_prefix + token["oauth_token"]
+ token["client_id"] = client_id
+ if redirect_uri:
+ token["oauth_callback"] = redirect_uri
+
+ cache.set(key, token, timeout=86400) # cache for one day
+ return TemporaryCredential(token)
+
+ def get_temporary_credential(oauth_token):
+ if not oauth_token:
+ return None
+ key = key_prefix + oauth_token
+ value = cache.get(key)
+ if value:
+ return TemporaryCredential(value)
+
+ def delete_temporary_credential(oauth_token):
+ if oauth_token:
+ key = key_prefix + oauth_token
+ cache.delete(key)
+
+ def create_authorization_verifier(credential, grant_user, verifier):
+ key = key_prefix + credential.get_oauth_token()
+ credential["oauth_verifier"] = verifier
+ credential["user_id"] = grant_user.get_user_id()
+ cache.set(key, credential, timeout=86400)
+ return credential
+
+ authorization_server.register_hook(
+ "create_temporary_credential", create_temporary_credential
+ )
+ authorization_server.register_hook(
+ "get_temporary_credential", get_temporary_credential
+ )
+ authorization_server.register_hook(
+ "delete_temporary_credential", delete_temporary_credential
+ )
+ authorization_server.register_hook(
+ "create_authorization_verifier", create_authorization_verifier
+ )
+
+
+def create_exists_nonce_func(cache, key_prefix="nonce:", expires=86400):
+ """Create an ``exists_nonce`` function that can be used in hooks and
+ resource protector.
+
+ :param cache: Cache instance
+ :param key_prefix: key prefix for temporary credential
+ :param expires: Expire time for nonce
+ """
+
+ def exists_nonce(nonce, timestamp, client_id, oauth_token):
+ key = f"{key_prefix}{nonce}-{timestamp}-{client_id}"
+ if oauth_token:
+ key = f"{key}-{oauth_token}"
+ rv = cache.has(key)
+ cache.set(key, 1, timeout=expires)
+ return rv
+
+ return exists_nonce
+
+
+def register_nonce_hooks(
+ authorization_server, cache, key_prefix="nonce:", expires=86400
+):
+ """Register nonce related hooks to authorization server.
+
+ :param authorization_server: AuthorizationServer instance
+ :param cache: Cache instance
+ :param key_prefix: key prefix for temporary credential
+ :param expires: Expire time for nonce
+ """
+ exists_nonce = create_exists_nonce_func(cache, key_prefix, expires)
+ authorization_server.register_hook("exists_nonce", exists_nonce)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/resource_protector.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/resource_protector.py
new file mode 100644
index 00000000..c1cc9e4f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth1/resource_protector.py
@@ -0,0 +1,121 @@
+import functools
+
+from flask import Response
+from flask import g
+from flask import json
+from flask import request as _req
+from werkzeug.local import LocalProxy
+
+from authlib.consts import default_json_headers
+from authlib.oauth1 import ResourceProtector as _ResourceProtector
+from authlib.oauth1.errors import OAuth1Error
+
+
+class ResourceProtector(_ResourceProtector):
+ """A protecting method for resource servers. Initialize a resource
+ protector with the these method:
+
+ 1. query_client
+ 2. query_token,
+ 3. exists_nonce
+
+ Usually, a ``query_client`` method would look like (if using SQLAlchemy)::
+
+ def query_client(client_id):
+ return Client.query.filter_by(client_id=client_id).first()
+
+ A ``query_token`` method accept two parameters, ``client_id`` and ``oauth_token``::
+
+ def query_token(client_id, oauth_token):
+ return Token.query.filter_by(
+ client_id=client_id, oauth_token=oauth_token
+ ).first()
+
+ And for ``exists_nonce``, if using cache, we have a built-in hook to create this method::
+
+ from authlib.integrations.flask_oauth1 import create_exists_nonce_func
+
+ exists_nonce = create_exists_nonce_func(cache)
+
+ Then initialize the resource protector with those methods::
+
+ require_oauth = ResourceProtector(
+ app,
+ query_client=query_client,
+ query_token=query_token,
+ exists_nonce=exists_nonce,
+ )
+ """
+
+ def __init__(
+ self, app=None, query_client=None, query_token=None, exists_nonce=None
+ ):
+ self.query_client = query_client
+ self.query_token = query_token
+ self._exists_nonce = exists_nonce
+
+ self.app = app
+ if app:
+ self.init_app(app)
+
+ def init_app(self, app, query_client=None, query_token=None, exists_nonce=None):
+ if query_client is not None:
+ self.query_client = query_client
+ if query_token is not None:
+ self.query_token = query_token
+ if exists_nonce is not None:
+ self._exists_nonce = exists_nonce
+
+ methods = app.config.get("OAUTH1_SUPPORTED_SIGNATURE_METHODS")
+ if methods and isinstance(methods, (list, tuple)):
+ self.SUPPORTED_SIGNATURE_METHODS = methods
+
+ self.app = app
+
+ def get_client_by_id(self, client_id):
+ return self.query_client(client_id)
+
+ def get_token_credential(self, request):
+ return self.query_token(request.client_id, request.token)
+
+ def exists_nonce(self, nonce, request):
+ if not self._exists_nonce:
+ raise RuntimeError('"exists_nonce" function is required.')
+
+ timestamp = request.timestamp
+ client_id = request.client_id
+ token = request.token
+ return self._exists_nonce(nonce, timestamp, client_id, token)
+
+ def acquire_credential(self):
+ req = self.validate_request(
+ _req.method, _req.url, _req.form.to_dict(flat=True), _req.headers
+ )
+ g.authlib_server_oauth1_credential = req.credential
+ return req.credential
+
+ def __call__(self, scope=None):
+ def wrapper(f):
+ @functools.wraps(f)
+ def decorated(*args, **kwargs):
+ try:
+ self.acquire_credential()
+ except OAuth1Error as error:
+ body = dict(error.get_body())
+ return Response(
+ json.dumps(body),
+ status=error.status_code,
+ headers=default_json_headers,
+ )
+ return f(*args, **kwargs)
+
+ return decorated
+
+ return wrapper
+
+
+def _get_current_credential():
+ return g.get("authlib_server_oauth1_credential")
+
+
+current_credential = LocalProxy(_get_current_credential)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__init__.py
new file mode 100644
index 00000000..0ae82657
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__init__.py
@@ -0,0 +1,8 @@
+# flake8: noqa
+
+from .authorization_server import AuthorizationServer
+from .resource_protector import ResourceProtector
+from .resource_protector import current_token
+from .signals import client_authenticated
+from .signals import token_authenticated
+from .signals import token_revoked
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..fc923f39
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/authorization_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/authorization_server.cpython-312.pyc
new file mode 100644
index 00000000..b35431f5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/authorization_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..b6505a65
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/requests.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/requests.cpython-312.pyc
new file mode 100644
index 00000000..6c0f06ae
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/requests.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/resource_protector.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/resource_protector.cpython-312.pyc
new file mode 100644
index 00000000..944c1513
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/resource_protector.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/signals.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/signals.cpython-312.pyc
new file mode 100644
index 00000000..10433f43
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/__pycache__/signals.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/authorization_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/authorization_server.py
new file mode 100644
index 00000000..8944c318
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/authorization_server.py
@@ -0,0 +1,165 @@
+from flask import Response
+from flask import json
+from flask import request as flask_req
+from werkzeug.utils import import_string
+
+from authlib.common.security import generate_token
+from authlib.oauth2 import AuthorizationServer as _AuthorizationServer
+from authlib.oauth2.rfc6750 import BearerTokenGenerator
+
+from .requests import FlaskJsonRequest
+from .requests import FlaskOAuth2Request
+from .signals import client_authenticated
+from .signals import token_revoked
+
+
+class AuthorizationServer(_AuthorizationServer):
+ """Flask implementation of :class:`authlib.oauth2.rfc6749.AuthorizationServer`.
+ Initialize it with ``query_client``, ``save_token`` methods and Flask
+ app instance::
+
+ def query_client(client_id):
+ return Client.query.filter_by(client_id=client_id).first()
+
+
+ def save_token(token, request):
+ if request.user:
+ user_id = request.user.id
+ else:
+ user_id = None
+ client = request.client
+ tok = Token(client_id=client.client_id, user_id=user.id, **token)
+ db.session.add(tok)
+ db.session.commit()
+
+
+ server = AuthorizationServer(app, query_client, save_token)
+ # or initialize lazily
+ server = AuthorizationServer()
+ server.init_app(app, query_client, save_token)
+ """
+
+ def __init__(self, app=None, query_client=None, save_token=None):
+ super().__init__()
+ self._query_client = query_client
+ self._save_token = save_token
+ self._error_uris = None
+ if app is not None:
+ self.init_app(app)
+
+ def init_app(self, app, query_client=None, save_token=None):
+ """Initialize later with Flask app instance."""
+ if query_client is not None:
+ self._query_client = query_client
+ if save_token is not None:
+ self._save_token = save_token
+ self.load_config(app.config)
+
+ def load_config(self, config):
+ self.register_token_generator(
+ "default", self.create_bearer_token_generator(config)
+ )
+ self.scopes_supported = config.get("OAUTH2_SCOPES_SUPPORTED")
+ self._error_uris = config.get("OAUTH2_ERROR_URIS")
+
+ def query_client(self, client_id):
+ return self._query_client(client_id)
+
+ def save_token(self, token, request):
+ return self._save_token(token, request)
+
+ def get_error_uri(self, request, error):
+ if self._error_uris:
+ uris = dict(self._error_uris)
+ return uris.get(error.error)
+
+ def create_oauth2_request(self, request):
+ return FlaskOAuth2Request(flask_req)
+
+ def create_json_request(self, request):
+ return FlaskJsonRequest(flask_req)
+
+ def handle_response(self, status_code, payload, headers):
+ if isinstance(payload, dict):
+ payload = json.dumps(payload)
+ return Response(payload, status=status_code, headers=headers)
+
+ def send_signal(self, name, *args, **kwargs):
+ if name == "after_authenticate_client":
+ client_authenticated.send(self, *args, **kwargs)
+ elif name == "after_revoke_token":
+ token_revoked.send(self, *args, **kwargs)
+
+ def create_bearer_token_generator(self, config):
+ """Create a generator function for generating ``token`` value. This
+ method will create a Bearer Token generator with
+ :class:`authlib.oauth2.rfc6750.BearerToken`.
+
+ Configurable settings:
+
+ 1. OAUTH2_ACCESS_TOKEN_GENERATOR: Boolean or import string, default is True.
+ 2. OAUTH2_REFRESH_TOKEN_GENERATOR: Boolean or import string, default is False.
+ 3. OAUTH2_TOKEN_EXPIRES_IN: Dict or import string, default is None.
+
+ By default, it will not generate ``refresh_token``, which can be turn on by
+ configure ``OAUTH2_REFRESH_TOKEN_GENERATOR``.
+
+ Here are some examples of the token generator::
+
+ OAUTH2_ACCESS_TOKEN_GENERATOR = "your_project.generators.gen_token"
+
+ # and in module `your_project.generators`, you can define:
+
+
+ def gen_token(client, grant_type, user, scope):
+ # generate token according to these parameters
+ token = create_random_token()
+ return f"{client.id}-{user.id}-{token}"
+
+ Here is an example of ``OAUTH2_TOKEN_EXPIRES_IN``::
+
+ OAUTH2_TOKEN_EXPIRES_IN = {
+ "authorization_code": 864000,
+ "urn:ietf:params:oauth:grant-type:jwt-bearer": 3600,
+ }
+ """
+ conf = config.get("OAUTH2_ACCESS_TOKEN_GENERATOR", True)
+ access_token_generator = create_token_generator(conf, 42)
+
+ conf = config.get("OAUTH2_REFRESH_TOKEN_GENERATOR", False)
+ refresh_token_generator = create_token_generator(conf, 48)
+
+ expires_conf = config.get("OAUTH2_TOKEN_EXPIRES_IN")
+ expires_generator = create_token_expires_in_generator(expires_conf)
+ return BearerTokenGenerator(
+ access_token_generator, refresh_token_generator, expires_generator
+ )
+
+
+def create_token_expires_in_generator(expires_in_conf=None):
+ if isinstance(expires_in_conf, str):
+ return import_string(expires_in_conf)
+
+ data = {}
+ data.update(BearerTokenGenerator.GRANT_TYPES_EXPIRES_IN)
+ if isinstance(expires_in_conf, dict):
+ data.update(expires_in_conf)
+
+ def expires_in(client, grant_type):
+ return data.get(grant_type, BearerTokenGenerator.DEFAULT_EXPIRES_IN)
+
+ return expires_in
+
+
+def create_token_generator(token_generator_conf, length=42):
+ if callable(token_generator_conf):
+ return token_generator_conf
+
+ if isinstance(token_generator_conf, str):
+ return import_string(token_generator_conf)
+ elif token_generator_conf is True:
+
+ def token_generator(*args, **kwargs):
+ return generate_token(length)
+
+ return token_generator
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/errors.py
new file mode 100644
index 00000000..5f499d11
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/errors.py
@@ -0,0 +1,40 @@
+import importlib.metadata
+
+from werkzeug.exceptions import HTTPException
+
+_version = importlib.metadata.version("werkzeug").split(".")[0]
+
+if _version in ("0", "1"):
+
+ class _HTTPException(HTTPException):
+ def __init__(self, code, body, headers, response=None):
+ super().__init__(None, response)
+ self.code = code
+
+ self.body = body
+ self.headers = headers
+
+ def get_body(self, environ=None):
+ return self.body
+
+ def get_headers(self, environ=None):
+ return self.headers
+else:
+
+ class _HTTPException(HTTPException):
+ def __init__(self, code, body, headers, response=None):
+ super().__init__(None, response)
+ self.code = code
+
+ self.body = body
+ self.headers = headers
+
+ def get_body(self, environ=None, scope=None):
+ return self.body
+
+ def get_headers(self, environ=None, scope=None):
+ return self.headers
+
+
+def raise_http_exception(status, body, headers):
+ raise _HTTPException(status, body, headers)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/requests.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/requests.py
new file mode 100644
index 00000000..c09b4113
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/requests.py
@@ -0,0 +1,57 @@
+from collections import defaultdict
+from functools import cached_property
+
+from flask.wrappers import Request
+
+from authlib.oauth2.rfc6749 import JsonPayload
+from authlib.oauth2.rfc6749 import JsonRequest
+from authlib.oauth2.rfc6749 import OAuth2Payload
+from authlib.oauth2.rfc6749 import OAuth2Request
+
+
+class FlaskOAuth2Payload(OAuth2Payload):
+ def __init__(self, request: Request):
+ self._request = request
+
+ @property
+ def data(self):
+ return self._request.values
+
+ @cached_property
+ def datalist(self):
+ values = defaultdict(list)
+ for k in self.data:
+ values[k].extend(self.data.getlist(k))
+ return values
+
+
+class FlaskOAuth2Request(OAuth2Request):
+ def __init__(self, request: Request):
+ super().__init__(
+ method=request.method, uri=request.url, headers=request.headers
+ )
+ self._request = request
+ self.payload = FlaskOAuth2Payload(request)
+
+ @property
+ def args(self):
+ return self._request.args
+
+ @property
+ def form(self):
+ return self._request.form
+
+
+class FlaskJsonPayload(JsonPayload):
+ def __init__(self, request: Request):
+ self._request = request
+
+ @property
+ def data(self):
+ return self._request.get_json()
+
+
+class FlaskJsonRequest(JsonRequest):
+ def __init__(self, request: Request):
+ super().__init__(request.method, request.url, request.headers)
+ self.payload = FlaskJsonPayload(request)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/resource_protector.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/resource_protector.py
new file mode 100644
index 00000000..059fbbd1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/resource_protector.py
@@ -0,0 +1,121 @@
+import functools
+from contextlib import contextmanager
+
+from flask import g
+from flask import json
+from flask import request as _req
+from werkzeug.local import LocalProxy
+
+from authlib.oauth2 import OAuth2Error
+from authlib.oauth2 import ResourceProtector as _ResourceProtector
+from authlib.oauth2.rfc6749 import MissingAuthorizationError
+
+from .errors import raise_http_exception
+from .requests import FlaskJsonRequest
+from .signals import token_authenticated
+
+
+class ResourceProtector(_ResourceProtector):
+ """A protecting method for resource servers. Creating a ``require_oauth``
+ decorator easily with ResourceProtector::
+
+ from authlib.integrations.flask_oauth2 import ResourceProtector
+
+ require_oauth = ResourceProtector()
+
+ # add bearer token validator
+ from authlib.oauth2.rfc6750 import BearerTokenValidator
+ from project.models import Token
+
+
+ class MyBearerTokenValidator(BearerTokenValidator):
+ def authenticate_token(self, token_string):
+ return Token.query.filter_by(access_token=token_string).first()
+
+
+ require_oauth.register_token_validator(MyBearerTokenValidator())
+
+ # protect resource with require_oauth
+
+
+ @app.route("/user")
+ @require_oauth(["profile"])
+ def user_profile():
+ user = User.get(current_token.user_id)
+ return jsonify(user.to_dict())
+
+ """
+
+ def raise_error_response(self, error):
+ """Raise HTTPException for OAuth2Error. Developers can re-implement
+ this method to customize the error response.
+
+ :param error: OAuth2Error
+ :raise: HTTPException
+ """
+ status = error.status_code
+ body = json.dumps(dict(error.get_body()))
+ headers = error.get_headers()
+ raise_http_exception(status, body, headers)
+
+ def acquire_token(self, scopes=None, **kwargs):
+ """A method to acquire current valid token with the given scope.
+
+ :param scopes: a list of scope values
+ :return: token object
+ """
+ request = FlaskJsonRequest(_req)
+ # backward compatibility
+ kwargs["scopes"] = scopes
+ for claim in kwargs:
+ if isinstance(kwargs[claim], str):
+ kwargs[claim] = [kwargs[claim]]
+ token = self.validate_request(request=request, **kwargs)
+ token_authenticated.send(self, token=token)
+ g.authlib_server_oauth2_token = token
+ return token
+
+ @contextmanager
+ def acquire(self, scopes=None):
+ """The with statement of ``require_oauth``. Instead of using a
+ decorator, you can use a with statement instead::
+
+ @app.route("/api/user")
+ def user_api():
+ with require_oauth.acquire("profile") as token:
+ user = User.get(token.user_id)
+ return jsonify(user.to_dict())
+ """
+ try:
+ yield self.acquire_token(scopes)
+ except OAuth2Error as error:
+ self.raise_error_response(error)
+
+ def __call__(self, scopes=None, optional=False, **kwargs):
+ claims = kwargs
+ # backward compatibility
+ claims["scopes"] = scopes
+
+ def wrapper(f):
+ @functools.wraps(f)
+ def decorated(*args, **kwargs):
+ try:
+ self.acquire_token(**claims)
+ except MissingAuthorizationError as error:
+ if optional:
+ return f(*args, **kwargs)
+ self.raise_error_response(error)
+ except OAuth2Error as error:
+ self.raise_error_response(error)
+ return f(*args, **kwargs)
+
+ return decorated
+
+ return wrapper
+
+
+def _get_current_token():
+ return g.get("authlib_server_oauth2_token")
+
+
+current_token = LocalProxy(_get_current_token)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/signals.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/signals.py
new file mode 100644
index 00000000..f29ba115
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/flask_oauth2/signals.py
@@ -0,0 +1,12 @@
+from flask.signals import Namespace
+
+_signal = Namespace()
+
+#: signal when client is authenticated
+client_authenticated = _signal.signal("client_authenticated")
+
+#: signal when token is revoked
+token_revoked = _signal.signal("token_revoked")
+
+#: signal when token is authenticated
+token_authenticated = _signal.signal("token_authenticated")
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__init__.py
new file mode 100644
index 00000000..00649412
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__init__.py
@@ -0,0 +1,36 @@
+from authlib.oauth1 import SIGNATURE_HMAC_SHA1
+from authlib.oauth1 import SIGNATURE_PLAINTEXT
+from authlib.oauth1 import SIGNATURE_RSA_SHA1
+from authlib.oauth1 import SIGNATURE_TYPE_BODY
+from authlib.oauth1 import SIGNATURE_TYPE_HEADER
+from authlib.oauth1 import SIGNATURE_TYPE_QUERY
+
+from ..base_client import OAuthError
+from .assertion_client import AssertionClient
+from .assertion_client import AsyncAssertionClient
+from .oauth1_client import AsyncOAuth1Client
+from .oauth1_client import OAuth1Auth
+from .oauth1_client import OAuth1Client
+from .oauth2_client import AsyncOAuth2Client
+from .oauth2_client import OAuth2Auth
+from .oauth2_client import OAuth2Client
+from .oauth2_client import OAuth2ClientAuth
+
+__all__ = [
+ "OAuthError",
+ "OAuth1Auth",
+ "AsyncOAuth1Client",
+ "OAuth1Client",
+ "SIGNATURE_HMAC_SHA1",
+ "SIGNATURE_RSA_SHA1",
+ "SIGNATURE_PLAINTEXT",
+ "SIGNATURE_TYPE_HEADER",
+ "SIGNATURE_TYPE_QUERY",
+ "SIGNATURE_TYPE_BODY",
+ "OAuth2Auth",
+ "OAuth2ClientAuth",
+ "OAuth2Client",
+ "AsyncOAuth2Client",
+ "AssertionClient",
+ "AsyncAssertionClient",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..b7a6fc59
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/assertion_client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/assertion_client.cpython-312.pyc
new file mode 100644
index 00000000..4d502214
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/assertion_client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/oauth1_client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/oauth1_client.cpython-312.pyc
new file mode 100644
index 00000000..d4a5d0d2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/oauth1_client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/oauth2_client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/oauth2_client.cpython-312.pyc
new file mode 100644
index 00000000..fb661649
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/oauth2_client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/utils.cpython-312.pyc
new file mode 100644
index 00000000..413eef22
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/assertion_client.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/assertion_client.py
new file mode 100644
index 00000000..9d52dad8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/assertion_client.py
@@ -0,0 +1,124 @@
+import httpx
+from httpx import USE_CLIENT_DEFAULT
+from httpx import Response
+
+from authlib.oauth2.rfc7521 import AssertionClient as _AssertionClient
+from authlib.oauth2.rfc7523 import JWTBearerGrant
+
+from ..base_client import OAuthError
+from .oauth2_client import OAuth2Auth
+from .utils import extract_client_kwargs
+
+__all__ = ["AsyncAssertionClient"]
+
+
+class AsyncAssertionClient(_AssertionClient, httpx.AsyncClient):
+ token_auth_class = OAuth2Auth
+ oauth_error_class = OAuthError
+ JWT_BEARER_GRANT_TYPE = JWTBearerGrant.GRANT_TYPE
+ ASSERTION_METHODS = {
+ JWT_BEARER_GRANT_TYPE: JWTBearerGrant.sign,
+ }
+ DEFAULT_GRANT_TYPE = JWT_BEARER_GRANT_TYPE
+
+ def __init__(
+ self,
+ token_endpoint,
+ issuer,
+ subject,
+ audience=None,
+ grant_type=None,
+ claims=None,
+ token_placement="header",
+ scope=None,
+ **kwargs,
+ ):
+ client_kwargs = extract_client_kwargs(kwargs)
+ httpx.AsyncClient.__init__(self, **client_kwargs)
+
+ _AssertionClient.__init__(
+ self,
+ session=None,
+ token_endpoint=token_endpoint,
+ issuer=issuer,
+ subject=subject,
+ audience=audience,
+ grant_type=grant_type,
+ claims=claims,
+ token_placement=token_placement,
+ scope=scope,
+ **kwargs,
+ )
+
+ async def request(
+ self, method, url, withhold_token=False, auth=USE_CLIENT_DEFAULT, **kwargs
+ ) -> Response:
+ """Send request with auto refresh token feature."""
+ if not withhold_token and auth is USE_CLIENT_DEFAULT:
+ if not self.token or self.token.is_expired():
+ await self.refresh_token()
+
+ auth = self.token_auth
+ return await super().request(method, url, auth=auth, **kwargs)
+
+ async def _refresh_token(self, data):
+ resp = await self.request(
+ "POST", self.token_endpoint, data=data, withhold_token=True
+ )
+
+ return self.parse_response_token(resp)
+
+
+class AssertionClient(_AssertionClient, httpx.Client):
+ token_auth_class = OAuth2Auth
+ oauth_error_class = OAuthError
+ JWT_BEARER_GRANT_TYPE = JWTBearerGrant.GRANT_TYPE
+ ASSERTION_METHODS = {
+ JWT_BEARER_GRANT_TYPE: JWTBearerGrant.sign,
+ }
+ DEFAULT_GRANT_TYPE = JWT_BEARER_GRANT_TYPE
+
+ def __init__(
+ self,
+ token_endpoint,
+ issuer,
+ subject,
+ audience=None,
+ grant_type=None,
+ claims=None,
+ token_placement="header",
+ scope=None,
+ **kwargs,
+ ):
+ client_kwargs = extract_client_kwargs(kwargs)
+ # app keyword was dropped!
+ app_value = client_kwargs.pop("app", None)
+ if app_value is not None:
+ client_kwargs["transport"] = httpx.WSGITransport(app=app_value)
+
+ httpx.Client.__init__(self, **client_kwargs)
+
+ _AssertionClient.__init__(
+ self,
+ session=self,
+ token_endpoint=token_endpoint,
+ issuer=issuer,
+ subject=subject,
+ audience=audience,
+ grant_type=grant_type,
+ claims=claims,
+ token_placement=token_placement,
+ scope=scope,
+ **kwargs,
+ )
+
+ def request(
+ self, method, url, withhold_token=False, auth=USE_CLIENT_DEFAULT, **kwargs
+ ):
+ """Send request with auto refresh token feature."""
+ if not withhold_token and auth is USE_CLIENT_DEFAULT:
+ if not self.token or self.token.is_expired():
+ self.refresh_token()
+
+ auth = self.token_auth
+ return super().request(method, url, auth=auth, **kwargs)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/oauth1_client.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/oauth1_client.py
new file mode 100644
index 00000000..a4757070
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/oauth1_client.py
@@ -0,0 +1,145 @@
+import typing
+
+import httpx
+from httpx import Auth
+from httpx import Request
+from httpx import Response
+
+from authlib.common.encoding import to_unicode
+from authlib.oauth1 import SIGNATURE_HMAC_SHA1
+from authlib.oauth1 import SIGNATURE_TYPE_HEADER
+from authlib.oauth1 import ClientAuth
+from authlib.oauth1.client import OAuth1Client as _OAuth1Client
+
+from ..base_client import OAuthError
+from .utils import build_request
+from .utils import extract_client_kwargs
+
+
+class OAuth1Auth(Auth, ClientAuth):
+ """Signs the httpx request using OAuth 1 (RFC5849)."""
+
+ requires_request_body = True
+
+ def auth_flow(self, request: Request) -> typing.Generator[Request, Response, None]:
+ url, headers, body = self.prepare(
+ request.method, str(request.url), request.headers, request.content
+ )
+ headers["Content-Length"] = str(len(body))
+ yield build_request(
+ url=url, headers=headers, body=body, initial_request=request
+ )
+
+
+class AsyncOAuth1Client(_OAuth1Client, httpx.AsyncClient):
+ auth_class = OAuth1Auth
+
+ def __init__(
+ self,
+ client_id,
+ client_secret=None,
+ token=None,
+ token_secret=None,
+ redirect_uri=None,
+ rsa_key=None,
+ verifier=None,
+ signature_method=SIGNATURE_HMAC_SHA1,
+ signature_type=SIGNATURE_TYPE_HEADER,
+ force_include_body=False,
+ **kwargs,
+ ):
+ _client_kwargs = extract_client_kwargs(kwargs)
+ httpx.AsyncClient.__init__(self, **_client_kwargs)
+
+ _OAuth1Client.__init__(
+ self,
+ None,
+ client_id=client_id,
+ client_secret=client_secret,
+ token=token,
+ token_secret=token_secret,
+ redirect_uri=redirect_uri,
+ rsa_key=rsa_key,
+ verifier=verifier,
+ signature_method=signature_method,
+ signature_type=signature_type,
+ force_include_body=force_include_body,
+ **kwargs,
+ )
+
+ async def fetch_access_token(self, url, verifier=None, **kwargs):
+ """Method for fetching an access token from the token endpoint.
+
+ This is the final step in the OAuth 1 workflow. An access token is
+ obtained using all previously obtained credentials, including the
+ verifier from the authorization step.
+
+ :param url: Access Token endpoint.
+ :param verifier: A verifier string to prove authorization was granted.
+ :param kwargs: Extra parameters to include for fetching access token.
+ :return: A token dict.
+ """
+ if verifier:
+ self.auth.verifier = verifier
+ if not self.auth.verifier:
+ self.handle_error("missing_verifier", 'Missing "verifier" value')
+ token = await self._fetch_token(url, **kwargs)
+ self.auth.verifier = None
+ return token
+
+ async def _fetch_token(self, url, **kwargs):
+ resp = await self.post(url, **kwargs)
+ text = await resp.aread()
+ token = self.parse_response_token(resp.status_code, to_unicode(text))
+ self.token = token
+ return token
+
+ @staticmethod
+ def handle_error(error_type, error_description):
+ raise OAuthError(error_type, error_description)
+
+
+class OAuth1Client(_OAuth1Client, httpx.Client):
+ auth_class = OAuth1Auth
+
+ def __init__(
+ self,
+ client_id,
+ client_secret=None,
+ token=None,
+ token_secret=None,
+ redirect_uri=None,
+ rsa_key=None,
+ verifier=None,
+ signature_method=SIGNATURE_HMAC_SHA1,
+ signature_type=SIGNATURE_TYPE_HEADER,
+ force_include_body=False,
+ **kwargs,
+ ):
+ _client_kwargs = extract_client_kwargs(kwargs)
+ # app keyword was dropped!
+ app_value = _client_kwargs.pop("app", None)
+ if app_value is not None:
+ _client_kwargs["transport"] = httpx.WSGITransport(app=app_value)
+
+ httpx.Client.__init__(self, **_client_kwargs)
+
+ _OAuth1Client.__init__(
+ self,
+ self,
+ client_id=client_id,
+ client_secret=client_secret,
+ token=token,
+ token_secret=token_secret,
+ redirect_uri=redirect_uri,
+ rsa_key=rsa_key,
+ verifier=verifier,
+ signature_method=signature_method,
+ signature_type=signature_type,
+ force_include_body=force_include_body,
+ **kwargs,
+ )
+
+ @staticmethod
+ def handle_error(error_type, error_description):
+ raise OAuthError(error_type, error_description)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/oauth2_client.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/oauth2_client.py
new file mode 100644
index 00000000..a157b7eb
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/oauth2_client.py
@@ -0,0 +1,285 @@
+import typing
+from contextlib import asynccontextmanager
+
+import httpx
+from anyio import Lock # Import after httpx so import errors refer to httpx
+from httpx import USE_CLIENT_DEFAULT
+from httpx import Auth
+from httpx import Request
+from httpx import Response
+
+from authlib.common.urls import url_decode
+from authlib.oauth2.auth import ClientAuth
+from authlib.oauth2.auth import TokenAuth
+from authlib.oauth2.client import OAuth2Client as _OAuth2Client
+
+from ..base_client import InvalidTokenError
+from ..base_client import MissingTokenError
+from ..base_client import OAuthError
+from ..base_client import UnsupportedTokenTypeError
+from .utils import HTTPX_CLIENT_KWARGS
+from .utils import build_request
+
+__all__ = [
+ "OAuth2Auth",
+ "OAuth2ClientAuth",
+ "AsyncOAuth2Client",
+ "OAuth2Client",
+]
+
+
+class OAuth2Auth(Auth, TokenAuth):
+ """Sign requests for OAuth 2.0, currently only bearer token is supported."""
+
+ requires_request_body = True
+
+ def auth_flow(self, request: Request) -> typing.Generator[Request, Response, None]:
+ try:
+ url, headers, body = self.prepare(
+ str(request.url), request.headers, request.content
+ )
+ headers["Content-Length"] = str(len(body))
+ yield build_request(
+ url=url, headers=headers, body=body, initial_request=request
+ )
+ except KeyError as error:
+ description = f"Unsupported token_type: {str(error)}"
+ raise UnsupportedTokenTypeError(description=description) from error
+
+
+class OAuth2ClientAuth(Auth, ClientAuth):
+ requires_request_body = True
+
+ def auth_flow(self, request: Request) -> typing.Generator[Request, Response, None]:
+ url, headers, body = self.prepare(
+ request.method, str(request.url), request.headers, request.content
+ )
+ headers["Content-Length"] = str(len(body))
+ yield build_request(
+ url=url, headers=headers, body=body, initial_request=request
+ )
+
+
+class AsyncOAuth2Client(_OAuth2Client, httpx.AsyncClient):
+ SESSION_REQUEST_PARAMS = HTTPX_CLIENT_KWARGS
+
+ client_auth_class = OAuth2ClientAuth
+ token_auth_class = OAuth2Auth
+ oauth_error_class = OAuthError
+
+ def __init__(
+ self,
+ client_id=None,
+ client_secret=None,
+ token_endpoint_auth_method=None,
+ revocation_endpoint_auth_method=None,
+ scope=None,
+ redirect_uri=None,
+ token=None,
+ token_placement="header",
+ update_token=None,
+ leeway=60,
+ **kwargs,
+ ):
+ # extract httpx.Client kwargs
+ client_kwargs = self._extract_session_request_params(kwargs)
+ httpx.AsyncClient.__init__(self, **client_kwargs)
+
+ # We use a Lock to synchronize coroutines to prevent
+ # multiple concurrent attempts to refresh the same token
+ self._token_refresh_lock = Lock()
+
+ _OAuth2Client.__init__(
+ self,
+ session=None,
+ client_id=client_id,
+ client_secret=client_secret,
+ token_endpoint_auth_method=token_endpoint_auth_method,
+ revocation_endpoint_auth_method=revocation_endpoint_auth_method,
+ scope=scope,
+ redirect_uri=redirect_uri,
+ token=token,
+ token_placement=token_placement,
+ update_token=update_token,
+ leeway=leeway,
+ **kwargs,
+ )
+
+ async def request(
+ self, method, url, withhold_token=False, auth=USE_CLIENT_DEFAULT, **kwargs
+ ):
+ if not withhold_token and auth is USE_CLIENT_DEFAULT:
+ if not self.token:
+ raise MissingTokenError()
+
+ await self.ensure_active_token(self.token)
+
+ auth = self.token_auth
+
+ return await super().request(method, url, auth=auth, **kwargs)
+
+ @asynccontextmanager
+ async def stream(
+ self, method, url, withhold_token=False, auth=USE_CLIENT_DEFAULT, **kwargs
+ ):
+ if not withhold_token and auth is USE_CLIENT_DEFAULT:
+ if not self.token:
+ raise MissingTokenError()
+
+ await self.ensure_active_token(self.token)
+
+ auth = self.token_auth
+
+ async with super().stream(method, url, auth=auth, **kwargs) as resp:
+ yield resp
+
+ async def ensure_active_token(self, token):
+ async with self._token_refresh_lock:
+ if self.token.is_expired(leeway=self.leeway):
+ refresh_token = token.get("refresh_token")
+ url = self.metadata.get("token_endpoint")
+ if refresh_token and url:
+ await self.refresh_token(url, refresh_token=refresh_token)
+ elif self.metadata.get("grant_type") == "client_credentials":
+ access_token = token["access_token"]
+ new_token = await self.fetch_token(
+ url, grant_type="client_credentials"
+ )
+ if self.update_token:
+ await self.update_token(new_token, access_token=access_token)
+ else:
+ raise InvalidTokenError()
+
+ async def _fetch_token(
+ self,
+ url,
+ body="",
+ headers=None,
+ auth=USE_CLIENT_DEFAULT,
+ method="POST",
+ **kwargs,
+ ):
+ if method.upper() == "POST":
+ resp = await self.post(
+ url, data=dict(url_decode(body)), headers=headers, auth=auth, **kwargs
+ )
+ else:
+ if "?" in url:
+ url = "&".join([url, body])
+ else:
+ url = "?".join([url, body])
+ resp = await self.get(url, headers=headers, auth=auth, **kwargs)
+
+ for hook in self.compliance_hook["access_token_response"]:
+ resp = hook(resp)
+
+ return self.parse_response_token(resp)
+
+ async def _refresh_token(
+ self,
+ url,
+ refresh_token=None,
+ body="",
+ headers=None,
+ auth=USE_CLIENT_DEFAULT,
+ **kwargs,
+ ):
+ resp = await self.post(
+ url, data=dict(url_decode(body)), headers=headers, auth=auth, **kwargs
+ )
+
+ for hook in self.compliance_hook["refresh_token_response"]:
+ resp = hook(resp)
+
+ token = self.parse_response_token(resp)
+ if "refresh_token" not in token:
+ self.token["refresh_token"] = refresh_token
+
+ if self.update_token:
+ await self.update_token(self.token, refresh_token=refresh_token)
+
+ return self.token
+
+ def _http_post(
+ self, url, body=None, auth=USE_CLIENT_DEFAULT, headers=None, **kwargs
+ ):
+ return self.post(
+ url, data=dict(url_decode(body)), headers=headers, auth=auth, **kwargs
+ )
+
+
+class OAuth2Client(_OAuth2Client, httpx.Client):
+ SESSION_REQUEST_PARAMS = HTTPX_CLIENT_KWARGS
+
+ client_auth_class = OAuth2ClientAuth
+ token_auth_class = OAuth2Auth
+ oauth_error_class = OAuthError
+
+ def __init__(
+ self,
+ client_id=None,
+ client_secret=None,
+ token_endpoint_auth_method=None,
+ revocation_endpoint_auth_method=None,
+ scope=None,
+ redirect_uri=None,
+ token=None,
+ token_placement="header",
+ update_token=None,
+ **kwargs,
+ ):
+ # extract httpx.Client kwargs
+ client_kwargs = self._extract_session_request_params(kwargs)
+ # app keyword was dropped!
+ app_value = client_kwargs.pop("app", None)
+ if app_value is not None:
+ client_kwargs["transport"] = httpx.WSGITransport(app=app_value)
+
+ httpx.Client.__init__(self, **client_kwargs)
+
+ _OAuth2Client.__init__(
+ self,
+ session=self,
+ client_id=client_id,
+ client_secret=client_secret,
+ token_endpoint_auth_method=token_endpoint_auth_method,
+ revocation_endpoint_auth_method=revocation_endpoint_auth_method,
+ scope=scope,
+ redirect_uri=redirect_uri,
+ token=token,
+ token_placement=token_placement,
+ update_token=update_token,
+ **kwargs,
+ )
+
+ @staticmethod
+ def handle_error(error_type, error_description):
+ raise OAuthError(error_type, error_description)
+
+ def request(
+ self, method, url, withhold_token=False, auth=USE_CLIENT_DEFAULT, **kwargs
+ ):
+ if not withhold_token and auth is USE_CLIENT_DEFAULT:
+ if not self.token:
+ raise MissingTokenError()
+
+ if not self.ensure_active_token(self.token):
+ raise InvalidTokenError()
+
+ auth = self.token_auth
+
+ return super().request(method, url, auth=auth, **kwargs)
+
+ def stream(
+ self, method, url, withhold_token=False, auth=USE_CLIENT_DEFAULT, **kwargs
+ ):
+ if not withhold_token and auth is USE_CLIENT_DEFAULT:
+ if not self.token:
+ raise MissingTokenError()
+
+ if not self.ensure_active_token(self.token):
+ raise InvalidTokenError()
+
+ auth = self.token_auth
+
+ return super().stream(method, url, auth=auth, **kwargs)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/utils.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/utils.py
new file mode 100644
index 00000000..33c3a2fe
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/httpx_client/utils.py
@@ -0,0 +1,41 @@
+from httpx import Request
+
+HTTPX_CLIENT_KWARGS = [
+ "headers",
+ "cookies",
+ "verify",
+ "cert",
+ "http1",
+ "http2",
+ "proxy",
+ "mounts",
+ "timeout",
+ "follow_redirects",
+ "limits",
+ "max_redirects",
+ "event_hooks",
+ "base_url",
+ "transport",
+ "trust_env",
+ "default_encoding",
+]
+
+
+def extract_client_kwargs(kwargs):
+ client_kwargs = {}
+ for k in HTTPX_CLIENT_KWARGS:
+ if k in kwargs:
+ client_kwargs[k] = kwargs.pop(k)
+ return client_kwargs
+
+
+def build_request(url, headers, body, initial_request: Request) -> Request:
+ """Make sure that all the data from initial request is passed to the updated object."""
+ updated_request = Request(
+ method=initial_request.method, url=url, headers=headers, content=body
+ )
+
+ if hasattr(initial_request, "extensions"):
+ updated_request.extensions = initial_request.extensions
+
+ return updated_request
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__init__.py
new file mode 100644
index 00000000..c9c01df3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__init__.py
@@ -0,0 +1,28 @@
+from authlib.oauth1 import SIGNATURE_HMAC_SHA1
+from authlib.oauth1 import SIGNATURE_PLAINTEXT
+from authlib.oauth1 import SIGNATURE_RSA_SHA1
+from authlib.oauth1 import SIGNATURE_TYPE_BODY
+from authlib.oauth1 import SIGNATURE_TYPE_HEADER
+from authlib.oauth1 import SIGNATURE_TYPE_QUERY
+
+from ..base_client import OAuthError
+from .assertion_session import AssertionSession
+from .oauth1_session import OAuth1Auth
+from .oauth1_session import OAuth1Session
+from .oauth2_session import OAuth2Auth
+from .oauth2_session import OAuth2Session
+
+__all__ = [
+ "OAuthError",
+ "OAuth1Session",
+ "OAuth1Auth",
+ "SIGNATURE_HMAC_SHA1",
+ "SIGNATURE_RSA_SHA1",
+ "SIGNATURE_PLAINTEXT",
+ "SIGNATURE_TYPE_HEADER",
+ "SIGNATURE_TYPE_QUERY",
+ "SIGNATURE_TYPE_BODY",
+ "OAuth2Session",
+ "OAuth2Auth",
+ "AssertionSession",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..19d45e6b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/assertion_session.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/assertion_session.cpython-312.pyc
new file mode 100644
index 00000000..197ab060
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/assertion_session.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/oauth1_session.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/oauth1_session.cpython-312.pyc
new file mode 100644
index 00000000..1accdf3c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/oauth1_session.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/oauth2_session.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/oauth2_session.cpython-312.pyc
new file mode 100644
index 00000000..6fa7cba1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/oauth2_session.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/utils.cpython-312.pyc
new file mode 100644
index 00000000..866c8a8c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/assertion_session.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/assertion_session.py
new file mode 100644
index 00000000..ee046077
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/assertion_session.py
@@ -0,0 +1,70 @@
+from requests import Session
+
+from authlib.oauth2.rfc7521 import AssertionClient
+from authlib.oauth2.rfc7523 import JWTBearerGrant
+
+from .oauth2_session import OAuth2Auth
+from .utils import update_session_configure
+
+
+class AssertionAuth(OAuth2Auth):
+ def ensure_active_token(self):
+ if self.client and (
+ not self.token or self.token.is_expired(self.client.leeway)
+ ):
+ return self.client.refresh_token()
+
+
+class AssertionSession(AssertionClient, Session):
+ """Constructs a new Assertion Framework for OAuth 2.0 Authorization Grants
+ per RFC7521_.
+
+ .. _RFC7521: https://tools.ietf.org/html/rfc7521
+ """
+
+ token_auth_class = AssertionAuth
+ JWT_BEARER_GRANT_TYPE = JWTBearerGrant.GRANT_TYPE
+ ASSERTION_METHODS = {
+ JWT_BEARER_GRANT_TYPE: JWTBearerGrant.sign,
+ }
+ DEFAULT_GRANT_TYPE = JWT_BEARER_GRANT_TYPE
+
+ def __init__(
+ self,
+ token_endpoint,
+ issuer,
+ subject,
+ audience=None,
+ grant_type=None,
+ claims=None,
+ token_placement="header",
+ scope=None,
+ default_timeout=None,
+ leeway=60,
+ **kwargs,
+ ):
+ Session.__init__(self)
+ self.default_timeout = default_timeout
+ update_session_configure(self, kwargs)
+ AssertionClient.__init__(
+ self,
+ session=self,
+ token_endpoint=token_endpoint,
+ issuer=issuer,
+ subject=subject,
+ audience=audience,
+ grant_type=grant_type,
+ claims=claims,
+ token_placement=token_placement,
+ scope=scope,
+ leeway=leeway,
+ **kwargs,
+ )
+
+ def request(self, method, url, withhold_token=False, auth=None, **kwargs):
+ """Send request with auto refresh token feature."""
+ if self.default_timeout:
+ kwargs.setdefault("timeout", self.default_timeout)
+ if not withhold_token and auth is None:
+ auth = self.token_auth
+ return super().request(method, url, auth=auth, **kwargs)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/oauth1_session.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/oauth1_session.py
new file mode 100644
index 00000000..d9f5d345
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/oauth1_session.py
@@ -0,0 +1,74 @@
+from requests import Session
+from requests.auth import AuthBase
+
+from authlib.common.encoding import to_native
+from authlib.oauth1 import SIGNATURE_HMAC_SHA1
+from authlib.oauth1 import SIGNATURE_TYPE_HEADER
+from authlib.oauth1 import ClientAuth
+from authlib.oauth1.client import OAuth1Client
+
+from ..base_client import OAuthError
+from .utils import update_session_configure
+
+
+class OAuth1Auth(AuthBase, ClientAuth):
+ """Signs the request using OAuth 1 (RFC5849)."""
+
+ def __call__(self, req):
+ url, headers, body = self.prepare(req.method, req.url, req.headers, req.body)
+
+ req.url = to_native(url)
+ req.prepare_headers(headers)
+ if body:
+ req.body = body
+ return req
+
+
+class OAuth1Session(OAuth1Client, Session):
+ auth_class = OAuth1Auth
+
+ def __init__(
+ self,
+ client_id,
+ client_secret=None,
+ token=None,
+ token_secret=None,
+ redirect_uri=None,
+ rsa_key=None,
+ verifier=None,
+ signature_method=SIGNATURE_HMAC_SHA1,
+ signature_type=SIGNATURE_TYPE_HEADER,
+ force_include_body=False,
+ **kwargs,
+ ):
+ Session.__init__(self)
+ update_session_configure(self, kwargs)
+ OAuth1Client.__init__(
+ self,
+ session=self,
+ client_id=client_id,
+ client_secret=client_secret,
+ token=token,
+ token_secret=token_secret,
+ redirect_uri=redirect_uri,
+ rsa_key=rsa_key,
+ verifier=verifier,
+ signature_method=signature_method,
+ signature_type=signature_type,
+ force_include_body=force_include_body,
+ **kwargs,
+ )
+
+ def rebuild_auth(self, prepared_request, response):
+ """When being redirected we should always strip Authorization
+ header, since nonce may not be reused as per OAuth spec.
+ """
+ if "Authorization" in prepared_request.headers:
+ # If we get redirected to a new host, we should strip out
+ # any authentication headers.
+ prepared_request.headers.pop("Authorization", True)
+ prepared_request.prepare_auth(self.auth)
+
+ @staticmethod
+ def handle_error(error_type, error_description):
+ raise OAuthError(error_type, error_description)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/oauth2_session.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/oauth2_session.py
new file mode 100644
index 00000000..2bacb18d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/oauth2_session.py
@@ -0,0 +1,140 @@
+from requests import Session
+from requests.auth import AuthBase
+
+from authlib.oauth2.auth import ClientAuth
+from authlib.oauth2.auth import TokenAuth
+from authlib.oauth2.client import OAuth2Client
+
+from ..base_client import InvalidTokenError
+from ..base_client import MissingTokenError
+from ..base_client import OAuthError
+from ..base_client import UnsupportedTokenTypeError
+from .utils import update_session_configure
+
+__all__ = ["OAuth2Session", "OAuth2Auth"]
+
+
+class OAuth2Auth(AuthBase, TokenAuth):
+ """Sign requests for OAuth 2.0, currently only bearer token is supported."""
+
+ def ensure_active_token(self):
+ if self.client and not self.client.ensure_active_token(self.token):
+ raise InvalidTokenError()
+
+ def __call__(self, req):
+ self.ensure_active_token()
+ try:
+ req.url, req.headers, req.body = self.prepare(
+ req.url, req.headers, req.body
+ )
+ except KeyError as error:
+ description = f"Unsupported token_type: {str(error)}"
+ raise UnsupportedTokenTypeError(description=description) from error
+ return req
+
+
+class OAuth2ClientAuth(AuthBase, ClientAuth):
+ """Attaches OAuth Client Authentication to the given Request object."""
+
+ def __call__(self, req):
+ req.url, req.headers, req.body = self.prepare(
+ req.method, req.url, req.headers, req.body
+ )
+ return req
+
+
+class OAuth2Session(OAuth2Client, Session):
+ """Construct a new OAuth 2 client requests session.
+
+ :param client_id: Client ID, which you get from client registration.
+ :param client_secret: Client Secret, which you get from registration.
+ :param authorization_endpoint: URL of the authorization server's
+ authorization endpoint.
+ :param token_endpoint: URL of the authorization server's token endpoint.
+ :param token_endpoint_auth_method: client authentication method for
+ token endpoint.
+ :param revocation_endpoint: URL of the authorization server's OAuth 2.0
+ revocation endpoint.
+ :param revocation_endpoint_auth_method: client authentication method for
+ revocation endpoint.
+ :param scope: Scope that you needed to access user resources.
+ :param state: Shared secret to prevent CSRF attack.
+ :param redirect_uri: Redirect URI you registered as callback.
+ :param token: A dict of token attributes such as ``access_token``,
+ ``token_type`` and ``expires_at``.
+ :param token_placement: The place to put token in HTTP request. Available
+ values: "header", "body", "uri".
+ :param update_token: A function for you to update token. It accept a
+ :class:`OAuth2Token` as parameter.
+ :param leeway: Time window in seconds before the actual expiration of the
+ authentication token, that the token is considered expired and will
+ be refreshed.
+ :param default_timeout: If settled, every requests will have a default timeout.
+ """
+
+ client_auth_class = OAuth2ClientAuth
+ token_auth_class = OAuth2Auth
+ oauth_error_class = OAuthError
+ SESSION_REQUEST_PARAMS = (
+ "allow_redirects",
+ "timeout",
+ "cookies",
+ "files",
+ "proxies",
+ "hooks",
+ "stream",
+ "verify",
+ "cert",
+ "json",
+ )
+
+ def __init__(
+ self,
+ client_id=None,
+ client_secret=None,
+ token_endpoint_auth_method=None,
+ revocation_endpoint_auth_method=None,
+ scope=None,
+ state=None,
+ redirect_uri=None,
+ token=None,
+ token_placement="header",
+ update_token=None,
+ leeway=60,
+ default_timeout=None,
+ **kwargs,
+ ):
+ Session.__init__(self)
+ self.default_timeout = default_timeout
+ update_session_configure(self, kwargs)
+
+ OAuth2Client.__init__(
+ self,
+ session=self,
+ client_id=client_id,
+ client_secret=client_secret,
+ token_endpoint_auth_method=token_endpoint_auth_method,
+ revocation_endpoint_auth_method=revocation_endpoint_auth_method,
+ scope=scope,
+ state=state,
+ redirect_uri=redirect_uri,
+ token=token,
+ token_placement=token_placement,
+ update_token=update_token,
+ leeway=leeway,
+ **kwargs,
+ )
+
+ def fetch_access_token(self, url=None, **kwargs):
+ """Alias for fetch_token."""
+ return self.fetch_token(url, **kwargs)
+
+ def request(self, method, url, withhold_token=False, auth=None, **kwargs):
+ """Send request with auto refresh token feature (if available)."""
+ if self.default_timeout:
+ kwargs.setdefault("timeout", self.default_timeout)
+ if not withhold_token and auth is None:
+ if not self.token:
+ raise MissingTokenError()
+ auth = self.token_auth
+ return super().request(method, url, auth=auth, **kwargs)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/utils.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/utils.py
new file mode 100644
index 00000000..dc967050
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/requests_client/utils.py
@@ -0,0 +1,15 @@
+REQUESTS_SESSION_KWARGS = [
+ "proxies",
+ "hooks",
+ "stream",
+ "verify",
+ "cert",
+ "max_redirects",
+ "trust_env",
+]
+
+
+def update_session_configure(session, kwargs):
+ for k in REQUESTS_SESSION_KWARGS:
+ if k in kwargs:
+ setattr(session, k, kwargs.pop(k))
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__init__.py
new file mode 100644
index 00000000..e2f806aa
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__init__.py
@@ -0,0 +1,19 @@
+from .client_mixin import OAuth2ClientMixin
+from .functions import create_bearer_token_validator
+from .functions import create_query_client_func
+from .functions import create_query_token_func
+from .functions import create_revocation_endpoint
+from .functions import create_save_token_func
+from .tokens_mixins import OAuth2AuthorizationCodeMixin
+from .tokens_mixins import OAuth2TokenMixin
+
+__all__ = [
+ "OAuth2ClientMixin",
+ "OAuth2AuthorizationCodeMixin",
+ "OAuth2TokenMixin",
+ "create_query_client_func",
+ "create_save_token_func",
+ "create_query_token_func",
+ "create_revocation_endpoint",
+ "create_bearer_token_validator",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..2a9b4890
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/client_mixin.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/client_mixin.cpython-312.pyc
new file mode 100644
index 00000000..48fccd88
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/client_mixin.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/functions.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/functions.cpython-312.pyc
new file mode 100644
index 00000000..fe51cc2a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/functions.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/tokens_mixins.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/tokens_mixins.cpython-312.pyc
new file mode 100644
index 00000000..7aa03f3f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/__pycache__/tokens_mixins.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/client_mixin.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/client_mixin.py
new file mode 100644
index 00000000..c8835086
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/client_mixin.py
@@ -0,0 +1,147 @@
+import secrets
+
+from sqlalchemy import Column
+from sqlalchemy import Integer
+from sqlalchemy import String
+from sqlalchemy import Text
+
+from authlib.common.encoding import json_dumps
+from authlib.common.encoding import json_loads
+from authlib.oauth2.rfc6749 import ClientMixin
+from authlib.oauth2.rfc6749 import list_to_scope
+from authlib.oauth2.rfc6749 import scope_to_list
+
+
+class OAuth2ClientMixin(ClientMixin):
+ client_id = Column(String(48), index=True)
+ client_secret = Column(String(120))
+ client_id_issued_at = Column(Integer, nullable=False, default=0)
+ client_secret_expires_at = Column(Integer, nullable=False, default=0)
+ _client_metadata = Column("client_metadata", Text)
+
+ @property
+ def client_info(self):
+ """Implementation for Client Info in OAuth 2.0 Dynamic Client
+ Registration Protocol via `Section 3.2.1`_.
+
+ .. _`Section 3.2.1`: https://tools.ietf.org/html/rfc7591#section-3.2.1
+ """
+ return dict(
+ client_id=self.client_id,
+ client_secret=self.client_secret,
+ client_id_issued_at=self.client_id_issued_at,
+ client_secret_expires_at=self.client_secret_expires_at,
+ )
+
+ @property
+ def client_metadata(self):
+ if "client_metadata" in self.__dict__:
+ return self.__dict__["client_metadata"]
+ if self._client_metadata:
+ data = json_loads(self._client_metadata)
+ self.__dict__["client_metadata"] = data
+ return data
+ return {}
+
+ def set_client_metadata(self, value):
+ self._client_metadata = json_dumps(value)
+ if "client_metadata" in self.__dict__:
+ del self.__dict__["client_metadata"]
+
+ @property
+ def redirect_uris(self):
+ return self.client_metadata.get("redirect_uris", [])
+
+ @property
+ def token_endpoint_auth_method(self):
+ return self.client_metadata.get(
+ "token_endpoint_auth_method", "client_secret_basic"
+ )
+
+ @property
+ def grant_types(self):
+ return self.client_metadata.get("grant_types", [])
+
+ @property
+ def response_types(self):
+ return self.client_metadata.get("response_types", [])
+
+ @property
+ def client_name(self):
+ return self.client_metadata.get("client_name")
+
+ @property
+ def client_uri(self):
+ return self.client_metadata.get("client_uri")
+
+ @property
+ def logo_uri(self):
+ return self.client_metadata.get("logo_uri")
+
+ @property
+ def scope(self):
+ return self.client_metadata.get("scope", "")
+
+ @property
+ def contacts(self):
+ return self.client_metadata.get("contacts", [])
+
+ @property
+ def tos_uri(self):
+ return self.client_metadata.get("tos_uri")
+
+ @property
+ def policy_uri(self):
+ return self.client_metadata.get("policy_uri")
+
+ @property
+ def jwks_uri(self):
+ return self.client_metadata.get("jwks_uri")
+
+ @property
+ def jwks(self):
+ return self.client_metadata.get("jwks", [])
+
+ @property
+ def software_id(self):
+ return self.client_metadata.get("software_id")
+
+ @property
+ def software_version(self):
+ return self.client_metadata.get("software_version")
+
+ @property
+ def id_token_signed_response_alg(self):
+ return self.client_metadata.get("id_token_signed_response_alg")
+
+ def get_client_id(self):
+ return self.client_id
+
+ def get_default_redirect_uri(self):
+ if self.redirect_uris:
+ return self.redirect_uris[0]
+
+ def get_allowed_scope(self, scope):
+ if not scope:
+ return ""
+ allowed = set(self.scope.split())
+ scopes = scope_to_list(scope)
+ return list_to_scope([s for s in scopes if s in allowed])
+
+ def check_redirect_uri(self, redirect_uri):
+ return redirect_uri in self.redirect_uris
+
+ def check_client_secret(self, client_secret):
+ return secrets.compare_digest(self.client_secret, client_secret)
+
+ def check_endpoint_auth_method(self, method, endpoint):
+ if endpoint == "token":
+ return self.token_endpoint_auth_method == method
+ # TODO
+ return True
+
+ def check_response_type(self, response_type):
+ return response_type in self.response_types
+
+ def check_grant_type(self, grant_type):
+ return grant_type in self.grant_types
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/functions.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/functions.py
new file mode 100644
index 00000000..d10ab24e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/functions.py
@@ -0,0 +1,104 @@
+import time
+
+
+def create_query_client_func(session, client_model):
+ """Create an ``query_client`` function that can be used in authorization
+ server.
+
+ :param session: SQLAlchemy session
+ :param client_model: Client model class
+ """
+
+ def query_client(client_id):
+ q = session.query(client_model)
+ return q.filter_by(client_id=client_id).first()
+
+ return query_client
+
+
+def create_save_token_func(session, token_model):
+ """Create an ``save_token`` function that can be used in authorization
+ server.
+
+ :param session: SQLAlchemy session
+ :param token_model: Token model class
+ """
+
+ def save_token(token, request):
+ if request.user:
+ user_id = request.user.get_user_id()
+ else:
+ user_id = None
+ client = request.client
+ item = token_model(client_id=client.client_id, user_id=user_id, **token)
+ session.add(item)
+ session.commit()
+
+ return save_token
+
+
+def create_query_token_func(session, token_model):
+ """Create an ``query_token`` function for revocation, introspection
+ token endpoints.
+
+ :param session: SQLAlchemy session
+ :param token_model: Token model class
+ """
+
+ def query_token(token, token_type_hint):
+ q = session.query(token_model)
+ if token_type_hint == "access_token":
+ return q.filter_by(access_token=token).first()
+ elif token_type_hint == "refresh_token":
+ return q.filter_by(refresh_token=token).first()
+ # without token_type_hint
+ item = q.filter_by(access_token=token).first()
+ if item:
+ return item
+ return q.filter_by(refresh_token=token).first()
+
+ return query_token
+
+
+def create_revocation_endpoint(session, token_model):
+ """Create a revocation endpoint class with SQLAlchemy session
+ and token model.
+
+ :param session: SQLAlchemy session
+ :param token_model: Token model class
+ """
+ from authlib.oauth2.rfc7009 import RevocationEndpoint
+
+ query_token = create_query_token_func(session, token_model)
+
+ class _RevocationEndpoint(RevocationEndpoint):
+ def query_token(self, token, token_type_hint):
+ return query_token(token, token_type_hint)
+
+ def revoke_token(self, token, request):
+ now = int(time.time())
+ hint = request.form.get("token_type_hint")
+ token.access_token_revoked_at = now
+ if hint != "access_token":
+ token.refresh_token_revoked_at = now
+ session.add(token)
+ session.commit()
+
+ return _RevocationEndpoint
+
+
+def create_bearer_token_validator(session, token_model):
+ """Create an bearer token validator class with SQLAlchemy session
+ and token model.
+
+ :param session: SQLAlchemy session
+ :param token_model: Token model class
+ """
+ from authlib.oauth2.rfc6750 import BearerTokenValidator
+
+ class _BearerTokenValidator(BearerTokenValidator):
+ def authenticate_token(self, token_string):
+ q = session.query(token_model)
+ return q.filter_by(access_token=token_string).first()
+
+ return _BearerTokenValidator
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/tokens_mixins.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/tokens_mixins.py
new file mode 100644
index 00000000..91808e35
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/sqla_oauth2/tokens_mixins.py
@@ -0,0 +1,76 @@
+import time
+
+from sqlalchemy import Column
+from sqlalchemy import Integer
+from sqlalchemy import String
+from sqlalchemy import Text
+
+from authlib.oauth2.rfc6749 import AuthorizationCodeMixin
+from authlib.oauth2.rfc6749 import TokenMixin
+
+
+class OAuth2AuthorizationCodeMixin(AuthorizationCodeMixin):
+ code = Column(String(120), unique=True, nullable=False)
+ client_id = Column(String(48))
+ redirect_uri = Column(Text, default="")
+ response_type = Column(Text, default="")
+ scope = Column(Text, default="")
+ nonce = Column(Text)
+ auth_time = Column(Integer, nullable=False, default=lambda: int(time.time()))
+ acr = Column(Text, nullable=True)
+ amr = Column(Text, nullable=True)
+
+ code_challenge = Column(Text)
+ code_challenge_method = Column(String(48))
+
+ def is_expired(self):
+ return self.auth_time + 300 < time.time()
+
+ def get_redirect_uri(self):
+ return self.redirect_uri
+
+ def get_scope(self):
+ return self.scope
+
+ def get_auth_time(self):
+ return self.auth_time
+
+ def get_acr(self):
+ return self.acr
+
+ def get_amr(self):
+ return self.amr.split() if self.amr else []
+
+ def get_nonce(self):
+ return self.nonce
+
+
+class OAuth2TokenMixin(TokenMixin):
+ client_id = Column(String(48))
+ token_type = Column(String(40))
+ access_token = Column(String(255), unique=True, nullable=False)
+ refresh_token = Column(String(255), index=True)
+ scope = Column(Text, default="")
+ issued_at = Column(Integer, nullable=False, default=lambda: int(time.time()))
+ access_token_revoked_at = Column(Integer, nullable=False, default=0)
+ refresh_token_revoked_at = Column(Integer, nullable=False, default=0)
+ expires_in = Column(Integer, nullable=False, default=0)
+
+ def check_client(self, client):
+ return self.client_id == client.get_client_id()
+
+ def get_scope(self):
+ return self.scope
+
+ def get_expires_in(self):
+ return self.expires_in
+
+ def is_revoked(self):
+ return self.access_token_revoked_at or self.refresh_token_revoked_at
+
+ def is_expired(self):
+ if not self.expires_in:
+ return False
+
+ expires_at = self.issued_at + self.expires_in
+ return expires_at < time.time()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__init__.py
new file mode 100644
index 00000000..e7d96378
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__init__.py
@@ -0,0 +1,26 @@
+from ..base_client import BaseOAuth
+from ..base_client import OAuthError
+from .apps import StarletteOAuth1App
+from .apps import StarletteOAuth2App
+from .integration import StarletteIntegration
+
+
+class OAuth(BaseOAuth):
+ oauth1_client_cls = StarletteOAuth1App
+ oauth2_client_cls = StarletteOAuth2App
+ framework_integration_cls = StarletteIntegration
+
+ def __init__(self, config=None, cache=None, fetch_token=None, update_token=None):
+ super().__init__(
+ cache=cache, fetch_token=fetch_token, update_token=update_token
+ )
+ self.config = config
+
+
+__all__ = [
+ "OAuth",
+ "OAuthError",
+ "StarletteIntegration",
+ "StarletteOAuth1App",
+ "StarletteOAuth2App",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..d5f7af7b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/apps.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/apps.cpython-312.pyc
new file mode 100644
index 00000000..3df8f7cb
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/apps.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/integration.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/integration.cpython-312.pyc
new file mode 100644
index 00000000..488024e5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/__pycache__/integration.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/apps.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/apps.py
new file mode 100644
index 00000000..b97143cf
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/apps.py
@@ -0,0 +1,106 @@
+from starlette.datastructures import URL
+from starlette.responses import RedirectResponse
+
+from ..base_client import BaseApp
+from ..base_client import OAuthError
+from ..base_client.async_app import AsyncOAuth1Mixin
+from ..base_client.async_app import AsyncOAuth2Mixin
+from ..base_client.async_openid import AsyncOpenIDMixin
+from ..httpx_client import AsyncOAuth1Client
+from ..httpx_client import AsyncOAuth2Client
+
+
+class StarletteAppMixin:
+ async def save_authorize_data(self, request, **kwargs):
+ state = kwargs.pop("state", None)
+ if state:
+ if self.framework.cache:
+ session = None
+ else:
+ session = request.session
+ await self.framework.set_state_data(session, state, kwargs)
+ else:
+ raise RuntimeError("Missing state value")
+
+ async def authorize_redirect(self, request, redirect_uri=None, **kwargs):
+ """Create a HTTP Redirect for Authorization Endpoint.
+
+ :param request: HTTP request instance from Starlette view.
+ :param redirect_uri: Callback or redirect URI for authorization.
+ :param kwargs: Extra parameters to include.
+ :return: A HTTP redirect response.
+ """
+ # Handle Starlette >= 0.26.0 where redirect_uri may now be a URL and not a string
+ if redirect_uri and isinstance(redirect_uri, URL):
+ redirect_uri = str(redirect_uri)
+ rv = await self.create_authorization_url(redirect_uri, **kwargs)
+ await self.save_authorize_data(request, redirect_uri=redirect_uri, **rv)
+ return RedirectResponse(rv["url"], status_code=302)
+
+
+class StarletteOAuth1App(StarletteAppMixin, AsyncOAuth1Mixin, BaseApp):
+ client_cls = AsyncOAuth1Client
+
+ async def authorize_access_token(self, request, **kwargs):
+ params = dict(request.query_params)
+ state = params.get("oauth_token")
+ if not state:
+ raise OAuthError(description='Missing "oauth_token" parameter')
+
+ data = await self.framework.get_state_data(request.session, state)
+ if not data:
+ raise OAuthError(description='Missing "request_token" in temporary data')
+
+ params["request_token"] = data["request_token"]
+ params.update(kwargs)
+ await self.framework.clear_state_data(request.session, state)
+ return await self.fetch_access_token(**params)
+
+
+class StarletteOAuth2App(
+ StarletteAppMixin, AsyncOAuth2Mixin, AsyncOpenIDMixin, BaseApp
+):
+ client_cls = AsyncOAuth2Client
+
+ async def authorize_access_token(self, request, **kwargs):
+ if request.scope.get("method", "GET") == "GET":
+ error = request.query_params.get("error")
+ if error:
+ description = request.query_params.get("error_description")
+ raise OAuthError(error=error, description=description)
+
+ params = {
+ "code": request.query_params.get("code"),
+ "state": request.query_params.get("state"),
+ }
+ else:
+ async with request.form() as form:
+ params = {
+ "code": form.get("code"),
+ "state": form.get("state"),
+ }
+
+ if self.framework.cache:
+ session = None
+ else:
+ session = request.session
+
+ state_data = await self.framework.get_state_data(session, params.get("state"))
+ await self.framework.clear_state_data(session, params.get("state"))
+ params = self._format_state_params(state_data, params)
+
+ claims_options = kwargs.pop("claims_options", None)
+ claims_cls = kwargs.pop("claims_cls", None)
+ leeway = kwargs.pop("leeway", 120)
+ token = await self.fetch_access_token(**params, **kwargs)
+
+ if "id_token" in token and "nonce" in state_data:
+ userinfo = await self.parse_id_token(
+ token,
+ nonce=state_data["nonce"],
+ claims_options=claims_options,
+ claims_cls=claims_cls,
+ leeway=leeway,
+ )
+ token["userinfo"] = userinfo
+ return token
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/integration.py b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/integration.py
new file mode 100644
index 00000000..25b7fdbc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/integrations/starlette_client/integration.py
@@ -0,0 +1,72 @@
+import json
+import time
+from collections.abc import Hashable
+from typing import Any
+from typing import Optional
+
+from ..base_client import FrameworkIntegration
+
+
+class StarletteIntegration(FrameworkIntegration):
+ async def _get_cache_data(self, key: Hashable):
+ value = await self.cache.get(key)
+ if not value:
+ return None
+ try:
+ return json.loads(value)
+ except (TypeError, ValueError):
+ return None
+
+ async def get_state_data(
+ self, session: Optional[dict[str, Any]], state: str
+ ) -> dict[str, Any]:
+ key = f"_state_{self.name}_{state}"
+ if self.cache:
+ value = await self._get_cache_data(key)
+ elif session is not None:
+ value = session.get(key)
+ else:
+ value = None
+
+ if value:
+ return value.get("data")
+ return None
+
+ async def set_state_data(
+ self, session: Optional[dict[str, Any]], state: str, data: Any
+ ):
+ key_prefix = f"_state_{self.name}_"
+ key = f"{key_prefix}{state}"
+ if self.cache:
+ await self.cache.set(key, json.dumps({"data": data}), self.expires_in)
+ elif session is not None:
+ # clear old state data to avoid session size growing
+ for old_key in list(session.keys()):
+ if old_key.startswith(key_prefix):
+ session.pop(old_key)
+ now = time.time()
+ session[key] = {"data": data, "exp": now + self.expires_in}
+
+ async def clear_state_data(self, session: Optional[dict[str, Any]], state: str):
+ key = f"_state_{self.name}_{state}"
+ if self.cache:
+ await self.cache.delete(key)
+ elif session is not None:
+ session.pop(key, None)
+ self._clear_session_state(session)
+
+ def update_token(self, token, refresh_token=None, access_token=None):
+ pass
+
+ @staticmethod
+ def load_config(oauth, name, params):
+ if not oauth.config:
+ return {}
+
+ rv = {}
+ for k in params:
+ conf_key = f"{name}_{k}".upper()
+ v = oauth.config.get(conf_key, default=None)
+ if v is not None:
+ rv[k] = v
+ return rv
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__init__.py
new file mode 100644
index 00000000..020cb5dd
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__init__.py
@@ -0,0 +1,73 @@
+"""authlib.jose
+~~~~~~~~~~~~
+
+JOSE implementation in Authlib. Tracking the status of JOSE specs at
+https://tools.ietf.org/wg/jose/
+"""
+
+from .errors import JoseError
+from .rfc7515 import JsonWebSignature
+from .rfc7515 import JWSAlgorithm
+from .rfc7515 import JWSHeader
+from .rfc7515 import JWSObject
+from .rfc7516 import JsonWebEncryption
+from .rfc7516 import JWEAlgorithm
+from .rfc7516 import JWEEncAlgorithm
+from .rfc7516 import JWEZipAlgorithm
+from .rfc7517 import JsonWebKey
+from .rfc7517 import Key
+from .rfc7517 import KeySet
+from .rfc7518 import ECDHESAlgorithm
+from .rfc7518 import ECKey
+from .rfc7518 import OctKey
+from .rfc7518 import RSAKey
+from .rfc7518 import register_jwe_rfc7518
+from .rfc7518 import register_jws_rfc7518
+from .rfc7519 import BaseClaims
+from .rfc7519 import JsonWebToken
+from .rfc7519 import JWTClaims
+from .rfc8037 import OKPKey
+from .rfc8037 import register_jws_rfc8037
+
+# register algorithms
+register_jws_rfc7518(JsonWebSignature)
+register_jws_rfc8037(JsonWebSignature)
+
+register_jwe_rfc7518(JsonWebEncryption)
+
+# attach algorithms
+ECDHESAlgorithm.ALLOWED_KEY_CLS = (ECKey, OKPKey)
+
+# register supported keys
+JsonWebKey.JWK_KEY_CLS = {
+ OctKey.kty: OctKey,
+ RSAKey.kty: RSAKey,
+ ECKey.kty: ECKey,
+ OKPKey.kty: OKPKey,
+}
+
+jwt = JsonWebToken(list(JsonWebSignature.ALGORITHMS_REGISTRY.keys()))
+
+
+__all__ = [
+ "JoseError",
+ "JsonWebSignature",
+ "JWSAlgorithm",
+ "JWSHeader",
+ "JWSObject",
+ "JsonWebEncryption",
+ "JWEAlgorithm",
+ "JWEEncAlgorithm",
+ "JWEZipAlgorithm",
+ "JsonWebKey",
+ "Key",
+ "KeySet",
+ "OctKey",
+ "RSAKey",
+ "ECKey",
+ "OKPKey",
+ "JsonWebToken",
+ "BaseClaims",
+ "JWTClaims",
+ "jwt",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..44fb2d08
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..ecde8772
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/jwk.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/jwk.cpython-312.pyc
new file mode 100644
index 00000000..9540d5ed
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/jwk.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/util.cpython-312.pyc
new file mode 100644
index 00000000..4051f3b6
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/__pycache__/util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__init__.py
new file mode 100644
index 00000000..c72edb64
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__init__.py
@@ -0,0 +1,19 @@
+from ._jwe_algorithms import JWE_DRAFT_ALG_ALGORITHMS
+from ._jwe_enc_cryptography import C20PEncAlgorithm
+
+try:
+ from ._jwe_enc_cryptodome import XC20PEncAlgorithm
+except ImportError:
+ XC20PEncAlgorithm = None
+
+
+def register_jwe_draft(cls):
+ for alg in JWE_DRAFT_ALG_ALGORITHMS:
+ cls.register_algorithm(alg)
+
+ cls.register_algorithm(C20PEncAlgorithm(256)) # C20P
+ if XC20PEncAlgorithm is not None:
+ cls.register_algorithm(XC20PEncAlgorithm(256)) # XC20P
+
+
+__all__ = ["register_jwe_draft"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..d5407bc7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_algorithms.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_algorithms.cpython-312.pyc
new file mode 100644
index 00000000..1b02a904
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_algorithms.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_enc_cryptodome.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_enc_cryptodome.cpython-312.pyc
new file mode 100644
index 00000000..ffc1a62d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_enc_cryptodome.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_enc_cryptography.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_enc_cryptography.cpython-312.pyc
new file mode 100644
index 00000000..e8e8dea6
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/__pycache__/_jwe_enc_cryptography.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_algorithms.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_algorithms.py
new file mode 100644
index 00000000..1b6269f5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_algorithms.py
@@ -0,0 +1,216 @@
+import struct
+
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives.kdf.concatkdf import ConcatKDFHash
+
+from authlib.jose.errors import InvalidEncryptionAlgorithmForECDH1PUWithKeyWrappingError
+from authlib.jose.rfc7516 import JWEAlgorithmWithTagAwareKeyAgreement
+from authlib.jose.rfc7518 import AESAlgorithm
+from authlib.jose.rfc7518 import CBCHS2EncAlgorithm
+from authlib.jose.rfc7518 import ECKey
+from authlib.jose.rfc7518 import u32be_len_input
+from authlib.jose.rfc8037 import OKPKey
+
+
+class ECDH1PUAlgorithm(JWEAlgorithmWithTagAwareKeyAgreement):
+ EXTRA_HEADERS = ["epk", "apu", "apv", "skid"]
+ ALLOWED_KEY_CLS = (ECKey, OKPKey)
+
+ # https://datatracker.ietf.org/doc/html/draft-madden-jose-ecdh-1pu-04
+ def __init__(self, key_size=None):
+ if key_size is None:
+ self.name = "ECDH-1PU"
+ self.description = "ECDH-1PU in the Direct Key Agreement mode"
+ else:
+ self.name = f"ECDH-1PU+A{key_size}KW"
+ self.description = (
+ f"ECDH-1PU using Concat KDF and CEK wrapped with A{key_size}KW"
+ )
+ self.key_size = key_size
+ self.aeskw = AESAlgorithm(key_size)
+
+ def prepare_key(self, raw_data):
+ if isinstance(raw_data, self.ALLOWED_KEY_CLS):
+ return raw_data
+ return ECKey.import_key(raw_data)
+
+ def generate_preset(self, enc_alg, key):
+ epk = self._generate_ephemeral_key(key)
+ h = self._prepare_headers(epk)
+ preset = {"epk": epk, "header": h}
+ if self.key_size is not None:
+ cek = enc_alg.generate_cek()
+ preset["cek"] = cek
+ return preset
+
+ def compute_shared_key(self, shared_key_e, shared_key_s):
+ return shared_key_e + shared_key_s
+
+ def compute_fixed_info(self, headers, bit_size, tag):
+ if tag is None:
+ cctag = b""
+ else:
+ cctag = u32be_len_input(tag)
+
+ # AlgorithmID
+ if self.key_size is None:
+ alg_id = u32be_len_input(headers["enc"])
+ else:
+ alg_id = u32be_len_input(headers["alg"])
+
+ # PartyUInfo
+ apu_info = u32be_len_input(headers.get("apu"), True)
+
+ # PartyVInfo
+ apv_info = u32be_len_input(headers.get("apv"), True)
+
+ # SuppPubInfo
+ pub_info = struct.pack(">I", bit_size) + cctag
+
+ return alg_id + apu_info + apv_info + pub_info
+
+ def compute_derived_key(self, shared_key, fixed_info, bit_size):
+ ckdf = ConcatKDFHash(
+ algorithm=hashes.SHA256(),
+ length=bit_size // 8,
+ otherinfo=fixed_info,
+ backend=default_backend(),
+ )
+ return ckdf.derive(shared_key)
+
+ def deliver_at_sender(
+ self,
+ sender_static_key,
+ sender_ephemeral_key,
+ recipient_pubkey,
+ headers,
+ bit_size,
+ tag,
+ ):
+ shared_key_s = sender_static_key.exchange_shared_key(recipient_pubkey)
+ shared_key_e = sender_ephemeral_key.exchange_shared_key(recipient_pubkey)
+ shared_key = self.compute_shared_key(shared_key_e, shared_key_s)
+
+ fixed_info = self.compute_fixed_info(headers, bit_size, tag)
+
+ return self.compute_derived_key(shared_key, fixed_info, bit_size)
+
+ def deliver_at_recipient(
+ self,
+ recipient_key,
+ sender_static_pubkey,
+ sender_ephemeral_pubkey,
+ headers,
+ bit_size,
+ tag,
+ ):
+ shared_key_s = recipient_key.exchange_shared_key(sender_static_pubkey)
+ shared_key_e = recipient_key.exchange_shared_key(sender_ephemeral_pubkey)
+ shared_key = self.compute_shared_key(shared_key_e, shared_key_s)
+
+ fixed_info = self.compute_fixed_info(headers, bit_size, tag)
+
+ return self.compute_derived_key(shared_key, fixed_info, bit_size)
+
+ def _generate_ephemeral_key(self, key):
+ return key.generate_key(key["crv"], is_private=True)
+
+ def _prepare_headers(self, epk):
+ # REQUIRED_JSON_FIELDS contains only public fields
+ pub_epk = {k: epk[k] for k in epk.REQUIRED_JSON_FIELDS}
+ pub_epk["kty"] = epk.kty
+ return {"epk": pub_epk}
+
+ def generate_keys_and_prepare_headers(self, enc_alg, key, sender_key, preset=None):
+ if not isinstance(enc_alg, CBCHS2EncAlgorithm):
+ raise InvalidEncryptionAlgorithmForECDH1PUWithKeyWrappingError()
+
+ if preset and "epk" in preset:
+ epk = preset["epk"]
+ h = {}
+ else:
+ epk = self._generate_ephemeral_key(key)
+ h = self._prepare_headers(epk)
+
+ if preset and "cek" in preset:
+ cek = preset["cek"]
+ else:
+ cek = enc_alg.generate_cek()
+
+ return {"epk": epk, "cek": cek, "header": h}
+
+ def _agree_upon_key_at_sender(
+ self, enc_alg, headers, key, sender_key, epk, tag=None
+ ):
+ if self.key_size is None:
+ bit_size = enc_alg.CEK_SIZE
+ else:
+ bit_size = self.key_size
+
+ public_key = key.get_op_key("wrapKey")
+
+ return self.deliver_at_sender(
+ sender_key, epk, public_key, headers, bit_size, tag
+ )
+
+ def _wrap_cek(self, cek, dk):
+ kek = self.aeskw.prepare_key(dk)
+ return self.aeskw.wrap_cek(cek, kek)
+
+ def agree_upon_key_and_wrap_cek(
+ self, enc_alg, headers, key, sender_key, epk, cek, tag
+ ):
+ dk = self._agree_upon_key_at_sender(enc_alg, headers, key, sender_key, epk, tag)
+ return self._wrap_cek(cek, dk)
+
+ def wrap(self, enc_alg, headers, key, sender_key, preset=None):
+ # In this class this method is used in direct key agreement mode only
+ if self.key_size is not None:
+ raise RuntimeError("Invalid algorithm state detected")
+
+ if preset and "epk" in preset:
+ epk = preset["epk"]
+ h = {}
+ else:
+ epk = self._generate_ephemeral_key(key)
+ h = self._prepare_headers(epk)
+
+ dk = self._agree_upon_key_at_sender(enc_alg, headers, key, sender_key, epk)
+
+ return {"ek": b"", "cek": dk, "header": h}
+
+ def unwrap(self, enc_alg, ek, headers, key, sender_key, tag=None):
+ if "epk" not in headers:
+ raise ValueError('Missing "epk" in headers')
+
+ if self.key_size is None:
+ bit_size = enc_alg.CEK_SIZE
+ else:
+ bit_size = self.key_size
+
+ sender_pubkey = sender_key.get_op_key("wrapKey")
+ epk = key.import_key(headers["epk"])
+ epk_pubkey = epk.get_op_key("wrapKey")
+ dk = self.deliver_at_recipient(
+ key, sender_pubkey, epk_pubkey, headers, bit_size, tag
+ )
+
+ if self.key_size is None:
+ return dk
+
+ kek = self.aeskw.prepare_key(dk)
+ return self.aeskw.unwrap(enc_alg, ek, headers, kek)
+
+
+JWE_DRAFT_ALG_ALGORITHMS = [
+ ECDH1PUAlgorithm(None), # ECDH-1PU
+ ECDH1PUAlgorithm(128), # ECDH-1PU+A128KW
+ ECDH1PUAlgorithm(192), # ECDH-1PU+A192KW
+ ECDH1PUAlgorithm(256), # ECDH-1PU+A256KW
+]
+
+
+def register_jwe_alg_draft(cls):
+ for alg in JWE_DRAFT_ALG_ALGORITHMS:
+ cls.register_algorithm(alg)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_enc_cryptodome.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_enc_cryptodome.py
new file mode 100644
index 00000000..e53e3531
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_enc_cryptodome.py
@@ -0,0 +1,53 @@
+"""authlib.jose.draft.
+~~~~~~~~~~~~~~~~~~~~
+
+Content Encryption per `Section 4`_.
+
+.. _`Section 4`: https://datatracker.ietf.org/doc/html/draft-amringer-jose-chacha-02#section-4
+"""
+
+from Cryptodome.Cipher import ChaCha20_Poly1305 as Cryptodome_ChaCha20_Poly1305
+
+from authlib.jose.rfc7516 import JWEEncAlgorithm
+
+
+class XC20PEncAlgorithm(JWEEncAlgorithm):
+ # Use of an IV of size 192 bits is REQUIRED with this algorithm.
+ # https://datatracker.ietf.org/doc/html/draft-amringer-jose-chacha-02#section-4.1
+ IV_SIZE = 192
+
+ def __init__(self, key_size):
+ self.name = "XC20P"
+ self.description = "XChaCha20-Poly1305"
+ self.key_size = key_size
+ self.CEK_SIZE = key_size
+
+ def encrypt(self, msg, aad, iv, key):
+ """Content Encryption with AEAD_XCHACHA20_POLY1305.
+
+ :param msg: text to be encrypt in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param key: encrypted key in bytes
+ :return: (ciphertext, tag)
+ """
+ self.check_iv(iv)
+ chacha = Cryptodome_ChaCha20_Poly1305.new(key=key, nonce=iv)
+ chacha.update(aad)
+ ciphertext, tag = chacha.encrypt_and_digest(msg)
+ return ciphertext, tag
+
+ def decrypt(self, ciphertext, aad, iv, tag, key):
+ """Content Decryption with AEAD_XCHACHA20_POLY1305.
+
+ :param ciphertext: ciphertext in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param tag: authentication tag in bytes
+ :param key: encrypted key in bytes
+ :return: message
+ """
+ self.check_iv(iv)
+ chacha = Cryptodome_ChaCha20_Poly1305.new(key=key, nonce=iv)
+ chacha.update(aad)
+ return chacha.decrypt_and_verify(ciphertext, tag)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_enc_cryptography.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_enc_cryptography.py
new file mode 100644
index 00000000..f689c30d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/drafts/_jwe_enc_cryptography.py
@@ -0,0 +1,51 @@
+"""authlib.jose.draft.
+~~~~~~~~~~~~~~~~~~~~
+
+Content Encryption per `Section 4`_.
+
+.. _`Section 4`: https://datatracker.ietf.org/doc/html/draft-amringer-jose-chacha-02#section-4
+"""
+
+from cryptography.hazmat.primitives.ciphers.aead import ChaCha20Poly1305
+
+from authlib.jose.rfc7516 import JWEEncAlgorithm
+
+
+class C20PEncAlgorithm(JWEEncAlgorithm):
+ # Use of an IV of size 96 bits is REQUIRED with this algorithm.
+ # https://datatracker.ietf.org/doc/html/draft-amringer-jose-chacha-02#section-4.1
+ IV_SIZE = 96
+
+ def __init__(self, key_size):
+ self.name = "C20P"
+ self.description = "ChaCha20-Poly1305"
+ self.key_size = key_size
+ self.CEK_SIZE = key_size
+
+ def encrypt(self, msg, aad, iv, key):
+ """Content Encryption with AEAD_CHACHA20_POLY1305.
+
+ :param msg: text to be encrypt in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param key: encrypted key in bytes
+ :return: (ciphertext, tag)
+ """
+ self.check_iv(iv)
+ chacha = ChaCha20Poly1305(key)
+ ciphertext = chacha.encrypt(iv, msg, aad)
+ return ciphertext[:-16], ciphertext[-16:]
+
+ def decrypt(self, ciphertext, aad, iv, tag, key):
+ """Content Decryption with AEAD_CHACHA20_POLY1305.
+
+ :param ciphertext: ciphertext in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param tag: authentication tag in bytes
+ :param key: encrypted key in bytes
+ :return: message
+ """
+ self.check_iv(iv)
+ chacha = ChaCha20Poly1305(key)
+ return chacha.decrypt(iv, ciphertext + tag, aad)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/errors.py
new file mode 100644
index 00000000..385a866e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/errors.py
@@ -0,0 +1,120 @@
+from authlib.common.errors import AuthlibBaseError
+
+
+class JoseError(AuthlibBaseError):
+ pass
+
+
+class DecodeError(JoseError):
+ error = "decode_error"
+
+
+class MissingAlgorithmError(JoseError):
+ error = "missing_algorithm"
+
+
+class UnsupportedAlgorithmError(JoseError):
+ error = "unsupported_algorithm"
+
+
+class BadSignatureError(JoseError):
+ error = "bad_signature"
+
+ def __init__(self, result):
+ super().__init__()
+ self.result = result
+
+
+class InvalidHeaderParameterNameError(JoseError):
+ error = "invalid_header_parameter_name"
+
+ def __init__(self, name):
+ description = f"Invalid Header Parameter Name: {name}"
+ super().__init__(description=description)
+
+
+class InvalidCritHeaderParameterNameError(JoseError):
+ error = "invalid_crit_header_parameter_name"
+
+ def __init__(self, name):
+ description = f"Invalid Header Parameter Name: {name}"
+ super().__init__(description=description)
+
+
+class InvalidEncryptionAlgorithmForECDH1PUWithKeyWrappingError(JoseError):
+ error = "invalid_encryption_algorithm_for_ECDH_1PU_with_key_wrapping"
+
+ def __init__(self):
+ description = (
+ "In key agreement with key wrapping mode ECDH-1PU algorithm "
+ "only supports AES_CBC_HMAC_SHA2 family encryption algorithms"
+ )
+ super().__init__(description=description)
+
+
+class InvalidAlgorithmForMultipleRecipientsMode(JoseError):
+ error = "invalid_algorithm_for_multiple_recipients_mode"
+
+ def __init__(self, alg):
+ description = f"{alg} algorithm cannot be used in multiple recipients mode"
+ super().__init__(description=description)
+
+
+class KeyMismatchError(JoseError):
+ error = "key_mismatch_error"
+ description = "Key does not match to any recipient"
+
+
+class MissingEncryptionAlgorithmError(JoseError):
+ error = "missing_encryption_algorithm"
+ description = "Missing 'enc' in header"
+
+
+class UnsupportedEncryptionAlgorithmError(JoseError):
+ error = "unsupported_encryption_algorithm"
+ description = "Unsupported 'enc' value in header"
+
+
+class UnsupportedCompressionAlgorithmError(JoseError):
+ error = "unsupported_compression_algorithm"
+ description = "Unsupported 'zip' value in header"
+
+
+class InvalidUseError(JoseError):
+ error = "invalid_use"
+ description = "Key 'use' is not valid for your usage"
+
+
+class InvalidClaimError(JoseError):
+ error = "invalid_claim"
+
+ def __init__(self, claim):
+ self.claim_name = claim
+ description = f"Invalid claim '{claim}'"
+ super().__init__(description=description)
+
+
+class MissingClaimError(JoseError):
+ error = "missing_claim"
+
+ def __init__(self, claim):
+ description = f"Missing '{claim}' claim"
+ super().__init__(description=description)
+
+
+class InsecureClaimError(JoseError):
+ error = "insecure_claim"
+
+ def __init__(self, claim):
+ description = f"Insecure claim '{claim}'"
+ super().__init__(description=description)
+
+
+class ExpiredTokenError(JoseError):
+ error = "expired_token"
+ description = "The token is expired"
+
+
+class InvalidTokenError(JoseError):
+ error = "invalid_token"
+ description = "The token is not valid yet"
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/jwk.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/jwk.py
new file mode 100644
index 00000000..e1debb57
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/jwk.py
@@ -0,0 +1,20 @@
+from authlib.deprecate import deprecate
+
+from .rfc7517 import JsonWebKey
+
+
+def loads(obj, kid=None):
+ deprecate("Please use ``JsonWebKey`` directly.")
+ key_set = JsonWebKey.import_key_set(obj)
+ if key_set:
+ return key_set.find_by_kid(kid)
+ return JsonWebKey.import_key(obj)
+
+
+def dumps(key, kty=None, **params):
+ deprecate("Please use ``JsonWebKey`` directly.")
+ if kty:
+ params["kty"] = kty
+
+ key = JsonWebKey.import_key(key, params)
+ return dict(key)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__init__.py
new file mode 100644
index 00000000..7c657515
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__init__.py
@@ -0,0 +1,15 @@
+"""authlib.jose.rfc7515.
+~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+JSON Web Signature (JWS).
+
+https://tools.ietf.org/html/rfc7515
+"""
+
+from .jws import JsonWebSignature
+from .models import JWSAlgorithm
+from .models import JWSHeader
+from .models import JWSObject
+
+__all__ = ["JsonWebSignature", "JWSAlgorithm", "JWSHeader", "JWSObject"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..77f94586
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/jws.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/jws.cpython-312.pyc
new file mode 100644
index 00000000..166b90aa
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/jws.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..34d52ed2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/jws.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/jws.py
new file mode 100644
index 00000000..65a7e973
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/jws.py
@@ -0,0 +1,350 @@
+from authlib.common.encoding import json_b64encode
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+from authlib.common.encoding import urlsafe_b64encode
+from authlib.jose.errors import BadSignatureError
+from authlib.jose.errors import DecodeError
+from authlib.jose.errors import InvalidCritHeaderParameterNameError
+from authlib.jose.errors import InvalidHeaderParameterNameError
+from authlib.jose.errors import MissingAlgorithmError
+from authlib.jose.errors import UnsupportedAlgorithmError
+from authlib.jose.util import ensure_dict
+from authlib.jose.util import extract_header
+from authlib.jose.util import extract_segment
+
+from .models import JWSHeader
+from .models import JWSObject
+
+
+class JsonWebSignature:
+ #: Registered Header Parameter Names defined by Section 4.1
+ REGISTERED_HEADER_PARAMETER_NAMES = frozenset(
+ [
+ "alg",
+ "jku",
+ "jwk",
+ "kid",
+ "x5u",
+ "x5c",
+ "x5t",
+ "x5t#S256",
+ "typ",
+ "cty",
+ "crit",
+ ]
+ )
+
+ MAX_CONTENT_LENGTH: int = 256000
+
+ #: Defined available JWS algorithms in the registry
+ ALGORITHMS_REGISTRY = {}
+
+ def __init__(self, algorithms=None, private_headers=None):
+ self._private_headers = private_headers
+ self._algorithms = algorithms
+
+ @classmethod
+ def register_algorithm(cls, algorithm):
+ if not algorithm or algorithm.algorithm_type != "JWS":
+ raise ValueError(f"Invalid algorithm for JWS, {algorithm!r}")
+ cls.ALGORITHMS_REGISTRY[algorithm.name] = algorithm
+
+ def serialize_compact(self, protected, payload, key):
+ """Generate a JWS Compact Serialization. The JWS Compact Serialization
+ represents digitally signed or MACed content as a compact, URL-safe
+ string, per `Section 7.1`_.
+
+ .. code-block:: text
+
+ BASE64URL(UTF8(JWS Protected Header)) || '.' ||
+ BASE64URL(JWS Payload) || '.' ||
+ BASE64URL(JWS Signature)
+
+ :param protected: A dict of protected header
+ :param payload: A bytes/string of payload
+ :param key: Private key used to generate signature
+ :return: byte
+ """
+ jws_header = JWSHeader(protected, None)
+ self._validate_private_headers(protected)
+ self._validate_crit_headers(protected)
+ algorithm, key = self._prepare_algorithm_key(protected, payload, key)
+
+ protected_segment = json_b64encode(jws_header.protected)
+ payload_segment = urlsafe_b64encode(to_bytes(payload))
+
+ # calculate signature
+ signing_input = b".".join([protected_segment, payload_segment])
+ signature = urlsafe_b64encode(algorithm.sign(signing_input, key))
+ return b".".join([protected_segment, payload_segment, signature])
+
+ def deserialize_compact(self, s, key, decode=None):
+ """Exact JWS Compact Serialization, and validate with the given key.
+ If key is not provided, the returned dict will contain the signature,
+ and signing input values. Via `Section 7.1`_.
+
+ :param s: text of JWS Compact Serialization
+ :param key: key used to verify the signature
+ :param decode: a function to decode payload data
+ :return: JWSObject
+ :raise: BadSignatureError
+
+ .. _`Section 7.1`: https://tools.ietf.org/html/rfc7515#section-7.1
+ """
+ if len(s) > self.MAX_CONTENT_LENGTH:
+ raise ValueError("Serialization is too long.")
+
+ try:
+ s = to_bytes(s)
+ signing_input, signature_segment = s.rsplit(b".", 1)
+ protected_segment, payload_segment = signing_input.split(b".", 1)
+ except ValueError as exc:
+ raise DecodeError("Not enough segments") from exc
+
+ protected = _extract_header(protected_segment)
+ self._validate_crit_headers(protected)
+ jws_header = JWSHeader(protected, None)
+
+ payload = _extract_payload(payload_segment)
+ if decode:
+ payload = decode(payload)
+
+ signature = _extract_signature(signature_segment)
+ rv = JWSObject(jws_header, payload, "compact")
+ algorithm, key = self._prepare_algorithm_key(jws_header, payload, key)
+ if algorithm.verify(signing_input, signature, key):
+ return rv
+ raise BadSignatureError(rv)
+
+ def serialize_json(self, header_obj, payload, key):
+ """Generate a JWS JSON Serialization. The JWS JSON Serialization
+ represents digitally signed or MACed content as a JSON object,
+ per `Section 7.2`_.
+
+ :param header_obj: A dict/list of header
+ :param payload: A string/dict of payload
+ :param key: Private key used to generate signature
+ :return: JWSObject
+
+ Example ``header_obj`` of JWS JSON Serialization::
+
+ {
+ "protected: {"alg": "HS256"},
+ "header": {"kid": "jose"}
+ }
+
+ Pass a dict to generate flattened JSON Serialization, pass a list of
+ header dict to generate standard JSON Serialization.
+ """
+ payload_segment = json_b64encode(payload)
+
+ def _sign(jws_header):
+ self._validate_private_headers(jws_header)
+ # RFC 7515 §4.1.11: 'crit' MUST be integrity-protected.
+ # Reject if present in unprotected header, and validate only
+ # against the protected header parameters.
+ self._reject_unprotected_crit(jws_header.header)
+ self._validate_crit_headers(jws_header.protected)
+ _alg, _key = self._prepare_algorithm_key(jws_header, payload, key)
+
+ protected_segment = json_b64encode(jws_header.protected)
+ signing_input = b".".join([protected_segment, payload_segment])
+ signature = urlsafe_b64encode(_alg.sign(signing_input, _key))
+
+ rv = {
+ "protected": to_unicode(protected_segment),
+ "signature": to_unicode(signature),
+ }
+ if jws_header.header is not None:
+ rv["header"] = jws_header.header
+ return rv
+
+ if isinstance(header_obj, dict):
+ data = _sign(JWSHeader.from_dict(header_obj))
+ data["payload"] = to_unicode(payload_segment)
+ return data
+
+ signatures = [_sign(JWSHeader.from_dict(h)) for h in header_obj]
+ return {"payload": to_unicode(payload_segment), "signatures": signatures}
+
+ def deserialize_json(self, obj, key, decode=None):
+ """Exact JWS JSON Serialization, and validate with the given key.
+ If key is not provided, it will return a dict without signature
+ verification. Header will still be validated. Via `Section 7.2`_.
+
+ :param obj: text of JWS JSON Serialization
+ :param key: key used to verify the signature
+ :param decode: a function to decode payload data
+ :return: JWSObject
+ :raise: BadSignatureError
+
+ .. _`Section 7.2`: https://tools.ietf.org/html/rfc7515#section-7.2
+ """
+ obj = ensure_dict(obj, "JWS")
+
+ payload_segment = obj.get("payload")
+ if payload_segment is None:
+ raise DecodeError('Missing "payload" value')
+
+ payload_segment = to_bytes(payload_segment)
+ payload = _extract_payload(payload_segment)
+ if decode:
+ payload = decode(payload)
+
+ if "signatures" not in obj:
+ # flattened JSON JWS
+ jws_header, valid = self._validate_json_jws(
+ payload_segment, payload, obj, key
+ )
+
+ rv = JWSObject(jws_header, payload, "flat")
+ if valid:
+ return rv
+ raise BadSignatureError(rv)
+
+ headers = []
+ is_valid = True
+ for header_obj in obj["signatures"]:
+ jws_header, valid = self._validate_json_jws(
+ payload_segment, payload, header_obj, key
+ )
+ headers.append(jws_header)
+ if not valid:
+ is_valid = False
+
+ rv = JWSObject(headers, payload, "json")
+ if is_valid:
+ return rv
+ raise BadSignatureError(rv)
+
+ def serialize(self, header, payload, key):
+ """Generate a JWS Serialization. It will automatically generate a
+ Compact or JSON Serialization depending on the given header. If a
+ header is in a JSON header format, it will call
+ :meth:`serialize_json`, otherwise it will call
+ :meth:`serialize_compact`.
+
+ :param header: A dict/list of header
+ :param payload: A string/dict of payload
+ :param key: Private key used to generate signature
+ :return: byte/dict
+ """
+ if isinstance(header, (list, tuple)):
+ return self.serialize_json(header, payload, key)
+ if "protected" in header:
+ return self.serialize_json(header, payload, key)
+ return self.serialize_compact(header, payload, key)
+
+ def deserialize(self, s, key, decode=None):
+ """Deserialize JWS Serialization, both compact and JSON format.
+ It will automatically deserialize depending on the given JWS.
+
+ :param s: text of JWS Compact/JSON Serialization
+ :param key: key used to verify the signature
+ :param decode: a function to decode payload data
+ :return: dict
+ :raise: BadSignatureError
+
+ If key is not provided, it will still deserialize the serialization
+ without verification.
+ """
+ if isinstance(s, dict):
+ return self.deserialize_json(s, key, decode)
+
+ s = to_bytes(s)
+ if s.startswith(b"{") and s.endswith(b"}"):
+ return self.deserialize_json(s, key, decode)
+ return self.deserialize_compact(s, key, decode)
+
+ def _prepare_algorithm_key(self, header, payload, key):
+ if "alg" not in header:
+ raise MissingAlgorithmError()
+
+ alg = header["alg"]
+ if self._algorithms is not None and alg not in self._algorithms:
+ raise UnsupportedAlgorithmError()
+ if alg not in self.ALGORITHMS_REGISTRY:
+ raise UnsupportedAlgorithmError()
+
+ algorithm = self.ALGORITHMS_REGISTRY[alg]
+ if callable(key):
+ key = key(header, payload)
+ elif key is None and "jwk" in header:
+ key = header["jwk"]
+ key = algorithm.prepare_key(key)
+ return algorithm, key
+
+ def _validate_private_headers(self, header):
+ # only validate private headers when developers set
+ # private headers explicitly
+ if self._private_headers is not None:
+ names = self.REGISTERED_HEADER_PARAMETER_NAMES.copy()
+ names = names.union(self._private_headers)
+
+ for k in header:
+ if k not in names:
+ raise InvalidHeaderParameterNameError(k)
+
+ def _reject_unprotected_crit(self, unprotected_header):
+ """Reject 'crit' when found in the unprotected header (RFC 7515 §4.1.11)."""
+ if unprotected_header and "crit" in unprotected_header:
+ raise InvalidHeaderParameterNameError("crit")
+
+ def _validate_crit_headers(self, header):
+ if "crit" in header:
+ crit_headers = header["crit"]
+ # Type enforcement for robustness and predictable errors
+ if not isinstance(crit_headers, list) or not all(
+ isinstance(x, str) for x in crit_headers
+ ):
+ raise InvalidHeaderParameterNameError("crit")
+ names = self.REGISTERED_HEADER_PARAMETER_NAMES.copy()
+ if self._private_headers:
+ names = names.union(self._private_headers)
+ for k in crit_headers:
+ if k not in names:
+ raise InvalidCritHeaderParameterNameError(k)
+ elif k not in header:
+ raise InvalidCritHeaderParameterNameError(k)
+
+ def _validate_json_jws(self, payload_segment, payload, header_obj, key):
+ protected_segment = header_obj.get("protected")
+ if not protected_segment:
+ raise DecodeError('Missing "protected" value')
+
+ signature_segment = header_obj.get("signature")
+ if not signature_segment:
+ raise DecodeError('Missing "signature" value')
+
+ protected_segment = to_bytes(protected_segment)
+ protected = _extract_header(protected_segment)
+ header = header_obj.get("header")
+ if header and not isinstance(header, dict):
+ raise DecodeError('Invalid "header" value')
+ # RFC 7515 §4.1.11: 'crit' MUST be integrity-protected. If present in
+ # the unprotected header object, reject the JWS.
+ self._reject_unprotected_crit(header)
+
+ # Enforce must-understand semantics for names listed in protected
+ # 'crit'. This will also ensure each listed name is present in the
+ # protected header.
+ self._validate_crit_headers(protected)
+ jws_header = JWSHeader(protected, header)
+ algorithm, key = self._prepare_algorithm_key(jws_header, payload, key)
+ signing_input = b".".join([protected_segment, payload_segment])
+ signature = _extract_signature(to_bytes(signature_segment))
+ if algorithm.verify(signing_input, signature, key):
+ return jws_header, True
+ return jws_header, False
+
+
+def _extract_header(header_segment):
+ return extract_header(header_segment, DecodeError)
+
+
+def _extract_signature(signature_segment):
+ return extract_segment(signature_segment, DecodeError, "signature")
+
+
+def _extract_payload(payload_segment):
+ return extract_segment(payload_segment, DecodeError, "payload")
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/models.py
new file mode 100644
index 00000000..d14fb641
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7515/models.py
@@ -0,0 +1,84 @@
+class JWSAlgorithm:
+ """Interface for JWS algorithm. JWA specification (RFC7518) SHOULD
+ implement the algorithms for JWS with this base implementation.
+ """
+
+ name = None
+ description = None
+ algorithm_type = "JWS"
+ algorithm_location = "alg"
+
+ def prepare_key(self, raw_data):
+ """Prepare key for signing and verifying signature."""
+ raise NotImplementedError()
+
+ def sign(self, msg, key):
+ """Sign the text msg with a private/sign key.
+
+ :param msg: message bytes to be signed
+ :param key: private key to sign the message
+ :return: bytes
+ """
+ raise NotImplementedError
+
+ def verify(self, msg, sig, key):
+ """Verify the signature of text msg with a public/verify key.
+
+ :param msg: message bytes to be signed
+ :param sig: result signature to be compared
+ :param key: public key to verify the signature
+ :return: boolean
+ """
+ raise NotImplementedError
+
+
+class JWSHeader(dict):
+ """Header object for JWS. It combine the protected header and unprotected
+ header together. JWSHeader itself is a dict of the combined dict. e.g.
+
+ >>> protected = {"alg": "HS256"}
+ >>> header = {"kid": "a"}
+ >>> jws_header = JWSHeader(protected, header)
+ >>> print(jws_header)
+ {'alg': 'HS256', 'kid': 'a'}
+ >>> jws_header.protected == protected
+ >>> jws_header.header == header
+
+ :param protected: dict of protected header
+ :param header: dict of unprotected header
+ """
+
+ def __init__(self, protected, header):
+ obj = {}
+ if header:
+ obj.update(header)
+ if protected:
+ obj.update(protected)
+ super().__init__(obj)
+ self.protected = protected
+ self.header = header
+
+ @classmethod
+ def from_dict(cls, obj):
+ if isinstance(obj, cls):
+ return obj
+ return cls(obj.get("protected"), obj.get("header"))
+
+
+class JWSObject(dict):
+ """A dict instance to represent a JWS object."""
+
+ def __init__(self, header, payload, type="compact"):
+ super().__init__(
+ header=header,
+ payload=payload,
+ )
+ self.header = header
+ self.payload = payload
+ self.type = type
+
+ @property
+ def headers(self):
+ """Alias of ``header`` for JSON typed JWS."""
+ if self.type == "json":
+ return self["header"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__init__.py
new file mode 100644
index 00000000..e38e1784
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__init__.py
@@ -0,0 +1,22 @@
+"""authlib.jose.rfc7516.
+~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+JSON Web Encryption (JWE).
+
+https://tools.ietf.org/html/rfc7516
+"""
+
+from .jwe import JsonWebEncryption
+from .models import JWEAlgorithm
+from .models import JWEAlgorithmWithTagAwareKeyAgreement
+from .models import JWEEncAlgorithm
+from .models import JWEZipAlgorithm
+
+__all__ = [
+ "JsonWebEncryption",
+ "JWEAlgorithm",
+ "JWEAlgorithmWithTagAwareKeyAgreement",
+ "JWEEncAlgorithm",
+ "JWEZipAlgorithm",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..39d6ecf6
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/jwe.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/jwe.cpython-312.pyc
new file mode 100644
index 00000000..ac5ce91b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/jwe.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..1f841aa8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/jwe.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/jwe.py
new file mode 100644
index 00000000..e58a7b7c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/jwe.py
@@ -0,0 +1,759 @@
+from collections import OrderedDict
+from copy import deepcopy
+
+from authlib.common.encoding import json_b64encode
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+from authlib.common.encoding import urlsafe_b64encode
+from authlib.jose.errors import DecodeError
+from authlib.jose.errors import InvalidAlgorithmForMultipleRecipientsMode
+from authlib.jose.errors import InvalidHeaderParameterNameError
+from authlib.jose.errors import KeyMismatchError
+from authlib.jose.errors import MissingAlgorithmError
+from authlib.jose.errors import MissingEncryptionAlgorithmError
+from authlib.jose.errors import UnsupportedAlgorithmError
+from authlib.jose.errors import UnsupportedCompressionAlgorithmError
+from authlib.jose.errors import UnsupportedEncryptionAlgorithmError
+from authlib.jose.rfc7516.models import JWEAlgorithmWithTagAwareKeyAgreement
+from authlib.jose.rfc7516.models import JWEHeader
+from authlib.jose.rfc7516.models import JWESharedHeader
+from authlib.jose.util import ensure_dict
+from authlib.jose.util import extract_header
+from authlib.jose.util import extract_segment
+
+
+class JsonWebEncryption:
+ #: Registered Header Parameter Names defined by Section 4.1
+ REGISTERED_HEADER_PARAMETER_NAMES = frozenset(
+ [
+ "alg",
+ "enc",
+ "zip",
+ "jku",
+ "jwk",
+ "kid",
+ "x5u",
+ "x5c",
+ "x5t",
+ "x5t#S256",
+ "typ",
+ "cty",
+ "crit",
+ ]
+ )
+
+ ALG_REGISTRY = {}
+ ENC_REGISTRY = {}
+ ZIP_REGISTRY = {}
+
+ def __init__(self, algorithms=None, private_headers=None):
+ self._algorithms = algorithms
+ self._private_headers = private_headers
+
+ @classmethod
+ def register_algorithm(cls, algorithm):
+ """Register an algorithm for ``alg`` or ``enc`` or ``zip`` of JWE."""
+ if not algorithm or algorithm.algorithm_type != "JWE":
+ raise ValueError(f"Invalid algorithm for JWE, {algorithm!r}")
+
+ if algorithm.algorithm_location == "alg":
+ cls.ALG_REGISTRY[algorithm.name] = algorithm
+ elif algorithm.algorithm_location == "enc":
+ cls.ENC_REGISTRY[algorithm.name] = algorithm
+ elif algorithm.algorithm_location == "zip":
+ cls.ZIP_REGISTRY[algorithm.name] = algorithm
+
+ def serialize_compact(self, protected, payload, key, sender_key=None):
+ """Generate a JWE Compact Serialization.
+
+ The JWE Compact Serialization represents encrypted content as a compact,
+ URL-safe string. This string is::
+
+ BASE64URL(UTF8(JWE Protected Header)) || '.' ||
+ BASE64URL(JWE Encrypted Key) || '.' ||
+ BASE64URL(JWE Initialization Vector) || '.' ||
+ BASE64URL(JWE Ciphertext) || '.' ||
+ BASE64URL(JWE Authentication Tag)
+
+ Only one recipient is supported by the JWE Compact Serialization and
+ it provides no syntax to represent JWE Shared Unprotected Header, JWE
+ Per-Recipient Unprotected Header, or JWE AAD values.
+
+ :param protected: A dict of protected header
+ :param payload: Payload (bytes or a value convertible to bytes)
+ :param key: Public key used to encrypt payload
+ :param sender_key: Sender's private key in case
+ JWEAlgorithmWithTagAwareKeyAgreement is used
+ :return: JWE compact serialization as bytes
+ """
+ # step 1: Prepare algorithms & key
+ alg = self.get_header_alg(protected)
+ enc = self.get_header_enc(protected)
+ zip_alg = self.get_header_zip(protected)
+
+ self._validate_sender_key(sender_key, alg)
+ self._validate_private_headers(protected, alg)
+
+ key = prepare_key(alg, protected, key)
+ if sender_key is not None:
+ sender_key = alg.prepare_key(sender_key)
+
+ # self._post_validate_header(protected, algorithm)
+
+ # step 2: Generate a random Content Encryption Key (CEK)
+ # use enc_alg.generate_cek() in scope of upcoming .wrap
+ # or .generate_keys_and_prepare_headers call
+
+ # step 3: Encrypt the CEK with the recipient's public key
+ if (
+ isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement)
+ and alg.key_size is not None
+ ):
+ # For a JWE algorithm with tag-aware key agreement in case key agreement
+ # with key wrapping mode is used:
+ # Defer key agreement with key wrapping until
+ # authentication tag is computed
+ prep = alg.generate_keys_and_prepare_headers(enc, key, sender_key)
+ epk = prep["epk"]
+ cek = prep["cek"]
+ protected.update(prep["header"])
+ else:
+ # In any other case:
+ # Keep the normal steps order defined by RFC 7516
+ if isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement):
+ wrapped = alg.wrap(enc, protected, key, sender_key)
+ else:
+ wrapped = alg.wrap(enc, protected, key)
+ cek = wrapped["cek"]
+ ek = wrapped["ek"]
+ if "header" in wrapped:
+ protected.update(wrapped["header"])
+
+ # step 4: Generate a random JWE Initialization Vector
+ iv = enc.generate_iv()
+
+ # step 5: Let the Additional Authenticated Data encryption parameter
+ # be ASCII(BASE64URL(UTF8(JWE Protected Header)))
+ protected_segment = json_b64encode(protected)
+ aad = to_bytes(protected_segment, "ascii")
+
+ # step 6: compress message if required
+ if zip_alg:
+ msg = zip_alg.compress(to_bytes(payload))
+ else:
+ msg = to_bytes(payload)
+
+ # step 7: perform encryption
+ ciphertext, tag = enc.encrypt(msg, aad, iv, cek)
+
+ if (
+ isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement)
+ and alg.key_size is not None
+ ):
+ # For a JWE algorithm with tag-aware key agreement in case key agreement
+ # with key wrapping mode is used:
+ # Perform key agreement with key wrapping deferred at step 3
+ wrapped = alg.agree_upon_key_and_wrap_cek(
+ enc, protected, key, sender_key, epk, cek, tag
+ )
+ ek = wrapped["ek"]
+
+ # step 8: build resulting message
+ return b".".join(
+ [
+ protected_segment,
+ urlsafe_b64encode(ek),
+ urlsafe_b64encode(iv),
+ urlsafe_b64encode(ciphertext),
+ urlsafe_b64encode(tag),
+ ]
+ )
+
+ def serialize_json(self, header_obj, payload, keys, sender_key=None): # noqa: C901
+ """Generate a JWE JSON Serialization (in fully general syntax).
+
+ The JWE JSON Serialization represents encrypted content as a JSON
+ object. This representation is neither optimized for compactness nor
+ URL safe.
+
+ The following members are defined for use in top-level JSON objects
+ used for the fully general JWE JSON Serialization syntax:
+
+ protected
+ The "protected" member MUST be present and contain the value
+ BASE64URL(UTF8(JWE Protected Header)) when the JWE Protected
+ Header value is non-empty; otherwise, it MUST be absent. These
+ Header Parameter values are integrity protected.
+
+ unprotected
+ The "unprotected" member MUST be present and contain the value JWE
+ Shared Unprotected Header when the JWE Shared Unprotected Header
+ value is non-empty; otherwise, it MUST be absent. This value is
+ represented as an unencoded JSON object, rather than as a string.
+ These Header Parameter values are not integrity protected.
+
+ iv
+ The "iv" member MUST be present and contain the value
+ BASE64URL(JWE Initialization Vector) when the JWE Initialization
+ Vector value is non-empty; otherwise, it MUST be absent.
+
+ aad
+ The "aad" member MUST be present and contain the value
+ BASE64URL(JWE AAD)) when the JWE AAD value is non-empty;
+ otherwise, it MUST be absent. A JWE AAD value can be included to
+ supply a base64url-encoded value to be integrity protected but not
+ encrypted.
+
+ ciphertext
+ The "ciphertext" member MUST be present and contain the value
+ BASE64URL(JWE Ciphertext).
+
+ tag
+ The "tag" member MUST be present and contain the value
+ BASE64URL(JWE Authentication Tag) when the JWE Authentication Tag
+ value is non-empty; otherwise, it MUST be absent.
+
+ recipients
+ The "recipients" member value MUST be an array of JSON objects.
+ Each object contains information specific to a single recipient.
+ This member MUST be present with exactly one array element per
+ recipient, even if some or all of the array element values are the
+ empty JSON object "{}" (which can happen when all Header Parameter
+ values are shared between all recipients and when no encrypted key
+ is used, such as when doing Direct Encryption).
+
+ The following members are defined for use in the JSON objects that
+ are elements of the "recipients" array:
+
+ header
+ The "header" member MUST be present and contain the value JWE Per-
+ Recipient Unprotected Header when the JWE Per-Recipient
+ Unprotected Header value is non-empty; otherwise, it MUST be
+ absent. This value is represented as an unencoded JSON object,
+ rather than as a string. These Header Parameter values are not
+ integrity protected.
+
+ encrypted_key
+ The "encrypted_key" member MUST be present and contain the value
+ BASE64URL(JWE Encrypted Key) when the JWE Encrypted Key value is
+ non-empty; otherwise, it MUST be absent.
+
+ This implementation assumes that "alg" and "enc" header fields are
+ contained in the protected or shared unprotected header.
+
+ :param header_obj: A dict of headers (in addition optionally contains JWE AAD)
+ :param payload: Payload (bytes or a value convertible to bytes)
+ :param keys: Public keys (or a single public key) used to encrypt payload
+ :param sender_key: Sender's private key in case
+ JWEAlgorithmWithTagAwareKeyAgreement is used
+ :return: JWE JSON serialization (in fully general syntax) as dict
+
+ Example of `header_obj`::
+
+ {
+ "protected": {
+ "alg": "ECDH-1PU+A128KW",
+ "enc": "A256CBC-HS512",
+ "apu": "QWxpY2U",
+ "apv": "Qm9iIGFuZCBDaGFybGll",
+ },
+ "unprotected": {"jku": "https://alice.example.com/keys.jwks"},
+ "recipients": [
+ {"header": {"kid": "bob-key-2"}},
+ {"header": {"kid": "2021-05-06"}},
+ ],
+ "aad": b"Authenticate me too.",
+ }
+ """
+ if not isinstance(keys, list): # single key
+ keys = [keys]
+
+ if not keys:
+ raise ValueError("No keys have been provided")
+
+ header_obj = deepcopy(header_obj)
+
+ shared_header = JWESharedHeader.from_dict(header_obj)
+
+ recipients = header_obj.get("recipients")
+ if recipients is None:
+ recipients = [{} for _ in keys]
+ for i in range(len(recipients)):
+ if recipients[i] is None:
+ recipients[i] = {}
+ if "header" not in recipients[i]:
+ recipients[i]["header"] = {}
+
+ jwe_aad = header_obj.get("aad")
+
+ if len(keys) != len(recipients):
+ raise ValueError(
+ f"Count of recipient keys {len(keys)} does not equal to count of recipients {len(recipients)}"
+ )
+
+ # step 1: Prepare algorithms & key
+ alg = self.get_header_alg(shared_header)
+ enc = self.get_header_enc(shared_header)
+ zip_alg = self.get_header_zip(shared_header)
+
+ self._validate_sender_key(sender_key, alg)
+ self._validate_private_headers(shared_header, alg)
+ for recipient in recipients:
+ self._validate_private_headers(recipient["header"], alg)
+
+ for i in range(len(keys)):
+ keys[i] = prepare_key(alg, recipients[i]["header"], keys[i])
+ if sender_key is not None:
+ sender_key = alg.prepare_key(sender_key)
+
+ # self._post_validate_header(protected, algorithm)
+
+ # step 2: Generate a random Content Encryption Key (CEK)
+ # use enc_alg.generate_cek() in scope of upcoming .wrap
+ # or .generate_keys_and_prepare_headers call
+
+ # step 3: Encrypt the CEK with the recipient's public key
+ preset = alg.generate_preset(enc, keys[0])
+ if "cek" in preset:
+ cek = preset["cek"]
+ else:
+ cek = None
+ if len(keys) > 1 and cek is None:
+ raise InvalidAlgorithmForMultipleRecipientsMode(alg.name)
+ if "header" in preset:
+ shared_header.update_protected(preset["header"])
+
+ if (
+ isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement)
+ and alg.key_size is not None
+ ):
+ # For a JWE algorithm with tag-aware key agreement in case key agreement
+ # with key wrapping mode is used:
+ # Defer key agreement with key wrapping until authentication tag is computed
+ epks = []
+ for i in range(len(keys)):
+ prep = alg.generate_keys_and_prepare_headers(
+ enc, keys[i], sender_key, preset
+ )
+ if cek is None:
+ cek = prep["cek"]
+ epks.append(prep["epk"])
+ recipients[i]["header"].update(prep["header"])
+ else:
+ # In any other case:
+ # Keep the normal steps order defined by RFC 7516
+ for i in range(len(keys)):
+ if isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement):
+ wrapped = alg.wrap(enc, shared_header, keys[i], sender_key, preset)
+ else:
+ wrapped = alg.wrap(enc, shared_header, keys[i], preset)
+ if cek is None:
+ cek = wrapped["cek"]
+ recipients[i]["encrypted_key"] = wrapped["ek"]
+ if "header" in wrapped:
+ recipients[i]["header"].update(wrapped["header"])
+
+ # step 4: Generate a random JWE Initialization Vector
+ iv = enc.generate_iv()
+
+ # step 5: Compute the Encoded Protected Header value
+ # BASE64URL(UTF8(JWE Protected Header)). If the JWE Protected Header
+ # is not present, let this value be the empty string.
+ # Let the Additional Authenticated Data encryption parameter be
+ # ASCII(Encoded Protected Header). However, if a JWE AAD value is
+ # present, instead let the Additional Authenticated Data encryption
+ # parameter be ASCII(Encoded Protected Header || '.' || BASE64URL(JWE AAD)).
+ aad = (
+ json_b64encode(shared_header.protected) if shared_header.protected else b""
+ )
+ if jwe_aad is not None:
+ aad += b"." + urlsafe_b64encode(jwe_aad)
+ aad = to_bytes(aad, "ascii")
+
+ # step 6: compress message if required
+ if zip_alg:
+ msg = zip_alg.compress(to_bytes(payload))
+ else:
+ msg = to_bytes(payload)
+
+ # step 7: perform encryption
+ ciphertext, tag = enc.encrypt(msg, aad, iv, cek)
+
+ if (
+ isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement)
+ and alg.key_size is not None
+ ):
+ # For a JWE algorithm with tag-aware key agreement in case key agreement
+ # with key wrapping mode is used:
+ # Perform key agreement with key wrapping deferred at step 3
+ for i in range(len(keys)):
+ wrapped = alg.agree_upon_key_and_wrap_cek(
+ enc, shared_header, keys[i], sender_key, epks[i], cek, tag
+ )
+ recipients[i]["encrypted_key"] = wrapped["ek"]
+
+ # step 8: build resulting message
+ obj = OrderedDict()
+
+ if shared_header.protected:
+ obj["protected"] = to_unicode(json_b64encode(shared_header.protected))
+
+ if shared_header.unprotected:
+ obj["unprotected"] = shared_header.unprotected
+
+ for recipient in recipients:
+ if not recipient["header"]:
+ del recipient["header"]
+ recipient["encrypted_key"] = to_unicode(
+ urlsafe_b64encode(recipient["encrypted_key"])
+ )
+ for member in set(recipient.keys()):
+ if member not in {"header", "encrypted_key"}:
+ del recipient[member]
+ obj["recipients"] = recipients
+
+ if jwe_aad is not None:
+ obj["aad"] = to_unicode(urlsafe_b64encode(jwe_aad))
+
+ obj["iv"] = to_unicode(urlsafe_b64encode(iv))
+
+ obj["ciphertext"] = to_unicode(urlsafe_b64encode(ciphertext))
+
+ obj["tag"] = to_unicode(urlsafe_b64encode(tag))
+
+ return obj
+
+ def serialize(self, header, payload, key, sender_key=None):
+ """Generate a JWE Serialization.
+
+ It will automatically generate a compact or JSON serialization depending
+ on `header` argument. If `header` is a dict with "protected",
+ "unprotected" and/or "recipients" keys, it will call `serialize_json`,
+ otherwise it will call `serialize_compact`.
+
+ :param header: A dict of header(s)
+ :param payload: Payload (bytes or a value convertible to bytes)
+ :param key: Public key(s) used to encrypt payload
+ :param sender_key: Sender's private key in case
+ JWEAlgorithmWithTagAwareKeyAgreement is used
+ :return: JWE compact serialization as bytes or
+ JWE JSON serialization as dict
+ """
+ if "protected" in header or "unprotected" in header or "recipients" in header:
+ return self.serialize_json(header, payload, key, sender_key)
+
+ return self.serialize_compact(header, payload, key, sender_key)
+
+ def deserialize_compact(self, s, key, decode=None, sender_key=None):
+ """Extract JWE Compact Serialization.
+
+ :param s: JWE Compact Serialization as bytes
+ :param key: Private key used to decrypt payload
+ (optionally can be a tuple of kid and essentially key)
+ :param decode: Function to decode payload data
+ :param sender_key: Sender's public key in case
+ JWEAlgorithmWithTagAwareKeyAgreement is used
+ :return: dict with `header` and `payload` keys where `header` value is
+ a dict containing protected header fields
+ """
+ try:
+ s = to_bytes(s)
+ protected_s, ek_s, iv_s, ciphertext_s, tag_s = s.rsplit(b".")
+ except ValueError as exc:
+ raise DecodeError("Not enough segments") from exc
+
+ protected = extract_header(protected_s, DecodeError)
+ ek = extract_segment(ek_s, DecodeError, "encryption key")
+ iv = extract_segment(iv_s, DecodeError, "initialization vector")
+ ciphertext = extract_segment(ciphertext_s, DecodeError, "ciphertext")
+ tag = extract_segment(tag_s, DecodeError, "authentication tag")
+
+ alg = self.get_header_alg(protected)
+ enc = self.get_header_enc(protected)
+ zip_alg = self.get_header_zip(protected)
+
+ self._validate_sender_key(sender_key, alg)
+ self._validate_private_headers(protected, alg)
+
+ if isinstance(key, tuple) and len(key) == 2:
+ # Ignore separately provided kid, extract essentially key only
+ key = key[1]
+
+ key = prepare_key(alg, protected, key)
+
+ if sender_key is not None:
+ sender_key = alg.prepare_key(sender_key)
+
+ if isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement):
+ # For a JWE algorithm with tag-aware key agreement:
+ if alg.key_size is not None:
+ # In case key agreement with key wrapping mode is used:
+ # Provide authentication tag to .unwrap method
+ cek = alg.unwrap(enc, ek, protected, key, sender_key, tag)
+ else:
+ # Otherwise, don't provide authentication tag to .unwrap method
+ cek = alg.unwrap(enc, ek, protected, key, sender_key)
+ else:
+ # For any other JWE algorithm:
+ # Don't provide authentication tag to .unwrap method
+ cek = alg.unwrap(enc, ek, protected, key)
+
+ aad = to_bytes(protected_s, "ascii")
+ msg = enc.decrypt(ciphertext, aad, iv, tag, cek)
+
+ if zip_alg:
+ payload = zip_alg.decompress(to_bytes(msg))
+ else:
+ payload = msg
+
+ if decode:
+ payload = decode(payload)
+ return {"header": protected, "payload": payload}
+
+ def deserialize_json(self, obj, key, decode=None, sender_key=None): # noqa: C901
+ """Extract JWE JSON Serialization.
+
+ :param obj: JWE JSON Serialization as dict or str
+ :param key: Private key used to decrypt payload
+ (optionally can be a tuple of kid and essentially key)
+ :param decode: Function to decode payload data
+ :param sender_key: Sender's public key in case
+ JWEAlgorithmWithTagAwareKeyAgreement is used
+ :return: dict with `header` and `payload` keys where `header` value is
+ a dict containing `protected`, `unprotected`, `recipients` and/or
+ `aad` keys
+ """
+ obj = ensure_dict(obj, "JWE")
+ obj = deepcopy(obj)
+
+ if "protected" in obj:
+ protected = extract_header(to_bytes(obj["protected"]), DecodeError)
+ else:
+ protected = None
+
+ unprotected = obj.get("unprotected")
+
+ recipients = obj["recipients"]
+ for recipient in recipients:
+ if "header" not in recipient:
+ recipient["header"] = {}
+ recipient["encrypted_key"] = extract_segment(
+ to_bytes(recipient["encrypted_key"]), DecodeError, "encrypted key"
+ )
+
+ if "aad" in obj:
+ jwe_aad = extract_segment(to_bytes(obj["aad"]), DecodeError, "JWE AAD")
+ else:
+ jwe_aad = None
+
+ iv = extract_segment(to_bytes(obj["iv"]), DecodeError, "initialization vector")
+
+ ciphertext = extract_segment(
+ to_bytes(obj["ciphertext"]), DecodeError, "ciphertext"
+ )
+
+ tag = extract_segment(to_bytes(obj["tag"]), DecodeError, "authentication tag")
+
+ shared_header = JWESharedHeader(protected, unprotected)
+
+ alg = self.get_header_alg(shared_header)
+ enc = self.get_header_enc(shared_header)
+ zip_alg = self.get_header_zip(shared_header)
+
+ self._validate_sender_key(sender_key, alg)
+ self._validate_private_headers(shared_header, alg)
+ for recipient in recipients:
+ self._validate_private_headers(recipient["header"], alg)
+
+ kid = None
+ if isinstance(key, tuple) and len(key) == 2:
+ # Extract separately provided kid and essentially key
+ kid = key[0]
+ key = key[1]
+
+ key = alg.prepare_key(key)
+
+ if kid is None:
+ # If kid has not been provided separately, try to get it from key itself
+ kid = key.kid
+
+ if sender_key is not None:
+ sender_key = alg.prepare_key(sender_key)
+
+ def _unwrap_with_sender_key_and_tag(ek, header):
+ return alg.unwrap(enc, ek, header, key, sender_key, tag)
+
+ def _unwrap_with_sender_key_and_without_tag(ek, header):
+ return alg.unwrap(enc, ek, header, key, sender_key)
+
+ def _unwrap_without_sender_key_and_tag(ek, header):
+ return alg.unwrap(enc, ek, header, key)
+
+ def _unwrap_for_matching_recipient(unwrap_func):
+ if kid is not None:
+ for recipient in recipients:
+ if recipient["header"].get("kid") == kid:
+ header = JWEHeader(protected, unprotected, recipient["header"])
+ return unwrap_func(recipient["encrypted_key"], header)
+
+ # Since no explicit match has been found, iterate over all the recipients
+ error = None
+ for recipient in recipients:
+ header = JWEHeader(protected, unprotected, recipient["header"])
+ try:
+ return unwrap_func(recipient["encrypted_key"], header)
+ except Exception as e:
+ error = e
+ else:
+ if error is None:
+ raise KeyMismatchError()
+ else:
+ raise error
+
+ if isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement):
+ # For a JWE algorithm with tag-aware key agreement:
+ if alg.key_size is not None:
+ # In case key agreement with key wrapping mode is used:
+ # Provide authentication tag to .unwrap method
+ cek = _unwrap_for_matching_recipient(_unwrap_with_sender_key_and_tag)
+ else:
+ # Otherwise, don't provide authentication tag to .unwrap method
+ cek = _unwrap_for_matching_recipient(
+ _unwrap_with_sender_key_and_without_tag
+ )
+ else:
+ # For any other JWE algorithm:
+ # Don't provide authentication tag to .unwrap method
+ cek = _unwrap_for_matching_recipient(_unwrap_without_sender_key_and_tag)
+
+ aad = to_bytes(obj.get("protected", ""))
+ if "aad" in obj:
+ aad += b"." + to_bytes(obj["aad"])
+ aad = to_bytes(aad, "ascii")
+
+ msg = enc.decrypt(ciphertext, aad, iv, tag, cek)
+
+ if zip_alg:
+ payload = zip_alg.decompress(to_bytes(msg))
+ else:
+ payload = msg
+
+ if decode:
+ payload = decode(payload)
+
+ for recipient in recipients:
+ if not recipient["header"]:
+ del recipient["header"]
+ for member in set(recipient.keys()):
+ if member != "header":
+ del recipient[member]
+
+ header = {}
+ if protected:
+ header["protected"] = protected
+ if unprotected:
+ header["unprotected"] = unprotected
+ header["recipients"] = recipients
+ if jwe_aad is not None:
+ header["aad"] = jwe_aad
+
+ return {"header": header, "payload": payload}
+
+ def deserialize(self, obj, key, decode=None, sender_key=None):
+ """Extract a JWE Serialization.
+
+ It supports both compact and JSON serialization.
+
+ :param obj: JWE compact serialization as bytes or
+ JWE JSON serialization as dict or str
+ :param key: Private key used to decrypt payload
+ (optionally can be a tuple of kid and essentially key)
+ :param decode: Function to decode payload data
+ :param sender_key: Sender's public key in case
+ JWEAlgorithmWithTagAwareKeyAgreement is used
+ :return: dict with `header` and `payload` keys
+ """
+ if isinstance(obj, dict):
+ return self.deserialize_json(obj, key, decode, sender_key)
+
+ obj = to_bytes(obj)
+ if obj.startswith(b"{") and obj.endswith(b"}"):
+ return self.deserialize_json(obj, key, decode, sender_key)
+
+ return self.deserialize_compact(obj, key, decode, sender_key)
+
+ @staticmethod
+ def parse_json(obj):
+ """Parse JWE JSON Serialization.
+
+ :param obj: JWE JSON Serialization as str or dict
+ :return: Parsed JWE JSON Serialization as dict if `obj` is an str,
+ or `obj` as is if `obj` is already a dict
+ """
+ return ensure_dict(obj, "JWE")
+
+ def get_header_alg(self, header):
+ if "alg" not in header:
+ raise MissingAlgorithmError()
+
+ alg = header["alg"]
+ if self._algorithms is not None and alg not in self._algorithms:
+ raise UnsupportedAlgorithmError()
+ if alg not in self.ALG_REGISTRY:
+ raise UnsupportedAlgorithmError()
+ return self.ALG_REGISTRY[alg]
+
+ def get_header_enc(self, header):
+ if "enc" not in header:
+ raise MissingEncryptionAlgorithmError()
+ enc = header["enc"]
+ if self._algorithms is not None and enc not in self._algorithms:
+ raise UnsupportedEncryptionAlgorithmError()
+ if enc not in self.ENC_REGISTRY:
+ raise UnsupportedEncryptionAlgorithmError()
+ return self.ENC_REGISTRY[enc]
+
+ def get_header_zip(self, header):
+ if "zip" in header:
+ z = header["zip"]
+ if self._algorithms is not None and z not in self._algorithms:
+ raise UnsupportedCompressionAlgorithmError()
+ if z not in self.ZIP_REGISTRY:
+ raise UnsupportedCompressionAlgorithmError()
+ return self.ZIP_REGISTRY[z]
+
+ def _validate_sender_key(self, sender_key, alg):
+ if isinstance(alg, JWEAlgorithmWithTagAwareKeyAgreement):
+ if sender_key is None:
+ raise ValueError(
+ f"{alg.name} algorithm requires sender_key but passed sender_key value is None"
+ )
+ else:
+ if sender_key is not None:
+ raise ValueError(
+ f"{alg.name} algorithm does not use sender_key but passed sender_key value is not None"
+ )
+
+ def _validate_private_headers(self, header, alg):
+ # only validate private headers when developers set
+ # private headers explicitly
+ if self._private_headers is None:
+ return
+
+ names = self.REGISTERED_HEADER_PARAMETER_NAMES.copy()
+ names = names.union(self._private_headers)
+
+ if alg.EXTRA_HEADERS:
+ names = names.union(alg.EXTRA_HEADERS)
+
+ for k in header:
+ if k not in names:
+ raise InvalidHeaderParameterNameError(k)
+
+
+def prepare_key(alg, header, key):
+ if callable(key):
+ key = key(header, None)
+ elif key is None and "jwk" in header:
+ key = header["jwk"]
+ return alg.prepare_key(key)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/models.py
new file mode 100644
index 00000000..2bcca8c8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7516/models.py
@@ -0,0 +1,157 @@
+import os
+from abc import ABCMeta
+
+
+class JWEAlgorithmBase(metaclass=ABCMeta): # noqa: B024
+ """Base interface for all JWE algorithms."""
+
+ EXTRA_HEADERS = None
+
+ name = None
+ description = None
+ algorithm_type = "JWE"
+ algorithm_location = "alg"
+
+ def prepare_key(self, raw_data):
+ raise NotImplementedError
+
+ def generate_preset(self, enc_alg, key):
+ raise NotImplementedError
+
+
+class JWEAlgorithm(JWEAlgorithmBase, metaclass=ABCMeta):
+ """Interface for JWE algorithm conforming to RFC7518.
+ JWA specification (RFC7518) SHOULD implement the algorithms for JWE
+ with this base implementation.
+ """
+
+ def wrap(self, enc_alg, headers, key, preset=None):
+ raise NotImplementedError
+
+ def unwrap(self, enc_alg, ek, headers, key):
+ raise NotImplementedError
+
+
+class JWEAlgorithmWithTagAwareKeyAgreement(JWEAlgorithmBase, metaclass=ABCMeta):
+ """Interface for JWE algorithm with tag-aware key agreement (in key agreement
+ with key wrapping mode).
+ ECDH-1PU is an example of such an algorithm.
+ """
+
+ def generate_keys_and_prepare_headers(self, enc_alg, key, sender_key, preset=None):
+ raise NotImplementedError
+
+ def agree_upon_key_and_wrap_cek(
+ self, enc_alg, headers, key, sender_key, epk, cek, tag
+ ):
+ raise NotImplementedError
+
+ def wrap(self, enc_alg, headers, key, sender_key, preset=None):
+ raise NotImplementedError
+
+ def unwrap(self, enc_alg, ek, headers, key, sender_key, tag=None):
+ raise NotImplementedError
+
+
+class JWEEncAlgorithm:
+ name = None
+ description = None
+ algorithm_type = "JWE"
+ algorithm_location = "enc"
+
+ IV_SIZE = None
+ CEK_SIZE = None
+
+ def generate_cek(self):
+ return os.urandom(self.CEK_SIZE // 8)
+
+ def generate_iv(self):
+ return os.urandom(self.IV_SIZE // 8)
+
+ def check_iv(self, iv):
+ if len(iv) * 8 != self.IV_SIZE:
+ raise ValueError('Invalid "iv" size')
+
+ def encrypt(self, msg, aad, iv, key):
+ """Encrypt the given "msg" text.
+
+ :param msg: text to be encrypt in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param key: encrypted key in bytes
+ :return: (ciphertext, tag)
+ """
+ raise NotImplementedError
+
+ def decrypt(self, ciphertext, aad, iv, tag, key):
+ """Decrypt the given cipher text.
+
+ :param ciphertext: ciphertext in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param tag: authentication tag in bytes
+ :param key: encrypted key in bytes
+ :return: message
+ """
+ raise NotImplementedError
+
+
+class JWEZipAlgorithm:
+ name = None
+ description = None
+ algorithm_type = "JWE"
+ algorithm_location = "zip"
+
+ def compress(self, s):
+ raise NotImplementedError
+
+ def decompress(self, s):
+ raise NotImplementedError
+
+
+class JWESharedHeader(dict):
+ """Shared header object for JWE.
+
+ Combines protected header and shared unprotected header together.
+ """
+
+ def __init__(self, protected, unprotected):
+ obj = {}
+ if unprotected:
+ obj.update(unprotected)
+ if protected:
+ obj.update(protected)
+ super().__init__(obj)
+ self.protected = protected if protected else {}
+ self.unprotected = unprotected if unprotected else {}
+
+ def update_protected(self, addition):
+ self.update(addition)
+ self.protected.update(addition)
+
+ @classmethod
+ def from_dict(cls, obj):
+ if isinstance(obj, cls):
+ return obj
+ return cls(obj.get("protected"), obj.get("unprotected"))
+
+
+class JWEHeader(dict):
+ """Header object for JWE.
+
+ Combines protected header, shared unprotected header
+ and specific recipient's unprotected header together.
+ """
+
+ def __init__(self, protected, unprotected, header):
+ obj = {}
+ if unprotected:
+ obj.update(unprotected)
+ if header:
+ obj.update(header)
+ if protected:
+ obj.update(protected)
+ super().__init__(obj)
+ self.protected = protected if protected else {}
+ self.unprotected = unprotected if unprotected else {}
+ self.header = header if header else {}
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__init__.py
new file mode 100644
index 00000000..2f41e3b5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__init__.py
@@ -0,0 +1,16 @@
+"""authlib.jose.rfc7517.
+~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+JSON Web Key (JWK).
+
+https://tools.ietf.org/html/rfc7517
+"""
+
+from ._cryptography_key import load_pem_key
+from .asymmetric_key import AsymmetricKey
+from .base_key import Key
+from .jwk import JsonWebKey
+from .key_set import KeySet
+
+__all__ = ["Key", "AsymmetricKey", "KeySet", "JsonWebKey", "load_pem_key"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..816552e4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/_cryptography_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/_cryptography_key.cpython-312.pyc
new file mode 100644
index 00000000..dc14b794
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/_cryptography_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/asymmetric_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/asymmetric_key.cpython-312.pyc
new file mode 100644
index 00000000..99fd7865
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/asymmetric_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/base_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/base_key.cpython-312.pyc
new file mode 100644
index 00000000..d6424e7f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/base_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/jwk.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/jwk.cpython-312.pyc
new file mode 100644
index 00000000..a5f57ad5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/jwk.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/key_set.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/key_set.cpython-312.pyc
new file mode 100644
index 00000000..1bf244da
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/__pycache__/key_set.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/_cryptography_key.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/_cryptography_key.py
new file mode 100644
index 00000000..ad16e9e5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/_cryptography_key.py
@@ -0,0 +1,35 @@
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives.serialization import load_pem_private_key
+from cryptography.hazmat.primitives.serialization import load_pem_public_key
+from cryptography.hazmat.primitives.serialization import load_ssh_public_key
+from cryptography.x509 import load_pem_x509_certificate
+
+from authlib.common.encoding import to_bytes
+
+
+def load_pem_key(raw, ssh_type=None, key_type=None, password=None):
+ raw = to_bytes(raw)
+
+ if ssh_type and raw.startswith(ssh_type):
+ return load_ssh_public_key(raw, backend=default_backend())
+
+ if key_type == "public":
+ return load_pem_public_key(raw, backend=default_backend())
+
+ if key_type == "private" or password is not None:
+ return load_pem_private_key(raw, password=password, backend=default_backend())
+
+ if b"PUBLIC" in raw:
+ return load_pem_public_key(raw, backend=default_backend())
+
+ if b"PRIVATE" in raw:
+ return load_pem_private_key(raw, password=password, backend=default_backend())
+
+ if b"CERTIFICATE" in raw:
+ cert = load_pem_x509_certificate(raw, default_backend())
+ return cert.public_key()
+
+ try:
+ return load_pem_private_key(raw, password=password, backend=default_backend())
+ except ValueError:
+ return load_pem_public_key(raw, backend=default_backend())
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/asymmetric_key.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/asymmetric_key.py
new file mode 100644
index 00000000..571c851e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/asymmetric_key.py
@@ -0,0 +1,196 @@
+from cryptography.hazmat.primitives.serialization import BestAvailableEncryption
+from cryptography.hazmat.primitives.serialization import Encoding
+from cryptography.hazmat.primitives.serialization import NoEncryption
+from cryptography.hazmat.primitives.serialization import PrivateFormat
+from cryptography.hazmat.primitives.serialization import PublicFormat
+
+from authlib.common.encoding import to_bytes
+
+from ._cryptography_key import load_pem_key
+from .base_key import Key
+
+
+class AsymmetricKey(Key):
+ """This is the base class for a JSON Web Key."""
+
+ PUBLIC_KEY_FIELDS = []
+ PRIVATE_KEY_FIELDS = []
+ PRIVATE_KEY_CLS = bytes
+ PUBLIC_KEY_CLS = bytes
+ SSH_PUBLIC_PREFIX = b""
+
+ def __init__(self, private_key=None, public_key=None, options=None):
+ super().__init__(options)
+ self.private_key = private_key
+ self.public_key = public_key
+
+ @property
+ def public_only(self):
+ if self.private_key:
+ return False
+ if "d" in self.tokens:
+ return False
+ return True
+
+ def get_op_key(self, operation):
+ """Get the raw key for the given key_op. This method will also
+ check if the given key_op is supported by this key.
+
+ :param operation: key operation value, such as "sign", "encrypt".
+ :return: raw key
+ """
+ self.check_key_op(operation)
+ if operation in self.PUBLIC_KEY_OPS:
+ return self.get_public_key()
+ return self.get_private_key()
+
+ def get_public_key(self):
+ if self.public_key:
+ return self.public_key
+
+ private_key = self.get_private_key()
+ if private_key:
+ return private_key.public_key()
+
+ return self.public_key
+
+ def get_private_key(self):
+ if self.private_key:
+ return self.private_key
+
+ if self.tokens:
+ self.load_raw_key()
+ return self.private_key
+
+ def load_raw_key(self):
+ if "d" in self.tokens:
+ self.private_key = self.load_private_key()
+ else:
+ self.public_key = self.load_public_key()
+
+ def load_dict_key(self):
+ if self.private_key:
+ self._dict_data.update(self.dumps_private_key())
+ else:
+ self._dict_data.update(self.dumps_public_key())
+
+ def dumps_private_key(self):
+ raise NotImplementedError()
+
+ def dumps_public_key(self):
+ raise NotImplementedError()
+
+ def load_private_key(self):
+ raise NotImplementedError()
+
+ def load_public_key(self):
+ raise NotImplementedError()
+
+ def as_dict(self, is_private=False, **params):
+ """Represent this key as a dict of the JSON Web Key."""
+ tokens = self.tokens
+ if is_private and "d" not in tokens:
+ raise ValueError("This is a public key")
+
+ kid = tokens.get("kid")
+ if "d" in tokens and not is_private:
+ # filter out private fields
+ tokens = {k: tokens[k] for k in tokens if k in self.PUBLIC_KEY_FIELDS}
+ tokens["kty"] = self.kty
+ if kid:
+ tokens["kid"] = kid
+
+ if not kid:
+ tokens["kid"] = self.thumbprint()
+
+ tokens.update(params)
+ return tokens
+
+ def as_key(self, is_private=False):
+ """Represent this key as raw key."""
+ if is_private:
+ return self.get_private_key()
+ return self.get_public_key()
+
+ def as_bytes(self, encoding=None, is_private=False, password=None):
+ """Export key into PEM/DER format bytes.
+
+ :param encoding: "PEM" or "DER"
+ :param is_private: export private key or public key
+ :param password: encrypt private key with password
+ :return: bytes
+ """
+ if encoding is None or encoding == "PEM":
+ encoding = Encoding.PEM
+ elif encoding == "DER":
+ encoding = Encoding.DER
+ else:
+ raise ValueError(f"Invalid encoding: {encoding!r}")
+
+ raw_key = self.as_key(is_private)
+ if is_private:
+ if not raw_key:
+ raise ValueError("This is a public key")
+ if password is None:
+ encryption_algorithm = NoEncryption()
+ else:
+ encryption_algorithm = BestAvailableEncryption(to_bytes(password))
+ return raw_key.private_bytes(
+ encoding=encoding,
+ format=PrivateFormat.PKCS8,
+ encryption_algorithm=encryption_algorithm,
+ )
+ return raw_key.public_bytes(
+ encoding=encoding,
+ format=PublicFormat.SubjectPublicKeyInfo,
+ )
+
+ def as_pem(self, is_private=False, password=None):
+ return self.as_bytes(is_private=is_private, password=password)
+
+ def as_der(self, is_private=False, password=None):
+ return self.as_bytes(encoding="DER", is_private=is_private, password=password)
+
+ @classmethod
+ def import_dict_key(cls, raw, options=None):
+ cls.check_required_fields(raw)
+ key = cls(options=options)
+ key._dict_data = raw
+ return key
+
+ @classmethod
+ def import_key(cls, raw, options=None):
+ if isinstance(raw, cls):
+ if options is not None:
+ raw.options.update(options)
+ return raw
+
+ if isinstance(raw, cls.PUBLIC_KEY_CLS):
+ key = cls(public_key=raw, options=options)
+ elif isinstance(raw, cls.PRIVATE_KEY_CLS):
+ key = cls(private_key=raw, options=options)
+ elif isinstance(raw, dict):
+ key = cls.import_dict_key(raw, options)
+ else:
+ if options is not None:
+ password = options.pop("password", None)
+ else:
+ password = None
+ raw_key = load_pem_key(raw, cls.SSH_PUBLIC_PREFIX, password=password)
+ if isinstance(raw_key, cls.PUBLIC_KEY_CLS):
+ key = cls(public_key=raw_key, options=options)
+ elif isinstance(raw_key, cls.PRIVATE_KEY_CLS):
+ key = cls(private_key=raw_key, options=options)
+ else:
+ raise ValueError("Invalid data for importing key")
+ return key
+
+ @classmethod
+ def validate_raw_key(cls, key):
+ return isinstance(key, cls.PUBLIC_KEY_CLS) or isinstance(
+ key, cls.PRIVATE_KEY_CLS
+ )
+
+ @classmethod
+ def generate_key(cls, crv_or_size, options=None, is_private=False):
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/base_key.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/base_key.py
new file mode 100644
index 00000000..0baa62c6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/base_key.py
@@ -0,0 +1,120 @@
+import hashlib
+from collections import OrderedDict
+
+from authlib.common.encoding import json_dumps
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+from authlib.common.encoding import urlsafe_b64encode
+
+from ..errors import InvalidUseError
+
+
+class Key:
+ """This is the base class for a JSON Web Key."""
+
+ kty = "_"
+
+ ALLOWED_PARAMS = ["use", "key_ops", "alg", "kid", "x5u", "x5c", "x5t", "x5t#S256"]
+
+ PRIVATE_KEY_OPS = [
+ "sign",
+ "decrypt",
+ "unwrapKey",
+ ]
+ PUBLIC_KEY_OPS = [
+ "verify",
+ "encrypt",
+ "wrapKey",
+ ]
+
+ REQUIRED_JSON_FIELDS = []
+
+ def __init__(self, options=None):
+ self.options = options or {}
+ self._dict_data = {}
+
+ @property
+ def tokens(self):
+ if not self._dict_data:
+ self.load_dict_key()
+
+ rv = dict(self._dict_data)
+ rv["kty"] = self.kty
+ for k in self.ALLOWED_PARAMS:
+ if k not in rv and k in self.options:
+ rv[k] = self.options[k]
+ return rv
+
+ @property
+ def kid(self):
+ return self.tokens.get("kid")
+
+ def keys(self):
+ return self.tokens.keys()
+
+ def __getitem__(self, item):
+ return self.tokens[item]
+
+ @property
+ def public_only(self):
+ raise NotImplementedError()
+
+ def load_raw_key(self):
+ raise NotImplementedError()
+
+ def load_dict_key(self):
+ raise NotImplementedError()
+
+ def check_key_op(self, operation):
+ """Check if the given key_op is supported by this key.
+
+ :param operation: key operation value, such as "sign", "encrypt".
+ :raise: ValueError
+ """
+ key_ops = self.tokens.get("key_ops")
+ if key_ops is not None and operation not in key_ops:
+ raise ValueError(f'Unsupported key_op "{operation}"')
+
+ if operation in self.PRIVATE_KEY_OPS and self.public_only:
+ raise ValueError(f'Invalid key_op "{operation}" for public key')
+
+ use = self.tokens.get("use")
+ if use:
+ if operation in ["sign", "verify"]:
+ if use != "sig":
+ raise InvalidUseError()
+ elif operation in ["decrypt", "encrypt", "wrapKey", "unwrapKey"]:
+ if use != "enc":
+ raise InvalidUseError()
+
+ def as_dict(self, is_private=False, **params):
+ raise NotImplementedError()
+
+ def as_json(self, is_private=False, **params):
+ """Represent this key as a JSON string."""
+ obj = self.as_dict(is_private, **params)
+ return json_dumps(obj)
+
+ def thumbprint(self):
+ """Implementation of RFC7638 JSON Web Key (JWK) Thumbprint."""
+ fields = list(self.REQUIRED_JSON_FIELDS)
+ fields.append("kty")
+ fields.sort()
+ data = OrderedDict()
+
+ for k in fields:
+ data[k] = self.tokens[k]
+
+ json_data = json_dumps(data)
+ digest_data = hashlib.sha256(to_bytes(json_data)).digest()
+ return to_unicode(urlsafe_b64encode(digest_data))
+
+ @classmethod
+ def check_required_fields(cls, data):
+ for k in cls.REQUIRED_JSON_FIELDS:
+ if k not in data:
+ raise ValueError(f'Missing required field: "{k}"')
+
+ @classmethod
+ def validate_raw_key(cls, key):
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/jwk.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/jwk.py
new file mode 100644
index 00000000..034691d2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/jwk.py
@@ -0,0 +1,64 @@
+from authlib.common.encoding import json_loads
+
+from ._cryptography_key import load_pem_key
+from .key_set import KeySet
+
+
+class JsonWebKey:
+ JWK_KEY_CLS = {}
+
+ @classmethod
+ def generate_key(cls, kty, crv_or_size, options=None, is_private=False):
+ """Generate a Key with the given key type, curve name or bit size.
+
+ :param kty: string of ``oct``, ``RSA``, ``EC``, ``OKP``
+ :param crv_or_size: curve name or bit size
+ :param options: a dict of other options for Key
+ :param is_private: create a private key or public key
+ :return: Key instance
+ """
+ key_cls = cls.JWK_KEY_CLS[kty]
+ return key_cls.generate_key(crv_or_size, options, is_private)
+
+ @classmethod
+ def import_key(cls, raw, options=None):
+ """Import a Key from bytes, string, PEM or dict.
+
+ :return: Key instance
+ """
+ kty = None
+ if options is not None:
+ kty = options.get("kty")
+
+ if kty is None and isinstance(raw, dict):
+ kty = raw.get("kty")
+
+ if kty is None:
+ raw_key = load_pem_key(raw)
+ for _kty in cls.JWK_KEY_CLS:
+ key_cls = cls.JWK_KEY_CLS[_kty]
+ if key_cls.validate_raw_key(raw_key):
+ return key_cls.import_key(raw_key, options)
+
+ key_cls = cls.JWK_KEY_CLS[kty]
+ return key_cls.import_key(raw, options)
+
+ @classmethod
+ def import_key_set(cls, raw):
+ """Import KeySet from string, dict or a list of keys.
+
+ :return: KeySet instance
+ """
+ raw = _transform_raw_key(raw)
+ if isinstance(raw, dict) and "keys" in raw:
+ keys = raw.get("keys")
+ return KeySet([cls.import_key(k) for k in keys])
+ raise ValueError("Invalid key set format")
+
+
+def _transform_raw_key(raw):
+ if isinstance(raw, str) and raw.startswith("{") and raw.endswith("}"):
+ return json_loads(raw)
+ elif isinstance(raw, (tuple, list)):
+ return {"keys": raw}
+ return raw
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/key_set.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/key_set.py
new file mode 100644
index 00000000..bd8fa691
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7517/key_set.py
@@ -0,0 +1,53 @@
+from authlib.common.encoding import json_dumps
+
+
+class KeySet:
+ """This class represents a JSON Web Key Set."""
+
+ def __init__(self, keys):
+ self.keys = keys
+
+ def as_dict(self, is_private=False, **params):
+ """Represent this key as a dict of the JSON Web Key Set."""
+ return {"keys": [k.as_dict(is_private, **params) for k in self.keys]}
+
+ def as_json(self, is_private=False, **params):
+ """Represent this key set as a JSON string."""
+ obj = self.as_dict(is_private, **params)
+ return json_dumps(obj)
+
+ def find_by_kid(self, kid, **params):
+ """Find the key matches the given kid value.
+
+ :param kid: A string of kid
+ :return: Key instance
+ :raise: ValueError
+ """
+ # Proposed fix, feel free to do something else but the idea is that we take the only key
+ # of the set if no kid is specified
+ if kid is None and len(self.keys) == 1:
+ return self.keys[0]
+
+ keys = [key for key in self.keys if key.kid == kid]
+ if params:
+ keys = list(_filter_keys_by_params(keys, **params))
+
+ if keys:
+ return keys[0]
+ raise ValueError("Key not found")
+
+
+def _filter_keys_by_params(keys, **params):
+ _use = params.get("use")
+ _alg = params.get("alg")
+
+ for key in keys:
+ designed_use = key.tokens.get("use")
+ if designed_use and _use and designed_use != _use:
+ continue
+
+ designed_alg = key.tokens.get("alg")
+ if designed_alg and _alg and designed_alg != _alg:
+ continue
+
+ yield key
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__init__.py
new file mode 100644
index 00000000..9b9dbcb7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__init__.py
@@ -0,0 +1,39 @@
+from .ec_key import ECKey
+from .jwe_algs import JWE_ALG_ALGORITHMS
+from .jwe_algs import AESAlgorithm
+from .jwe_algs import ECDHESAlgorithm
+from .jwe_algs import u32be_len_input
+from .jwe_encs import JWE_ENC_ALGORITHMS
+from .jwe_encs import CBCHS2EncAlgorithm
+from .jwe_zips import DeflateZipAlgorithm
+from .jws_algs import JWS_ALGORITHMS
+from .oct_key import OctKey
+from .rsa_key import RSAKey
+
+
+def register_jws_rfc7518(cls):
+ for algorithm in JWS_ALGORITHMS:
+ cls.register_algorithm(algorithm)
+
+
+def register_jwe_rfc7518(cls):
+ for algorithm in JWE_ALG_ALGORITHMS:
+ cls.register_algorithm(algorithm)
+
+ for algorithm in JWE_ENC_ALGORITHMS:
+ cls.register_algorithm(algorithm)
+
+ cls.register_algorithm(DeflateZipAlgorithm())
+
+
+__all__ = [
+ "register_jws_rfc7518",
+ "register_jwe_rfc7518",
+ "OctKey",
+ "RSAKey",
+ "ECKey",
+ "u32be_len_input",
+ "AESAlgorithm",
+ "ECDHESAlgorithm",
+ "CBCHS2EncAlgorithm",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..94f34067
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/ec_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/ec_key.cpython-312.pyc
new file mode 100644
index 00000000..230d56ca
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/ec_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_algs.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_algs.cpython-312.pyc
new file mode 100644
index 00000000..08467082
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_algs.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_encs.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_encs.cpython-312.pyc
new file mode 100644
index 00000000..05f03b9d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_encs.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_zips.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_zips.cpython-312.pyc
new file mode 100644
index 00000000..30ac83e7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jwe_zips.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jws_algs.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jws_algs.cpython-312.pyc
new file mode 100644
index 00000000..3b9d2c4e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/jws_algs.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/oct_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/oct_key.cpython-312.pyc
new file mode 100644
index 00000000..5d77f1af
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/oct_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/rsa_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/rsa_key.cpython-312.pyc
new file mode 100644
index 00000000..eda94f54
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/rsa_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/util.cpython-312.pyc
new file mode 100644
index 00000000..8fc97b39
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/__pycache__/util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/ec_key.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/ec_key.py
new file mode 100644
index 00000000..82ec6a4b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/ec_key.py
@@ -0,0 +1,108 @@
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives.asymmetric import ec
+from cryptography.hazmat.primitives.asymmetric.ec import SECP256K1
+from cryptography.hazmat.primitives.asymmetric.ec import SECP256R1
+from cryptography.hazmat.primitives.asymmetric.ec import SECP384R1
+from cryptography.hazmat.primitives.asymmetric.ec import SECP521R1
+from cryptography.hazmat.primitives.asymmetric.ec import (
+ EllipticCurvePrivateKeyWithSerialization,
+)
+from cryptography.hazmat.primitives.asymmetric.ec import EllipticCurvePrivateNumbers
+from cryptography.hazmat.primitives.asymmetric.ec import EllipticCurvePublicKey
+from cryptography.hazmat.primitives.asymmetric.ec import EllipticCurvePublicNumbers
+
+from authlib.common.encoding import base64_to_int
+from authlib.common.encoding import int_to_base64
+
+from ..rfc7517 import AsymmetricKey
+
+
+class ECKey(AsymmetricKey):
+ """Key class of the ``EC`` key type."""
+
+ kty = "EC"
+ DSS_CURVES = {
+ "P-256": SECP256R1,
+ "P-384": SECP384R1,
+ "P-521": SECP521R1,
+ # https://tools.ietf.org/html/rfc8812#section-3.1
+ "secp256k1": SECP256K1,
+ }
+ CURVES_DSS = {
+ SECP256R1.name: "P-256",
+ SECP384R1.name: "P-384",
+ SECP521R1.name: "P-521",
+ SECP256K1.name: "secp256k1",
+ }
+ REQUIRED_JSON_FIELDS = ["crv", "x", "y"]
+
+ PUBLIC_KEY_FIELDS = REQUIRED_JSON_FIELDS
+ PRIVATE_KEY_FIELDS = ["crv", "d", "x", "y"]
+
+ PUBLIC_KEY_CLS = EllipticCurvePublicKey
+ PRIVATE_KEY_CLS = EllipticCurvePrivateKeyWithSerialization
+ SSH_PUBLIC_PREFIX = b"ecdsa-sha2-"
+
+ def exchange_shared_key(self, pubkey):
+ # # used in ECDHESAlgorithm
+ private_key = self.get_private_key()
+ if private_key:
+ return private_key.exchange(ec.ECDH(), pubkey)
+ raise ValueError("Invalid key for exchanging shared key")
+
+ @property
+ def curve_key_size(self):
+ raw_key = self.get_private_key()
+ if not raw_key:
+ raw_key = self.public_key
+ return raw_key.curve.key_size
+
+ def load_private_key(self):
+ curve = self.DSS_CURVES[self._dict_data["crv"]]()
+ public_numbers = EllipticCurvePublicNumbers(
+ base64_to_int(self._dict_data["x"]),
+ base64_to_int(self._dict_data["y"]),
+ curve,
+ )
+ private_numbers = EllipticCurvePrivateNumbers(
+ base64_to_int(self.tokens["d"]), public_numbers
+ )
+ return private_numbers.private_key(default_backend())
+
+ def load_public_key(self):
+ curve = self.DSS_CURVES[self._dict_data["crv"]]()
+ public_numbers = EllipticCurvePublicNumbers(
+ base64_to_int(self._dict_data["x"]),
+ base64_to_int(self._dict_data["y"]),
+ curve,
+ )
+ return public_numbers.public_key(default_backend())
+
+ def dumps_private_key(self):
+ numbers = self.private_key.private_numbers()
+ return {
+ "crv": self.CURVES_DSS[self.private_key.curve.name],
+ "x": int_to_base64(numbers.public_numbers.x),
+ "y": int_to_base64(numbers.public_numbers.y),
+ "d": int_to_base64(numbers.private_value),
+ }
+
+ def dumps_public_key(self):
+ numbers = self.public_key.public_numbers()
+ return {
+ "crv": self.CURVES_DSS[numbers.curve.name],
+ "x": int_to_base64(numbers.x),
+ "y": int_to_base64(numbers.y),
+ }
+
+ @classmethod
+ def generate_key(cls, crv="P-256", options=None, is_private=False) -> "ECKey":
+ if crv not in cls.DSS_CURVES:
+ raise ValueError(f'Invalid crv value: "{crv}"')
+ raw_key = ec.generate_private_key(
+ curve=cls.DSS_CURVES[crv](),
+ backend=default_backend(),
+ )
+ if not is_private:
+ raw_key = raw_key.public_key()
+ return cls.import_key(raw_key, options=options)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_algs.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_algs.py
new file mode 100644
index 00000000..e22718a0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_algs.py
@@ -0,0 +1,350 @@
+import os
+import struct
+
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives.asymmetric import padding
+from cryptography.hazmat.primitives.ciphers import Cipher
+from cryptography.hazmat.primitives.ciphers.algorithms import AES
+from cryptography.hazmat.primitives.ciphers.modes import GCM
+from cryptography.hazmat.primitives.kdf.concatkdf import ConcatKDFHash
+from cryptography.hazmat.primitives.keywrap import aes_key_unwrap
+from cryptography.hazmat.primitives.keywrap import aes_key_wrap
+
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_native
+from authlib.common.encoding import urlsafe_b64decode
+from authlib.common.encoding import urlsafe_b64encode
+from authlib.jose.rfc7516 import JWEAlgorithm
+
+from .ec_key import ECKey
+from .oct_key import OctKey
+from .rsa_key import RSAKey
+
+
+class DirectAlgorithm(JWEAlgorithm):
+ name = "dir"
+ description = "Direct use of a shared symmetric key"
+
+ def prepare_key(self, raw_data):
+ return OctKey.import_key(raw_data)
+
+ def generate_preset(self, enc_alg, key):
+ return {}
+
+ def wrap(self, enc_alg, headers, key, preset=None):
+ cek = key.get_op_key("encrypt")
+ if len(cek) * 8 != enc_alg.CEK_SIZE:
+ raise ValueError('Invalid "cek" length')
+ return {"ek": b"", "cek": cek}
+
+ def unwrap(self, enc_alg, ek, headers, key):
+ cek = key.get_op_key("decrypt")
+ if len(cek) * 8 != enc_alg.CEK_SIZE:
+ raise ValueError('Invalid "cek" length')
+ return cek
+
+
+class RSAAlgorithm(JWEAlgorithm):
+ #: A key of size 2048 bits or larger MUST be used with these algorithms
+ #: RSA1_5, RSA-OAEP, RSA-OAEP-256
+ key_size = 2048
+
+ def __init__(self, name, description, pad_fn):
+ self.name = name
+ self.description = description
+ self.padding = pad_fn
+
+ def prepare_key(self, raw_data):
+ return RSAKey.import_key(raw_data)
+
+ def generate_preset(self, enc_alg, key):
+ cek = enc_alg.generate_cek()
+ return {"cek": cek}
+
+ def wrap(self, enc_alg, headers, key, preset=None):
+ if preset and "cek" in preset:
+ cek = preset["cek"]
+ else:
+ cek = enc_alg.generate_cek()
+
+ op_key = key.get_op_key("wrapKey")
+ if op_key.key_size < self.key_size:
+ raise ValueError("A key of size 2048 bits or larger MUST be used")
+ ek = op_key.encrypt(cek, self.padding)
+ return {"ek": ek, "cek": cek}
+
+ def unwrap(self, enc_alg, ek, headers, key):
+ # it will raise ValueError if failed
+ op_key = key.get_op_key("unwrapKey")
+ cek = op_key.decrypt(ek, self.padding)
+ if len(cek) * 8 != enc_alg.CEK_SIZE:
+ raise ValueError('Invalid "cek" length')
+ return cek
+
+
+class AESAlgorithm(JWEAlgorithm):
+ def __init__(self, key_size):
+ self.name = f"A{key_size}KW"
+ self.description = f"AES Key Wrap using {key_size}-bit key"
+ self.key_size = key_size
+
+ def prepare_key(self, raw_data):
+ return OctKey.import_key(raw_data)
+
+ def generate_preset(self, enc_alg, key):
+ cek = enc_alg.generate_cek()
+ return {"cek": cek}
+
+ def _check_key(self, key):
+ if len(key) * 8 != self.key_size:
+ raise ValueError(f"A key of size {self.key_size} bits is required.")
+
+ def wrap_cek(self, cek, key):
+ op_key = key.get_op_key("wrapKey")
+ self._check_key(op_key)
+ ek = aes_key_wrap(op_key, cek, default_backend())
+ return {"ek": ek, "cek": cek}
+
+ def wrap(self, enc_alg, headers, key, preset=None):
+ if preset and "cek" in preset:
+ cek = preset["cek"]
+ else:
+ cek = enc_alg.generate_cek()
+ return self.wrap_cek(cek, key)
+
+ def unwrap(self, enc_alg, ek, headers, key):
+ op_key = key.get_op_key("unwrapKey")
+ self._check_key(op_key)
+ cek = aes_key_unwrap(op_key, ek, default_backend())
+ if len(cek) * 8 != enc_alg.CEK_SIZE:
+ raise ValueError('Invalid "cek" length')
+ return cek
+
+
+class AESGCMAlgorithm(JWEAlgorithm):
+ EXTRA_HEADERS = frozenset(["iv", "tag"])
+
+ def __init__(self, key_size):
+ self.name = f"A{key_size}GCMKW"
+ self.description = f"Key wrapping with AES GCM using {key_size}-bit key"
+ self.key_size = key_size
+
+ def prepare_key(self, raw_data):
+ return OctKey.import_key(raw_data)
+
+ def generate_preset(self, enc_alg, key):
+ cek = enc_alg.generate_cek()
+ return {"cek": cek}
+
+ def _check_key(self, key):
+ if len(key) * 8 != self.key_size:
+ raise ValueError(f"A key of size {self.key_size} bits is required.")
+
+ def wrap(self, enc_alg, headers, key, preset=None):
+ if preset and "cek" in preset:
+ cek = preset["cek"]
+ else:
+ cek = enc_alg.generate_cek()
+
+ op_key = key.get_op_key("wrapKey")
+ self._check_key(op_key)
+
+ #: https://tools.ietf.org/html/rfc7518#section-4.7.1.1
+ #: The "iv" (initialization vector) Header Parameter value is the
+ #: base64url-encoded representation of the 96-bit IV value
+ iv_size = 96
+ iv = os.urandom(iv_size // 8)
+
+ cipher = Cipher(AES(op_key), GCM(iv), backend=default_backend())
+ enc = cipher.encryptor()
+ ek = enc.update(cek) + enc.finalize()
+
+ h = {
+ "iv": to_native(urlsafe_b64encode(iv)),
+ "tag": to_native(urlsafe_b64encode(enc.tag)),
+ }
+ return {"ek": ek, "cek": cek, "header": h}
+
+ def unwrap(self, enc_alg, ek, headers, key):
+ op_key = key.get_op_key("unwrapKey")
+ self._check_key(op_key)
+
+ iv = headers.get("iv")
+ if not iv:
+ raise ValueError('Missing "iv" in headers')
+
+ tag = headers.get("tag")
+ if not tag:
+ raise ValueError('Missing "tag" in headers')
+
+ iv = urlsafe_b64decode(to_bytes(iv))
+ tag = urlsafe_b64decode(to_bytes(tag))
+
+ cipher = Cipher(AES(op_key), GCM(iv, tag), backend=default_backend())
+ d = cipher.decryptor()
+ cek = d.update(ek) + d.finalize()
+ if len(cek) * 8 != enc_alg.CEK_SIZE:
+ raise ValueError('Invalid "cek" length')
+ return cek
+
+
+class ECDHESAlgorithm(JWEAlgorithm):
+ EXTRA_HEADERS = ["epk", "apu", "apv"]
+ ALLOWED_KEY_CLS = ECKey
+
+ # https://tools.ietf.org/html/rfc7518#section-4.6
+ def __init__(self, key_size=None):
+ if key_size is None:
+ self.name = "ECDH-ES"
+ self.description = "ECDH-ES in the Direct Key Agreement mode"
+ else:
+ self.name = f"ECDH-ES+A{key_size}KW"
+ self.description = (
+ f"ECDH-ES using Concat KDF and CEK wrapped with A{key_size}KW"
+ )
+ self.key_size = key_size
+ self.aeskw = AESAlgorithm(key_size)
+
+ def prepare_key(self, raw_data):
+ if isinstance(raw_data, self.ALLOWED_KEY_CLS):
+ return raw_data
+ return ECKey.import_key(raw_data)
+
+ def generate_preset(self, enc_alg, key):
+ epk = self._generate_ephemeral_key(key)
+ h = self._prepare_headers(epk)
+ preset = {"epk": epk, "header": h}
+ if self.key_size is not None:
+ cek = enc_alg.generate_cek()
+ preset["cek"] = cek
+ return preset
+
+ def compute_fixed_info(self, headers, bit_size):
+ # AlgorithmID
+ if self.key_size is None:
+ alg_id = u32be_len_input(headers["enc"])
+ else:
+ alg_id = u32be_len_input(headers["alg"])
+
+ # PartyUInfo
+ apu_info = u32be_len_input(headers.get("apu"), True)
+
+ # PartyVInfo
+ apv_info = u32be_len_input(headers.get("apv"), True)
+
+ # SuppPubInfo
+ pub_info = struct.pack(">I", bit_size)
+
+ return alg_id + apu_info + apv_info + pub_info
+
+ def compute_derived_key(self, shared_key, fixed_info, bit_size):
+ ckdf = ConcatKDFHash(
+ algorithm=hashes.SHA256(),
+ length=bit_size // 8,
+ otherinfo=fixed_info,
+ backend=default_backend(),
+ )
+ return ckdf.derive(shared_key)
+
+ def deliver(self, key, pubkey, headers, bit_size):
+ shared_key = key.exchange_shared_key(pubkey)
+ fixed_info = self.compute_fixed_info(headers, bit_size)
+ return self.compute_derived_key(shared_key, fixed_info, bit_size)
+
+ def _generate_ephemeral_key(self, key):
+ return key.generate_key(key["crv"], is_private=True)
+
+ def _prepare_headers(self, epk):
+ # REQUIRED_JSON_FIELDS contains only public fields
+ pub_epk = {k: epk[k] for k in epk.REQUIRED_JSON_FIELDS}
+ pub_epk["kty"] = epk.kty
+ return {"epk": pub_epk}
+
+ def wrap(self, enc_alg, headers, key, preset=None):
+ if self.key_size is None:
+ bit_size = enc_alg.CEK_SIZE
+ else:
+ bit_size = self.key_size
+
+ if preset and "epk" in preset:
+ epk = preset["epk"]
+ h = {}
+ else:
+ epk = self._generate_ephemeral_key(key)
+ h = self._prepare_headers(epk)
+
+ public_key = key.get_op_key("wrapKey")
+ dk = self.deliver(epk, public_key, headers, bit_size)
+
+ if self.key_size is None:
+ return {"ek": b"", "cek": dk, "header": h}
+
+ if preset and "cek" in preset:
+ preset_for_kw = {"cek": preset["cek"]}
+ else:
+ preset_for_kw = None
+
+ kek = self.aeskw.prepare_key(dk)
+ rv = self.aeskw.wrap(enc_alg, headers, kek, preset_for_kw)
+ rv["header"] = h
+ return rv
+
+ def unwrap(self, enc_alg, ek, headers, key):
+ if "epk" not in headers:
+ raise ValueError('Missing "epk" in headers')
+
+ if self.key_size is None:
+ bit_size = enc_alg.CEK_SIZE
+ else:
+ bit_size = self.key_size
+
+ epk = key.import_key(headers["epk"])
+ public_key = epk.get_op_key("wrapKey")
+ dk = self.deliver(key, public_key, headers, bit_size)
+
+ if self.key_size is None:
+ return dk
+
+ kek = self.aeskw.prepare_key(dk)
+ return self.aeskw.unwrap(enc_alg, ek, headers, kek)
+
+
+def u32be_len_input(s, base64=False):
+ if not s:
+ return b"\x00\x00\x00\x00"
+ if base64:
+ s = urlsafe_b64decode(to_bytes(s))
+ else:
+ s = to_bytes(s)
+ return struct.pack(">I", len(s)) + s
+
+
+JWE_ALG_ALGORITHMS = [
+ DirectAlgorithm(), # dir
+ RSAAlgorithm("RSA1_5", "RSAES-PKCS1-v1_5", padding.PKCS1v15()),
+ RSAAlgorithm(
+ "RSA-OAEP",
+ "RSAES OAEP using default parameters",
+ padding.OAEP(padding.MGF1(hashes.SHA1()), hashes.SHA1(), None),
+ ),
+ RSAAlgorithm(
+ "RSA-OAEP-256",
+ "RSAES OAEP using SHA-256 and MGF1 with SHA-256",
+ padding.OAEP(padding.MGF1(hashes.SHA256()), hashes.SHA256(), None),
+ ),
+ AESAlgorithm(128), # A128KW
+ AESAlgorithm(192), # A192KW
+ AESAlgorithm(256), # A256KW
+ AESGCMAlgorithm(128), # A128GCMKW
+ AESGCMAlgorithm(192), # A192GCMKW
+ AESGCMAlgorithm(256), # A256GCMKW
+ ECDHESAlgorithm(None), # ECDH-ES
+ ECDHESAlgorithm(128), # ECDH-ES+A128KW
+ ECDHESAlgorithm(192), # ECDH-ES+A192KW
+ ECDHESAlgorithm(256), # ECDH-ES+A256KW
+]
+
+# 'PBES2-HS256+A128KW': '',
+# 'PBES2-HS384+A192KW': '',
+# 'PBES2-HS512+A256KW': '',
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_encs.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_encs.py
new file mode 100644
index 00000000..38246131
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_encs.py
@@ -0,0 +1,147 @@
+"""authlib.jose.rfc7518.
+~~~~~~~~~~~~~~~~~~~~
+
+Cryptographic Algorithms for Cryptographic Algorithms for Content
+Encryption per `Section 5`_.
+
+.. _`Section 5`: https://tools.ietf.org/html/rfc7518#section-5
+"""
+
+import hashlib
+import hmac
+
+from cryptography.exceptions import InvalidTag
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives.ciphers import Cipher
+from cryptography.hazmat.primitives.ciphers.algorithms import AES
+from cryptography.hazmat.primitives.ciphers.modes import CBC
+from cryptography.hazmat.primitives.ciphers.modes import GCM
+from cryptography.hazmat.primitives.padding import PKCS7
+
+from ..rfc7516 import JWEEncAlgorithm
+from .util import encode_int
+
+
+class CBCHS2EncAlgorithm(JWEEncAlgorithm):
+ # The IV used is a 128-bit value generated randomly or
+ # pseudo-randomly for use in the cipher.
+ IV_SIZE = 128
+
+ def __init__(self, key_size, hash_type):
+ self.name = f"A{key_size}CBC-HS{hash_type}"
+ tpl = "AES_{}_CBC_HMAC_SHA_{} authenticated encryption algorithm"
+ self.description = tpl.format(key_size, hash_type)
+
+ # bit length
+ self.key_size = key_size
+ # byte length
+ self.key_len = key_size // 8
+
+ self.CEK_SIZE = key_size * 2
+ self.hash_alg = getattr(hashlib, f"sha{hash_type}")
+
+ def _hmac(self, ciphertext, aad, iv, key):
+ al = encode_int(len(aad) * 8, 64)
+ msg = aad + iv + ciphertext + al
+ d = hmac.new(key, msg, self.hash_alg).digest()
+ return d[: self.key_len]
+
+ def encrypt(self, msg, aad, iv, key):
+ """Key Encryption with AES_CBC_HMAC_SHA2.
+
+ :param msg: text to be encrypt in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param key: encrypted key in bytes
+ :return: (ciphertext, iv, tag)
+ """
+ self.check_iv(iv)
+ hkey = key[: self.key_len]
+ ekey = key[self.key_len :]
+
+ pad = PKCS7(AES.block_size).padder()
+ padded_data = pad.update(msg) + pad.finalize()
+
+ cipher = Cipher(AES(ekey), CBC(iv), backend=default_backend())
+ enc = cipher.encryptor()
+ ciphertext = enc.update(padded_data) + enc.finalize()
+ tag = self._hmac(ciphertext, aad, iv, hkey)
+ return ciphertext, tag
+
+ def decrypt(self, ciphertext, aad, iv, tag, key):
+ """Key Decryption with AES AES_CBC_HMAC_SHA2.
+
+ :param ciphertext: ciphertext in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param tag: authentication tag in bytes
+ :param key: encrypted key in bytes
+ :return: message
+ """
+ self.check_iv(iv)
+ hkey = key[: self.key_len]
+ dkey = key[self.key_len :]
+
+ _tag = self._hmac(ciphertext, aad, iv, hkey)
+ if not hmac.compare_digest(_tag, tag):
+ raise InvalidTag()
+
+ cipher = Cipher(AES(dkey), CBC(iv), backend=default_backend())
+ d = cipher.decryptor()
+ data = d.update(ciphertext) + d.finalize()
+ unpad = PKCS7(AES.block_size).unpadder()
+ return unpad.update(data) + unpad.finalize()
+
+
+class GCMEncAlgorithm(JWEEncAlgorithm):
+ # Use of an IV of size 96 bits is REQUIRED with this algorithm.
+ # https://tools.ietf.org/html/rfc7518#section-5.3
+ IV_SIZE = 96
+
+ def __init__(self, key_size):
+ self.name = f"A{key_size}GCM"
+ self.description = f"AES GCM using {key_size}-bit key"
+ self.key_size = key_size
+ self.CEK_SIZE = key_size
+
+ def encrypt(self, msg, aad, iv, key):
+ """Key Encryption with AES GCM.
+
+ :param msg: text to be encrypt in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param key: encrypted key in bytes
+ :return: (ciphertext, iv, tag)
+ """
+ self.check_iv(iv)
+ cipher = Cipher(AES(key), GCM(iv), backend=default_backend())
+ enc = cipher.encryptor()
+ enc.authenticate_additional_data(aad)
+ ciphertext = enc.update(msg) + enc.finalize()
+ return ciphertext, enc.tag
+
+ def decrypt(self, ciphertext, aad, iv, tag, key):
+ """Key Decryption with AES GCM.
+
+ :param ciphertext: ciphertext in bytes
+ :param aad: additional authenticated data in bytes
+ :param iv: initialization vector in bytes
+ :param tag: authentication tag in bytes
+ :param key: encrypted key in bytes
+ :return: message
+ """
+ self.check_iv(iv)
+ cipher = Cipher(AES(key), GCM(iv, tag), backend=default_backend())
+ d = cipher.decryptor()
+ d.authenticate_additional_data(aad)
+ return d.update(ciphertext) + d.finalize()
+
+
+JWE_ENC_ALGORITHMS = [
+ CBCHS2EncAlgorithm(128, 256), # A128CBC-HS256
+ CBCHS2EncAlgorithm(192, 384), # A192CBC-HS384
+ CBCHS2EncAlgorithm(256, 512), # A256CBC-HS512
+ GCMEncAlgorithm(128), # A128GCM
+ GCMEncAlgorithm(192), # A192GCM
+ GCMEncAlgorithm(256), # A256GCM
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_zips.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_zips.py
new file mode 100644
index 00000000..70b1c5cf
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jwe_zips.py
@@ -0,0 +1,34 @@
+import zlib
+
+from ..rfc7516 import JsonWebEncryption
+from ..rfc7516 import JWEZipAlgorithm
+
+GZIP_HEAD = bytes([120, 156])
+MAX_SIZE = 250 * 1024
+
+
+class DeflateZipAlgorithm(JWEZipAlgorithm):
+ name = "DEF"
+ description = "DEFLATE"
+
+ def compress(self, s: bytes) -> bytes:
+ """Compress bytes data with DEFLATE algorithm."""
+ data = zlib.compress(s)
+ # https://datatracker.ietf.org/doc/html/rfc1951
+ # since DEF is always gzip, we can drop gzip headers and tail
+ return data[2:-4]
+
+ def decompress(self, s: bytes) -> bytes:
+ """Decompress DEFLATE bytes data."""
+ if s.startswith(GZIP_HEAD):
+ decompressor = zlib.decompressobj()
+ else:
+ decompressor = zlib.decompressobj(-zlib.MAX_WBITS)
+ value = decompressor.decompress(s, MAX_SIZE)
+ if decompressor.unconsumed_tail:
+ raise ValueError(f"Decompressed string exceeds {MAX_SIZE} bytes")
+ return value
+
+
+def register_jwe_rfc7518():
+ JsonWebEncryption.register_algorithm(DeflateZipAlgorithm())
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jws_algs.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jws_algs.py
new file mode 100644
index 00000000..3f97530a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/jws_algs.py
@@ -0,0 +1,221 @@
+"""authlib.jose.rfc7518.
+~~~~~~~~~~~~~~~~~~~~
+
+"alg" (Algorithm) Header Parameter Values for JWS per `Section 3`_.
+
+.. _`Section 3`: https://tools.ietf.org/html/rfc7518#section-3
+"""
+
+import hashlib
+import hmac
+
+from cryptography.exceptions import InvalidSignature
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives.asymmetric import padding
+from cryptography.hazmat.primitives.asymmetric.ec import ECDSA
+from cryptography.hazmat.primitives.asymmetric.utils import decode_dss_signature
+from cryptography.hazmat.primitives.asymmetric.utils import encode_dss_signature
+
+from ..rfc7515 import JWSAlgorithm
+from .ec_key import ECKey
+from .oct_key import OctKey
+from .rsa_key import RSAKey
+from .util import decode_int
+from .util import encode_int
+
+
+class NoneAlgorithm(JWSAlgorithm):
+ name = "none"
+ description = "No digital signature or MAC performed"
+
+ def prepare_key(self, raw_data):
+ return None
+
+ def sign(self, msg, key):
+ return b""
+
+ def verify(self, msg, sig, key):
+ return sig == b""
+
+
+class HMACAlgorithm(JWSAlgorithm):
+ """HMAC using SHA algorithms for JWS. Available algorithms:
+
+ - HS256: HMAC using SHA-256
+ - HS384: HMAC using SHA-384
+ - HS512: HMAC using SHA-512
+ """
+
+ SHA256 = hashlib.sha256
+ SHA384 = hashlib.sha384
+ SHA512 = hashlib.sha512
+
+ def __init__(self, sha_type):
+ self.name = f"HS{sha_type}"
+ self.description = f"HMAC using SHA-{sha_type}"
+ self.hash_alg = getattr(self, f"SHA{sha_type}")
+
+ def prepare_key(self, raw_data):
+ return OctKey.import_key(raw_data)
+
+ def sign(self, msg, key):
+ # it is faster than the one in cryptography
+ op_key = key.get_op_key("sign")
+ return hmac.new(op_key, msg, self.hash_alg).digest()
+
+ def verify(self, msg, sig, key):
+ op_key = key.get_op_key("verify")
+ v_sig = hmac.new(op_key, msg, self.hash_alg).digest()
+ return hmac.compare_digest(sig, v_sig)
+
+
+class RSAAlgorithm(JWSAlgorithm):
+ """RSA using SHA algorithms for JWS. Available algorithms:
+
+ - RS256: RSASSA-PKCS1-v1_5 using SHA-256
+ - RS384: RSASSA-PKCS1-v1_5 using SHA-384
+ - RS512: RSASSA-PKCS1-v1_5 using SHA-512
+ """
+
+ SHA256 = hashes.SHA256
+ SHA384 = hashes.SHA384
+ SHA512 = hashes.SHA512
+
+ def __init__(self, sha_type):
+ self.name = f"RS{sha_type}"
+ self.description = f"RSASSA-PKCS1-v1_5 using SHA-{sha_type}"
+ self.hash_alg = getattr(self, f"SHA{sha_type}")
+ self.padding = padding.PKCS1v15()
+
+ def prepare_key(self, raw_data):
+ return RSAKey.import_key(raw_data)
+
+ def sign(self, msg, key):
+ op_key = key.get_op_key("sign")
+ return op_key.sign(msg, self.padding, self.hash_alg())
+
+ def verify(self, msg, sig, key):
+ op_key = key.get_op_key("verify")
+ try:
+ op_key.verify(sig, msg, self.padding, self.hash_alg())
+ return True
+ except InvalidSignature:
+ return False
+
+
+class ECAlgorithm(JWSAlgorithm):
+ """ECDSA using SHA algorithms for JWS. Available algorithms:
+
+ - ES256: ECDSA using P-256 and SHA-256
+ - ES384: ECDSA using P-384 and SHA-384
+ - ES512: ECDSA using P-521 and SHA-512
+ """
+
+ SHA256 = hashes.SHA256
+ SHA384 = hashes.SHA384
+ SHA512 = hashes.SHA512
+
+ def __init__(self, name, curve, sha_type):
+ self.name = name
+ self.curve = curve
+ self.description = f"ECDSA using {self.curve} and SHA-{sha_type}"
+ self.hash_alg = getattr(self, f"SHA{sha_type}")
+
+ def prepare_key(self, raw_data):
+ key = ECKey.import_key(raw_data)
+ if key["crv"] != self.curve:
+ raise ValueError(
+ f'Key for "{self.name}" not supported, only "{self.curve}" allowed'
+ )
+ return key
+
+ def sign(self, msg, key):
+ op_key = key.get_op_key("sign")
+ der_sig = op_key.sign(msg, ECDSA(self.hash_alg()))
+ r, s = decode_dss_signature(der_sig)
+ size = key.curve_key_size
+ return encode_int(r, size) + encode_int(s, size)
+
+ def verify(self, msg, sig, key):
+ key_size = key.curve_key_size
+ length = (key_size + 7) // 8
+
+ if len(sig) != 2 * length:
+ return False
+
+ r = decode_int(sig[:length])
+ s = decode_int(sig[length:])
+ der_sig = encode_dss_signature(r, s)
+
+ try:
+ op_key = key.get_op_key("verify")
+ op_key.verify(der_sig, msg, ECDSA(self.hash_alg()))
+ return True
+ except InvalidSignature:
+ return False
+
+
+class RSAPSSAlgorithm(JWSAlgorithm):
+ """RSASSA-PSS using SHA algorithms for JWS. Available algorithms:
+
+ - PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256
+ - PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384
+ - PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512
+ """
+
+ SHA256 = hashes.SHA256
+ SHA384 = hashes.SHA384
+ SHA512 = hashes.SHA512
+
+ def __init__(self, sha_type):
+ self.name = f"PS{sha_type}"
+ tpl = "RSASSA-PSS using SHA-{} and MGF1 with SHA-{}"
+ self.description = tpl.format(sha_type, sha_type)
+ self.hash_alg = getattr(self, f"SHA{sha_type}")
+
+ def prepare_key(self, raw_data):
+ return RSAKey.import_key(raw_data)
+
+ def sign(self, msg, key):
+ op_key = key.get_op_key("sign")
+ return op_key.sign(
+ msg,
+ padding.PSS(
+ mgf=padding.MGF1(self.hash_alg()), salt_length=self.hash_alg.digest_size
+ ),
+ self.hash_alg(),
+ )
+
+ def verify(self, msg, sig, key):
+ op_key = key.get_op_key("verify")
+ try:
+ op_key.verify(
+ sig,
+ msg,
+ padding.PSS(
+ mgf=padding.MGF1(self.hash_alg()),
+ salt_length=self.hash_alg.digest_size,
+ ),
+ self.hash_alg(),
+ )
+ return True
+ except InvalidSignature:
+ return False
+
+
+JWS_ALGORITHMS = [
+ NoneAlgorithm(), # none
+ HMACAlgorithm(256), # HS256
+ HMACAlgorithm(384), # HS384
+ HMACAlgorithm(512), # HS512
+ RSAAlgorithm(256), # RS256
+ RSAAlgorithm(384), # RS384
+ RSAAlgorithm(512), # RS512
+ ECAlgorithm("ES256", "P-256", 256),
+ ECAlgorithm("ES384", "P-384", 384),
+ ECAlgorithm("ES512", "P-521", 512),
+ ECAlgorithm("ES256K", "secp256k1", 256), # defined in RFC8812
+ RSAPSSAlgorithm(256), # PS256
+ RSAPSSAlgorithm(384), # PS384
+ RSAPSSAlgorithm(512), # PS512
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/oct_key.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/oct_key.py
new file mode 100644
index 00000000..6888c490
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/oct_key.py
@@ -0,0 +1,96 @@
+import secrets
+
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+from authlib.common.encoding import urlsafe_b64decode
+from authlib.common.encoding import urlsafe_b64encode
+
+from ..rfc7517 import Key
+
+POSSIBLE_UNSAFE_KEYS = (
+ b"-----BEGIN ",
+ b"---- BEGIN ",
+ b"ssh-rsa ",
+ b"ssh-dss ",
+ b"ssh-ed25519 ",
+ b"ecdsa-sha2-",
+)
+
+
+class OctKey(Key):
+ """Key class of the ``oct`` key type."""
+
+ kty = "oct"
+ REQUIRED_JSON_FIELDS = ["k"]
+
+ def __init__(self, raw_key=None, options=None):
+ super().__init__(options)
+ self.raw_key = raw_key
+
+ @property
+ def public_only(self):
+ return False
+
+ def get_op_key(self, operation):
+ """Get the raw key for the given key_op. This method will also
+ check if the given key_op is supported by this key.
+
+ :param operation: key operation value, such as "sign", "encrypt".
+ :return: raw key
+ """
+ self.check_key_op(operation)
+ if not self.raw_key:
+ self.load_raw_key()
+ return self.raw_key
+
+ def load_raw_key(self):
+ self.raw_key = urlsafe_b64decode(to_bytes(self.tokens["k"]))
+
+ def load_dict_key(self):
+ k = to_unicode(urlsafe_b64encode(self.raw_key))
+ self._dict_data = {"kty": self.kty, "k": k}
+
+ def as_dict(self, is_private=False, **params):
+ tokens = self.tokens
+ if "kid" not in tokens:
+ tokens["kid"] = self.thumbprint()
+
+ tokens.update(params)
+ return tokens
+
+ @classmethod
+ def validate_raw_key(cls, key):
+ return isinstance(key, bytes)
+
+ @classmethod
+ def import_key(cls, raw, options=None):
+ """Import a key from bytes, string, or dict data."""
+ if isinstance(raw, cls):
+ if options is not None:
+ raw.options.update(options)
+ return raw
+
+ if isinstance(raw, dict):
+ cls.check_required_fields(raw)
+ key = cls(options=options)
+ key._dict_data = raw
+ else:
+ raw_key = to_bytes(raw)
+
+ # security check
+ if raw_key.startswith(POSSIBLE_UNSAFE_KEYS):
+ raise ValueError("This key may not be safe to import")
+
+ key = cls(raw_key=raw_key, options=options)
+ return key
+
+ @classmethod
+ def generate_key(cls, key_size=256, options=None, is_private=True):
+ """Generate a ``OctKey`` with the given bit size."""
+ if not is_private:
+ raise ValueError("oct key can not be generated as public")
+
+ if key_size % 8 != 0:
+ raise ValueError("Invalid bit size for oct key")
+
+ return cls.import_key(secrets.token_bytes(int(key_size / 8)), options)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/rsa_key.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/rsa_key.py
new file mode 100644
index 00000000..6f6db48c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/rsa_key.py
@@ -0,0 +1,127 @@
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives.asymmetric import rsa
+from cryptography.hazmat.primitives.asymmetric.rsa import RSAPrivateKeyWithSerialization
+from cryptography.hazmat.primitives.asymmetric.rsa import RSAPrivateNumbers
+from cryptography.hazmat.primitives.asymmetric.rsa import RSAPublicKey
+from cryptography.hazmat.primitives.asymmetric.rsa import RSAPublicNumbers
+from cryptography.hazmat.primitives.asymmetric.rsa import rsa_crt_dmp1
+from cryptography.hazmat.primitives.asymmetric.rsa import rsa_crt_dmq1
+from cryptography.hazmat.primitives.asymmetric.rsa import rsa_crt_iqmp
+from cryptography.hazmat.primitives.asymmetric.rsa import rsa_recover_prime_factors
+
+from authlib.common.encoding import base64_to_int
+from authlib.common.encoding import int_to_base64
+
+from ..rfc7517 import AsymmetricKey
+
+
+class RSAKey(AsymmetricKey):
+ """Key class of the ``RSA`` key type."""
+
+ kty = "RSA"
+ PUBLIC_KEY_CLS = RSAPublicKey
+ PRIVATE_KEY_CLS = RSAPrivateKeyWithSerialization
+
+ PUBLIC_KEY_FIELDS = ["e", "n"]
+ PRIVATE_KEY_FIELDS = ["d", "dp", "dq", "e", "n", "p", "q", "qi"]
+ REQUIRED_JSON_FIELDS = ["e", "n"]
+ SSH_PUBLIC_PREFIX = b"ssh-rsa"
+
+ def dumps_private_key(self):
+ numbers = self.private_key.private_numbers()
+ return {
+ "n": int_to_base64(numbers.public_numbers.n),
+ "e": int_to_base64(numbers.public_numbers.e),
+ "d": int_to_base64(numbers.d),
+ "p": int_to_base64(numbers.p),
+ "q": int_to_base64(numbers.q),
+ "dp": int_to_base64(numbers.dmp1),
+ "dq": int_to_base64(numbers.dmq1),
+ "qi": int_to_base64(numbers.iqmp),
+ }
+
+ def dumps_public_key(self):
+ numbers = self.public_key.public_numbers()
+ return {"n": int_to_base64(numbers.n), "e": int_to_base64(numbers.e)}
+
+ def load_private_key(self):
+ obj = self._dict_data
+
+ if "oth" in obj: # pragma: no cover
+ # https://tools.ietf.org/html/rfc7518#section-6.3.2.7
+ raise ValueError('"oth" is not supported yet')
+
+ public_numbers = RSAPublicNumbers(
+ base64_to_int(obj["e"]), base64_to_int(obj["n"])
+ )
+
+ if has_all_prime_factors(obj):
+ numbers = RSAPrivateNumbers(
+ d=base64_to_int(obj["d"]),
+ p=base64_to_int(obj["p"]),
+ q=base64_to_int(obj["q"]),
+ dmp1=base64_to_int(obj["dp"]),
+ dmq1=base64_to_int(obj["dq"]),
+ iqmp=base64_to_int(obj["qi"]),
+ public_numbers=public_numbers,
+ )
+ else:
+ d = base64_to_int(obj["d"])
+ p, q = rsa_recover_prime_factors(public_numbers.n, d, public_numbers.e)
+ numbers = RSAPrivateNumbers(
+ d=d,
+ p=p,
+ q=q,
+ dmp1=rsa_crt_dmp1(d, p),
+ dmq1=rsa_crt_dmq1(d, q),
+ iqmp=rsa_crt_iqmp(p, q),
+ public_numbers=public_numbers,
+ )
+
+ return numbers.private_key(default_backend())
+
+ def load_public_key(self):
+ numbers = RSAPublicNumbers(
+ base64_to_int(self._dict_data["e"]), base64_to_int(self._dict_data["n"])
+ )
+ return numbers.public_key(default_backend())
+
+ @classmethod
+ def generate_key(cls, key_size=2048, options=None, is_private=False) -> "RSAKey":
+ if key_size < 512:
+ raise ValueError("key_size must not be less than 512")
+ if key_size % 8 != 0:
+ raise ValueError("Invalid key_size for RSAKey")
+ raw_key = rsa.generate_private_key(
+ public_exponent=65537,
+ key_size=key_size,
+ backend=default_backend(),
+ )
+ if not is_private:
+ raw_key = raw_key.public_key()
+ return cls.import_key(raw_key, options=options)
+
+ @classmethod
+ def import_dict_key(cls, raw, options=None):
+ cls.check_required_fields(raw)
+ key = cls(options=options)
+ key._dict_data = raw
+ if "d" in raw and not has_all_prime_factors(raw):
+ # reload dict key
+ key.load_raw_key()
+ key.load_dict_key()
+ return key
+
+
+def has_all_prime_factors(obj):
+ props = ["p", "q", "dp", "dq", "qi"]
+ props_found = [prop in obj for prop in props]
+ if all(props_found):
+ return True
+
+ if any(props_found):
+ raise ValueError(
+ "RSA key must include all parameters if any are present besides d"
+ )
+
+ return False
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/util.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/util.py
new file mode 100644
index 00000000..723770ad
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7518/util.py
@@ -0,0 +1,12 @@
+import binascii
+
+
+def encode_int(num, bits):
+ length = ((bits + 7) // 8) * 2
+ padded_hex = f"{num:0{length}x}"
+ big_endian = binascii.a2b_hex(padded_hex.encode("ascii"))
+ return big_endian
+
+
+def decode_int(b):
+ return int(binascii.b2a_hex(b), 16)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__init__.py
new file mode 100644
index 00000000..2717e7f6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__init__.py
@@ -0,0 +1,14 @@
+"""authlib.jose.rfc7519.
+~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+JSON Web Token (JWT).
+
+https://tools.ietf.org/html/rfc7519
+"""
+
+from .claims import BaseClaims
+from .claims import JWTClaims
+from .jwt import JsonWebToken
+
+__all__ = ["JsonWebToken", "BaseClaims", "JWTClaims"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..c34bff7c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/claims.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/claims.cpython-312.pyc
new file mode 100644
index 00000000..185e05c8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/claims.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/jwt.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/jwt.cpython-312.pyc
new file mode 100644
index 00000000..5862b89e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/__pycache__/jwt.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/claims.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/claims.py
new file mode 100644
index 00000000..1cc36cbf
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/claims.py
@@ -0,0 +1,227 @@
+import time
+
+from authlib.jose.errors import ExpiredTokenError
+from authlib.jose.errors import InvalidClaimError
+from authlib.jose.errors import InvalidTokenError
+from authlib.jose.errors import MissingClaimError
+
+
+class BaseClaims(dict):
+ """Payload claims for JWT, which contains a validate interface.
+
+ :param payload: the payload dict of JWT
+ :param header: the header dict of JWT
+ :param options: validate options
+ :param params: other params
+
+ An example on ``options`` parameter, the format is inspired by
+ `OpenID Connect Claims`_::
+
+ {
+ "iss": {
+ "essential": True,
+ "values": ["https://example.com", "https://example.org"]
+ },
+ "sub": {
+ "essential": True
+ "value": "248289761001"
+ },
+ "jti": {
+ "validate": validate_jti
+ }
+ }
+
+ .. _`OpenID Connect Claims`:
+ http://openid.net/specs/openid-connect-core-1_0.html#IndividualClaimsRequests
+ """
+
+ REGISTERED_CLAIMS = []
+
+ def __init__(self, payload, header, options=None, params=None):
+ super().__init__(payload)
+ self.header = header
+ self.options = options or {}
+ self.params = params or {}
+
+ def __getattr__(self, key):
+ try:
+ return object.__getattribute__(self, key)
+ except AttributeError as error:
+ if key in self.REGISTERED_CLAIMS:
+ return self.get(key)
+ raise error
+
+ def _validate_essential_claims(self):
+ for k in self.options:
+ if self.options[k].get("essential"):
+ if k not in self:
+ raise MissingClaimError(k)
+ elif not self.get(k):
+ raise InvalidClaimError(k)
+
+ def _validate_claim_value(self, claim_name):
+ option = self.options.get(claim_name)
+ if not option:
+ return
+
+ value = self.get(claim_name)
+ option_value = option.get("value")
+ if option_value and value != option_value:
+ raise InvalidClaimError(claim_name)
+
+ option_values = option.get("values")
+ if option_values and value not in option_values:
+ raise InvalidClaimError(claim_name)
+
+ validate = option.get("validate")
+ if validate and not validate(self, value):
+ raise InvalidClaimError(claim_name)
+
+ def get_registered_claims(self):
+ rv = {}
+ for k in self.REGISTERED_CLAIMS:
+ if k in self:
+ rv[k] = self[k]
+ return rv
+
+
+class JWTClaims(BaseClaims):
+ REGISTERED_CLAIMS = ["iss", "sub", "aud", "exp", "nbf", "iat", "jti"]
+
+ def validate(self, now=None, leeway=0):
+ """Validate everything in claims payload."""
+ self._validate_essential_claims()
+
+ if now is None:
+ now = int(time.time())
+
+ self.validate_iss()
+ self.validate_sub()
+ self.validate_aud()
+ self.validate_exp(now, leeway)
+ self.validate_nbf(now, leeway)
+ self.validate_iat(now, leeway)
+ self.validate_jti()
+
+ # Validate custom claims
+ for key in self.options.keys():
+ if key not in self.REGISTERED_CLAIMS:
+ self._validate_claim_value(key)
+
+ def validate_iss(self):
+ """The "iss" (issuer) claim identifies the principal that issued the
+ JWT. The processing of this claim is generally application specific.
+ The "iss" value is a case-sensitive string containing a StringOrURI
+ value. Use of this claim is OPTIONAL.
+ """
+ self._validate_claim_value("iss")
+
+ def validate_sub(self):
+ """The "sub" (subject) claim identifies the principal that is the
+ subject of the JWT. The claims in a JWT are normally statements
+ about the subject. The subject value MUST either be scoped to be
+ locally unique in the context of the issuer or be globally unique.
+ The processing of this claim is generally application specific. The
+ "sub" value is a case-sensitive string containing a StringOrURI
+ value. Use of this claim is OPTIONAL.
+ """
+ self._validate_claim_value("sub")
+
+ def validate_aud(self):
+ """The "aud" (audience) claim identifies the recipients that the JWT is
+ intended for. Each principal intended to process the JWT MUST
+ identify itself with a value in the audience claim. If the principal
+ processing the claim does not identify itself with a value in the
+ "aud" claim when this claim is present, then the JWT MUST be
+ rejected. In the general case, the "aud" value is an array of case-
+ sensitive strings, each containing a StringOrURI value. In the
+ special case when the JWT has one audience, the "aud" value MAY be a
+ single case-sensitive string containing a StringOrURI value. The
+ interpretation of audience values is generally application specific.
+ Use of this claim is OPTIONAL.
+ """
+ aud_option = self.options.get("aud")
+ aud = self.get("aud")
+ if not aud_option or not aud:
+ return
+
+ aud_values = aud_option.get("values")
+ if not aud_values:
+ aud_value = aud_option.get("value")
+ if aud_value:
+ aud_values = [aud_value]
+
+ if not aud_values:
+ return
+
+ if isinstance(self["aud"], list):
+ aud_list = self["aud"]
+ else:
+ aud_list = [self["aud"]]
+
+ if not any([v in aud_list for v in aud_values]):
+ raise InvalidClaimError("aud")
+
+ def validate_exp(self, now, leeway):
+ """The "exp" (expiration time) claim identifies the expiration time on
+ or after which the JWT MUST NOT be accepted for processing. The
+ processing of the "exp" claim requires that the current date/time
+ MUST be before the expiration date/time listed in the "exp" claim.
+ Implementers MAY provide for some small leeway, usually no more than
+ a few minutes, to account for clock skew. Its value MUST be a number
+ containing a NumericDate value. Use of this claim is OPTIONAL.
+ """
+ if "exp" in self:
+ exp = self["exp"]
+ if not _validate_numeric_time(exp):
+ raise InvalidClaimError("exp")
+ if exp < (now - leeway):
+ raise ExpiredTokenError()
+
+ def validate_nbf(self, now, leeway):
+ """The "nbf" (not before) claim identifies the time before which the JWT
+ MUST NOT be accepted for processing. The processing of the "nbf"
+ claim requires that the current date/time MUST be after or equal to
+ the not-before date/time listed in the "nbf" claim. Implementers MAY
+ provide for some small leeway, usually no more than a few minutes, to
+ account for clock skew. Its value MUST be a number containing a
+ NumericDate value. Use of this claim is OPTIONAL.
+ """
+ if "nbf" in self:
+ nbf = self["nbf"]
+ if not _validate_numeric_time(nbf):
+ raise InvalidClaimError("nbf")
+ if nbf > (now + leeway):
+ raise InvalidTokenError()
+
+ def validate_iat(self, now, leeway):
+ """The "iat" (issued at) claim identifies the time at which the JWT was
+ issued. This claim can be used to determine the age of the JWT.
+ Implementers MAY provide for some small leeway, usually no more
+ than a few minutes, to account for clock skew. Its value MUST be a
+ number containing a NumericDate value. Use of this claim is OPTIONAL.
+ """
+ if "iat" in self:
+ iat = self["iat"]
+ if not _validate_numeric_time(iat):
+ raise InvalidClaimError("iat")
+ if iat > (now + leeway):
+ raise InvalidTokenError(
+ description="The token is not valid as it was issued in the future"
+ )
+
+ def validate_jti(self):
+ """The "jti" (JWT ID) claim provides a unique identifier for the JWT.
+ The identifier value MUST be assigned in a manner that ensures that
+ there is a negligible probability that the same value will be
+ accidentally assigned to a different data object; if the application
+ uses multiple issuers, collisions MUST be prevented among values
+ produced by different issuers as well. The "jti" claim can be used
+ to prevent the JWT from being replayed. The "jti" value is a case-
+ sensitive string. Use of this claim is OPTIONAL.
+ """
+ self._validate_claim_value("jti")
+
+
+def _validate_numeric_time(s):
+ return isinstance(s, (int, float))
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/jwt.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/jwt.py
new file mode 100644
index 00000000..c52e9df9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc7519/jwt.py
@@ -0,0 +1,191 @@
+import calendar
+import datetime
+import random
+import re
+
+from authlib.common.encoding import json_dumps
+from authlib.common.encoding import json_loads
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+
+from ..errors import DecodeError
+from ..errors import InsecureClaimError
+from ..rfc7515 import JsonWebSignature
+from ..rfc7516 import JsonWebEncryption
+from ..rfc7517 import Key
+from ..rfc7517 import KeySet
+from .claims import JWTClaims
+
+
+class JsonWebToken:
+ SENSITIVE_NAMES = ("password", "token", "secret", "secret_key")
+ # Thanks to sentry SensitiveDataFilter
+ SENSITIVE_VALUES = re.compile(
+ r"|".join(
+ [
+ # http://www.richardsramblings.com/regex/credit-card-numbers/
+ r"\b(?:3[47]\d|(?:4\d|5[1-5]|65)\d{2}|6011)\d{12}\b",
+ # various private keys
+ r"-----BEGIN[A-Z ]+PRIVATE KEY-----.+-----END[A-Z ]+PRIVATE KEY-----",
+ # social security numbers (US)
+ r"^\b(?!(000|666|9))\d{3}-(?!00)\d{2}-(?!0000)\d{4}\b",
+ ]
+ ),
+ re.DOTALL,
+ )
+
+ def __init__(self, algorithms, private_headers=None):
+ self._jws = JsonWebSignature(algorithms, private_headers=private_headers)
+ self._jwe = JsonWebEncryption(algorithms, private_headers=private_headers)
+
+ def check_sensitive_data(self, payload):
+ """Check if payload contains sensitive information."""
+ for k in payload:
+ # check claims key name
+ if k in self.SENSITIVE_NAMES:
+ raise InsecureClaimError(k)
+
+ # check claims values
+ v = payload[k]
+ if isinstance(v, str) and self.SENSITIVE_VALUES.search(v):
+ raise InsecureClaimError(k)
+
+ def encode(self, header, payload, key, check=True):
+ """Encode a JWT with the given header, payload and key.
+
+ :param header: A dict of JWS header
+ :param payload: A dict to be encoded
+ :param key: key used to sign the signature
+ :param check: check if sensitive data in payload
+ :return: bytes
+ """
+ header.setdefault("typ", "JWT")
+
+ for k in ["exp", "iat", "nbf"]:
+ # convert datetime into timestamp
+ claim = payload.get(k)
+ if isinstance(claim, datetime.datetime):
+ payload[k] = calendar.timegm(claim.utctimetuple())
+
+ if check:
+ self.check_sensitive_data(payload)
+
+ key = find_encode_key(key, header)
+ text = to_bytes(json_dumps(payload))
+ if "enc" in header:
+ return self._jwe.serialize_compact(header, text, key)
+ else:
+ return self._jws.serialize_compact(header, text, key)
+
+ def decode(self, s, key, claims_cls=None, claims_options=None, claims_params=None):
+ """Decode the JWT with the given key. This is similar with
+ :meth:`verify`, except that it will raise BadSignatureError when
+ signature doesn't match.
+
+ :param s: text of JWT
+ :param key: key used to verify the signature
+ :param claims_cls: class to be used for JWT claims
+ :param claims_options: `options` parameters for claims_cls
+ :param claims_params: `params` parameters for claims_cls
+ :return: claims_cls instance
+ :raise: BadSignatureError
+ """
+ if claims_cls is None:
+ claims_cls = JWTClaims
+
+ if callable(key):
+ load_key = key
+ else:
+ load_key = create_load_key(prepare_raw_key(key))
+
+ s = to_bytes(s)
+ dot_count = s.count(b".")
+ if dot_count == 2:
+ data = self._jws.deserialize_compact(s, load_key, decode_payload)
+ elif dot_count == 4:
+ data = self._jwe.deserialize_compact(s, load_key, decode_payload)
+ else:
+ raise DecodeError("Invalid input segments length")
+ return claims_cls(
+ data["payload"],
+ data["header"],
+ options=claims_options,
+ params=claims_params,
+ )
+
+
+def decode_payload(bytes_payload):
+ try:
+ payload = json_loads(to_unicode(bytes_payload))
+ except ValueError as exc:
+ raise DecodeError("Invalid payload value") from exc
+ if not isinstance(payload, dict):
+ raise DecodeError("Invalid payload type")
+ return payload
+
+
+def prepare_raw_key(raw):
+ if isinstance(raw, KeySet):
+ return raw
+
+ if isinstance(raw, str) and raw.startswith("{") and raw.endswith("}"):
+ raw = json_loads(raw)
+ elif isinstance(raw, (tuple, list)):
+ raw = {"keys": raw}
+ return raw
+
+
+def find_encode_key(key, header):
+ if isinstance(key, KeySet):
+ kid = header.get("kid")
+ if kid:
+ return key.find_by_kid(kid)
+
+ rv = random.choice(key.keys)
+ # use side effect to add kid value into header
+ header["kid"] = rv.kid
+ return rv
+
+ if isinstance(key, dict) and "keys" in key:
+ keys = key["keys"]
+ kid = header.get("kid")
+ for k in keys:
+ if k.get("kid") == kid:
+ return k
+
+ if not kid:
+ rv = random.choice(keys)
+ header["kid"] = rv["kid"]
+ return rv
+ raise ValueError("Invalid JSON Web Key Set")
+
+ # append kid into header
+ if isinstance(key, dict) and "kid" in key:
+ header["kid"] = key["kid"]
+ elif isinstance(key, Key) and key.kid:
+ header["kid"] = key.kid
+ return key
+
+
+def create_load_key(key):
+ def load_key(header, payload):
+ if isinstance(key, KeySet):
+ return key.find_by_kid(header.get("kid"))
+
+ if isinstance(key, dict) and "keys" in key:
+ keys = key["keys"]
+ kid = header.get("kid")
+
+ if kid is not None:
+ # look for the requested key
+ for k in keys:
+ if k.get("kid") == kid:
+ return k
+ else:
+ # use the only key
+ if len(keys) == 1:
+ return keys[0]
+ raise ValueError("Invalid JSON Web Key Set")
+ return key
+
+ return load_key
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__init__.py
new file mode 100644
index 00000000..2c13c374
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__init__.py
@@ -0,0 +1,4 @@
+from .jws_eddsa import register_jws_rfc8037
+from .okp_key import OKPKey
+
+__all__ = ["register_jws_rfc8037", "OKPKey"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..5875525a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/jws_eddsa.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/jws_eddsa.cpython-312.pyc
new file mode 100644
index 00000000..74006b5b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/jws_eddsa.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/okp_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/okp_key.cpython-312.pyc
new file mode 100644
index 00000000..a2c8018f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/__pycache__/okp_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/jws_eddsa.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/jws_eddsa.py
new file mode 100644
index 00000000..e8ab16cc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/jws_eddsa.py
@@ -0,0 +1,28 @@
+from cryptography.exceptions import InvalidSignature
+
+from ..rfc7515 import JWSAlgorithm
+from .okp_key import OKPKey
+
+
+class EdDSAAlgorithm(JWSAlgorithm):
+ name = "EdDSA"
+ description = "Edwards-curve Digital Signature Algorithm for JWS"
+
+ def prepare_key(self, raw_data):
+ return OKPKey.import_key(raw_data)
+
+ def sign(self, msg, key):
+ op_key = key.get_op_key("sign")
+ return op_key.sign(msg)
+
+ def verify(self, msg, sig, key):
+ op_key = key.get_op_key("verify")
+ try:
+ op_key.verify(sig, msg)
+ return True
+ except InvalidSignature:
+ return False
+
+
+def register_jws_rfc8037(cls):
+ cls.register_algorithm(EdDSAAlgorithm())
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/okp_key.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/okp_key.py
new file mode 100644
index 00000000..034b40d1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/rfc8037/okp_key.py
@@ -0,0 +1,99 @@
+from cryptography.hazmat.primitives.asymmetric.ed448 import Ed448PrivateKey
+from cryptography.hazmat.primitives.asymmetric.ed448 import Ed448PublicKey
+from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PrivateKey
+from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PublicKey
+from cryptography.hazmat.primitives.asymmetric.x448 import X448PrivateKey
+from cryptography.hazmat.primitives.asymmetric.x448 import X448PublicKey
+from cryptography.hazmat.primitives.asymmetric.x25519 import X25519PrivateKey
+from cryptography.hazmat.primitives.asymmetric.x25519 import X25519PublicKey
+from cryptography.hazmat.primitives.serialization import Encoding
+from cryptography.hazmat.primitives.serialization import NoEncryption
+from cryptography.hazmat.primitives.serialization import PrivateFormat
+from cryptography.hazmat.primitives.serialization import PublicFormat
+
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+from authlib.common.encoding import urlsafe_b64decode
+from authlib.common.encoding import urlsafe_b64encode
+
+from ..rfc7517 import AsymmetricKey
+
+PUBLIC_KEYS_MAP = {
+ "Ed25519": Ed25519PublicKey,
+ "Ed448": Ed448PublicKey,
+ "X25519": X25519PublicKey,
+ "X448": X448PublicKey,
+}
+PRIVATE_KEYS_MAP = {
+ "Ed25519": Ed25519PrivateKey,
+ "Ed448": Ed448PrivateKey,
+ "X25519": X25519PrivateKey,
+ "X448": X448PrivateKey,
+}
+
+
+class OKPKey(AsymmetricKey):
+ """Key class of the ``OKP`` key type."""
+
+ kty = "OKP"
+ REQUIRED_JSON_FIELDS = ["crv", "x"]
+ PUBLIC_KEY_FIELDS = REQUIRED_JSON_FIELDS
+ PRIVATE_KEY_FIELDS = ["crv", "d"]
+ PUBLIC_KEY_CLS = tuple(PUBLIC_KEYS_MAP.values())
+ PRIVATE_KEY_CLS = tuple(PRIVATE_KEYS_MAP.values())
+ SSH_PUBLIC_PREFIX = b"ssh-ed25519"
+
+ def exchange_shared_key(self, pubkey):
+ # used in ECDHESAlgorithm
+ private_key = self.get_private_key()
+ if private_key and isinstance(private_key, (X25519PrivateKey, X448PrivateKey)):
+ return private_key.exchange(pubkey)
+ raise ValueError("Invalid key for exchanging shared key")
+
+ @staticmethod
+ def get_key_curve(key):
+ if isinstance(key, (Ed25519PublicKey, Ed25519PrivateKey)):
+ return "Ed25519"
+ elif isinstance(key, (Ed448PublicKey, Ed448PrivateKey)):
+ return "Ed448"
+ elif isinstance(key, (X25519PublicKey, X25519PrivateKey)):
+ return "X25519"
+ elif isinstance(key, (X448PublicKey, X448PrivateKey)):
+ return "X448"
+
+ def load_private_key(self):
+ crv_key = PRIVATE_KEYS_MAP[self._dict_data["crv"]]
+ d_bytes = urlsafe_b64decode(to_bytes(self._dict_data["d"]))
+ return crv_key.from_private_bytes(d_bytes)
+
+ def load_public_key(self):
+ crv_key = PUBLIC_KEYS_MAP[self._dict_data["crv"]]
+ x_bytes = urlsafe_b64decode(to_bytes(self._dict_data["x"]))
+ return crv_key.from_public_bytes(x_bytes)
+
+ def dumps_private_key(self):
+ obj = self.dumps_public_key(self.private_key.public_key())
+ d_bytes = self.private_key.private_bytes(
+ Encoding.Raw, PrivateFormat.Raw, NoEncryption()
+ )
+ obj["d"] = to_unicode(urlsafe_b64encode(d_bytes))
+ return obj
+
+ def dumps_public_key(self, public_key=None):
+ if public_key is None:
+ public_key = self.public_key
+ x_bytes = public_key.public_bytes(Encoding.Raw, PublicFormat.Raw)
+ return {
+ "crv": self.get_key_curve(public_key),
+ "x": to_unicode(urlsafe_b64encode(x_bytes)),
+ }
+
+ @classmethod
+ def generate_key(cls, crv="Ed25519", options=None, is_private=False) -> "OKPKey":
+ if crv not in PRIVATE_KEYS_MAP:
+ raise ValueError(f'Invalid crv value: "{crv}"')
+ private_key_cls = PRIVATE_KEYS_MAP[crv]
+ raw_key = private_key_cls.generate()
+ if not is_private:
+ raw_key = raw_key.public_key()
+ return cls.import_key(raw_key, options=options)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/jose/util.py b/Backend/venv/lib/python3.12/site-packages/authlib/jose/util.py
new file mode 100644
index 00000000..848b9501
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/jose/util.py
@@ -0,0 +1,46 @@
+import binascii
+
+from authlib.common.encoding import json_loads
+from authlib.common.encoding import to_unicode
+from authlib.common.encoding import urlsafe_b64decode
+from authlib.jose.errors import DecodeError
+
+
+def extract_header(header_segment, error_cls):
+ if len(header_segment) > 256000:
+ raise ValueError("Value of header is too long")
+
+ header_data = extract_segment(header_segment, error_cls, "header")
+
+ try:
+ header = json_loads(header_data.decode("utf-8"))
+ except ValueError as e:
+ raise error_cls(f"Invalid header string: {e}") from e
+
+ if not isinstance(header, dict):
+ raise error_cls("Header must be a json object")
+ return header
+
+
+def extract_segment(segment, error_cls, name="payload"):
+ if len(segment) > 256000:
+ raise ValueError(f"Value of {name} is too long")
+
+ try:
+ return urlsafe_b64decode(segment)
+ except (TypeError, binascii.Error) as exc:
+ msg = f"Invalid {name} padding"
+ raise error_cls(msg) from exc
+
+
+def ensure_dict(s, structure_name):
+ if not isinstance(s, dict):
+ try:
+ s = json_loads(to_unicode(s))
+ except (ValueError, TypeError) as exc:
+ raise DecodeError(f"Invalid {structure_name}") from exc
+
+ if not isinstance(s, dict):
+ raise DecodeError(f"Invalid {structure_name}")
+
+ return s
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__init__.py
new file mode 100644
index 00000000..203b73e4
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__init__.py
@@ -0,0 +1,31 @@
+from .rfc5849 import SIGNATURE_HMAC_SHA1
+from .rfc5849 import SIGNATURE_PLAINTEXT
+from .rfc5849 import SIGNATURE_RSA_SHA1
+from .rfc5849 import SIGNATURE_TYPE_BODY
+from .rfc5849 import SIGNATURE_TYPE_HEADER
+from .rfc5849 import SIGNATURE_TYPE_QUERY
+from .rfc5849 import AuthorizationServer
+from .rfc5849 import ClientAuth
+from .rfc5849 import ClientMixin
+from .rfc5849 import OAuth1Request
+from .rfc5849 import ResourceProtector
+from .rfc5849 import TemporaryCredential
+from .rfc5849 import TemporaryCredentialMixin
+from .rfc5849 import TokenCredentialMixin
+
+__all__ = [
+ "OAuth1Request",
+ "ClientAuth",
+ "SIGNATURE_HMAC_SHA1",
+ "SIGNATURE_RSA_SHA1",
+ "SIGNATURE_PLAINTEXT",
+ "SIGNATURE_TYPE_HEADER",
+ "SIGNATURE_TYPE_QUERY",
+ "SIGNATURE_TYPE_BODY",
+ "ClientMixin",
+ "TemporaryCredentialMixin",
+ "TokenCredentialMixin",
+ "TemporaryCredential",
+ "AuthorizationServer",
+ "ResourceProtector",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..b4a89fe0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/client.cpython-312.pyc
new file mode 100644
index 00000000..f9786721
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..21c43183
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/client.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/client.py
new file mode 100644
index 00000000..ad523da7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/client.py
@@ -0,0 +1,186 @@
+from authlib.common.encoding import json_loads
+from authlib.common.urls import add_params_to_uri
+from authlib.common.urls import url_decode
+from authlib.common.urls import urlparse
+
+from .rfc5849 import SIGNATURE_HMAC_SHA1
+from .rfc5849 import SIGNATURE_TYPE_HEADER
+from .rfc5849 import ClientAuth
+
+
+class OAuth1Client:
+ auth_class = ClientAuth
+
+ def __init__(
+ self,
+ session,
+ client_id,
+ client_secret=None,
+ token=None,
+ token_secret=None,
+ redirect_uri=None,
+ rsa_key=None,
+ verifier=None,
+ signature_method=SIGNATURE_HMAC_SHA1,
+ signature_type=SIGNATURE_TYPE_HEADER,
+ force_include_body=False,
+ realm=None,
+ **kwargs,
+ ):
+ if not client_id:
+ raise ValueError('Missing "client_id"')
+
+ self.session = session
+ self.auth = self.auth_class(
+ client_id,
+ client_secret=client_secret,
+ token=token,
+ token_secret=token_secret,
+ redirect_uri=redirect_uri,
+ signature_method=signature_method,
+ signature_type=signature_type,
+ rsa_key=rsa_key,
+ verifier=verifier,
+ realm=realm,
+ force_include_body=force_include_body,
+ )
+ self._kwargs = kwargs
+
+ @property
+ def redirect_uri(self):
+ return self.auth.redirect_uri
+
+ @redirect_uri.setter
+ def redirect_uri(self, uri):
+ self.auth.redirect_uri = uri
+
+ @property
+ def token(self):
+ return dict(
+ oauth_token=self.auth.token,
+ oauth_token_secret=self.auth.token_secret,
+ oauth_verifier=self.auth.verifier,
+ )
+
+ @token.setter
+ def token(self, token):
+ """This token setter is designed for an easy integration for
+ OAuthClient. Make sure both OAuth1Session and OAuth2Session
+ have token setters.
+ """
+ if token is None:
+ self.auth.token = None
+ self.auth.token_secret = None
+ self.auth.verifier = None
+ elif "oauth_token" in token:
+ self.auth.token = token["oauth_token"]
+ if "oauth_token_secret" in token:
+ self.auth.token_secret = token["oauth_token_secret"]
+ if "oauth_verifier" in token:
+ self.auth.verifier = token["oauth_verifier"]
+ else:
+ message = f"oauth_token is missing: {token!r}"
+ self.handle_error("missing_token", message)
+
+ def create_authorization_url(self, url, request_token=None, **kwargs):
+ """Create an authorization URL by appending request_token and optional
+ kwargs to url.
+
+ This is the second step in the OAuth 1 workflow. The user should be
+ redirected to this authorization URL, grant access to you, and then
+ be redirected back to you. The redirection back can either be specified
+ during client registration or by supplying a callback URI per request.
+
+ :param url: The authorization endpoint URL.
+ :param request_token: The previously obtained request token.
+ :param kwargs: Optional parameters to append to the URL.
+ :returns: The authorization URL with new parameters embedded.
+ """
+ kwargs["oauth_token"] = request_token or self.auth.token
+ if self.auth.redirect_uri:
+ kwargs["oauth_callback"] = self.auth.redirect_uri
+ return add_params_to_uri(url, kwargs.items())
+
+ def fetch_request_token(self, url, **kwargs):
+ """Method for fetching an access token from the token endpoint.
+
+ This is the first step in the OAuth 1 workflow. A request token is
+ obtained by making a signed post request to url. The token is then
+ parsed from the application/x-www-form-urlencoded response and ready
+ to be used to construct an authorization url.
+
+ :param url: Request Token endpoint.
+ :param kwargs: Extra parameters to include for fetching token.
+ :return: A Request Token dict.
+ """
+ return self._fetch_token(url, **kwargs)
+
+ def fetch_access_token(self, url, verifier=None, **kwargs):
+ """Method for fetching an access token from the token endpoint.
+
+ This is the final step in the OAuth 1 workflow. An access token is
+ obtained using all previously obtained credentials, including the
+ verifier from the authorization step.
+
+ :param url: Access Token endpoint.
+ :param verifier: A verifier string to prove authorization was granted.
+ :param kwargs: Extra parameters to include for fetching access token.
+ :return: A token dict.
+ """
+ if verifier:
+ self.auth.verifier = verifier
+ if not self.auth.verifier:
+ self.handle_error("missing_verifier", 'Missing "verifier" value')
+ return self._fetch_token(url, **kwargs)
+
+ def parse_authorization_response(self, url):
+ """Extract parameters from the post authorization redirect
+ response URL.
+
+ :param url: The full URL that resulted from the user being redirected
+ back from the OAuth provider to you, the client.
+ :returns: A dict of parameters extracted from the URL.
+ """
+ token = dict(url_decode(urlparse.urlparse(url).query))
+ self.token = token
+ return token
+
+ def _fetch_token(self, url, **kwargs):
+ resp = self.session.post(url, auth=self.auth, **kwargs)
+ token = self.parse_response_token(resp.status_code, resp.text)
+ self.token = token
+ self.auth.verifier = None
+ return token
+
+ def parse_response_token(self, status_code, text):
+ if status_code >= 400:
+ message = (
+ f"Token request failed with code {status_code}, response was '{text}'."
+ )
+ self.handle_error("fetch_token_denied", message)
+
+ try:
+ text = text.strip()
+ if text.startswith("{"):
+ token = json_loads(text)
+ else:
+ token = dict(url_decode(text))
+ except (TypeError, ValueError) as e:
+ error = (
+ "Unable to decode token from token response. "
+ "This is commonly caused by an unsuccessful request where"
+ " a non urlencoded error message is returned. "
+ f"The decoding error was {e}"
+ )
+ raise ValueError(error) from e
+ return token
+
+ @staticmethod
+ def handle_error(error_type, error_description):
+ raise ValueError(f"{error_type}: {error_description}")
+
+ def __del__(self):
+ try:
+ del self.session
+ except AttributeError:
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/errors.py
new file mode 100644
index 00000000..e7770da5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/errors.py
@@ -0,0 +1,3 @@
+# flake8: noqa
+
+from .rfc5849.errors import *
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__init__.py
new file mode 100644
index 00000000..bb7fad8c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__init__.py
@@ -0,0 +1,39 @@
+"""authlib.oauth1.rfc5849.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of The OAuth 1.0 Protocol.
+
+https://tools.ietf.org/html/rfc5849
+"""
+
+from .authorization_server import AuthorizationServer
+from .client_auth import ClientAuth
+from .models import ClientMixin
+from .models import TemporaryCredential
+from .models import TemporaryCredentialMixin
+from .models import TokenCredentialMixin
+from .resource_protector import ResourceProtector
+from .signature import SIGNATURE_HMAC_SHA1
+from .signature import SIGNATURE_PLAINTEXT
+from .signature import SIGNATURE_RSA_SHA1
+from .signature import SIGNATURE_TYPE_BODY
+from .signature import SIGNATURE_TYPE_HEADER
+from .signature import SIGNATURE_TYPE_QUERY
+from .wrapper import OAuth1Request
+
+__all__ = [
+ "OAuth1Request",
+ "ClientAuth",
+ "SIGNATURE_HMAC_SHA1",
+ "SIGNATURE_RSA_SHA1",
+ "SIGNATURE_PLAINTEXT",
+ "SIGNATURE_TYPE_HEADER",
+ "SIGNATURE_TYPE_QUERY",
+ "SIGNATURE_TYPE_BODY",
+ "ClientMixin",
+ "TemporaryCredentialMixin",
+ "TokenCredentialMixin",
+ "TemporaryCredential",
+ "AuthorizationServer",
+ "ResourceProtector",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..9ccade76
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/authorization_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/authorization_server.cpython-312.pyc
new file mode 100644
index 00000000..8e16586f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/authorization_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/base_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/base_server.cpython-312.pyc
new file mode 100644
index 00000000..24408201
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/base_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/client_auth.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/client_auth.cpython-312.pyc
new file mode 100644
index 00000000..5ea57f7d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/client_auth.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..447a75f5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..1c0bf0c0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/parameters.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/parameters.cpython-312.pyc
new file mode 100644
index 00000000..84c1c4e7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/parameters.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/resource_protector.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/resource_protector.cpython-312.pyc
new file mode 100644
index 00000000..0d6bccbc
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/resource_protector.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/rsa.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/rsa.cpython-312.pyc
new file mode 100644
index 00000000..8c969ac4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/rsa.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/signature.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/signature.cpython-312.pyc
new file mode 100644
index 00000000..1c7dd4a8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/signature.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/util.cpython-312.pyc
new file mode 100644
index 00000000..27a69f7f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/wrapper.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/wrapper.cpython-312.pyc
new file mode 100644
index 00000000..7ab603ff
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/__pycache__/wrapper.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/authorization_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/authorization_server.py
new file mode 100644
index 00000000..ddbf293b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/authorization_server.py
@@ -0,0 +1,350 @@
+from authlib.common.urls import add_params_to_uri
+from authlib.common.urls import is_valid_url
+
+from .base_server import BaseServer
+from .errors import AccessDeniedError
+from .errors import InvalidClientError
+from .errors import InvalidRequestError
+from .errors import InvalidTokenError
+from .errors import MethodNotAllowedError
+from .errors import MissingRequiredParameterError
+from .errors import OAuth1Error
+
+
+class AuthorizationServer(BaseServer):
+ TOKEN_RESPONSE_HEADER = [
+ ("Content-Type", "application/x-www-form-urlencoded"),
+ ("Cache-Control", "no-store"),
+ ("Pragma", "no-cache"),
+ ]
+
+ TEMPORARY_CREDENTIALS_METHOD = "POST"
+
+ def _get_client(self, request):
+ client = self.get_client_by_id(request.client_id)
+ request.client = client
+ return client
+
+ def create_oauth1_request(self, request):
+ raise NotImplementedError()
+
+ def handle_response(self, status_code, payload, headers):
+ raise NotImplementedError()
+
+ def handle_error_response(self, error):
+ return self.handle_response(
+ error.status_code, error.get_body(), error.get_headers()
+ )
+
+ def validate_temporary_credentials_request(self, request):
+ """Validate HTTP request for temporary credentials."""
+ # The client obtains a set of temporary credentials from the server by
+ # making an authenticated (Section 3) HTTP "POST" request to the
+ # Temporary Credential Request endpoint (unless the server advertises
+ # another HTTP request method for the client to use).
+ if request.method.upper() != self.TEMPORARY_CREDENTIALS_METHOD:
+ raise MethodNotAllowedError()
+
+ # REQUIRED parameter
+ if not request.client_id:
+ raise MissingRequiredParameterError("oauth_consumer_key")
+
+ # REQUIRED parameter
+ oauth_callback = request.redirect_uri
+ if not request.redirect_uri:
+ raise MissingRequiredParameterError("oauth_callback")
+
+ # An absolute URI or
+ # other means (the parameter value MUST be set to "oob"
+ if oauth_callback != "oob" and not is_valid_url(oauth_callback):
+ raise InvalidRequestError('Invalid "oauth_callback" value')
+
+ client = self._get_client(request)
+ if not client:
+ raise InvalidClientError()
+
+ self.validate_timestamp_and_nonce(request)
+ self.validate_oauth_signature(request)
+ return request
+
+ def create_temporary_credentials_response(self, request=None):
+ """Validate temporary credentials token request and create response
+ for temporary credentials token. Assume the endpoint of temporary
+ credentials request is ``https://photos.example.net/initiate``:
+
+ .. code-block:: http
+
+ POST /initiate HTTP/1.1
+ Host: photos.example.net
+ Authorization: OAuth realm="Photos",
+ oauth_consumer_key="dpf43f3p2l4k3l03",
+ oauth_signature_method="HMAC-SHA1",
+ oauth_timestamp="137131200",
+ oauth_nonce="wIjqoS",
+ oauth_callback="http%3A%2F%2Fprinter.example.com%2Fready",
+ oauth_signature="74KNZJeDHnMBp0EMJ9ZHt%2FXKycU%3D"
+
+ The server validates the request and replies with a set of temporary
+ credentials in the body of the HTTP response:
+
+ .. code-block:: http
+
+ HTTP/1.1 200 OK
+ Content-Type: application/x-www-form-urlencoded
+
+ oauth_token=hh5s93j4hdidpola&oauth_token_secret=hdhd0244k9j7ao03&
+ oauth_callback_confirmed=true
+
+ :param request: OAuth1Request instance.
+ :returns: (status_code, body, headers)
+ """
+ try:
+ request = self.create_oauth1_request(request)
+ self.validate_temporary_credentials_request(request)
+ except OAuth1Error as error:
+ return self.handle_error_response(error)
+
+ credential = self.create_temporary_credential(request)
+ payload = [
+ ("oauth_token", credential.get_oauth_token()),
+ ("oauth_token_secret", credential.get_oauth_token_secret()),
+ ("oauth_callback_confirmed", True),
+ ]
+ return self.handle_response(200, payload, self.TOKEN_RESPONSE_HEADER)
+
+ def validate_authorization_request(self, request):
+ """Validate the request for resource owner authorization."""
+ if not request.token:
+ raise MissingRequiredParameterError("oauth_token")
+
+ credential = self.get_temporary_credential(request)
+ if not credential:
+ raise InvalidTokenError()
+
+ # assign credential for later use
+ request.credential = credential
+ return request
+
+ def create_authorization_response(self, request, grant_user=None):
+ """Validate authorization request and create authorization response.
+ Assume the endpoint for authorization request is
+ ``https://photos.example.net/authorize``, the client redirects Jane's
+ user-agent to the server's Resource Owner Authorization endpoint to
+ obtain Jane's approval for accessing her private photos::
+
+ https://photos.example.net/authorize?oauth_token=hh5s93j4hdidpola
+
+ The server requests Jane to sign in using her username and password
+ and if successful, asks her to approve granting 'printer.example.com'
+ access to her private photos. Jane approves the request and her
+ user-agent is redirected to the callback URI provided by the client
+ in the previous request (line breaks are for display purposes only)::
+
+ http://printer.example.com/ready?
+ oauth_token=hh5s93j4hdidpola&oauth_verifier=hfdp7dh39dks9884
+
+ :param request: OAuth1Request instance.
+ :param grant_user: if granted, pass the grant user, otherwise None.
+ :returns: (status_code, body, headers)
+ """
+ request = self.create_oauth1_request(request)
+ # authorize endpoint should try catch this error
+ self.validate_authorization_request(request)
+
+ temporary_credentials = request.credential
+ redirect_uri = temporary_credentials.get_redirect_uri()
+ if not redirect_uri or redirect_uri == "oob":
+ client_id = temporary_credentials.get_client_id()
+ client = self.get_client_by_id(client_id)
+ redirect_uri = client.get_default_redirect_uri()
+
+ if grant_user is None:
+ error = AccessDeniedError()
+ location = add_params_to_uri(redirect_uri, error.get_body())
+ return self.handle_response(302, "", [("Location", location)])
+
+ request.user = grant_user
+ verifier = self.create_authorization_verifier(request)
+
+ params = [("oauth_token", request.token), ("oauth_verifier", verifier)]
+ location = add_params_to_uri(redirect_uri, params)
+ return self.handle_response(302, "", [("Location", location)])
+
+ def validate_token_request(self, request):
+ """Validate request for issuing token."""
+ if not request.client_id:
+ raise MissingRequiredParameterError("oauth_consumer_key")
+
+ client = self._get_client(request)
+ if not client:
+ raise InvalidClientError()
+
+ if not request.token:
+ raise MissingRequiredParameterError("oauth_token")
+
+ token = self.get_temporary_credential(request)
+ if not token:
+ raise InvalidTokenError()
+
+ verifier = request.oauth_params.get("oauth_verifier")
+ if not verifier:
+ raise MissingRequiredParameterError("oauth_verifier")
+
+ if not token.check_verifier(verifier):
+ raise InvalidRequestError('Invalid "oauth_verifier"')
+
+ request.credential = token
+ self.validate_timestamp_and_nonce(request)
+ self.validate_oauth_signature(request)
+ return request
+
+ def create_token_response(self, request):
+ """Validate token request and create token response. Assuming the
+ endpoint of token request is ``https://photos.example.net/token``,
+ the callback request informs the client that Jane completed the
+ authorization process. The client then requests a set of token
+ credentials using its temporary credentials (over a secure Transport
+ Layer Security (TLS) channel):
+
+ .. code-block:: http
+
+ POST /token HTTP/1.1
+ Host: photos.example.net
+ Authorization: OAuth realm="Photos",
+ oauth_consumer_key="dpf43f3p2l4k3l03",
+ oauth_token="hh5s93j4hdidpola",
+ oauth_signature_method="HMAC-SHA1",
+ oauth_timestamp="137131201",
+ oauth_nonce="walatlh",
+ oauth_verifier="hfdp7dh39dks9884",
+ oauth_signature="gKgrFCywp7rO0OXSjdot%2FIHF7IU%3D"
+
+ The server validates the request and replies with a set of token
+ credentials in the body of the HTTP response:
+
+ .. code-block:: http
+
+ HTTP/1.1 200 OK
+ Content-Type: application/x-www-form-urlencoded
+
+ oauth_token=nnch734d00sl2jdk&oauth_token_secret=pfkkdhi9sl3r4s00
+
+ :param request: OAuth1Request instance.
+ :returns: (status_code, body, headers)
+ """
+ try:
+ request = self.create_oauth1_request(request)
+ except OAuth1Error as error:
+ return self.handle_error_response(error)
+
+ try:
+ self.validate_token_request(request)
+ except OAuth1Error as error:
+ self.delete_temporary_credential(request)
+ return self.handle_error_response(error)
+
+ credential = self.create_token_credential(request)
+ payload = [
+ ("oauth_token", credential.get_oauth_token()),
+ ("oauth_token_secret", credential.get_oauth_token_secret()),
+ ]
+ self.delete_temporary_credential(request)
+ return self.handle_response(200, payload, self.TOKEN_RESPONSE_HEADER)
+
+ def create_temporary_credential(self, request):
+ """Generate and save a temporary credential into database or cache.
+ A temporary credential is used for exchanging token credential. This
+ method should be re-implemented::
+
+ def create_temporary_credential(self, request):
+ oauth_token = generate_token(36)
+ oauth_token_secret = generate_token(48)
+ temporary_credential = TemporaryCredential(
+ oauth_token=oauth_token,
+ oauth_token_secret=oauth_token_secret,
+ client_id=request.client_id,
+ redirect_uri=request.redirect_uri,
+ )
+ # if the credential has a save method
+ temporary_credential.save()
+ return temporary_credential
+
+ :param request: OAuth1Request instance
+ :return: TemporaryCredential instance
+ """
+ raise NotImplementedError()
+
+ def get_temporary_credential(self, request):
+ """Get the temporary credential from database or cache. A temporary
+ credential should share the same methods as described in models of
+ ``TemporaryCredentialMixin``::
+
+ def get_temporary_credential(self, request):
+ key = "a-key-prefix:{}".format(request.token)
+ data = cache.get(key)
+ # TemporaryCredential shares methods from TemporaryCredentialMixin
+ return TemporaryCredential(data)
+
+ :param request: OAuth1Request instance
+ :return: TemporaryCredential instance
+ """
+ raise NotImplementedError()
+
+ def delete_temporary_credential(self, request):
+ """Delete temporary credential from database or cache. For instance,
+ if temporary credential is saved in cache::
+
+ def delete_temporary_credential(self, request):
+ key = "a-key-prefix:{}".format(request.token)
+ cache.delete(key)
+
+ :param request: OAuth1Request instance
+ """
+ raise NotImplementedError()
+
+ def create_authorization_verifier(self, request):
+ """Create and bind ``oauth_verifier`` to temporary credential. It
+ could be re-implemented in this way::
+
+ def create_authorization_verifier(self, request):
+ verifier = generate_token(36)
+
+ temporary_credential = request.credential
+ user_id = request.user.id
+
+ temporary_credential.user_id = user_id
+ temporary_credential.oauth_verifier = verifier
+ # if the credential has a save method
+ temporary_credential.save()
+
+ # remember to return the verifier
+ return verifier
+
+ :param request: OAuth1Request instance
+ :return: A string of ``oauth_verifier``
+ """
+ raise NotImplementedError()
+
+ def create_token_credential(self, request):
+ """Create and save token credential into database. This method would
+ be re-implemented like this::
+
+ def create_token_credential(self, request):
+ oauth_token = generate_token(36)
+ oauth_token_secret = generate_token(48)
+ temporary_credential = request.credential
+
+ token_credential = TokenCredential(
+ oauth_token=oauth_token,
+ oauth_token_secret=oauth_token_secret,
+ client_id=temporary_credential.get_client_id(),
+ user_id=temporary_credential.get_user_id(),
+ )
+ # if the credential has a save method
+ token_credential.save()
+ return token_credential
+
+ :param request: OAuth1Request instance
+ :return: TokenCredential instance
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/base_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/base_server.py
new file mode 100644
index 00000000..68bb426b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/base_server.py
@@ -0,0 +1,115 @@
+import time
+
+from .errors import InvalidNonceError
+from .errors import InvalidRequestError
+from .errors import InvalidSignatureError
+from .errors import MissingRequiredParameterError
+from .errors import UnsupportedSignatureMethodError
+from .signature import SIGNATURE_HMAC_SHA1
+from .signature import SIGNATURE_PLAINTEXT
+from .signature import SIGNATURE_RSA_SHA1
+from .signature import verify_hmac_sha1
+from .signature import verify_plaintext
+from .signature import verify_rsa_sha1
+
+
+class BaseServer:
+ SIGNATURE_METHODS = {
+ SIGNATURE_HMAC_SHA1: verify_hmac_sha1,
+ SIGNATURE_RSA_SHA1: verify_rsa_sha1,
+ SIGNATURE_PLAINTEXT: verify_plaintext,
+ }
+ SUPPORTED_SIGNATURE_METHODS = [SIGNATURE_HMAC_SHA1]
+ EXPIRY_TIME = 300
+
+ @classmethod
+ def register_signature_method(cls, name, verify):
+ """Extend signature method verification.
+
+ :param name: A string to represent signature method.
+ :param verify: A function to verify signature.
+
+ The ``verify`` method accept ``OAuth1Request`` as parameter::
+
+ def verify_custom_method(request):
+ # verify this request, return True or False
+ return True
+
+
+ Server.register_signature_method("custom-name", verify_custom_method)
+ """
+ cls.SIGNATURE_METHODS[name] = verify
+
+ def validate_timestamp_and_nonce(self, request):
+ """Validate ``oauth_timestamp`` and ``oauth_nonce`` in HTTP request.
+
+ :param request: OAuth1Request instance
+ """
+ timestamp = request.oauth_params.get("oauth_timestamp")
+ nonce = request.oauth_params.get("oauth_nonce")
+
+ if request.signature_method == SIGNATURE_PLAINTEXT:
+ # The parameters MAY be omitted when using the "PLAINTEXT"
+ # signature method
+ if not timestamp and not nonce:
+ return
+
+ if not timestamp:
+ raise MissingRequiredParameterError("oauth_timestamp")
+
+ try:
+ # The timestamp value MUST be a positive integer
+ timestamp = int(timestamp)
+ if timestamp < 0:
+ raise InvalidRequestError('Invalid "oauth_timestamp" value')
+
+ if self.EXPIRY_TIME and time.time() - timestamp > self.EXPIRY_TIME:
+ raise InvalidRequestError('Invalid "oauth_timestamp" value')
+ except (ValueError, TypeError) as exc:
+ raise InvalidRequestError('Invalid "oauth_timestamp" value') from exc
+
+ if not nonce:
+ raise MissingRequiredParameterError("oauth_nonce")
+
+ if self.exists_nonce(nonce, request):
+ raise InvalidNonceError()
+
+ def validate_oauth_signature(self, request):
+ """Validate ``oauth_signature`` from HTTP request.
+
+ :param request: OAuth1Request instance
+ """
+ method = request.signature_method
+ if not method:
+ raise MissingRequiredParameterError("oauth_signature_method")
+
+ if method not in self.SUPPORTED_SIGNATURE_METHODS:
+ raise UnsupportedSignatureMethodError()
+
+ if not request.signature:
+ raise MissingRequiredParameterError("oauth_signature")
+
+ verify = self.SIGNATURE_METHODS.get(method)
+ if not verify:
+ raise UnsupportedSignatureMethodError()
+
+ if not verify(request):
+ raise InvalidSignatureError()
+
+ def get_client_by_id(self, client_id):
+ """Get client instance with the given ``client_id``.
+
+ :param client_id: A string of client_id
+ :return: Client instance
+ """
+ raise NotImplementedError()
+
+ def exists_nonce(self, nonce, request):
+ """The nonce value MUST be unique across all requests with the same
+ timestamp, client credentials, and token combinations.
+
+ :param nonce: A string value of ``oauth_nonce``
+ :param request: OAuth1Request instance
+ :return: Boolean
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/client_auth.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/client_auth.py
new file mode 100644
index 00000000..81c8188b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/client_auth.py
@@ -0,0 +1,191 @@
+import base64
+import hashlib
+import time
+
+from authlib.common.encoding import to_native
+from authlib.common.security import generate_token
+from authlib.common.urls import extract_params
+
+from .parameters import prepare_form_encoded_body
+from .parameters import prepare_headers
+from .parameters import prepare_request_uri_query
+from .signature import SIGNATURE_HMAC_SHA1
+from .signature import SIGNATURE_PLAINTEXT
+from .signature import SIGNATURE_RSA_SHA1
+from .signature import SIGNATURE_TYPE_BODY
+from .signature import SIGNATURE_TYPE_HEADER
+from .signature import SIGNATURE_TYPE_QUERY
+from .signature import sign_hmac_sha1
+from .signature import sign_plaintext
+from .signature import sign_rsa_sha1
+from .wrapper import OAuth1Request
+
+CONTENT_TYPE_FORM_URLENCODED = "application/x-www-form-urlencoded"
+CONTENT_TYPE_MULTI_PART = "multipart/form-data"
+
+
+class ClientAuth:
+ SIGNATURE_METHODS = {
+ SIGNATURE_HMAC_SHA1: sign_hmac_sha1,
+ SIGNATURE_RSA_SHA1: sign_rsa_sha1,
+ SIGNATURE_PLAINTEXT: sign_plaintext,
+ }
+
+ @classmethod
+ def register_signature_method(cls, name, sign):
+ """Extend client signature methods.
+
+ :param name: A string to represent signature method.
+ :param sign: A function to generate signature.
+
+ The ``sign`` method accept 2 parameters::
+
+ def custom_sign_method(client, request):
+ # client is the instance of Client.
+ return "your-signed-string"
+
+
+ Client.register_signature_method("custom-name", custom_sign_method)
+ """
+ cls.SIGNATURE_METHODS[name] = sign
+
+ def __init__(
+ self,
+ client_id,
+ client_secret=None,
+ token=None,
+ token_secret=None,
+ redirect_uri=None,
+ rsa_key=None,
+ verifier=None,
+ signature_method=SIGNATURE_HMAC_SHA1,
+ signature_type=SIGNATURE_TYPE_HEADER,
+ realm=None,
+ force_include_body=False,
+ ):
+ self.client_id = client_id
+ self.client_secret = client_secret
+ self.token = token
+ self.token_secret = token_secret
+ self.redirect_uri = redirect_uri
+ self.signature_method = signature_method
+ self.signature_type = signature_type
+ self.rsa_key = rsa_key
+ self.verifier = verifier
+ self.realm = realm
+ self.force_include_body = force_include_body
+
+ def get_oauth_signature(self, method, uri, headers, body):
+ """Get an OAuth signature to be used in signing a request.
+
+ To satisfy `section 3.4.1.2`_ item 2, if the request argument's
+ headers dict attribute contains a Host item, its value will
+ replace any netloc part of the request argument's uri attribute
+ value.
+
+ .. _`section 3.4.1.2`: https://tools.ietf.org/html/rfc5849#section-3.4.1.2
+ """
+ sign = self.SIGNATURE_METHODS.get(self.signature_method)
+ if not sign:
+ raise ValueError("Invalid signature method.")
+
+ request = OAuth1Request(method, uri, body=body, headers=headers)
+ return sign(self, request)
+
+ def get_oauth_params(self, nonce, timestamp):
+ oauth_params = [
+ ("oauth_nonce", nonce),
+ ("oauth_timestamp", timestamp),
+ ("oauth_version", "1.0"),
+ ("oauth_signature_method", self.signature_method),
+ ("oauth_consumer_key", self.client_id),
+ ]
+ if self.token:
+ oauth_params.append(("oauth_token", self.token))
+ if self.redirect_uri:
+ oauth_params.append(("oauth_callback", self.redirect_uri))
+ if self.verifier:
+ oauth_params.append(("oauth_verifier", self.verifier))
+ return oauth_params
+
+ def _render(self, uri, headers, body, oauth_params):
+ if self.signature_type == SIGNATURE_TYPE_HEADER:
+ headers = prepare_headers(oauth_params, headers, realm=self.realm)
+ elif self.signature_type == SIGNATURE_TYPE_BODY:
+ if CONTENT_TYPE_FORM_URLENCODED in headers.get("Content-Type", ""):
+ decoded_body = extract_params(body) or []
+ body = prepare_form_encoded_body(oauth_params, decoded_body)
+ headers["Content-Type"] = CONTENT_TYPE_FORM_URLENCODED
+ elif self.signature_type == SIGNATURE_TYPE_QUERY:
+ uri = prepare_request_uri_query(oauth_params, uri)
+ else:
+ raise ValueError("Unknown signature type specified.")
+ return uri, headers, body
+
+ def sign(self, method, uri, headers, body):
+ """Sign the HTTP request, add OAuth parameters and signature.
+
+ :param method: HTTP method of the request.
+ :param uri: URI of the HTTP request.
+ :param body: Body payload of the HTTP request.
+ :param headers: Headers of the HTTP request.
+ :return: uri, headers, body
+ """
+ nonce = generate_nonce()
+ timestamp = generate_timestamp()
+ if body is None:
+ body = b""
+
+ # transform int to str
+ timestamp = str(timestamp)
+
+ if headers is None:
+ headers = {}
+
+ oauth_params = self.get_oauth_params(nonce, timestamp)
+
+ # https://datatracker.ietf.org/doc/html/draft-eaton-oauth-bodyhash-00.html
+ # include oauth_body_hash
+ if body and headers.get("Content-Type") != CONTENT_TYPE_FORM_URLENCODED:
+ oauth_body_hash = base64.b64encode(hashlib.sha1(body).digest())
+ oauth_params.append(("oauth_body_hash", oauth_body_hash.decode("utf-8")))
+
+ uri, headers, body = self._render(uri, headers, body, oauth_params)
+
+ sig = self.get_oauth_signature(method, uri, headers, body)
+ oauth_params.append(("oauth_signature", sig))
+
+ uri, headers, body = self._render(uri, headers, body, oauth_params)
+ return uri, headers, body
+
+ def prepare(self, method, uri, headers, body):
+ """Add OAuth parameters to the request.
+
+ Parameters may be included from the body if the content-type is
+ urlencoded, if no content type is set, a guess is made.
+ """
+ content_type = to_native(headers.get("Content-Type", ""))
+ if self.signature_type == SIGNATURE_TYPE_BODY:
+ content_type = CONTENT_TYPE_FORM_URLENCODED
+ elif not content_type and extract_params(body):
+ content_type = CONTENT_TYPE_FORM_URLENCODED
+
+ if CONTENT_TYPE_FORM_URLENCODED in content_type:
+ headers["Content-Type"] = CONTENT_TYPE_FORM_URLENCODED
+ uri, headers, body = self.sign(method, uri, headers, body)
+ elif self.force_include_body:
+ # To allow custom clients to work on non form encoded bodies.
+ uri, headers, body = self.sign(method, uri, headers, body)
+ else:
+ # Omit body data in the signing of non form-encoded requests
+ uri, headers, _ = self.sign(method, uri, headers, b"")
+ body = b""
+ return uri, headers, body
+
+
+def generate_nonce():
+ return generate_token()
+
+
+def generate_timestamp():
+ return str(int(time.time()))
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/errors.py
new file mode 100644
index 00000000..9826aec6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/errors.py
@@ -0,0 +1,89 @@
+"""authlib.oauth1.rfc5849.errors.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+RFC5849 has no definition on errors. This module is designed by
+Authlib based on OAuth 1.0a `Section 10`_ with some changes.
+
+.. _`Section 10`: https://oauth.net/core/1.0a/#rfc.section.10
+"""
+
+from authlib.common.errors import AuthlibHTTPError
+from authlib.common.security import is_secure_transport
+
+
+class OAuth1Error(AuthlibHTTPError):
+ def __init__(self, description=None, uri=None, status_code=None):
+ super().__init__(None, description, uri, status_code)
+
+ def get_headers(self):
+ """Get a list of headers."""
+ return [
+ ("Content-Type", "application/x-www-form-urlencoded"),
+ ("Cache-Control", "no-store"),
+ ("Pragma", "no-cache"),
+ ]
+
+
+class InsecureTransportError(OAuth1Error):
+ error = "insecure_transport"
+ description = "OAuth 2 MUST utilize https."
+
+ @classmethod
+ def check(cls, uri):
+ if not is_secure_transport(uri):
+ raise cls()
+
+
+class InvalidRequestError(OAuth1Error):
+ error = "invalid_request"
+
+
+class UnsupportedParameterError(OAuth1Error):
+ error = "unsupported_parameter"
+
+
+class UnsupportedSignatureMethodError(OAuth1Error):
+ error = "unsupported_signature_method"
+
+
+class MissingRequiredParameterError(OAuth1Error):
+ error = "missing_required_parameter"
+
+ def __init__(self, key):
+ description = f'missing "{key}" in parameters'
+ super().__init__(description=description)
+
+
+class DuplicatedOAuthProtocolParameterError(OAuth1Error):
+ error = "duplicated_oauth_protocol_parameter"
+
+
+class InvalidClientError(OAuth1Error):
+ error = "invalid_client"
+ status_code = 401
+
+
+class InvalidTokenError(OAuth1Error):
+ error = "invalid_token"
+ description = 'Invalid or expired "oauth_token" in parameters'
+ status_code = 401
+
+
+class InvalidSignatureError(OAuth1Error):
+ error = "invalid_signature"
+ status_code = 401
+
+
+class InvalidNonceError(OAuth1Error):
+ error = "invalid_nonce"
+ status_code = 401
+
+
+class AccessDeniedError(OAuth1Error):
+ error = "access_denied"
+ description = "The resource owner or authorization server denied the request"
+
+
+class MethodNotAllowedError(OAuth1Error):
+ error = "method_not_allowed"
+ status_code = 405
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/models.py
new file mode 100644
index 00000000..04245d16
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/models.py
@@ -0,0 +1,108 @@
+class ClientMixin:
+ def get_default_redirect_uri(self):
+ """A method to get client default redirect_uri. For instance, the
+ database table for client has a column called ``default_redirect_uri``::
+
+ def get_default_redirect_uri(self):
+ return self.default_redirect_uri
+
+ :return: A URL string
+ """
+ raise NotImplementedError()
+
+ def get_client_secret(self):
+ """A method to return the client_secret of this client. For instance,
+ the database table has a column called ``client_secret``::
+
+ def get_client_secret(self):
+ return self.client_secret
+ """
+ raise NotImplementedError()
+
+ def get_rsa_public_key(self):
+ """A method to get the RSA public key for RSA-SHA1 signature method.
+ For instance, the value is saved on column ``rsa_public_key``::
+
+ def get_rsa_public_key(self):
+ return self.rsa_public_key
+ """
+ raise NotImplementedError()
+
+
+class TokenCredentialMixin:
+ def get_oauth_token(self):
+ """A method to get the value of ``oauth_token``. For instance, the
+ database table has a column called ``oauth_token``::
+
+ def get_oauth_token(self):
+ return self.oauth_token
+
+ :return: A string
+ """
+ raise NotImplementedError()
+
+ def get_oauth_token_secret(self):
+ """A method to get the value of ``oauth_token_secret``. For instance,
+ the database table has a column called ``oauth_token_secret``::
+
+ def get_oauth_token_secret(self):
+ return self.oauth_token_secret
+
+ :return: A string
+ """
+ raise NotImplementedError()
+
+
+class TemporaryCredentialMixin(TokenCredentialMixin):
+ def get_client_id(self):
+ """A method to get the client_id associated with this credential.
+ For instance, the table in the database has a column ``client_id``::
+
+ def get_client_id(self):
+ return self.client_id
+ """
+ raise NotImplementedError()
+
+ def get_redirect_uri(self):
+ """A method to get temporary credential's ``oauth_callback``.
+ For instance, the database table for temporary credential has a
+ column called ``oauth_callback``::
+
+ def get_redirect_uri(self):
+ return self.oauth_callback
+
+ :return: A URL string
+ """
+ raise NotImplementedError()
+
+ def check_verifier(self, verifier):
+ """A method to check if the given verifier matches this temporary
+ credential. For instance that this temporary credential has recorded
+ the value in database as column ``oauth_verifier``::
+
+ def check_verifier(self, verifier):
+ return self.oauth_verifier == verifier
+
+ :return: Boolean
+ """
+ raise NotImplementedError()
+
+
+class TemporaryCredential(dict, TemporaryCredentialMixin):
+ def get_client_id(self):
+ return self.get("client_id")
+
+ def get_user_id(self):
+ return self.get("user_id")
+
+ def get_redirect_uri(self):
+ return self.get("oauth_callback")
+
+ def check_verifier(self, verifier):
+ return self.get("oauth_verifier") == verifier
+
+ def get_oauth_token(self):
+ return self.get("oauth_token")
+
+ def get_oauth_token_secret(self):
+ return self.get("oauth_token_secret")
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/parameters.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/parameters.py
new file mode 100644
index 00000000..54574244
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/parameters.py
@@ -0,0 +1,106 @@
+"""authlib.spec.rfc5849.parameters.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This module contains methods related to `section 3.5`_ of the OAuth 1.0a spec.
+
+.. _`section 3.5`: https://tools.ietf.org/html/rfc5849#section-3.5
+"""
+
+from authlib.common.urls import extract_params
+from authlib.common.urls import url_encode
+from authlib.common.urls import urlparse
+
+from .util import escape
+
+
+def prepare_headers(oauth_params, headers=None, realm=None):
+ """**Prepare the Authorization header.**
+ Per `section 3.5.1`_ of the spec.
+
+ Protocol parameters can be transmitted using the HTTP "Authorization"
+ header field as defined by `RFC2617`_ with the auth-scheme name set to
+ "OAuth" (case insensitive).
+
+ For example::
+
+ Authorization: OAuth realm="Photos",
+ oauth_consumer_key="dpf43f3p2l4k3l03",
+ oauth_signature_method="HMAC-SHA1",
+ oauth_timestamp="137131200",
+ oauth_nonce="wIjqoS",
+ oauth_callback="http%3A%2F%2Fprinter.example.com%2Fready",
+ oauth_signature="74KNZJeDHnMBp0EMJ9ZHt%2FXKycU%3D",
+ oauth_version="1.0"
+
+ .. _`section 3.5.1`: https://tools.ietf.org/html/rfc5849#section-3.5.1
+ .. _`RFC2617`: https://tools.ietf.org/html/rfc2617
+ """
+ headers = headers or {}
+
+ # step 1, 2, 3 in Section 3.5.1
+ header_parameters = ", ".join(
+ [
+ f'{escape(k)}="{escape(v)}"'
+ for k, v in oauth_params
+ if k.startswith("oauth_")
+ ]
+ )
+
+ # 4. The OPTIONAL "realm" parameter MAY be added and interpreted per
+ # `RFC2617 section 1.2`_.
+ #
+ # .. _`RFC2617 section 1.2`: https://tools.ietf.org/html/rfc2617#section-1.2
+ if realm:
+ # NOTE: realm should *not* be escaped
+ header_parameters = f'realm="{realm}", ' + header_parameters
+
+ # the auth-scheme name set to "OAuth" (case insensitive).
+ headers["Authorization"] = f"OAuth {header_parameters}"
+ return headers
+
+
+def _append_params(oauth_params, params):
+ """Append OAuth params to an existing set of parameters.
+
+ Both params and oauth_params is must be lists of 2-tuples.
+
+ Per `section 3.5.2`_ and `3.5.3`_ of the spec.
+
+ .. _`section 3.5.2`: https://tools.ietf.org/html/rfc5849#section-3.5.2
+ .. _`3.5.3`: https://tools.ietf.org/html/rfc5849#section-3.5.3
+
+ """
+ merged = list(params)
+ merged.extend(oauth_params)
+ # The request URI / entity-body MAY include other request-specific
+ # parameters, in which case, the protocol parameters SHOULD be appended
+ # following the request-specific parameters, properly separated by an "&"
+ # character (ASCII code 38)
+ merged.sort(key=lambda i: i[0].startswith("oauth_"))
+ return merged
+
+
+def prepare_form_encoded_body(oauth_params, body):
+ """Prepare the Form-Encoded Body.
+
+ Per `section 3.5.2`_ of the spec.
+
+ .. _`section 3.5.2`: https://tools.ietf.org/html/rfc5849#section-3.5.2
+
+ """
+ # append OAuth params to the existing body
+ return url_encode(_append_params(oauth_params, body))
+
+
+def prepare_request_uri_query(oauth_params, uri):
+ """Prepare the Request URI Query.
+
+ Per `section 3.5.3`_ of the spec.
+
+ .. _`section 3.5.3`: https://tools.ietf.org/html/rfc5849#section-3.5.3
+
+ """
+ # append OAuth params to the existing set of query components
+ sch, net, path, par, query, fra = urlparse.urlparse(uri)
+ query = url_encode(_append_params(oauth_params, extract_params(query) or []))
+ return urlparse.urlunparse((sch, net, path, par, query, fra))
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/resource_protector.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/resource_protector.py
new file mode 100644
index 00000000..364b6b5a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/resource_protector.py
@@ -0,0 +1,39 @@
+from .base_server import BaseServer
+from .errors import InvalidClientError
+from .errors import InvalidTokenError
+from .errors import MissingRequiredParameterError
+from .wrapper import OAuth1Request
+
+
+class ResourceProtector(BaseServer):
+ def validate_request(self, method, uri, body, headers):
+ request = OAuth1Request(method, uri, body, headers)
+
+ if not request.client_id:
+ raise MissingRequiredParameterError("oauth_consumer_key")
+
+ client = self.get_client_by_id(request.client_id)
+ if not client:
+ raise InvalidClientError()
+ request.client = client
+
+ if not request.token:
+ raise MissingRequiredParameterError("oauth_token")
+
+ token = self.get_token_credential(request)
+ if not token:
+ raise InvalidTokenError()
+
+ request.credential = token
+ self.validate_timestamp_and_nonce(request)
+ self.validate_oauth_signature(request)
+ return request
+
+ def get_token_credential(self, request):
+ """Fetch the token credential from data store like a database,
+ framework should implement this function.
+
+ :param request: OAuth1Request instance
+ :return: Token model instance
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/rsa.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/rsa.py
new file mode 100644
index 00000000..fd68fcd2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/rsa.py
@@ -0,0 +1,24 @@
+from cryptography.exceptions import InvalidSignature
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives.asymmetric import padding
+from cryptography.hazmat.primitives.serialization import load_pem_private_key
+from cryptography.hazmat.primitives.serialization import load_pem_public_key
+
+from authlib.common.encoding import to_bytes
+
+
+def sign_sha1(msg, rsa_private_key):
+ key = load_pem_private_key(
+ to_bytes(rsa_private_key), password=None, backend=default_backend()
+ )
+ return key.sign(msg, padding.PKCS1v15(), hashes.SHA1())
+
+
+def verify_sha1(sig, msg, rsa_public_key):
+ key = load_pem_public_key(to_bytes(rsa_public_key), backend=default_backend())
+ try:
+ key.verify(sig, msg, padding.PKCS1v15(), hashes.SHA1())
+ return True
+ except InvalidSignature:
+ return False
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/signature.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/signature.py
new file mode 100644
index 00000000..d12e44a5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/signature.py
@@ -0,0 +1,387 @@
+"""authlib.oauth1.rfc5849.signature.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of `section 3.4`_ of the spec.
+
+.. _`section 3.4`: https://tools.ietf.org/html/rfc5849#section-3.4
+"""
+
+import binascii
+import hashlib
+import hmac
+
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+from authlib.common.urls import urlparse
+
+from .util import escape
+from .util import unescape
+
+SIGNATURE_HMAC_SHA1 = "HMAC-SHA1"
+SIGNATURE_RSA_SHA1 = "RSA-SHA1"
+SIGNATURE_PLAINTEXT = "PLAINTEXT"
+
+SIGNATURE_TYPE_HEADER = "HEADER"
+SIGNATURE_TYPE_QUERY = "QUERY"
+SIGNATURE_TYPE_BODY = "BODY"
+
+
+def construct_base_string(method, uri, params, host=None):
+ """Generate signature base string from request, per `Section 3.4.1`_.
+
+ For example, the HTTP request::
+
+ POST /request?b5=%3D%253D&a3=a&c%40=&a2=r%20b HTTP/1.1
+ Host: example.com
+ Content-Type: application/x-www-form-urlencoded
+ Authorization: OAuth realm="Example",
+ oauth_consumer_key="9djdj82h48djs9d2",
+ oauth_token="kkk9d7dh3k39sjv7",
+ oauth_signature_method="HMAC-SHA1",
+ oauth_timestamp="137131201",
+ oauth_nonce="7d8f3e4a",
+ oauth_signature="bYT5CMsGcbgUdFHObYMEfcx6bsw%3D"
+
+ c2&a3=2+q
+
+ is represented by the following signature base string (line breaks
+ are for display purposes only)::
+
+ POST&http%3A%2F%2Fexample.com%2Frequest&a2%3Dr%2520b%26a3%3D2%2520q
+ %26a3%3Da%26b5%3D%253D%25253D%26c%2540%3D%26c2%3D%26oauth_consumer_
+ key%3D9djdj82h48djs9d2%26oauth_nonce%3D7d8f3e4a%26oauth_signature_m
+ ethod%3DHMAC-SHA1%26oauth_timestamp%3D137131201%26oauth_token%3Dkkk
+ 9d7dh3k39sjv7
+
+ .. _`Section 3.4.1`: https://tools.ietf.org/html/rfc5849#section-3.4.1
+ """
+ # Create base string URI per Section 3.4.1.2
+ base_string_uri = normalize_base_string_uri(uri, host)
+
+ # Cleanup parameter sources per Section 3.4.1.3.1
+ unescaped_params = []
+ for k, v in params:
+ # The "oauth_signature" parameter MUST be excluded from the signature
+ if k in ("oauth_signature", "realm"):
+ continue
+
+ # ensure oauth params are unescaped
+ if k.startswith("oauth_"):
+ v = unescape(v)
+ unescaped_params.append((k, v))
+
+ # Normalize parameters per Section 3.4.1.3.2
+ normalized_params = normalize_parameters(unescaped_params)
+
+ # construct base string
+ return "&".join(
+ [
+ escape(method.upper()),
+ escape(base_string_uri),
+ escape(normalized_params),
+ ]
+ )
+
+
+def normalize_base_string_uri(uri, host=None):
+ """Normalize Base String URI per `Section 3.4.1.2`_.
+
+ For example, the HTTP request::
+
+ GET /r%20v/X?id=123 HTTP/1.1
+ Host: EXAMPLE.COM:80
+
+ is represented by the base string URI: "http://example.com/r%20v/X".
+
+ In another example, the HTTPS request::
+
+ GET /?q=1 HTTP/1.1
+ Host: www.example.net:8080
+
+ is represented by the base string URI: "https://www.example.net:8080/".
+
+ .. _`Section 3.4.1.2`: https://tools.ietf.org/html/rfc5849#section-3.4.1.2
+
+ The host argument overrides the netloc part of the uri argument.
+ """
+ uri = to_unicode(uri)
+ scheme, netloc, path, params, query, fragment = urlparse.urlparse(uri)
+
+ # The scheme, authority, and path of the request resource URI `RFC3986`
+ # are included by constructing an "http" or "https" URI representing
+ # the request resource (without the query or fragment) as follows:
+ #
+ # .. _`RFC3986`: https://tools.ietf.org/html/rfc3986
+
+ if not scheme or not netloc:
+ raise ValueError("uri must include a scheme and netloc")
+
+ # Per `RFC 2616 section 5.1.2`_:
+ #
+ # Note that the absolute path cannot be empty; if none is present in
+ # the original URI, it MUST be given as "/" (the server root).
+ #
+ # .. _`RFC 2616 section 5.1.2`: https://tools.ietf.org/html/rfc2616#section-5.1.2
+ if not path:
+ path = "/"
+
+ # 1. The scheme and host MUST be in lowercase.
+ scheme = scheme.lower()
+ netloc = netloc.lower()
+
+ # 2. The host and port values MUST match the content of the HTTP
+ # request "Host" header field.
+ if host is not None:
+ netloc = host.lower()
+
+ # 3. The port MUST be included if it is not the default port for the
+ # scheme, and MUST be excluded if it is the default. Specifically,
+ # the port MUST be excluded when making an HTTP request `RFC2616`_
+ # to port 80 or when making an HTTPS request `RFC2818`_ to port 443.
+ # All other non-default port numbers MUST be included.
+ #
+ # .. _`RFC2616`: https://tools.ietf.org/html/rfc2616
+ # .. _`RFC2818`: https://tools.ietf.org/html/rfc2818
+ default_ports = (
+ ("http", "80"),
+ ("https", "443"),
+ )
+ if ":" in netloc:
+ host, port = netloc.split(":", 1)
+ if (scheme, port) in default_ports:
+ netloc = host
+
+ return urlparse.urlunparse((scheme, netloc, path, params, "", ""))
+
+
+def normalize_parameters(params):
+ """Normalize parameters per `Section 3.4.1.3.2`_.
+
+ For example, the list of parameters from the previous section would
+ be normalized as follows:
+
+ Encoded::
+
+ +------------------------+------------------+
+ | Name | Value |
+ +------------------------+------------------+
+ | b5 | %3D%253D |
+ | a3 | a |
+ | c%40 | |
+ | a2 | r%20b |
+ | oauth_consumer_key | 9djdj82h48djs9d2 |
+ | oauth_token | kkk9d7dh3k39sjv7 |
+ | oauth_signature_method | HMAC-SHA1 |
+ | oauth_timestamp | 137131201 |
+ | oauth_nonce | 7d8f3e4a |
+ | c2 | |
+ | a3 | 2%20q |
+ +------------------------+------------------+
+
+ Sorted::
+
+ +------------------------+------------------+
+ | Name | Value |
+ +------------------------+------------------+
+ | a2 | r%20b |
+ | a3 | 2%20q |
+ | a3 | a |
+ | b5 | %3D%253D |
+ | c%40 | |
+ | c2 | |
+ | oauth_consumer_key | 9djdj82h48djs9d2 |
+ | oauth_nonce | 7d8f3e4a |
+ | oauth_signature_method | HMAC-SHA1 |
+ | oauth_timestamp | 137131201 |
+ | oauth_token | kkk9d7dh3k39sjv7 |
+ +------------------------+------------------+
+
+ Concatenated Pairs::
+
+ +-------------------------------------+
+ | Name=Value |
+ +-------------------------------------+
+ | a2=r%20b |
+ | a3=2%20q |
+ | a3=a |
+ | b5=%3D%253D |
+ | c%40= |
+ | c2= |
+ | oauth_consumer_key=9djdj82h48djs9d2 |
+ | oauth_nonce=7d8f3e4a |
+ | oauth_signature_method=HMAC-SHA1 |
+ | oauth_timestamp=137131201 |
+ | oauth_token=kkk9d7dh3k39sjv7 |
+ +-------------------------------------+
+
+ and concatenated together into a single string (line breaks are for
+ display purposes only)::
+
+ a2=r%20b&a3=2%20q&a3=a&b5=%3D%253D&c%40=&c2=&oauth_consumer_key=9dj
+ dj82h48djs9d2&oauth_nonce=7d8f3e4a&oauth_signature_method=HMAC-SHA1
+ &oauth_timestamp=137131201&oauth_token=kkk9d7dh3k39sjv7
+
+ .. _`Section 3.4.1.3.2`: https://tools.ietf.org/html/rfc5849#section-3.4.1.3.2
+ """
+ # 1. First, the name and value of each parameter are encoded
+ # (`Section 3.6`_).
+ #
+ # .. _`Section 3.6`: https://tools.ietf.org/html/rfc5849#section-3.6
+ key_values = [(escape(k), escape(v)) for k, v in params]
+
+ # 2. The parameters are sorted by name, using ascending byte value
+ # ordering. If two or more parameters share the same name, they
+ # are sorted by their value.
+ key_values.sort()
+
+ # 3. The name of each parameter is concatenated to its corresponding
+ # value using an "=" character (ASCII code 61) as a separator, even
+ # if the value is empty.
+ parameter_parts = [f"{k}={v}" for k, v in key_values]
+
+ # 4. The sorted name/value pairs are concatenated together into a
+ # single string by using an "&" character (ASCII code 38) as
+ # separator.
+ return "&".join(parameter_parts)
+
+
+def generate_signature_base_string(request):
+ """Generate signature base string from request."""
+ host = request.headers.get("Host", None)
+ return construct_base_string(request.method, request.uri, request.params, host)
+
+
+def hmac_sha1_signature(base_string, client_secret, token_secret):
+ """Generate signature via HMAC-SHA1 method, per `Section 3.4.2`_.
+
+ The "HMAC-SHA1" signature method uses the HMAC-SHA1 signature
+ algorithm as defined in `RFC2104`_::
+
+ digest = HMAC - SHA1(key, text)
+
+ .. _`RFC2104`: https://tools.ietf.org/html/rfc2104
+ .. _`Section 3.4.2`: https://tools.ietf.org/html/rfc5849#section-3.4.2
+ """
+ # The HMAC-SHA1 function variables are used in following way:
+
+ # text is set to the value of the signature base string from
+ # `Section 3.4.1.1`_.
+ #
+ # .. _`Section 3.4.1.1`: https://tools.ietf.org/html/rfc5849#section-3.4.1.1
+ text = base_string
+
+ # key is set to the concatenated values of:
+ # 1. The client shared-secret, after being encoded (`Section 3.6`_).
+ #
+ # .. _`Section 3.6`: https://tools.ietf.org/html/rfc5849#section-3.6
+ key = escape(client_secret or "")
+
+ # 2. An "&" character (ASCII code 38), which MUST be included
+ # even when either secret is empty.
+ key += "&"
+
+ # 3. The token shared-secret, after being encoded (`Section 3.6`_).
+ #
+ # .. _`Section 3.6`: https://tools.ietf.org/html/rfc5849#section-3.6
+ key += escape(token_secret or "")
+
+ signature = hmac.new(to_bytes(key), to_bytes(text), hashlib.sha1)
+
+ # digest is used to set the value of the "oauth_signature" protocol
+ # parameter, after the result octet string is base64-encoded
+ # per `RFC2045, Section 6.8`.
+ #
+ # .. _`RFC2045, Section 6.8`: https://tools.ietf.org/html/rfc2045#section-6.8
+ sig = binascii.b2a_base64(signature.digest())[:-1]
+ return to_unicode(sig)
+
+
+def rsa_sha1_signature(base_string, rsa_private_key):
+ """Generate signature via RSA-SHA1 method, per `Section 3.4.3`_.
+
+ The "RSA-SHA1" signature method uses the RSASSA-PKCS1-v1_5 signature
+ algorithm as defined in `RFC3447, Section 8.2`_ (also known as
+ PKCS#1), using SHA-1 as the hash function for EMSA-PKCS1-v1_5. To
+ use this method, the client MUST have established client credentials
+ with the server that included its RSA public key (in a manner that is
+ beyond the scope of this specification).
+
+ .. _`Section 3.4.3`: https://tools.ietf.org/html/rfc5849#section-3.4.3
+ .. _`RFC3447, Section 8.2`: https://tools.ietf.org/html/rfc3447#section-8.2
+ """
+ from .rsa import sign_sha1
+
+ base_string = to_bytes(base_string)
+ s = sign_sha1(to_bytes(base_string), rsa_private_key)
+ sig = binascii.b2a_base64(s)[:-1]
+ return to_unicode(sig)
+
+
+def plaintext_signature(client_secret, token_secret):
+ """Generate signature via PLAINTEXT method, per `Section 3.4.4`_.
+
+ The "PLAINTEXT" method does not employ a signature algorithm. It
+ MUST be used with a transport-layer mechanism such as TLS or SSL (or
+ sent over a secure channel with equivalent protections). It does not
+ utilize the signature base string or the "oauth_timestamp" and
+ "oauth_nonce" parameters.
+
+ .. _`Section 3.4.4`: https://tools.ietf.org/html/rfc5849#section-3.4.4
+ """
+ # The "oauth_signature" protocol parameter is set to the concatenated
+ # value of:
+
+ # 1. The client shared-secret, after being encoded (`Section 3.6`_).
+ #
+ # .. _`Section 3.6`: https://tools.ietf.org/html/rfc5849#section-3.6
+ signature = escape(client_secret or "")
+
+ # 2. An "&" character (ASCII code 38), which MUST be included even
+ # when either secret is empty.
+ signature += "&"
+
+ # 3. The token shared-secret, after being encoded (`Section 3.6`_).
+ #
+ # .. _`Section 3.6`: https://tools.ietf.org/html/rfc5849#section-3.6
+ signature += escape(token_secret or "")
+
+ return signature
+
+
+def sign_hmac_sha1(client, request):
+ """Sign a HMAC-SHA1 signature."""
+ base_string = generate_signature_base_string(request)
+ return hmac_sha1_signature(base_string, client.client_secret, client.token_secret)
+
+
+def sign_rsa_sha1(client, request):
+ """Sign a RSASSA-PKCS #1 v1.5 base64 encoded signature."""
+ base_string = generate_signature_base_string(request)
+ return rsa_sha1_signature(base_string, client.rsa_key)
+
+
+def sign_plaintext(client, request):
+ """Sign a PLAINTEXT signature."""
+ return plaintext_signature(client.client_secret, client.token_secret)
+
+
+def verify_hmac_sha1(request):
+ """Verify a HMAC-SHA1 signature."""
+ base_string = generate_signature_base_string(request)
+ sig = hmac_sha1_signature(base_string, request.client_secret, request.token_secret)
+ return hmac.compare_digest(sig, request.signature)
+
+
+def verify_rsa_sha1(request):
+ """Verify a RSASSA-PKCS #1 v1.5 base64 encoded signature."""
+ from .rsa import verify_sha1
+
+ base_string = generate_signature_base_string(request)
+ sig = binascii.a2b_base64(to_bytes(request.signature))
+ return verify_sha1(sig, to_bytes(base_string), request.rsa_public_key)
+
+
+def verify_plaintext(request):
+ """Verify a PLAINTEXT signature."""
+ sig = plaintext_signature(request.client_secret, request.token_secret)
+ return hmac.compare_digest(sig, request.signature)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/util.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/util.py
new file mode 100644
index 00000000..fb1e0ca3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/util.py
@@ -0,0 +1,10 @@
+from authlib.common.urls import quote
+from authlib.common.urls import unquote
+
+
+def escape(s):
+ return quote(s, safe=b"~")
+
+
+def unescape(s):
+ return unquote(s)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/wrapper.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/wrapper.py
new file mode 100644
index 00000000..cd3c43e7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth1/rfc5849/wrapper.py
@@ -0,0 +1,129 @@
+from urllib.request import parse_http_list
+from urllib.request import parse_keqv_list
+
+from authlib.common.urls import extract_params
+from authlib.common.urls import url_decode
+from authlib.common.urls import urlparse
+
+from .errors import DuplicatedOAuthProtocolParameterError
+from .errors import InsecureTransportError
+from .signature import SIGNATURE_TYPE_BODY
+from .signature import SIGNATURE_TYPE_HEADER
+from .signature import SIGNATURE_TYPE_QUERY
+from .util import unescape
+
+
+class OAuth1Request:
+ def __init__(self, method, uri, body=None, headers=None):
+ InsecureTransportError.check(uri)
+ self.method = method
+ self.uri = uri
+ self.body = body
+ self.headers = headers or {}
+
+ # states namespaces
+ self.client = None
+ self.credential = None
+ self.user = None
+
+ self.query = urlparse.urlparse(uri).query
+ self.query_params = url_decode(self.query)
+ self.body_params = extract_params(body) or []
+
+ self.auth_params, self.realm = _parse_authorization_header(headers)
+ self.signature_type, self.oauth_params = _parse_oauth_params(
+ self.query_params, self.body_params, self.auth_params
+ )
+
+ params = []
+ params.extend(self.query_params)
+ params.extend(self.body_params)
+ params.extend(self.auth_params)
+ self.params = params
+
+ @property
+ def client_id(self):
+ return self.oauth_params.get("oauth_consumer_key")
+
+ @property
+ def client_secret(self):
+ if self.client:
+ return self.client.get_client_secret()
+
+ @property
+ def rsa_public_key(self):
+ if self.client:
+ return self.client.get_rsa_public_key()
+
+ @property
+ def timestamp(self):
+ return self.oauth_params.get("oauth_timestamp")
+
+ @property
+ def redirect_uri(self):
+ return self.oauth_params.get("oauth_callback")
+
+ @property
+ def signature(self):
+ return self.oauth_params.get("oauth_signature")
+
+ @property
+ def signature_method(self):
+ return self.oauth_params.get("oauth_signature_method")
+
+ @property
+ def token(self):
+ return self.oauth_params.get("oauth_token")
+
+ @property
+ def token_secret(self):
+ if self.credential:
+ return self.credential.get_oauth_token_secret()
+
+
+def _filter_oauth(params):
+ for k, v in params:
+ if k.startswith("oauth_"):
+ yield (k, v)
+
+
+def _parse_authorization_header(headers):
+ """Parse an OAuth authorization header into a list of 2-tuples."""
+ authorization_header = headers.get("Authorization")
+ if not authorization_header:
+ return [], None
+
+ auth_scheme = "oauth "
+ if authorization_header.lower().startswith(auth_scheme):
+ items = parse_http_list(authorization_header[len(auth_scheme) :])
+ try:
+ items = parse_keqv_list(items).items()
+ auth_params = [(unescape(k), unescape(v)) for k, v in items]
+ realm = dict(auth_params).get("realm")
+ return auth_params, realm
+ except (IndexError, ValueError):
+ pass
+ raise ValueError("Malformed authorization header")
+
+
+def _parse_oauth_params(query_params, body_params, auth_params):
+ oauth_params_set = [
+ (SIGNATURE_TYPE_QUERY, list(_filter_oauth(query_params))),
+ (SIGNATURE_TYPE_BODY, list(_filter_oauth(body_params))),
+ (SIGNATURE_TYPE_HEADER, list(_filter_oauth(auth_params))),
+ ]
+ oauth_params_set = [params for params in oauth_params_set if params[1]]
+ if len(oauth_params_set) > 1:
+ found_types = [p[0] for p in oauth_params_set]
+ raise DuplicatedOAuthProtocolParameterError(
+ '"oauth_" params must come from only 1 signature type '
+ "but were found in {}".format(",".join(found_types))
+ )
+
+ if oauth_params_set:
+ signature_type = oauth_params_set[0][0]
+ oauth_params = dict(oauth_params_set[0][1])
+ else:
+ signature_type = None
+ oauth_params = {}
+ return signature_type, oauth_params
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__init__.py
new file mode 100644
index 00000000..76bb873c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__init__.py
@@ -0,0 +1,21 @@
+from .auth import ClientAuth
+from .auth import TokenAuth
+from .base import OAuth2Error
+from .client import OAuth2Client
+from .rfc6749 import AuthorizationServer
+from .rfc6749 import ClientAuthentication
+from .rfc6749 import JsonRequest
+from .rfc6749 import OAuth2Request
+from .rfc6749 import ResourceProtector
+
+__all__ = [
+ "OAuth2Error",
+ "ClientAuth",
+ "TokenAuth",
+ "OAuth2Client",
+ "OAuth2Request",
+ "JsonRequest",
+ "AuthorizationServer",
+ "ClientAuthentication",
+ "ResourceProtector",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..7648c813
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/auth.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/auth.cpython-312.pyc
new file mode 100644
index 00000000..e178b9c6
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/auth.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/base.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/base.cpython-312.pyc
new file mode 100644
index 00000000..610208e7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/base.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/client.cpython-312.pyc
new file mode 100644
index 00000000..326a69f1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/__pycache__/client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/auth.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/auth.py
new file mode 100644
index 00000000..dffccb7f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/auth.py
@@ -0,0 +1,115 @@
+import base64
+
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_native
+from authlib.common.urls import add_params_to_qs
+from authlib.common.urls import add_params_to_uri
+
+from .rfc6749 import OAuth2Token
+from .rfc6750 import add_bearer_token
+
+
+def encode_client_secret_basic(client, method, uri, headers, body):
+ text = f"{client.client_id}:{client.client_secret}"
+ auth = to_native(base64.b64encode(to_bytes(text, "latin1")))
+ headers["Authorization"] = f"Basic {auth}"
+ return uri, headers, body
+
+
+def encode_client_secret_post(client, method, uri, headers, body):
+ body = add_params_to_qs(
+ body or "",
+ [
+ ("client_id", client.client_id),
+ ("client_secret", client.client_secret or ""),
+ ],
+ )
+ if "Content-Length" in headers:
+ headers["Content-Length"] = str(len(body))
+ return uri, headers, body
+
+
+def encode_none(client, method, uri, headers, body):
+ if method == "GET":
+ uri = add_params_to_uri(uri, [("client_id", client.client_id)])
+ return uri, headers, body
+ body = add_params_to_qs(body, [("client_id", client.client_id)])
+ if "Content-Length" in headers:
+ headers["Content-Length"] = str(len(body))
+ return uri, headers, body
+
+
+class ClientAuth:
+ """Attaches OAuth Client Information to HTTP requests.
+
+ :param client_id: Client ID, which you get from client registration.
+ :param client_secret: Client Secret, which you get from registration.
+ :param auth_method: Client auth method for token endpoint. The supported
+ methods for now:
+
+ * client_secret_basic (default)
+ * client_secret_post
+ * none
+ """
+
+ DEFAULT_AUTH_METHODS = {
+ "client_secret_basic": encode_client_secret_basic,
+ "client_secret_post": encode_client_secret_post,
+ "none": encode_none,
+ }
+
+ def __init__(self, client_id, client_secret, auth_method=None):
+ if auth_method is None:
+ auth_method = "client_secret_basic"
+
+ self.client_id = client_id
+ self.client_secret = client_secret
+
+ if auth_method in self.DEFAULT_AUTH_METHODS:
+ auth_method = self.DEFAULT_AUTH_METHODS[auth_method]
+
+ self.auth_method = auth_method
+
+ def prepare(self, method, uri, headers, body):
+ return self.auth_method(self, method, uri, headers, body)
+
+
+class TokenAuth:
+ """Attach token information to HTTP requests.
+
+ :param token: A dict or OAuth2Token instance of an OAuth 2.0 token
+ :param token_placement: The placement of the token, default is ``header``,
+ available choices:
+
+ * header (default)
+ * body
+ * uri
+ """
+
+ DEFAULT_TOKEN_TYPE = "bearer"
+ SIGN_METHODS = {"bearer": add_bearer_token}
+
+ def __init__(self, token, token_placement="header", client=None):
+ self.token = OAuth2Token.from_dict(token)
+ self.token_placement = token_placement
+ self.client = client
+ self.hooks = set()
+
+ def set_token(self, token):
+ self.token = OAuth2Token.from_dict(token)
+
+ def prepare(self, uri, headers, body):
+ token_type = self.token.get("token_type", self.DEFAULT_TOKEN_TYPE)
+ sign = self.SIGN_METHODS[token_type.lower()]
+ uri, headers, body = sign(
+ self.token["access_token"], uri, headers, body, self.token_placement
+ )
+
+ for hook in self.hooks:
+ uri, headers, body = hook(uri, headers, body)
+
+ return uri, headers, body
+
+ def __del__(self):
+ del self.client
+ del self.hooks
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/base.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/base.py
new file mode 100644
index 00000000..407c0935
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/base.py
@@ -0,0 +1,62 @@
+from authlib.common.errors import AuthlibHTTPError
+from authlib.common.urls import add_params_to_uri
+
+
+def invalid_error_characters(text: str) -> list[str]:
+ """Check whether the string only contains characters from the restricted ASCII set defined in RFC6749 for errors.
+
+ https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
+ """
+ valid_ranges = [
+ (0x20, 0x21),
+ (0x23, 0x5B),
+ (0x5D, 0x7E),
+ ]
+
+ return [
+ char
+ for char in set(text)
+ if not any(start <= ord(char) <= end for start, end in valid_ranges)
+ ]
+
+
+class OAuth2Error(AuthlibHTTPError):
+ def __init__(
+ self,
+ description=None,
+ uri=None,
+ status_code=None,
+ state=None,
+ redirect_uri=None,
+ redirect_fragment=False,
+ error=None,
+ ):
+ # Human-readable ASCII [USASCII] text providing
+ # additional information, used to assist the client developer in
+ # understanding the error that occurred.
+ # Values for the "error_description" parameter MUST NOT include
+ # characters outside the set %x20-21 / %x23-5B / %x5D-7E.
+ if description:
+ if chars := invalid_error_characters(description):
+ raise ValueError(
+ f"Error description contains forbidden characters: {', '.join(chars)}."
+ )
+
+ super().__init__(error, description, uri, status_code)
+ self.state = state
+ self.redirect_uri = redirect_uri
+ self.redirect_fragment = redirect_fragment
+
+ def get_body(self):
+ """Get a list of body."""
+ error = super().get_body()
+ if self.state:
+ error.append(("state", self.state))
+ return error
+
+ def __call__(self, uri=None):
+ if self.redirect_uri:
+ params = self.get_body()
+ loc = add_params_to_uri(self.redirect_uri, params, self.redirect_fragment)
+ return 302, "", [("Location", loc)]
+ return super().__call__(uri=uri)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/client.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/client.py
new file mode 100644
index 00000000..340c11bb
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/client.py
@@ -0,0 +1,528 @@
+from authlib.common.security import generate_token
+from authlib.common.urls import url_decode
+
+from .auth import ClientAuth
+from .auth import TokenAuth
+from .base import OAuth2Error
+from .rfc6749.parameters import parse_authorization_code_response
+from .rfc6749.parameters import parse_implicit_response
+from .rfc6749.parameters import prepare_grant_uri
+from .rfc6749.parameters import prepare_token_request
+from .rfc7009 import prepare_revoke_token_request
+from .rfc7636 import create_s256_code_challenge
+
+DEFAULT_HEADERS = {
+ "Accept": "application/json",
+ "Content-Type": "application/x-www-form-urlencoded;charset=UTF-8",
+}
+
+
+class OAuth2Client:
+ """Construct a new OAuth 2 protocol client.
+
+ :param session: Requests session object to communicate with
+ authorization server.
+ :param client_id: Client ID, which you get from client registration.
+ :param client_secret: Client Secret, which you get from registration.
+ :param token_endpoint_auth_method: client authentication method for
+ token endpoint.
+ :param revocation_endpoint_auth_method: client authentication method for
+ revocation endpoint.
+ :param scope: Scope that you needed to access user resources.
+ :param state: Shared secret to prevent CSRF attack.
+ :param redirect_uri: Redirect URI you registered as callback.
+ :param code_challenge_method: PKCE method name, only S256 is supported.
+ :param token: A dict of token attributes such as ``access_token``,
+ ``token_type`` and ``expires_at``.
+ :param token_placement: The place to put token in HTTP request. Available
+ values: "header", "body", "uri".
+ :param update_token: A function for you to update token. It accept a
+ :class:`OAuth2Token` as parameter.
+ :param leeway: Time window in seconds before the actual expiration of the
+ authentication token, that the token is considered expired and will
+ be refreshed.
+ """
+
+ client_auth_class = ClientAuth
+ token_auth_class = TokenAuth
+ oauth_error_class = OAuth2Error
+
+ EXTRA_AUTHORIZE_PARAMS = ("response_mode", "nonce", "prompt", "login_hint")
+ SESSION_REQUEST_PARAMS = []
+
+ def __init__(
+ self,
+ session,
+ client_id=None,
+ client_secret=None,
+ token_endpoint_auth_method=None,
+ revocation_endpoint_auth_method=None,
+ scope=None,
+ state=None,
+ redirect_uri=None,
+ code_challenge_method=None,
+ token=None,
+ token_placement="header",
+ update_token=None,
+ leeway=60,
+ **metadata,
+ ):
+ self.session = session
+ self.client_id = client_id
+ self.client_secret = client_secret
+ self.state = state
+
+ if token_endpoint_auth_method is None:
+ if client_secret:
+ token_endpoint_auth_method = "client_secret_basic"
+ else:
+ token_endpoint_auth_method = "none"
+
+ self.token_endpoint_auth_method = token_endpoint_auth_method
+
+ if revocation_endpoint_auth_method is None:
+ if client_secret:
+ revocation_endpoint_auth_method = "client_secret_basic"
+ else:
+ revocation_endpoint_auth_method = "none"
+
+ self.revocation_endpoint_auth_method = revocation_endpoint_auth_method
+
+ self.scope = scope
+ self.redirect_uri = redirect_uri
+ self.code_challenge_method = code_challenge_method
+
+ self.token_auth = self.token_auth_class(token, token_placement, self)
+ self.update_token = update_token
+
+ token_updater = metadata.pop("token_updater", None)
+ if token_updater:
+ raise ValueError(
+ "update token has been redesigned, checkout the documentation"
+ )
+
+ self.metadata = metadata
+
+ self.compliance_hook = {
+ "access_token_response": set(),
+ "refresh_token_request": set(),
+ "refresh_token_response": set(),
+ "revoke_token_request": set(),
+ "introspect_token_request": set(),
+ }
+ self._auth_methods = {}
+
+ self.leeway = leeway
+
+ def register_client_auth_method(self, auth):
+ """Extend client authenticate for token endpoint.
+
+ :param auth: an instance to sign the request
+ """
+ if isinstance(auth, tuple):
+ self._auth_methods[auth[0]] = auth[1]
+ else:
+ self._auth_methods[auth.name] = auth
+
+ def client_auth(self, auth_method):
+ if isinstance(auth_method, str) and auth_method in self._auth_methods:
+ auth_method = self._auth_methods[auth_method]
+ return self.client_auth_class(
+ client_id=self.client_id,
+ client_secret=self.client_secret,
+ auth_method=auth_method,
+ )
+
+ @property
+ def token(self):
+ return self.token_auth.token
+
+ @token.setter
+ def token(self, token):
+ self.token_auth.set_token(token)
+
+ def create_authorization_url(self, url, state=None, code_verifier=None, **kwargs):
+ """Generate an authorization URL and state.
+
+ :param url: Authorization endpoint url, must be HTTPS.
+ :param state: An optional state string for CSRF protection. If not
+ given it will be generated for you.
+ :param code_verifier: An optional code_verifier for code challenge.
+ :param kwargs: Extra parameters to include.
+ :return: authorization_url, state
+ """
+ if state is None:
+ state = generate_token()
+
+ response_type = self.metadata.get("response_type", "code")
+ response_type = kwargs.pop("response_type", response_type)
+ if "redirect_uri" not in kwargs:
+ kwargs["redirect_uri"] = self.redirect_uri
+ if "scope" not in kwargs:
+ kwargs["scope"] = self.scope
+
+ if (
+ code_verifier
+ and response_type == "code"
+ and self.code_challenge_method == "S256"
+ ):
+ kwargs["code_challenge"] = create_s256_code_challenge(code_verifier)
+ kwargs["code_challenge_method"] = self.code_challenge_method
+
+ for k in self.EXTRA_AUTHORIZE_PARAMS:
+ if k not in kwargs and k in self.metadata:
+ kwargs[k] = self.metadata[k]
+
+ uri = prepare_grant_uri(
+ url,
+ client_id=self.client_id,
+ response_type=response_type,
+ state=state,
+ **kwargs,
+ )
+ return uri, state
+
+ def fetch_token(
+ self,
+ url=None,
+ body="",
+ method="POST",
+ headers=None,
+ auth=None,
+ grant_type=None,
+ state=None,
+ **kwargs,
+ ):
+ """Generic method for fetching an access token from the token endpoint.
+
+ :param url: Access Token endpoint URL, if not configured,
+ ``authorization_response`` is used to extract token from
+ its fragment (implicit way).
+ :param body: Optional application/x-www-form-urlencoded body to add the
+ include in the token request. Prefer kwargs over body.
+ :param method: The HTTP method used to make the request. Defaults
+ to POST, but may also be GET. Other methods should
+ be added as needed.
+ :param headers: Dict to default request headers with.
+ :param auth: An auth tuple or method as accepted by requests.
+ :param grant_type: Use specified grant_type to fetch token.
+ :param state: Optional "state" value to fetch token.
+ :return: A :class:`OAuth2Token` object (a dict too).
+ """
+ state = state or self.state
+ # implicit grant_type
+ authorization_response = kwargs.pop("authorization_response", None)
+ if authorization_response and "#" in authorization_response:
+ return self.token_from_fragment(authorization_response, state)
+
+ session_kwargs = self._extract_session_request_params(kwargs)
+
+ if authorization_response and "code=" in authorization_response:
+ grant_type = "authorization_code"
+ params = parse_authorization_code_response(
+ authorization_response,
+ state=state,
+ )
+ kwargs["code"] = params["code"]
+
+ if grant_type is None:
+ grant_type = self.metadata.get("grant_type")
+
+ if grant_type is None:
+ grant_type = _guess_grant_type(kwargs)
+ self.metadata["grant_type"] = grant_type
+
+ body = self._prepare_token_endpoint_body(body, grant_type, **kwargs)
+
+ if auth is None:
+ auth = self.client_auth(self.token_endpoint_auth_method)
+
+ if headers is None:
+ headers = DEFAULT_HEADERS
+
+ if url is None:
+ url = self.metadata.get("token_endpoint")
+
+ return self._fetch_token(
+ url, body=body, auth=auth, method=method, headers=headers, **session_kwargs
+ )
+
+ def token_from_fragment(self, authorization_response, state=None):
+ token = parse_implicit_response(authorization_response, state)
+ if "error" in token:
+ raise self.oauth_error_class(
+ error=token["error"], description=token.get("error_description")
+ )
+ self.token = token
+ return token
+
+ def refresh_token(
+ self, url=None, refresh_token=None, body="", auth=None, headers=None, **kwargs
+ ):
+ """Fetch a new access token using a refresh token.
+
+ :param url: Refresh Token endpoint, must be HTTPS.
+ :param refresh_token: The refresh_token to use.
+ :param body: Optional application/x-www-form-urlencoded body to add the
+ include in the token request. Prefer kwargs over body.
+ :param auth: An auth tuple or method as accepted by requests.
+ :param headers: Dict to default request headers with.
+ :return: A :class:`OAuth2Token` object (a dict too).
+ """
+ session_kwargs = self._extract_session_request_params(kwargs)
+ refresh_token = refresh_token or self.token.get("refresh_token")
+ if "scope" not in kwargs and self.scope:
+ kwargs["scope"] = self.scope
+ body = prepare_token_request(
+ "refresh_token", body, refresh_token=refresh_token, **kwargs
+ )
+
+ if headers is None:
+ headers = DEFAULT_HEADERS.copy()
+
+ if url is None:
+ url = self.metadata.get("token_endpoint")
+
+ for hook in self.compliance_hook["refresh_token_request"]:
+ url, headers, body = hook(url, headers, body)
+
+ if auth is None:
+ auth = self.client_auth(self.token_endpoint_auth_method)
+
+ return self._refresh_token(
+ url,
+ refresh_token=refresh_token,
+ body=body,
+ headers=headers,
+ auth=auth,
+ **session_kwargs,
+ )
+
+ def ensure_active_token(self, token=None):
+ if token is None:
+ token = self.token
+ if not token.is_expired(leeway=self.leeway):
+ return True
+ refresh_token = token.get("refresh_token")
+ url = self.metadata.get("token_endpoint")
+ if refresh_token and url:
+ self.refresh_token(url, refresh_token=refresh_token)
+ return True
+ elif self.metadata.get("grant_type") == "client_credentials":
+ access_token = token["access_token"]
+ new_token = self.fetch_token(url, grant_type="client_credentials")
+ if self.update_token:
+ self.update_token(new_token, access_token=access_token)
+ return True
+
+ def revoke_token(
+ self,
+ url,
+ token=None,
+ token_type_hint=None,
+ body=None,
+ auth=None,
+ headers=None,
+ **kwargs,
+ ):
+ """Revoke token method defined via `RFC7009`_.
+
+ :param url: Revoke Token endpoint, must be HTTPS.
+ :param token: The token to be revoked.
+ :param token_type_hint: The type of the token that to be revoked.
+ It can be "access_token" or "refresh_token".
+ :param body: Optional application/x-www-form-urlencoded body to add the
+ include in the token request. Prefer kwargs over body.
+ :param auth: An auth tuple or method as accepted by requests.
+ :param headers: Dict to default request headers with.
+ :return: Revocation Response
+
+ .. _`RFC7009`: https://tools.ietf.org/html/rfc7009
+ """
+ if auth is None:
+ auth = self.client_auth(self.revocation_endpoint_auth_method)
+ return self._handle_token_hint(
+ "revoke_token_request",
+ url,
+ token=token,
+ token_type_hint=token_type_hint,
+ body=body,
+ auth=auth,
+ headers=headers,
+ **kwargs,
+ )
+
+ def introspect_token(
+ self,
+ url,
+ token=None,
+ token_type_hint=None,
+ body=None,
+ auth=None,
+ headers=None,
+ **kwargs,
+ ):
+ """Implementation of OAuth 2.0 Token Introspection defined via `RFC7662`_.
+
+ :param url: Introspection Endpoint, must be HTTPS.
+ :param token: The token to be introspected.
+ :param token_type_hint: The type of the token that to be revoked.
+ It can be "access_token" or "refresh_token".
+ :param body: Optional application/x-www-form-urlencoded body to add the
+ include in the token request. Prefer kwargs over body.
+ :param auth: An auth tuple or method as accepted by requests.
+ :param headers: Dict to default request headers with.
+ :return: Introspection Response
+
+ .. _`RFC7662`: https://tools.ietf.org/html/rfc7662
+ """
+ if auth is None:
+ auth = self.client_auth(self.token_endpoint_auth_method)
+ return self._handle_token_hint(
+ "introspect_token_request",
+ url,
+ token=token,
+ token_type_hint=token_type_hint,
+ body=body,
+ auth=auth,
+ headers=headers,
+ **kwargs,
+ )
+
+ def register_compliance_hook(self, hook_type, hook):
+ """Register a hook for request/response tweaking.
+
+ Available hooks are:
+
+ * access_token_response: invoked before token parsing.
+ * refresh_token_request: invoked before refreshing token.
+ * refresh_token_response: invoked before refresh token parsing.
+ * protected_request: invoked before making a request.
+ * revoke_token_request: invoked before revoking a token.
+ * introspect_token_request: invoked before introspecting a token.
+ """
+ if hook_type == "protected_request":
+ self.token_auth.hooks.add(hook)
+ return
+
+ if hook_type not in self.compliance_hook:
+ raise ValueError(
+ "Hook type %s is not in %s.", hook_type, self.compliance_hook
+ )
+ self.compliance_hook[hook_type].add(hook)
+
+ def parse_response_token(self, resp):
+ if resp.status_code >= 500:
+ resp.raise_for_status()
+
+ token = resp.json()
+ if "error" in token:
+ raise self.oauth_error_class(
+ error=token["error"], description=token.get("error_description")
+ )
+ self.token = token
+ return self.token
+
+ def _fetch_token(
+ self, url, body="", headers=None, auth=None, method="POST", **kwargs
+ ):
+ if method.upper() == "POST":
+ resp = self.session.post(
+ url, data=dict(url_decode(body)), headers=headers, auth=auth, **kwargs
+ )
+ else:
+ if "?" in url:
+ url = "&".join([url, body])
+ else:
+ url = "?".join([url, body])
+ resp = self.session.request(
+ method, url, headers=headers, auth=auth, **kwargs
+ )
+
+ for hook in self.compliance_hook["access_token_response"]:
+ resp = hook(resp)
+
+ return self.parse_response_token(resp)
+
+ def _refresh_token(
+ self, url, refresh_token=None, body="", headers=None, auth=None, **kwargs
+ ):
+ resp = self._http_post(url, body=body, auth=auth, headers=headers, **kwargs)
+
+ for hook in self.compliance_hook["refresh_token_response"]:
+ resp = hook(resp)
+
+ token = self.parse_response_token(resp)
+ if "refresh_token" not in token:
+ self.token["refresh_token"] = refresh_token
+
+ if callable(self.update_token):
+ self.update_token(self.token, refresh_token=refresh_token)
+
+ return self.token
+
+ def _handle_token_hint(
+ self,
+ hook,
+ url,
+ token=None,
+ token_type_hint=None,
+ body=None,
+ auth=None,
+ headers=None,
+ **kwargs,
+ ):
+ if token is None and self.token:
+ token = self.token.get("refresh_token") or self.token.get("access_token")
+
+ if body is None:
+ body = ""
+
+ body, headers = prepare_revoke_token_request(
+ token, token_type_hint, body, headers
+ )
+
+ for compliance_hook in self.compliance_hook[hook]:
+ url, headers, body = compliance_hook(url, headers, body)
+
+ if auth is None:
+ auth = self.client_auth(self.revocation_endpoint_auth_method)
+
+ session_kwargs = self._extract_session_request_params(kwargs)
+ return self._http_post(url, body, auth=auth, headers=headers, **session_kwargs)
+
+ def _prepare_token_endpoint_body(self, body, grant_type, **kwargs):
+ if grant_type == "authorization_code":
+ if "redirect_uri" not in kwargs:
+ kwargs["redirect_uri"] = self.redirect_uri
+ return prepare_token_request(grant_type, body, **kwargs)
+
+ if "scope" not in kwargs and self.scope:
+ kwargs["scope"] = self.scope
+ return prepare_token_request(grant_type, body, **kwargs)
+
+ def _extract_session_request_params(self, kwargs):
+ """Extract parameters for session object from the passing ``**kwargs``."""
+ rv = {}
+ for k in self.SESSION_REQUEST_PARAMS:
+ if k in kwargs:
+ rv[k] = kwargs.pop(k)
+ return rv
+
+ def _http_post(self, url, body=None, auth=None, headers=None, **kwargs):
+ return self.session.post(
+ url, data=dict(url_decode(body)), headers=headers, auth=auth, **kwargs
+ )
+
+ def __del__(self):
+ del self.session
+
+
+def _guess_grant_type(kwargs):
+ if "code" in kwargs:
+ grant_type = "authorization_code"
+ elif "username" in kwargs and "password" in kwargs:
+ grant_type = "password"
+ else:
+ grant_type = "client_credentials"
+ return grant_type
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__init__.py
new file mode 100644
index 00000000..6837dabe
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__init__.py
@@ -0,0 +1,90 @@
+"""authlib.oauth2.rfc6749.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+The OAuth 2.0 Authorization Framework.
+
+https://tools.ietf.org/html/rfc6749
+"""
+
+from .authenticate_client import ClientAuthentication
+from .authorization_server import AuthorizationServer
+from .errors import AccessDeniedError
+from .errors import InsecureTransportError
+from .errors import InvalidClientError
+from .errors import InvalidGrantError
+from .errors import InvalidRequestError
+from .errors import InvalidScopeError
+from .errors import MismatchingStateException
+from .errors import MissingAuthorizationError
+from .errors import MissingCodeException # exceptions for clients
+from .errors import MissingTokenException
+from .errors import MissingTokenTypeException
+from .errors import OAuth2Error
+from .errors import UnauthorizedClientError
+from .errors import UnsupportedGrantTypeError
+from .errors import UnsupportedResponseTypeError
+from .errors import UnsupportedTokenTypeError
+from .grants import AuthorizationCodeGrant
+from .grants import AuthorizationEndpointMixin
+from .grants import BaseGrant
+from .grants import ClientCredentialsGrant
+from .grants import ImplicitGrant
+from .grants import RefreshTokenGrant
+from .grants import ResourceOwnerPasswordCredentialsGrant
+from .grants import TokenEndpointMixin
+from .models import AuthorizationCodeMixin
+from .models import ClientMixin
+from .models import TokenMixin
+from .requests import JsonPayload
+from .requests import JsonRequest
+from .requests import OAuth2Payload
+from .requests import OAuth2Request
+from .resource_protector import ResourceProtector
+from .resource_protector import TokenValidator
+from .token_endpoint import TokenEndpoint
+from .util import list_to_scope
+from .util import scope_to_list
+from .wrappers import OAuth2Token
+
+__all__ = [
+ "OAuth2Payload",
+ "OAuth2Token",
+ "OAuth2Request",
+ "JsonPayload",
+ "JsonRequest",
+ "OAuth2Error",
+ "AccessDeniedError",
+ "MissingAuthorizationError",
+ "InvalidGrantError",
+ "InvalidClientError",
+ "InvalidRequestError",
+ "InvalidScopeError",
+ "InsecureTransportError",
+ "UnauthorizedClientError",
+ "UnsupportedResponseTypeError",
+ "UnsupportedGrantTypeError",
+ "UnsupportedTokenTypeError",
+ "MissingCodeException",
+ "MissingTokenException",
+ "MissingTokenTypeException",
+ "MismatchingStateException",
+ "ClientMixin",
+ "AuthorizationCodeMixin",
+ "TokenMixin",
+ "ClientAuthentication",
+ "AuthorizationServer",
+ "ResourceProtector",
+ "TokenValidator",
+ "TokenEndpoint",
+ "BaseGrant",
+ "AuthorizationEndpointMixin",
+ "TokenEndpointMixin",
+ "AuthorizationCodeGrant",
+ "ImplicitGrant",
+ "ResourceOwnerPasswordCredentialsGrant",
+ "ClientCredentialsGrant",
+ "RefreshTokenGrant",
+ "scope_to_list",
+ "list_to_scope",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..e816e297
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/authenticate_client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/authenticate_client.cpython-312.pyc
new file mode 100644
index 00000000..595713d5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/authenticate_client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/authorization_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/authorization_server.cpython-312.pyc
new file mode 100644
index 00000000..60db5a0e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/authorization_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..1e08a69a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/hooks.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/hooks.cpython-312.pyc
new file mode 100644
index 00000000..9298f6ac
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/hooks.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..306502c2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/parameters.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/parameters.cpython-312.pyc
new file mode 100644
index 00000000..c6fe556b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/parameters.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/requests.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/requests.cpython-312.pyc
new file mode 100644
index 00000000..f1dd3144
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/requests.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/resource_protector.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/resource_protector.cpython-312.pyc
new file mode 100644
index 00000000..a27b77d5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/resource_protector.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/token_endpoint.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/token_endpoint.cpython-312.pyc
new file mode 100644
index 00000000..176e895a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/token_endpoint.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/util.cpython-312.pyc
new file mode 100644
index 00000000..fb0bab70
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/wrappers.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/wrappers.cpython-312.pyc
new file mode 100644
index 00000000..eb5fe649
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/__pycache__/wrappers.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/authenticate_client.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/authenticate_client.py
new file mode 100644
index 00000000..3792dcab
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/authenticate_client.py
@@ -0,0 +1,114 @@
+"""authlib.oauth2.rfc6749.authenticate_client.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Registry of client authentication methods, with 3 built-in methods:
+
+1. client_secret_basic
+2. client_secret_post
+3. none
+
+The "client_secret_basic" method is used a lot in examples of `RFC6749`_,
+but the concept of naming are introduced in `RFC7591`_.
+
+.. _`RFC6749`: https://tools.ietf.org/html/rfc6749
+.. _`RFC7591`: https://tools.ietf.org/html/rfc7591
+"""
+
+import logging
+
+from .errors import InvalidClientError
+from .util import extract_basic_authorization
+
+log = logging.getLogger(__name__)
+
+__all__ = ["ClientAuthentication"]
+
+
+class ClientAuthentication:
+ def __init__(self, query_client):
+ self.query_client = query_client
+ self._methods = {
+ "none": authenticate_none,
+ "client_secret_basic": authenticate_client_secret_basic,
+ "client_secret_post": authenticate_client_secret_post,
+ }
+
+ def register(self, method, func):
+ self._methods[method] = func
+
+ def authenticate(self, request, methods, endpoint):
+ for method in methods:
+ func = self._methods[method]
+ client = func(self.query_client, request)
+ if client and client.check_endpoint_auth_method(method, endpoint):
+ request.auth_method = method
+ return client
+
+ if "client_secret_basic" in methods:
+ raise InvalidClientError(
+ status_code=401,
+ description=f"The client cannot authenticate with methods: {methods}",
+ )
+ raise InvalidClientError(
+ description=f"The client cannot authenticate with methods: {methods}",
+ )
+
+ def __call__(self, request, methods, endpoint="token"):
+ return self.authenticate(request, methods, endpoint)
+
+
+def authenticate_client_secret_basic(query_client, request):
+ """Authenticate client by ``client_secret_basic`` method. The client
+ uses HTTP Basic for authentication.
+ """
+ client_id, client_secret = extract_basic_authorization(request.headers)
+ if client_id and client_secret:
+ client = _validate_client(query_client, client_id, 401)
+ if client.check_client_secret(client_secret):
+ log.debug(f'Authenticate {client_id} via "client_secret_basic" success')
+ return client
+ log.debug(f'Authenticate {client_id} via "client_secret_basic" failed')
+
+
+def authenticate_client_secret_post(query_client, request):
+ """Authenticate client by ``client_secret_post`` method. The client
+ uses POST parameters for authentication.
+ """
+ data = request.form
+ client_id = data.get("client_id")
+ client_secret = data.get("client_secret")
+ if client_id and client_secret:
+ client = _validate_client(query_client, client_id)
+ if client.check_client_secret(client_secret):
+ log.debug(f'Authenticate {client_id} via "client_secret_post" success')
+ return client
+ log.debug(f'Authenticate {client_id} via "client_secret_post" failed')
+
+
+def authenticate_none(query_client, request):
+ """Authenticate public client by ``none`` method. The client
+ does not have a client secret.
+ """
+ client_id = request.payload.client_id
+ if client_id and not request.payload.data.get("client_secret"):
+ client = _validate_client(query_client, client_id)
+ log.debug(f'Authenticate {client_id} via "none" success')
+ return client
+ log.debug(f'Authenticate {client_id} via "none" failed')
+
+
+def _validate_client(query_client, client_id, status_code=400):
+ if client_id is None:
+ raise InvalidClientError(
+ status_code=status_code,
+ description="Missing 'client_id' parameter.",
+ )
+
+ client = query_client(client_id)
+ if not client:
+ raise InvalidClientError(
+ status_code=status_code,
+ description="The client does not exist on this server.",
+ )
+
+ return client
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/authorization_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/authorization_server.py
new file mode 100644
index 00000000..928251dc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/authorization_server.py
@@ -0,0 +1,360 @@
+from authlib.common.errors import ContinueIteration
+from authlib.deprecate import deprecate
+
+from .authenticate_client import ClientAuthentication
+from .errors import InvalidScopeError
+from .errors import OAuth2Error
+from .errors import UnsupportedGrantTypeError
+from .errors import UnsupportedResponseTypeError
+from .hooks import Hookable
+from .hooks import hooked
+from .requests import JsonRequest
+from .requests import OAuth2Request
+from .util import scope_to_list
+
+
+class AuthorizationServer(Hookable):
+ """Authorization server that handles Authorization Endpoint and Token
+ Endpoint.
+
+ :param scopes_supported: A list of supported scopes by this authorization server.
+ """
+
+ def __init__(self, scopes_supported=None):
+ super().__init__()
+ self.scopes_supported = scopes_supported
+ self._token_generators = {}
+ self._client_auth = None
+ self._authorization_grants = []
+ self._token_grants = []
+ self._endpoints = {}
+ self._extensions = []
+
+ def query_client(self, client_id):
+ """Query OAuth client by client_id. The client model class MUST
+ implement the methods described by
+ :class:`~authlib.oauth2.rfc6749.ClientMixin`.
+ """
+ raise NotImplementedError()
+
+ def save_token(self, token, request):
+ """Define function to save the generated token into database."""
+ raise NotImplementedError()
+
+ def generate_token(
+ self,
+ grant_type,
+ client,
+ user=None,
+ scope=None,
+ expires_in=None,
+ include_refresh_token=True,
+ ):
+ """Generate the token dict.
+
+ :param grant_type: current requested grant_type.
+ :param client: the client that making the request.
+ :param user: current authorized user.
+ :param expires_in: if provided, use this value as expires_in.
+ :param scope: current requested scope.
+ :param include_refresh_token: should refresh_token be included.
+ :return: Token dict
+ """
+ # generator for a specified grant type
+ func = self._token_generators.get(grant_type)
+ if not func:
+ # default generator for all grant types
+ func = self._token_generators.get("default")
+ if not func:
+ raise RuntimeError("No configured token generator")
+
+ return func(
+ grant_type=grant_type,
+ client=client,
+ user=user,
+ scope=scope,
+ expires_in=expires_in,
+ include_refresh_token=include_refresh_token,
+ )
+
+ def register_token_generator(self, grant_type, func):
+ """Register a function as token generator for the given ``grant_type``.
+ Developers MUST register a default token generator with a special
+ ``grant_type=default``::
+
+ def generate_bearer_token(
+ grant_type,
+ client,
+ user=None,
+ scope=None,
+ expires_in=None,
+ include_refresh_token=True,
+ ):
+ token = {"token_type": "Bearer", "access_token": ...}
+ if include_refresh_token:
+ token["refresh_token"] = ...
+ ...
+ return token
+
+
+ authorization_server.register_token_generator(
+ "default", generate_bearer_token
+ )
+
+ If you register a generator for a certain grant type, that generator will only works
+ for the given grant type::
+
+ authorization_server.register_token_generator(
+ "client_credentials",
+ generate_bearer_token,
+ )
+
+ :param grant_type: string name of the grant type
+ :param func: a function to generate token
+ """
+ self._token_generators[grant_type] = func
+
+ def authenticate_client(self, request, methods, endpoint="token"):
+ """Authenticate client via HTTP request information with the given
+ methods, such as ``client_secret_basic``, ``client_secret_post``.
+ """
+ if self._client_auth is None and self.query_client:
+ self._client_auth = ClientAuthentication(self.query_client)
+ return self._client_auth(request, methods, endpoint)
+
+ def register_client_auth_method(self, method, func):
+ """Add more client auth method. The default methods are:
+
+ * none: The client is a public client and does not have a client secret
+ * client_secret_post: The client uses the HTTP POST parameters
+ * client_secret_basic: The client uses HTTP Basic
+
+ :param method: Name of the Auth method
+ :param func: Function to authenticate the client
+
+ The auth method accept two parameters: ``query_client`` and ``request``,
+ an example for this method::
+
+ def authenticate_client_via_custom(query_client, request):
+ client_id = request.headers["X-Client-Id"]
+ client = query_client(client_id)
+ do_some_validation(client)
+ return client
+
+
+ authorization_server.register_client_auth_method(
+ "custom", authenticate_client_via_custom
+ )
+ """
+ if self._client_auth is None and self.query_client:
+ self._client_auth = ClientAuthentication(self.query_client)
+
+ self._client_auth.register(method, func)
+
+ def register_extension(self, extension):
+ self._extensions.append(extension(self))
+
+ def get_error_uri(self, request, error):
+ """Return a URI for the given error, framework may implement this method."""
+ return None
+
+ def send_signal(self, name, *args, **kwargs):
+ """Framework integration can re-implement this method to support
+ signal system.
+ """
+ raise NotImplementedError()
+
+ def create_oauth2_request(self, request) -> OAuth2Request:
+ """This method MUST be implemented in framework integrations. It is
+ used to create an OAuth2Request instance.
+
+ :param request: the "request" instance in framework
+ :return: OAuth2Request instance
+ """
+ raise NotImplementedError()
+
+ def create_json_request(self, request) -> JsonRequest:
+ """This method MUST be implemented in framework integrations. It is
+ used to create an HttpRequest instance.
+
+ :param request: the "request" instance in framework
+ :return: HttpRequest instance
+ """
+ raise NotImplementedError()
+
+ def handle_response(self, status, body, headers):
+ """Return HTTP response. Framework MUST implement this function."""
+ raise NotImplementedError()
+
+ def validate_requested_scope(self, scope):
+ """Validate if requested scope is supported by Authorization Server.
+ Developers CAN re-write this method to meet your needs.
+ """
+ if scope and self.scopes_supported:
+ scopes = set(scope_to_list(scope))
+ if not set(self.scopes_supported).issuperset(scopes):
+ raise InvalidScopeError()
+
+ def register_grant(self, grant_cls, extensions=None):
+ """Register a grant class into the endpoint registry. Developers
+ can implement the grants in ``authlib.oauth2.rfc6749.grants`` and
+ register with this method::
+
+ class AuthorizationCodeGrant(grants.AuthorizationCodeGrant):
+ def authenticate_user(self, credential):
+ # ...
+
+ authorization_server.register_grant(AuthorizationCodeGrant)
+
+ :param grant_cls: a grant class.
+ :param extensions: extensions for the grant class.
+ """
+ if hasattr(grant_cls, "check_authorization_endpoint"):
+ self._authorization_grants.append((grant_cls, extensions))
+ if hasattr(grant_cls, "check_token_endpoint"):
+ self._token_grants.append((grant_cls, extensions))
+
+ def register_endpoint(self, endpoint):
+ """Add extra endpoint to authorization server. e.g.
+ RevocationEndpoint::
+
+ authorization_server.register_endpoint(RevocationEndpoint)
+
+ :param endpoint_cls: A endpoint class or instance.
+ """
+ if isinstance(endpoint, type):
+ endpoint = endpoint(self)
+ else:
+ endpoint.server = self
+
+ endpoints = self._endpoints.setdefault(endpoint.ENDPOINT_NAME, [])
+ endpoints.append(endpoint)
+
+ @hooked
+ def get_authorization_grant(self, request):
+ """Find the authorization grant for current request.
+
+ :param request: OAuth2Request instance.
+ :return: grant instance
+ """
+ for grant_cls, extensions in self._authorization_grants:
+ if grant_cls.check_authorization_endpoint(request):
+ return _create_grant(grant_cls, extensions, request, self)
+
+ raise UnsupportedResponseTypeError(
+ f"The response type '{request.payload.response_type}' is not supported by the server.",
+ request.payload.response_type,
+ redirect_uri=request.payload.redirect_uri,
+ )
+
+ def get_consent_grant(self, request=None, end_user=None):
+ """Validate current HTTP request for authorization page. This page
+ is designed for resource owner to grant or deny the authorization.
+ """
+ request = self.create_oauth2_request(request)
+
+ try:
+ request.user = end_user
+
+ grant = self.get_authorization_grant(request)
+ grant.validate_no_multiple_request_parameter(request)
+ grant.validate_consent_request()
+
+ except OAuth2Error as error:
+ # REQUIRED if a "state" parameter was present in the client
+ # authorization request. The exact value received from the
+ # client.
+ error.state = request.payload.state
+ raise
+ return grant
+
+ def get_token_grant(self, request):
+ """Find the token grant for current request.
+
+ :param request: OAuth2Request instance.
+ :return: grant instance
+ """
+ for grant_cls, extensions in self._token_grants:
+ if grant_cls.check_token_endpoint(request):
+ return _create_grant(grant_cls, extensions, request, self)
+ raise UnsupportedGrantTypeError(request.payload.grant_type)
+
+ def create_endpoint_response(self, name, request=None):
+ """Validate endpoint request and create endpoint response.
+
+ :param name: Endpoint name
+ :param request: HTTP request instance.
+ :return: Response
+ """
+ if name not in self._endpoints:
+ raise RuntimeError(f"There is no '{name}' endpoint.")
+
+ endpoints = self._endpoints[name]
+ for endpoint in endpoints:
+ request = endpoint.create_endpoint_request(request)
+ try:
+ return self.handle_response(*endpoint(request))
+ except ContinueIteration:
+ continue
+ except OAuth2Error as error:
+ return self.handle_error_response(request, error)
+
+ @hooked
+ def create_authorization_response(self, request=None, grant_user=None, grant=None):
+ """Validate authorization request and create authorization response.
+
+ :param request: HTTP request instance.
+ :param grant_user: if granted, it is resource owner. If denied,
+ it is None.
+ :returns: Response
+ """
+ if not isinstance(request, OAuth2Request):
+ request = self.create_oauth2_request(request)
+
+ if not grant:
+ deprecate("The 'grant' parameter will become mandatory.", version="1.8")
+ try:
+ grant = self.get_authorization_grant(request)
+ except UnsupportedResponseTypeError as error:
+ error.state = request.payload.state
+ return self.handle_error_response(request, error)
+
+ try:
+ redirect_uri = grant.validate_authorization_request()
+ args = grant.create_authorization_response(redirect_uri, grant_user)
+ response = self.handle_response(*args)
+ except OAuth2Error as error:
+ error.state = request.payload.state
+ response = self.handle_error_response(request, error)
+
+ grant.execute_hook("after_authorization_response", response)
+ return response
+
+ def create_token_response(self, request=None):
+ """Validate token request and create token response.
+
+ :param request: HTTP request instance
+ """
+ request = self.create_oauth2_request(request)
+ try:
+ grant = self.get_token_grant(request)
+ except UnsupportedGrantTypeError as error:
+ return self.handle_error_response(request, error)
+
+ try:
+ grant.validate_token_request()
+ args = grant.create_token_response()
+ return self.handle_response(*args)
+ except OAuth2Error as error:
+ return self.handle_error_response(request, error)
+
+ def handle_error_response(self, request, error):
+ return self.handle_response(*error(self.get_error_uri(request, error)))
+
+
+def _create_grant(grant_cls, extensions, request, server):
+ grant = grant_cls(request, server)
+ if extensions:
+ for ext in extensions:
+ ext(grant)
+ return grant
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/errors.py
new file mode 100644
index 00000000..87d73b3a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/errors.py
@@ -0,0 +1,247 @@
+"""authlib.oauth2.rfc6749.errors.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Implementation for OAuth 2 Error Response. A basic error has
+parameters:
+
+Error:
+REQUIRED. A single ASCII [USASCII] error code.
+
+error_description
+OPTIONAL. Human-readable ASCII [USASCII] text providing
+additional information, used to assist the client developer in
+understanding the error that occurred.
+
+error_uri
+OPTIONAL. A URI identifying a human-readable web page with
+information about the error, used to provide the client
+developer with additional information about the error.
+Values for the "error_uri" parameter MUST conform to the
+URI-reference syntax and thus MUST NOT include characters
+outside the set %x21 / %x23-5B / %x5D-7E.
+
+state
+REQUIRED if a "state" parameter was present in the client
+authorization request. The exact value received from the
+client.
+
+https://tools.ietf.org/html/rfc6749#section-5.2
+
+:copyright: (c) 2017 by Hsiaoming Yang.
+
+"""
+
+from authlib.common.security import is_secure_transport
+from authlib.oauth2.base import OAuth2Error
+
+__all__ = [
+ "OAuth2Error",
+ "InsecureTransportError",
+ "InvalidRequestError",
+ "InvalidClientError",
+ "UnauthorizedClientError",
+ "InvalidGrantError",
+ "UnsupportedResponseTypeError",
+ "UnsupportedGrantTypeError",
+ "InvalidScopeError",
+ "AccessDeniedError",
+ "MissingAuthorizationError",
+ "UnsupportedTokenTypeError",
+ "MissingCodeException",
+ "MissingTokenException",
+ "MissingTokenTypeException",
+ "MismatchingStateException",
+]
+
+
+class InsecureTransportError(OAuth2Error):
+ error = "insecure_transport"
+ description = "OAuth 2 MUST utilize https."
+
+ @classmethod
+ def check(cls, uri):
+ """Check and raise InsecureTransportError with the given URI."""
+ if not is_secure_transport(uri):
+ raise cls()
+
+
+class InvalidRequestError(OAuth2Error):
+ """The request is missing a required parameter, includes an
+ unsupported parameter value (other than grant type),
+ repeats a parameter, includes multiple credentials,
+ utilizes more than one mechanism for authenticating the
+ client, or is otherwise malformed.
+
+ https://tools.ietf.org/html/rfc6749#section-5.2
+ """
+
+ error = "invalid_request"
+
+
+class InvalidClientError(OAuth2Error):
+ """Client authentication failed (e.g., unknown client, no
+ client authentication included, or unsupported
+ authentication method). The authorization server MAY
+ return an HTTP 401 (Unauthorized) status code to indicate
+ which HTTP authentication schemes are supported. If the
+ client attempted to authenticate via the "Authorization"
+ request header field, the authorization server MUST
+ respond with an HTTP 401 (Unauthorized) status code and
+ include the "WWW-Authenticate" response header field
+ matching the authentication scheme used by the client.
+
+ https://tools.ietf.org/html/rfc6749#section-5.2
+ """
+
+ error = "invalid_client"
+ status_code = 400
+
+ def get_headers(self):
+ headers = super().get_headers()
+ if self.status_code == 401:
+ error_description = self.get_error_description()
+ # safe escape
+ error_description = error_description.replace('"', "|")
+ extras = [
+ f'error="{self.error}"',
+ f'error_description="{error_description}"',
+ ]
+ headers.append(("WWW-Authenticate", "Basic " + ", ".join(extras)))
+ return headers
+
+
+class InvalidGrantError(OAuth2Error):
+ """The provided authorization grant (e.g., authorization
+ code, resource owner credentials) or refresh token is
+ invalid, expired, revoked, does not match the redirection
+ URI used in the authorization request, or was issued to
+ another client.
+
+ https://tools.ietf.org/html/rfc6749#section-5.2
+ """
+
+ error = "invalid_grant"
+
+
+class UnauthorizedClientError(OAuth2Error):
+ """The authenticated client is not authorized to use this
+ authorization grant type.
+
+ https://tools.ietf.org/html/rfc6749#section-5.2
+ """
+
+ error = "unauthorized_client"
+
+
+class UnsupportedResponseTypeError(OAuth2Error):
+ """The authorization server does not support obtaining
+ an access token using this method.
+ """
+
+ error = "unsupported_response_type"
+
+ def __init__(self, response_type, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.response_type = response_type
+
+ def get_error_description(self):
+ return f"response_type={self.response_type} is not supported"
+
+
+class UnsupportedGrantTypeError(OAuth2Error):
+ """The authorization grant type is not supported by the
+ authorization server.
+
+ https://tools.ietf.org/html/rfc6749#section-5.2
+ """
+
+ error = "unsupported_grant_type"
+
+ def __init__(self, grant_type):
+ super().__init__()
+ self.grant_type = grant_type
+
+ def get_error_description(self):
+ return f"grant_type={self.grant_type} is not supported"
+
+
+class InvalidScopeError(OAuth2Error):
+ """The requested scope is invalid, unknown, malformed, or
+ exceeds the scope granted by the resource owner.
+
+ https://tools.ietf.org/html/rfc6749#section-5.2
+ """
+
+ error = "invalid_scope"
+ description = "The requested scope is invalid, unknown, or malformed."
+
+
+class AccessDeniedError(OAuth2Error):
+ """The resource owner or authorization server denied the request.
+
+ Used in authorization endpoint for "code" and "implicit". Defined in
+ `Section 4.1.2.1`_.
+
+ .. _`Section 4.1.2.1`: https://tools.ietf.org/html/rfc6749#section-4.1.2.1
+ """
+
+ error = "access_denied"
+ description = "The resource owner or authorization server denied the request"
+
+
+# -- below are extended errors -- #
+
+
+class ForbiddenError(OAuth2Error):
+ status_code = 401
+
+ def __init__(self, auth_type=None, realm=None):
+ super().__init__()
+ self.auth_type = auth_type
+ self.realm = realm
+
+ def get_headers(self):
+ headers = super().get_headers()
+ if not self.auth_type:
+ return headers
+
+ extras = []
+ if self.realm:
+ extras.append(f'realm="{self.realm}"')
+ extras.append(f'error="{self.error}"')
+ error_description = self.description
+ extras.append(f'error_description="{error_description}"')
+ headers.append(("WWW-Authenticate", f"{self.auth_type} " + ", ".join(extras)))
+ return headers
+
+
+class MissingAuthorizationError(ForbiddenError):
+ error = "missing_authorization"
+ description = "Missing 'Authorization' in headers."
+
+
+class UnsupportedTokenTypeError(ForbiddenError):
+ error = "unsupported_token_type"
+
+
+# -- exceptions for clients -- #
+
+
+class MissingCodeException(OAuth2Error):
+ error = "missing_code"
+ description = "Missing 'code' in response."
+
+
+class MissingTokenException(OAuth2Error):
+ error = "missing_token"
+ description = "Missing 'access_token' in response."
+
+
+class MissingTokenTypeException(OAuth2Error):
+ error = "missing_token_type"
+ description = "Missing 'token_type' in response."
+
+
+class MismatchingStateException(OAuth2Error):
+ error = "mismatching_state"
+ description = "CSRF Warning! State not equal in request and response."
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__init__.py
new file mode 100644
index 00000000..f627c418
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__init__.py
@@ -0,0 +1,41 @@
+"""
+authlib.oauth2.rfc6749.grants
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Implementation for `Section 4`_ of "Obtaining Authorization".
+
+To request an access token, the client obtains authorization from the
+resource owner. The authorization is expressed in the form of an
+authorization grant, which the client uses to request the access
+token. OAuth defines four grant types:
+
+1. authorization code
+2. implicit
+3. resource owner password credentials
+4. client credentials.
+
+It also provides an extension mechanism for defining additional grant
+types. Authlib defines refresh_token as a grant type too.
+
+.. _`Section 4`: https://tools.ietf.org/html/rfc6749#section-4
+"""
+
+from .authorization_code import AuthorizationCodeGrant
+from .base import AuthorizationEndpointMixin
+from .base import BaseGrant
+from .base import TokenEndpointMixin
+from .client_credentials import ClientCredentialsGrant
+from .implicit import ImplicitGrant
+from .refresh_token import RefreshTokenGrant
+from .resource_owner_password_credentials import ResourceOwnerPasswordCredentialsGrant
+
+__all__ = [
+ "BaseGrant",
+ "AuthorizationEndpointMixin",
+ "TokenEndpointMixin",
+ "AuthorizationCodeGrant",
+ "ImplicitGrant",
+ "ResourceOwnerPasswordCredentialsGrant",
+ "ClientCredentialsGrant",
+ "RefreshTokenGrant",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..17438b5d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/authorization_code.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/authorization_code.cpython-312.pyc
new file mode 100644
index 00000000..a4286428
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/authorization_code.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/base.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/base.cpython-312.pyc
new file mode 100644
index 00000000..368539b5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/base.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/client_credentials.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/client_credentials.cpython-312.pyc
new file mode 100644
index 00000000..0c62a4ff
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/client_credentials.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/implicit.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/implicit.cpython-312.pyc
new file mode 100644
index 00000000..1542ff65
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/implicit.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/refresh_token.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/refresh_token.cpython-312.pyc
new file mode 100644
index 00000000..fc2fac61
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/refresh_token.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/resource_owner_password_credentials.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/resource_owner_password_credentials.cpython-312.pyc
new file mode 100644
index 00000000..2cea609b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/__pycache__/resource_owner_password_credentials.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/authorization_code.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/authorization_code.py
new file mode 100644
index 00000000..f3479541
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/authorization_code.py
@@ -0,0 +1,390 @@
+import logging
+
+from authlib.common.security import generate_token
+from authlib.common.urls import add_params_to_uri
+
+from ..errors import AccessDeniedError
+from ..errors import InvalidClientError
+from ..errors import InvalidGrantError
+from ..errors import InvalidRequestError
+from ..errors import OAuth2Error
+from ..errors import UnauthorizedClientError
+from ..hooks import hooked
+from .base import AuthorizationEndpointMixin
+from .base import BaseGrant
+from .base import TokenEndpointMixin
+
+log = logging.getLogger(__name__)
+
+
+class AuthorizationCodeGrant(BaseGrant, AuthorizationEndpointMixin, TokenEndpointMixin):
+ """The authorization code grant type is used to obtain both access
+ tokens and refresh tokens and is optimized for confidential clients.
+ Since this is a redirection-based flow, the client must be capable of
+ interacting with the resource owner's user-agent (typically a web
+ browser) and capable of receiving incoming requests (via redirection)
+ from the authorization server::
+
+ +----------+
+ | Resource |
+ | Owner |
+ | |
+ +----------+
+ ^
+ |
+ (B)
+ +----|-----+ Client Identifier +---------------+
+ | -+----(A)-- & Redirection URI ---->| |
+ | User- | | Authorization |
+ | Agent -+----(B)-- User authenticates --->| Server |
+ | | | |
+ | -+----(C)-- Authorization Code ---<| |
+ +-|----|---+ +---------------+
+ | | ^ v
+ (A) (C) | |
+ | | | |
+ ^ v | |
+ +---------+ | |
+ | |>---(D)-- Authorization Code ---------' |
+ | Client | & Redirection URI |
+ | | |
+ | |<---(E)----- Access Token -------------------'
+ +---------+ (w/ Optional Refresh Token)
+ """
+
+ #: Allowed client auth methods for token endpoint
+ TOKEN_ENDPOINT_AUTH_METHODS = ["client_secret_basic", "client_secret_post"]
+
+ #: Generated "code" length
+ AUTHORIZATION_CODE_LENGTH = 48
+
+ RESPONSE_TYPES = {"code"}
+ GRANT_TYPE = "authorization_code"
+
+ def validate_authorization_request(self):
+ """The client constructs the request URI by adding the following
+ parameters to the query component of the authorization endpoint URI
+ using the "application/x-www-form-urlencoded" format.
+ Per `Section 4.1.1`_.
+
+ response_type
+ REQUIRED. Value MUST be set to "code".
+
+ client_id
+ REQUIRED. The client identifier as described in Section 2.2.
+
+ redirect_uri
+ OPTIONAL. As described in Section 3.1.2.
+
+ scope
+ OPTIONAL. The scope of the access request as described by
+ Section 3.3.
+
+ state
+ RECOMMENDED. An opaque value used by the client to maintain
+ state between the request and callback. The authorization
+ server includes this value when redirecting the user-agent back
+ to the client. The parameter SHOULD be used for preventing
+ cross-site request forgery as described in Section 10.12.
+
+ The client directs the resource owner to the constructed URI using an
+ HTTP redirection response, or by other means available to it via the
+ user-agent.
+
+ For example, the client directs the user-agent to make the following
+ HTTP request using TLS (with extra line breaks for display purposes
+ only):
+
+ .. code-block:: http
+
+ GET /authorize?response_type=code&client_id=s6BhdRkqt3&state=xyz
+ &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1
+ Host: server.example.com
+
+ The authorization server validates the request to ensure that all
+ required parameters are present and valid. If the request is valid,
+ the authorization server authenticates the resource owner and obtains
+ an authorization decision (by asking the resource owner or by
+ establishing approval via other means).
+
+ .. _`Section 4.1.1`: https://tools.ietf.org/html/rfc6749#section-4.1.1
+ """
+ return validate_code_authorization_request(self)
+
+ def create_authorization_response(self, redirect_uri: str, grant_user):
+ """If the resource owner grants the access request, the authorization
+ server issues an authorization code and delivers it to the client by
+ adding the following parameters to the query component of the
+ redirection URI using the "application/x-www-form-urlencoded" format.
+ Per `Section 4.1.2`_.
+
+ code
+ REQUIRED. The authorization code generated by the
+ authorization server. The authorization code MUST expire
+ shortly after it is issued to mitigate the risk of leaks. A
+ maximum authorization code lifetime of 10 minutes is
+ RECOMMENDED. The client MUST NOT use the authorization code
+ more than once. If an authorization code is used more than
+ once, the authorization server MUST deny the request and SHOULD
+ revoke (when possible) all tokens previously issued based on
+ that authorization code. The authorization code is bound to
+ the client identifier and redirection URI.
+ state
+ REQUIRED if the "state" parameter was present in the client
+ authorization request. The exact value received from the
+ client.
+
+ For example, the authorization server redirects the user-agent by
+ sending the following HTTP response.
+
+ .. code-block:: http
+
+ HTTP/1.1 302 Found
+ Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA
+ &state=xyz
+
+ .. _`Section 4.1.2`: https://tools.ietf.org/html/rfc6749#section-4.1.2
+
+ :param redirect_uri: Redirect to the given URI for the authorization
+ :param grant_user: if resource owner granted the request, pass this
+ resource owner, otherwise pass None.
+ :returns: (status_code, body, headers)
+ """
+ if not grant_user:
+ raise AccessDeniedError(redirect_uri=redirect_uri)
+
+ self.request.user = grant_user
+
+ code = self.generate_authorization_code()
+ self.save_authorization_code(code, self.request)
+
+ params = [("code", code)]
+ if self.request.payload.state:
+ params.append(("state", self.request.payload.state))
+ uri = add_params_to_uri(redirect_uri, params)
+ headers = [("Location", uri)]
+ return 302, "", headers
+
+ @hooked
+ def validate_token_request(self):
+ """The client makes a request to the token endpoint by sending the
+ following parameters using the "application/x-www-form-urlencoded"
+ format per `Section 4.1.3`_:
+
+ grant_type
+ REQUIRED. Value MUST be set to "authorization_code".
+
+ code
+ REQUIRED. The authorization code received from the
+ authorization server.
+
+ redirect_uri
+ REQUIRED, if the "redirect_uri" parameter was included in the
+ authorization request as described in Section 4.1.1, and their
+ values MUST be identical.
+
+ client_id
+ REQUIRED, if the client is not authenticating with the
+ authorization server as described in Section 3.2.1.
+
+ If the client type is confidential or the client was issued client
+ credentials (or assigned other authentication requirements), the
+ client MUST authenticate with the authorization server as described
+ in Section 3.2.1.
+
+ For example, the client makes the following HTTP request using TLS:
+
+ .. code-block:: http
+
+ POST /token HTTP/1.1
+ Host: server.example.com
+ Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
+ Content-Type: application/x-www-form-urlencoded
+
+ grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA
+ &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
+
+ .. _`Section 4.1.3`: https://tools.ietf.org/html/rfc6749#section-4.1.3
+ """
+ # ignore validate for grant_type, since it is validated by
+ # check_token_endpoint
+
+ # authenticate the client if client authentication is included
+ client = self.authenticate_token_endpoint_client()
+
+ log.debug("Validate token request of %r", client)
+ if not client.check_grant_type(self.GRANT_TYPE):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'grant_type={self.GRANT_TYPE}'"
+ )
+
+ code = self.request.form.get("code")
+ if code is None:
+ raise InvalidRequestError("Missing 'code' in request.")
+
+ # ensure that the authorization code was issued to the authenticated
+ # confidential client, or if the client is public, ensure that the
+ # code was issued to "client_id" in the request
+ authorization_code = self.query_authorization_code(code, client)
+ if not authorization_code:
+ raise InvalidGrantError("Invalid 'code' in request.")
+
+ # validate redirect_uri parameter
+ log.debug("Validate token redirect_uri of %r", client)
+ redirect_uri = self.request.payload.redirect_uri
+ original_redirect_uri = authorization_code.get_redirect_uri()
+ if original_redirect_uri and redirect_uri != original_redirect_uri:
+ raise InvalidGrantError("Invalid 'redirect_uri' in request.")
+
+ # save for create_token_response
+ self.request.client = client
+ self.request.authorization_code = authorization_code
+
+ @hooked
+ def create_token_response(self):
+ """If the access token request is valid and authorized, the
+ authorization server issues an access token and optional refresh
+ token as described in Section 5.1. If the request client
+ authentication failed or is invalid, the authorization server returns
+ an error response as described in Section 5.2. Per `Section 4.1.4`_.
+
+ An example successful response:
+
+ .. code-block:: http
+
+ HTTP/1.1 200 OK
+ Content-Type: application/json
+ Cache-Control: no-store
+ Pragma: no-cache
+
+ {
+ "access_token":"2YotnFZFEjr1zCsicMWpAA",
+ "token_type":"example",
+ "expires_in":3600,
+ "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",
+ "example_parameter":"example_value"
+ }
+
+ :returns: (status_code, body, headers)
+
+ .. _`Section 4.1.4`: https://tools.ietf.org/html/rfc6749#section-4.1.4
+ """
+ client = self.request.client
+ authorization_code = self.request.authorization_code
+
+ user = self.authenticate_user(authorization_code)
+ if not user:
+ raise InvalidGrantError("There is no 'user' for this code.")
+ self.request.user = user
+
+ scope = authorization_code.get_scope()
+ token = self.generate_token(
+ user=user,
+ scope=scope,
+ include_refresh_token=client.check_grant_type("refresh_token"),
+ )
+ log.debug("Issue token %r to %r", token, client)
+
+ self.save_token(token)
+ self.delete_authorization_code(authorization_code)
+ return 200, token, self.TOKEN_RESPONSE_HEADER
+
+ def generate_authorization_code(self):
+ """ "The method to generate "code" value for authorization code data.
+ Developers may rewrite this method, or customize the code length with::
+
+ class MyAuthorizationCodeGrant(AuthorizationCodeGrant):
+ AUTHORIZATION_CODE_LENGTH = 32 # default is 48
+ """
+ return generate_token(self.AUTHORIZATION_CODE_LENGTH)
+
+ def save_authorization_code(self, code, request):
+ """Save authorization_code for later use. Developers MUST implement
+ it in subclass. Here is an example::
+
+ def save_authorization_code(self, code, request):
+ client = request.client
+ item = AuthorizationCode(
+ code=code,
+ client_id=client.client_id,
+ redirect_uri=request.payload.redirect_uri,
+ scope=request.payload.scope,
+ user_id=request.user.id,
+ )
+ item.save()
+ """
+ raise NotImplementedError()
+
+ def query_authorization_code(self, code, client): # pragma: no cover
+ """Get authorization_code from previously savings. Developers MUST
+ implement it in subclass::
+
+ def query_authorization_code(self, code, client):
+ return Authorization.get(code=code, client_id=client.client_id)
+
+ :param code: a string represent the code.
+ :param client: client related to this code.
+ :return: authorization_code object
+ """
+ raise NotImplementedError()
+
+ def delete_authorization_code(self, authorization_code):
+ """Delete authorization code from database or cache. Developers MUST
+ implement it in subclass, e.g.::
+
+ def delete_authorization_code(self, authorization_code):
+ authorization_code.delete()
+
+ :param authorization_code: the instance of authorization_code
+ """
+ raise NotImplementedError()
+
+ def authenticate_user(self, authorization_code):
+ """Authenticate the user related to this authorization_code. Developers
+ MUST implement this method in subclass, e.g.::
+
+ def authenticate_user(self, authorization_code):
+ return User.get(authorization_code.user_id)
+
+ :param authorization_code: AuthorizationCode object
+ :return: user
+ """
+ raise NotImplementedError()
+
+
+def validate_code_authorization_request(grant):
+ request = grant.request
+ client_id = request.payload.client_id
+ log.debug("Validate authorization request of %r", client_id)
+
+ if client_id is None:
+ raise InvalidClientError(
+ description="Missing 'client_id' parameter.",
+ )
+
+ client = grant.server.query_client(client_id)
+ if not client:
+ raise InvalidClientError(
+ description="The client does not exist on this server.",
+ )
+
+ redirect_uri = grant.validate_authorization_redirect_uri(request, client)
+ response_type = request.payload.response_type
+ if not client.check_response_type(response_type):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'response_type={response_type}'",
+ redirect_uri=redirect_uri,
+ )
+
+ grant.request.client = client
+
+ @hooked
+ def validate_authorization_request_payload(grant, redirect_uri):
+ grant.validate_requested_scope()
+
+ try:
+ validate_authorization_request_payload(grant, redirect_uri)
+ except OAuth2Error as error:
+ error.redirect_uri = redirect_uri
+ raise error
+ return redirect_uri
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/base.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/base.py
new file mode 100644
index 00000000..bd1de087
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/base.py
@@ -0,0 +1,158 @@
+from authlib.consts import default_json_headers
+
+from ..errors import InvalidRequestError
+from ..hooks import Hookable
+from ..hooks import hooked
+from ..requests import OAuth2Request
+
+
+class BaseGrant(Hookable):
+ #: Allowed client auth methods for token endpoint
+ TOKEN_ENDPOINT_AUTH_METHODS = ["client_secret_basic"]
+
+ #: Designed for which "grant_type"
+ GRANT_TYPE = None
+
+ # NOTE: there is no charset for application/json, since
+ # application/json should always in UTF-8.
+ # The example on RFC is incorrect.
+ # https://tools.ietf.org/html/rfc4627
+ TOKEN_RESPONSE_HEADER = default_json_headers
+
+ def __init__(self, request: OAuth2Request, server):
+ super().__init__()
+ self.prompt = None
+ self.redirect_uri = None
+ self.request = request
+ self.server = server
+
+ @property
+ def client(self):
+ return self.request.client
+
+ def generate_token(
+ self,
+ user=None,
+ scope=None,
+ grant_type=None,
+ expires_in=None,
+ include_refresh_token=True,
+ ):
+ if grant_type is None:
+ grant_type = self.GRANT_TYPE
+ return self.server.generate_token(
+ client=self.request.client,
+ grant_type=grant_type,
+ user=user,
+ scope=scope,
+ expires_in=expires_in,
+ include_refresh_token=include_refresh_token,
+ )
+
+ def authenticate_token_endpoint_client(self):
+ """Authenticate client with the given methods for token endpoint.
+
+ For example, the client makes the following HTTP request using TLS:
+
+ .. code-block:: http
+
+ POST /token HTTP/1.1
+ Host: server.example.com
+ Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
+ Content-Type: application/x-www-form-urlencoded
+
+ grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA
+ &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
+
+ Default available methods are: "none", "client_secret_basic" and
+ "client_secret_post".
+
+ :return: client
+ """
+ client = self.server.authenticate_client(
+ self.request, self.TOKEN_ENDPOINT_AUTH_METHODS
+ )
+ self.server.send_signal("after_authenticate_client", client=client, grant=self)
+ return client
+
+ def save_token(self, token):
+ """A method to save token into database."""
+ return self.server.save_token(token, self.request)
+
+ def validate_requested_scope(self):
+ """Validate if requested scope is supported by Authorization Server."""
+ scope = self.request.payload.scope
+ return self.server.validate_requested_scope(scope)
+
+
+class TokenEndpointMixin:
+ #: Allowed HTTP methods of this token endpoint
+ TOKEN_ENDPOINT_HTTP_METHODS = ["POST"]
+
+ #: Designed for which "grant_type"
+ GRANT_TYPE = None
+
+ @classmethod
+ def check_token_endpoint(cls, request: OAuth2Request):
+ return (
+ request.payload.grant_type == cls.GRANT_TYPE
+ and request.method in cls.TOKEN_ENDPOINT_HTTP_METHODS
+ )
+
+ def validate_token_request(self):
+ raise NotImplementedError()
+
+ def create_token_response(self):
+ raise NotImplementedError()
+
+
+class AuthorizationEndpointMixin:
+ RESPONSE_TYPES = set()
+ ERROR_RESPONSE_FRAGMENT = False
+
+ @classmethod
+ def check_authorization_endpoint(cls, request: OAuth2Request):
+ return request.payload.response_type in cls.RESPONSE_TYPES
+
+ @staticmethod
+ def validate_authorization_redirect_uri(request: OAuth2Request, client):
+ if request.payload.redirect_uri:
+ if not client.check_redirect_uri(request.payload.redirect_uri):
+ raise InvalidRequestError(
+ f"Redirect URI {request.payload.redirect_uri} is not supported by client.",
+ )
+ return request.payload.redirect_uri
+ else:
+ redirect_uri = client.get_default_redirect_uri()
+ if not redirect_uri:
+ raise InvalidRequestError(
+ "Missing 'redirect_uri' in request.", state=request.payload.state
+ )
+ return redirect_uri
+
+ @staticmethod
+ def validate_no_multiple_request_parameter(request: OAuth2Request):
+ """For the Authorization Endpoint, request and response parameters MUST NOT be included
+ more than once. Per `Section 3.1`_.
+
+ .. _`Section 3.1`: https://tools.ietf.org/html/rfc6749#section-3.1
+ """
+ datalist = request.payload.datalist
+ parameters = ["response_type", "client_id", "redirect_uri", "scope", "state"]
+ for param in parameters:
+ if len(datalist.get(param, [])) > 1:
+ raise InvalidRequestError(
+ f"Multiple '{param}' in request.", state=request.payload.state
+ )
+
+ @hooked
+ def validate_consent_request(self):
+ redirect_uri = self.validate_authorization_request()
+ self.redirect_uri = redirect_uri
+ return redirect_uri
+
+ def validate_authorization_request(self):
+ raise NotImplementedError()
+
+ def create_authorization_response(self, redirect_uri: str, grant_user):
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/client_credentials.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/client_credentials.py
new file mode 100644
index 00000000..3b0ff7d2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/client_credentials.py
@@ -0,0 +1,109 @@
+import logging
+
+from ..errors import UnauthorizedClientError
+from ..hooks import hooked
+from .base import BaseGrant
+from .base import TokenEndpointMixin
+
+log = logging.getLogger(__name__)
+
+
+class ClientCredentialsGrant(BaseGrant, TokenEndpointMixin):
+ """The client can request an access token using only its client
+ credentials (or other supported means of authentication) when the
+ client is requesting access to the protected resources under its
+ control, or those of another resource owner that have been previously
+ arranged with the authorization server.
+
+ The client credentials grant type MUST only be used by confidential
+ clients::
+
+ +---------+ +---------------+
+ | | | |
+ | |>--(A)- Client Authentication --->| Authorization |
+ | Client | | Server |
+ | |<--(B)---- Access Token ---------<| |
+ | | | |
+ +---------+ +---------------+
+
+ https://tools.ietf.org/html/rfc6749#section-4.4
+ """
+
+ GRANT_TYPE = "client_credentials"
+
+ def validate_token_request(self):
+ """The client makes a request to the token endpoint by adding the
+ following parameters using the "application/x-www-form-urlencoded"
+ format per Appendix B with a character encoding of UTF-8 in the HTTP
+ request entity-body:
+
+ grant_type
+ REQUIRED. Value MUST be set to "client_credentials".
+
+ scope
+ OPTIONAL. The scope of the access request as described by
+ Section 3.3.
+
+ The client MUST authenticate with the authorization server as
+ described in Section 3.2.1.
+
+ For example, the client makes the following HTTP request using
+ transport-layer security (with extra line breaks for display purposes
+ only):
+
+ .. code-block:: http
+
+ POST /token HTTP/1.1
+ Host: server.example.com
+ Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
+ Content-Type: application/x-www-form-urlencoded
+
+ grant_type=client_credentials
+
+ The authorization server MUST authenticate the client.
+ """
+ # ignore validate for grant_type, since it is validated by
+ # check_token_endpoint
+ client = self.authenticate_token_endpoint_client()
+ log.debug("Validate token request of %r", client)
+
+ if not client.check_grant_type(self.GRANT_TYPE):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'grant_type={self.GRANT_TYPE}'"
+ )
+
+ self.request.client = client
+ self.validate_requested_scope()
+
+ @hooked
+ def create_token_response(self):
+ """If the access token request is valid and authorized, the
+ authorization server issues an access token as described in
+ Section 5.1. A refresh token SHOULD NOT be included. If the request
+ failed client authentication or is invalid, the authorization server
+ returns an error response as described in Section 5.2.
+
+ An example successful response:
+
+ .. code-block:: http
+
+ HTTP/1.1 200 OK
+ Content-Type: application/json
+ Cache-Control: no-store
+ Pragma: no-cache
+
+ {
+ "access_token":"2YotnFZFEjr1zCsicMWpAA",
+ "token_type":"example",
+ "expires_in":3600,
+ "example_parameter":"example_value"
+ }
+
+ :returns: (status_code, body, headers)
+ """
+ token = self.generate_token(
+ scope=self.request.payload.scope, include_refresh_token=False
+ )
+ log.debug("Issue token %r to %r", token, self.client)
+ self.save_token(token)
+ return 200, token, self.TOKEN_RESPONSE_HEADER
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/implicit.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/implicit.py
new file mode 100644
index 00000000..170a8764
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/implicit.py
@@ -0,0 +1,225 @@
+import logging
+
+from authlib.common.urls import add_params_to_uri
+
+from ..errors import AccessDeniedError
+from ..errors import OAuth2Error
+from ..errors import UnauthorizedClientError
+from ..hooks import hooked
+from .base import AuthorizationEndpointMixin
+from .base import BaseGrant
+
+log = logging.getLogger(__name__)
+
+
+class ImplicitGrant(BaseGrant, AuthorizationEndpointMixin):
+ """The implicit grant type is used to obtain access tokens (it does not
+ support the issuance of refresh tokens) and is optimized for public
+ clients known to operate a particular redirection URI. These clients
+ are typically implemented in a browser using a scripting language
+ such as JavaScript.
+
+ Since this is a redirection-based flow, the client must be capable of
+ interacting with the resource owner's user-agent (typically a web
+ browser) and capable of receiving incoming requests (via redirection)
+ from the authorization server.
+
+ Unlike the authorization code grant type, in which the client makes
+ separate requests for authorization and for an access token, the
+ client receives the access token as the result of the authorization
+ request.
+
+ The implicit grant type does not include client authentication, and
+ relies on the presence of the resource owner and the registration of
+ the redirection URI. Because the access token is encoded into the
+ redirection URI, it may be exposed to the resource owner and other
+ applications residing on the same device::
+
+ +----------+
+ | Resource |
+ | Owner |
+ | |
+ +----------+
+ ^
+ |
+ (B)
+ +----|-----+ Client Identifier +---------------+
+ | -+----(A)-- & Redirection URI --->| |
+ | User- | | Authorization |
+ | Agent -|----(B)-- User authenticates -->| Server |
+ | | | |
+ | |<---(C)--- Redirection URI ----<| |
+ | | with Access Token +---------------+
+ | | in Fragment
+ | | +---------------+
+ | |----(D)--- Redirection URI ---->| Web-Hosted |
+ | | without Fragment | Client |
+ | | | Resource |
+ | (F) |<---(E)------- Script ---------<| |
+ | | +---------------+
+ +-|--------+
+ | |
+ (A) (G) Access Token
+ | |
+ ^ v
+ +---------+
+ | |
+ | Client |
+ | |
+ +---------+
+ """
+
+ #: authorization_code grant type has authorization endpoint
+ AUTHORIZATION_ENDPOINT = True
+ #: Allowed client auth methods for token endpoint
+ TOKEN_ENDPOINT_AUTH_METHODS = ["none"]
+
+ RESPONSE_TYPES = {"token"}
+ GRANT_TYPE = "implicit"
+ ERROR_RESPONSE_FRAGMENT = True
+
+ @hooked
+ def validate_authorization_request(self):
+ """The client constructs the request URI by adding the following
+ parameters to the query component of the authorization endpoint URI
+ using the "application/x-www-form-urlencoded" format.
+ Per `Section 4.2.1`_.
+
+ response_type
+ REQUIRED. Value MUST be set to "token".
+
+ client_id
+ REQUIRED. The client identifier as described in Section 2.2.
+
+ redirect_uri
+ OPTIONAL. As described in Section 3.1.2.
+
+ scope
+ OPTIONAL. The scope of the access request as described by
+ Section 3.3.
+
+ state
+ RECOMMENDED. An opaque value used by the client to maintain
+ state between the request and callback. The authorization
+ server includes this value when redirecting the user-agent back
+ to the client. The parameter SHOULD be used for preventing
+ cross-site request forgery as described in Section 10.12.
+
+ The client directs the resource owner to the constructed URI using an
+ HTTP redirection response, or by other means available to it via the
+ user-agent.
+
+ For example, the client directs the user-agent to make the following
+ HTTP request using TLS:
+
+ .. code-block:: http
+
+ GET /authorize?response_type=token&client_id=s6BhdRkqt3&state=xyz
+ &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1
+ Host: server.example.com
+
+ .. _`Section 4.2.1`: https://tools.ietf.org/html/rfc6749#section-4.2.1
+ """
+ # ignore validate for response_type, since it is validated by
+ # check_authorization_endpoint
+
+ # The implicit grant type is optimized for public clients
+ client = self.authenticate_token_endpoint_client()
+ log.debug("Validate authorization request of %r", client)
+
+ redirect_uri = self.validate_authorization_redirect_uri(self.request, client)
+
+ response_type = self.request.payload.response_type
+ if not client.check_response_type(response_type):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'response_type={response_type}'",
+ redirect_uri=redirect_uri,
+ redirect_fragment=True,
+ )
+
+ try:
+ self.request.client = client
+ self.validate_requested_scope()
+ except OAuth2Error as error:
+ error.redirect_uri = redirect_uri
+ error.redirect_fragment = True
+ raise error
+ return redirect_uri
+
+ @hooked
+ def create_authorization_response(self, redirect_uri, grant_user):
+ """If the resource owner grants the access request, the authorization
+ server issues an access token and delivers it to the client by adding
+ the following parameters to the fragment component of the redirection
+ URI using the "application/x-www-form-urlencoded" format.
+ Per `Section 4.2.2`_.
+
+ access_token
+ REQUIRED. The access token issued by the authorization server.
+
+ token_type
+ REQUIRED. The type of the token issued as described in
+ Section 7.1. Value is case insensitive.
+
+ expires_in
+ RECOMMENDED. The lifetime in seconds of the access token. For
+ example, the value "3600" denotes that the access token will
+ expire in one hour from the time the response was generated.
+ If omitted, the authorization server SHOULD provide the
+ expiration time via other means or document the default value.
+
+ scope
+ OPTIONAL, if identical to the scope requested by the client;
+ otherwise, REQUIRED. The scope of the access token as
+ described by Section 3.3.
+
+ state
+ REQUIRED if the "state" parameter was present in the client
+ authorization request. The exact value received from the
+ client.
+
+ The authorization server MUST NOT issue a refresh token.
+
+ For example, the authorization server redirects the user-agent by
+ sending the following HTTP response:
+
+ .. code-block:: http
+
+ HTTP/1.1 302 Found
+ Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
+ &state=xyz&token_type=example&expires_in=3600
+
+ Developers should note that some user-agents do not support the
+ inclusion of a fragment component in the HTTP "Location" response
+ header field. Such clients will require using other methods for
+ redirecting the client than a 3xx redirection response -- for
+ example, returning an HTML page that includes a 'continue' button
+ with an action linked to the redirection URI.
+
+ .. _`Section 4.2.2`: https://tools.ietf.org/html/rfc6749#section-4.2.2
+
+ :param redirect_uri: Redirect to the given URI for the authorization
+ :param grant_user: if resource owner granted the request, pass this
+ resource owner, otherwise pass None.
+ :returns: (status_code, body, headers)
+ """
+ state = self.request.payload.state
+ if grant_user:
+ self.request.user = grant_user
+ token = self.generate_token(
+ user=grant_user,
+ scope=self.request.payload.scope,
+ include_refresh_token=False,
+ )
+ log.debug("Grant token %r to %r", token, self.request.client)
+
+ self.save_token(token)
+ params = [(k, token[k]) for k in token]
+ if state:
+ params.append(("state", state))
+
+ uri = add_params_to_uri(redirect_uri, params, fragment=True)
+ headers = [("Location", uri)]
+ return 302, "", headers
+ else:
+ raise AccessDeniedError(redirect_uri=redirect_uri, redirect_fragment=True)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/refresh_token.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/refresh_token.py
new file mode 100644
index 00000000..d1e502db
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/refresh_token.py
@@ -0,0 +1,183 @@
+"""authlib.oauth2.rfc6749.grants.refresh_token.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A special grant endpoint for refresh_token grant_type. Refreshing an
+Access Token per `Section 6`_.
+
+.. _`Section 6`: https://tools.ietf.org/html/rfc6749#section-6
+"""
+
+import logging
+
+from ..errors import InvalidGrantError
+from ..errors import InvalidRequestError
+from ..errors import InvalidScopeError
+from ..errors import UnauthorizedClientError
+from ..hooks import hooked
+from ..util import scope_to_list
+from .base import BaseGrant
+from .base import TokenEndpointMixin
+
+log = logging.getLogger(__name__)
+
+
+class RefreshTokenGrant(BaseGrant, TokenEndpointMixin):
+ """A special grant endpoint for refresh_token grant_type. Refreshing an
+ Access Token per `Section 6`_.
+
+ .. _`Section 6`: https://tools.ietf.org/html/rfc6749#section-6
+ """
+
+ GRANT_TYPE = "refresh_token"
+
+ #: The authorization server MAY issue a new refresh token
+ INCLUDE_NEW_REFRESH_TOKEN = False
+
+ def _validate_request_client(self):
+ # require client authentication for confidential clients or for any
+ # client that was issued client credentials (or with other
+ # authentication requirements)
+ client = self.authenticate_token_endpoint_client()
+ log.debug("Validate token request of %r", client)
+
+ if not client.check_grant_type(self.GRANT_TYPE):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'grant_type={self.GRANT_TYPE}'"
+ )
+
+ return client
+
+ def _validate_request_token(self, client):
+ refresh_token = self.request.form.get("refresh_token")
+ if refresh_token is None:
+ raise InvalidRequestError("Missing 'refresh_token' in request.")
+
+ token = self.authenticate_refresh_token(refresh_token)
+ if not token or not token.check_client(client):
+ raise InvalidGrantError()
+ return token
+
+ def _validate_token_scope(self, token):
+ scope = self.request.payload.scope
+ if not scope:
+ return
+
+ original_scope = token.get_scope()
+ if not original_scope:
+ raise InvalidScopeError()
+
+ original_scope = set(scope_to_list(original_scope))
+ if not original_scope.issuperset(set(scope_to_list(scope))):
+ raise InvalidScopeError()
+
+ def validate_token_request(self):
+ """If the authorization server issued a refresh token to the client, the
+ client makes a refresh request to the token endpoint by adding the
+ following parameters using the "application/x-www-form-urlencoded"
+ format per Appendix B with a character encoding of UTF-8 in the HTTP
+ request entity-body, per Section 6:
+
+ grant_type
+ REQUIRED. Value MUST be set to "refresh_token".
+
+ refresh_token
+ REQUIRED. The refresh token issued to the client.
+
+ scope
+ OPTIONAL. The scope of the access request as described by
+ Section 3.3. The requested scope MUST NOT include any scope
+ not originally granted by the resource owner, and if omitted is
+ treated as equal to the scope originally granted by the
+ resource owner.
+
+
+ For example, the client makes the following HTTP request using
+ transport-layer security (with extra line breaks for display purposes
+ only):
+
+ .. code-block:: http
+
+ POST /token HTTP/1.1
+ Host: server.example.com
+ Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
+ Content-Type: application/x-www-form-urlencoded
+
+ grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKWIA
+ """
+ client = self._validate_request_client()
+ self.request.client = client
+ refresh_token = self._validate_request_token(client)
+ self._validate_token_scope(refresh_token)
+ self.request.refresh_token = refresh_token
+
+ @hooked
+ def create_token_response(self):
+ """If valid and authorized, the authorization server issues an access
+ token as described in Section 5.1. If the request failed
+ verification or is invalid, the authorization server returns an error
+ response as described in Section 5.2.
+ """
+ refresh_token = self.request.refresh_token
+ user = self.authenticate_user(refresh_token)
+ if not user:
+ raise InvalidRequestError("There is no 'user' for this token.")
+
+ client = self.request.client
+ token = self.issue_token(user, refresh_token)
+ log.debug("Issue token %r to %r", token, client)
+
+ self.request.user = user
+ self.save_token(token)
+ self.revoke_old_credential(refresh_token)
+ return 200, token, self.TOKEN_RESPONSE_HEADER
+
+ def issue_token(self, user, refresh_token):
+ scope = self.request.payload.scope
+ if not scope:
+ scope = refresh_token.get_scope()
+
+ token = self.generate_token(
+ user=user,
+ scope=scope,
+ include_refresh_token=self.INCLUDE_NEW_REFRESH_TOKEN,
+ )
+ return token
+
+ def authenticate_refresh_token(self, refresh_token):
+ """Get token information with refresh_token string. Developers MUST
+ implement this method in subclass::
+
+ def authenticate_refresh_token(self, refresh_token):
+ token = Token.get(refresh_token=refresh_token)
+ if token and not token.refresh_token_revoked:
+ return token
+
+ :param refresh_token: The refresh token issued to the client
+ :return: token
+ """
+ raise NotImplementedError()
+
+ def authenticate_user(self, refresh_token):
+ """Authenticate the user related to this credential. Developers MUST
+ implement this method in subclass::
+
+ def authenticate_user(self, credential):
+ return User.get(credential.user_id)
+
+ :param refresh_token: Token object
+ :return: user
+ """
+ raise NotImplementedError()
+
+ def revoke_old_credential(self, refresh_token):
+ """The authorization server MAY revoke the old refresh token after
+ issuing a new refresh token to the client. Developers MUST implement
+ this method in subclass::
+
+ def revoke_old_credential(self, refresh_token):
+ credential.revoked = True
+ credential.save()
+
+ :param refresh_token: Token object
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/resource_owner_password_credentials.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/resource_owner_password_credentials.py
new file mode 100644
index 00000000..ce1c487c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/grants/resource_owner_password_credentials.py
@@ -0,0 +1,155 @@
+import logging
+
+from ..errors import InvalidRequestError
+from ..errors import UnauthorizedClientError
+from ..hooks import hooked
+from .base import BaseGrant
+from .base import TokenEndpointMixin
+
+log = logging.getLogger(__name__)
+
+
+class ResourceOwnerPasswordCredentialsGrant(BaseGrant, TokenEndpointMixin):
+ """The resource owner password credentials grant type is suitable in
+ cases where the resource owner has a trust relationship with the
+ client, such as the device operating system or a highly privileged.
+
+ application. The authorization server should take special care when
+ enabling this grant type and only allow it when other flows are not
+ viable.
+
+ This grant type is suitable for clients capable of obtaining the
+ resource owner's credentials (username and password, typically using
+ an interactive form). It is also used to migrate existing clients
+ using direct authentication schemes such as HTTP Basic or Digest
+ authentication to OAuth by converting the stored credentials to an
+ access token::
+
+ +----------+
+ | Resource |
+ | Owner |
+ | |
+ +----------+
+ v
+ | Resource Owner
+ (A) Password Credentials
+ |
+ v
+ +---------+ +---------------+
+ | |>--(B)---- Resource Owner ------->| |
+ | | Password Credentials | Authorization |
+ | Client | | Server |
+ | |<--(C)---- Access Token ---------<| |
+ | | (w/ Optional Refresh Token) | |
+ +---------+ +---------------+
+ """
+
+ GRANT_TYPE = "password"
+
+ def validate_token_request(self):
+ """The client makes a request to the token endpoint by adding the
+ following parameters using the "application/x-www-form-urlencoded"
+ format per Appendix B with a character encoding of UTF-8 in the HTTP
+ request entity-body:
+
+ grant_type
+ REQUIRED. Value MUST be set to "password".
+
+ username
+ REQUIRED. The resource owner username.
+
+ password
+ REQUIRED. The resource owner password.
+
+ scope
+ OPTIONAL. The scope of the access request as described by
+ Section 3.3.
+
+ If the client type is confidential or the client was issued client
+ credentials (or assigned other authentication requirements), the
+ client MUST authenticate with the authorization server as described
+ in Section 3.2.1.
+
+ For example, the client makes the following HTTP request using
+ transport-layer security (with extra line breaks for display purposes
+ only):
+
+ .. code-block:: http
+
+ POST /token HTTP/1.1
+ Host: server.example.com
+ Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
+ Content-Type: application/x-www-form-urlencoded
+
+ grant_type=password&username=johndoe&password=A3ddj3w
+ """
+ # ignore validate for grant_type, since it is validated by
+ # check_token_endpoint
+ client = self.authenticate_token_endpoint_client()
+ log.debug("Validate token request of %r", client)
+
+ if not client.check_grant_type(self.GRANT_TYPE):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'grant_type={self.GRANT_TYPE}'"
+ )
+
+ params = self.request.form
+ if "username" not in params:
+ raise InvalidRequestError("Missing 'username' in request.")
+ if "password" not in params:
+ raise InvalidRequestError("Missing 'password' in request.")
+
+ log.debug("Authenticate user of %r", params["username"])
+ user = self.authenticate_user(params["username"], params["password"])
+ if not user:
+ raise InvalidRequestError(
+ "Invalid 'username' or 'password' in request.",
+ )
+ self.request.client = client
+ self.request.user = user
+ self.validate_requested_scope()
+
+ @hooked
+ def create_token_response(self):
+ """If the access token request is valid and authorized, the
+ authorization server issues an access token and optional refresh
+ token as described in Section 5.1. If the request failed client
+ authentication or is invalid, the authorization server returns an
+ error response as described in Section 5.2.
+
+ An example successful response:
+
+ .. code-block:: http
+
+ HTTP/1.1 200 OK
+ Content-Type: application/json
+ Cache-Control: no-store
+ Pragma: no-cache
+
+ {
+ "access_token":"2YotnFZFEjr1zCsicMWpAA",
+ "token_type":"example",
+ "expires_in":3600,
+ "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",
+ "example_parameter":"example_value"
+ }
+
+ :returns: (status_code, body, headers)
+ """
+ user = self.request.user
+ scope = self.request.payload.scope
+ token = self.generate_token(user=user, scope=scope)
+ log.debug("Issue token %r to %r", token, self.client)
+ self.save_token(token)
+ return 200, token, self.TOKEN_RESPONSE_HEADER
+
+ def authenticate_user(self, username, password):
+ """Validate the resource owner password credentials using its
+ existing password validation algorithm::
+
+ def authenticate_user(self, username, password):
+ user = get_user_by_username(username)
+ if user.check_password(password):
+ return user
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/hooks.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/hooks.py
new file mode 100644
index 00000000..376f0e18
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/hooks.py
@@ -0,0 +1,37 @@
+from collections import defaultdict
+
+
+class Hookable:
+ _hooks = None
+
+ def __init__(self):
+ self._hooks = defaultdict(set)
+
+ def register_hook(self, hook_type, hook):
+ self._hooks[hook_type].add(hook)
+
+ def execute_hook(self, hook_type, *args, **kwargs):
+ for hook in self._hooks[hook_type]:
+ hook(self, *args, **kwargs)
+
+
+def hooked(func=None, before=None, after=None):
+ """Execute hooks before and after the decorated method."""
+
+ def decorator(func):
+ before_name = before or f"before_{func.__name__}"
+ after_name = after or f"after_{func.__name__}"
+
+ def wrapper(self, *args, **kwargs):
+ self.execute_hook(before_name, *args, **kwargs)
+ result = func(self, *args, **kwargs)
+ self.execute_hook(after_name, result)
+ return result
+
+ return wrapper
+
+ # The decorator has been called without parenthesis
+ if callable(func):
+ return decorator(func)
+
+ return decorator
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/models.py
new file mode 100644
index 00000000..f3eaef66
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/models.py
@@ -0,0 +1,243 @@
+"""authlib.oauth2.rfc6749.models.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This module defines how to construct Client, AuthorizationCode and Token.
+"""
+
+
+class ClientMixin:
+ """Implementation of OAuth 2 Client described in `Section 2`_ with
+ some methods to help validation. A client has at least these information:
+
+ * client_id: A string represents client identifier.
+ * client_secret: A string represents client password.
+ * token_endpoint_auth_method: A way to authenticate client at token
+ endpoint.
+
+ .. _`Section 2`: https://tools.ietf.org/html/rfc6749#section-2
+ """
+
+ def get_client_id(self):
+ """A method to return client_id of the client. For instance, the value
+ in database is saved in a column called ``client_id``::
+
+ def get_client_id(self):
+ return self.client_id
+
+ :return: string
+ """
+ raise NotImplementedError()
+
+ def get_default_redirect_uri(self):
+ """A method to get client default redirect_uri. For instance, the
+ database table for client has a column called ``default_redirect_uri``::
+
+ def get_default_redirect_uri(self):
+ return self.default_redirect_uri
+
+ :return: A URL string
+ """
+ raise NotImplementedError()
+
+ def get_allowed_scope(self, scope):
+ """A method to return a list of requested scopes which are supported by
+ this client. For instance, there is a ``scope`` column::
+
+ def get_allowed_scope(self, scope):
+ if not scope:
+ return ""
+ allowed = set(scope_to_list(self.scope))
+ return list_to_scope([s for s in scope.split() if s in allowed])
+
+ :param scope: the requested scope.
+ :return: string of scope
+ """
+ raise NotImplementedError()
+
+ def check_redirect_uri(self, redirect_uri):
+ """Validate redirect_uri parameter in Authorization Endpoints. For
+ instance, in the client table, there is an ``allowed_redirect_uris``
+ column::
+
+ def check_redirect_uri(self, redirect_uri):
+ return redirect_uri in self.allowed_redirect_uris
+
+ :param redirect_uri: A URL string for redirecting.
+ :return: bool
+ """
+ raise NotImplementedError()
+
+ def check_client_secret(self, client_secret):
+ """Check client_secret matching with the client. For instance, in
+ the client table, the column is called ``client_secret``::
+
+ import secrets
+
+
+ def check_client_secret(self, client_secret):
+ return secrets.compare_digest(self.client_secret, client_secret)
+
+ :param client_secret: A string of client secret
+ :return: bool
+ """
+ raise NotImplementedError()
+
+ def check_endpoint_auth_method(self, method, endpoint):
+ """Check if client support the given method for the given endpoint.
+ There is a ``token_endpoint_auth_method`` defined via `RFC7591`_.
+ Developers MAY re-implement this method with::
+
+ def check_endpoint_auth_method(self, method, endpoint):
+ if endpoint == "token":
+ # if client table has ``token_endpoint_auth_method``
+ return self.token_endpoint_auth_method == method
+ return True
+
+ Method values defined by this specification are:
+
+ * "none": The client is a public client as defined in OAuth 2.0,
+ and does not have a client secret.
+
+ * "client_secret_post": The client uses the HTTP POST parameters
+ as defined in OAuth 2.0
+
+ * "client_secret_basic": The client uses HTTP Basic as defined in
+ OAuth 2.0
+
+ .. _`RFC7591`: https://tools.ietf.org/html/rfc7591
+ """
+ raise NotImplementedError()
+
+ def check_response_type(self, response_type):
+ """Validate if the client can handle the given response_type. There
+ are two response types defined by RFC6749: code and token. For
+ instance, there is a ``allowed_response_types`` column in your client::
+
+ def check_response_type(self, response_type):
+ return response_type in self.response_types
+
+ :param response_type: the requested response_type string.
+ :return: bool
+ """
+ raise NotImplementedError()
+
+ def check_grant_type(self, grant_type):
+ """Validate if the client can handle the given grant_type. There are
+ four grant types defined by RFC6749:
+
+ * authorization_code
+ * implicit
+ * client_credentials
+ * password
+
+ For instance, there is a ``allowed_grant_types`` column in your client::
+
+ def check_grant_type(self, grant_type):
+ return grant_type in self.grant_types
+
+ :param grant_type: the requested grant_type string.
+ :return: bool
+ """
+ raise NotImplementedError()
+
+
+class AuthorizationCodeMixin:
+ def get_redirect_uri(self):
+ """A method to get authorization code's ``redirect_uri``.
+ For instance, the database table for authorization code has a
+ column called ``redirect_uri``::
+
+ def get_redirect_uri(self):
+ return self.redirect_uri
+
+ :return: A URL string
+ """
+ raise NotImplementedError()
+
+ def get_scope(self):
+ """A method to get scope of the authorization code. For instance,
+ the column is called ``scope``::
+
+ def get_scope(self):
+ return self.scope
+
+ :return: scope string
+ """
+ raise NotImplementedError()
+
+
+class TokenMixin:
+ def check_client(self, client):
+ """A method to check if this token is issued to the given client.
+ For instance, ``client_id`` is saved on token table::
+
+ def check_client(self, client):
+ return self.client_id == client.client_id
+
+ :return: bool
+ """
+ raise NotImplementedError()
+
+ def get_scope(self):
+ """A method to get scope of the authorization code. For instance,
+ the column is called ``scope``::
+
+ def get_scope(self):
+ return self.scope
+
+ :return: scope string
+ """
+ raise NotImplementedError()
+
+ def get_expires_in(self):
+ """A method to get the ``expires_in`` value of the token. e.g.
+ the column is called ``expires_in``::
+
+ def get_expires_in(self):
+ return self.expires_in
+
+ :return: timestamp int
+ """
+ raise NotImplementedError()
+
+ def is_expired(self):
+ """A method to define if this token is expired. For instance,
+ there is a column ``expired_at`` in the table::
+
+ def is_expired(self):
+ return self.expired_at < now
+
+ :return: boolean
+ """
+ raise NotImplementedError()
+
+ def is_revoked(self):
+ """A method to define if this token is revoked. For instance,
+ there is a boolean column ``revoked`` in the table::
+
+ def is_revoked(self):
+ return self.revoked
+
+ :return: boolean
+ """
+ raise NotImplementedError()
+
+ def get_user(self):
+ """A method to get the user object associated with this token:
+
+ .. code-block::
+
+ def get_user(self):
+ return User.get(self.user_id)
+ """
+ raise NotImplementedError()
+
+ def get_client(self) -> ClientMixin:
+ """A method to get the client object associated with this token:
+
+ .. code-block::
+
+ def get_client(self):
+ return Client.get(self.client_id)
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/parameters.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/parameters.py
new file mode 100644
index 00000000..a575fe72
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/parameters.py
@@ -0,0 +1,214 @@
+from authlib.common.encoding import to_unicode
+from authlib.common.urls import add_params_to_qs
+from authlib.common.urls import add_params_to_uri
+from authlib.common.urls import urlparse
+
+from .errors import MismatchingStateException
+from .errors import MissingCodeException
+from .errors import MissingTokenException
+from .errors import MissingTokenTypeException
+from .util import list_to_scope
+
+
+def prepare_grant_uri(
+ uri, client_id, response_type, redirect_uri=None, scope=None, state=None, **kwargs
+):
+ """Prepare the authorization grant request URI.
+
+ The client constructs the request URI by adding the following
+ parameters to the query component of the authorization endpoint URI
+ using the ``application/x-www-form-urlencoded`` format:
+
+ :param uri: The authorize endpoint to fetch "code" or "token".
+ :param client_id: The client identifier as described in `Section 2.2`_.
+ :param response_type: To indicate which OAuth 2 grant/flow is required,
+ "code" and "token".
+ :param redirect_uri: The client provided URI to redirect back to after
+ authorization as described in `Section 3.1.2`_.
+ :param scope: The scope of the access request as described by
+ `Section 3.3`_.
+ :param state: An opaque value used by the client to maintain
+ state between the request and callback. The authorization
+ server includes this value when redirecting the user-agent
+ back to the client. The parameter SHOULD be used for
+ preventing cross-site request forgery as described in
+ `Section 10.12`_.
+ :param kwargs: Extra arguments to embed in the grant/authorization URL.
+
+ An example of an authorization code grant authorization URL::
+
+ /authorize?response_type=code&client_id=s6BhdRkqt3&state=xyz
+ &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
+
+ .. _`Section 2.2`: https://tools.ietf.org/html/rfc6749#section-2.2
+ .. _`Section 3.1.2`: https://tools.ietf.org/html/rfc6749#section-3.1.2
+ .. _`Section 3.3`: https://tools.ietf.org/html/rfc6749#section-3.3
+ .. _`section 10.12`: https://tools.ietf.org/html/rfc6749#section-10.12
+ """
+ params = [("response_type", response_type), ("client_id", client_id)]
+
+ if redirect_uri:
+ params.append(("redirect_uri", redirect_uri))
+ if scope:
+ params.append(("scope", list_to_scope(scope)))
+ if state:
+ params.append(("state", state))
+
+ for k, value in kwargs.items():
+ if value is not None:
+ if isinstance(value, (list, tuple)):
+ for v in value:
+ if v is not None:
+ params.append((to_unicode(k), v))
+ else:
+ params.append((to_unicode(k), value))
+
+ return add_params_to_uri(uri, params)
+
+
+def prepare_token_request(grant_type, body="", redirect_uri=None, **kwargs):
+ """Prepare the access token request. Per `Section 4.1.3`_.
+
+ The client makes a request to the token endpoint by adding the
+ following parameters using the ``application/x-www-form-urlencoded``
+ format in the HTTP request entity-body:
+
+ :param grant_type: To indicate grant type being used, i.e. "password",
+ "authorization_code" or "client_credentials".
+ :param body: Existing request body to embed parameters in.
+ :param redirect_uri: If the "redirect_uri" parameter was included in the
+ authorization request as described in
+ `Section 4.1.1`_, and their values MUST be identical.
+ :param kwargs: Extra arguments to embed in the request body.
+
+ An example of an authorization code token request body::
+
+ grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA
+ &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
+
+ .. _`Section 4.1.1`: https://tools.ietf.org/html/rfc6749#section-4.1.1
+ .. _`Section 4.1.3`: https://tools.ietf.org/html/rfc6749#section-4.1.3
+ """
+ params = [("grant_type", grant_type)]
+
+ if redirect_uri:
+ params.append(("redirect_uri", redirect_uri))
+
+ if "scope" in kwargs:
+ kwargs["scope"] = list_to_scope(kwargs["scope"])
+
+ if grant_type == "authorization_code" and kwargs.get("code") is None:
+ raise MissingCodeException()
+
+ for k in kwargs:
+ if kwargs[k]:
+ params.append((to_unicode(k), kwargs[k]))
+
+ return add_params_to_qs(body, params)
+
+
+def parse_authorization_code_response(uri, state=None):
+ """Parse authorization grant response URI into a dict.
+
+ If the resource owner grants the access request, the authorization
+ server issues an authorization code and delivers it to the client by
+ adding the following parameters to the query component of the
+ redirection URI using the ``application/x-www-form-urlencoded`` format:
+
+ **code**
+ REQUIRED. The authorization code generated by the
+ authorization server. The authorization code MUST expire
+ shortly after it is issued to mitigate the risk of leaks. A
+ maximum authorization code lifetime of 10 minutes is
+ RECOMMENDED. The client MUST NOT use the authorization code
+ more than once. If an authorization code is used more than
+ once, the authorization server MUST deny the request and SHOULD
+ revoke (when possible) all tokens previously issued based on
+ that authorization code. The authorization code is bound to
+ the client identifier and redirection URI.
+
+ **state**
+ REQUIRED if the "state" parameter was present in the client
+ authorization request. The exact value received from the
+ client.
+
+ :param uri: The full redirect URL back to the client.
+ :param state: The state parameter from the authorization request.
+
+ For example, the authorization server redirects the user-agent by
+ sending the following HTTP response:
+
+ .. code-block:: http
+
+ HTTP/1.1 302 Found
+ Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA
+ &state=xyz
+
+ """
+ query = urlparse.urlparse(uri).query
+ params = dict(urlparse.parse_qsl(query))
+
+ if "code" not in params:
+ raise MissingCodeException()
+
+ params_state = params.get("state")
+ if state and params_state != state:
+ raise MismatchingStateException()
+
+ return params
+
+
+def parse_implicit_response(uri, state=None):
+ """Parse the implicit token response URI into a dict.
+
+ If the resource owner grants the access request, the authorization
+ server issues an access token and delivers it to the client by adding
+ the following parameters to the fragment component of the redirection
+ URI using the ``application/x-www-form-urlencoded`` format:
+
+ **access_token**
+ REQUIRED. The access token issued by the authorization server.
+
+ **token_type**
+ REQUIRED. The type of the token issued as described in
+ Section 7.1. Value is case insensitive.
+
+ **expires_in**
+ RECOMMENDED. The lifetime in seconds of the access token. For
+ example, the value "3600" denotes that the access token will
+ expire in one hour from the time the response was generated.
+ If omitted, the authorization server SHOULD provide the
+ expiration time via other means or document the default value.
+
+ **scope**
+ OPTIONAL, if identical to the scope requested by the client,
+ otherwise REQUIRED. The scope of the access token as described
+ by Section 3.3.
+
+ **state**
+ REQUIRED if the "state" parameter was present in the client
+ authorization request. The exact value received from the
+ client.
+
+ Similar to the authorization code response, but with a full token provided
+ in the URL fragment:
+
+ .. code-block:: http
+
+ HTTP/1.1 302 Found
+ Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
+ &state=xyz&token_type=example&expires_in=3600
+ """
+ fragment = urlparse.urlparse(uri).fragment
+ params = dict(urlparse.parse_qsl(fragment, keep_blank_values=True))
+
+ if "access_token" not in params:
+ raise MissingTokenException()
+
+ if "token_type" not in params:
+ raise MissingTokenTypeException()
+
+ if state and params.get("state", None) != state:
+ raise MismatchingStateException()
+
+ return params
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/requests.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/requests.py
new file mode 100644
index 00000000..2caa4fdf
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/requests.py
@@ -0,0 +1,196 @@
+from collections import defaultdict
+
+from authlib.deprecate import deprecate
+
+from .errors import InsecureTransportError
+
+
+class OAuth2Payload:
+ @property
+ def data(self):
+ raise NotImplementedError()
+
+ @property
+ def datalist(self) -> defaultdict[str, list]:
+ raise NotImplementedError()
+
+ @property
+ def client_id(self) -> str:
+ """The authorization server issues the registered client a client
+ identifier -- a unique string representing the registration
+ information provided by the client. The value is extracted from
+ request.
+
+ :return: string
+ """
+ return self.data.get("client_id")
+
+ @property
+ def response_type(self) -> str:
+ rt = self.data.get("response_type")
+ if rt and " " in rt:
+ # sort multiple response types
+ return " ".join(sorted(rt.split()))
+ return rt
+
+ @property
+ def grant_type(self) -> str:
+ return self.data.get("grant_type")
+
+ @property
+ def redirect_uri(self):
+ return self.data.get("redirect_uri")
+
+ @property
+ def scope(self) -> str:
+ return self.data.get("scope")
+
+ @property
+ def state(self):
+ return self.data.get("state")
+
+
+class BasicOAuth2Payload(OAuth2Payload):
+ def __init__(self, payload):
+ self._data = payload
+ self._datalist = {key: [value] for key, value in payload.items()}
+
+ @property
+ def data(self):
+ return self._data
+
+ @property
+ def datalist(self) -> defaultdict[str, list]:
+ return self._datalist
+
+
+class OAuth2Request(OAuth2Payload):
+ def __init__(self, method: str, uri: str, body=None, headers=None):
+ InsecureTransportError.check(uri)
+ #: HTTP method
+ self.method = method
+ self.uri = uri
+ #: HTTP headers
+ self.headers = headers or {}
+
+ # Store body for backward compatibility but issue deprecation warning if used
+ if body is not None:
+ deprecate(
+ "'body' parameter in OAuth2Request is deprecated. "
+ "Use the payload system instead.",
+ version="1.8",
+ )
+ self._body = body
+
+ self.payload = None
+
+ self.client = None
+ self.auth_method = None
+ self.user = None
+ self.authorization_code = None
+ self.refresh_token = None
+ self.credential = None
+
+ @property
+ def args(self):
+ raise NotImplementedError()
+
+ @property
+ def form(self):
+ if self._body:
+ return self._body
+ raise NotImplementedError()
+
+ @property
+ def data(self):
+ deprecate(
+ "'request.data' is deprecated in favor of 'request.payload.data'",
+ version="1.8",
+ )
+ return self.payload.data
+
+ @property
+ def datalist(self) -> defaultdict[str, list]:
+ deprecate(
+ "'request.datalist' is deprecated in favor of 'request.payload.datalist'",
+ version="1.8",
+ )
+ return self.payload.datalist
+
+ @property
+ def client_id(self) -> str:
+ deprecate(
+ "'request.client_id' is deprecated in favor of 'request.payload.client_id'",
+ version="1.8",
+ )
+ return self.payload.client_id
+
+ @property
+ def response_type(self) -> str:
+ deprecate(
+ "'request.response_type' is deprecated in favor of 'request.payload.response_type'",
+ version="1.8",
+ )
+ return self.payload.response_type
+
+ @property
+ def grant_type(self) -> str:
+ deprecate(
+ "'request.grant_type' is deprecated in favor of 'request.payload.grant_type'",
+ version="1.8",
+ )
+ return self.payload.grant_type
+
+ @property
+ def redirect_uri(self):
+ deprecate(
+ "'request.redirect_uri' is deprecated in favor of 'request.payload.redirect_uri'",
+ version="1.8",
+ )
+ return self.payload.redirect_uri
+
+ @property
+ def scope(self) -> str:
+ deprecate(
+ "'request.scope' is deprecated in favor of 'request.payload.scope'",
+ version="1.8",
+ )
+ return self.payload.scope
+
+ @property
+ def state(self):
+ deprecate(
+ "'request.state' is deprecated in favor of 'request.payload.state'",
+ version="1.8",
+ )
+ return self.payload.state
+
+ @property
+ def body(self):
+ deprecate(
+ "'request.body' is deprecated. Use the payload system instead.",
+ version="1.8",
+ )
+ return self._body
+
+
+class JsonPayload:
+ @property
+ def data(self):
+ raise NotImplementedError()
+
+
+class JsonRequest:
+ def __init__(self, method, uri, headers=None):
+ self.method = method
+ self.uri = uri
+ self.headers = headers or {}
+ self.payload = None
+
+ @property
+ def data(self):
+ deprecate(
+ "'request.data' is deprecated in favor of 'request.payload.data'",
+ version="1.8",
+ )
+ return self.payload.data
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/resource_protector.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/resource_protector.py
new file mode 100644
index 00000000..11436205
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/resource_protector.py
@@ -0,0 +1,148 @@
+"""authlib.oauth2.rfc6749.resource_protector.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Implementation of Accessing Protected Resources per `Section 7`_.
+
+.. _`Section 7`: https://tools.ietf.org/html/rfc6749#section-7
+"""
+
+from .errors import MissingAuthorizationError
+from .errors import UnsupportedTokenTypeError
+from .util import scope_to_list
+
+
+class TokenValidator:
+ """Base token validator class. Subclass this validator to register
+ into ResourceProtector instance.
+ """
+
+ TOKEN_TYPE = "bearer"
+
+ def __init__(self, realm=None, **extra_attributes):
+ self.realm = realm
+ self.extra_attributes = extra_attributes
+
+ @staticmethod
+ def scope_insufficient(token_scopes, required_scopes):
+ if not required_scopes:
+ return False
+
+ token_scopes = scope_to_list(token_scopes)
+ if not token_scopes:
+ return True
+
+ token_scopes = set(token_scopes)
+ for scope in required_scopes:
+ resource_scopes = set(scope_to_list(scope))
+ if token_scopes.issuperset(resource_scopes):
+ return False
+
+ return True
+
+ def authenticate_token(self, token_string):
+ """A method to query token from database with the given token string.
+ Developers MUST re-implement this method. For instance::
+
+ def authenticate_token(self, token_string):
+ return get_token_from_database(token_string)
+
+ :param token_string: A string to represent the access_token.
+ :return: token
+ """
+ raise NotImplementedError()
+
+ def validate_request(self, request):
+ """A method to validate if the HTTP request is valid or not. Developers MUST
+ re-implement this method. For instance, your server requires a
+ "X-Device-Version" in the header::
+
+ def validate_request(self, request):
+ if "X-Device-Version" not in request.headers:
+ raise InvalidRequestError()
+
+ Usually, you don't have to detect if the request is valid or not. If you have
+ to, you MUST re-implement this method.
+
+ :param request: instance of HttpRequest
+ :raise: InvalidRequestError
+ """
+
+ def validate_token(self, token, scopes, request):
+ """A method to validate if the authorized token is valid, if it has the
+ permission on the given scopes. Developers MUST re-implement this method.
+ e.g, check if token is expired, revoked::
+
+ def validate_token(self, token, scopes, request):
+ if not token:
+ raise InvalidTokenError()
+ if token.is_expired() or token.is_revoked():
+ raise InvalidTokenError()
+ if not match_token_scopes(token, scopes):
+ raise InsufficientScopeError()
+ """
+ raise NotImplementedError()
+
+
+class ResourceProtector:
+ def __init__(self):
+ self._token_validators = {}
+ self._default_realm = None
+ self._default_auth_type = None
+
+ def register_token_validator(self, validator: TokenValidator):
+ """Register a token validator for a given Authorization type.
+ Authlib has a built-in BearerTokenValidator per rfc6750.
+ """
+ if not self._default_auth_type:
+ self._default_realm = validator.realm
+ self._default_auth_type = validator.TOKEN_TYPE
+
+ if validator.TOKEN_TYPE not in self._token_validators:
+ self._token_validators[validator.TOKEN_TYPE] = validator
+
+ def get_token_validator(self, token_type):
+ """Get token validator from registry for the given token type."""
+ validator = self._token_validators.get(token_type.lower())
+ if not validator:
+ raise UnsupportedTokenTypeError(
+ self._default_auth_type, self._default_realm
+ )
+ return validator
+
+ def parse_request_authorization(self, request):
+ """Parse the token and token validator from request Authorization header.
+ Here is an example of Authorization header::
+
+ Authorization: Bearer a-token-string
+
+ This method will parse this header, if it can find the validator for
+ ``Bearer``, it will return the validator and ``a-token-string``.
+
+ :return: validator, token_string
+ :raise: MissingAuthorizationError
+ :raise: UnsupportedTokenTypeError
+ """
+ auth = request.headers.get("Authorization")
+ if not auth:
+ raise MissingAuthorizationError(
+ self._default_auth_type, self._default_realm
+ )
+
+ # https://tools.ietf.org/html/rfc6749#section-7.1
+ token_parts = auth.split(None, 1)
+ if len(token_parts) != 2:
+ raise UnsupportedTokenTypeError(
+ self._default_auth_type, self._default_realm
+ )
+
+ token_type, token_string = token_parts
+ validator = self.get_token_validator(token_type)
+ return validator, token_string
+
+ def validate_request(self, scopes, request, **kwargs):
+ """Validate the request and return a token."""
+ validator, token_string = self.parse_request_authorization(request)
+ validator.validate_request(request)
+ token = validator.authenticate_token(token_string)
+ validator.validate_token(token, scopes, request, **kwargs)
+ return token
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/token_endpoint.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/token_endpoint.py
new file mode 100644
index 00000000..4d013f97
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/token_endpoint.py
@@ -0,0 +1,32 @@
+class TokenEndpoint:
+ #: Endpoint name to be registered
+ ENDPOINT_NAME = None
+ #: Supported token types
+ SUPPORTED_TOKEN_TYPES = ("access_token", "refresh_token")
+ #: Allowed client authenticate methods
+ CLIENT_AUTH_METHODS = ["client_secret_basic"]
+
+ def __init__(self, server):
+ self.server = server
+
+ def __call__(self, request):
+ # make it callable for authorization server
+ # ``create_endpoint_response``
+ return self.create_endpoint_response(request)
+
+ def create_endpoint_request(self, request):
+ return self.server.create_oauth2_request(request)
+
+ def authenticate_endpoint_client(self, request):
+ """Authentication client for endpoint with ``CLIENT_AUTH_METHODS``."""
+ client = self.server.authenticate_client(
+ request, self.CLIENT_AUTH_METHODS, self.ENDPOINT_NAME
+ )
+ request.client = client
+ return client
+
+ def authenticate_token(self, request, client):
+ raise NotImplementedError()
+
+ def create_endpoint_response(self, request):
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/util.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/util.py
new file mode 100644
index 00000000..93199245
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/util.py
@@ -0,0 +1,42 @@
+import base64
+import binascii
+from urllib.parse import unquote
+
+from authlib.common.encoding import to_unicode
+
+
+def list_to_scope(scope):
+ """Convert a list of scopes to a space separated string."""
+ if isinstance(scope, (set, tuple, list)):
+ return " ".join([to_unicode(s) for s in scope])
+ if scope is None:
+ return scope
+ return to_unicode(scope)
+
+
+def scope_to_list(scope):
+ """Convert a space separated string to a list of scopes."""
+ if isinstance(scope, (tuple, list, set)):
+ return [to_unicode(s) for s in scope]
+ elif scope is None:
+ return None
+ return scope.strip().split()
+
+
+def extract_basic_authorization(headers):
+ auth = headers.get("Authorization")
+ if not auth or " " not in auth:
+ return None, None
+
+ auth_type, auth_token = auth.split(None, 1)
+ if auth_type.lower() != "basic":
+ return None, None
+
+ try:
+ query = to_unicode(base64.b64decode(auth_token))
+ except (binascii.Error, TypeError):
+ return None, None
+ if ":" in query:
+ username, password = query.split(":", 1)
+ return unquote(username), unquote(password)
+ return query, None
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/wrappers.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/wrappers.py
new file mode 100644
index 00000000..810a5c8c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6749/wrappers.py
@@ -0,0 +1,24 @@
+import time
+
+
+class OAuth2Token(dict):
+ def __init__(self, params):
+ if params.get("expires_at"):
+ params["expires_at"] = int(params["expires_at"])
+ elif params.get("expires_in"):
+ params["expires_at"] = int(time.time()) + int(params["expires_in"])
+ super().__init__(params)
+
+ def is_expired(self, leeway=60):
+ expires_at = self.get("expires_at")
+ if not expires_at:
+ return None
+ # small timedelta to consider token as expired before it actually expires
+ expiration_threshold = expires_at - leeway
+ return expiration_threshold < time.time()
+
+ @classmethod
+ def from_dict(cls, token):
+ if isinstance(token, dict) and not isinstance(token, cls):
+ token = cls(token)
+ return token
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__init__.py
new file mode 100644
index 00000000..f7878b59
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__init__.py
@@ -0,0 +1,27 @@
+"""authlib.oauth2.rfc6750.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+The OAuth 2.0 Authorization Framework: Bearer Token Usage.
+
+https://tools.ietf.org/html/rfc6750
+"""
+
+from .errors import InsufficientScopeError
+from .errors import InvalidTokenError
+from .parameters import add_bearer_token
+from .token import BearerTokenGenerator
+from .validator import BearerTokenValidator
+
+# TODO: add deprecation
+BearerToken = BearerTokenGenerator
+
+
+__all__ = [
+ "InvalidTokenError",
+ "InsufficientScopeError",
+ "add_bearer_token",
+ "BearerToken",
+ "BearerTokenGenerator",
+ "BearerTokenValidator",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..70cef161
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..d3e95374
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/parameters.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/parameters.cpython-312.pyc
new file mode 100644
index 00000000..c925c3c3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/parameters.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/token.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/token.cpython-312.pyc
new file mode 100644
index 00000000..2292e714
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/token.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/validator.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/validator.cpython-312.pyc
new file mode 100644
index 00000000..a551b8a2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/__pycache__/validator.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/errors.py
new file mode 100644
index 00000000..80d51dba
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/errors.py
@@ -0,0 +1,88 @@
+"""authlib.rfc6750.errors.
+~~~~~~~~~~~~~~~~~~~~~~
+
+OAuth Extensions Error Registration. When a request fails,
+the resource server responds using the appropriate HTTP
+status code and includes one of the following error codes
+in the response.
+
+https://tools.ietf.org/html/rfc6750#section-6.2
+
+:copyright: (c) 2017 by Hsiaoming Yang.
+"""
+
+from ..base import OAuth2Error
+
+__all__ = ["InvalidTokenError", "InsufficientScopeError"]
+
+
+class InvalidTokenError(OAuth2Error):
+ """The access token provided is expired, revoked, malformed, or
+ invalid for other reasons. The resource SHOULD respond with
+ the HTTP 401 (Unauthorized) status code. The client MAY
+ request a new access token and retry the protected resource
+ request.
+
+ https://tools.ietf.org/html/rfc6750#section-3.1
+ """
+
+ error = "invalid_token"
+ description = (
+ "The access token provided is expired, revoked, malformed, "
+ "or invalid for other reasons."
+ )
+ status_code = 401
+
+ def __init__(
+ self,
+ description=None,
+ uri=None,
+ status_code=None,
+ state=None,
+ realm=None,
+ **extra_attributes,
+ ):
+ super().__init__(description, uri, status_code, state)
+ self.realm = realm
+ self.extra_attributes = extra_attributes
+
+ def get_headers(self):
+ """If the protected resource request does not include authentication
+ credentials or does not contain an access token that enables access
+ to the protected resource, the resource server MUST include the HTTP
+ "WWW-Authenticate" response header field; it MAY include it in
+ response to other conditions as well.
+
+ https://tools.ietf.org/html/rfc6750#section-3
+ """
+ headers = super().get_headers()
+
+ extras = []
+ if self.realm:
+ extras.append(f'realm="{self.realm}"')
+ if self.extra_attributes:
+ extras.extend(
+ [f'{k}="{self.extra_attributes[k]}"' for k in self.extra_attributes]
+ )
+ extras.append(f'error="{self.error}"')
+ error_description = self.get_error_description()
+ extras.append(f'error_description="{error_description}"')
+ headers.append(("WWW-Authenticate", "Bearer " + ", ".join(extras)))
+ return headers
+
+
+class InsufficientScopeError(OAuth2Error):
+ """The request requires higher privileges than provided by the
+ access token. The resource server SHOULD respond with the HTTP
+ 403 (Forbidden) status code and MAY include the "scope"
+ attribute with the scope necessary to access the protected
+ resource.
+
+ https://tools.ietf.org/html/rfc6750#section-3.1
+ """
+
+ error = "insufficient_scope"
+ description = (
+ "The request requires higher privileges than provided by the access token."
+ )
+ status_code = 403
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/parameters.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/parameters.py
new file mode 100644
index 00000000..6bb94f92
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/parameters.py
@@ -0,0 +1,42 @@
+from authlib.common.urls import add_params_to_qs
+from authlib.common.urls import add_params_to_uri
+
+
+def add_to_uri(token, uri):
+ """Add a Bearer Token to the request URI.
+ Not recommended, use only if client can't use authorization header or body.
+
+ http://www.example.com/path?access_token=h480djs93hd8
+ """
+ return add_params_to_uri(uri, [("access_token", token)])
+
+
+def add_to_headers(token, headers=None):
+ """Add a Bearer Token to the request URI.
+ Recommended method of passing bearer tokens.
+
+ Authorization: Bearer h480djs93hd8
+ """
+ headers = headers or {}
+ headers["Authorization"] = f"Bearer {token}"
+ return headers
+
+
+def add_to_body(token, body=None):
+ """Add a Bearer Token to the request body.
+
+ access_token=h480djs93hd8
+ """
+ if body is None:
+ body = ""
+ return add_params_to_qs(body, [("access_token", token)])
+
+
+def add_bearer_token(token, uri, headers, body, placement="header"):
+ if placement in ("uri", "url", "query"):
+ uri = add_to_uri(token, uri)
+ elif placement in ("header", "headers"):
+ headers = add_to_headers(token, headers)
+ elif placement == "body":
+ body = add_to_body(token, body)
+ return uri, headers, body
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/token.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/token.py
new file mode 100644
index 00000000..f1518f41
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/token.py
@@ -0,0 +1,110 @@
+class BearerTokenGenerator:
+ """Bearer token generator which can create the payload for token response
+ by OAuth 2 server. A typical token response would be:
+
+ .. code-block:: http
+
+ HTTP/1.1 200 OK
+ Content-Type: application/json;charset=UTF-8
+ Cache-Control: no-store
+ Pragma: no-cache
+
+ {
+ "access_token":"mF_9.B5f-4.1JqM",
+ "token_type":"Bearer",
+ "expires_in":3600,
+ "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA"
+ }
+ """
+
+ #: default expires_in value
+ DEFAULT_EXPIRES_IN = 3600
+ #: default expires_in value differentiate by grant_type
+ GRANT_TYPES_EXPIRES_IN = {
+ "authorization_code": 864000,
+ "implicit": 3600,
+ "password": 864000,
+ "client_credentials": 864000,
+ }
+
+ def __init__(
+ self,
+ access_token_generator,
+ refresh_token_generator=None,
+ expires_generator=None,
+ ):
+ self.access_token_generator = access_token_generator
+ self.refresh_token_generator = refresh_token_generator
+ self.expires_generator = expires_generator
+
+ def _get_expires_in(self, client, grant_type):
+ if self.expires_generator is None:
+ expires_in = self.GRANT_TYPES_EXPIRES_IN.get(
+ grant_type, self.DEFAULT_EXPIRES_IN
+ )
+ elif callable(self.expires_generator):
+ expires_in = self.expires_generator(client, grant_type)
+ elif isinstance(self.expires_generator, int):
+ expires_in = self.expires_generator
+ else:
+ expires_in = self.DEFAULT_EXPIRES_IN
+ return expires_in
+
+ @staticmethod
+ def get_allowed_scope(client, scope):
+ if scope:
+ scope = client.get_allowed_scope(scope)
+ return scope
+
+ def generate(
+ self,
+ grant_type,
+ client,
+ user=None,
+ scope=None,
+ expires_in=None,
+ include_refresh_token=True,
+ ):
+ """Generate a bearer token for OAuth 2.0 authorization token endpoint.
+
+ :param client: the client that making the request.
+ :param grant_type: current requested grant_type.
+ :param user: current authorized user.
+ :param expires_in: if provided, use this value as expires_in.
+ :param scope: current requested scope.
+ :param include_refresh_token: should refresh_token be included.
+ :return: Token dict
+ """
+ scope = self.get_allowed_scope(client, scope)
+ access_token = self.access_token_generator(
+ client=client, grant_type=grant_type, user=user, scope=scope
+ )
+ if expires_in is None:
+ expires_in = self._get_expires_in(client, grant_type)
+
+ token = {
+ "token_type": "Bearer",
+ "access_token": access_token,
+ }
+ if expires_in:
+ token["expires_in"] = expires_in
+ if include_refresh_token and self.refresh_token_generator:
+ token["refresh_token"] = self.refresh_token_generator(
+ client=client, grant_type=grant_type, user=user, scope=scope
+ )
+ if scope:
+ token["scope"] = scope
+ return token
+
+ def __call__(
+ self,
+ grant_type,
+ client,
+ user=None,
+ scope=None,
+ expires_in=None,
+ include_refresh_token=True,
+ ):
+ return self.generate(
+ grant_type, client, user, scope, expires_in, include_refresh_token
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/validator.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/validator.py
new file mode 100644
index 00000000..a9716ec5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc6750/validator.py
@@ -0,0 +1,42 @@
+"""authlib.oauth2.rfc6750.validator.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Validate Bearer Token for in request, scope and token.
+"""
+
+from ..rfc6749 import TokenValidator
+from .errors import InsufficientScopeError
+from .errors import InvalidTokenError
+
+
+class BearerTokenValidator(TokenValidator):
+ TOKEN_TYPE = "bearer"
+
+ def authenticate_token(self, token_string):
+ """A method to query token from database with the given token string.
+ Developers MUST re-implement this method. For instance::
+
+ def authenticate_token(self, token_string):
+ return get_token_from_database(token_string)
+
+ :param token_string: A string to represent the access_token.
+ :return: token
+ """
+ raise NotImplementedError()
+
+ def validate_token(self, token, scopes, request):
+ """Check if token is active and matches the requested scopes."""
+ if not token:
+ raise InvalidTokenError(
+ realm=self.realm, extra_attributes=self.extra_attributes
+ )
+ if token.is_expired():
+ raise InvalidTokenError(
+ realm=self.realm, extra_attributes=self.extra_attributes
+ )
+ if token.is_revoked():
+ raise InvalidTokenError(
+ realm=self.realm, extra_attributes=self.extra_attributes
+ )
+ if self.scope_insufficient(token.get_scope(), scopes):
+ raise InsufficientScopeError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__init__.py
new file mode 100644
index 00000000..c355a19c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__init__.py
@@ -0,0 +1,13 @@
+"""authlib.oauth2.rfc7009.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+OAuth 2.0 Token Revocation.
+
+https://tools.ietf.org/html/rfc7009
+"""
+
+from .parameters import prepare_revoke_token_request
+from .revocation import RevocationEndpoint
+
+__all__ = ["prepare_revoke_token_request", "RevocationEndpoint"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..68eae198
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/parameters.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/parameters.cpython-312.pyc
new file mode 100644
index 00000000..d4f6aa0b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/parameters.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/revocation.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/revocation.cpython-312.pyc
new file mode 100644
index 00000000..cbf2fdbc
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/__pycache__/revocation.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/parameters.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/parameters.py
new file mode 100644
index 00000000..dbbe2db7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/parameters.py
@@ -0,0 +1,24 @@
+from authlib.common.urls import add_params_to_qs
+
+
+def prepare_revoke_token_request(token, token_type_hint=None, body=None, headers=None):
+ """Construct request body and headers for revocation endpoint.
+
+ :param token: access_token or refresh_token string.
+ :param token_type_hint: Optional, `access_token` or `refresh_token`.
+ :param body: current request body.
+ :param headers: current request headers.
+ :return: tuple of (body, headers)
+
+ https://tools.ietf.org/html/rfc7009#section-2.1
+ """
+ params = [("token", token)]
+ if token_type_hint:
+ params.append(("token_type_hint", token_type_hint))
+
+ body = add_params_to_qs(body or "", params)
+ if headers is None:
+ headers = {}
+
+ headers["Content-Type"] = "application/x-www-form-urlencoded"
+ return body, headers
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/revocation.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/revocation.py
new file mode 100644
index 00000000..0dd85d08
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7009/revocation.py
@@ -0,0 +1,112 @@
+from authlib.consts import default_json_headers
+
+from ..rfc6749 import InvalidGrantError
+from ..rfc6749 import InvalidRequestError
+from ..rfc6749 import TokenEndpoint
+from ..rfc6749 import UnsupportedTokenTypeError
+
+
+class RevocationEndpoint(TokenEndpoint):
+ """Implementation of revocation endpoint which is described in
+ `RFC7009`_.
+
+ .. _RFC7009: https://tools.ietf.org/html/rfc7009
+ """
+
+ #: Endpoint name to be registered
+ ENDPOINT_NAME = "revocation"
+
+ def authenticate_token(self, request, client):
+ """The client constructs the request by including the following
+ parameters using the "application/x-www-form-urlencoded" format in
+ the HTTP request entity-body:
+
+ token
+ REQUIRED. The token that the client wants to get revoked.
+
+ token_type_hint
+ OPTIONAL. A hint about the type of the token submitted for
+ revocation.
+ """
+ self.check_params(request, client)
+ token = self.query_token(
+ request.form["token"], request.form.get("token_type_hint")
+ )
+ if token and not token.check_client(client):
+ raise InvalidGrantError()
+ return token
+
+ def check_params(self, request, client):
+ if "token" not in request.form:
+ raise InvalidRequestError()
+
+ hint = request.form.get("token_type_hint")
+ if hint and hint not in self.SUPPORTED_TOKEN_TYPES:
+ raise UnsupportedTokenTypeError()
+
+ def create_endpoint_response(self, request):
+ """Validate revocation request and create the response for revocation.
+ For example, a client may request the revocation of a refresh token
+ with the following request::
+
+ POST /revoke HTTP/1.1
+ Host: server.example.com
+ Content-Type: application/x-www-form-urlencoded
+ Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
+
+ token=45ghiukldjahdnhzdauz&token_type_hint=refresh_token
+
+ :returns: (status_code, body, headers)
+ """
+ # The authorization server first validates the client credentials
+ client = self.authenticate_endpoint_client(request)
+
+ # then verifies whether the token was issued to the client making
+ # the revocation request
+ token = self.authenticate_token(request, client)
+
+ # the authorization server invalidates the token
+ if token:
+ self.revoke_token(token, request)
+ self.server.send_signal(
+ "after_revoke_token",
+ token=token,
+ client=client,
+ )
+ return 200, {}, default_json_headers
+
+ def query_token(self, token_string, token_type_hint):
+ """Get the token from database/storage by the given token string.
+ Developers should implement this method::
+
+ def query_token(self, token_string, token_type_hint):
+ if token_type_hint == 'access_token':
+ return Token.query_by_access_token(token_string)
+ if token_type_hint == 'refresh_token':
+ return Token.query_by_refresh_token(token_string)
+ return Token.query_by_access_token(token_string) or \
+ Token.query_by_refresh_token(token_string)
+ """
+ raise NotImplementedError()
+
+ def revoke_token(self, token, request):
+ """Mark token as revoked. Since token MUST be unique, it would be
+ dangerous to delete it. Consider this situation:
+
+ 1. Jane obtained a token XYZ
+ 2. Jane revoked (deleted) token XYZ
+ 3. Bob generated a new token XYZ
+ 4. Jane can use XYZ to access Bob's resource
+
+ It would be secure to mark a token as revoked::
+
+ def revoke_token(self, token, request):
+ hint = request.form.get("token_type_hint")
+ if hint == "access_token":
+ token.access_token_revoked = True
+ else:
+ token.access_token_revoked = True
+ token.refresh_token_revoked = True
+ token.save()
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__init__.py
new file mode 100644
index 00000000..86e57652
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__init__.py
@@ -0,0 +1,3 @@
+from .client import AssertionClient
+
+__all__ = ["AssertionClient"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..cd103080
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__pycache__/client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__pycache__/client.cpython-312.pyc
new file mode 100644
index 00000000..97bf213b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/__pycache__/client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/client.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/client.py
new file mode 100644
index 00000000..decbd130
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7521/client.py
@@ -0,0 +1,107 @@
+from authlib.common.encoding import to_native
+from authlib.oauth2.base import OAuth2Error
+
+
+class AssertionClient:
+ """Constructs a new Assertion Framework for OAuth 2.0 Authorization Grants
+ per RFC7521_.
+
+ .. _RFC7521: https://tools.ietf.org/html/rfc7521
+ """
+
+ DEFAULT_GRANT_TYPE = None
+ ASSERTION_METHODS = {}
+ token_auth_class = None
+ oauth_error_class = OAuth2Error
+
+ def __init__(
+ self,
+ session,
+ token_endpoint,
+ issuer,
+ subject,
+ audience=None,
+ grant_type=None,
+ claims=None,
+ token_placement="header",
+ scope=None,
+ leeway=60,
+ **kwargs,
+ ):
+ self.session = session
+
+ if audience is None:
+ audience = token_endpoint
+
+ self.token_endpoint = token_endpoint
+
+ if grant_type is None:
+ grant_type = self.DEFAULT_GRANT_TYPE
+
+ self.grant_type = grant_type
+
+ # https://tools.ietf.org/html/rfc7521#section-5.1
+ self.issuer = issuer
+ self.subject = subject
+ self.audience = audience
+ self.claims = claims
+ self.scope = scope
+ if self.token_auth_class is not None:
+ self.token_auth = self.token_auth_class(None, token_placement, self)
+ self._kwargs = kwargs
+ self.leeway = leeway
+
+ @property
+ def token(self):
+ return self.token_auth.token
+
+ @token.setter
+ def token(self, token):
+ self.token_auth.set_token(token)
+
+ def refresh_token(self):
+ """Using Assertions as Authorization Grants to refresh token as
+ described in `Section 4.1`_.
+
+ .. _`Section 4.1`: https://tools.ietf.org/html/rfc7521#section-4.1
+ """
+ generate_assertion = self.ASSERTION_METHODS[self.grant_type]
+ assertion = generate_assertion(
+ issuer=self.issuer,
+ subject=self.subject,
+ audience=self.audience,
+ claims=self.claims,
+ **self._kwargs,
+ )
+ data = {
+ "assertion": to_native(assertion),
+ "grant_type": self.grant_type,
+ }
+ if self.scope:
+ data["scope"] = self.scope
+
+ return self._refresh_token(data)
+
+ def parse_response_token(self, resp):
+ if resp.status_code >= 500:
+ resp.raise_for_status()
+
+ token = resp.json()
+ if "error" in token:
+ raise self.oauth_error_class(
+ error=token["error"], description=token.get("error_description")
+ )
+
+ self.token = token
+ return self.token
+
+ def _refresh_token(self, data):
+ resp = self.session.request(
+ "POST", self.token_endpoint, data=data, withhold_token=True
+ )
+
+ return self.parse_response_token(resp)
+
+ def __del__(self):
+ if self.session:
+ del self.session
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__init__.py
new file mode 100644
index 00000000..29dfd1c3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__init__.py
@@ -0,0 +1,31 @@
+"""authlib.oauth2.rfc7523.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+JSON Web Token (JWT) Profile for OAuth 2.0 Client
+Authentication and Authorization Grants.
+
+https://tools.ietf.org/html/rfc7523
+"""
+
+from .assertion import client_secret_jwt_sign
+from .assertion import private_key_jwt_sign
+from .auth import ClientSecretJWT
+from .auth import PrivateKeyJWT
+from .client import JWTBearerClientAssertion
+from .jwt_bearer import JWTBearerGrant
+from .token import JWTBearerTokenGenerator
+from .validator import JWTBearerToken
+from .validator import JWTBearerTokenValidator
+
+__all__ = [
+ "JWTBearerGrant",
+ "JWTBearerClientAssertion",
+ "client_secret_jwt_sign",
+ "private_key_jwt_sign",
+ "ClientSecretJWT",
+ "PrivateKeyJWT",
+ "JWTBearerToken",
+ "JWTBearerTokenGenerator",
+ "JWTBearerTokenValidator",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..491b368e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/assertion.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/assertion.cpython-312.pyc
new file mode 100644
index 00000000..64481ae7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/assertion.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/auth.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/auth.cpython-312.pyc
new file mode 100644
index 00000000..943a31c1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/auth.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/client.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/client.cpython-312.pyc
new file mode 100644
index 00000000..e4a712d0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/client.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/jwt_bearer.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/jwt_bearer.cpython-312.pyc
new file mode 100644
index 00000000..af67cf0c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/jwt_bearer.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/token.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/token.cpython-312.pyc
new file mode 100644
index 00000000..c92e6abc
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/token.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/validator.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/validator.cpython-312.pyc
new file mode 100644
index 00000000..409b4cbe
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/__pycache__/validator.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/assertion.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/assertion.py
new file mode 100644
index 00000000..3978f57f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/assertion.py
@@ -0,0 +1,82 @@
+import time
+
+from authlib.common.security import generate_token
+from authlib.jose import jwt
+
+
+def sign_jwt_bearer_assertion(
+ key,
+ issuer,
+ audience,
+ subject=None,
+ issued_at=None,
+ expires_at=None,
+ claims=None,
+ header=None,
+ **kwargs,
+):
+ if header is None:
+ header = {}
+ alg = kwargs.pop("alg", None)
+ if alg:
+ header["alg"] = alg
+ if "alg" not in header:
+ raise ValueError("Missing 'alg' in header")
+
+ payload = {"iss": issuer, "aud": audience}
+
+ # subject is not required in Google service
+ if subject:
+ payload["sub"] = subject
+
+ if not issued_at:
+ issued_at = int(time.time())
+
+ expires_in = kwargs.pop("expires_in", 3600)
+ if not expires_at:
+ expires_at = issued_at + expires_in
+
+ payload["iat"] = issued_at
+ payload["exp"] = expires_at
+
+ if claims:
+ payload.update(claims)
+
+ return jwt.encode(header, payload, key)
+
+
+def client_secret_jwt_sign(
+ client_secret, client_id, token_endpoint, alg="HS256", claims=None, **kwargs
+):
+ return _sign(client_secret, client_id, token_endpoint, alg, claims, **kwargs)
+
+
+def private_key_jwt_sign(
+ private_key, client_id, token_endpoint, alg="RS256", claims=None, **kwargs
+):
+ return _sign(private_key, client_id, token_endpoint, alg, claims, **kwargs)
+
+
+def _sign(key, client_id, token_endpoint, alg, claims=None, **kwargs):
+ # REQUIRED. Issuer. This MUST contain the client_id of the OAuth Client.
+ issuer = client_id
+ # REQUIRED. Subject. This MUST contain the client_id of the OAuth Client.
+ subject = client_id
+ # The Audience SHOULD be the URL of the Authorization Server's Token Endpoint.
+ audience = token_endpoint
+
+ # jti is required
+ if claims is None:
+ claims = {}
+ if "jti" not in claims:
+ claims["jti"] = generate_token(36)
+
+ return sign_jwt_bearer_assertion(
+ key=key,
+ issuer=issuer,
+ audience=audience,
+ subject=subject,
+ claims=claims,
+ alg=alg,
+ **kwargs,
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/auth.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/auth.py
new file mode 100644
index 00000000..015673d2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/auth.py
@@ -0,0 +1,103 @@
+from authlib.common.urls import add_params_to_qs
+
+from .assertion import client_secret_jwt_sign
+from .assertion import private_key_jwt_sign
+from .client import ASSERTION_TYPE
+
+
+class ClientSecretJWT:
+ """Authentication method for OAuth 2.0 Client. This authentication
+ method is called ``client_secret_jwt``, which is using ``client_id``
+ and ``client_secret`` constructed with JWT to identify a client.
+
+ Here is an example of use ``client_secret_jwt`` with Requests Session::
+
+ from authlib.integrations.requests_client import OAuth2Session
+
+ token_endpoint = "https://example.com/oauth/token"
+ session = OAuth2Session(
+ "your-client-id",
+ "your-client-secret",
+ token_endpoint_auth_method="client_secret_jwt",
+ )
+ session.register_client_auth_method(ClientSecretJWT(token_endpoint))
+ session.fetch_token(token_endpoint)
+
+ :param token_endpoint: A string URL of the token endpoint
+ :param claims: Extra JWT claims
+ :param headers: Extra JWT headers
+ :param alg: ``alg`` value, default is HS256
+ """
+
+ name = "client_secret_jwt"
+ alg = "HS256"
+
+ def __init__(self, token_endpoint=None, claims=None, headers=None, alg=None):
+ self.token_endpoint = token_endpoint
+ self.claims = claims
+ self.headers = headers
+ if alg is not None:
+ self.alg = alg
+
+ def sign(self, auth, token_endpoint):
+ return client_secret_jwt_sign(
+ auth.client_secret,
+ client_id=auth.client_id,
+ token_endpoint=token_endpoint,
+ claims=self.claims,
+ header=self.headers,
+ alg=self.alg,
+ )
+
+ def __call__(self, auth, method, uri, headers, body):
+ token_endpoint = self.token_endpoint
+ if not token_endpoint:
+ token_endpoint = uri
+
+ client_assertion = self.sign(auth, token_endpoint)
+ body = add_params_to_qs(
+ body or "",
+ [
+ ("client_assertion_type", ASSERTION_TYPE),
+ ("client_assertion", client_assertion),
+ ],
+ )
+ return uri, headers, body
+
+
+class PrivateKeyJWT(ClientSecretJWT):
+ """Authentication method for OAuth 2.0 Client. This authentication
+ method is called ``private_key_jwt``, which is using ``client_id``
+ and ``private_key`` constructed with JWT to identify a client.
+
+ Here is an example of use ``private_key_jwt`` with Requests Session::
+
+ from authlib.integrations.requests_client import OAuth2Session
+
+ token_endpoint = "https://example.com/oauth/token"
+ session = OAuth2Session(
+ "your-client-id",
+ "your-client-private-key",
+ token_endpoint_auth_method="private_key_jwt",
+ )
+ session.register_client_auth_method(PrivateKeyJWT(token_endpoint))
+ session.fetch_token(token_endpoint)
+
+ :param token_endpoint: A string URL of the token endpoint
+ :param claims: Extra JWT claims
+ :param headers: Extra JWT headers
+ :param alg: ``alg`` value, default is RS256
+ """
+
+ name = "private_key_jwt"
+ alg = "RS256"
+
+ def sign(self, auth, token_endpoint):
+ return private_key_jwt_sign(
+ auth.client_secret,
+ client_id=auth.client_id,
+ token_endpoint=token_endpoint,
+ claims=self.claims,
+ header=self.headers,
+ alg=self.alg,
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/client.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/client.py
new file mode 100644
index 00000000..9773ce06
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/client.py
@@ -0,0 +1,124 @@
+import logging
+
+from authlib.jose import jwt
+from authlib.jose.errors import JoseError
+
+from ..rfc6749 import InvalidClientError
+
+ASSERTION_TYPE = "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"
+log = logging.getLogger(__name__)
+
+
+class JWTBearerClientAssertion:
+ """Implementation of Using JWTs for Client Authentication, which is
+ defined by RFC7523.
+ """
+
+ #: Value of ``client_assertion_type`` of JWTs
+ CLIENT_ASSERTION_TYPE = ASSERTION_TYPE
+ #: Name of the client authentication method
+ CLIENT_AUTH_METHOD = "client_assertion_jwt"
+
+ def __init__(self, token_url, validate_jti=True, leeway=60):
+ self.token_url = token_url
+ self._validate_jti = validate_jti
+ # A small allowance of time, typically no more than a few minutes,
+ # to account for clock skew. The default is 60 seconds.
+ self.leeway = leeway
+
+ def __call__(self, query_client, request):
+ data = request.form
+ assertion_type = data.get("client_assertion_type")
+ assertion = data.get("client_assertion")
+ if assertion_type == ASSERTION_TYPE and assertion:
+ resolve_key = self.create_resolve_key_func(query_client, request)
+ self.process_assertion_claims(assertion, resolve_key)
+ return self.authenticate_client(request.client)
+ log.debug("Authenticate via %r failed", self.CLIENT_AUTH_METHOD)
+
+ def create_claims_options(self):
+ """Create a claims_options for verify JWT payload claims. Developers
+ MAY overwrite this method to create a more strict options.
+ """
+ # https://tools.ietf.org/html/rfc7523#section-3
+ # The Audience SHOULD be the URL of the Authorization Server's Token Endpoint
+ options = {
+ "iss": {"essential": True, "validate": _validate_iss},
+ "sub": {"essential": True},
+ "aud": {"essential": True, "value": self.token_url},
+ "exp": {"essential": True},
+ }
+ if self._validate_jti:
+ options["jti"] = {"essential": True, "validate": self.validate_jti}
+ return options
+
+ def process_assertion_claims(self, assertion, resolve_key):
+ """Extract JWT payload claims from request "assertion", per
+ `Section 3.1`_.
+
+ :param assertion: assertion string value in the request
+ :param resolve_key: function to resolve the sign key
+ :return: JWTClaims
+ :raise: InvalidClientError
+
+ .. _`Section 3.1`: https://tools.ietf.org/html/rfc7523#section-3.1
+ """
+ try:
+ claims = jwt.decode(
+ assertion, resolve_key, claims_options=self.create_claims_options()
+ )
+ claims.validate(leeway=self.leeway)
+ except JoseError as e:
+ log.debug("Assertion Error: %r", e)
+ raise InvalidClientError(description=e.description) from e
+ return claims
+
+ def authenticate_client(self, client):
+ if client.check_endpoint_auth_method(self.CLIENT_AUTH_METHOD, "token"):
+ return client
+ raise InvalidClientError(
+ description=f"The client cannot authenticate with method: {self.CLIENT_AUTH_METHOD}"
+ )
+
+ def create_resolve_key_func(self, query_client, request):
+ def resolve_key(headers, payload):
+ # https://tools.ietf.org/html/rfc7523#section-3
+ # For client authentication, the subject MUST be the
+ # "client_id" of the OAuth client
+ client_id = payload["sub"]
+ client = query_client(client_id)
+ if not client:
+ raise InvalidClientError(
+ description="The client does not exist on this server."
+ )
+ request.client = client
+ return self.resolve_client_public_key(client, headers)
+
+ return resolve_key
+
+ def validate_jti(self, claims, jti):
+ """Validate if the given ``jti`` value is used before. Developers
+ MUST implement this method::
+
+ def validate_jti(self, claims, jti):
+ key = "jti:{}-{}".format(claims["sub"], jti)
+ if redis.get(key):
+ return False
+ redis.set(key, 1, ex=3600)
+ return True
+ """
+ raise NotImplementedError()
+
+ def resolve_client_public_key(self, client, headers):
+ """Resolve the client public key for verifying the JWT signature.
+ A client may have many public keys, in this case, we can retrieve it
+ via ``kid`` value in headers. Developers MUST implement this method::
+
+ def resolve_client_public_key(self, client, headers):
+ return client.public_key
+ """
+ raise NotImplementedError()
+
+
+def _validate_iss(claims, iss):
+ return claims["sub"] == iss
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/jwt_bearer.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/jwt_bearer.py
new file mode 100644
index 00000000..e4c83a61
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/jwt_bearer.py
@@ -0,0 +1,199 @@
+import logging
+
+from authlib.jose import JoseError
+from authlib.jose import jwt
+
+from ..rfc6749 import BaseGrant
+from ..rfc6749 import InvalidClientError
+from ..rfc6749 import InvalidGrantError
+from ..rfc6749 import InvalidRequestError
+from ..rfc6749 import TokenEndpointMixin
+from ..rfc6749 import UnauthorizedClientError
+from .assertion import sign_jwt_bearer_assertion
+
+log = logging.getLogger(__name__)
+JWT_BEARER_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:jwt-bearer"
+
+
+class JWTBearerGrant(BaseGrant, TokenEndpointMixin):
+ GRANT_TYPE = JWT_BEARER_GRANT_TYPE
+
+ #: Options for verifying JWT payload claims. Developers MAY
+ #: overwrite this constant to create a more strict options.
+ CLAIMS_OPTIONS = {
+ "iss": {"essential": True},
+ "aud": {"essential": True},
+ "exp": {"essential": True},
+ }
+
+ # A small allowance of time, typically no more than a few minutes,
+ # to account for clock skew. The default is 60 seconds.
+ LEEWAY = 60
+
+ @staticmethod
+ def sign(
+ key,
+ issuer,
+ audience,
+ subject=None,
+ issued_at=None,
+ expires_at=None,
+ claims=None,
+ **kwargs,
+ ):
+ return sign_jwt_bearer_assertion(
+ key, issuer, audience, subject, issued_at, expires_at, claims, **kwargs
+ )
+
+ def process_assertion_claims(self, assertion):
+ """Extract JWT payload claims from request "assertion", per
+ `Section 3.1`_.
+
+ :param assertion: assertion string value in the request
+ :return: JWTClaims
+ :raise: InvalidGrantError
+
+ .. _`Section 3.1`: https://tools.ietf.org/html/rfc7523#section-3.1
+ """
+ try:
+ claims = jwt.decode(
+ assertion, self.resolve_public_key, claims_options=self.CLAIMS_OPTIONS
+ )
+ claims.validate(leeway=self.LEEWAY)
+ except JoseError as e:
+ log.debug("Assertion Error: %r", e)
+ raise InvalidGrantError(description=e.description) from e
+ return claims
+
+ def resolve_public_key(self, headers, payload):
+ client = self.resolve_issuer_client(payload["iss"])
+ return self.resolve_client_key(client, headers, payload)
+
+ def validate_token_request(self):
+ """The client makes a request to the token endpoint by sending the
+ following parameters using the "application/x-www-form-urlencoded"
+ format per `Section 2.1`_:
+
+ grant_type
+ REQUIRED. Value MUST be set to
+ "urn:ietf:params:oauth:grant-type:jwt-bearer".
+
+ assertion
+ REQUIRED. Value MUST contain a single JWT.
+
+ scope
+ OPTIONAL.
+
+ The following example demonstrates an access token request with a JWT
+ as an authorization grant:
+
+ .. code-block:: http
+
+ POST /token.oauth2 HTTP/1.1
+ Host: as.example.com
+ Content-Type: application/x-www-form-urlencoded
+
+ grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer
+ &assertion=eyJhbGciOiJFUzI1NiIsImtpZCI6IjE2In0.
+ eyJpc3Mi[...omitted for brevity...].
+ J9l-ZhwP[...omitted for brevity...]
+
+ .. _`Section 2.1`: https://tools.ietf.org/html/rfc7523#section-2.1
+ """
+ assertion = self.request.form.get("assertion")
+ if not assertion:
+ raise InvalidRequestError("Missing 'assertion' in request")
+
+ claims = self.process_assertion_claims(assertion)
+ client = self.resolve_issuer_client(claims["iss"])
+ log.debug("Validate token request of %s", client)
+
+ if not client.check_grant_type(self.GRANT_TYPE):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'grant_type={self.GRANT_TYPE}'"
+ )
+
+ self.request.client = client
+ self.validate_requested_scope()
+
+ subject = claims.get("sub")
+ if subject:
+ user = self.authenticate_user(subject)
+ if not user:
+ raise InvalidGrantError(description="Invalid 'sub' value in assertion")
+
+ log.debug("Check client(%s) permission to User(%s)", client, user)
+ if not self.has_granted_permission(client, user):
+ raise InvalidClientError(
+ description="Client has no permission to access user data"
+ )
+ self.request.user = user
+
+ def create_token_response(self):
+ """If valid and authorized, the authorization server issues an access
+ token.
+ """
+ token = self.generate_token(
+ scope=self.request.payload.scope,
+ user=self.request.user,
+ include_refresh_token=False,
+ )
+ log.debug("Issue token %r to %r", token, self.request.client)
+ self.save_token(token)
+ return 200, token, self.TOKEN_RESPONSE_HEADER
+
+ def resolve_issuer_client(self, issuer):
+ """Fetch client via "iss" in assertion claims. Developers MUST
+ implement this method in subclass, e.g.::
+
+ def resolve_issuer_client(self, issuer):
+ return Client.query_by_iss(issuer)
+
+ :param issuer: "iss" value in assertion
+ :return: Client instance
+ """
+ raise NotImplementedError()
+
+ def resolve_client_key(self, client, headers, payload):
+ """Resolve client key to decode assertion data. Developers MUST
+ implement this method in subclass. For instance, there is a
+ "jwks" column on client table, e.g.::
+
+ def resolve_client_key(self, client, headers, payload):
+ # from authlib.jose import JsonWebKey
+
+ key_set = JsonWebKey.import_key_set(client.jwks)
+ return key_set.find_by_kid(headers["kid"])
+
+ :param client: instance of OAuth client model
+ :param headers: headers part of the JWT
+ :param payload: payload part of the JWT
+ :return: ``authlib.jose.Key`` instance
+ """
+ raise NotImplementedError()
+
+ def authenticate_user(self, subject):
+ """Authenticate user with the given assertion claims. Developers MUST
+ implement it in subclass, e.g.::
+
+ def authenticate_user(self, subject):
+ return User.get_by_sub(subject)
+
+ :param subject: "sub" value in claims
+ :return: User instance
+ """
+ raise NotImplementedError()
+
+ def has_granted_permission(self, client, user):
+ """Check if the client has permission to access the given user's resource.
+ Developers MUST implement it in subclass, e.g.::
+
+ def has_granted_permission(self, client, user):
+ permission = ClientUserGrant.query(client=client, user=user)
+ return permission.granted
+
+ :param client: instance of OAuth client model
+ :param user: instance of User model
+ :return: bool
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/token.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/token.py
new file mode 100644
index 00000000..882794a6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/token.py
@@ -0,0 +1,104 @@
+import time
+
+from authlib.common.encoding import to_native
+from authlib.jose import jwt
+
+
+class JWTBearerTokenGenerator:
+ """A JSON Web Token formatted bearer token generator for jwt-bearer grant type.
+ This token generator can be registered into authorization server::
+
+ authorization_server.register_token_generator(
+ "urn:ietf:params:oauth:grant-type:jwt-bearer",
+ JWTBearerTokenGenerator(private_rsa_key),
+ )
+
+ In this way, we can generate the token into JWT format. And we don't have to
+ save this token into database, since it will be short time valid. Consider to
+ rewrite ``JWTBearerGrant.save_token``::
+
+ class MyJWTBearerGrant(JWTBearerGrant):
+ def save_token(self, token):
+ pass
+
+ :param secret_key: private RSA key in bytes, JWK or JWK Set.
+ :param issuer: a string or URI of the issuer
+ :param alg: ``alg`` to use in JWT
+ """
+
+ DEFAULT_EXPIRES_IN = 3600
+
+ def __init__(self, secret_key, issuer=None, alg="RS256"):
+ self.secret_key = secret_key
+ self.issuer = issuer
+ self.alg = alg
+
+ @staticmethod
+ def get_allowed_scope(client, scope):
+ if scope:
+ scope = client.get_allowed_scope(scope)
+ return scope
+
+ @staticmethod
+ def get_sub_value(user):
+ """Return user's ID as ``sub`` value in token payload. For instance::
+
+ @staticmethod
+ def get_sub_value(user):
+ return str(user.id)
+ """
+ return user.get_user_id()
+
+ def get_token_data(self, grant_type, client, expires_in, user=None, scope=None):
+ scope = self.get_allowed_scope(client, scope)
+ issued_at = int(time.time())
+ data = {
+ "scope": scope,
+ "grant_type": grant_type,
+ "iat": issued_at,
+ "exp": issued_at + expires_in,
+ "client_id": client.get_client_id(),
+ }
+ if self.issuer:
+ data["iss"] = self.issuer
+ if user:
+ data["sub"] = self.get_sub_value(user)
+ return data
+
+ def generate(self, grant_type, client, user=None, scope=None, expires_in=None):
+ """Generate a bearer token for OAuth 2.0 authorization token endpoint.
+
+ :param client: the client that making the request.
+ :param grant_type: current requested grant_type.
+ :param user: current authorized user.
+ :param expires_in: if provided, use this value as expires_in.
+ :param scope: current requested scope.
+ :return: Token dict
+ """
+ if expires_in is None:
+ expires_in = self.DEFAULT_EXPIRES_IN
+
+ token_data = self.get_token_data(grant_type, client, expires_in, user, scope)
+ access_token = jwt.encode(
+ {"alg": self.alg}, token_data, key=self.secret_key, check=False
+ )
+ token = {
+ "token_type": "Bearer",
+ "access_token": to_native(access_token),
+ "expires_in": expires_in,
+ }
+ if scope:
+ token["scope"] = scope
+ return token
+
+ def __call__(
+ self,
+ grant_type,
+ client,
+ user=None,
+ scope=None,
+ expires_in=None,
+ include_refresh_token=True,
+ ):
+ # there is absolutely no refresh token in JWT format
+ return self.generate(grant_type, client, user, scope, expires_in)
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/validator.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/validator.py
new file mode 100644
index 00000000..1cc72bef
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7523/validator.py
@@ -0,0 +1,59 @@
+import logging
+import time
+
+from authlib.jose import JoseError
+from authlib.jose import JWTClaims
+from authlib.jose import jwt
+
+from ..rfc6749 import TokenMixin
+from ..rfc6750 import BearerTokenValidator
+
+logger = logging.getLogger(__name__)
+
+
+class JWTBearerToken(TokenMixin, JWTClaims):
+ def check_client(self, client):
+ return self["client_id"] == client.get_client_id()
+
+ def get_scope(self):
+ return self.get("scope")
+
+ def get_expires_in(self):
+ return self["exp"] - self["iat"]
+
+ def is_expired(self):
+ return self["exp"] < time.time()
+
+ def is_revoked(self):
+ return False
+
+
+class JWTBearerTokenValidator(BearerTokenValidator):
+ TOKEN_TYPE = "bearer"
+ token_cls = JWTBearerToken
+
+ def __init__(self, public_key, issuer=None, realm=None, **extra_attributes):
+ super().__init__(realm, **extra_attributes)
+ self.public_key = public_key
+ claims_options = {
+ "exp": {"essential": True},
+ "client_id": {"essential": True},
+ "grant_type": {"essential": True},
+ }
+ if issuer:
+ claims_options["iss"] = {"essential": True, "value": issuer}
+ self.claims_options = claims_options
+
+ def authenticate_token(self, token_string):
+ try:
+ claims = jwt.decode(
+ token_string,
+ self.public_key,
+ claims_options=self.claims_options,
+ claims_cls=self.token_cls,
+ )
+ claims.validate()
+ return claims
+ except JoseError as error:
+ logger.debug("Authenticate token failed. %r", error)
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__init__.py
new file mode 100644
index 00000000..8b25365d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__init__.py
@@ -0,0 +1,24 @@
+"""authlib.oauth2.rfc7591.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+OAuth 2.0 Dynamic Client Registration Protocol.
+
+https://tools.ietf.org/html/rfc7591
+"""
+
+from .claims import ClientMetadataClaims
+from .endpoint import ClientRegistrationEndpoint
+from .errors import InvalidClientMetadataError
+from .errors import InvalidRedirectURIError
+from .errors import InvalidSoftwareStatementError
+from .errors import UnapprovedSoftwareStatementError
+
+__all__ = [
+ "ClientMetadataClaims",
+ "ClientRegistrationEndpoint",
+ "InvalidRedirectURIError",
+ "InvalidClientMetadataError",
+ "InvalidSoftwareStatementError",
+ "UnapprovedSoftwareStatementError",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..b2099655
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/claims.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/claims.cpython-312.pyc
new file mode 100644
index 00000000..10ec7a9d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/claims.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/endpoint.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/endpoint.cpython-312.pyc
new file mode 100644
index 00000000..3f7df35c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/endpoint.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..57f29f6e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/claims.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/claims.py
new file mode 100644
index 00000000..914c55b2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/claims.py
@@ -0,0 +1,274 @@
+from authlib.common.urls import is_valid_url
+from authlib.jose import BaseClaims
+from authlib.jose import JsonWebKey
+from authlib.jose.errors import InvalidClaimError
+
+from ..rfc6749 import scope_to_list
+
+
+class ClientMetadataClaims(BaseClaims):
+ # https://tools.ietf.org/html/rfc7591#section-2
+ REGISTERED_CLAIMS = [
+ "redirect_uris",
+ "token_endpoint_auth_method",
+ "grant_types",
+ "response_types",
+ "client_name",
+ "client_uri",
+ "logo_uri",
+ "scope",
+ "contacts",
+ "tos_uri",
+ "policy_uri",
+ "jwks_uri",
+ "jwks",
+ "software_id",
+ "software_version",
+ ]
+
+ def validate(self):
+ self._validate_essential_claims()
+ self.validate_redirect_uris()
+ self.validate_token_endpoint_auth_method()
+ self.validate_grant_types()
+ self.validate_response_types()
+ self.validate_client_name()
+ self.validate_client_uri()
+ self.validate_logo_uri()
+ self.validate_scope()
+ self.validate_contacts()
+ self.validate_tos_uri()
+ self.validate_policy_uri()
+ self.validate_jwks_uri()
+ self.validate_jwks()
+ self.validate_software_id()
+ self.validate_software_version()
+
+ def validate_redirect_uris(self):
+ """Array of redirection URI strings for use in redirect-based flows
+ such as the authorization code and implicit flows. As required by
+ Section 2 of OAuth 2.0 [RFC6749], clients using flows with
+ redirection MUST register their redirection URI values.
+ Authorization servers that support dynamic registration for
+ redirect-based flows MUST implement support for this metadata
+ value.
+ """
+ uris = self.get("redirect_uris")
+ if uris:
+ for uri in uris:
+ self._validate_uri("redirect_uris", uri)
+
+ def validate_token_endpoint_auth_method(self):
+ """String indicator of the requested authentication method for the
+ token endpoint.
+ """
+ # If unspecified or omitted, the default is "client_secret_basic"
+ if "token_endpoint_auth_method" not in self:
+ self["token_endpoint_auth_method"] = "client_secret_basic"
+ self._validate_claim_value("token_endpoint_auth_method")
+
+ def validate_grant_types(self):
+ """Array of OAuth 2.0 grant type strings that the client can use at
+ the token endpoint.
+ """
+ self._validate_claim_value("grant_types")
+
+ def validate_response_types(self):
+ """Array of the OAuth 2.0 response type strings that the client can
+ use at the authorization endpoint.
+ """
+ self._validate_claim_value("response_types")
+
+ def validate_client_name(self):
+ """Human-readable string name of the client to be presented to the
+ end-user during authorization. If omitted, the authorization
+ server MAY display the raw "client_id" value to the end-user
+ instead. It is RECOMMENDED that clients always send this field.
+ The value of this field MAY be internationalized, as described in
+ Section 2.2.
+ """
+
+ def validate_client_uri(self):
+ """URL string of a web page providing information about the client.
+ If present, the server SHOULD display this URL to the end-user in
+ a clickable fashion. It is RECOMMENDED that clients always send
+ this field. The value of this field MUST point to a valid web
+ page. The value of this field MAY be internationalized, as
+ described in Section 2.2.
+ """
+ self._validate_uri("client_uri")
+
+ def validate_logo_uri(self):
+ """URL string that references a logo for the client. If present, the
+ server SHOULD display this image to the end-user during approval.
+ The value of this field MUST point to a valid image file. The
+ value of this field MAY be internationalized, as described in
+ Section 2.2.
+ """
+ self._validate_uri("logo_uri")
+
+ def validate_scope(self):
+ """String containing a space-separated list of scope values (as
+ described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client
+ can use when requesting access tokens. The semantics of values in
+ this list are service specific. If omitted, an authorization
+ server MAY register a client with a default set of scopes.
+ """
+ self._validate_claim_value("scope")
+
+ def validate_contacts(self):
+ """Array of strings representing ways to contact people responsible
+ for this client, typically email addresses. The authorization
+ server MAY make these contact addresses available to end-users for
+ support requests for the client. See Section 6 for information on
+ Privacy Considerations.
+ """
+ if "contacts" in self and not isinstance(self["contacts"], list):
+ raise InvalidClaimError("contacts")
+
+ def validate_tos_uri(self):
+ """URL string that points to a human-readable terms of service
+ document for the client that describes a contractual relationship
+ between the end-user and the client that the end-user accepts when
+ authorizing the client. The authorization server SHOULD display
+ this URL to the end-user if it is provided. The value of this
+ field MUST point to a valid web page. The value of this field MAY
+ be internationalized, as described in Section 2.2.
+ """
+ self._validate_uri("tos_uri")
+
+ def validate_policy_uri(self):
+ """URL string that points to a human-readable privacy policy document
+ that describes how the deployment organization collects, uses,
+ retains, and discloses personal data. The authorization server
+ SHOULD display this URL to the end-user if it is provided. The
+ value of this field MUST point to a valid web page. The value of
+ this field MAY be internationalized, as described in Section 2.2.
+ """
+ self._validate_uri("policy_uri")
+
+ def validate_jwks_uri(self):
+ """URL string referencing the client's JSON Web Key (JWK) Set
+ [RFC7517] document, which contains the client's public keys. The
+ value of this field MUST point to a valid JWK Set document. These
+ keys can be used by higher-level protocols that use signing or
+ encryption. For instance, these keys might be used by some
+ applications for validating signed requests made to the token
+ endpoint when using JWTs for client authentication [RFC7523]. Use
+ of this parameter is preferred over the "jwks" parameter, as it
+ allows for easier key rotation. The "jwks_uri" and "jwks"
+ parameters MUST NOT both be present in the same request or
+ response.
+ """
+ # TODO: use real HTTP library
+ self._validate_uri("jwks_uri")
+
+ def validate_jwks(self):
+ """Client's JSON Web Key Set [RFC7517] document value, which contains
+ the client's public keys. The value of this field MUST be a JSON
+ object containing a valid JWK Set. These keys can be used by
+ higher-level protocols that use signing or encryption. This
+ parameter is intended to be used by clients that cannot use the
+ "jwks_uri" parameter, such as native clients that cannot host
+ public URLs. The "jwks_uri" and "jwks" parameters MUST NOT both
+ be present in the same request or response.
+ """
+ if "jwks" in self:
+ if "jwks_uri" in self:
+ # The "jwks_uri" and "jwks" parameters MUST NOT both be present
+ raise InvalidClaimError("jwks")
+
+ jwks = self["jwks"]
+ try:
+ key_set = JsonWebKey.import_key_set(jwks)
+ if not key_set:
+ raise InvalidClaimError("jwks")
+ except ValueError as exc:
+ raise InvalidClaimError("jwks") from exc
+
+ def validate_software_id(self):
+ """A unique identifier string (e.g., a Universally Unique Identifier
+ (UUID)) assigned by the client developer or software publisher
+ used by registration endpoints to identify the client software to
+ be dynamically registered. Unlike "client_id", which is issued by
+ the authorization server and SHOULD vary between instances, the
+ "software_id" SHOULD remain the same for all instances of the
+ client software. The "software_id" SHOULD remain the same across
+ multiple updates or versions of the same piece of software. The
+ value of this field is not intended to be human readable and is
+ usually opaque to the client and authorization server.
+ """
+
+ def validate_software_version(self):
+ """A version identifier string for the client software identified by
+ "software_id". The value of the "software_version" SHOULD change
+ on any update to the client software identified by the same
+ "software_id". The value of this field is intended to be compared
+ using string equality matching and no other comparison semantics
+ are defined by this specification. The value of this field is
+ outside the scope of this specification, but it is not intended to
+ be human readable and is usually opaque to the client and
+ authorization server. The definition of what constitutes an
+ update to client software that would trigger a change to this
+ value is specific to the software itself and is outside the scope
+ of this specification.
+ """
+
+ def _validate_uri(self, key, uri=None):
+ if uri is None:
+ uri = self.get(key)
+ if uri and not is_valid_url(uri, fragments_allowed=False):
+ raise InvalidClaimError(key)
+
+ @classmethod
+ def get_claims_options(cls, metadata):
+ """Generate claims options validation from Authorization Server metadata."""
+ scopes_supported = metadata.get("scopes_supported")
+ response_types_supported = metadata.get("response_types_supported")
+ grant_types_supported = metadata.get("grant_types_supported")
+ auth_methods_supported = metadata.get("token_endpoint_auth_methods_supported")
+ options = {}
+ if scopes_supported is not None:
+ scopes_supported = set(scopes_supported)
+
+ def _validate_scope(claims, value):
+ if not value:
+ return True
+ scopes = set(scope_to_list(value))
+ return scopes_supported.issuperset(scopes)
+
+ options["scope"] = {"validate": _validate_scope}
+
+ if response_types_supported is not None:
+ response_types_supported = [
+ set(items.split()) for items in response_types_supported
+ ]
+
+ def _validate_response_types(claims, value):
+ # If omitted, the default is that the client will use only the "code"
+ # response type.
+ response_types = (
+ [set(items.split()) for items in value] if value else [{"code"}]
+ )
+ return all(
+ response_type in response_types_supported
+ for response_type in response_types
+ )
+
+ options["response_types"] = {"validate": _validate_response_types}
+
+ if grant_types_supported is not None:
+ grant_types_supported = set(grant_types_supported)
+
+ def _validate_grant_types(claims, value):
+ # If omitted, the default behavior is that the client will use only
+ # the "authorization_code" Grant Type.
+ grant_types = set(value) if value else {"authorization_code"}
+ return grant_types_supported.issuperset(grant_types)
+
+ options["grant_types"] = {"validate": _validate_grant_types}
+
+ if auth_methods_supported is not None:
+ options["token_endpoint_auth_method"] = {"values": auth_methods_supported}
+
+ return options
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/endpoint.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/endpoint.py
new file mode 100644
index 00000000..92a9026b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/endpoint.py
@@ -0,0 +1,191 @@
+import binascii
+import os
+import time
+
+from authlib.common.security import generate_token
+from authlib.consts import default_json_headers
+from authlib.deprecate import deprecate
+from authlib.jose import JoseError
+from authlib.jose import JsonWebToken
+
+from ..rfc6749 import AccessDeniedError
+from ..rfc6749 import InvalidRequestError
+from .claims import ClientMetadataClaims
+from .errors import InvalidClientMetadataError
+from .errors import InvalidSoftwareStatementError
+from .errors import UnapprovedSoftwareStatementError
+
+
+class ClientRegistrationEndpoint:
+ """The client registration endpoint is an OAuth 2.0 endpoint designed to
+ allow a client to be registered with the authorization server.
+ """
+
+ ENDPOINT_NAME = "client_registration"
+
+ #: Rewrite this value with a list to support ``software_statement``
+ #: e.g. ``software_statement_alg_values_supported = ['RS256']``
+ software_statement_alg_values_supported = None
+
+ def __init__(self, server=None, claims_classes=None):
+ self.server = server
+ self.claims_classes = claims_classes or [ClientMetadataClaims]
+
+ def __call__(self, request):
+ return self.create_registration_response(request)
+
+ def create_registration_response(self, request):
+ token = self.authenticate_token(request)
+ if not token:
+ raise AccessDeniedError()
+
+ request.credential = token
+
+ client_metadata = self.extract_client_metadata(request)
+ client_info = self.generate_client_info(request)
+ body = {}
+ body.update(client_metadata)
+ body.update(client_info)
+ client = self.save_client(client_info, client_metadata, request)
+ registration_info = self.generate_client_registration_info(client, request)
+ if registration_info:
+ body.update(registration_info)
+ return 201, body, default_json_headers
+
+ def extract_client_metadata(self, request):
+ if not request.payload.data:
+ raise InvalidRequestError()
+
+ json_data = request.payload.data.copy()
+ software_statement = json_data.pop("software_statement", None)
+ if software_statement and self.software_statement_alg_values_supported:
+ data = self.extract_software_statement(software_statement, request)
+ json_data.update(data)
+
+ client_metadata = {}
+ server_metadata = self.get_server_metadata()
+ for claims_class in self.claims_classes:
+ options = (
+ claims_class.get_claims_options(server_metadata)
+ if hasattr(claims_class, "get_claims_options") and server_metadata
+ else {}
+ )
+ claims = claims_class(json_data, {}, options, server_metadata)
+ try:
+ claims.validate()
+ except JoseError as error:
+ raise InvalidClientMetadataError(error.description) from error
+
+ client_metadata.update(**claims.get_registered_claims())
+ return client_metadata
+
+ def extract_software_statement(self, software_statement, request):
+ key = self.resolve_public_key(request)
+ if not key:
+ raise UnapprovedSoftwareStatementError()
+
+ try:
+ jwt = JsonWebToken(self.software_statement_alg_values_supported)
+ claims = jwt.decode(software_statement, key)
+ # there is no need to validate claims
+ return claims
+ except JoseError as exc:
+ raise InvalidSoftwareStatementError() from exc
+
+ def generate_client_info(self, request):
+ # https://tools.ietf.org/html/rfc7591#section-3.2.1
+ try:
+ client_id = self.generate_client_id(request)
+ except TypeError: # pragma: no cover
+ client_id = self.generate_client_id()
+ deprecate(
+ "generate_client_id takes a 'request' parameter. "
+ "It will become mandatory in coming releases",
+ version="1.8",
+ )
+
+ try:
+ client_secret = self.generate_client_secret(request)
+ except TypeError: # pragma: no cover
+ client_secret = self.generate_client_secret()
+ deprecate(
+ "generate_client_secret takes a 'request' parameter. "
+ "It will become mandatory in coming releases",
+ version="1.8",
+ )
+
+ client_id_issued_at = int(time.time())
+ client_secret_expires_at = 0
+ return dict(
+ client_id=client_id,
+ client_secret=client_secret,
+ client_id_issued_at=client_id_issued_at,
+ client_secret_expires_at=client_secret_expires_at,
+ )
+
+ def generate_client_registration_info(self, client, request):
+ """Generate ```registration_client_uri`` and ``registration_access_token``
+ for RFC7592. This method returns ``None`` by default. Developers MAY rewrite
+ this method to return registration information.
+ """
+ return None
+
+ def create_endpoint_request(self, request):
+ return self.server.create_json_request(request)
+
+ def generate_client_id(self, request):
+ """Generate ``client_id`` value. Developers MAY rewrite this method
+ to use their own way to generate ``client_id``.
+ """
+ return generate_token(42)
+
+ def generate_client_secret(self, request):
+ """Generate ``client_secret`` value. Developers MAY rewrite this method
+ to use their own way to generate ``client_secret``.
+ """
+ return binascii.hexlify(os.urandom(24)).decode("ascii")
+
+ def get_server_metadata(self):
+ """Return server metadata which includes supported grant types,
+ response types and etc.
+ """
+ raise NotImplementedError()
+
+ def authenticate_token(self, request):
+ """Authenticate current credential who is requesting to register a client.
+ Developers MUST implement this method in subclass::
+
+ def authenticate_token(self, request):
+ auth = request.headers.get("Authorization")
+ return get_token_by_auth(auth)
+
+ :return: token instance
+ """
+ raise NotImplementedError()
+
+ def resolve_public_key(self, request):
+ """Resolve a public key for decoding ``software_statement``. If
+ ``enable_software_statement=True``, developers MUST implement this
+ method in subclass::
+
+ def resolve_public_key(self, request):
+ return get_public_key_from_user(request.credential)
+
+ :return: JWK or Key string
+ """
+ raise NotImplementedError()
+
+ def save_client(self, client_info, client_metadata, request):
+ """Save client into database. Developers MUST implement this method
+ in subclass::
+
+ def save_client(self, client_info, client_metadata, request):
+ client = OAuthClient(
+ client_id=client_info['client_id'],
+ client_secret=client_info['client_secret'],
+ ...
+ )
+ client.save()
+ return client
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/errors.py
new file mode 100644
index 00000000..4b6ed5b5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7591/errors.py
@@ -0,0 +1,37 @@
+from ..rfc6749 import OAuth2Error
+
+
+class InvalidRedirectURIError(OAuth2Error):
+ """The value of one or more redirection URIs is invalid.
+ https://tools.ietf.org/html/rfc7591#section-3.2.2.
+ """
+
+ error = "invalid_redirect_uri"
+
+
+class InvalidClientMetadataError(OAuth2Error):
+ """The value of one of the client metadata fields is invalid and the
+ server has rejected this request. Note that an authorization
+ server MAY choose to substitute a valid value for any requested
+ parameter of a client's metadata.
+ https://tools.ietf.org/html/rfc7591#section-3.2.2.
+ """
+
+ error = "invalid_client_metadata"
+
+
+class InvalidSoftwareStatementError(OAuth2Error):
+ """The software statement presented is invalid.
+ https://tools.ietf.org/html/rfc7591#section-3.2.2.
+ """
+
+ error = "invalid_software_statement"
+
+
+class UnapprovedSoftwareStatementError(OAuth2Error):
+ """The software statement presented is not approved for use by this
+ authorization server.
+ https://tools.ietf.org/html/rfc7591#section-3.2.2.
+ """
+
+ error = "unapproved_software_statement"
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__init__.py
new file mode 100644
index 00000000..a5b3cb1c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__init__.py
@@ -0,0 +1,12 @@
+"""authlib.oauth2.rfc7592.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+OAuth 2.0 Dynamic Client Registration Management Protocol.
+
+https://tools.ietf.org/html/rfc7592
+"""
+
+from .endpoint import ClientConfigurationEndpoint
+
+__all__ = ["ClientConfigurationEndpoint"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..88a7e47d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__pycache__/endpoint.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__pycache__/endpoint.cpython-312.pyc
new file mode 100644
index 00000000..c3120991
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/__pycache__/endpoint.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/endpoint.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/endpoint.py
new file mode 100644
index 00000000..964202c9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7592/endpoint.py
@@ -0,0 +1,226 @@
+from authlib.consts import default_json_headers
+from authlib.jose import JoseError
+
+from ..rfc6749 import AccessDeniedError
+from ..rfc6749 import InvalidClientError
+from ..rfc6749 import InvalidRequestError
+from ..rfc6749 import UnauthorizedClientError
+from ..rfc7591 import InvalidClientMetadataError
+from ..rfc7591.claims import ClientMetadataClaims
+
+
+class ClientConfigurationEndpoint:
+ ENDPOINT_NAME = "client_configuration"
+
+ def __init__(self, server=None, claims_classes=None):
+ self.server = server
+ self.claims_classes = claims_classes or [ClientMetadataClaims]
+
+ def __call__(self, request):
+ return self.create_configuration_response(request)
+
+ def create_configuration_response(self, request):
+ # This request is authenticated by the registration access token issued
+ # to the client.
+ token = self.authenticate_token(request)
+ if not token:
+ raise AccessDeniedError()
+
+ request.credential = token
+
+ client = self.authenticate_client(request)
+ if not client:
+ # If the client does not exist on this server, the server MUST respond
+ # with HTTP 401 Unauthorized and the registration access token used to
+ # make this request SHOULD be immediately revoked.
+ self.revoke_access_token(request, token)
+ raise InvalidClientError(
+ status_code=401, description="The client does not exist on this server."
+ )
+
+ if not self.check_permission(client, request):
+ # If the client does not have permission to read its record, the server
+ # MUST return an HTTP 403 Forbidden.
+ raise UnauthorizedClientError(
+ status_code=403,
+ description="The client does not have permission to read its record.",
+ )
+
+ request.client = client
+
+ if request.method == "GET":
+ return self.create_read_client_response(client, request)
+ elif request.method == "DELETE":
+ return self.create_delete_client_response(client, request)
+ elif request.method == "PUT":
+ return self.create_update_client_response(client, request)
+
+ def create_endpoint_request(self, request):
+ return self.server.create_json_request(request)
+
+ def create_read_client_response(self, client, request):
+ body = self.introspect_client(client)
+ body.update(self.generate_client_registration_info(client, request))
+ return 200, body, default_json_headers
+
+ def create_delete_client_response(self, client, request):
+ self.delete_client(client, request)
+ headers = [
+ ("Cache-Control", "no-store"),
+ ("Pragma", "no-cache"),
+ ]
+ return 204, "", headers
+
+ def create_update_client_response(self, client, request):
+ # The updated client metadata fields request MUST NOT include the
+ # 'registration_access_token', 'registration_client_uri',
+ # 'client_secret_expires_at', or 'client_id_issued_at' fields
+ must_not_include = (
+ "registration_access_token",
+ "registration_client_uri",
+ "client_secret_expires_at",
+ "client_id_issued_at",
+ )
+ for k in must_not_include:
+ if k in request.payload.data:
+ raise InvalidRequestError()
+
+ # The client MUST include its 'client_id' field in the request
+ client_id = request.payload.data.get("client_id")
+ if not client_id:
+ raise InvalidRequestError()
+ if client_id != client.get_client_id():
+ raise InvalidRequestError()
+
+ # If the client includes the 'client_secret' field in the request,
+ # the value of this field MUST match the currently issued client
+ # secret for that client.
+ if "client_secret" in request.payload.data:
+ if not client.check_client_secret(request.payload.data["client_secret"]):
+ raise InvalidRequestError()
+
+ client_metadata = self.extract_client_metadata(request)
+ client = self.update_client(client, client_metadata, request)
+ return self.create_read_client_response(client, request)
+
+ def extract_client_metadata(self, request):
+ json_data = request.payload.data.copy()
+ client_metadata = {}
+ server_metadata = self.get_server_metadata()
+ for claims_class in self.claims_classes:
+ options = (
+ claims_class.get_claims_options(server_metadata)
+ if hasattr(claims_class, "get_claims_options") and server_metadata
+ else {}
+ )
+ claims = claims_class(json_data, {}, options, server_metadata)
+ try:
+ claims.validate()
+ except JoseError as error:
+ raise InvalidClientMetadataError(error.description) from error
+
+ client_metadata.update(**claims.get_registered_claims())
+ return client_metadata
+
+ def introspect_client(self, client):
+ return {**client.client_info, **client.client_metadata}
+
+ def generate_client_registration_info(self, client, request):
+ """Generate ```registration_client_uri`` and ``registration_access_token``
+ for RFC7592. By default this method returns the values sent in the current
+ request. Developers MUST rewrite this method to return different registration
+ information.::
+
+ def generate_client_registration_info(self, client, request):{
+ access_token = request.headers['Authorization'].split(' ')[1]
+ return {
+ 'registration_client_uri': request.uri,
+ 'registration_access_token': access_token,
+ }
+
+ :param client: the instance of OAuth client
+ :param request: formatted request instance
+ """
+ raise NotImplementedError()
+
+ def authenticate_token(self, request):
+ """Authenticate current credential who is requesting to register a client.
+ Developers MUST implement this method in subclass::
+
+ def authenticate_token(self, request):
+ auth = request.headers.get("Authorization")
+ return get_token_by_auth(auth)
+
+ :return: token instance
+ """
+ raise NotImplementedError()
+
+ def authenticate_client(self, request):
+ """Read a client from the request payload.
+ Developers MUST implement this method in subclass::
+
+ def authenticate_client(self, request):
+ client_id = request.payload.data.get("client_id")
+ return Client.get(client_id=client_id)
+
+ :return: client instance
+ """
+ raise NotImplementedError()
+
+ def revoke_access_token(self, token, request):
+ """Revoke a token access in case an invalid client has been requested.
+ Developers MUST implement this method in subclass::
+
+ def revoke_access_token(self, token, request):
+ token.revoked = True
+ token.save()
+
+ """
+ raise NotImplementedError()
+
+ def check_permission(self, client, request):
+ """Checks whether the current client is allowed to be accessed, edited
+ or deleted. Developers MUST implement it in subclass, e.g.::
+
+ def check_permission(self, client, request):
+ return client.editable
+
+ :return: boolean
+ """
+ raise NotImplementedError()
+
+ def delete_client(self, client, request):
+ """Delete authorization code from database or cache. Developers MUST
+ implement it in subclass, e.g.::
+
+ def delete_client(self, client, request):
+ client.delete()
+
+ :param client: the instance of OAuth client
+ :param request: formatted request instance
+ """
+ raise NotImplementedError()
+
+ def update_client(self, client, client_metadata, request):
+ """Update the client in the database. Developers MUST implement this method
+ in subclass::
+
+ def update_client(self, client, client_metadata, request):
+ client.set_client_metadata(
+ {**client.client_metadata, **client_metadata}
+ )
+ client.save()
+ return client
+
+ :param client: the instance of OAuth client
+ :param client_metadata: a dict of the client claims to update
+ :param request: formatted request instance
+ :return: client instance
+ """
+ raise NotImplementedError()
+
+ def get_server_metadata(self):
+ """Return server metadata which includes supported grant types,
+ response types and etc.
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__init__.py
new file mode 100644
index 00000000..25399a58
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__init__.py
@@ -0,0 +1,13 @@
+"""authlib.oauth2.rfc7636.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+Proof Key for Code Exchange by OAuth Public Clients.
+
+https://tools.ietf.org/html/rfc7636
+"""
+
+from .challenge import CodeChallenge
+from .challenge import create_s256_code_challenge
+
+__all__ = ["CodeChallenge", "create_s256_code_challenge"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..58cc0e3b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__pycache__/challenge.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__pycache__/challenge.cpython-312.pyc
new file mode 100644
index 00000000..36661913
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/__pycache__/challenge.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/challenge.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/challenge.py
new file mode 100644
index 00000000..952c1583
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7636/challenge.py
@@ -0,0 +1,147 @@
+import hashlib
+import re
+
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import to_unicode
+from authlib.common.encoding import urlsafe_b64encode
+
+from ..rfc6749 import InvalidGrantError
+from ..rfc6749 import InvalidRequestError
+from ..rfc6749 import OAuth2Request
+
+CODE_VERIFIER_PATTERN = re.compile(r"^[a-zA-Z0-9\-._~]{43,128}$")
+CODE_CHALLENGE_PATTERN = re.compile(r"^[a-zA-Z0-9\-._~]{43,128}$")
+
+
+def create_s256_code_challenge(code_verifier):
+ """Create S256 code_challenge with the given code_verifier."""
+ data = hashlib.sha256(to_bytes(code_verifier, "ascii")).digest()
+ return to_unicode(urlsafe_b64encode(data))
+
+
+def compare_plain_code_challenge(code_verifier, code_challenge):
+ # If the "code_challenge_method" from Section 4.3 was "plain",
+ # they are compared directly
+ return code_verifier == code_challenge
+
+
+def compare_s256_code_challenge(code_verifier, code_challenge):
+ # BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) == code_challenge
+ return create_s256_code_challenge(code_verifier) == code_challenge
+
+
+class CodeChallenge:
+ """CodeChallenge extension to Authorization Code Grant. It is used to
+ improve the security of Authorization Code flow for public clients by
+ sending extra "code_challenge" and "code_verifier" to the authorization
+ server.
+
+ The AuthorizationCodeGrant SHOULD save the ``code_challenge`` and
+ ``code_challenge_method`` into database when ``save_authorization_code``.
+ Then register this extension via::
+
+ server.register_grant(AuthorizationCodeGrant, [CodeChallenge(required=True)])
+ """
+
+ #: defaults to "plain" if not present in the request
+ DEFAULT_CODE_CHALLENGE_METHOD = "plain"
+ #: supported ``code_challenge_method``
+ SUPPORTED_CODE_CHALLENGE_METHOD = ["plain", "S256"]
+
+ CODE_CHALLENGE_METHODS = {
+ "plain": compare_plain_code_challenge,
+ "S256": compare_s256_code_challenge,
+ }
+
+ def __init__(self, required=True):
+ self.required = required
+
+ def __call__(self, grant):
+ grant.register_hook(
+ "after_validate_authorization_request_payload",
+ self.validate_code_challenge,
+ )
+ grant.register_hook(
+ "after_validate_token_request",
+ self.validate_code_verifier,
+ )
+
+ def validate_code_challenge(self, grant, redirect_uri):
+ request: OAuth2Request = grant.request
+ challenge = request.payload.data.get("code_challenge")
+ method = request.payload.data.get("code_challenge_method")
+ if not challenge and not method:
+ return
+
+ if not challenge:
+ raise InvalidRequestError("Missing 'code_challenge'")
+
+ if len(request.payload.datalist.get("code_challenge", [])) > 1:
+ raise InvalidRequestError("Multiple 'code_challenge' in request.")
+
+ if not CODE_CHALLENGE_PATTERN.match(challenge):
+ raise InvalidRequestError("Invalid 'code_challenge'")
+
+ if method and method not in self.SUPPORTED_CODE_CHALLENGE_METHOD:
+ raise InvalidRequestError("Unsupported 'code_challenge_method'")
+
+ if len(request.payload.datalist.get("code_challenge_method", [])) > 1:
+ raise InvalidRequestError("Multiple 'code_challenge_method' in request.")
+
+ def validate_code_verifier(self, grant, result):
+ request: OAuth2Request = grant.request
+ verifier = request.form.get("code_verifier")
+
+ # public client MUST verify code challenge
+ if self.required and request.auth_method == "none" and not verifier:
+ raise InvalidRequestError("Missing 'code_verifier'")
+
+ authorization_code = request.authorization_code
+ challenge = self.get_authorization_code_challenge(authorization_code)
+
+ # ignore, it is the normal RFC6749 authorization_code request
+ if not challenge and not verifier:
+ return
+
+ # challenge exists, code_verifier is required
+ if not verifier:
+ raise InvalidRequestError("Missing 'code_verifier'")
+
+ if not CODE_VERIFIER_PATTERN.match(verifier):
+ raise InvalidRequestError("Invalid 'code_verifier'")
+
+ # 4.6. Server Verifies code_verifier before Returning the Tokens
+ method = self.get_authorization_code_challenge_method(authorization_code)
+ if method is None:
+ method = self.DEFAULT_CODE_CHALLENGE_METHOD
+
+ func = self.CODE_CHALLENGE_METHODS.get(method)
+ if not func:
+ raise RuntimeError(f"No verify method for '{method}'")
+
+ # If the values are not equal, an error response indicating
+ # "invalid_grant" MUST be returned.
+ if not func(verifier, challenge):
+ raise InvalidGrantError(description="Code challenge failed.")
+
+ def get_authorization_code_challenge(self, authorization_code):
+ """Get "code_challenge" associated with this authorization code.
+ Developers MAY re-implement it in subclass, the default logic::
+
+ def get_authorization_code_challenge(self, authorization_code):
+ return authorization_code.code_challenge
+
+ :param authorization_code: the instance of authorization_code
+ """
+ return authorization_code.code_challenge
+
+ def get_authorization_code_challenge_method(self, authorization_code):
+ """Get "code_challenge_method" associated with this authorization code.
+ Developers MAY re-implement it in subclass, the default logic::
+
+ def get_authorization_code_challenge_method(self, authorization_code):
+ return authorization_code.code_challenge_method
+
+ :param authorization_code: the instance of authorization_code
+ """
+ return authorization_code.code_challenge_method
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__init__.py
new file mode 100644
index 00000000..ada30736
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__init__.py
@@ -0,0 +1,14 @@
+"""authlib.oauth2.rfc7662.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+OAuth 2.0 Token Introspection.
+
+https://tools.ietf.org/html/rfc7662
+"""
+
+from .introspection import IntrospectionEndpoint
+from .models import IntrospectionToken
+from .token_validator import IntrospectTokenValidator
+
+__all__ = ["IntrospectionEndpoint", "IntrospectionToken", "IntrospectTokenValidator"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..02250fcb
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/introspection.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/introspection.cpython-312.pyc
new file mode 100644
index 00000000..96b0a143
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/introspection.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..f773aa7a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/token_validator.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/token_validator.cpython-312.pyc
new file mode 100644
index 00000000..ee9d094f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/__pycache__/token_validator.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/introspection.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/introspection.py
new file mode 100644
index 00000000..9ff7ea9e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/introspection.py
@@ -0,0 +1,132 @@
+from authlib.consts import default_json_headers
+
+from ..rfc6749 import InvalidRequestError
+from ..rfc6749 import TokenEndpoint
+from ..rfc6749 import UnsupportedTokenTypeError
+
+
+class IntrospectionEndpoint(TokenEndpoint):
+ """Implementation of introspection endpoint which is described in
+ `RFC7662`_.
+
+ .. _RFC7662: https://tools.ietf.org/html/rfc7662
+ """
+
+ #: Endpoint name to be registered
+ ENDPOINT_NAME = "introspection"
+
+ def authenticate_token(self, request, client):
+ """The protected resource calls the introspection endpoint using an HTTP
+ ``POST`` request with parameters sent as
+ "application/x-www-form-urlencoded" data. The protected resource sends a
+ parameter representing the token along with optional parameters
+ representing additional context that is known by the protected resource
+ to aid the authorization server in its response.
+
+ token
+ **REQUIRED** The string value of the token. For access tokens, this
+ is the ``access_token`` value returned from the token endpoint
+ defined in OAuth 2.0. For refresh tokens, this is the
+ ``refresh_token`` value returned from the token endpoint as defined
+ in OAuth 2.0.
+
+ token_type_hint
+ **OPTIONAL** A hint about the type of the token submitted for
+ introspection.
+ """
+ self.check_params(request, client)
+ token = self.query_token(
+ request.form["token"], request.form.get("token_type_hint")
+ )
+ if token and self.check_permission(token, client, request):
+ return token
+
+ def check_params(self, request, client):
+ params = request.form
+ if "token" not in params:
+ raise InvalidRequestError()
+
+ hint = params.get("token_type_hint")
+ if hint and hint not in self.SUPPORTED_TOKEN_TYPES:
+ raise UnsupportedTokenTypeError()
+
+ def create_endpoint_response(self, request):
+ """Validate introspection request and create the response.
+
+ :returns: (status_code, body, headers)
+ """
+ # The authorization server first validates the client credentials
+ client = self.authenticate_endpoint_client(request)
+
+ # then verifies whether the token was issued to the client making
+ # the revocation request
+ token = self.authenticate_token(request, client)
+
+ # the authorization server invalidates the token
+ body = self.create_introspection_payload(token)
+ return 200, body, default_json_headers
+
+ def create_introspection_payload(self, token):
+ # the token is not active, does not exist on this server, or the
+ # protected resource is not allowed to introspect this particular
+ # token, then the authorization server MUST return an introspection
+ # response with the "active" field set to "false"
+ if not token:
+ return {"active": False}
+ if token.is_expired() or token.is_revoked():
+ return {"active": False}
+ payload = self.introspect_token(token)
+ if "active" not in payload:
+ payload["active"] = True
+ return payload
+
+ def check_permission(self, token, client, request):
+ """Check if the request has permission to introspect the token. Developers
+ MUST implement this method::
+
+ def check_permission(self, token, client, request):
+ # only allow a special client to introspect the token
+ return client.client_id == "introspection_client"
+
+ :return: bool
+ """
+ raise NotImplementedError()
+
+ def query_token(self, token_string, token_type_hint):
+ """Get the token from database/storage by the given token string.
+ Developers should implement this method::
+
+ def query_token(self, token_string, token_type_hint):
+ if token_type_hint == "access_token":
+ tok = Token.query_by_access_token(token_string)
+ elif token_type_hint == "refresh_token":
+ tok = Token.query_by_refresh_token(token_string)
+ else:
+ tok = Token.query_by_access_token(token_string)
+ if not tok:
+ tok = Token.query_by_refresh_token(token_string)
+ return tok
+ """
+ raise NotImplementedError()
+
+ def introspect_token(self, token):
+ """Read given token and return its introspection metadata as a
+ dictionary following `Section 2.2`_::
+
+ def introspect_token(self, token):
+ return {
+ "active": True,
+ "client_id": token.client_id,
+ "token_type": token.token_type,
+ "username": get_token_username(token),
+ "scope": token.get_scope(),
+ "sub": get_token_user_sub(token),
+ "aud": token.client_id,
+ "iss": "https://server.example.com/",
+ "exp": token.expires_at,
+ "iat": token.issued_at,
+ }
+
+ .. _`Section 2.2`: https://tools.ietf.org/html/rfc7662#section-2.2
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/models.py
new file mode 100644
index 00000000..e369fa73
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/models.py
@@ -0,0 +1,40 @@
+from ..rfc6749 import TokenMixin
+
+
+class IntrospectionToken(dict, TokenMixin):
+ def get_client_id(self):
+ return self.get("client_id")
+
+ def get_scope(self):
+ return self.get("scope")
+
+ def get_expires_in(self):
+ # this method is only used in refresh token,
+ # no need to implement it
+ return 0
+
+ def get_expires_at(self):
+ return self.get("exp", 0)
+
+ def __getattr__(self, key):
+ # https://tools.ietf.org/html/rfc7662#section-2.2
+ available_keys = {
+ "active",
+ "scope",
+ "client_id",
+ "username",
+ "token_type",
+ "exp",
+ "iat",
+ "nbf",
+ "sub",
+ "aud",
+ "iss",
+ "jti",
+ }
+ try:
+ return object.__getattribute__(self, key)
+ except AttributeError as error:
+ if key in available_keys:
+ return self.get(key)
+ raise error
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/token_validator.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/token_validator.py
new file mode 100644
index 00000000..213be564
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc7662/token_validator.py
@@ -0,0 +1,34 @@
+from ..rfc6749 import TokenValidator
+from ..rfc6750 import InsufficientScopeError
+from ..rfc6750 import InvalidTokenError
+
+
+class IntrospectTokenValidator(TokenValidator):
+ TOKEN_TYPE = "bearer"
+
+ def introspect_token(self, token_string):
+ """Request introspection token endpoint with the given token string,
+ authorization server will return token information in JSON format.
+ Developers MUST implement this method before using it::
+
+ def introspect_token(self, token_string):
+ # for example, introspection token endpoint has limited
+ # internal IPs to access, so there is no need to add
+ # authentication.
+ url = "https://example.com/oauth/introspect"
+ resp = requests.post(url, data={"token": token_string})
+ resp.raise_for_status()
+ return resp.json()
+ """
+ raise NotImplementedError()
+
+ def authenticate_token(self, token_string):
+ return self.introspect_token(token_string)
+
+ def validate_token(self, token, scopes, request):
+ if not token or not token["active"]:
+ raise InvalidTokenError(
+ realm=self.realm, extra_attributes=self.extra_attributes
+ )
+ if self.scope_insufficient(token.get("scope"), scopes):
+ raise InsufficientScopeError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__init__.py
new file mode 100644
index 00000000..fff67209
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__init__.py
@@ -0,0 +1,13 @@
+"""authlib.oauth2.rfc8414.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents a direct implementation of
+OAuth 2.0 Authorization Server Metadata.
+
+https://tools.ietf.org/html/rfc8414
+"""
+
+from .models import AuthorizationServerMetadata
+from .well_known import get_well_known_url
+
+__all__ = ["AuthorizationServerMetadata", "get_well_known_url"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..73a8d17b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..aebbe7d4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/well_known.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/well_known.cpython-312.pyc
new file mode 100644
index 00000000..7def77d4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/__pycache__/well_known.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/models.py
new file mode 100644
index 00000000..5cf1de27
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/models.py
@@ -0,0 +1,385 @@
+from authlib.common.security import is_secure_transport
+from authlib.common.urls import is_valid_url
+from authlib.common.urls import urlparse
+
+
+class AuthorizationServerMetadata(dict):
+ """Define Authorization Server Metadata via `Section 2`_ in RFC8414_.
+
+ .. _RFC8414: https://tools.ietf.org/html/rfc8414
+ .. _`Section 2`: https://tools.ietf.org/html/rfc8414#section-2
+ """
+
+ REGISTRY_KEYS = [
+ "issuer",
+ "authorization_endpoint",
+ "token_endpoint",
+ "jwks_uri",
+ "registration_endpoint",
+ "scopes_supported",
+ "response_types_supported",
+ "response_modes_supported",
+ "grant_types_supported",
+ "token_endpoint_auth_methods_supported",
+ "token_endpoint_auth_signing_alg_values_supported",
+ "service_documentation",
+ "ui_locales_supported",
+ "op_policy_uri",
+ "op_tos_uri",
+ "revocation_endpoint",
+ "revocation_endpoint_auth_methods_supported",
+ "revocation_endpoint_auth_signing_alg_values_supported",
+ "introspection_endpoint",
+ "introspection_endpoint_auth_methods_supported",
+ "introspection_endpoint_auth_signing_alg_values_supported",
+ "code_challenge_methods_supported",
+ ]
+
+ def validate_issuer(self):
+ """REQUIRED. The authorization server's issuer identifier, which is
+ a URL that uses the "https" scheme and has no query or fragment
+ components.
+ """
+ issuer = self.get("issuer")
+
+ #: 1. REQUIRED
+ if not issuer:
+ raise ValueError('"issuer" is required')
+
+ parsed = urlparse.urlparse(issuer)
+
+ #: 2. uses the "https" scheme
+ if not is_secure_transport(issuer):
+ raise ValueError('"issuer" MUST use "https" scheme')
+
+ #: 3. has no query or fragment
+ if parsed.query or parsed.fragment:
+ raise ValueError('"issuer" has no query or fragment')
+
+ def validate_authorization_endpoint(self):
+ """URL of the authorization server's authorization endpoint
+ [RFC6749]. This is REQUIRED unless no grant types are supported
+ that use the authorization endpoint.
+ """
+ url = self.get("authorization_endpoint")
+ if url:
+ if not is_secure_transport(url):
+ raise ValueError('"authorization_endpoint" MUST use "https" scheme')
+ return
+
+ grant_types_supported = set(self.grant_types_supported)
+ authorization_grant_types = {"authorization_code", "implicit"}
+ if grant_types_supported & authorization_grant_types:
+ raise ValueError('"authorization_endpoint" is required')
+
+ def validate_token_endpoint(self):
+ """URL of the authorization server's token endpoint [RFC6749]. This
+ is REQUIRED unless only the implicit grant type is supported.
+ """
+ grant_types_supported = self.get("grant_types_supported")
+ if (
+ grant_types_supported
+ and len(grant_types_supported) == 1
+ and grant_types_supported[0] == "implicit"
+ ):
+ return
+
+ url = self.get("token_endpoint")
+ if not url:
+ raise ValueError('"token_endpoint" is required')
+
+ if not is_secure_transport(url):
+ raise ValueError('"token_endpoint" MUST use "https" scheme')
+
+ def validate_jwks_uri(self):
+ """OPTIONAL. URL of the authorization server's JWK Set [JWK]
+ document. The referenced document contains the signing key(s) the
+ client uses to validate signatures from the authorization server.
+ This URL MUST use the "https" scheme. The JWK Set MAY also
+ contain the server's encryption key or keys, which are used by
+ clients to encrypt requests to the server. When both signing and
+ encryption keys are made available, a "use" (public key use)
+ parameter value is REQUIRED for all keys in the referenced JWK Set
+ to indicate each key's intended usage.
+ """
+ url = self.get("jwks_uri")
+ if url and not is_secure_transport(url):
+ raise ValueError('"jwks_uri" MUST use "https" scheme')
+
+ def validate_registration_endpoint(self):
+ """OPTIONAL. URL of the authorization server's OAuth 2.0 Dynamic
+ Client Registration endpoint [RFC7591].
+ """
+ url = self.get("registration_endpoint")
+ if url and not is_secure_transport(url):
+ raise ValueError('"registration_endpoint" MUST use "https" scheme')
+
+ def validate_scopes_supported(self):
+ """RECOMMENDED. JSON array containing a list of the OAuth 2.0
+ [RFC6749] "scope" values that this authorization server supports.
+ Servers MAY choose not to advertise some supported scope values
+ even when this parameter is used.
+ """
+ validate_array_value(self, "scopes_supported")
+
+ def validate_response_types_supported(self):
+ """REQUIRED. JSON array containing a list of the OAuth 2.0
+ "response_type" values that this authorization server supports.
+ The array values used are the same as those used with the
+ "response_types" parameter defined by "OAuth 2.0 Dynamic Client
+ Registration Protocol" [RFC7591].
+ """
+ response_types_supported = self.get("response_types_supported")
+ if not response_types_supported:
+ raise ValueError('"response_types_supported" is required')
+ if not isinstance(response_types_supported, list):
+ raise ValueError('"response_types_supported" MUST be JSON array')
+
+ def validate_response_modes_supported(self):
+ """OPTIONAL. JSON array containing a list of the OAuth 2.0
+ "response_mode" values that this authorization server supports, as
+ specified in "OAuth 2.0 Multiple Response Type Encoding Practices"
+ [OAuth.Responses]. If omitted, the default is "["query",
+ "fragment"]". The response mode value "form_post" is also defined
+ in "OAuth 2.0 Form Post Response Mode" [OAuth.Post].
+ """
+ validate_array_value(self, "response_modes_supported")
+
+ def validate_grant_types_supported(self):
+ """OPTIONAL. JSON array containing a list of the OAuth 2.0 grant
+ type values that this authorization server supports. The array
+ values used are the same as those used with the "grant_types"
+ parameter defined by "OAuth 2.0 Dynamic Client Registration
+ Protocol" [RFC7591]. If omitted, the default value is
+ "["authorization_code", "implicit"]".
+ """
+ validate_array_value(self, "grant_types_supported")
+
+ def validate_token_endpoint_auth_methods_supported(self):
+ """OPTIONAL. JSON array containing a list of client authentication
+ methods supported by this token endpoint. Client authentication
+ method values are used in the "token_endpoint_auth_method"
+ parameter defined in Section 2 of [RFC7591]. If omitted, the
+ default is "client_secret_basic" -- the HTTP Basic Authentication
+ Scheme specified in Section 2.3.1 of OAuth 2.0 [RFC6749].
+ """
+ validate_array_value(self, "token_endpoint_auth_methods_supported")
+
+ def validate_token_endpoint_auth_signing_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWS signing
+ algorithms ("alg" values) supported by the token endpoint for the
+ signature on the JWT [JWT] used to authenticate the client at the
+ token endpoint for the "private_key_jwt" and "client_secret_jwt"
+ authentication methods. This metadata entry MUST be present if
+ either of these authentication methods are specified in the
+ "token_endpoint_auth_methods_supported" entry. No default
+ algorithms are implied if this entry is omitted. Servers SHOULD
+ support "RS256". The value "none" MUST NOT be used.
+ """
+ _validate_alg_values(
+ self,
+ "token_endpoint_auth_signing_alg_values_supported",
+ self.token_endpoint_auth_methods_supported,
+ )
+
+ def validate_service_documentation(self):
+ """OPTIONAL. URL of a page containing human-readable information
+ that developers might want or need to know when using the
+ authorization server. In particular, if the authorization server
+ does not support Dynamic Client Registration, then information on
+ how to register clients needs to be provided in this
+ documentation.
+ """
+ value = self.get("service_documentation")
+ if value and not is_valid_url(value):
+ raise ValueError('"service_documentation" MUST be a URL')
+
+ def validate_ui_locales_supported(self):
+ """OPTIONAL. Languages and scripts supported for the user interface,
+ represented as a JSON array of language tag values from BCP 47
+ [RFC5646]. If omitted, the set of supported languages and scripts
+ is unspecified.
+ """
+ validate_array_value(self, "ui_locales_supported")
+
+ def validate_op_policy_uri(self):
+ """OPTIONAL. URL that the authorization server provides to the
+ person registering the client to read about the authorization
+ server's requirements on how the client can use the data provided
+ by the authorization server. The registration process SHOULD
+ display this URL to the person registering the client if it is
+ given. As described in Section 5, despite the identifier
+ "op_policy_uri" appearing to be OpenID-specific, its usage in this
+ specification is actually referring to a general OAuth 2.0 feature
+ that is not specific to OpenID Connect.
+ """
+ value = self.get("op_policy_uri")
+ if value and not is_valid_url(value):
+ raise ValueError('"op_policy_uri" MUST be a URL')
+
+ def validate_op_tos_uri(self):
+ """OPTIONAL. URL that the authorization server provides to the
+ person registering the client to read about the authorization
+ server's terms of service. The registration process SHOULD
+ display this URL to the person registering the client if it is
+ given. As described in Section 5, despite the identifier
+ "op_tos_uri", appearing to be OpenID-specific, its usage in this
+ specification is actually referring to a general OAuth 2.0 feature
+ that is not specific to OpenID Connect.
+ """
+ value = self.get("op_tos_uri")
+ if value and not is_valid_url(value):
+ raise ValueError('"op_tos_uri" MUST be a URL')
+
+ def validate_revocation_endpoint(self):
+ """OPTIONAL. URL of the authorization server's OAuth 2.0 revocation
+ endpoint [RFC7009].
+ """
+ url = self.get("revocation_endpoint")
+ if url and not is_secure_transport(url):
+ raise ValueError('"revocation_endpoint" MUST use "https" scheme')
+
+ def validate_revocation_endpoint_auth_methods_supported(self):
+ """OPTIONAL. JSON array containing a list of client authentication
+ methods supported by this revocation endpoint. The valid client
+ authentication method values are those registered in the IANA
+ "OAuth Token Endpoint Authentication Methods" registry
+ [IANA.OAuth.Parameters]. If omitted, the default is
+ "client_secret_basic" -- the HTTP Basic Authentication Scheme
+ specified in Section 2.3.1 of OAuth 2.0 [RFC6749].
+ """
+ validate_array_value(self, "revocation_endpoint_auth_methods_supported")
+
+ def validate_revocation_endpoint_auth_signing_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWS signing
+ algorithms ("alg" values) supported by the revocation endpoint for
+ the signature on the JWT [JWT] used to authenticate the client at
+ the revocation endpoint for the "private_key_jwt" and
+ "client_secret_jwt" authentication methods. This metadata entry
+ MUST be present if either of these authentication methods are
+ specified in the "revocation_endpoint_auth_methods_supported"
+ entry. No default algorithms are implied if this entry is
+ omitted. The value "none" MUST NOT be used.
+ """
+ _validate_alg_values(
+ self,
+ "revocation_endpoint_auth_signing_alg_values_supported",
+ self.revocation_endpoint_auth_methods_supported,
+ )
+
+ def validate_introspection_endpoint(self):
+ """OPTIONAL. URL of the authorization server's OAuth 2.0
+ introspection endpoint [RFC7662].
+ """
+ url = self.get("introspection_endpoint")
+ if url and not is_secure_transport(url):
+ raise ValueError('"introspection_endpoint" MUST use "https" scheme')
+
+ def validate_introspection_endpoint_auth_methods_supported(self):
+ """OPTIONAL. JSON array containing a list of client authentication
+ methods supported by this introspection endpoint. The valid
+ client authentication method values are those registered in the
+ IANA "OAuth Token Endpoint Authentication Methods" registry
+ [IANA.OAuth.Parameters] or those registered in the IANA "OAuth
+ Access Token Types" registry [IANA.OAuth.Parameters]. (These
+ values are and will remain distinct, due to Section 7.2.) If
+ omitted, the set of supported authentication methods MUST be
+ determined by other means.
+ """
+ validate_array_value(self, "introspection_endpoint_auth_methods_supported")
+
+ def validate_introspection_endpoint_auth_signing_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWS signing
+ algorithms ("alg" values) supported by the introspection endpoint
+ for the signature on the JWT [JWT] used to authenticate the client
+ at the introspection endpoint for the "private_key_jwt" and
+ "client_secret_jwt" authentication methods. This metadata entry
+ MUST be present if either of these authentication methods are
+ specified in the "introspection_endpoint_auth_methods_supported"
+ entry. No default algorithms are implied if this entry is
+ omitted. The value "none" MUST NOT be used.
+ """
+ _validate_alg_values(
+ self,
+ "introspection_endpoint_auth_signing_alg_values_supported",
+ self.introspection_endpoint_auth_methods_supported,
+ )
+
+ def validate_code_challenge_methods_supported(self):
+ """OPTIONAL. JSON array containing a list of Proof Key for Code
+ Exchange (PKCE) [RFC7636] code challenge methods supported by this
+ authorization server. Code challenge method values are used in
+ the "code_challenge_method" parameter defined in Section 4.3 of
+ [RFC7636]. The valid code challenge method values are those
+ registered in the IANA "PKCE Code Challenge Methods" registry
+ [IANA.OAuth.Parameters]. If omitted, the authorization server
+ does not support PKCE.
+ """
+ validate_array_value(self, "code_challenge_methods_supported")
+
+ @property
+ def response_modes_supported(self):
+ #: If omitted, the default is ["query", "fragment"]
+ return self.get("response_modes_supported", ["query", "fragment"])
+
+ @property
+ def grant_types_supported(self):
+ #: If omitted, the default value is ["authorization_code", "implicit"]
+ return self.get("grant_types_supported", ["authorization_code", "implicit"])
+
+ @property
+ def token_endpoint_auth_methods_supported(self):
+ #: If omitted, the default is "client_secret_basic"
+ return self.get(
+ "token_endpoint_auth_methods_supported", ["client_secret_basic"]
+ )
+
+ @property
+ def revocation_endpoint_auth_methods_supported(self):
+ #: If omitted, the default is "client_secret_basic"
+ return self.get(
+ "revocation_endpoint_auth_methods_supported", ["client_secret_basic"]
+ )
+
+ @property
+ def introspection_endpoint_auth_methods_supported(self):
+ #: If omitted, the set of supported authentication methods MUST be
+ #: determined by other means
+ #: here, we use "client_secret_basic"
+ return self.get(
+ "introspection_endpoint_auth_methods_supported", ["client_secret_basic"]
+ )
+
+ def validate(self):
+ """Validate all server metadata value."""
+ for key in self.REGISTRY_KEYS:
+ object.__getattribute__(self, f"validate_{key}")()
+
+ def __getattr__(self, key):
+ try:
+ return object.__getattribute__(self, key)
+ except AttributeError as error:
+ if key in self.REGISTRY_KEYS:
+ return self.get(key)
+ raise error
+
+
+def _validate_alg_values(data, key, auth_methods_supported):
+ value = data.get(key)
+ if value and not isinstance(value, list):
+ raise ValueError(f'"{key}" MUST be JSON array')
+
+ auth_methods = set(auth_methods_supported)
+ jwt_auth_methods = {"private_key_jwt", "client_secret_jwt"}
+ if auth_methods & jwt_auth_methods:
+ if not value:
+ raise ValueError(f'"{key}" is required')
+
+ if value and "none" in value:
+ raise ValueError(f'the value "none" MUST NOT be used in "{key}"')
+
+
+def validate_array_value(metadata, key):
+ values = metadata.get(key)
+ if values is not None and not isinstance(values, list):
+ raise ValueError(f'"{key}" MUST be JSON array')
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/well_known.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/well_known.py
new file mode 100644
index 00000000..db5f0fae
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8414/well_known.py
@@ -0,0 +1,22 @@
+from authlib.common.urls import urlparse
+
+
+def get_well_known_url(issuer, external=False, suffix="oauth-authorization-server"):
+ """Get well-known URI with issuer via `Section 3.1`_.
+
+ .. _`Section 3.1`: https://tools.ietf.org/html/rfc8414#section-3.1
+
+ :param issuer: URL of the issuer
+ :param external: return full external url or not
+ :param suffix: well-known URI suffix for RFC8414
+ :return: URL
+ """
+ parsed = urlparse.urlparse(issuer)
+ path = parsed.path
+ if path and path != "/":
+ url_path = f"/.well-known/{suffix}{path}"
+ else:
+ url_path = f"/.well-known/{suffix}"
+ if not external:
+ return url_path
+ return parsed.scheme + "://" + parsed.netloc + url_path
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__init__.py
new file mode 100644
index 00000000..1a449c48
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__init__.py
@@ -0,0 +1,28 @@
+"""authlib.oauth2.rfc8628.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents an implementation of
+OAuth 2.0 Device Authorization Grant.
+
+https://tools.ietf.org/html/rfc8628
+"""
+
+from .device_code import DEVICE_CODE_GRANT_TYPE
+from .device_code import DeviceCodeGrant
+from .endpoint import DeviceAuthorizationEndpoint
+from .errors import AuthorizationPendingError
+from .errors import ExpiredTokenError
+from .errors import SlowDownError
+from .models import DeviceCredentialDict
+from .models import DeviceCredentialMixin
+
+__all__ = [
+ "DeviceAuthorizationEndpoint",
+ "DeviceCodeGrant",
+ "DEVICE_CODE_GRANT_TYPE",
+ "DeviceCredentialMixin",
+ "DeviceCredentialDict",
+ "AuthorizationPendingError",
+ "SlowDownError",
+ "ExpiredTokenError",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..c497fb15
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/device_code.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/device_code.cpython-312.pyc
new file mode 100644
index 00000000..c33d3ac7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/device_code.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/endpoint.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/endpoint.cpython-312.pyc
new file mode 100644
index 00000000..168003e1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/endpoint.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..5668d80e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..daddc6ee
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/device_code.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/device_code.py
new file mode 100644
index 00000000..a38053ba
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/device_code.py
@@ -0,0 +1,185 @@
+import logging
+
+from ..rfc6749 import BaseGrant
+from ..rfc6749 import TokenEndpointMixin
+from ..rfc6749.errors import AccessDeniedError
+from ..rfc6749.errors import InvalidRequestError
+from ..rfc6749.errors import UnauthorizedClientError
+from ..rfc6749.hooks import hooked
+from .errors import AuthorizationPendingError
+from .errors import ExpiredTokenError
+from .errors import SlowDownError
+
+log = logging.getLogger(__name__)
+DEVICE_CODE_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:device_code"
+
+
+class DeviceCodeGrant(BaseGrant, TokenEndpointMixin):
+ """This OAuth 2.0 [RFC6749] protocol extension enables OAuth clients to
+ request user authorization from applications on devices that have
+ limited input capabilities or lack a suitable browser. Such devices
+ include smart TVs, media consoles, picture frames, and printers,
+ which lack an easy input method or a suitable browser required for
+ traditional OAuth interactions. Here is the authorization flow::
+
+ +----------+ +----------------+
+ | |>---(A)-- Client Identifier --->| |
+ | | | |
+ | |<---(B)-- Device Code, ---<| |
+ | | User Code, | |
+ | Device | & Verification URI | |
+ | Client | | |
+ | | [polling] | |
+ | |>---(E)-- Device Code --->| |
+ | | & Client Identifier | |
+ | | | Authorization |
+ | |<---(F)-- Access Token ---<| Server |
+ +----------+ (& Optional Refresh Token) | |
+ v | |
+ : | |
+ (C) User Code & Verification URI | |
+ : | |
+ v | |
+ +----------+ | |
+ | End User | | |
+ | at |<---(D)-- End user reviews --->| |
+ | Browser | authorization request | |
+ +----------+ +----------------+
+
+ This DeviceCodeGrant is the implementation of step (E) and (F).
+
+ (E) While the end user reviews the client's request (step D), the
+ client repeatedly polls the authorization server to find out if
+ the user completed the user authorization step. The client
+ includes the device code and its client identifier.
+
+ (F) The authorization server validates the device code provided by
+ the client and responds with the access token if the client is
+ granted access, an error if they are denied access, or an
+ indication that the client should continue to poll.
+ """
+
+ GRANT_TYPE = DEVICE_CODE_GRANT_TYPE
+ TOKEN_ENDPOINT_AUTH_METHODS = ["client_secret_basic", "client_secret_post", "none"]
+
+ def validate_token_request(self):
+ """After displaying instructions to the user, the client creates an
+ access token request and sends it to the token endpoint with the
+ following parameters:
+
+ grant_type
+ REQUIRED. Value MUST be set to
+ "urn:ietf:params:oauth:grant-type:device_code".
+
+ device_code
+ REQUIRED. The device verification code, "device_code" from the
+ device authorization response.
+
+ client_id
+ REQUIRED if the client is not authenticating with the
+ authorization server as described in Section 3.2.1. of [RFC6749].
+ The client identifier as described in Section 2.2 of [RFC6749].
+
+ For example, the client makes the following HTTPS request::
+
+ POST /token HTTP/1.1
+ Host: server.example.com
+ Content-Type: application/x-www-form-urlencoded
+
+ grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code
+ &device_code=GmRhmhcxhwAzkoEqiMEg_DnyEysNkuNhszIySk9eS
+ &client_id=1406020730
+ """
+ device_code = self.request.payload.data.get("device_code")
+ if not device_code:
+ raise InvalidRequestError("Missing 'device_code' in payload")
+
+ client = self.authenticate_token_endpoint_client()
+ if not client.check_grant_type(self.GRANT_TYPE):
+ raise UnauthorizedClientError(
+ f"The client is not authorized to use 'response_type={self.GRANT_TYPE}'",
+ )
+
+ credential = self.query_device_credential(device_code)
+ if not credential:
+ raise InvalidRequestError("Invalid 'device_code' in payload")
+
+ if credential.get_client_id() != client.get_client_id():
+ raise UnauthorizedClientError()
+
+ user = self.validate_device_credential(credential)
+ self.request.user = user
+ self.request.client = client
+ self.request.credential = credential
+
+ @hooked
+ def create_token_response(self):
+ """If the access token request is valid and authorized, the
+ authorization server issues an access token and optional refresh
+ token.
+ """
+ client = self.request.client
+ scope = self.request.credential.get_scope()
+ token = self.generate_token(
+ user=self.request.user,
+ scope=scope,
+ include_refresh_token=client.check_grant_type("refresh_token"),
+ )
+ log.debug("Issue token %r to %r", token, client)
+ self.save_token(token)
+ return 200, token, self.TOKEN_RESPONSE_HEADER
+
+ def validate_device_credential(self, credential):
+ if credential.is_expired():
+ raise ExpiredTokenError()
+
+ user_code = credential.get_user_code()
+ user_grant = self.query_user_grant(user_code)
+
+ if user_grant is not None:
+ user, approved = user_grant
+ if not approved:
+ raise AccessDeniedError()
+ return user
+
+ if self.should_slow_down(credential):
+ raise SlowDownError()
+
+ raise AuthorizationPendingError()
+
+ def query_device_credential(self, device_code):
+ """Get device credential from previously savings via ``DeviceAuthorizationEndpoint``.
+ Developers MUST implement it in subclass::
+
+ def query_device_credential(self, device_code):
+ return DeviceCredential.get(device_code)
+
+ :param device_code: a string represent the code.
+ :return: DeviceCredential instance
+ """
+ raise NotImplementedError()
+
+ def query_user_grant(self, user_code):
+ """Get user and grant via the given user code. Developers MUST
+ implement it in subclass::
+
+ def query_user_grant(self, user_code):
+ # e.g. we saved user grant info in redis
+ data = redis.get("oauth_user_grant:" + user_code)
+ if not data:
+ return None
+
+ user_id, allowed = data.split()
+ user = User.get(user_id)
+ return user, bool(allowed)
+
+ Note, user grant information is saved by verification endpoint.
+ """
+ raise NotImplementedError()
+
+ def should_slow_down(self, credential):
+ """The authorization request is still pending and polling should
+ continue, but the interval MUST be increased by 5 seconds for this
+ and all subsequent requests.
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/endpoint.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/endpoint.py
new file mode 100644
index 00000000..555715d4
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/endpoint.py
@@ -0,0 +1,172 @@
+from authlib.common.security import generate_token
+from authlib.common.urls import add_params_to_uri
+from authlib.consts import default_json_headers
+
+
+class DeviceAuthorizationEndpoint:
+ """This OAuth 2.0 [RFC6749] protocol extension enables OAuth clients to
+ request user authorization from applications on devices that have
+ limited input capabilities or lack a suitable browser. Such devices
+ include smart TVs, media consoles, picture frames, and printers,
+ which lack an easy input method or a suitable browser required for
+ traditional OAuth interactions. Here is the authorization flow::
+
+ +----------+ +----------------+
+ | |>---(A)-- Client Identifier --->| |
+ | | | |
+ | |<---(B)-- Device Code, ---<| |
+ | | User Code, | |
+ | Device | & Verification URI | |
+ | Client | | |
+ | | [polling] | |
+ | |>---(E)-- Device Code --->| |
+ | | & Client Identifier | |
+ | | | Authorization |
+ | |<---(F)-- Access Token ---<| Server |
+ +----------+ (& Optional Refresh Token) | |
+ v | |
+ : | |
+ (C) User Code & Verification URI | |
+ : | |
+ v | |
+ +----------+ | |
+ | End User | | |
+ | at |<---(D)-- End user reviews --->| |
+ | Browser | authorization request | |
+ +----------+ +----------------+
+
+ This DeviceAuthorizationEndpoint is the implementation of step (A) and (B).
+
+ (A) The client requests access from the authorization server and
+ includes its client identifier in the request.
+
+ (B) The authorization server issues a device code and an end-user
+ code and provides the end-user verification URI.
+ """
+
+ ENDPOINT_NAME = "device_authorization"
+ CLIENT_AUTH_METHODS = ["client_secret_basic", "client_secret_post", "none"]
+
+ #: customize "user_code" type, string or digital
+ USER_CODE_TYPE = "string"
+
+ #: The lifetime in seconds of the "device_code" and "user_code"
+ EXPIRES_IN = 1800
+
+ #: The minimum amount of time in seconds that the client SHOULD
+ #: wait between polling requests to the token endpoint.
+ INTERVAL = 5
+
+ def __init__(self, server):
+ self.server = server
+
+ def __call__(self, request):
+ # make it callable for authorization server
+ # ``create_endpoint_response``
+ return self.create_endpoint_response(request)
+
+ def create_endpoint_request(self, request):
+ return self.server.create_oauth2_request(request)
+
+ def authenticate_client(self, request):
+ """client_id is REQUIRED **if the client is not** authenticating with the
+ authorization server as described in Section 3.2.1. of [RFC6749].
+
+ This means the endpoint support "none" authentication method. In this case,
+ this endpoint's auth methods are:
+
+ - client_secret_basic
+ - client_secret_post
+ - none
+
+ Developers change the value of ``CLIENT_AUTH_METHODS`` in subclass. For
+ instance::
+
+ class MyDeviceAuthorizationEndpoint(DeviceAuthorizationEndpoint):
+ # only support ``client_secret_basic`` auth method
+ CLIENT_AUTH_METHODS = ["client_secret_basic"]
+ """
+ client = self.server.authenticate_client(
+ request, self.CLIENT_AUTH_METHODS, self.ENDPOINT_NAME
+ )
+ request.client = client
+ return client
+
+ def create_endpoint_response(self, request):
+ # https://tools.ietf.org/html/rfc8628#section-3.1
+
+ self.authenticate_client(request)
+ self.server.validate_requested_scope(request.payload.scope)
+
+ device_code = self.generate_device_code()
+ user_code = self.generate_user_code()
+ verification_uri = self.get_verification_uri()
+ verification_uri_complete = add_params_to_uri(
+ verification_uri, [("user_code", user_code)]
+ )
+
+ data = {
+ "device_code": device_code,
+ "user_code": user_code,
+ "verification_uri": verification_uri,
+ "verification_uri_complete": verification_uri_complete,
+ "expires_in": self.EXPIRES_IN,
+ "interval": self.INTERVAL,
+ }
+
+ self.save_device_credential(
+ request.payload.client_id, request.payload.scope, data
+ )
+ return 200, data, default_json_headers
+
+ def generate_user_code(self):
+ """A method to generate ``user_code`` value for device authorization
+ endpoint. This method will generate a random string like MQNA-JPOZ.
+ Developers can rewrite this method to create their own ``user_code``.
+ """
+ # https://tools.ietf.org/html/rfc8628#section-6.1
+ if self.USER_CODE_TYPE == "digital":
+ return create_digital_user_code()
+ return create_string_user_code()
+
+ def generate_device_code(self):
+ """A method to generate ``device_code`` value for device authorization
+ endpoint. This method will generate a random string of 42 characters.
+ Developers can rewrite this method to create their own ``device_code``.
+ """
+ return generate_token(42)
+
+ def get_verification_uri(self):
+ """Define the ``verification_uri`` of device authorization endpoint.
+ Developers MUST implement this method in subclass::
+
+ def get_verification_uri(self):
+ return "https://your-company.com/active"
+ """
+ raise NotImplementedError()
+
+ def save_device_credential(self, client_id, scope, data):
+ """Save device token into database for later use. Developers MUST
+ implement this method in subclass::
+
+ def save_device_credential(self, client_id, scope, data):
+ item = DeviceCredential(client_id=client_id, scope=scope, **data)
+ item.save()
+ """
+ raise NotImplementedError()
+
+
+def create_string_user_code():
+ base = "BCDFGHJKLMNPQRSTVWXZ"
+ return "-".join([generate_token(4, base), generate_token(4, base)])
+
+
+def create_digital_user_code():
+ base = "0123456789"
+ return "-".join(
+ [
+ generate_token(3, base),
+ generate_token(3, base),
+ generate_token(3, base),
+ ]
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/errors.py
new file mode 100644
index 00000000..354306dc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/errors.py
@@ -0,0 +1,30 @@
+from ..rfc6749.errors import OAuth2Error
+
+# https://tools.ietf.org/html/rfc8628#section-3.5
+
+
+class AuthorizationPendingError(OAuth2Error):
+ """The authorization request is still pending as the end user hasn't
+ yet completed the user-interaction steps (Section 3.3).
+ """
+
+ error = "authorization_pending"
+
+
+class SlowDownError(OAuth2Error):
+ """A variant of "authorization_pending", the authorization request is
+ still pending and polling should continue, but the interval MUST
+ be increased by 5 seconds for this and all subsequent requests.
+ """
+
+ error = "slow_down"
+
+
+class ExpiredTokenError(OAuth2Error):
+ """The "device_code" has expired, and the device authorization
+ session has concluded. The client MAY commence a new device
+ authorization request but SHOULD wait for user interaction before
+ restarting to avoid unnecessary polling.
+ """
+
+ error = "expired_token"
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/models.py
new file mode 100644
index 00000000..0be4665f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8628/models.py
@@ -0,0 +1,38 @@
+import time
+
+
+class DeviceCredentialMixin:
+ def get_client_id(self):
+ raise NotImplementedError()
+
+ def get_scope(self):
+ raise NotImplementedError()
+
+ def get_user_code(self):
+ raise NotImplementedError()
+
+ def is_expired(self):
+ raise NotImplementedError()
+
+
+class DeviceCredentialDict(dict, DeviceCredentialMixin):
+ def get_client_id(self):
+ return self["client_id"]
+
+ def get_scope(self):
+ return self.get("scope")
+
+ def get_user_code(self):
+ return self["user_code"]
+
+ def get_nonce(self):
+ return self.get("nonce")
+
+ def get_auth_time(self):
+ return self.get("auth_time")
+
+ def is_expired(self):
+ expires_at = self.get("expires_at")
+ if expires_at:
+ return expires_at < time.time()
+ return False
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8693/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8693/__init__.py
new file mode 100644
index 00000000..8ea6c5f6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8693/__init__.py
@@ -0,0 +1,8 @@
+"""authlib.oauth2.rfc8693.
+~~~~~~~~~~~~~~~~~~~~~~
+
+This module represents an implementation of
+OAuth 2.0 Token Exchange.
+
+https://tools.ietf.org/html/rfc8693
+"""
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8693/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8693/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..273158ba
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc8693/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__init__.py
new file mode 100644
index 00000000..2d1d87d8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__init__.py
@@ -0,0 +1,11 @@
+from .introspection import JWTIntrospectionEndpoint
+from .revocation import JWTRevocationEndpoint
+from .token import JWTBearerTokenGenerator
+from .token_validator import JWTBearerTokenValidator
+
+__all__ = [
+ "JWTBearerTokenGenerator",
+ "JWTBearerTokenValidator",
+ "JWTIntrospectionEndpoint",
+ "JWTRevocationEndpoint",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..f4ea7937
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/claims.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/claims.cpython-312.pyc
new file mode 100644
index 00000000..5db5de19
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/claims.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/introspection.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/introspection.cpython-312.pyc
new file mode 100644
index 00000000..9edafb81
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/introspection.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/revocation.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/revocation.cpython-312.pyc
new file mode 100644
index 00000000..773dc4e0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/revocation.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/token.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/token.cpython-312.pyc
new file mode 100644
index 00000000..8a7babe0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/token.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/token_validator.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/token_validator.cpython-312.pyc
new file mode 100644
index 00000000..8f7e5853
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/__pycache__/token_validator.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/claims.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/claims.py
new file mode 100644
index 00000000..645ba37b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/claims.py
@@ -0,0 +1,64 @@
+from authlib.jose.errors import InvalidClaimError
+from authlib.jose.rfc7519 import JWTClaims
+
+
+class JWTAccessTokenClaims(JWTClaims):
+ REGISTERED_CLAIMS = JWTClaims.REGISTERED_CLAIMS + [
+ "client_id",
+ "auth_time",
+ "acr",
+ "amr",
+ "scope",
+ "groups",
+ "roles",
+ "entitlements",
+ ]
+
+ def validate(self, **kwargs):
+ self.validate_typ()
+
+ super().validate(**kwargs)
+ self.validate_client_id()
+ self.validate_auth_time()
+ self.validate_acr()
+ self.validate_amr()
+ self.validate_scope()
+ self.validate_groups()
+ self.validate_roles()
+ self.validate_entitlements()
+
+ def validate_typ(self):
+ # The resource server MUST verify that the 'typ' header value is 'at+jwt'
+ # or 'application/at+jwt' and reject tokens carrying any other value.
+ # 'typ' is not a required claim, so we don't raise an error if it's missing.
+ typ = self.header.get("typ")
+ if typ and typ.lower() not in ("at+jwt", "application/at+jwt"):
+ raise InvalidClaimError("typ")
+
+ def validate_client_id(self):
+ return self._validate_claim_value("client_id")
+
+ def validate_auth_time(self):
+ auth_time = self.get("auth_time")
+ if auth_time and not isinstance(auth_time, (int, float)):
+ raise InvalidClaimError("auth_time")
+
+ def validate_acr(self):
+ return self._validate_claim_value("acr")
+
+ def validate_amr(self):
+ amr = self.get("amr")
+ if amr and not isinstance(self["amr"], list):
+ raise InvalidClaimError("amr")
+
+ def validate_scope(self):
+ return self._validate_claim_value("scope")
+
+ def validate_groups(self):
+ return self._validate_claim_value("groups")
+
+ def validate_roles(self):
+ return self._validate_claim_value("roles")
+
+ def validate_entitlements(self):
+ return self._validate_claim_value("entitlements")
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/introspection.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/introspection.py
new file mode 100644
index 00000000..2842e428
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/introspection.py
@@ -0,0 +1,127 @@
+from authlib.common.errors import ContinueIteration
+from authlib.consts import default_json_headers
+from authlib.jose.errors import ExpiredTokenError
+from authlib.jose.errors import InvalidClaimError
+from authlib.oauth2.rfc6750.errors import InvalidTokenError
+from authlib.oauth2.rfc9068.token_validator import JWTBearerTokenValidator
+
+from ..rfc7662 import IntrospectionEndpoint
+
+
+class JWTIntrospectionEndpoint(IntrospectionEndpoint):
+ r"""JWTIntrospectionEndpoint inherits from :ref:`specs/rfc7662`
+ :class:`~authlib.oauth2.rfc7662.IntrospectionEndpoint` and implements the machinery
+ to automatically process the JWT access tokens.
+
+ :param issuer: The issuer identifier for which tokens will be introspected.
+
+ :param \\*\\*kwargs: Other parameters are inherited from
+ :class:`~authlib.oauth2.rfc7662.introspection.IntrospectionEndpoint`.
+
+ ::
+
+ class MyJWTAccessTokenIntrospectionEndpoint(JWTIntrospectionEndpoint):
+ def get_jwks(self): ...
+
+ def get_username(self, user_id): ...
+
+
+ # endpoint dedicated to JWT access token introspection
+ authorization_server.register_endpoint(
+ MyJWTAccessTokenIntrospectionEndpoint(
+ issuer="https://authorization-server.example.org",
+ )
+ )
+
+ # another endpoint dedicated to refresh token introspection
+ authorization_server.register_endpoint(MyRefreshTokenIntrospectionEndpoint)
+
+ """
+
+ #: Endpoint name to be registered
+ ENDPOINT_NAME = "introspection"
+
+ def __init__(self, issuer, server=None, *args, **kwargs):
+ super().__init__(*args, server=server, **kwargs)
+ self.issuer = issuer
+
+ def create_endpoint_response(self, request):
+ """"""
+ # The authorization server first validates the client credentials
+ client = self.authenticate_endpoint_client(request)
+
+ # then verifies whether the token was issued to the client making
+ # the revocation request
+ token = self.authenticate_token(request, client)
+
+ # the authorization server invalidates the token
+ body = self.create_introspection_payload(token)
+ return 200, body, default_json_headers
+
+ def authenticate_token(self, request, client):
+ """"""
+ self.check_params(request, client)
+
+ # do not attempt to decode refresh_tokens
+ if request.form.get("token_type_hint") not in ("access_token", None):
+ raise ContinueIteration()
+
+ validator = JWTBearerTokenValidator(issuer=self.issuer, resource_server=None)
+ validator.get_jwks = self.get_jwks
+ try:
+ token = validator.authenticate_token(request.form["token"])
+
+ # if the token is not a JWT, fall back to the regular flow
+ except InvalidTokenError as exc:
+ raise ContinueIteration() from exc
+
+ if token and self.check_permission(token, client, request):
+ return token
+
+ def create_introspection_payload(self, token):
+ if not token:
+ return {"active": False}
+
+ try:
+ token.validate()
+ except ExpiredTokenError:
+ return {"active": False}
+ except InvalidClaimError as exc:
+ if exc.claim_name == "iss":
+ raise ContinueIteration() from exc
+ raise InvalidTokenError() from exc
+
+ payload = {
+ "active": True,
+ "token_type": "Bearer",
+ "client_id": token["client_id"],
+ "scope": token["scope"],
+ "sub": token["sub"],
+ "aud": token["aud"],
+ "iss": token["iss"],
+ "exp": token["exp"],
+ "iat": token["iat"],
+ }
+
+ if username := self.get_username(token["sub"]):
+ payload["username"] = username
+
+ return payload
+
+ def get_jwks(self):
+ """Return the JWKs that will be used to check the JWT access token signature.
+ Developers MUST re-implement this method::
+
+ def get_jwks(self):
+ return load_jwks("jwks.json")
+ """
+ raise NotImplementedError()
+
+ def get_username(self, user_id: str) -> str:
+ """Returns an username from a user ID.
+ Developers MAY re-implement this method::
+
+ def get_username(self, user_id):
+ return User.get(id=user_id).username
+ """
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/revocation.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/revocation.py
new file mode 100644
index 00000000..62e45c2c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/revocation.py
@@ -0,0 +1,74 @@
+from authlib.common.errors import ContinueIteration
+from authlib.oauth2.rfc6750.errors import InvalidTokenError
+from authlib.oauth2.rfc9068.token_validator import JWTBearerTokenValidator
+
+from ..rfc6749 import UnsupportedTokenTypeError
+from ..rfc7009 import RevocationEndpoint
+
+
+class JWTRevocationEndpoint(RevocationEndpoint):
+ r"""JWTRevocationEndpoint inherits from `RFC7009`_
+ :class:`~authlib.oauth2.rfc7009.RevocationEndpoint`.
+
+ The JWT access tokens cannot be revoked.
+ If the submitted token is a JWT access token, then revocation returns
+ a `invalid_token_error`.
+
+ :param issuer: The issuer identifier.
+
+ :param \\*\\*kwargs: Other parameters are inherited from
+ :class:`~authlib.oauth2.rfc7009.RevocationEndpoint`.
+
+ Plain text access tokens and other kind of tokens such as refresh_tokens
+ will be ignored by this endpoint and passed to the next revocation endpoint::
+
+ class MyJWTAccessTokenRevocationEndpoint(JWTRevocationEndpoint):
+ def get_jwks(self): ...
+
+
+ # endpoint dedicated to JWT access token revokation
+ authorization_server.register_endpoint(
+ MyJWTAccessTokenRevocationEndpoint(
+ issuer="https://authorization-server.example.org",
+ )
+ )
+
+ # another endpoint dedicated to refresh token revokation
+ authorization_server.register_endpoint(MyRefreshTokenRevocationEndpoint)
+
+ .. _RFC7009: https://tools.ietf.org/html/rfc7009
+ """
+
+ def __init__(self, issuer, server=None, *args, **kwargs):
+ super().__init__(*args, server=server, **kwargs)
+ self.issuer = issuer
+
+ def authenticate_token(self, request, client):
+ """"""
+ self.check_params(request, client)
+
+ # do not attempt to revoke refresh_tokens
+ if request.form.get("token_type_hint") not in ("access_token", None):
+ raise ContinueIteration()
+
+ validator = JWTBearerTokenValidator(issuer=self.issuer, resource_server=None)
+ validator.get_jwks = self.get_jwks
+
+ try:
+ validator.authenticate_token(request.form["token"])
+
+ # if the token is not a JWT, fall back to the regular flow
+ except InvalidTokenError as exc:
+ raise ContinueIteration() from exc
+
+ # JWT access token cannot be revoked
+ raise UnsupportedTokenTypeError()
+
+ def get_jwks(self):
+ """Return the JWKs that will be used to check the JWT access token signature.
+ Developers MUST re-implement this method::
+
+ def get_jwks(self):
+ return load_jwks("jwks.json")
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/token.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/token.py
new file mode 100644
index 00000000..db702a68
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/token.py
@@ -0,0 +1,218 @@
+import time
+from typing import Optional
+from typing import Union
+
+from authlib.common.security import generate_token
+from authlib.jose import jwt
+from authlib.oauth2.rfc6750.token import BearerTokenGenerator
+
+
+class JWTBearerTokenGenerator(BearerTokenGenerator):
+ r"""A JWT formatted access token generator.
+
+ :param issuer: The issuer identifier. Will appear in the JWT ``iss`` claim.
+
+ :param \\*\\*kwargs: Other parameters are inherited from
+ :class:`~authlib.oauth2.rfc6750.token.BearerTokenGenerator`.
+
+ This token generator can be registered into the authorization server::
+
+ class MyJWTBearerTokenGenerator(JWTBearerTokenGenerator):
+ def get_jwks(self): ...
+
+ def get_extra_claims(self, client, grant_type, user, scope): ...
+
+
+ authorization_server.register_token_generator(
+ "default",
+ MyJWTBearerTokenGenerator(
+ issuer="https://authorization-server.example.org"
+ ),
+ )
+ """
+
+ def __init__(
+ self,
+ issuer,
+ alg="RS256",
+ refresh_token_generator=None,
+ expires_generator=None,
+ ):
+ super().__init__(
+ self.access_token_generator, refresh_token_generator, expires_generator
+ )
+ self.issuer = issuer
+ self.alg = alg
+
+ def get_jwks(self):
+ """Return the JWKs that will be used to sign the JWT access token.
+ Developers MUST re-implement this method::
+
+ def get_jwks(self):
+ return load_jwks("jwks.json")
+ """
+ raise NotImplementedError()
+
+ def get_extra_claims(self, client, grant_type, user, scope):
+ """Return extra claims to add in the JWT access token. Developers MAY
+ re-implement this method to add identity claims like the ones in
+ :ref:`specs/oidc` ID Token, or any other arbitrary claims::
+
+ def get_extra_claims(self, client, grant_type, user, scope):
+ return generate_user_info(user, scope)
+ """
+ return {}
+
+ def get_audiences(self, client, user, scope) -> Union[str, list[str]]:
+ """Return the audience for the token. By default this simply returns
+ the client ID. Developers MAY re-implement this method to add extra
+ audiences::
+
+ def get_audiences(self, client, user, scope):
+ return [
+ client.get_client_id(),
+ resource_server.get_id(),
+ ]
+ """
+ return client.get_client_id()
+
+ def get_acr(self, user) -> Optional[str]:
+ """Authentication Context Class Reference.
+ Returns a user-defined case sensitive string indicating the class of
+ authentication the used performed. Token audience may refuse to give access to
+ some resources if some ACR criteria are not met.
+ :ref:`specs/oidc` defines one special value: ``0`` means that the user
+ authentication did not respect `ISO29115`_ level 1, and will be refused monetary
+ operations. Developers MAY re-implement this method::
+
+ def get_acr(self, user):
+ if user.insecure_session():
+ return "0"
+ return "urn:mace:incommon:iap:silver"
+
+ .. _ISO29115: https://www.iso.org/standard/45138.html
+ """
+ return None
+
+ def get_auth_time(self, user) -> Optional[int]:
+ """User authentication time.
+ Time when the End-User authentication occurred. Its value is a JSON number
+ representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC
+ until the date/time. Developers MAY re-implement this method::
+
+ def get_auth_time(self, user):
+ return datetime.timestamp(user.get_auth_time())
+ """
+ return None
+
+ def get_amr(self, user) -> Optional[list[str]]:
+ """Authentication Methods References.
+ Defined by :ref:`specs/oidc` as an option list of user-defined case-sensitive
+ strings indication which authentication methods have been used to authenticate
+ the user. Developers MAY re-implement this method::
+
+ def get_amr(self, user):
+ return ["2FA"] if user.has_2fa_enabled() else []
+ """
+ return None
+
+ def get_jti(self, client, grant_type, user, scope) -> str:
+ """JWT ID.
+ Create an unique identifier for the token. Developers MAY re-implement
+ this method::
+
+ def get_jti(self, client, grant_type, user scope):
+ return generate_random_string(16)
+ """
+ return generate_token(16)
+
+ def access_token_generator(self, client, grant_type, user, scope):
+ now = int(time.time())
+ expires_in = now + self._get_expires_in(client, grant_type)
+
+ token_data = {
+ "iss": self.issuer,
+ "exp": expires_in,
+ "client_id": client.get_client_id(),
+ "iat": now,
+ "jti": self.get_jti(client, grant_type, user, scope),
+ "scope": scope,
+ }
+
+ # In cases of access tokens obtained through grants where a resource owner is
+ # involved, such as the authorization code grant, the value of 'sub' SHOULD
+ # correspond to the subject identifier of the resource owner.
+
+ if user:
+ token_data["sub"] = user.get_user_id()
+
+ # In cases of access tokens obtained through grants where no resource owner is
+ # involved, such as the client credentials grant, the value of 'sub' SHOULD
+ # correspond to an identifier the authorization server uses to indicate the
+ # client application.
+
+ else:
+ token_data["sub"] = client.get_client_id()
+
+ # If the request includes a 'resource' parameter (as defined in [RFC8707]), the
+ # resulting JWT access token 'aud' claim SHOULD have the same value as the
+ # 'resource' parameter in the request.
+
+ # TODO: Implement this with RFC8707
+ if False: # pragma: no cover
+ ...
+
+ # If the request does not include a 'resource' parameter, the authorization
+ # server MUST use a default resource indicator in the 'aud' claim. If a 'scope'
+ # parameter is present in the request, the authorization server SHOULD use it to
+ # infer the value of the default resource indicator to be used in the 'aud'
+ # claim. The mechanism through which scopes are associated with default resource
+ # indicator values is outside the scope of this specification.
+
+ else:
+ token_data["aud"] = self.get_audiences(client, user, scope)
+
+ # If the values in the 'scope' parameter refer to different default resource
+ # indicator values, the authorization server SHOULD reject the request with
+ # 'invalid_scope' as described in Section 4.1.2.1 of [RFC6749].
+ # TODO: Implement this with RFC8707
+
+ if auth_time := self.get_auth_time(user):
+ token_data["auth_time"] = auth_time
+
+ # The meaning and processing of acr Claim Values is out of scope for this
+ # specification.
+
+ if acr := self.get_acr(user):
+ token_data["acr"] = acr
+
+ # The definition of particular values to be used in the amr Claim is beyond the
+ # scope of this specification.
+
+ if amr := self.get_amr(user):
+ token_data["amr"] = amr
+
+ # Authorization servers MAY return arbitrary attributes not defined in any
+ # existing specification, as long as the corresponding claim names are collision
+ # resistant or the access tokens are meant to be used only within a private
+ # subsystem. Please refer to Sections 4.2 and 4.3 of [RFC7519] for details.
+
+ token_data.update(self.get_extra_claims(client, grant_type, user, scope))
+
+ # This specification registers the 'application/at+jwt' media type, which can
+ # be used to indicate that the content is a JWT access token. JWT access tokens
+ # MUST include this media type in the 'typ' header parameter to explicitly
+ # declare that the JWT represents an access token complying with this profile.
+ # Per the definition of 'typ' in Section 4.1.9 of [RFC7515], it is RECOMMENDED
+ # that the 'application/' prefix be omitted. Therefore, the 'typ' value used
+ # SHOULD be 'at+jwt'.
+
+ header = {"alg": self.alg, "typ": "at+jwt"}
+
+ access_token = jwt.encode(
+ header,
+ token_data,
+ key=self.get_jwks(),
+ check=False,
+ )
+ return access_token.decode()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/token_validator.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/token_validator.py
new file mode 100644
index 00000000..51105c01
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9068/token_validator.py
@@ -0,0 +1,163 @@
+"""authlib.oauth2.rfc9068.token_validator.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Implementation of Validating JWT Access Tokens per `Section 4`_.
+
+.. _`Section 7`: https://www.rfc-editor.org/rfc/rfc9068.html#name-validating-jwt-access-token
+"""
+
+from authlib.jose import jwt
+from authlib.jose.errors import DecodeError
+from authlib.jose.errors import JoseError
+from authlib.oauth2.rfc6750.errors import InsufficientScopeError
+from authlib.oauth2.rfc6750.errors import InvalidTokenError
+from authlib.oauth2.rfc6750.validator import BearerTokenValidator
+
+from .claims import JWTAccessTokenClaims
+
+
+class JWTBearerTokenValidator(BearerTokenValidator):
+ """JWTBearerTokenValidator can protect your resource server endpoints.
+
+ :param issuer: The issuer from which tokens will be accepted.
+ :param resource_server: An identifier for the current resource server,
+ which must appear in the JWT ``aud`` claim.
+
+ Developers needs to implement the missing methods::
+
+ class MyJWTBearerTokenValidator(JWTBearerTokenValidator):
+ def get_jwks(self): ...
+
+
+ require_oauth = ResourceProtector()
+ require_oauth.register_token_validator(
+ MyJWTBearerTokenValidator(
+ issuer="https://authorization-server.example.org",
+ resource_server="https://resource-server.example.org",
+ )
+ )
+
+ You can then protect resources depending on the JWT `scope`, `groups`,
+ `roles` or `entitlements` claims::
+
+ @require_oauth(
+ scope="profile",
+ groups="admins",
+ roles="student",
+ entitlements="captain",
+ )
+ def resource_endpoint(): ...
+ """
+
+ def __init__(self, issuer, resource_server, *args, **kwargs):
+ self.issuer = issuer
+ self.resource_server = resource_server
+ super().__init__(*args, **kwargs)
+
+ def get_jwks(self):
+ """Return the JWKs that will be used to check the JWT access token signature.
+ Developers MUST re-implement this method. Typically the JWKs are statically
+ stored in the resource server configuration, or dynamically downloaded and
+ cached using :ref:`specs/rfc8414`::
+
+ def get_jwks(self):
+ if "jwks" in cache:
+ return cache.get("jwks")
+
+ server_metadata = get_server_metadata(self.issuer)
+ jwks_uri = server_metadata.get("jwks_uri")
+ cache["jwks"] = requests.get(jwks_uri).json()
+ return cache["jwks"]
+ """
+ raise NotImplementedError()
+
+ def validate_iss(self, claims, iss: "str") -> bool:
+ # The issuer identifier for the authorization server (which is typically
+ # obtained during discovery) MUST exactly match the value of the 'iss'
+ # claim.
+ return iss == self.issuer
+
+ def authenticate_token(self, token_string):
+ """"""
+ # empty docstring avoids to display the irrelevant parent docstring
+
+ claims_options = {
+ "iss": {"essential": True, "validate": self.validate_iss},
+ "exp": {"essential": True},
+ "aud": {"essential": True, "value": self.resource_server},
+ "sub": {"essential": True},
+ "client_id": {"essential": True},
+ "iat": {"essential": True},
+ "jti": {"essential": True},
+ "auth_time": {"essential": False},
+ "acr": {"essential": False},
+ "amr": {"essential": False},
+ "scope": {"essential": False},
+ "groups": {"essential": False},
+ "roles": {"essential": False},
+ "entitlements": {"essential": False},
+ }
+ jwks = self.get_jwks()
+
+ # If the JWT access token is encrypted, decrypt it using the keys and algorithms
+ # that the resource server specified during registration. If encryption was
+ # negotiated with the authorization server at registration time and the incoming
+ # JWT access token is not encrypted, the resource server SHOULD reject it.
+
+ # The resource server MUST validate the signature of all incoming JWT access
+ # tokens according to [RFC7515] using the algorithm specified in the JWT 'alg'
+ # Header Parameter. The resource server MUST reject any JWT in which the value
+ # of 'alg' is 'none'. The resource server MUST use the keys provided by the
+ # authorization server.
+ try:
+ return jwt.decode(
+ token_string,
+ key=jwks,
+ claims_cls=JWTAccessTokenClaims,
+ claims_options=claims_options,
+ )
+ except DecodeError as exc:
+ raise InvalidTokenError(
+ realm=self.realm, extra_attributes=self.extra_attributes
+ ) from exc
+
+ def validate_token(
+ self, token, scopes, request, groups=None, roles=None, entitlements=None
+ ):
+ """"""
+ # empty docstring avoids to display the irrelevant parent docstring
+ try:
+ token.validate()
+ except JoseError as exc:
+ raise InvalidTokenError(
+ realm=self.realm, extra_attributes=self.extra_attributes
+ ) from exc
+
+ # If an authorization request includes a scope parameter, the corresponding
+ # issued JWT access token SHOULD include a 'scope' claim as defined in Section
+ # 4.2 of [RFC8693]. All the individual scope strings in the 'scope' claim MUST
+ # have meaning for the resources indicated in the 'aud' claim. See Section 5 for
+ # more considerations about the relationship between scope strings and resources
+ # indicated by the 'aud' claim.
+
+ if self.scope_insufficient(token.get("scope", []), scopes):
+ raise InsufficientScopeError()
+
+ # Many authorization servers embed authorization attributes that go beyond the
+ # delegated scenarios described by [RFC7519] in the access tokens they issue.
+ # Typical examples include resource owner memberships in roles and groups that
+ # are relevant to the resource being accessed, entitlements assigned to the
+ # resource owner for the targeted resource that the authorization server knows
+ # about, and so on. An authorization server wanting to include such attributes
+ # in a JWT access token SHOULD use the 'groups', 'roles', and 'entitlements'
+ # attributes of the 'User' resource schema defined by Section 4.1.2 of
+ # [RFC7643]) as claim types.
+
+ if self.scope_insufficient(token.get("groups"), groups):
+ raise InvalidTokenError()
+
+ if self.scope_insufficient(token.get("roles"), roles):
+ raise InvalidTokenError()
+
+ if self.scope_insufficient(token.get("entitlements"), entitlements):
+ raise InvalidTokenError()
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__init__.py
new file mode 100644
index 00000000..02194770
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__init__.py
@@ -0,0 +1,9 @@
+from .authorization_server import JWTAuthenticationRequest
+from .discovery import AuthorizationServerMetadata
+from .registration import ClientMetadataClaims
+
+__all__ = [
+ "AuthorizationServerMetadata",
+ "JWTAuthenticationRequest",
+ "ClientMetadataClaims",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..d4161ca5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/authorization_server.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/authorization_server.cpython-312.pyc
new file mode 100644
index 00000000..9370ac7a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/authorization_server.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/discovery.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/discovery.cpython-312.pyc
new file mode 100644
index 00000000..c7ce3537
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/discovery.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..8f8f552e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/registration.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/registration.cpython-312.pyc
new file mode 100644
index 00000000..d47c8d92
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/__pycache__/registration.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/authorization_server.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/authorization_server.py
new file mode 100644
index 00000000..292d51d2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/authorization_server.py
@@ -0,0 +1,255 @@
+from authlib.jose import jwt
+from authlib.jose.errors import JoseError
+
+from ..rfc6749 import AuthorizationServer
+from ..rfc6749 import ClientMixin
+from ..rfc6749 import InvalidRequestError
+from ..rfc6749.authenticate_client import _validate_client
+from ..rfc6749.requests import BasicOAuth2Payload
+from ..rfc6749.requests import OAuth2Request
+from .errors import InvalidRequestObjectError
+from .errors import InvalidRequestUriError
+from .errors import RequestNotSupportedError
+from .errors import RequestUriNotSupportedError
+
+
+class JWTAuthenticationRequest:
+ """Authorization server extension implementing the support
+ for JWT secured authentication request, as defined in :rfc:`RFC9101 <9101>`.
+
+ :param support_request: Whether to enable support for the ``request`` parameter.
+ :param support_request_uri: Whether to enable support for the ``request_uri`` parameter.
+
+ This extension is intended to be inherited and registered into the authorization server::
+
+ class JWTAuthenticationRequest(rfc9101.JWTAuthenticationRequest):
+ def resolve_client_public_key(self, client: ClientMixin):
+ return get_jwks_for_client(client)
+
+ def get_request_object(self, request_uri: str):
+ try:
+ return requests.get(request_uri).text
+ except requests.Exception:
+ return None
+
+ def get_server_metadata(self):
+ return {
+ "issuer": ...,
+ "authorization_endpoint": ...,
+ "require_signed_request_object": ...,
+ }
+
+ def get_client_require_signed_request_object(self, client: ClientMixin):
+ return client.require_signed_request_object
+
+
+ authorization_server.register_extension(JWTAuthenticationRequest())
+ """
+
+ def __init__(self, support_request: bool = True, support_request_uri: bool = True):
+ self.support_request = support_request
+ self.support_request_uri = support_request_uri
+
+ def __call__(self, authorization_server: AuthorizationServer):
+ authorization_server.register_hook(
+ "before_get_authorization_grant", self.parse_authorization_request
+ )
+
+ def parse_authorization_request(
+ self, authorization_server: AuthorizationServer, request: OAuth2Request
+ ):
+ client = _validate_client(
+ authorization_server.query_client, request.payload.client_id
+ )
+ if not self._shoud_proceed_with_request_object(
+ authorization_server, request, client
+ ):
+ return
+
+ raw_request_object = self._get_raw_request_object(authorization_server, request)
+ request_object = self._decode_request_object(
+ request, client, raw_request_object
+ )
+ payload = BasicOAuth2Payload(request_object)
+ request.payload = payload
+
+ def _shoud_proceed_with_request_object(
+ self,
+ authorization_server: AuthorizationServer,
+ request: OAuth2Request,
+ client: ClientMixin,
+ ) -> bool:
+ if "request" in request.payload.data and "request_uri" in request.payload.data:
+ raise InvalidRequestError(
+ "The 'request' and 'request_uri' parameters are mutually exclusive.",
+ state=request.payload.state,
+ )
+
+ if "request" in request.payload.data:
+ if not self.support_request:
+ raise RequestNotSupportedError(state=request.payload.state)
+ return True
+
+ if "request_uri" in request.payload.data:
+ if not self.support_request_uri:
+ raise RequestUriNotSupportedError(state=request.payload.state)
+ return True
+
+ # When the value of it [require_signed_request_object] as client metadata is true,
+ # then the server MUST reject the authorization request
+ # from the client that does not conform to this specification.
+ if self.get_client_require_signed_request_object(client):
+ raise InvalidRequestError(
+ "Authorization requests for this client must use signed request objects.",
+ state=request.payload.state,
+ )
+
+ # When the value of it [require_signed_request_object] as server metadata is true,
+ # then the server MUST reject the authorization request
+ # from any client that does not conform to this specification.
+ metadata = self.get_server_metadata()
+ if metadata and metadata.get("require_signed_request_object", False):
+ raise InvalidRequestError(
+ "Authorization requests for this server must use signed request objects.",
+ state=request.payload.state,
+ )
+
+ return False
+
+ def _get_raw_request_object(
+ self, authorization_server: AuthorizationServer, request: OAuth2Request
+ ) -> str:
+ if "request_uri" in request.payload.data:
+ raw_request_object = self.get_request_object(
+ request.payload.data["request_uri"]
+ )
+ if not raw_request_object:
+ raise InvalidRequestUriError(state=request.payload.state)
+
+ else:
+ raw_request_object = request.payload.data["request"]
+
+ return raw_request_object
+
+ def _decode_request_object(
+ self, request, client: ClientMixin, raw_request_object: str
+ ):
+ jwks = self.resolve_client_public_key(client)
+
+ try:
+ request_object = jwt.decode(raw_request_object, jwks)
+ request_object.validate()
+
+ except JoseError as error:
+ raise InvalidRequestObjectError(
+ description=error.description or InvalidRequestObjectError.description,
+ state=request.payload.state,
+ ) from error
+
+ # It MUST also reject the request if the Request Object uses an
+ # alg value of none when this server metadata value is true.
+ # If omitted, the default value is false.
+ if (
+ self.get_client_require_signed_request_object(client)
+ and request_object.header["alg"] == "none"
+ ):
+ raise InvalidRequestError(
+ "Authorization requests for this client must use signed request objects.",
+ state=request.payload.state,
+ )
+
+ # It MUST also reject the request if the Request Object uses an
+ # alg value of none. If omitted, the default value is false.
+ metadata = self.get_server_metadata()
+ if (
+ metadata
+ and metadata.get("require_signed_request_object", False)
+ and request_object.header["alg"] == "none"
+ ):
+ raise InvalidRequestError(
+ "Authorization requests for this server must use signed request objects.",
+ state=request.payload.state,
+ )
+
+ # The client ID values in the client_id request parameter and in
+ # the Request Object client_id claim MUST be identical.
+ if request_object["client_id"] != request.payload.client_id:
+ raise InvalidRequestError(
+ "The 'client_id' claim from the request parameters "
+ "and the request object claims don't match.",
+ state=request.payload.state,
+ )
+
+ # The Request Object MAY be sent by value, as described in Section 5.1,
+ # or by reference, as described in Section 5.2. request and
+ # request_uri parameters MUST NOT be included in Request Objects.
+ if "request" in request_object or "request_uri" in request_object:
+ raise InvalidRequestError(
+ "The 'request' and 'request_uri' parameters must not be included in the request object.",
+ state=request.payload.state,
+ )
+
+ return request_object
+
+ def get_request_object(self, request_uri: str):
+ """Download the request object at ``request_uri``.
+
+ This method must be implemented if the ``request_uri`` parameter is supported::
+
+ class JWTAuthenticationRequest(rfc9101.JWTAuthenticationRequest):
+ def get_request_object(self, request_uri: str):
+ try:
+ return requests.get(request_uri).text
+ except requests.Exception:
+ return None
+ """
+ raise NotImplementedError()
+
+ def resolve_client_public_keys(self, client: ClientMixin):
+ """Resolve the client public key for verifying the JWT signature.
+ A client may have many public keys, in this case, we can retrieve it
+ via ``kid`` value in headers. Developers MUST implement this method::
+
+ class JWTAuthenticationRequest(rfc9101.JWTAuthenticationRequest):
+ def resolve_client_public_key(self, client):
+ if client.jwks_uri:
+ return requests.get(client.jwks_uri).json
+
+ return client.jwks
+ """
+ raise NotImplementedError()
+
+ def get_server_metadata(self) -> dict:
+ """Return server metadata which includes supported grant types,
+ response types and etc.
+
+ When the ``require_signed_request_object`` claim is :data:`True`,
+ all clients require that authorization requests
+ use request objects, and an error will be returned when the authorization
+ request payload is passed in the request body or query string::
+
+ class JWTAuthenticationRequest(rfc9101.JWTAuthenticationRequest):
+ def get_server_metadata(self):
+ return {
+ "issuer": ...,
+ "authorization_endpoint": ...,
+ "require_signed_request_object": ...,
+ }
+
+ """
+ return {} # pragma: no cover
+
+ def get_client_require_signed_request_object(self, client: ClientMixin) -> bool:
+ """Return the 'require_signed_request_object' client metadata.
+
+ When :data:`True`, the client requires that authorization requests
+ use request objects, and an error will be returned when the authorization
+ request payload is passed in the request body or query string::
+
+ class JWTAuthenticationRequest(rfc9101.JWTAuthenticationRequest):
+ def get_client_require_signed_request_object(self, client):
+ return client.require_signed_request_object
+
+ If not implemented, the value is considered as :data:`False`.
+ """
+ return False # pragma: no cover
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/discovery.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/discovery.py
new file mode 100644
index 00000000..b7331e24
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/discovery.py
@@ -0,0 +1,9 @@
+from authlib.oidc.discovery.models import _validate_boolean_value
+
+
+class AuthorizationServerMetadata(dict):
+ REGISTRY_KEYS = ["require_signed_request_object"]
+
+ def validate_require_signed_request_object(self):
+ """Indicates where authorization request needs to be protected as Request Object and provided through either request or request_uri parameter."""
+ _validate_boolean_value(self, "require_signed_request_object")
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/errors.py
new file mode 100644
index 00000000..3feeeaab
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/errors.py
@@ -0,0 +1,34 @@
+from ..base import OAuth2Error
+
+__all__ = [
+ "InvalidRequestUriError",
+ "InvalidRequestObjectError",
+ "RequestNotSupportedError",
+ "RequestUriNotSupportedError",
+]
+
+
+class InvalidRequestUriError(OAuth2Error):
+ error = "invalid_request_uri"
+ description = "The request_uri in the authorization request returns an error or contains invalid data."
+ status_code = 400
+
+
+class InvalidRequestObjectError(OAuth2Error):
+ error = "invalid_request_object"
+ description = "The request parameter contains an invalid Request Object."
+ status_code = 400
+
+
+class RequestNotSupportedError(OAuth2Error):
+ error = "request_not_supported"
+ description = (
+ "The authorization server does not support the use of the request parameter."
+ )
+ status_code = 400
+
+
+class RequestUriNotSupportedError(OAuth2Error):
+ error = "request_uri_not_supported"
+ description = "The authorization server does not support the use of the request_uri parameter."
+ status_code = 400
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/registration.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/registration.py
new file mode 100644
index 00000000..50cc2097
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9101/registration.py
@@ -0,0 +1,44 @@
+from authlib.jose import BaseClaims
+from authlib.jose.errors import InvalidClaimError
+
+
+class ClientMetadataClaims(BaseClaims):
+ """Additional client metadata can be used with :ref:`specs/rfc7591` and :ref:`specs/rfc7592` endpoints.
+
+ This can be used with::
+
+ server.register_endpoint(
+ ClientRegistrationEndpoint(
+ claims_classes=[
+ rfc7591.ClientMetadataClaims,
+ rfc9101.ClientMetadataClaims,
+ ]
+ )
+ )
+
+ server.register_endpoint(
+ ClientRegistrationEndpoint(
+ claims_classes=[
+ rfc7591.ClientMetadataClaims,
+ rfc9101.ClientMetadataClaims,
+ ]
+ )
+ )
+
+ """
+
+ REGISTERED_CLAIMS = [
+ "require_signed_request_object",
+ ]
+
+ def validate(self):
+ self._validate_essential_claims()
+ self.validate_require_signed_request_object()
+
+ def validate_require_signed_request_object(self):
+ self.setdefault("require_signed_request_object", False)
+
+ if not isinstance(self["require_signed_request_object"], bool):
+ raise InvalidClaimError("require_signed_request_object")
+
+ self._validate_claim_value("require_signed_request_object")
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__init__.py
new file mode 100644
index 00000000..b866c7be
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__init__.py
@@ -0,0 +1,3 @@
+from .parameter import IssuerParameter
+
+__all__ = ["IssuerParameter"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..e88e4e0d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__pycache__/parameter.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__pycache__/parameter.cpython-312.pyc
new file mode 100644
index 00000000..3918d98a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/__pycache__/parameter.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/parameter.py b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/parameter.py
new file mode 100644
index 00000000..0b46494e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oauth2/rfc9207/parameter.py
@@ -0,0 +1,45 @@
+from typing import Optional
+
+from authlib.common.urls import add_params_to_uri
+from authlib.deprecate import deprecate
+from authlib.oauth2.rfc6749.grants import BaseGrant
+
+
+class IssuerParameter:
+ def __call__(self, authorization_server):
+ if isinstance(authorization_server, BaseGrant):
+ deprecate(
+ "IssueParameter should be used as an authorization server extension with 'authorization_server.register_extension(IssueParameter())'.",
+ version="1.8",
+ )
+ authorization_server.register_hook(
+ "after_authorization_response",
+ self.add_issuer_parameter,
+ )
+
+ else:
+ authorization_server.register_hook(
+ "after_create_authorization_response",
+ self.add_issuer_parameter,
+ )
+
+ def add_issuer_parameter(self, authorization_server, response):
+ if self.get_issuer() and response.location:
+ # RFC9207 §2
+ # In authorization responses to the client, including error responses,
+ # an authorization server supporting this specification MUST indicate
+ # its identity by including the iss parameter in the response.
+
+ new_location = add_params_to_uri(
+ response.location, {"iss": self.get_issuer()}
+ )
+ response.location = new_location
+
+ def get_issuer(self) -> Optional[str]:
+ """Return the issuer URL.
+ Developers MAY implement this method if they want to support :rfc:`RFC9207 <9207>`::
+
+ def get_issuer(self) -> str:
+ return "https://auth.example.org"
+ """
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/PyMySQL-1.1.0.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/__init__.py
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/PyMySQL-1.1.0.dist-info/REQUESTED
rename to Backend/venv/lib/python3.12/site-packages/authlib/oidc/__init__.py
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..e724003d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__init__.py
new file mode 100644
index 00000000..62649e02
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__init__.py
@@ -0,0 +1,35 @@
+"""authlib.oidc.core.
+~~~~~~~~~~~~~~~~~
+
+OpenID Connect Core 1.0 Implementation.
+
+http://openid.net/specs/openid-connect-core-1_0.html
+"""
+
+from .claims import CodeIDToken
+from .claims import HybridIDToken
+from .claims import IDToken
+from .claims import ImplicitIDToken
+from .claims import UserInfo
+from .claims import get_claim_cls_by_response_type
+from .grants import OpenIDCode
+from .grants import OpenIDHybridGrant
+from .grants import OpenIDImplicitGrant
+from .grants import OpenIDToken
+from .models import AuthorizationCodeMixin
+from .userinfo import UserInfoEndpoint
+
+__all__ = [
+ "AuthorizationCodeMixin",
+ "IDToken",
+ "CodeIDToken",
+ "ImplicitIDToken",
+ "HybridIDToken",
+ "UserInfo",
+ "UserInfoEndpoint",
+ "get_claim_cls_by_response_type",
+ "OpenIDToken",
+ "OpenIDCode",
+ "OpenIDHybridGrant",
+ "OpenIDImplicitGrant",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..ae30e55c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/claims.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/claims.cpython-312.pyc
new file mode 100644
index 00000000..b1e94da8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/claims.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..96cfedc5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..2843a266
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/userinfo.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/userinfo.cpython-312.pyc
new file mode 100644
index 00000000..214d8563
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/userinfo.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/util.cpython-312.pyc
new file mode 100644
index 00000000..0de75ba1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/__pycache__/util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/claims.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/claims.py
new file mode 100644
index 00000000..dc707730
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/claims.py
@@ -0,0 +1,308 @@
+import hmac
+import time
+
+from authlib.common.encoding import to_bytes
+from authlib.jose import JWTClaims
+from authlib.jose.errors import InvalidClaimError
+from authlib.jose.errors import MissingClaimError
+from authlib.oauth2.rfc6749.util import scope_to_list
+
+from .util import create_half_hash
+
+__all__ = [
+ "IDToken",
+ "CodeIDToken",
+ "ImplicitIDToken",
+ "HybridIDToken",
+ "UserInfo",
+ "get_claim_cls_by_response_type",
+]
+
+_REGISTERED_CLAIMS = [
+ "iss",
+ "sub",
+ "aud",
+ "exp",
+ "nbf",
+ "iat",
+ "auth_time",
+ "nonce",
+ "acr",
+ "amr",
+ "azp",
+ "at_hash",
+]
+
+
+class IDToken(JWTClaims):
+ ESSENTIAL_CLAIMS = ["iss", "sub", "aud", "exp", "iat"]
+
+ def validate(self, now=None, leeway=0):
+ for k in self.ESSENTIAL_CLAIMS:
+ if k not in self:
+ raise MissingClaimError(k)
+
+ self._validate_essential_claims()
+ if now is None:
+ now = int(time.time())
+
+ self.validate_iss()
+ self.validate_sub()
+ self.validate_aud()
+ self.validate_exp(now, leeway)
+ self.validate_nbf(now, leeway)
+ self.validate_iat(now, leeway)
+ self.validate_auth_time()
+ self.validate_nonce()
+ self.validate_acr()
+ self.validate_amr()
+ self.validate_azp()
+ self.validate_at_hash()
+
+ def validate_auth_time(self):
+ """Time when the End-User authentication occurred. Its value is a JSON
+ number representing the number of seconds from 1970-01-01T0:0:0Z as
+ measured in UTC until the date/time. When a max_age request is made or
+ when auth_time is requested as an Essential Claim, then this Claim is
+ REQUIRED; otherwise, its inclusion is OPTIONAL.
+ """
+ auth_time = self.get("auth_time")
+ if self.params.get("max_age") and not auth_time:
+ raise MissingClaimError("auth_time")
+
+ if auth_time and not isinstance(auth_time, (int, float)):
+ raise InvalidClaimError("auth_time")
+
+ def validate_nonce(self):
+ """String value used to associate a Client session with an ID Token,
+ and to mitigate replay attacks. The value is passed through unmodified
+ from the Authentication Request to the ID Token. If present in the ID
+ Token, Clients MUST verify that the nonce Claim Value is equal to the
+ value of the nonce parameter sent in the Authentication Request. If
+ present in the Authentication Request, Authorization Servers MUST
+ include a nonce Claim in the ID Token with the Claim Value being the
+ nonce value sent in the Authentication Request. Authorization Servers
+ SHOULD perform no other processing on nonce values used. The nonce
+ value is a case sensitive string.
+ """
+ nonce_value = self.params.get("nonce")
+ if nonce_value:
+ if "nonce" not in self:
+ raise MissingClaimError("nonce")
+ if nonce_value != self["nonce"]:
+ raise InvalidClaimError("nonce")
+
+ def validate_acr(self):
+ """OPTIONAL. Authentication Context Class Reference. String specifying
+ an Authentication Context Class Reference value that identifies the
+ Authentication Context Class that the authentication performed
+ satisfied. The value "0" indicates the End-User authentication did not
+ meet the requirements of `ISO/IEC 29115`_ level 1. Authentication
+ using a long-lived browser cookie, for instance, is one example where
+ the use of "level 0" is appropriate. Authentications with level 0
+ SHOULD NOT be used to authorize access to any resource of any monetary
+ value. An absolute URI or an `RFC 6711`_ registered name SHOULD be
+ used as the acr value; registered names MUST NOT be used with a
+ different meaning than that which is registered. Parties using this
+ claim will need to agree upon the meanings of the values used, which
+ may be context-specific. The acr value is a case sensitive string.
+
+ .. _`ISO/IEC 29115`: https://www.iso.org/standard/45138.html
+ .. _`RFC 6711`: https://tools.ietf.org/html/rfc6711
+ """
+ return self._validate_claim_value("acr")
+
+ def validate_amr(self):
+ """OPTIONAL. Authentication Methods References. JSON array of strings
+ that are identifiers for authentication methods used in the
+ authentication. For instance, values might indicate that both password
+ and OTP authentication methods were used. The definition of particular
+ values to be used in the amr Claim is beyond the scope of this
+ specification. Parties using this claim will need to agree upon the
+ meanings of the values used, which may be context-specific. The amr
+ value is an array of case sensitive strings.
+ """
+ amr = self.get("amr")
+ if amr and not isinstance(self["amr"], list):
+ raise InvalidClaimError("amr")
+
+ def validate_azp(self):
+ """OPTIONAL. Authorized party - the party to which the ID Token was
+ issued. If present, it MUST contain the OAuth 2.0 Client ID of this
+ party. This Claim is only needed when the ID Token has a single
+ audience value and that audience is different than the authorized
+ party. It MAY be included even when the authorized party is the same
+ as the sole audience. The azp value is a case sensitive string
+ containing a StringOrURI value.
+ """
+ aud = self.get("aud")
+ client_id = self.params.get("client_id")
+ required = False
+ if aud and client_id:
+ if isinstance(aud, list) and len(aud) == 1:
+ aud = aud[0]
+ if aud != client_id:
+ required = True
+
+ azp = self.get("azp")
+ if required and not azp:
+ raise MissingClaimError("azp")
+
+ if azp and client_id and azp != client_id:
+ raise InvalidClaimError("azp")
+
+ def validate_at_hash(self):
+ """OPTIONAL. Access Token hash value. Its value is the base64url
+ encoding of the left-most half of the hash of the octets of the ASCII
+ representation of the access_token value, where the hash algorithm
+ used is the hash algorithm used in the alg Header Parameter of the
+ ID Token's JOSE Header. For instance, if the alg is RS256, hash the
+ access_token value with SHA-256, then take the left-most 128 bits and
+ base64url encode them. The at_hash value is a case sensitive string.
+ """
+ access_token = self.params.get("access_token")
+ at_hash = self.get("at_hash")
+ if at_hash and access_token:
+ if not _verify_hash(at_hash, access_token, self.header["alg"]):
+ raise InvalidClaimError("at_hash")
+
+
+class CodeIDToken(IDToken):
+ RESPONSE_TYPES = ("code",)
+ REGISTERED_CLAIMS = _REGISTERED_CLAIMS
+
+
+class ImplicitIDToken(IDToken):
+ RESPONSE_TYPES = ("id_token", "id_token token")
+ ESSENTIAL_CLAIMS = ["iss", "sub", "aud", "exp", "iat", "nonce"]
+ REGISTERED_CLAIMS = _REGISTERED_CLAIMS
+
+ def validate_at_hash(self):
+ """If the ID Token is issued from the Authorization Endpoint with an
+ access_token value, which is the case for the response_type value
+ id_token token, this is REQUIRED; it MAY NOT be used when no Access
+ Token is issued, which is the case for the response_type value
+ id_token.
+ """
+ access_token = self.params.get("access_token")
+ if access_token and "at_hash" not in self:
+ raise MissingClaimError("at_hash")
+ super().validate_at_hash()
+
+
+class HybridIDToken(ImplicitIDToken):
+ RESPONSE_TYPES = ("code id_token", "code token", "code id_token token")
+ REGISTERED_CLAIMS = _REGISTERED_CLAIMS + ["c_hash"]
+
+ def validate(self, now=None, leeway=0):
+ super().validate(now=now, leeway=leeway)
+ self.validate_c_hash()
+
+ def validate_c_hash(self):
+ """Code hash value. Its value is the base64url encoding of the
+ left-most half of the hash of the octets of the ASCII representation
+ of the code value, where the hash algorithm used is the hash algorithm
+ used in the alg Header Parameter of the ID Token's JOSE Header. For
+ instance, if the alg is HS512, hash the code value with SHA-512, then
+ take the left-most 256 bits and base64url encode them. The c_hash
+ value is a case sensitive string.
+ If the ID Token is issued from the Authorization Endpoint with a code,
+ which is the case for the response_type values code id_token and code
+ id_token token, this is REQUIRED; otherwise, its inclusion is OPTIONAL.
+ """
+ code = self.params.get("code")
+ c_hash = self.get("c_hash")
+ if code:
+ if not c_hash:
+ raise MissingClaimError("c_hash")
+ if not _verify_hash(c_hash, code, self.header["alg"]):
+ raise InvalidClaimError("c_hash")
+
+
+class UserInfo(dict):
+ """The standard claims of a UserInfo object. Defined per `Section 5.1`_.
+
+ .. _`Section 5.1`: http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
+ """
+
+ #: registered claims that UserInfo supports
+ REGISTERED_CLAIMS = [
+ "sub",
+ "name",
+ "given_name",
+ "family_name",
+ "middle_name",
+ "nickname",
+ "preferred_username",
+ "profile",
+ "picture",
+ "website",
+ "email",
+ "email_verified",
+ "gender",
+ "birthdate",
+ "zoneinfo",
+ "locale",
+ "phone_number",
+ "phone_number_verified",
+ "address",
+ "updated_at",
+ ]
+
+ SCOPES_CLAIMS_MAPPING = {
+ "openid": ["sub"],
+ "profile": [
+ "name",
+ "family_name",
+ "given_name",
+ "middle_name",
+ "nickname",
+ "preferred_username",
+ "profile",
+ "picture",
+ "website",
+ "gender",
+ "birthdate",
+ "zoneinfo",
+ "locale",
+ "updated_at",
+ ],
+ "email": ["email", "email_verified"],
+ "address": ["address"],
+ "phone": ["phone_number", "phone_number_verified"],
+ }
+
+ def filter(self, scope: str):
+ """Return a new UserInfo object containing only the claims matching the scope passed in parameter."""
+ scope = scope_to_list(scope)
+ filtered_claims = [
+ claim
+ for scope_part in scope
+ for claim in self.SCOPES_CLAIMS_MAPPING.get(scope_part, [])
+ ]
+ filtered_items = {
+ key: val for key, val in self.items() if key in filtered_claims
+ }
+ return UserInfo(filtered_items)
+
+ def __getattr__(self, key):
+ try:
+ return object.__getattribute__(self, key)
+ except AttributeError as error:
+ if key in self.REGISTERED_CLAIMS:
+ return self.get(key)
+ raise error
+
+
+def get_claim_cls_by_response_type(response_type):
+ claims_classes = (CodeIDToken, ImplicitIDToken, HybridIDToken)
+ for claims_cls in claims_classes:
+ if response_type in claims_cls.RESPONSE_TYPES:
+ return claims_cls
+
+
+def _verify_hash(signature, s, alg):
+ hash_value = create_half_hash(s, alg)
+ if not hash_value:
+ return True
+ return hmac.compare_digest(hash_value, to_bytes(signature))
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/errors.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/errors.py
new file mode 100644
index 00000000..a2ed7609
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/errors.py
@@ -0,0 +1,87 @@
+from authlib.oauth2 import OAuth2Error
+
+
+class InteractionRequiredError(OAuth2Error):
+ """The Authorization Server requires End-User interaction of some form
+ to proceed. This error MAY be returned when the prompt parameter value
+ in the Authentication Request is none, but the Authentication Request
+ cannot be completed without displaying a user interface for End-User
+ interaction.
+
+ http://openid.net/specs/openid-connect-core-1_0.html#AuthError
+ """
+
+ error = "interaction_required"
+
+
+class LoginRequiredError(OAuth2Error):
+ """The Authorization Server requires End-User authentication. This error
+ MAY be returned when the prompt parameter value in the Authentication
+ Request is none, but the Authentication Request cannot be completed
+ without displaying a user interface for End-User authentication.
+
+ http://openid.net/specs/openid-connect-core-1_0.html#AuthError
+ """
+
+ error = "login_required"
+
+
+class AccountSelectionRequiredError(OAuth2Error):
+ """The End-User is REQUIRED to select a session at the Authorization
+ Server. The End-User MAY be authenticated at the Authorization Server
+ with different associated accounts, but the End-User did not select a
+ session. This error MAY be returned when the prompt parameter value in
+ the Authentication Request is none, but the Authentication Request cannot
+ be completed without displaying a user interface to prompt for a session
+ to use.
+
+ http://openid.net/specs/openid-connect-core-1_0.html#AuthError
+ """
+
+ error = "account_selection_required"
+
+
+class ConsentRequiredError(OAuth2Error):
+ """The Authorization Server requires End-User consent. This error MAY be
+ returned when the prompt parameter value in the Authentication Request is
+ none, but the Authentication Request cannot be completed without
+ displaying a user interface for End-User consent.
+
+ http://openid.net/specs/openid-connect-core-1_0.html#AuthError
+ """
+
+ error = "consent_required"
+
+
+class InvalidRequestURIError(OAuth2Error):
+ """The request_uri in the Authorization Request returns an error or
+ contains invalid data.
+
+ http://openid.net/specs/openid-connect-core-1_0.html#AuthError
+ """
+
+ error = "invalid_request_uri"
+
+
+class InvalidRequestObjectError(OAuth2Error):
+ """The request parameter contains an invalid Request Object."""
+
+ error = "invalid_request_object"
+
+
+class RequestNotSupportedError(OAuth2Error):
+ """The OP does not support use of the request parameter."""
+
+ error = "request_not_supported"
+
+
+class RequestURINotSupportedError(OAuth2Error):
+ """The OP does not support use of the request_uri parameter."""
+
+ error = "request_uri_not_supported"
+
+
+class RegistrationNotSupportedError(OAuth2Error):
+ """The OP does not support use of the registration parameter."""
+
+ error = "registration_not_supported"
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__init__.py
new file mode 100644
index 00000000..d01ac083
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__init__.py
@@ -0,0 +1,11 @@
+from .code import OpenIDCode
+from .code import OpenIDToken
+from .hybrid import OpenIDHybridGrant
+from .implicit import OpenIDImplicitGrant
+
+__all__ = [
+ "OpenIDToken",
+ "OpenIDCode",
+ "OpenIDImplicitGrant",
+ "OpenIDHybridGrant",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..d2184498
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/code.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/code.cpython-312.pyc
new file mode 100644
index 00000000..37f1c18a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/code.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/hybrid.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/hybrid.cpython-312.pyc
new file mode 100644
index 00000000..3d5b08ff
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/hybrid.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/implicit.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/implicit.cpython-312.pyc
new file mode 100644
index 00000000..5d7cefb5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/implicit.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/util.cpython-312.pyc
new file mode 100644
index 00000000..029bed49
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/__pycache__/util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/code.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/code.py
new file mode 100644
index 00000000..767781fa
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/code.py
@@ -0,0 +1,162 @@
+"""authlib.oidc.core.grants.code.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Implementation of Authentication using the Authorization Code Flow
+per `Section 3.1`_.
+
+.. _`Section 3.1`: http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth
+"""
+
+import logging
+
+from authlib.oauth2.rfc6749 import OAuth2Request
+
+from .util import generate_id_token
+from .util import is_openid_scope
+from .util import validate_nonce
+from .util import validate_request_prompt
+
+log = logging.getLogger(__name__)
+
+
+class OpenIDToken:
+ def get_jwt_config(self, grant): # pragma: no cover
+ """Get the JWT configuration for OpenIDCode extension. The JWT
+ configuration will be used to generate ``id_token``.
+ If ``alg`` is undefined, the ``id_token_signed_response_alg`` client
+ metadata will be used. By default ``RS256`` will be used.
+ If ``key`` is undefined, the ``jwks_uri`` or ``jwks`` client metadata
+ will be used.
+ Developers MUST implement this method in subclass, e.g.::
+
+ def get_jwt_config(self, grant):
+ return {
+ "key": read_private_key_file(key_path),
+ "alg": "RS256",
+ "iss": "issuer-identity",
+ "exp": 3600,
+ }
+
+ :param grant: AuthorizationCodeGrant instance
+ :return: dict
+ """
+ raise NotImplementedError()
+
+ def generate_user_info(self, user, scope):
+ """Provide user information for the given scope. Developers
+ MUST implement this method in subclass, e.g.::
+
+ from authlib.oidc.core import UserInfo
+
+
+ def generate_user_info(self, user, scope):
+ user_info = UserInfo(sub=user.id, name=user.name)
+ if "email" in scope:
+ user_info["email"] = user.email
+ return user_info
+
+ :param user: user instance
+ :param scope: scope of the token
+ :return: ``authlib.oidc.core.UserInfo`` instance
+ """
+ raise NotImplementedError()
+
+ def get_audiences(self, request):
+ """Parse `aud` value for id_token, default value is client id. Developers
+ MAY rewrite this method to provide a customized audience value.
+ """
+ client = request.client
+ return [client.get_client_id()]
+
+ def process_token(self, grant, response):
+ _, token, _ = response
+ scope = token.get("scope")
+ if not scope or not is_openid_scope(scope):
+ # standard authorization code flow
+ return token
+
+ request: OAuth2Request = grant.request
+ authorization_code = request.authorization_code
+
+ config = self.get_jwt_config(grant)
+ config["aud"] = self.get_audiences(request)
+
+ # Per OpenID Connect Registration 1.0 Section 2:
+ # Use client's id_token_signed_response_alg if specified
+ if not config.get("alg") and (
+ client_alg := request.client.id_token_signed_response_alg
+ ):
+ config["alg"] = client_alg
+
+ if authorization_code:
+ config["nonce"] = authorization_code.get_nonce()
+ config["auth_time"] = authorization_code.get_auth_time()
+
+ if acr := authorization_code.get_acr():
+ config["acr"] = acr
+
+ if amr := authorization_code.get_amr():
+ config["amr"] = amr
+
+ user_info = self.generate_user_info(request.user, token["scope"])
+ id_token = generate_id_token(token, user_info, **config)
+ token["id_token"] = id_token
+ return token
+
+ def __call__(self, grant):
+ grant.register_hook("after_create_token_response", self.process_token)
+
+
+class OpenIDCode(OpenIDToken):
+ """An extension from OpenID Connect for "grant_type=code" request. Developers
+ MUST implement the missing methods::
+
+ class MyOpenIDCode(OpenIDCode):
+ def get_jwt_config(self, grant):
+ return {...}
+
+ def exists_nonce(self, nonce, request):
+ return check_if_nonce_in_cache(request.payload.client_id, nonce)
+
+ def generate_user_info(self, user, scope):
+ return {...}
+
+ The register this extension with AuthorizationCodeGrant::
+
+ authorization_server.register_grant(
+ AuthorizationCodeGrant, extensions=[MyOpenIDCode()]
+ )
+ """
+
+ def __init__(self, require_nonce=False):
+ self.require_nonce = require_nonce
+
+ def exists_nonce(self, nonce, request):
+ """Check if the given nonce is existing in your database. Developers
+ MUST implement this method in subclass, e.g.::
+
+ def exists_nonce(self, nonce, request):
+ exists = AuthorizationCode.query.filter_by(
+ client_id=request.payload.client_id, nonce=nonce
+ ).first()
+ return bool(exists)
+
+ :param nonce: A string of "nonce" parameter in request
+ :param request: OAuth2Request instance
+ :return: Boolean
+ """
+ raise NotImplementedError()
+
+ def validate_openid_authorization_request(self, grant, redirect_uri):
+ validate_nonce(grant.request, self.exists_nonce, self.require_nonce)
+
+ def __call__(self, grant):
+ grant.register_hook("after_create_token_response", self.process_token)
+ if is_openid_scope(grant.request.payload.scope):
+ grant.register_hook(
+ "after_validate_authorization_request_payload",
+ self.validate_openid_authorization_request,
+ )
+ grant.register_hook(
+ "after_validate_consent_request", validate_request_prompt
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/hybrid.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/hybrid.py
new file mode 100644
index 00000000..8c373525
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/hybrid.py
@@ -0,0 +1,91 @@
+import logging
+
+from authlib.common.security import generate_token
+from authlib.oauth2.rfc6749 import InvalidScopeError
+from authlib.oauth2.rfc6749.grants.authorization_code import (
+ validate_code_authorization_request,
+)
+
+from .implicit import OpenIDImplicitGrant
+from .util import is_openid_scope
+from .util import validate_nonce
+
+log = logging.getLogger(__name__)
+
+
+class OpenIDHybridGrant(OpenIDImplicitGrant):
+ #: Generated "code" length
+ AUTHORIZATION_CODE_LENGTH = 48
+
+ RESPONSE_TYPES = {"code id_token", "code token", "code id_token token"}
+ GRANT_TYPE = "code"
+ DEFAULT_RESPONSE_MODE = "fragment"
+
+ def generate_authorization_code(self):
+ """ "The method to generate "code" value for authorization code data.
+ Developers may rewrite this method, or customize the code length with::
+
+ class MyAuthorizationCodeGrant(AuthorizationCodeGrant):
+ AUTHORIZATION_CODE_LENGTH = 32 # default is 48
+ """
+ return generate_token(self.AUTHORIZATION_CODE_LENGTH)
+
+ def save_authorization_code(self, code, request):
+ """Save authorization_code for later use. Developers MUST implement
+ it in subclass. Here is an example::
+
+ def save_authorization_code(self, code, request):
+ client = request.client
+ auth_code = AuthorizationCode(
+ code=code,
+ client_id=client.client_id,
+ redirect_uri=request.payload.redirect_uri,
+ scope=request.payload.scope,
+ nonce=request.payload.data.get("nonce"),
+ user_id=request.user.id,
+ )
+ auth_code.save()
+ """
+ raise NotImplementedError()
+
+ def validate_authorization_request(self):
+ if not is_openid_scope(self.request.payload.scope):
+ raise InvalidScopeError(
+ "Missing 'openid' scope",
+ redirect_uri=self.request.payload.redirect_uri,
+ redirect_fragment=True,
+ )
+ self.register_hook(
+ "after_validate_authorization_request_payload",
+ lambda grant, redirect_uri: validate_nonce(
+ grant.request, grant.exists_nonce, required=True
+ ),
+ )
+ return validate_code_authorization_request(self)
+
+ def create_granted_params(self, grant_user):
+ self.request.user = grant_user
+ client = self.request.client
+ code = self.generate_authorization_code()
+ self.save_authorization_code(code, self.request)
+ params = [("code", code)]
+ token = self.generate_token(
+ grant_type="implicit",
+ user=grant_user,
+ scope=self.request.payload.scope,
+ include_refresh_token=False,
+ )
+
+ response_types = self.request.payload.response_type.split()
+ if "token" in response_types:
+ log.debug("Grant token %r to %r", token, client)
+ self.server.save_token(token, self.request)
+ if "id_token" in response_types:
+ token = self.process_implicit_token(token, code)
+ else:
+ # response_type is "code id_token"
+ token = {"expires_in": token["expires_in"], "scope": token["scope"]}
+ token = self.process_implicit_token(token, code)
+
+ params.extend([(k, token[k]) for k in token])
+ return params
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/implicit.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/implicit.py
new file mode 100644
index 00000000..4aafdede
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/implicit.py
@@ -0,0 +1,175 @@
+import logging
+
+from authlib.oauth2.rfc6749 import AccessDeniedError
+from authlib.oauth2.rfc6749 import ImplicitGrant
+from authlib.oauth2.rfc6749 import InvalidScopeError
+from authlib.oauth2.rfc6749 import OAuth2Error
+from authlib.oauth2.rfc6749.errors import InvalidRequestError
+from authlib.oauth2.rfc6749.hooks import hooked
+
+from .util import create_response_mode_response
+from .util import generate_id_token
+from .util import is_openid_scope
+from .util import validate_nonce
+from .util import validate_request_prompt
+
+log = logging.getLogger(__name__)
+
+
+class OpenIDImplicitGrant(ImplicitGrant):
+ RESPONSE_TYPES = {"id_token token", "id_token"}
+ DEFAULT_RESPONSE_MODE = "fragment"
+
+ def exists_nonce(self, nonce, request):
+ """Check if the given nonce is existing in your database. Developers
+ should implement this method in subclass, e.g.::
+
+ def exists_nonce(self, nonce, request):
+ exists = AuthorizationCode.query.filter_by(
+ client_id=request.payload.client_id, nonce=nonce
+ ).first()
+ return bool(exists)
+
+ :param nonce: A string of "nonce" parameter in request
+ :param request: OAuth2Request instance
+ :return: Boolean
+ """
+ raise NotImplementedError()
+
+ def get_jwt_config(self):
+ """Get the JWT configuration for OpenIDImplicitGrant. The JWT
+ configuration will be used to generate ``id_token``. Developers
+ MUST implement this method in subclass, e.g.::
+
+ def get_jwt_config(self):
+ return {
+ "key": read_private_key_file(key_path),
+ "alg": "RS256",
+ "iss": "issuer-identity",
+ "exp": 3600,
+ }
+
+ :return: dict
+ """
+ raise NotImplementedError()
+
+ def generate_user_info(self, user, scope):
+ """Provide user information for the given scope. Developers
+ MUST implement this method in subclass, e.g.::
+
+ from authlib.oidc.core import UserInfo
+
+
+ def generate_user_info(self, user, scope):
+ user_info = UserInfo(sub=user.id, name=user.name)
+ if "email" in scope:
+ user_info["email"] = user.email
+ return user_info
+
+ :param user: user instance
+ :param scope: scope of the token
+ :return: ``authlib.oidc.core.UserInfo`` instance
+ """
+ raise NotImplementedError()
+
+ def get_audiences(self, request):
+ """Parse `aud` value for id_token, default value is client id. Developers
+ MAY rewrite this method to provide a customized audience value.
+ """
+ client = request.client
+ return [client.get_client_id()]
+
+ def validate_authorization_request(self):
+ if not is_openid_scope(self.request.payload.scope):
+ raise InvalidScopeError(
+ "Missing 'openid' scope",
+ redirect_uri=self.request.payload.redirect_uri,
+ redirect_fragment=True,
+ )
+ redirect_uri = super().validate_authorization_request()
+ try:
+ validate_nonce(self.request, self.exists_nonce, required=True)
+ except OAuth2Error as error:
+ error.redirect_uri = redirect_uri
+ error.redirect_fragment = True
+ raise error
+ return redirect_uri
+
+ @hooked
+ def validate_consent_request(self):
+ redirect_uri = self.validate_authorization_request()
+ validate_request_prompt(self, redirect_uri, redirect_fragment=True)
+ return redirect_uri
+
+ def create_authorization_response(self, redirect_uri, grant_user):
+ state = self.request.payload.state
+ if grant_user:
+ params = self.create_granted_params(grant_user)
+ if state:
+ params.append(("state", state))
+ else:
+ error = AccessDeniedError()
+ params = error.get_body()
+
+ # http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html#ResponseModes
+ response_mode = self.request.payload.data.get(
+ "response_mode", self.DEFAULT_RESPONSE_MODE
+ )
+ return create_response_mode_response(
+ redirect_uri=redirect_uri,
+ params=params,
+ response_mode=response_mode,
+ )
+
+ def create_granted_params(self, grant_user):
+ self.request.user = grant_user
+ client = self.request.client
+ token = self.generate_token(
+ user=grant_user,
+ scope=self.request.payload.scope,
+ include_refresh_token=False,
+ )
+ if self.request.payload.response_type == "id_token":
+ token = {
+ "expires_in": token["expires_in"],
+ "scope": token["scope"],
+ }
+ token = self.process_implicit_token(token)
+ else:
+ log.debug("Grant token %r to %r", token, client)
+ self.server.save_token(token, self.request)
+ token = self.process_implicit_token(token)
+ params = [(k, token[k]) for k in token]
+ return params
+
+ def process_implicit_token(self, token, code=None):
+ config = self.get_jwt_config()
+ config["aud"] = self.get_audiences(self.request)
+ config["nonce"] = self.request.payload.data.get("nonce")
+ if code is not None:
+ config["code"] = code
+
+ # Per OpenID Connect Registration 1.0 Section 2:
+ # Use client's id_token_signed_response_alg if specified
+ if not config.get("alg") and (
+ client_alg := self.request.client.id_token_signed_response_alg
+ ):
+ if client_alg == "none":
+ # According to oidc-registration §2 the 'none' alg is not valid in
+ # implicit flows:
+ # The value none MUST NOT be used as the ID Token alg value unless
+ # the Client uses only Response Types that return no ID Token from
+ # the Authorization Endpoint (such as when only using the
+ # Authorization Code Flow).
+ raise InvalidRequestError(
+ "id_token must be signed in implicit flows",
+ redirect_uri=self.request.payload.redirect_uri,
+ redirect_fragment=True,
+ )
+
+ config["alg"] = client_alg
+
+ user_info = self.generate_user_info(self.request.user, token["scope"])
+ id_token = generate_id_token(token, user_info, **config)
+ token["id_token"] = id_token
+ return token
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/util.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/util.py
new file mode 100644
index 00000000..1906e4e9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/grants/util.py
@@ -0,0 +1,160 @@
+import time
+
+from authlib.common.encoding import to_native
+from authlib.common.urls import add_params_to_uri
+from authlib.common.urls import quote_url
+from authlib.jose import jwt
+from authlib.oauth2.rfc6749 import InvalidRequestError
+from authlib.oauth2.rfc6749 import scope_to_list
+
+from ..errors import AccountSelectionRequiredError
+from ..errors import ConsentRequiredError
+from ..errors import LoginRequiredError
+from ..util import create_half_hash
+
+
+def is_openid_scope(scope):
+ scopes = scope_to_list(scope)
+ return scopes and "openid" in scopes
+
+
+def validate_request_prompt(grant, redirect_uri, redirect_fragment=False):
+ prompt = grant.request.payload.data.get("prompt")
+ end_user = grant.request.user
+ if not prompt:
+ if not end_user:
+ grant.prompt = "login"
+ return grant
+
+ if prompt == "none" and not end_user:
+ raise LoginRequiredError(
+ redirect_uri=redirect_uri, redirect_fragment=redirect_fragment
+ )
+
+ prompts = prompt.split()
+ if "none" in prompts and len(prompts) > 1:
+ # If this parameter contains none with any other value,
+ # an error is returned
+ raise InvalidRequestError(
+ "Invalid 'prompt' parameter.",
+ redirect_uri=redirect_uri,
+ redirect_fragment=redirect_fragment,
+ )
+
+ prompt = _guess_prompt_value(
+ end_user, prompts, redirect_uri, redirect_fragment=redirect_fragment
+ )
+ if prompt:
+ grant.prompt = prompt
+ return grant
+
+
+def validate_nonce(request, exists_nonce, required=False):
+ nonce = request.payload.data.get("nonce")
+ if not nonce:
+ if required:
+ raise InvalidRequestError("Missing 'nonce' in request.")
+ return True
+
+ if exists_nonce(nonce, request):
+ raise InvalidRequestError("Replay attack")
+
+
+def generate_id_token(
+ token,
+ user_info,
+ key,
+ iss,
+ aud,
+ alg="RS256",
+ exp=3600,
+ nonce=None,
+ auth_time=None,
+ acr=None,
+ amr=None,
+ code=None,
+ kid=None,
+):
+ now = int(time.time())
+ if auth_time is None:
+ auth_time = now
+
+ header = {"alg": alg}
+ if kid:
+ header["kid"] = kid
+
+ payload = {
+ "iss": iss,
+ "aud": aud,
+ "iat": now,
+ "exp": now + exp,
+ "auth_time": auth_time,
+ }
+ if nonce:
+ payload["nonce"] = nonce
+
+ if acr:
+ payload["acr"] = acr
+
+ if amr:
+ payload["amr"] = amr
+
+ if code:
+ c_hash = create_half_hash(code, alg)
+ if c_hash is not None:
+ payload["c_hash"] = to_native(c_hash)
+
+ access_token = token.get("access_token")
+ if access_token:
+ at_hash = create_half_hash(access_token, alg)
+ if at_hash is not None:
+ payload["at_hash"] = to_native(at_hash)
+
+ payload.update(user_info)
+ return to_native(jwt.encode(header, payload, key))
+
+
+def create_response_mode_response(redirect_uri, params, response_mode):
+ if response_mode == "form_post":
+ tpl = (
+ "Redirecting"
+ ''
+ ''
+ )
+ inputs = "".join(
+ [
+ f''
+ for k, v in params
+ ]
+ )
+ body = tpl.format(quote_url(redirect_uri), inputs)
+ return 200, body, [("Content-Type", "text/html; charset=utf-8")]
+
+ if response_mode == "query":
+ uri = add_params_to_uri(redirect_uri, params, fragment=False)
+ elif response_mode == "fragment":
+ uri = add_params_to_uri(redirect_uri, params, fragment=True)
+ else:
+ raise InvalidRequestError('Invalid "response_mode" value')
+
+ return 302, "", [("Location", uri)]
+
+
+def _guess_prompt_value(end_user, prompts, redirect_uri, redirect_fragment):
+ # http://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
+
+ if not end_user or "login" in prompts:
+ return "login"
+
+ if "consent" in prompts:
+ if not end_user:
+ raise ConsentRequiredError(
+ redirect_uri=redirect_uri, redirect_fragment=redirect_fragment
+ )
+ return "consent"
+ elif "select_account" in prompts:
+ if not end_user:
+ raise AccountSelectionRequiredError(
+ redirect_uri=redirect_uri, redirect_fragment=redirect_fragment
+ )
+ return "select_account"
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/models.py
new file mode 100644
index 00000000..4350e919
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/models.py
@@ -0,0 +1,29 @@
+from authlib.oauth2.rfc6749 import AuthorizationCodeMixin as _AuthorizationCodeMixin
+
+
+class AuthorizationCodeMixin(_AuthorizationCodeMixin):
+ def get_nonce(self):
+ """Get "nonce" value of the authorization code object."""
+ # OPs MUST support the prompt parameter, as defined in Section 3.1.2, including the specified user interface behaviors such as none and login.
+ raise NotImplementedError()
+
+ def get_auth_time(self):
+ """Get "auth_time" value of the authorization code object."""
+ # OPs MUST support returning the time at which the End-User authenticated via the auth_time Claim, when requested, as defined in Section 2.
+ raise NotImplementedError()
+
+ def get_acr(self) -> str:
+ """Get the "acr" (Authentication Method Class) value of the authorization code object."""
+ # OPs MUST support requests for specific Authentication Context Class Reference values via the acr_values parameter, as defined in Section 3.1.2. (Note that the minimum level of support required for this parameter is simply to have its use not result in an error.)
+ return None
+
+ def get_amr(self) -> list[str]:
+ """Get the "amr" (Authentication Method Reference) value of the authorization code object.
+
+ Have a look at :rfc:`RFC8176 <8176>` to see the full list of registered amr.
+
+ def get_amr(self) -> list[str]:
+ return ["pwd", "otp"]
+
+ """
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/userinfo.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/userinfo.py
new file mode 100644
index 00000000..b650c91e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/userinfo.py
@@ -0,0 +1,120 @@
+from typing import Optional
+
+from authlib.consts import default_json_headers
+from authlib.jose import jwt
+from authlib.oauth2.rfc6749.authorization_server import AuthorizationServer
+from authlib.oauth2.rfc6749.authorization_server import OAuth2Request
+from authlib.oauth2.rfc6749.resource_protector import ResourceProtector
+
+from .claims import UserInfo
+
+
+class UserInfoEndpoint:
+ """OpenID Connect Core UserInfo Endpoint.
+
+ This endpoint returns information about a given user, as a JSON payload or as a JWT.
+ It must be subclassed and a few methods needs to be manually implemented::
+
+ class UserInfoEndpoint(oidc.core.UserInfoEndpoint):
+ def get_issuer(self):
+ return "https://auth.example"
+
+ def generate_user_info(self, user, scope):
+ return UserInfo(
+ sub=user.id,
+ name=user.name,
+ ...
+ ).filter(scope)
+
+ def resolve_private_key(self):
+ return server_private_jwk_set()
+
+ It is also needed to pass a :class:`~authlib.oauth2.rfc6749.ResourceProtector` instance
+ with a registered :class:`~authlib.oauth2.rfc6749.TokenValidator` at initialization,
+ so the access to the endpoint can be restricter to valid token bearers::
+
+ resource_protector = ResourceProtector()
+ resource_protector.register_token_validator(BearerTokenValidator())
+ server.register_endpoint(
+ UserInfoEndpoint(resource_protector=resource_protector)
+ )
+
+ And then you can plug the endpoint to your application::
+
+ @app.route("/oauth/userinfo", methods=["GET", "POST"])
+ def userinfo():
+ return server.create_endpoint_response("userinfo")
+
+ """
+
+ ENDPOINT_NAME = "userinfo"
+
+ def __init__(
+ self,
+ server: Optional[AuthorizationServer] = None,
+ resource_protector: Optional[ResourceProtector] = None,
+ ):
+ self.server = server
+ self.resource_protector = resource_protector
+
+ def create_endpoint_request(self, request: OAuth2Request):
+ return self.server.create_oauth2_request(request)
+
+ def __call__(self, request: OAuth2Request):
+ token = self.resource_protector.acquire_token("openid")
+ client = token.get_client()
+ user = token.get_user()
+ user_info = self.generate_user_info(user, token.scope)
+
+ if alg := client.client_metadata.get("userinfo_signed_response_alg"):
+ # If signed, the UserInfo Response MUST contain the Claims iss
+ # (issuer) and aud (audience) as members. The iss value MUST be
+ # the OP's Issuer Identifier URL. The aud value MUST be or
+ # include the RP's Client ID value.
+ user_info["iss"] = self.get_issuer()
+ user_info["aud"] = client.client_id
+
+ data = jwt.encode({"alg": alg}, user_info, self.resolve_private_key())
+ return 200, data, [("Content-Type", "application/jwt")]
+
+ return 200, user_info, default_json_headers
+
+ def generate_user_info(self, user, scope: str) -> UserInfo:
+ """
+ Generate a :class:`~authlib.oidc.core.UserInfo` object for an user::
+
+ def generate_user_info(self, user, scope: str) -> UserInfo:
+ return UserInfo(
+ given_name=user.given_name,
+ family_name=user.last_name,
+ email=user.email,
+ ...
+ ).filter(scope)
+
+ This method must be implemented by developers.
+ """
+ raise NotImplementedError()
+
+ def get_issuer(self) -> str:
+ """The OP's Issuer Identifier URL.
+
+ The value is used to fill the ``iss`` claim that is mandatory in signed userinfo::
+
+ def get_issuer(self) -> str:
+ return "https://auth.example"
+
+ This method must be implemented by developers to support JWT userinfo.
+ """
+ raise NotImplementedError()
+
+ def resolve_private_key(self):
+ """Return the server JSON Web Key Set.
+
+ This is used to sign userinfo payloads::
+
+ def resolve_private_key(self):
+ return server_private_jwk_set()
+
+ This method must be implemented by developers to support JWT userinfo signing.
+ """
+ return None # pragma: no cover
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/util.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/util.py
new file mode 100644
index 00000000..9463f95f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/core/util.py
@@ -0,0 +1,18 @@
+import hashlib
+
+from authlib.common.encoding import to_bytes
+from authlib.common.encoding import urlsafe_b64encode
+
+
+def create_half_hash(s, alg):
+ if alg == "EdDSA":
+ hash_alg = hashlib.sha512
+ else:
+ hash_type = f"sha{alg[2:]}"
+ hash_alg = getattr(hashlib, hash_type, None)
+ if not hash_alg:
+ return None
+
+ data_digest = hash_alg(to_bytes(s)).digest()
+ slice_index = int(len(data_digest) / 2)
+ return urlsafe_b64encode(data_digest[:slice_index])
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__init__.py
new file mode 100644
index 00000000..8c982201
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__init__.py
@@ -0,0 +1,12 @@
+"""authlib.oidc.discover.
+~~~~~~~~~~~~~~~~~~~~~
+
+OpenID Connect Discovery 1.0 Implementation.
+
+https://openid.net/specs/openid-connect-discovery-1_0.html
+"""
+
+from .models import OpenIDProviderMetadata
+from .well_known import get_well_known_url
+
+__all__ = ["OpenIDProviderMetadata", "get_well_known_url"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..91dd17c7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/models.cpython-312.pyc
new file mode 100644
index 00000000..b77abad4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/well_known.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/well_known.cpython-312.pyc
new file mode 100644
index 00000000..3aef705d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/__pycache__/well_known.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/models.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/models.py
new file mode 100644
index 00000000..25fb148a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/models.py
@@ -0,0 +1,287 @@
+from authlib.oauth2.rfc8414 import AuthorizationServerMetadata
+from authlib.oauth2.rfc8414.models import validate_array_value
+
+
+class OpenIDProviderMetadata(AuthorizationServerMetadata):
+ REGISTRY_KEYS = [
+ "issuer",
+ "authorization_endpoint",
+ "token_endpoint",
+ "jwks_uri",
+ "registration_endpoint",
+ "scopes_supported",
+ "response_types_supported",
+ "response_modes_supported",
+ "grant_types_supported",
+ "token_endpoint_auth_methods_supported",
+ "service_documentation",
+ "ui_locales_supported",
+ "op_policy_uri",
+ "op_tos_uri",
+ # added by OpenID
+ "token_endpoint_auth_signing_alg_values_supported",
+ "acr_values_supported",
+ "subject_types_supported",
+ "id_token_signing_alg_values_supported",
+ "id_token_encryption_alg_values_supported",
+ "id_token_encryption_enc_values_supported",
+ "userinfo_signing_alg_values_supported",
+ "userinfo_encryption_alg_values_supported",
+ "userinfo_encryption_enc_values_supported",
+ "request_object_signing_alg_values_supported",
+ "request_object_encryption_alg_values_supported",
+ "request_object_encryption_enc_values_supported",
+ "display_values_supported",
+ "claim_types_supported",
+ "claims_supported",
+ "claims_locales_supported",
+ "claims_parameter_supported",
+ "request_parameter_supported",
+ "request_uri_parameter_supported",
+ "require_request_uri_registration",
+ # not defined by OpenID
+ # 'revocation_endpoint',
+ # 'revocation_endpoint_auth_methods_supported',
+ # 'revocation_endpoint_auth_signing_alg_values_supported',
+ # 'introspection_endpoint',
+ # 'introspection_endpoint_auth_methods_supported',
+ # 'introspection_endpoint_auth_signing_alg_values_supported',
+ # 'code_challenge_methods_supported',
+ ]
+
+ def validate_jwks_uri(self):
+ # REQUIRED in OpenID Connect
+ jwks_uri = self.get("jwks_uri")
+ if jwks_uri is None:
+ raise ValueError('"jwks_uri" is required')
+ return super().validate_jwks_uri()
+
+ def validate_acr_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the Authentication
+ Context Class References that this OP supports.
+ """
+ validate_array_value(self, "acr_values_supported")
+
+ def validate_subject_types_supported(self):
+ """REQUIRED. JSON array containing a list of the Subject Identifier
+ types that this OP supports. Valid types include pairwise and public.
+ """
+ # 1. REQUIRED
+ values = self.get("subject_types_supported")
+ if values is None:
+ raise ValueError('"subject_types_supported" is required')
+
+ # 2. JSON array
+ if not isinstance(values, list):
+ raise ValueError('"subject_types_supported" MUST be JSON array')
+
+ # 3. Valid types include pairwise and public
+ valid_types = {"pairwise", "public"}
+ if not valid_types.issuperset(set(values)):
+ raise ValueError('"subject_types_supported" contains invalid values')
+
+ def validate_id_token_signing_alg_values_supported(self):
+ """REQUIRED. JSON array containing a list of the JWS signing
+ algorithms (alg values) supported by the OP for the ID Token to
+ encode the Claims in a JWT [JWT]. The algorithm RS256 MUST be
+ included. The value none MAY be supported, but MUST NOT be used
+ unless the Response Type used returns no ID Token from the
+ Authorization Endpoint (such as when using the Authorization
+ Code Flow).
+ """
+ # 1. REQUIRED
+ values = self.get("id_token_signing_alg_values_supported")
+ if values is None:
+ raise ValueError('"id_token_signing_alg_values_supported" is required')
+
+ # 2. JSON array
+ if not isinstance(values, list):
+ raise ValueError(
+ '"id_token_signing_alg_values_supported" MUST be JSON array'
+ )
+
+ # 3. The algorithm RS256 MUST be included
+ if "RS256" not in values:
+ raise ValueError(
+ '"RS256" MUST be included in "id_token_signing_alg_values_supported"'
+ )
+
+ def validate_id_token_encryption_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWE encryption
+ algorithms (alg values) supported by the OP for the ID Token to
+ encode the Claims in a JWT.
+ """
+ validate_array_value(self, "id_token_encryption_alg_values_supported")
+
+ def validate_id_token_encryption_enc_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWE encryption
+ algorithms (enc values) supported by the OP for the ID Token to
+ encode the Claims in a JWT.
+ """
+ validate_array_value(self, "id_token_encryption_enc_values_supported")
+
+ def validate_userinfo_signing_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWS signing
+ algorithms (alg values) [JWA] supported by the UserInfo Endpoint
+ to encode the Claims in a JWT. The value none MAY be included.
+ """
+ validate_array_value(self, "userinfo_signing_alg_values_supported")
+
+ def validate_userinfo_encryption_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWE encryption
+ algorithms (alg values) [JWA] supported by the UserInfo Endpoint
+ to encode the Claims in a JWT.
+ """
+ validate_array_value(self, "userinfo_encryption_alg_values_supported")
+
+ def validate_userinfo_encryption_enc_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWE encryption
+ algorithms (enc values) [JWA] supported by the UserInfo Endpoint
+ to encode the Claims in a JWT.
+ """
+ validate_array_value(self, "userinfo_encryption_enc_values_supported")
+
+ def validate_request_object_signing_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWS signing
+ algorithms (alg values) supported by the OP for Request Objects,
+ which are described in Section 6.1 of OpenID Connect Core 1.0.
+ These algorithms are used both when the Request Object is passed
+ by value (using the request parameter) and when it is passed by
+ reference (using the request_uri parameter). Servers SHOULD support
+ none and RS256.
+ """
+ values = self.get("request_object_signing_alg_values_supported")
+ if not values:
+ return
+
+ if not isinstance(values, list):
+ raise ValueError(
+ '"request_object_signing_alg_values_supported" MUST be JSON array'
+ )
+
+ def validate_request_object_encryption_alg_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWE encryption
+ algorithms (alg values) supported by the OP for Request Objects.
+ These algorithms are used both when the Request Object is passed
+ by value and when it is passed by reference.
+ """
+ validate_array_value(self, "request_object_encryption_alg_values_supported")
+
+ def validate_request_object_encryption_enc_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the JWE encryption
+ algorithms (enc values) supported by the OP for Request Objects.
+ These algorithms are used both when the Request Object is passed
+ by value and when it is passed by reference.
+ """
+ validate_array_value(self, "request_object_encryption_enc_values_supported")
+
+ def validate_display_values_supported(self):
+ """OPTIONAL. JSON array containing a list of the display parameter
+ values that the OpenID Provider supports. These values are described
+ in Section 3.1.2.1 of OpenID Connect Core 1.0.
+ """
+ values = self.get("display_values_supported")
+ if not values:
+ return
+
+ if not isinstance(values, list):
+ raise ValueError('"display_values_supported" MUST be JSON array')
+
+ valid_values = {"page", "popup", "touch", "wap"}
+ if not valid_values.issuperset(set(values)):
+ raise ValueError('"display_values_supported" contains invalid values')
+
+ def validate_claim_types_supported(self):
+ """OPTIONAL. JSON array containing a list of the Claim Types that
+ the OpenID Provider supports. These Claim Types are described in
+ Section 5.6 of OpenID Connect Core 1.0. Values defined by this
+ specification are normal, aggregated, and distributed. If omitted,
+ the implementation supports only normal Claims.
+ """
+ values = self.get("claim_types_supported")
+ if not values:
+ return
+
+ if not isinstance(values, list):
+ raise ValueError('"claim_types_supported" MUST be JSON array')
+
+ valid_values = {"normal", "aggregated", "distributed"}
+ if not valid_values.issuperset(set(values)):
+ raise ValueError('"claim_types_supported" contains invalid values')
+
+ def validate_claims_supported(self):
+ """RECOMMENDED. JSON array containing a list of the Claim Names
+ of the Claims that the OpenID Provider MAY be able to supply values
+ for. Note that for privacy or other reasons, this might not be an
+ exhaustive list.
+ """
+ validate_array_value(self, "claims_supported")
+
+ def validate_claims_locales_supported(self):
+ """OPTIONAL. Languages and scripts supported for values in Claims
+ being returned, represented as a JSON array of BCP47 [RFC5646]
+ language tag values. Not all languages and scripts are necessarily
+ supported for all Claim values.
+ """
+ validate_array_value(self, "claims_locales_supported")
+
+ def validate_claims_parameter_supported(self):
+ """OPTIONAL. Boolean value specifying whether the OP supports use of
+ the claims parameter, with true indicating support. If omitted, the
+ default value is false.
+ """
+ _validate_boolean_value(self, "claims_parameter_supported")
+
+ def validate_request_parameter_supported(self):
+ """OPTIONAL. Boolean value specifying whether the OP supports use of
+ the request parameter, with true indicating support. If omitted, the
+ default value is false.
+ """
+ _validate_boolean_value(self, "request_parameter_supported")
+
+ def validate_request_uri_parameter_supported(self):
+ """OPTIONAL. Boolean value specifying whether the OP supports use of
+ the request_uri parameter, with true indicating support. If omitted,
+ the default value is true.
+ """
+ _validate_boolean_value(self, "request_uri_parameter_supported")
+
+ def validate_require_request_uri_registration(self):
+ """OPTIONAL. Boolean value specifying whether the OP requires any
+ request_uri values used to be pre-registered using the request_uris
+ registration parameter. Pre-registration is REQUIRED when the value
+ is true. If omitted, the default value is false.
+ """
+ _validate_boolean_value(self, "require_request_uri_registration")
+
+ @property
+ def claim_types_supported(self):
+ # If omitted, the implementation supports only normal Claims
+ return self.get("claim_types_supported", ["normal"])
+
+ @property
+ def claims_parameter_supported(self):
+ # If omitted, the default value is false.
+ return self.get("claims_parameter_supported", False)
+
+ @property
+ def request_parameter_supported(self):
+ # If omitted, the default value is false.
+ return self.get("request_parameter_supported", False)
+
+ @property
+ def request_uri_parameter_supported(self):
+ # If omitted, the default value is true.
+ return self.get("request_uri_parameter_supported", True)
+
+ @property
+ def require_request_uri_registration(self):
+ # If omitted, the default value is false.
+ return self.get("require_request_uri_registration", False)
+
+
+def _validate_boolean_value(metadata, key):
+ if key not in metadata:
+ return
+ if metadata[key] not in (True, False):
+ raise ValueError(f'"{key}" MUST be boolean')
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/well_known.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/well_known.py
new file mode 100644
index 00000000..0222962d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/discovery/well_known.py
@@ -0,0 +1,17 @@
+from authlib.common.urls import urlparse
+
+
+def get_well_known_url(issuer, external=False):
+ """Get well-known URI with issuer via Section 4.1.
+
+ :param issuer: URL of the issuer
+ :param external: return full external url or not
+ :return: URL
+ """
+ # https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationRequest
+ if external:
+ return issuer.rstrip("/") + "/.well-known/openid-configuration"
+
+ parsed = urlparse.urlparse(issuer)
+ path = parsed.path
+ return path.rstrip("/") + "/.well-known/openid-configuration"
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__init__.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__init__.py
new file mode 100644
index 00000000..08cbf656
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__init__.py
@@ -0,0 +1,3 @@
+from .claims import ClientMetadataClaims
+
+__all__ = ["ClientMetadataClaims"]
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..c70793bd
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__pycache__/claims.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__pycache__/claims.cpython-312.pyc
new file mode 100644
index 00000000..b98f238d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/__pycache__/claims.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/claims.py b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/claims.py
new file mode 100644
index 00000000..b9c7dbf9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib/oidc/registration/claims.py
@@ -0,0 +1,355 @@
+from authlib.common.urls import is_valid_url
+from authlib.jose import BaseClaims
+from authlib.jose.errors import InvalidClaimError
+
+
+class ClientMetadataClaims(BaseClaims):
+ REGISTERED_CLAIMS = [
+ "token_endpoint_auth_signing_alg",
+ "application_type",
+ "sector_identifier_uri",
+ "subject_type",
+ "id_token_signed_response_alg",
+ "id_token_encrypted_response_alg",
+ "id_token_encrypted_response_enc",
+ "userinfo_signed_response_alg",
+ "userinfo_encrypted_response_alg",
+ "userinfo_encrypted_response_enc",
+ "default_max_age",
+ "require_auth_time",
+ "default_acr_values",
+ "initiate_login_uri",
+ "request_object_signing_alg",
+ "request_object_encryption_alg",
+ "request_object_encryption_enc",
+ "request_uris",
+ ]
+
+ def validate(self):
+ self._validate_essential_claims()
+ self.validate_token_endpoint_auth_signing_alg()
+ self.validate_application_type()
+ self.validate_sector_identifier_uri()
+ self.validate_subject_type()
+ self.validate_id_token_signed_response_alg()
+ self.validate_id_token_encrypted_response_alg()
+ self.validate_id_token_encrypted_response_enc()
+ self.validate_userinfo_signed_response_alg()
+ self.validate_userinfo_encrypted_response_alg()
+ self.validate_userinfo_encrypted_response_enc()
+ self.validate_default_max_age()
+ self.validate_require_auth_time()
+ self.validate_default_acr_values()
+ self.validate_initiate_login_uri()
+ self.validate_request_object_signing_alg()
+ self.validate_request_object_encryption_alg()
+ self.validate_request_object_encryption_enc()
+ self.validate_request_uris()
+
+ def _validate_uri(self, key):
+ uri = self.get(key)
+ uris = uri if isinstance(uri, list) else [uri]
+ for uri in uris:
+ if uri and not is_valid_url(uri):
+ raise InvalidClaimError(key)
+
+ @classmethod
+ def get_claims_options(self, metadata):
+ """Generate claims options validation from Authorization Server metadata."""
+ options = {}
+
+ if acr_values_supported := metadata.get("acr_values_supported"):
+
+ def _validate_default_acr_values(claims, value):
+ return not value or set(value).issubset(set(acr_values_supported))
+
+ options["default_acr_values"] = {"validate": _validate_default_acr_values}
+
+ values_mapping = {
+ "token_endpoint_auth_signing_alg_values_supported": "token_endpoint_auth_signing_alg",
+ "subject_types_supported": "subject_type",
+ "id_token_signing_alg_values_supported": "id_token_signed_response_alg",
+ "id_token_encryption_alg_values_supported": "id_token_encrypted_response_alg",
+ "id_token_encryption_enc_values_supported": "id_token_encrypted_response_enc",
+ "userinfo_signing_alg_values_supported": "userinfo_signed_response_alg",
+ "userinfo_encryption_alg_values_supported": "userinfo_encrypted_response_alg",
+ "userinfo_encryption_enc_values_supported": "userinfo_encrypted_response_enc",
+ "request_object_signing_alg_values_supported": "request_object_signing_alg",
+ "request_object_encryption_alg_values_supported": "request_object_encryption_alg",
+ "request_object_encryption_enc_values_supported": "request_object_encryption_enc",
+ }
+
+ def make_validator(metadata_claim_values):
+ def _validate(claims, value):
+ return not value or value in metadata_claim_values
+
+ return _validate
+
+ for metadata_claim_name, request_claim_name in values_mapping.items():
+ if metadata_claim_values := metadata.get(metadata_claim_name):
+ options[request_claim_name] = {
+ "validate": make_validator(metadata_claim_values)
+ }
+
+ return options
+
+ def validate_token_endpoint_auth_signing_alg(self):
+ """JWS [JWS] alg algorithm [JWA] that MUST be used for signing the JWT [JWT]
+ used to authenticate the Client at the Token Endpoint for the private_key_jwt
+ and client_secret_jwt authentication methods.
+
+ All Token Requests using these authentication methods from this Client MUST be
+ rejected, if the JWT is not signed with this algorithm. Servers SHOULD support
+ RS256. The value none MUST NOT be used. The default, if omitted, is that any
+ algorithm supported by the OP and the RP MAY be used.
+ """
+ if self.get("token_endpoint_auth_signing_alg") == "none":
+ raise InvalidClaimError("token_endpoint_auth_signing_alg")
+
+ self._validate_claim_value("token_endpoint_auth_signing_alg")
+
+ def validate_application_type(self):
+ """Kind of the application.
+
+ The default, if omitted, is web. The defined values are native or web. Web
+ Clients using the OAuth Implicit Grant Type MUST only register URLs using the
+ https scheme as redirect_uris; they MUST NOT use localhost as the hostname.
+ Native Clients MUST only register redirect_uris using custom URI schemes or
+ loopback URLs using the http scheme; loopback URLs use localhost or the IP
+ loopback literals 127.0.0.1 or [::1] as the hostname. Authorization Servers MAY
+ place additional constraints on Native Clients. Authorization Servers MAY
+ reject Redirection URI values using the http scheme, other than the loopback
+ case for Native Clients. The Authorization Server MUST verify that all the
+ registered redirect_uris conform to these constraints. This prevents sharing a
+ Client ID across different types of Clients.
+ """
+ self.setdefault("application_type", "web")
+ if self.get("application_type") not in ("web", "native"):
+ raise InvalidClaimError("application_type")
+
+ self._validate_claim_value("application_type")
+
+ def validate_sector_identifier_uri(self):
+ """URL using the https scheme to be used in calculating Pseudonymous Identifiers
+ by the OP.
+
+ The URL references a file with a single JSON array of redirect_uri values.
+ Please see Section 5. Providers that use pairwise sub (subject) values SHOULD
+ utilize the sector_identifier_uri value provided in the Subject Identifier
+ calculation for pairwise identifiers.
+ """
+ self._validate_uri("sector_identifier_uri")
+
+ def validate_subject_type(self):
+ """subject_type requested for responses to this Client.
+
+ The subject_types_supported discovery parameter contains a list of the supported
+ subject_type values for the OP. Valid types include pairwise and public.
+ """
+ self._validate_claim_value("subject_type")
+
+ def validate_id_token_signed_response_alg(self):
+ """JWS alg algorithm [JWA] REQUIRED for signing the ID Token issued to this
+ Client.
+
+ The value none MUST NOT be used as the ID Token alg value unless the Client uses
+ only Response Types that return no ID Token from the Authorization Endpoint
+ (such as when only using the Authorization Code Flow). The default, if omitted,
+ is RS256. The public key for validating the signature is provided by retrieving
+ the JWK Set referenced by the jwks_uri element from OpenID Connect Discovery 1.0
+ [OpenID.Discovery].
+ """
+ if self.get(
+ "id_token_signed_response_alg"
+ ) == "none" and "id_token" in self.get("response_type", ""):
+ raise InvalidClaimError("id_token_signed_response_alg")
+
+ self.setdefault("id_token_signed_response_alg", "RS256")
+ self._validate_claim_value("id_token_signed_response_alg")
+
+ def validate_id_token_encrypted_response_alg(self):
+ """JWE alg algorithm [JWA] REQUIRED for encrypting the ID Token issued to this
+ Client.
+
+ If this is requested, the response will be signed then encrypted, with the
+ result being a Nested JWT, as defined in [JWT]. The default, if omitted, is that
+ no encryption is performed.
+ """
+ self._validate_claim_value("id_token_encrypted_response_alg")
+
+ def validate_id_token_encrypted_response_enc(self):
+ """JWE enc algorithm [JWA] REQUIRED for encrypting the ID Token issued to this
+ Client.
+
+ If id_token_encrypted_response_alg is specified, the default
+ id_token_encrypted_response_enc value is A128CBC-HS256. When
+ id_token_encrypted_response_enc is included, id_token_encrypted_response_alg
+ MUST also be provided.
+ """
+ if self.get("id_token_encrypted_response_enc") and not self.get(
+ "id_token_encrypted_response_alg"
+ ):
+ raise InvalidClaimError("id_token_encrypted_response_enc")
+
+ if self.get("id_token_encrypted_response_alg"):
+ self.setdefault("id_token_encrypted_response_enc", "A128CBC-HS256")
+
+ self._validate_claim_value("id_token_encrypted_response_enc")
+
+ def validate_userinfo_signed_response_alg(self):
+ """JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses.
+
+ If this is specified, the response will be JWT [JWT] serialized, and signed
+ using JWS. The default, if omitted, is for the UserInfo Response to return the
+ Claims as a UTF-8 [RFC3629] encoded JSON object using the application/json
+ content-type.
+ """
+ self._validate_claim_value("userinfo_signed_response_alg")
+
+ def validate_userinfo_encrypted_response_alg(self):
+ """JWE [JWE] alg algorithm [JWA] REQUIRED for encrypting UserInfo Responses.
+
+ If both signing and encryption are requested, the response will be signed then
+ encrypted, with the result being a Nested JWT, as defined in [JWT]. The default,
+ if omitted, is that no encryption is performed.
+ """
+ self._validate_claim_value("userinfo_encrypted_response_alg")
+
+ def validate_userinfo_encrypted_response_enc(self):
+ """JWE enc algorithm [JWA] REQUIRED for encrypting UserInfo Responses.
+
+ If userinfo_encrypted_response_alg is specified, the default
+ userinfo_encrypted_response_enc value is A128CBC-HS256. When
+ userinfo_encrypted_response_enc is included, userinfo_encrypted_response_alg
+ MUST also be provided.
+ """
+ if self.get("userinfo_encrypted_response_enc") and not self.get(
+ "userinfo_encrypted_response_alg"
+ ):
+ raise InvalidClaimError("userinfo_encrypted_response_enc")
+
+ if self.get("userinfo_encrypted_response_alg"):
+ self.setdefault("userinfo_encrypted_response_enc", "A128CBC-HS256")
+
+ self._validate_claim_value("userinfo_encrypted_response_enc")
+
+ def validate_default_max_age(self):
+ """Default Maximum Authentication Age.
+
+ Specifies that the End-User MUST be actively authenticated if the End-User was
+ authenticated longer ago than the specified number of seconds. The max_age
+ request parameter overrides this default value. If omitted, no default Maximum
+ Authentication Age is specified.
+ """
+ if self.get("default_max_age") is not None and not isinstance(
+ self["default_max_age"], (int, float)
+ ):
+ raise InvalidClaimError("default_max_age")
+
+ self._validate_claim_value("default_max_age")
+
+ def validate_require_auth_time(self):
+ """Boolean value specifying whether the auth_time Claim in the ID Token is
+ REQUIRED.
+
+ It is REQUIRED when the value is true. (If this is false, the auth_time Claim
+ can still be dynamically requested as an individual Claim for the ID Token using
+ the claims request parameter described in Section 5.5.1 of OpenID Connect Core
+ 1.0 [OpenID.Core].) If omitted, the default value is false.
+ """
+ self.setdefault("require_auth_time", False)
+ if self.get("require_auth_time") is not None and not isinstance(
+ self["require_auth_time"], bool
+ ):
+ raise InvalidClaimError("require_auth_time")
+
+ self._validate_claim_value("require_auth_time")
+
+ def validate_default_acr_values(self):
+ """Default requested Authentication Context Class Reference values.
+
+ Array of strings that specifies the default acr values that the OP is being
+ requested to use for processing requests from this Client, with the values
+ appearing in order of preference. The Authentication Context Class satisfied by
+ the authentication performed is returned as the acr Claim Value in the issued ID
+ Token. The acr Claim is requested as a Voluntary Claim by this parameter. The
+ acr_values_supported discovery element contains a list of the supported acr
+ values supported by the OP. Values specified in the acr_values request parameter
+ or an individual acr Claim request override these default values.
+ """
+ self._validate_claim_value("default_acr_values")
+
+ def validate_initiate_login_uri(self):
+ """RI using the https scheme that a third party can use to initiate a login by
+ the RP, as specified in Section 4 of OpenID Connect Core 1.0 [OpenID.Core].
+
+ The URI MUST accept requests via both GET and POST. The Client MUST understand
+ the login_hint and iss parameters and SHOULD support the target_link_uri
+ parameter.
+ """
+ self._validate_uri("initiate_login_uri")
+
+ def validate_request_object_signing_alg(self):
+ """JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects
+ sent to the OP.
+
+ All Request Objects from this Client MUST be rejected, if not signed with this
+ algorithm. Request Objects are described in Section 6.1 of OpenID Connect Core
+ 1.0 [OpenID.Core]. This algorithm MUST be used both when the Request Object is
+ passed by value (using the request parameter) and when it is passed by reference
+ (using the request_uri parameter). Servers SHOULD support RS256. The value none
+ MAY be used. The default, if omitted, is that any algorithm supported by the OP
+ and the RP MAY be used.
+ """
+ self._validate_claim_value("request_object_signing_alg")
+
+ def validate_request_object_encryption_alg(self):
+ """JWE [JWE] alg algorithm [JWA] the RP is declaring that it may use for
+ encrypting Request Objects sent to the OP.
+
+ This parameter SHOULD be included when symmetric encryption will be used, since
+ this signals to the OP that a client_secret value needs to be returned from
+ which the symmetric key will be derived, that might not otherwise be returned.
+ The RP MAY still use other supported encryption algorithms or send unencrypted
+ Request Objects, even when this parameter is present. If both signing and
+ encryption are requested, the Request Object will be signed then encrypted, with
+ the result being a Nested JWT, as defined in [JWT]. The default, if omitted, is
+ that the RP is not declaring whether it might encrypt any Request Objects.
+ """
+ self._validate_claim_value("request_object_encryption_alg")
+
+ def validate_request_object_encryption_enc(self):
+ """JWE enc algorithm [JWA] the RP is declaring that it may use for encrypting
+ Request Objects sent to the OP.
+
+ If request_object_encryption_alg is specified, the default
+ request_object_encryption_enc value is A128CBC-HS256. When
+ request_object_encryption_enc is included, request_object_encryption_alg MUST
+ also be provided.
+ """
+ if self.get("request_object_encryption_enc") and not self.get(
+ "request_object_encryption_alg"
+ ):
+ raise InvalidClaimError("request_object_encryption_enc")
+
+ if self.get("request_object_encryption_alg"):
+ self.setdefault("request_object_encryption_enc", "A128CBC-HS256")
+
+ self._validate_claim_value("request_object_encryption_enc")
+
+ def validate_request_uris(self):
+ """Array of request_uri values that are pre-registered by the RP for use at the
+ OP.
+
+ These URLs MUST use the https scheme unless the target Request Object is signed
+ in a way that is verifiable by the OP. Servers MAY cache the contents of the
+ files referenced by these URIs and not retrieve them at the time they are used
+ in a request. OPs can require that request_uri values used be pre-registered
+ with the require_request_uri_registration discovery parameter. If the contents
+ of the request file could ever change, these URI values SHOULD include the
+ base64url-encoded SHA-256 hash value of the file contents referenced by the URI
+ as the value of the URI fragment. If the fragment value used for a URI changes,
+ that signals the server that its cached value for that URI with the old fragment
+ value is no longer valid.
+ """
+ self._validate_uri("request_uris")
diff --git a/Backend/venv/lib/python3.12/site-packages/PyMySQL-1.1.0.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/PyMySQL-1.1.0.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/METADATA
new file mode 100644
index 00000000..7194f00b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/METADATA
@@ -0,0 +1,212 @@
+Metadata-Version: 2.4
+Name: bandit
+Version: 1.9.2
+Summary: Security oriented static analyser for python code.
+Home-page: https://bandit.readthedocs.io/
+Author: PyCQA
+Author-email: code-quality@python.org
+License: Apache-2.0
+Project-URL: Documentation, https://bandit.readthedocs.io/
+Project-URL: Release Notes, https://github.com/PyCQA/bandit/releases
+Project-URL: Source Code, https://github.com/PyCQA/bandit
+Project-URL: Issue Tracker, https://github.com/PyCQA/bandit/issues
+Project-URL: Discord, https://discord.gg/qYxpadCgkx
+Project-URL: Sponsor, https://psfmember.org/civicrm/contribute/transact/?reset=1&id=42
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+License-File: LICENSE
+Requires-Dist: PyYAML>=5.3.1
+Requires-Dist: stevedore>=1.20.0
+Requires-Dist: rich
+Requires-Dist: colorama>=0.3.9; platform_system == "Windows"
+Provides-Extra: yaml
+Requires-Dist: PyYAML; extra == "yaml"
+Provides-Extra: toml
+Requires-Dist: tomli>=1.1.0; python_version < "3.11" and extra == "toml"
+Provides-Extra: baseline
+Requires-Dist: GitPython>=3.1.30; extra == "baseline"
+Provides-Extra: sarif
+Requires-Dist: sarif-om>=1.0.4; extra == "sarif"
+Requires-Dist: jschema-to-python>=1.2.3; extra == "sarif"
+Provides-Extra: test
+Requires-Dist: coverage>=4.5.4; extra == "test"
+Requires-Dist: fixtures>=3.0.0; extra == "test"
+Requires-Dist: flake8>=4.0.0; extra == "test"
+Requires-Dist: stestr>=2.5.0; extra == "test"
+Requires-Dist: testscenarios>=0.5.0; extra == "test"
+Requires-Dist: testtools>=2.3.0; extra == "test"
+Requires-Dist: beautifulsoup4>=4.8.0; extra == "test"
+Requires-Dist: pylint==1.9.4; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+.. image:: https://raw.githubusercontent.com/pycqa/bandit/main/logo/logotype-sm.png
+ :alt: Bandit
+
+======
+
+.. image:: https://github.com/PyCQA/bandit/actions/workflows/pythonpackage.yml/badge.svg?branch=main
+ :target: https://github.com/PyCQA/bandit/actions?query=workflow%3A%22Build+and+Test+Bandit%22+branch%3Amain
+ :alt: Build Status
+
+.. image:: https://readthedocs.org/projects/bandit/badge/?version=latest
+ :target: https://readthedocs.org/projects/bandit/
+ :alt: Docs Status
+
+.. image:: https://img.shields.io/pypi/v/bandit.svg
+ :target: https://pypi.org/project/bandit/
+ :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/pyversions/bandit.svg
+ :target: https://pypi.org/project/bandit/
+ :alt: Python Versions
+
+.. image:: https://img.shields.io/pypi/format/bandit.svg
+ :target: https://pypi.org/project/bandit/
+ :alt: Format
+
+.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
+ :target: https://github.com/PyCQA/bandit/blob/main/LICENSE
+ :alt: License
+
+.. image:: https://img.shields.io/discord/825463413634891776.svg
+ :target: https://discord.gg/qYxpadCgkx
+ :alt: Discord
+
+A security linter from PyCQA
+
+* Free software: Apache license
+* Documentation: https://bandit.readthedocs.io/en/latest/
+* Source: https://github.com/PyCQA/bandit
+* Bugs: https://github.com/PyCQA/bandit/issues
+* Contributing: https://github.com/PyCQA/bandit/blob/main/CONTRIBUTING.md
+
+Overview
+--------
+
+Bandit is a tool designed to find common security issues in Python code. To do
+this Bandit processes each file, builds an AST from it, and runs appropriate
+plugins against the AST nodes. Once Bandit has finished scanning all the files
+it generates a report.
+
+Bandit was originally developed within the OpenStack Security Project and
+later rehomed to PyCQA.
+
+.. image:: https://raw.githubusercontent.com/pycqa/bandit/main/bandit-terminal.png
+ :alt: Bandit Example Screen Shot
+
+Show Your Style
+---------------
+
+.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
+ :target: https://github.com/PyCQA/bandit
+ :alt: Security Status
+
+Use our badge in your project's README!
+
+using Markdown::
+
+ [](https://github.com/PyCQA/bandit)
+
+using RST::
+
+ .. image:: https://img.shields.io/badge/security-bandit-yellow.svg
+ :target: https://github.com/PyCQA/bandit
+ :alt: Security Status
+
+References
+----------
+
+Python AST module documentation: https://docs.python.org/3/library/ast.html
+
+Green Tree Snakes - the missing Python AST docs:
+https://greentreesnakes.readthedocs.org/en/latest/
+
+Documentation of the various types of AST nodes that Bandit currently covers
+or could be extended to cover:
+https://greentreesnakes.readthedocs.org/en/latest/nodes.html
+
+Container Images
+----------------
+
+Bandit is available as a container image, built within the bandit repository
+using GitHub Actions. The image is available on ghcr.io:
+
+.. code-block:: console
+
+ docker pull ghcr.io/pycqa/bandit/bandit
+
+The image is built for the following architectures:
+
+* amd64
+* arm64
+* armv7
+* armv8
+
+To pull a specific architecture, use the following format:
+
+.. code-block:: console
+
+ docker pull --platform= ghcr.io/pycqa/bandit/bandit:latest
+
+Every image is signed with sigstore cosign and it is possible to verify the
+source of origin using the following cosign command:
+
+.. code-block:: console
+
+ cosign verify ghcr.io/pycqa/bandit/bandit:latest \
+ --certificate-identity https://github.com/pycqa/bandit/.github/workflows/build-publish-image.yml@refs/tags/ \
+ --certificate-oidc-issuer https://token.actions.githubusercontent.com
+
+Where `` is the release version of Bandit.
+
+Sponsors
+--------
+
+The development of Bandit is made possible by the following sponsors:
+
+.. list-table::
+ :width: 100%
+ :class: borderless
+
+ * - .. image:: https://avatars.githubusercontent.com/u/34240465?s=200&v=4
+ :target: https://opensource.mercedes-benz.com/
+ :alt: Mercedes-Benz
+ :width: 88
+
+ - .. image:: https://github.githubassets.com/assets/tidelift-8cea37dea8fc.svg
+ :target: https://tidelift.com/lifter/search/pypi/bandit
+ :alt: Tidelift
+ :width: 88
+
+ - .. image:: https://avatars.githubusercontent.com/u/110237746?s=200&v=4
+ :target: https://stacklok.com/
+ :alt: Stacklok
+ :width: 88
+
+If you also ❤️ Bandit, please consider sponsoring.
+
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/RECORD
new file mode 100644
index 00000000..c4dcc86e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/RECORD
@@ -0,0 +1,151 @@
+../../../bin/bandit,sha256=yBYGS7B3xqN_9bHJM7ux_Qw-qHCKYUn86RCg67iTR9c,226
+../../../bin/bandit-baseline,sha256=9ZfYWP7HqpuoSLgDOEc3BLBPrKOqyjIviJSjHkVZRKo,230
+../../../bin/bandit-config-generator,sha256=eHL_LNgSMZdLZ5oDRNDT51QWjFbe2FCUvDyKIpqWi8Y,238
+../../../share/man/man1/bandit.1,sha256=KJ3m_ldOMgtAgMEJOtUtEVpkzY_l3cBlqU-J7Q0agoM,6545
+bandit-1.9.2.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+bandit-1.9.2.dist-info/METADATA,sha256=_qNlufb8-I7N9f2xpkqsJHu7C1henHmrY5UC5AdXmJs,7101
+bandit-1.9.2.dist-info/RECORD,,
+bandit-1.9.2.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bandit-1.9.2.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+bandit-1.9.2.dist-info/entry_points.txt,sha256=WoSLidZc14iE9GTbJR_2SkYGg03fNqaIhmgf2kHSXN8,4156
+bandit-1.9.2.dist-info/licenses/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
+bandit-1.9.2.dist-info/pbr.json,sha256=7xTM-0o_27NMhRTgoUeKqP7eYksacwC1XzciVz5jxcI,47
+bandit-1.9.2.dist-info/top_level.txt,sha256=SVJ-U-In_cpe2PQq5ZOlxjEnlAV5MfjvfFuGzg8wgdg,7
+bandit/__init__.py,sha256=yjou8RxyHpx6zHjYcBa4_CUffNYIdERGCPx6PirAo-8,683
+bandit/__main__.py,sha256=PtnKPE5k9V79ArPscEozE9ruwUIMuHlYv3yiCMJ5UBs,571
+bandit/__pycache__/__init__.cpython-312.pyc,,
+bandit/__pycache__/__main__.cpython-312.pyc,,
+bandit/blacklists/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bandit/blacklists/__pycache__/__init__.cpython-312.pyc,,
+bandit/blacklists/__pycache__/calls.cpython-312.pyc,,
+bandit/blacklists/__pycache__/imports.cpython-312.pyc,,
+bandit/blacklists/__pycache__/utils.cpython-312.pyc,,
+bandit/blacklists/calls.py,sha256=QCVOeBCZMrxLMo4ELUbuhCt2QorTcUe9vzqFDR0T1mU,29363
+bandit/blacklists/imports.py,sha256=3lCND02DoDE9EFHPeFhEegzP3YTZb4dk9RCUA-96Tek,17269
+bandit/blacklists/utils.py,sha256=OBm8dmmQsgp5_dJcm2-eAi69u5eXujeOYDg6zhMNeTM,420
+bandit/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bandit/cli/__pycache__/__init__.cpython-312.pyc,,
+bandit/cli/__pycache__/baseline.cpython-312.pyc,,
+bandit/cli/__pycache__/config_generator.cpython-312.pyc,,
+bandit/cli/__pycache__/main.cpython-312.pyc,,
+bandit/cli/baseline.py,sha256=Z0VsMRmKyTxTyWLELtuKret9eiRkIqH804phSzzn_wU,7841
+bandit/cli/config_generator.py,sha256=umRDttgCxuyPG_7bOXCHgsEUi_xwaQbwgSA3tdGoUfk,6281
+bandit/cli/main.py,sha256=0ArpKpaYG-jQyOHRDcY2hnZVFbv945nQmE2ZOZsKrTc,20874
+bandit/core/__init__.py,sha256=NwxNqwUmUIJBQwnsOG58nvi6owEldiyGmkkig0a-4nw,558
+bandit/core/__pycache__/__init__.cpython-312.pyc,,
+bandit/core/__pycache__/blacklisting.cpython-312.pyc,,
+bandit/core/__pycache__/config.cpython-312.pyc,,
+bandit/core/__pycache__/constants.cpython-312.pyc,,
+bandit/core/__pycache__/context.cpython-312.pyc,,
+bandit/core/__pycache__/docs_utils.cpython-312.pyc,,
+bandit/core/__pycache__/extension_loader.cpython-312.pyc,,
+bandit/core/__pycache__/issue.cpython-312.pyc,,
+bandit/core/__pycache__/manager.cpython-312.pyc,,
+bandit/core/__pycache__/meta_ast.cpython-312.pyc,,
+bandit/core/__pycache__/metrics.cpython-312.pyc,,
+bandit/core/__pycache__/node_visitor.cpython-312.pyc,,
+bandit/core/__pycache__/test_properties.cpython-312.pyc,,
+bandit/core/__pycache__/test_set.cpython-312.pyc,,
+bandit/core/__pycache__/tester.cpython-312.pyc,,
+bandit/core/__pycache__/utils.cpython-312.pyc,,
+bandit/core/blacklisting.py,sha256=AcV2Xe_gFmqRFTezvtOxDUv2z6r4v3mcXhg63MHQ85c,2780
+bandit/core/config.py,sha256=6VCkWN3PFGIG9x4FFrNjBvhTffxRZ_KEnipNmlgzav8,9840
+bandit/core/constants.py,sha256=yaB2ks72eOzrnfN7xOr3zFWxsc8eCMnppnIBj-_Jmn0,1220
+bandit/core/context.py,sha256=27qPogcEZcHdTV2ByGnBpJso7Kr8bwObk5rnunGqrOs,10667
+bandit/core/docs_utils.py,sha256=iDWwx4XTnIcAyQhLp6DSyP9C1M2pkgA2Ktb686cyf_I,1779
+bandit/core/extension_loader.py,sha256=6w8qE64A8vYU6wP3ryVZfn7Yxy5SFpw_zEnB5ttWeyU,4039
+bandit/core/issue.py,sha256=BituIds2j2gbSMaMf9iM7N_yzcGo0-qQq38Pp-Ae7ko,7069
+bandit/core/manager.py,sha256=VheBgjhZ7AieM0Wnh2C2Z7JLvXA03k58tOtLj4FxiUA,17283
+bandit/core/meta_ast.py,sha256=rAUdLwsm4eTPN0oXvzyIOfVXsuKV93MLMJsUC86hTWc,1136
+bandit/core/metrics.py,sha256=wDjPmrujRszaqY0zI1W7tVTVYhnC-kHo8wCaf5vYKBA,3454
+bandit/core/node_visitor.py,sha256=HsSSE3KnKxLfS_57hK_VDgfCud6LvjA_xraZ58rMmdg,10830
+bandit/core/test_properties.py,sha256=_letTk7y9Sp5SyRaq2clLeNRjKCWnOxucglGtUMLE5Q,2106
+bandit/core/test_set.py,sha256=jweZ7eK1IGhodabF6DHO_DhBMMrHxFU03R5_z4sSrJc,4054
+bandit/core/tester.py,sha256=X83oF67sqLC23ox8VWGK81v0TzFNfrvAYYouNnQFlho,6511
+bandit/core/utils.py,sha256=U5Q88mi9A7yenKMPhQA8EJyaI6qYw18kRFOM4SdhHJw,12266
+bandit/formatters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bandit/formatters/__pycache__/__init__.cpython-312.pyc,,
+bandit/formatters/__pycache__/csv.cpython-312.pyc,,
+bandit/formatters/__pycache__/custom.cpython-312.pyc,,
+bandit/formatters/__pycache__/html.cpython-312.pyc,,
+bandit/formatters/__pycache__/json.cpython-312.pyc,,
+bandit/formatters/__pycache__/sarif.cpython-312.pyc,,
+bandit/formatters/__pycache__/screen.cpython-312.pyc,,
+bandit/formatters/__pycache__/text.cpython-312.pyc,,
+bandit/formatters/__pycache__/utils.cpython-312.pyc,,
+bandit/formatters/__pycache__/xml.cpython-312.pyc,,
+bandit/formatters/__pycache__/yaml.cpython-312.pyc,,
+bandit/formatters/csv.py,sha256=IiTLncVx3hnn7A7pJpJ5Y9vxibhxHIvZnGhezhYYKSg,2313
+bandit/formatters/custom.py,sha256=21GgrLiaStknoVD9GU-sWku4nK7hJI4O7-pgyHQacbw,5363
+bandit/formatters/html.py,sha256=VNHmmKAsZWV_S-ROd4DEXJd_Uy1ipOvbD50BzihubKU,8489
+bandit/formatters/json.py,sha256=8fA-v5lsLTdoB5UwCVqxhpgeYAZDY1tK7wsZjUAFLqg,4330
+bandit/formatters/sarif.py,sha256=jP5kd9Eut0BiPIJ7e8J38vp7BLLtJFaRfEGSwGQZ41I,10791
+bandit/formatters/screen.py,sha256=71cPOEqoDznO1aHbVt-zAjWLeeTMUwYGj5kt86UGdrM,6850
+bandit/formatters/text.py,sha256=Vhh_AUATxiQpLcm0xtZ91GSJ5QeES_rXMVy1kS1H_U4,5978
+bandit/formatters/utils.py,sha256=MXmcXC1fBeRbURQKqUtqhPMtAEMO6I6-MIwcdrI_UFA,390
+bandit/formatters/xml.py,sha256=pbsa66tYlGfybq6_N5gOhTgKnSQnvJFs39z8zFCwac4,2753
+bandit/formatters/yaml.py,sha256=lmJDFXQmxp7vdC7koqRWMb9IRSMXyXEFhH2zoNu8oHc,3463
+bandit/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bandit/plugins/__pycache__/__init__.cpython-312.pyc,,
+bandit/plugins/__pycache__/app_debug.cpython-312.pyc,,
+bandit/plugins/__pycache__/asserts.cpython-312.pyc,,
+bandit/plugins/__pycache__/crypto_request_no_cert_validation.cpython-312.pyc,,
+bandit/plugins/__pycache__/django_sql_injection.cpython-312.pyc,,
+bandit/plugins/__pycache__/django_xss.cpython-312.pyc,,
+bandit/plugins/__pycache__/exec.cpython-312.pyc,,
+bandit/plugins/__pycache__/general_bad_file_permissions.cpython-312.pyc,,
+bandit/plugins/__pycache__/general_bind_all_interfaces.cpython-312.pyc,,
+bandit/plugins/__pycache__/general_hardcoded_password.cpython-312.pyc,,
+bandit/plugins/__pycache__/general_hardcoded_tmp.cpython-312.pyc,,
+bandit/plugins/__pycache__/hashlib_insecure_functions.cpython-312.pyc,,
+bandit/plugins/__pycache__/huggingface_unsafe_download.cpython-312.pyc,,
+bandit/plugins/__pycache__/injection_paramiko.cpython-312.pyc,,
+bandit/plugins/__pycache__/injection_shell.cpython-312.pyc,,
+bandit/plugins/__pycache__/injection_sql.cpython-312.pyc,,
+bandit/plugins/__pycache__/injection_wildcard.cpython-312.pyc,,
+bandit/plugins/__pycache__/insecure_ssl_tls.cpython-312.pyc,,
+bandit/plugins/__pycache__/jinja2_templates.cpython-312.pyc,,
+bandit/plugins/__pycache__/logging_config_insecure_listen.cpython-312.pyc,,
+bandit/plugins/__pycache__/mako_templates.cpython-312.pyc,,
+bandit/plugins/__pycache__/markupsafe_markup_xss.cpython-312.pyc,,
+bandit/plugins/__pycache__/pytorch_load.cpython-312.pyc,,
+bandit/plugins/__pycache__/request_without_timeout.cpython-312.pyc,,
+bandit/plugins/__pycache__/snmp_security_check.cpython-312.pyc,,
+bandit/plugins/__pycache__/ssh_no_host_key_verification.cpython-312.pyc,,
+bandit/plugins/__pycache__/tarfile_unsafe_members.cpython-312.pyc,,
+bandit/plugins/__pycache__/trojansource.cpython-312.pyc,,
+bandit/plugins/__pycache__/try_except_continue.cpython-312.pyc,,
+bandit/plugins/__pycache__/try_except_pass.cpython-312.pyc,,
+bandit/plugins/__pycache__/weak_cryptographic_key.cpython-312.pyc,,
+bandit/plugins/__pycache__/yaml_load.cpython-312.pyc,,
+bandit/plugins/app_debug.py,sha256=0Zp-DTiLnuvF-jlZKhCEK-9YzRMcUc7JS6mxWV01hFc,2257
+bandit/plugins/asserts.py,sha256=iOP5WRjdpFc8j62pIkQ_cx-LYDW1aSv8qpfdU78AoXU,2305
+bandit/plugins/crypto_request_no_cert_validation.py,sha256=AyESgBZ7JtzieeJTnRXu0kknf7og1B5GI-6uA3kLbls,2660
+bandit/plugins/django_sql_injection.py,sha256=iYNAWU-j0DRgj5rDN7sboWvxcm2czm0i8849N6tzIdw,5203
+bandit/plugins/django_xss.py,sha256=HOUAk6w2lMF6RNsZsyP7i_1qa4iJGXg2Ek_Ni28joQ4,10302
+bandit/plugins/exec.py,sha256=5kosSmgI8Y2XM4Z_5hwIq7WRTmdpfDM5E7uXYTaGxgo,1357
+bandit/plugins/general_bad_file_permissions.py,sha256=8T59CP-aluBtXkQdyyQJljFiLvK4yVIy3fDSggw53Eg,3340
+bandit/plugins/general_bind_all_interfaces.py,sha256=Mn8YBkfF5Qwhx1QRMHB-5HNnzhR4neP0lI_6LyQr4Gg,1522
+bandit/plugins/general_hardcoded_password.py,sha256=UfSRKJAKxbAOq7Mxo9mGP9eCj0ixxwCztD80ctbrCoM,8282
+bandit/plugins/general_hardcoded_tmp.py,sha256=OjDZgboZF186RK133GQksRqAkneBP14LxnBn88KSjjs,2301
+bandit/plugins/hashlib_insecure_functions.py,sha256=-cYJKULazbzqwOcq-uAGk5EvDMNTHc9BCubr3l4UHJY,4330
+bandit/plugins/huggingface_unsafe_download.py,sha256=Up1y-dxOEPJpnhzCB6c0oiNWhbRNq5UlqocJyjdNa7c,5323
+bandit/plugins/injection_paramiko.py,sha256=bAbqH-4CHQY1ghQpjlck-Pl8DKq4G6jJoAQCY3PSzYw,2049
+bandit/plugins/injection_shell.py,sha256=PsNFFjg59usUSIFR-g5VPwcUJzQ_0KJLFq3Y64rfXYY,26851
+bandit/plugins/injection_sql.py,sha256=4AmbKs5DX_pdNykSMnHcvK_IdfVP_e_-whB1P24hSSw,4875
+bandit/plugins/injection_wildcard.py,sha256=GeHJchoDxULuaLeCxMyYuJrxVTC1vx8k6JSsXm5BDFM,5016
+bandit/plugins/insecure_ssl_tls.py,sha256=VrR9qyOyY7o1UTBw-Fw06GbE87SO4wD_j127erVfDLQ,10454
+bandit/plugins/jinja2_templates.py,sha256=5-0hPcJqm-THcZn44CSReq9_oy8Ym9QG_YN-vzv3hhg,5806
+bandit/plugins/logging_config_insecure_listen.py,sha256=UzDtLTiIwRnqpPjPIZbdtYb32BT5E5h2hhC2-m9kxGU,1944
+bandit/plugins/mako_templates.py,sha256=HBhxtofo1gGd8dKPxahJ1ELlv60NYrn0rcX4B-MYtpM,2549
+bandit/plugins/markupsafe_markup_xss.py,sha256=QTFwXe99MK26MtEEmn6tlNdy9ojQY0BMZNvKMZ3cAWg,3704
+bandit/plugins/pytorch_load.py,sha256=G8W6dPpAIPU6UyOV_IcKsXAPsVZkwo_m7XpV5R8aRr4,2650
+bandit/plugins/request_without_timeout.py,sha256=IJadPCwQVEAXZ3h3YscgvgDIzdrHM0_jozYiRN30kyE,3087
+bandit/plugins/snmp_security_check.py,sha256=tTdonRdKMKs5Rq4o4OWznW4_rjna2UhnStNLZTKG58I,3716
+bandit/plugins/ssh_no_host_key_verification.py,sha256=1Fqx5k5gtLvnWk4Gz7bQXwqx4TOxIzUGa-ouYBQGNsI,2732
+bandit/plugins/tarfile_unsafe_members.py,sha256=-VKsrS06IdH4NfbXTphi6d4AUtkjELJAuZIHfQyTKw8,3929
+bandit/plugins/trojansource.py,sha256=wdZMcMsbBumI6OC-q0k7mBIDolX3lruwWSIj2eBnyDU,2513
+bandit/plugins/try_except_continue.py,sha256=K-VrQS_YnifFwz5GC1LAUzGHTbbh9m-LHuDaJwgAS5o,3078
+bandit/plugins/try_except_pass.py,sha256=DwPiiziccoWtgE86aEmU9maKW1W8JuJxqOlnume1nis,2910
+bandit/plugins/weak_cryptographic_key.py,sha256=SGH3YM3LiBrcmuO0GjnQuZCVm42d2C68l1dGKtnwNb8,5544
+bandit/plugins/yaml_load.py,sha256=bOfCZBOcSXB3AAINJbuvcHkHebo-qyMyA4155Lgnx2g,2404
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/REQUESTED
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/REQUESTED
rename to Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/REQUESTED
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/WHEEL
similarity index 65%
rename from Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/WHEEL
rename to Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/WHEEL
index 5bad85fd..8acb9559 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/WHEEL
+++ b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/WHEEL
@@ -1,5 +1,5 @@
Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.0)
+Generator: setuptools (79.0.1)
Root-Is-Purelib: true
Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/entry_points.txt b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/entry_points.txt
new file mode 100644
index 00000000..8c71592c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/entry_points.txt
@@ -0,0 +1,63 @@
+[bandit.blacklists]
+calls = bandit.blacklists.calls:gen_blacklist
+imports = bandit.blacklists.imports:gen_blacklist
+
+[bandit.formatters]
+csv = bandit.formatters.csv:report
+custom = bandit.formatters.custom:report
+html = bandit.formatters.html:report
+json = bandit.formatters.json:report
+sarif = bandit.formatters.sarif:report
+screen = bandit.formatters.screen:report
+txt = bandit.formatters.text:report
+xml = bandit.formatters.xml:report
+yaml = bandit.formatters.yaml:report
+
+[bandit.plugins]
+any_other_function_with_shell_equals_true = bandit.plugins.injection_shell:any_other_function_with_shell_equals_true
+assert_used = bandit.plugins.asserts:assert_used
+django_extra_used = bandit.plugins.django_sql_injection:django_extra_used
+django_mark_safe = bandit.plugins.django_xss:django_mark_safe
+django_rawsql_used = bandit.plugins.django_sql_injection:django_rawsql_used
+exec_used = bandit.plugins.exec:exec_used
+flask_debug_true = bandit.plugins.app_debug:flask_debug_true
+hardcoded_bind_all_interfaces = bandit.plugins.general_bind_all_interfaces:hardcoded_bind_all_interfaces
+hardcoded_password_default = bandit.plugins.general_hardcoded_password:hardcoded_password_default
+hardcoded_password_funcarg = bandit.plugins.general_hardcoded_password:hardcoded_password_funcarg
+hardcoded_password_string = bandit.plugins.general_hardcoded_password:hardcoded_password_string
+hardcoded_sql_expressions = bandit.plugins.injection_sql:hardcoded_sql_expressions
+hardcoded_tmp_directory = bandit.plugins.general_hardcoded_tmp:hardcoded_tmp_directory
+hashlib_insecure_functions = bandit.plugins.hashlib_insecure_functions:hashlib
+huggingface_unsafe_download = bandit.plugins.huggingface_unsafe_download:huggingface_unsafe_download
+jinja2_autoescape_false = bandit.plugins.jinja2_templates:jinja2_autoescape_false
+linux_commands_wildcard_injection = bandit.plugins.injection_wildcard:linux_commands_wildcard_injection
+logging_config_insecure_listen = bandit.plugins.logging_config_insecure_listen:logging_config_insecure_listen
+markupsafe_markup_xss = bandit.plugins.markupsafe_markup_xss:markupsafe_markup_xss
+paramiko_calls = bandit.plugins.injection_paramiko:paramiko_calls
+pytorch_load = bandit.plugins.pytorch_load:pytorch_load
+request_with_no_cert_validation = bandit.plugins.crypto_request_no_cert_validation:request_with_no_cert_validation
+request_without_timeout = bandit.plugins.request_without_timeout:request_without_timeout
+set_bad_file_permissions = bandit.plugins.general_bad_file_permissions:set_bad_file_permissions
+snmp_insecure_version = bandit.plugins.snmp_security_check:snmp_insecure_version_check
+snmp_weak_cryptography = bandit.plugins.snmp_security_check:snmp_crypto_check
+ssh_no_host_key_verification = bandit.plugins.ssh_no_host_key_verification:ssh_no_host_key_verification
+ssl_with_bad_defaults = bandit.plugins.insecure_ssl_tls:ssl_with_bad_defaults
+ssl_with_bad_version = bandit.plugins.insecure_ssl_tls:ssl_with_bad_version
+ssl_with_no_version = bandit.plugins.insecure_ssl_tls:ssl_with_no_version
+start_process_with_a_shell = bandit.plugins.injection_shell:start_process_with_a_shell
+start_process_with_no_shell = bandit.plugins.injection_shell:start_process_with_no_shell
+start_process_with_partial_path = bandit.plugins.injection_shell:start_process_with_partial_path
+subprocess_popen_with_shell_equals_true = bandit.plugins.injection_shell:subprocess_popen_with_shell_equals_true
+subprocess_without_shell_equals_true = bandit.plugins.injection_shell:subprocess_without_shell_equals_true
+tarfile_unsafe_members = bandit.plugins.tarfile_unsafe_members:tarfile_unsafe_members
+trojansource = bandit.plugins.trojansource:trojansource
+try_except_continue = bandit.plugins.try_except_continue:try_except_continue
+try_except_pass = bandit.plugins.try_except_pass:try_except_pass
+use_of_mako_templates = bandit.plugins.mako_templates:use_of_mako_templates
+weak_cryptographic_key = bandit.plugins.weak_cryptographic_key:weak_cryptographic_key
+yaml_load = bandit.plugins.yaml_load:yaml_load
+
+[console_scripts]
+bandit = bandit.cli.main:main
+bandit-baseline = bandit.cli.baseline:main
+bandit-config-generator = bandit.cli.config_generator:main
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/licenses/LICENSE b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/licenses/LICENSE
new file mode 100644
index 00000000..67db8588
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/licenses/LICENSE
@@ -0,0 +1,175 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/pbr.json b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/pbr.json
new file mode 100644
index 00000000..330224ee
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/pbr.json
@@ -0,0 +1 @@
+{"git_version": "ea0d187", "is_release": false}
\ No newline at end of file
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/top_level.txt b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/top_level.txt
new file mode 100644
index 00000000..4f97a523
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit-1.9.2.dist-info/top_level.txt
@@ -0,0 +1 @@
+bandit
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/__init__.py b/Backend/venv/lib/python3.12/site-packages/bandit/__init__.py
new file mode 100644
index 00000000..7c7bf00a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/__init__.py
@@ -0,0 +1,20 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+from importlib import metadata
+
+from bandit.core import config # noqa
+from bandit.core import context # noqa
+from bandit.core import manager # noqa
+from bandit.core import meta_ast # noqa
+from bandit.core import node_visitor # noqa
+from bandit.core import test_set # noqa
+from bandit.core import tester # noqa
+from bandit.core import utils # noqa
+from bandit.core.constants import * # noqa
+from bandit.core.issue import * # noqa
+from bandit.core.test_properties import * # noqa
+
+__author__ = metadata.metadata("bandit")["Author"]
+__version__ = metadata.version("bandit")
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/__main__.py b/Backend/venv/lib/python3.12/site-packages/bandit/__main__.py
new file mode 100644
index 00000000..f43c06a2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/__main__.py
@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: Apache-2.0
+"""Bandit is a tool designed to find common security issues in Python code.
+
+Bandit is a tool designed to find common security issues in Python code.
+To do this Bandit processes each file, builds an AST from it, and runs
+appropriate plugins against the AST nodes. Once Bandit has finished
+scanning all the files it generates a report.
+
+Bandit was originally developed within the OpenStack Security Project and
+later rehomed to PyCQA.
+
+https://bandit.readthedocs.io/
+"""
+from bandit.cli import main
+
+main.main()
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..34e12309
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/__pycache__/__main__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/__pycache__/__main__.cpython-312.pyc
new file mode 100644
index 00000000..0ec985d8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/__pycache__/__main__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__init__.py
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/REQUESTED
rename to Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__init__.py
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..fbceaa37
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/calls.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/calls.cpython-312.pyc
new file mode 100644
index 00000000..1c641474
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/calls.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/imports.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/imports.cpython-312.pyc
new file mode 100644
index 00000000..69215cf3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/imports.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/utils.cpython-312.pyc
new file mode 100644
index 00000000..4c4a80ea
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/calls.py b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/calls.py
new file mode 100644
index 00000000..024e873a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/calls.py
@@ -0,0 +1,670 @@
+#
+# Copyright 2016 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+====================================================
+Blacklist various Python calls known to be dangerous
+====================================================
+
+This blacklist data checks for a number of Python calls known to have possible
+security implications. The following blacklist tests are run against any
+function calls encountered in the scanned code base, triggered by encountering
+ast.Call nodes.
+
+B301: pickle
+------------
+
+Pickle and modules that wrap it can be unsafe when used to
+deserialize untrusted data, possible security issue.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B301 | pickle | - pickle.loads | Medium |
+| | | - pickle.load | |
+| | | - pickle.Unpickler | |
+| | | - dill.loads | |
+| | | - dill.load | |
+| | | - dill.Unpickler | |
+| | | - shelve.open | |
+| | | - shelve.DbfilenameShelf | |
+| | | - jsonpickle.decode | |
+| | | - jsonpickle.unpickler.decode | |
+| | | - jsonpickle.unpickler.Unpickler | |
+| | | - pandas.read_pickle | |
++------+---------------------+------------------------------------+-----------+
+
+B302: marshal
+-------------
+
+Deserialization with the marshal module is possibly dangerous.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B302 | marshal | - marshal.load | Medium |
+| | | - marshal.loads | |
++------+---------------------+------------------------------------+-----------+
+
+B303: md5
+---------
+
+Use of insecure MD2, MD4, MD5, or SHA1 hash function.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B303 | md5 | - hashlib.md5 | Medium |
+| | | - hashlib.sha1 | |
+| | | - Crypto.Hash.MD2.new | |
+| | | - Crypto.Hash.MD4.new | |
+| | | - Crypto.Hash.MD5.new | |
+| | | - Crypto.Hash.SHA.new | |
+| | | - Cryptodome.Hash.MD2.new | |
+| | | - Cryptodome.Hash.MD4.new | |
+| | | - Cryptodome.Hash.MD5.new | |
+| | | - Cryptodome.Hash.SHA.new | |
+| | | - cryptography.hazmat.primitives | |
+| | | .hashes.MD5 | |
+| | | - cryptography.hazmat.primitives | |
+| | | .hashes.SHA1 | |
++------+---------------------+------------------------------------+-----------+
+
+B304 - B305: ciphers and modes
+------------------------------
+
+Use of insecure cipher or cipher mode. Replace with a known secure cipher such
+as AES.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B304 | ciphers | - Crypto.Cipher.ARC2.new | High |
+| | | - Crypto.Cipher.ARC4.new | |
+| | | - Crypto.Cipher.Blowfish.new | |
+| | | - Crypto.Cipher.DES.new | |
+| | | - Crypto.Cipher.XOR.new | |
+| | | - Cryptodome.Cipher.ARC2.new | |
+| | | - Cryptodome.Cipher.ARC4.new | |
+| | | - Cryptodome.Cipher.Blowfish.new | |
+| | | - Cryptodome.Cipher.DES.new | |
+| | | - Cryptodome.Cipher.XOR.new | |
+| | | - cryptography.hazmat.primitives | |
+| | | .ciphers.algorithms.ARC4 | |
+| | | - cryptography.hazmat.primitives | |
+| | | .ciphers.algorithms.Blowfish | |
+| | | - cryptography.hazmat.primitives | |
+| | | .ciphers.algorithms.IDEA | |
+| | | - cryptography.hazmat.primitives | |
+| | | .ciphers.algorithms.CAST5 | |
+| | | - cryptography.hazmat.primitives | |
+| | | .ciphers.algorithms.SEED | |
+| | | - cryptography.hazmat.primitives | |
+| | | .ciphers.algorithms.TripleDES | |
++------+---------------------+------------------------------------+-----------+
+| B305 | cipher_modes | - cryptography.hazmat.primitives | Medium |
+| | | .ciphers.modes.ECB | |
++------+---------------------+------------------------------------+-----------+
+
+B306: mktemp_q
+--------------
+
+Use of insecure and deprecated function (mktemp).
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B306 | mktemp_q | - tempfile.mktemp | Medium |
++------+---------------------+------------------------------------+-----------+
+
+B307: eval
+----------
+
+Use of possibly insecure function - consider using safer ast.literal_eval.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B307 | eval | - eval | Medium |
++------+---------------------+------------------------------------+-----------+
+
+B308: mark_safe
+---------------
+
+Use of mark_safe() may expose cross-site scripting vulnerabilities and should
+be reviewed.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B308 | mark_safe | - django.utils.safestring.mark_safe| Medium |
++------+---------------------+------------------------------------+-----------+
+
+B309: httpsconnection
+---------------------
+
+The check for this call has been removed.
+
+Use of HTTPSConnection on older versions of Python prior to 2.7.9 and 3.4.3 do
+not provide security, see https://wiki.openstack.org/wiki/OSSN/OSSN-0033
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B309 | httpsconnection | - httplib.HTTPSConnection | Medium |
+| | | - http.client.HTTPSConnection | |
+| | | - six.moves.http_client | |
+| | | .HTTPSConnection | |
++------+---------------------+------------------------------------+-----------+
+
+B310: urllib_urlopen
+--------------------
+
+Audit url open for permitted schemes. Allowing use of 'file:'' or custom
+schemes is often unexpected.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B310 | urllib_urlopen | - urllib.urlopen | Medium |
+| | | - urllib.request.urlopen | |
+| | | - urllib.urlretrieve | |
+| | | - urllib.request.urlretrieve | |
+| | | - urllib.URLopener | |
+| | | - urllib.request.URLopener | |
+| | | - urllib.FancyURLopener | |
+| | | - urllib.request.FancyURLopener | |
+| | | - urllib2.urlopen | |
+| | | - urllib2.Request | |
+| | | - six.moves.urllib.request.urlopen | |
+| | | - six.moves.urllib.request | |
+| | | .urlretrieve | |
+| | | - six.moves.urllib.request | |
+| | | .URLopener | |
+| | | - six.moves.urllib.request | |
+| | | .FancyURLopener | |
++------+---------------------+------------------------------------+-----------+
+
+B311: random
+------------
+
+Standard pseudo-random generators are not suitable for security/cryptographic
+purposes. Consider using the secrets module instead:
+https://docs.python.org/library/secrets.html
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B311 | random | - random.Random | Low |
+| | | - random.random | |
+| | | - random.randrange | |
+| | | - random.randint | |
+| | | - random.choice | |
+| | | - random.choices | |
+| | | - random.uniform | |
+| | | - random.triangular | |
+| | | - random.randbytes | |
+| | | - random.randrange | |
+| | | - random.sample | |
+| | | - random.getrandbits | |
++------+---------------------+------------------------------------+-----------+
+
+B312: telnetlib
+---------------
+
+Telnet-related functions are being called. Telnet is considered insecure. Use
+SSH or some other encrypted protocol.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B312 | telnetlib | - telnetlib.\* | High |
++------+---------------------+------------------------------------+-----------+
+
+B313 - B319: XML
+----------------
+
+Most of this is based off of Christian Heimes' work on defusedxml:
+https://pypi.org/project/defusedxml/#defusedxml-sax
+
+Using various XLM methods to parse untrusted XML data is known to be vulnerable
+to XML attacks. Methods should be replaced with their defusedxml equivalents.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B313 | xml_bad_cElementTree| - xml.etree.cElementTree.parse | Medium |
+| | | - xml.etree.cElementTree.iterparse | |
+| | | - xml.etree.cElementTree.fromstring| |
+| | | - xml.etree.cElementTree.XMLParser | |
++------+---------------------+------------------------------------+-----------+
+| B314 | xml_bad_ElementTree | - xml.etree.ElementTree.parse | Medium |
+| | | - xml.etree.ElementTree.iterparse | |
+| | | - xml.etree.ElementTree.fromstring | |
+| | | - xml.etree.ElementTree.XMLParser | |
++------+---------------------+------------------------------------+-----------+
+| B315 | xml_bad_expatreader | - xml.sax.expatreader.create_parser| Medium |
++------+---------------------+------------------------------------+-----------+
+| B316 | xml_bad_expatbuilder| - xml.dom.expatbuilder.parse | Medium |
+| | | - xml.dom.expatbuilder.parseString | |
++------+---------------------+------------------------------------+-----------+
+| B317 | xml_bad_sax | - xml.sax.parse | Medium |
+| | | - xml.sax.parseString | |
+| | | - xml.sax.make_parser | |
++------+---------------------+------------------------------------+-----------+
+| B318 | xml_bad_minidom | - xml.dom.minidom.parse | Medium |
+| | | - xml.dom.minidom.parseString | |
++------+---------------------+------------------------------------+-----------+
+| B319 | xml_bad_pulldom | - xml.dom.pulldom.parse | Medium |
+| | | - xml.dom.pulldom.parseString | |
++------+---------------------+------------------------------------+-----------+
+
+B320: xml_bad_etree
+-------------------
+
+The check for this call has been removed.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B320 | xml_bad_etree | - lxml.etree.parse | Medium |
+| | | - lxml.etree.fromstring | |
+| | | - lxml.etree.RestrictedElement | |
+| | | - lxml.etree.GlobalParserTLS | |
+| | | - lxml.etree.getDefaultParser | |
+| | | - lxml.etree.check_docinfo | |
++------+---------------------+------------------------------------+-----------+
+
+B321: ftplib
+------------
+
+FTP-related functions are being called. FTP is considered insecure. Use
+SSH/SFTP/SCP or some other encrypted protocol.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B321 | ftplib | - ftplib.\* | High |
++------+---------------------+------------------------------------+-----------+
+
+B322: input
+-----------
+
+The check for this call has been removed.
+
+The input method in Python 2 will read from standard input, evaluate and
+run the resulting string as python source code. This is similar, though in
+many ways worse, than using eval. On Python 2, use raw_input instead, input
+is safe in Python 3.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B322 | input | - input | High |
++------+---------------------+------------------------------------+-----------+
+
+B323: unverified_context
+------------------------
+
+By default, Python will create a secure, verified ssl context for use in such
+classes as HTTPSConnection. However, it still allows using an insecure
+context via the _create_unverified_context that reverts to the previous
+behavior that does not validate certificates or perform hostname checks.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B323 | unverified_context | - ssl._create_unverified_context | Medium |
++------+---------------------+------------------------------------+-----------+
+
+B325: tempnam
+--------------
+
+The check for this call has been removed.
+
+Use of os.tempnam() and os.tmpnam() is vulnerable to symlink attacks. Consider
+using tmpfile() instead.
+
+For further information:
+ https://docs.python.org/2.7/library/os.html#os.tempnam
+ https://docs.python.org/3/whatsnew/3.0.html?highlight=tempnam
+ https://bugs.python.org/issue17880
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Calls | Severity |
++======+=====================+====================================+===========+
+| B325 | tempnam | - os.tempnam | Medium |
+| | | - os.tmpnam | |
++------+---------------------+------------------------------------+-----------+
+
+"""
+from bandit.blacklists import utils
+from bandit.core import issue
+
+
+def gen_blacklist():
+ """Generate a list of items to blacklist.
+
+ Methods of this type, "bandit.blacklist" plugins, are used to build a list
+ of items that bandit's built in blacklisting tests will use to trigger
+ issues. They replace the older blacklist* test plugins and allow
+ blacklisted items to have a unique bandit ID for filtering and profile
+ usage.
+
+ :return: a dictionary mapping node types to a list of blacklist data
+ """
+ sets = []
+ sets.append(
+ utils.build_conf_dict(
+ "pickle",
+ "B301",
+ issue.Cwe.DESERIALIZATION_OF_UNTRUSTED_DATA,
+ [
+ "pickle.loads",
+ "pickle.load",
+ "pickle.Unpickler",
+ "dill.loads",
+ "dill.load",
+ "dill.Unpickler",
+ "shelve.open",
+ "shelve.DbfilenameShelf",
+ "jsonpickle.decode",
+ "jsonpickle.unpickler.decode",
+ "jsonpickle.unpickler.Unpickler",
+ "pandas.read_pickle",
+ ],
+ "Pickle and modules that wrap it can be unsafe when used to "
+ "deserialize untrusted data, possible security issue.",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "marshal",
+ "B302",
+ issue.Cwe.DESERIALIZATION_OF_UNTRUSTED_DATA,
+ ["marshal.load", "marshal.loads"],
+ "Deserialization with the marshal module is possibly dangerous.",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "md5",
+ "B303",
+ issue.Cwe.BROKEN_CRYPTO,
+ [
+ "Crypto.Hash.MD2.new",
+ "Crypto.Hash.MD4.new",
+ "Crypto.Hash.MD5.new",
+ "Crypto.Hash.SHA.new",
+ "Cryptodome.Hash.MD2.new",
+ "Cryptodome.Hash.MD4.new",
+ "Cryptodome.Hash.MD5.new",
+ "Cryptodome.Hash.SHA.new",
+ "cryptography.hazmat.primitives.hashes.MD5",
+ "cryptography.hazmat.primitives.hashes.SHA1",
+ ],
+ "Use of insecure MD2, MD4, MD5, or SHA1 hash function.",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "ciphers",
+ "B304",
+ issue.Cwe.BROKEN_CRYPTO,
+ [
+ "Crypto.Cipher.ARC2.new",
+ "Crypto.Cipher.ARC4.new",
+ "Crypto.Cipher.Blowfish.new",
+ "Crypto.Cipher.DES.new",
+ "Crypto.Cipher.XOR.new",
+ "Cryptodome.Cipher.ARC2.new",
+ "Cryptodome.Cipher.ARC4.new",
+ "Cryptodome.Cipher.Blowfish.new",
+ "Cryptodome.Cipher.DES.new",
+ "Cryptodome.Cipher.XOR.new",
+ "cryptography.hazmat.primitives.ciphers.algorithms.ARC4",
+ "cryptography.hazmat.primitives.ciphers.algorithms.Blowfish",
+ "cryptography.hazmat.primitives.ciphers.algorithms.CAST5",
+ "cryptography.hazmat.primitives.ciphers.algorithms.IDEA",
+ "cryptography.hazmat.primitives.ciphers.algorithms.SEED",
+ "cryptography.hazmat.primitives.ciphers.algorithms.TripleDES",
+ ],
+ "Use of insecure cipher {name}. Replace with a known secure"
+ " cipher such as AES.",
+ "HIGH",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "cipher_modes",
+ "B305",
+ issue.Cwe.BROKEN_CRYPTO,
+ ["cryptography.hazmat.primitives.ciphers.modes.ECB"],
+ "Use of insecure cipher mode {name}.",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "mktemp_q",
+ "B306",
+ issue.Cwe.INSECURE_TEMP_FILE,
+ ["tempfile.mktemp"],
+ "Use of insecure and deprecated function (mktemp).",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "eval",
+ "B307",
+ issue.Cwe.OS_COMMAND_INJECTION,
+ ["eval"],
+ "Use of possibly insecure function - consider using safer "
+ "ast.literal_eval.",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "mark_safe",
+ "B308",
+ issue.Cwe.XSS,
+ ["django.utils.safestring.mark_safe"],
+ "Use of mark_safe() may expose cross-site scripting "
+ "vulnerabilities and should be reviewed.",
+ )
+ )
+
+ # skipped B309 as the check for a call to httpsconnection has been removed
+
+ sets.append(
+ utils.build_conf_dict(
+ "urllib_urlopen",
+ "B310",
+ issue.Cwe.PATH_TRAVERSAL,
+ [
+ "urllib.request.urlopen",
+ "urllib.request.urlretrieve",
+ "urllib.request.URLopener",
+ "urllib.request.FancyURLopener",
+ "six.moves.urllib.request.urlopen",
+ "six.moves.urllib.request.urlretrieve",
+ "six.moves.urllib.request.URLopener",
+ "six.moves.urllib.request.FancyURLopener",
+ ],
+ "Audit url open for permitted schemes. Allowing use of file:/ or "
+ "custom schemes is often unexpected.",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "random",
+ "B311",
+ issue.Cwe.INSUFFICIENT_RANDOM_VALUES,
+ [
+ "random.Random",
+ "random.random",
+ "random.randrange",
+ "random.randint",
+ "random.choice",
+ "random.choices",
+ "random.uniform",
+ "random.triangular",
+ "random.randbytes",
+ "random.sample",
+ "random.randrange",
+ "random.getrandbits",
+ ],
+ "Standard pseudo-random generators are not suitable for "
+ "security/cryptographic purposes.",
+ "LOW",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "telnetlib",
+ "B312",
+ issue.Cwe.CLEARTEXT_TRANSMISSION,
+ ["telnetlib.Telnet"],
+ "Telnet-related functions are being called. Telnet is considered "
+ "insecure. Use SSH or some other encrypted protocol.",
+ "HIGH",
+ )
+ )
+
+ # Most of this is based off of Christian Heimes' work on defusedxml:
+ # https://pypi.org/project/defusedxml/#defusedxml-sax
+
+ xml_msg = (
+ "Using {name} to parse untrusted XML data is known to be "
+ "vulnerable to XML attacks. Replace {name} with its "
+ "defusedxml equivalent function or make sure "
+ "defusedxml.defuse_stdlib() is called"
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "xml_bad_cElementTree",
+ "B313",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ [
+ "xml.etree.cElementTree.parse",
+ "xml.etree.cElementTree.iterparse",
+ "xml.etree.cElementTree.fromstring",
+ "xml.etree.cElementTree.XMLParser",
+ ],
+ xml_msg,
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "xml_bad_ElementTree",
+ "B314",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ [
+ "xml.etree.ElementTree.parse",
+ "xml.etree.ElementTree.iterparse",
+ "xml.etree.ElementTree.fromstring",
+ "xml.etree.ElementTree.XMLParser",
+ ],
+ xml_msg,
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "xml_bad_expatreader",
+ "B315",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.sax.expatreader.create_parser"],
+ xml_msg,
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "xml_bad_expatbuilder",
+ "B316",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.dom.expatbuilder.parse", "xml.dom.expatbuilder.parseString"],
+ xml_msg,
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "xml_bad_sax",
+ "B317",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.sax.parse", "xml.sax.parseString", "xml.sax.make_parser"],
+ xml_msg,
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "xml_bad_minidom",
+ "B318",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.dom.minidom.parse", "xml.dom.minidom.parseString"],
+ xml_msg,
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "xml_bad_pulldom",
+ "B319",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.dom.pulldom.parse", "xml.dom.pulldom.parseString"],
+ xml_msg,
+ )
+ )
+
+ # skipped B320 as the check for a call to lxml.etree has been removed
+
+ # end of XML tests
+
+ sets.append(
+ utils.build_conf_dict(
+ "ftplib",
+ "B321",
+ issue.Cwe.CLEARTEXT_TRANSMISSION,
+ ["ftplib.FTP"],
+ "FTP-related functions are being called. FTP is considered "
+ "insecure. Use SSH/SFTP/SCP or some other encrypted protocol.",
+ "HIGH",
+ )
+ )
+
+ # skipped B322 as the check for a call to input() has been removed
+
+ sets.append(
+ utils.build_conf_dict(
+ "unverified_context",
+ "B323",
+ issue.Cwe.IMPROPER_CERT_VALIDATION,
+ ["ssl._create_unverified_context"],
+ "By default, Python will create a secure, verified ssl context for"
+ " use in such classes as HTTPSConnection. However, it still allows"
+ " using an insecure context via the _create_unverified_context "
+ "that reverts to the previous behavior that does not validate "
+ "certificates or perform hostname checks.",
+ )
+ )
+
+ # skipped B324 (used in bandit/plugins/hashlib_new_insecure_functions.py)
+
+ # skipped B325 as the check for a call to os.tempnam and os.tmpnam have
+ # been removed
+
+ return {"Call": sets}
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/imports.py b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/imports.py
new file mode 100644
index 00000000..b15155b6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/imports.py
@@ -0,0 +1,425 @@
+#
+# Copyright 2016 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+======================================================
+Blacklist various Python imports known to be dangerous
+======================================================
+
+This blacklist data checks for a number of Python modules known to have
+possible security implications. The following blacklist tests are run against
+any import statements or calls encountered in the scanned code base.
+
+Note that the XML rules listed here are mostly based off of Christian Heimes'
+work on defusedxml: https://pypi.org/project/defusedxml/
+
+B401: import_telnetlib
+----------------------
+
+A telnet-related module is being imported. Telnet is considered insecure. Use
+SSH or some other encrypted protocol.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B401 | import_telnetlib | - telnetlib | high |
++------+---------------------+------------------------------------+-----------+
+
+B402: import_ftplib
+-------------------
+A FTP-related module is being imported. FTP is considered insecure. Use
+SSH/SFTP/SCP or some other encrypted protocol.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B402 | import_ftplib | - ftplib | high |
++------+---------------------+------------------------------------+-----------+
+
+B403: import_pickle
+-------------------
+
+Consider possible security implications associated with these modules.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B403 | import_pickle | - pickle | low |
+| | | - cPickle | |
+| | | - dill | |
+| | | - shelve | |
++------+---------------------+------------------------------------+-----------+
+
+B404: import_subprocess
+-----------------------
+
+Consider possible security implications associated with these modules.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B404 | import_subprocess | - subprocess | low |
++------+---------------------+------------------------------------+-----------+
+
+
+B405: import_xml_etree
+----------------------
+
+Using various methods to parse untrusted XML data is known to be vulnerable to
+XML attacks. Replace vulnerable imports with the equivalent defusedxml package,
+or make sure defusedxml.defuse_stdlib() is called.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B405 | import_xml_etree | - xml.etree.cElementTree | low |
+| | | - xml.etree.ElementTree | |
++------+---------------------+------------------------------------+-----------+
+
+B406: import_xml_sax
+--------------------
+
+Using various methods to parse untrusted XML data is known to be vulnerable to
+XML attacks. Replace vulnerable imports with the equivalent defusedxml package,
+or make sure defusedxml.defuse_stdlib() is called.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B406 | import_xml_sax | - xml.sax | low |
++------+---------------------+------------------------------------+-----------+
+
+B407: import_xml_expat
+----------------------
+
+Using various methods to parse untrusted XML data is known to be vulnerable to
+XML attacks. Replace vulnerable imports with the equivalent defusedxml package,
+or make sure defusedxml.defuse_stdlib() is called.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B407 | import_xml_expat | - xml.dom.expatbuilder | low |
++------+---------------------+------------------------------------+-----------+
+
+B408: import_xml_minidom
+------------------------
+
+Using various methods to parse untrusted XML data is known to be vulnerable to
+XML attacks. Replace vulnerable imports with the equivalent defusedxml package,
+or make sure defusedxml.defuse_stdlib() is called.
+
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B408 | import_xml_minidom | - xml.dom.minidom | low |
++------+---------------------+------------------------------------+-----------+
+
+B409: import_xml_pulldom
+------------------------
+
+Using various methods to parse untrusted XML data is known to be vulnerable to
+XML attacks. Replace vulnerable imports with the equivalent defusedxml package,
+or make sure defusedxml.defuse_stdlib() is called.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B409 | import_xml_pulldom | - xml.dom.pulldom | low |
++------+---------------------+------------------------------------+-----------+
+
+B410: import_lxml
+-----------------
+
+This import blacklist has been removed. The information here has been
+left for historical purposes.
+
+Using various methods to parse untrusted XML data is known to be vulnerable to
+XML attacks. Replace vulnerable imports with the equivalent defusedxml package.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B410 | import_lxml | - lxml | low |
++------+---------------------+------------------------------------+-----------+
+
+B411: import_xmlrpclib
+----------------------
+
+XMLRPC is particularly dangerous as it is also concerned with communicating
+data over a network. Use defusedxml.xmlrpc.monkey_patch() function to
+monkey-patch xmlrpclib and mitigate remote XML attacks.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B411 | import_xmlrpclib | - xmlrpc | high |
++------+---------------------+------------------------------------+-----------+
+
+B412: import_httpoxy
+--------------------
+httpoxy is a set of vulnerabilities that affect application code running in
+CGI, or CGI-like environments. The use of CGI for web applications should be
+avoided to prevent this class of attack. More details are available
+at https://httpoxy.org/.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B412 | import_httpoxy | - wsgiref.handlers.CGIHandler | high |
+| | | - twisted.web.twcgi.CGIScript | |
++------+---------------------+------------------------------------+-----------+
+
+B413: import_pycrypto
+---------------------
+pycrypto library is known to have publicly disclosed buffer overflow
+vulnerability https://github.com/dlitz/pycrypto/issues/176. It is no longer
+actively maintained and has been deprecated in favor of pyca/cryptography
+library.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B413 | import_pycrypto | - Crypto.Cipher | high |
+| | | - Crypto.Hash | |
+| | | - Crypto.IO | |
+| | | - Crypto.Protocol | |
+| | | - Crypto.PublicKey | |
+| | | - Crypto.Random | |
+| | | - Crypto.Signature | |
+| | | - Crypto.Util | |
++------+---------------------+------------------------------------+-----------+
+
+B414: import_pycryptodome
+-------------------------
+This import blacklist has been removed. The information here has been
+left for historical purposes.
+
+pycryptodome is a direct fork of pycrypto that has not fully addressed
+the issues inherent in PyCrypto. It seems to exist, mainly, as an API
+compatible continuation of pycrypto and should be deprecated in favor
+of pyca/cryptography which has more support among the Python community.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B414 | import_pycryptodome | - Cryptodome.Cipher | high |
+| | | - Cryptodome.Hash | |
+| | | - Cryptodome.IO | |
+| | | - Cryptodome.Protocol | |
+| | | - Cryptodome.PublicKey | |
+| | | - Cryptodome.Random | |
+| | | - Cryptodome.Signature | |
+| | | - Cryptodome.Util | |
++------+---------------------+------------------------------------+-----------+
+
+B415: import_pyghmi
+-------------------
+An IPMI-related module is being imported. IPMI is considered insecure. Use
+an encrypted protocol.
+
++------+---------------------+------------------------------------+-----------+
+| ID | Name | Imports | Severity |
++======+=====================+====================================+===========+
+| B415 | import_pyghmi | - pyghmi | high |
++------+---------------------+------------------------------------+-----------+
+
+"""
+from bandit.blacklists import utils
+from bandit.core import issue
+
+
+def gen_blacklist():
+ """Generate a list of items to blacklist.
+
+ Methods of this type, "bandit.blacklist" plugins, are used to build a list
+ of items that bandit's built in blacklisting tests will use to trigger
+ issues. They replace the older blacklist* test plugins and allow
+ blacklisted items to have a unique bandit ID for filtering and profile
+ usage.
+
+ :return: a dictionary mapping node types to a list of blacklist data
+ """
+ sets = []
+ sets.append(
+ utils.build_conf_dict(
+ "import_telnetlib",
+ "B401",
+ issue.Cwe.CLEARTEXT_TRANSMISSION,
+ ["telnetlib"],
+ "A telnet-related module is being imported. Telnet is "
+ "considered insecure. Use SSH or some other encrypted protocol.",
+ "HIGH",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_ftplib",
+ "B402",
+ issue.Cwe.CLEARTEXT_TRANSMISSION,
+ ["ftplib"],
+ "A FTP-related module is being imported. FTP is considered "
+ "insecure. Use SSH/SFTP/SCP or some other encrypted protocol.",
+ "HIGH",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_pickle",
+ "B403",
+ issue.Cwe.DESERIALIZATION_OF_UNTRUSTED_DATA,
+ ["pickle", "cPickle", "dill", "shelve"],
+ "Consider possible security implications associated with "
+ "{name} module.",
+ "LOW",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_subprocess",
+ "B404",
+ issue.Cwe.OS_COMMAND_INJECTION,
+ ["subprocess"],
+ "Consider possible security implications associated with the "
+ "subprocess module.",
+ "LOW",
+ )
+ )
+
+ # Most of this is based off of Christian Heimes' work on defusedxml:
+ # https://pypi.org/project/defusedxml/#defusedxml-sax
+
+ xml_msg = (
+ "Using {name} to parse untrusted XML data is known to be "
+ "vulnerable to XML attacks. Replace {name} with the equivalent "
+ "defusedxml package, or make sure defusedxml.defuse_stdlib() "
+ "is called."
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_xml_etree",
+ "B405",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.etree.cElementTree", "xml.etree.ElementTree"],
+ xml_msg,
+ "LOW",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_xml_sax",
+ "B406",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.sax"],
+ xml_msg,
+ "LOW",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_xml_expat",
+ "B407",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.dom.expatbuilder"],
+ xml_msg,
+ "LOW",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_xml_minidom",
+ "B408",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.dom.minidom"],
+ xml_msg,
+ "LOW",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_xml_pulldom",
+ "B409",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xml.dom.pulldom"],
+ xml_msg,
+ "LOW",
+ )
+ )
+
+ # skipped B410 as the check for import_lxml has been removed
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_xmlrpclib",
+ "B411",
+ issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ ["xmlrpc"],
+ "Using {name} to parse untrusted XML data is known to be "
+ "vulnerable to XML attacks. Use defusedxml.xmlrpc.monkey_patch() "
+ "function to monkey-patch xmlrpclib and mitigate XML "
+ "vulnerabilities.",
+ "HIGH",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_httpoxy",
+ "B412",
+ issue.Cwe.IMPROPER_ACCESS_CONTROL,
+ [
+ "wsgiref.handlers.CGIHandler",
+ "twisted.web.twcgi.CGIScript",
+ "twisted.web.twcgi.CGIDirectory",
+ ],
+ "Consider possible security implications associated with "
+ "{name} module.",
+ "HIGH",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_pycrypto",
+ "B413",
+ issue.Cwe.BROKEN_CRYPTO,
+ [
+ "Crypto.Cipher",
+ "Crypto.Hash",
+ "Crypto.IO",
+ "Crypto.Protocol",
+ "Crypto.PublicKey",
+ "Crypto.Random",
+ "Crypto.Signature",
+ "Crypto.Util",
+ ],
+ "The pyCrypto library and its module {name} are no longer actively"
+ " maintained and have been deprecated. "
+ "Consider using pyca/cryptography library.",
+ "HIGH",
+ )
+ )
+
+ sets.append(
+ utils.build_conf_dict(
+ "import_pyghmi",
+ "B415",
+ issue.Cwe.CLEARTEXT_TRANSMISSION,
+ ["pyghmi"],
+ "An IPMI-related module is being imported. IPMI is considered "
+ "insecure. Use an encrypted protocol.",
+ "HIGH",
+ )
+ )
+
+ return {"Import": sets, "ImportFrom": sets, "Call": sets}
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/utils.py b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/utils.py
new file mode 100644
index 00000000..fa4a5c9a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/blacklists/utils.py
@@ -0,0 +1,17 @@
+#
+# Copyright 2016 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""Utils module."""
+
+
+def build_conf_dict(name, bid, cwe, qualnames, message, level="MEDIUM"):
+ """Build and return a blacklist configuration dict."""
+ return {
+ "name": name,
+ "id": bid,
+ "cwe": cwe,
+ "message": message,
+ "qualnames": qualnames,
+ "level": level,
+ }
diff --git a/Backend/venv/lib/python3.12/site-packages/pydantic-2.5.0.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__init__.py
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/pydantic-2.5.0.dist-info/REQUESTED
rename to Backend/venv/lib/python3.12/site-packages/bandit/cli/__init__.py
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..e62683f9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/baseline.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/baseline.cpython-312.pyc
new file mode 100644
index 00000000..a5bc79de
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/baseline.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/config_generator.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/config_generator.cpython-312.pyc
new file mode 100644
index 00000000..6f6c231b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/config_generator.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/main.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/main.cpython-312.pyc
new file mode 100644
index 00000000..086e5f43
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/cli/__pycache__/main.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/cli/baseline.py b/Backend/venv/lib/python3.12/site-packages/bandit/cli/baseline.py
new file mode 100644
index 00000000..406c0c77
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/cli/baseline.py
@@ -0,0 +1,252 @@
+#
+# Copyright 2015 Hewlett-Packard Enterprise
+#
+# SPDX-License-Identifier: Apache-2.0
+# #############################################################################
+# Bandit Baseline is a tool that runs Bandit against a Git commit, and compares
+# the current commit findings to the parent commit findings.
+# To do this it checks out the parent commit, runs Bandit (with any provided
+# filters or profiles), checks out the current commit, runs Bandit, and then
+# reports on any new findings.
+# #############################################################################
+"""Bandit is a tool designed to find common security issues in Python code."""
+import argparse
+import contextlib
+import logging
+import os
+import shutil
+import subprocess # nosec: B404
+import sys
+import tempfile
+
+try:
+ import git
+except ImportError:
+ git = None
+
+bandit_args = sys.argv[1:]
+baseline_tmp_file = "_bandit_baseline_run.json_"
+current_commit = None
+default_output_format = "terminal"
+LOG = logging.getLogger(__name__)
+repo = None
+report_basename = "bandit_baseline_result"
+valid_baseline_formats = ["txt", "html", "json"]
+
+"""baseline.py"""
+
+
+def main():
+ """Execute Bandit."""
+ # our cleanup function needs this and can't be passed arguments
+ global current_commit
+ global repo
+
+ parent_commit = None
+ output_format = None
+ repo = None
+ report_fname = None
+
+ init_logger()
+
+ output_format, repo, report_fname = initialize()
+
+ if not repo:
+ sys.exit(2)
+
+ # #################### Find current and parent commits ####################
+ try:
+ commit = repo.commit()
+ current_commit = commit.hexsha
+ LOG.info("Got current commit: [%s]", commit.name_rev)
+
+ commit = commit.parents[0]
+ parent_commit = commit.hexsha
+ LOG.info("Got parent commit: [%s]", commit.name_rev)
+
+ except git.GitCommandError:
+ LOG.error("Unable to get current or parent commit")
+ sys.exit(2)
+ except IndexError:
+ LOG.error("Parent commit not available")
+ sys.exit(2)
+
+ # #################### Run Bandit against both commits ####################
+ output_type = (
+ ["-f", "txt"]
+ if output_format == default_output_format
+ else ["-o", report_fname]
+ )
+
+ with baseline_setup() as t:
+ bandit_tmpfile = f"{t}/{baseline_tmp_file}"
+
+ steps = [
+ {
+ "message": "Getting Bandit baseline results",
+ "commit": parent_commit,
+ "args": bandit_args + ["-f", "json", "-o", bandit_tmpfile],
+ },
+ {
+ "message": "Comparing Bandit results to baseline",
+ "commit": current_commit,
+ "args": bandit_args + ["-b", bandit_tmpfile] + output_type,
+ },
+ ]
+
+ return_code = None
+
+ for step in steps:
+ repo.head.reset(commit=step["commit"], working_tree=True)
+
+ LOG.info(step["message"])
+
+ bandit_command = ["bandit"] + step["args"]
+
+ try:
+ output = subprocess.check_output(bandit_command) # nosec: B603
+ except subprocess.CalledProcessError as e:
+ output = e.output
+ return_code = e.returncode
+ else:
+ return_code = 0
+ output = output.decode("utf-8") # subprocess returns bytes
+
+ if return_code not in [0, 1]:
+ LOG.error(
+ "Error running command: %s\nOutput: %s\n",
+ bandit_args,
+ output,
+ )
+
+ # #################### Output and exit ####################################
+ # print output or display message about written report
+ if output_format == default_output_format:
+ print(output)
+ else:
+ LOG.info("Successfully wrote %s", report_fname)
+
+ # exit with the code the last Bandit run returned
+ sys.exit(return_code)
+
+
+# #################### Clean up before exit ###################################
+@contextlib.contextmanager
+def baseline_setup():
+ """Baseline setup by creating temp folder and resetting repo."""
+ d = tempfile.mkdtemp()
+ yield d
+ shutil.rmtree(d, True)
+
+ if repo:
+ repo.head.reset(commit=current_commit, working_tree=True)
+
+
+# #################### Setup logging ##########################################
+def init_logger():
+ """Init logger."""
+ LOG.handlers = []
+ log_level = logging.INFO
+ log_format_string = "[%(levelname)7s ] %(message)s"
+ logging.captureWarnings(True)
+ LOG.setLevel(log_level)
+ handler = logging.StreamHandler(sys.stdout)
+ handler.setFormatter(logging.Formatter(log_format_string))
+ LOG.addHandler(handler)
+
+
+# #################### Perform initialization and validate assumptions ########
+def initialize():
+ """Initialize arguments and output formats."""
+ valid = True
+
+ # #################### Parse Args #########################################
+ parser = argparse.ArgumentParser(
+ description="Bandit Baseline - Generates Bandit results compared to "
+ "a baseline",
+ formatter_class=argparse.RawDescriptionHelpFormatter,
+ epilog="Additional Bandit arguments such as severity filtering (-ll) "
+ "can be added and will be passed to Bandit.",
+ )
+ if sys.version_info >= (3, 14):
+ parser.suggest_on_error = True
+ parser.color = False
+
+ parser.add_argument(
+ "targets",
+ metavar="targets",
+ type=str,
+ nargs="+",
+ help="source file(s) or directory(s) to be tested",
+ )
+
+ parser.add_argument(
+ "-f",
+ dest="output_format",
+ action="store",
+ default="terminal",
+ help="specify output format",
+ choices=valid_baseline_formats,
+ )
+
+ args, _ = parser.parse_known_args()
+
+ # #################### Setup Output #######################################
+ # set the output format, or use a default if not provided
+ output_format = (
+ args.output_format if args.output_format else default_output_format
+ )
+
+ if output_format == default_output_format:
+ LOG.info("No output format specified, using %s", default_output_format)
+
+ # set the report name based on the output format
+ report_fname = f"{report_basename}.{output_format}"
+
+ # #################### Check Requirements #################################
+ if git is None:
+ LOG.error("Git not available, reinstall with baseline extra")
+ valid = False
+ return (None, None, None)
+
+ try:
+ repo = git.Repo(os.getcwd())
+
+ except git.exc.InvalidGitRepositoryError:
+ LOG.error("Bandit baseline must be called from a git project root")
+ valid = False
+
+ except git.exc.GitCommandNotFound:
+ LOG.error("Git command not found")
+ valid = False
+
+ else:
+ if repo.is_dirty():
+ LOG.error(
+ "Current working directory is dirty and must be " "resolved"
+ )
+ valid = False
+
+ # if output format is specified, we need to be able to write the report
+ if output_format != default_output_format and os.path.exists(report_fname):
+ LOG.error("File %s already exists, aborting", report_fname)
+ valid = False
+
+ # Bandit needs to be able to create this temp file
+ if os.path.exists(baseline_tmp_file):
+ LOG.error(
+ "Temporary file %s needs to be removed prior to running",
+ baseline_tmp_file,
+ )
+ valid = False
+
+ # we must validate -o is not provided, as it will mess up Bandit baseline
+ if "-o" in bandit_args:
+ LOG.error("Bandit baseline must not be called with the -o option")
+ valid = False
+
+ return (output_format, repo, report_fname) if valid else (None, None, None)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/cli/config_generator.py b/Backend/venv/lib/python3.12/site-packages/bandit/cli/config_generator.py
new file mode 100644
index 00000000..7564db4f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/cli/config_generator.py
@@ -0,0 +1,207 @@
+# Copyright 2015 Red Hat Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+"""Bandit is a tool designed to find common security issues in Python code."""
+import argparse
+import importlib
+import logging
+import os
+import sys
+
+import yaml
+
+from bandit.core import extension_loader
+
+PROG_NAME = "bandit_conf_generator"
+LOG = logging.getLogger(__name__)
+
+
+template = """
+### Bandit config file generated from:
+# '{cli}'
+
+### This config may optionally select a subset of tests to run or skip by
+### filling out the 'tests' and 'skips' lists given below. If no tests are
+### specified for inclusion then it is assumed all tests are desired. The skips
+### set will remove specific tests from the include set. This can be controlled
+### using the -t/-s CLI options. Note that the same test ID should not appear
+### in both 'tests' and 'skips', this would be nonsensical and is detected by
+### Bandit at runtime.
+
+# Available tests:
+{test_list}
+
+# (optional) list included test IDs here, eg '[B101, B406]':
+{test}
+
+# (optional) list skipped test IDs here, eg '[B101, B406]':
+{skip}
+
+### (optional) plugin settings - some test plugins require configuration data
+### that may be given here, per-plugin. All bandit test plugins have a built in
+### set of sensible defaults and these will be used if no configuration is
+### provided. It is not necessary to provide settings for every (or any) plugin
+### if the defaults are acceptable.
+
+{settings}
+"""
+
+
+def init_logger():
+ """Init logger."""
+ LOG.handlers = []
+ log_level = logging.INFO
+ log_format_string = "[%(levelname)5s]: %(message)s"
+ logging.captureWarnings(True)
+ LOG.setLevel(log_level)
+ handler = logging.StreamHandler(sys.stdout)
+ handler.setFormatter(logging.Formatter(log_format_string))
+ LOG.addHandler(handler)
+
+
+def parse_args():
+ """Parse arguments."""
+ help_description = """Bandit Config Generator
+
+ This tool is used to generate an optional profile. The profile may be used
+ to include or skip tests and override values for plugins.
+
+ When used to store an output profile, this tool will output a template that
+ includes all plugins and their default settings. Any settings which aren't
+ being overridden can be safely removed from the profile and default values
+ will be used. Bandit will prefer settings from the profile over the built
+ in values."""
+
+ parser = argparse.ArgumentParser(
+ description=help_description,
+ formatter_class=argparse.RawTextHelpFormatter,
+ )
+ if sys.version_info >= (3, 14):
+ parser.suggest_on_error = True
+ parser.color = False
+
+ parser.add_argument(
+ "--show-defaults",
+ dest="show_defaults",
+ action="store_true",
+ help="show the default settings values for each "
+ "plugin but do not output a profile",
+ )
+ parser.add_argument(
+ "-o",
+ "--out",
+ dest="output_file",
+ action="store",
+ help="output file to save profile",
+ )
+ parser.add_argument(
+ "-t",
+ "--tests",
+ dest="tests",
+ action="store",
+ default=None,
+ type=str,
+ help="list of test names to run",
+ )
+ parser.add_argument(
+ "-s",
+ "--skip",
+ dest="skips",
+ action="store",
+ default=None,
+ type=str,
+ help="list of test names to skip",
+ )
+ args = parser.parse_args()
+
+ if not args.output_file and not args.show_defaults:
+ parser.print_help()
+ parser.exit(1)
+
+ return args
+
+
+def get_config_settings():
+ """Get configuration settings."""
+ config = {}
+ for plugin in extension_loader.MANAGER.plugins:
+ fn_name = plugin.name
+ function = plugin.plugin
+
+ # if a function takes config...
+ if hasattr(function, "_takes_config"):
+ fn_module = importlib.import_module(function.__module__)
+
+ # call the config generator if it exists
+ if hasattr(fn_module, "gen_config"):
+ config[fn_name] = fn_module.gen_config(function._takes_config)
+
+ return yaml.safe_dump(config, default_flow_style=False)
+
+
+def main():
+ """Config generator to write configuration file."""
+ init_logger()
+ args = parse_args()
+
+ yaml_settings = get_config_settings()
+
+ if args.show_defaults:
+ print(yaml_settings)
+
+ if args.output_file:
+ if os.path.exists(os.path.abspath(args.output_file)):
+ LOG.error("File %s already exists, exiting", args.output_file)
+ sys.exit(2)
+
+ try:
+ with open(args.output_file, "w") as f:
+ skips = args.skips.split(",") if args.skips else []
+ tests = args.tests.split(",") if args.tests else []
+
+ for skip in skips:
+ if not extension_loader.MANAGER.check_id(skip):
+ raise RuntimeError(f"unknown ID in skips: {skip}")
+
+ for test in tests:
+ if not extension_loader.MANAGER.check_id(test):
+ raise RuntimeError(f"unknown ID in tests: {test}")
+
+ tpl = "# {0} : {1}"
+ test_list = [
+ tpl.format(t.plugin._test_id, t.name)
+ for t in extension_loader.MANAGER.plugins
+ ]
+
+ others = [
+ tpl.format(k, v["name"])
+ for k, v in (
+ extension_loader.MANAGER.blacklist_by_id.items()
+ )
+ ]
+ test_list.extend(others)
+ test_list.sort()
+
+ contents = template.format(
+ cli=" ".join(sys.argv),
+ settings=yaml_settings,
+ test_list="\n".join(test_list),
+ skip="skips: " + str(skips) if skips else "skips:",
+ test="tests: " + str(tests) if tests else "tests:",
+ )
+ f.write(contents)
+
+ except OSError:
+ LOG.error("Unable to open %s for writing", args.output_file)
+
+ except Exception as e:
+ LOG.error("Error: %s", e)
+
+ else:
+ LOG.info("Successfully wrote profile: %s", args.output_file)
+
+ return 0
+
+
+if __name__ == "__main__":
+ sys.exit(main())
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/cli/main.py b/Backend/venv/lib/python3.12/site-packages/bandit/cli/main.py
new file mode 100644
index 00000000..f489d453
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/cli/main.py
@@ -0,0 +1,701 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+"""Bandit is a tool designed to find common security issues in Python code."""
+import argparse
+import fnmatch
+import logging
+import os
+import sys
+import textwrap
+
+import bandit
+from bandit.core import config as b_config
+from bandit.core import constants
+from bandit.core import manager as b_manager
+from bandit.core import utils
+
+BASE_CONFIG = "bandit.yaml"
+LOG = logging.getLogger()
+
+
+def _init_logger(log_level=logging.INFO, log_format=None):
+ """Initialize the logger.
+
+ :param debug: Whether to enable debug mode
+ :return: An instantiated logging instance
+ """
+ LOG.handlers = []
+
+ if not log_format:
+ # default log format
+ log_format_string = constants.log_format_string
+ else:
+ log_format_string = log_format
+
+ logging.captureWarnings(True)
+
+ LOG.setLevel(log_level)
+ handler = logging.StreamHandler(sys.stderr)
+ handler.setFormatter(logging.Formatter(log_format_string))
+ LOG.addHandler(handler)
+ LOG.debug("logging initialized")
+
+
+def _get_options_from_ini(ini_path, target):
+ """Return a dictionary of config options or None if we can't load any."""
+ ini_file = None
+
+ if ini_path:
+ ini_file = ini_path
+ else:
+ bandit_files = []
+
+ for t in target:
+ for root, _, filenames in os.walk(t):
+ for filename in fnmatch.filter(filenames, ".bandit"):
+ bandit_files.append(os.path.join(root, filename))
+
+ if len(bandit_files) > 1:
+ LOG.error(
+ "Multiple .bandit files found - scan separately or "
+ "choose one with --ini\n\t%s",
+ ", ".join(bandit_files),
+ )
+ sys.exit(2)
+
+ elif len(bandit_files) == 1:
+ ini_file = bandit_files[0]
+ LOG.info("Found project level .bandit file: %s", bandit_files[0])
+
+ if ini_file:
+ return utils.parse_ini_file(ini_file)
+ else:
+ return None
+
+
+def _init_extensions():
+ from bandit.core import extension_loader as ext_loader
+
+ return ext_loader.MANAGER
+
+
+def _log_option_source(default_val, arg_val, ini_val, option_name):
+ """It's useful to show the source of each option."""
+ # When default value is not defined, arg_val and ini_val is deterministic
+ if default_val is None:
+ if arg_val:
+ LOG.info("Using command line arg for %s", option_name)
+ return arg_val
+ elif ini_val:
+ LOG.info("Using ini file for %s", option_name)
+ return ini_val
+ else:
+ return None
+ # No value passed to commad line and default value is used
+ elif default_val == arg_val:
+ return ini_val if ini_val else arg_val
+ # Certainly a value is passed to commad line
+ else:
+ return arg_val
+
+
+def _running_under_virtualenv():
+ if hasattr(sys, "real_prefix"):
+ return True
+ elif sys.prefix != getattr(sys, "base_prefix", sys.prefix):
+ return True
+
+
+def _get_profile(config, profile_name, config_path):
+ profile = {}
+ if profile_name:
+ profiles = config.get_option("profiles") or {}
+ profile = profiles.get(profile_name)
+ if profile is None:
+ raise utils.ProfileNotFound(config_path, profile_name)
+ LOG.debug("read in legacy profile '%s': %s", profile_name, profile)
+ else:
+ profile["include"] = set(config.get_option("tests") or [])
+ profile["exclude"] = set(config.get_option("skips") or [])
+ return profile
+
+
+def _log_info(args, profile):
+ inc = ",".join([t for t in profile["include"]]) or "None"
+ exc = ",".join([t for t in profile["exclude"]]) or "None"
+ LOG.info("profile include tests: %s", inc)
+ LOG.info("profile exclude tests: %s", exc)
+ LOG.info("cli include tests: %s", args.tests)
+ LOG.info("cli exclude tests: %s", args.skips)
+
+
+def main():
+ """Bandit CLI."""
+ # bring our logging stuff up as early as possible
+ debug = (
+ logging.DEBUG
+ if "-d" in sys.argv or "--debug" in sys.argv
+ else logging.INFO
+ )
+ _init_logger(debug)
+ extension_mgr = _init_extensions()
+
+ baseline_formatters = [
+ f.name
+ for f in filter(
+ lambda x: hasattr(x.plugin, "_accepts_baseline"),
+ extension_mgr.formatters,
+ )
+ ]
+
+ # now do normal startup
+ parser = argparse.ArgumentParser(
+ description="Bandit - a Python source code security analyzer",
+ formatter_class=argparse.RawDescriptionHelpFormatter,
+ )
+ if sys.version_info >= (3, 14):
+ parser.suggest_on_error = True
+ parser.color = False
+
+ parser.add_argument(
+ "targets",
+ metavar="targets",
+ type=str,
+ nargs="*",
+ help="source file(s) or directory(s) to be tested",
+ )
+ parser.add_argument(
+ "-r",
+ "--recursive",
+ dest="recursive",
+ action="store_true",
+ help="find and process files in subdirectories",
+ )
+ parser.add_argument(
+ "-a",
+ "--aggregate",
+ dest="agg_type",
+ action="store",
+ default="file",
+ type=str,
+ choices=["file", "vuln"],
+ help="aggregate output by vulnerability (default) or by filename",
+ )
+ parser.add_argument(
+ "-n",
+ "--number",
+ dest="context_lines",
+ action="store",
+ default=3,
+ type=int,
+ help="maximum number of code lines to output for each issue",
+ )
+ parser.add_argument(
+ "-c",
+ "--configfile",
+ dest="config_file",
+ action="store",
+ default=None,
+ type=str,
+ help="optional config file to use for selecting plugins and "
+ "overriding defaults",
+ )
+ parser.add_argument(
+ "-p",
+ "--profile",
+ dest="profile",
+ action="store",
+ default=None,
+ type=str,
+ help="profile to use (defaults to executing all tests)",
+ )
+ parser.add_argument(
+ "-t",
+ "--tests",
+ dest="tests",
+ action="store",
+ default=None,
+ type=str,
+ help="comma-separated list of test IDs to run",
+ )
+ parser.add_argument(
+ "-s",
+ "--skip",
+ dest="skips",
+ action="store",
+ default=None,
+ type=str,
+ help="comma-separated list of test IDs to skip",
+ )
+ severity_group = parser.add_mutually_exclusive_group(required=False)
+ severity_group.add_argument(
+ "-l",
+ "--level",
+ dest="severity",
+ action="count",
+ default=1,
+ help="report only issues of a given severity level or "
+ "higher (-l for LOW, -ll for MEDIUM, -lll for HIGH)",
+ )
+ severity_group.add_argument(
+ "--severity-level",
+ dest="severity_string",
+ action="store",
+ help="report only issues of a given severity level or higher."
+ ' "all" and "low" are likely to produce the same results, but it'
+ " is possible for rules to be undefined which will"
+ ' not be listed in "low".',
+ choices=["all", "low", "medium", "high"],
+ )
+ confidence_group = parser.add_mutually_exclusive_group(required=False)
+ confidence_group.add_argument(
+ "-i",
+ "--confidence",
+ dest="confidence",
+ action="count",
+ default=1,
+ help="report only issues of a given confidence level or "
+ "higher (-i for LOW, -ii for MEDIUM, -iii for HIGH)",
+ )
+ confidence_group.add_argument(
+ "--confidence-level",
+ dest="confidence_string",
+ action="store",
+ help="report only issues of a given confidence level or higher."
+ ' "all" and "low" are likely to produce the same results, but it'
+ " is possible for rules to be undefined which will"
+ ' not be listed in "low".',
+ choices=["all", "low", "medium", "high"],
+ )
+ output_format = (
+ "screen"
+ if (
+ sys.stdout.isatty()
+ and os.getenv("NO_COLOR") is None
+ and os.getenv("TERM") != "dumb"
+ )
+ else "txt"
+ )
+ parser.add_argument(
+ "-f",
+ "--format",
+ dest="output_format",
+ action="store",
+ default=output_format,
+ help="specify output format",
+ choices=sorted(extension_mgr.formatter_names),
+ )
+ parser.add_argument(
+ "--msg-template",
+ action="store",
+ default=None,
+ help="specify output message template"
+ " (only usable with --format custom),"
+ " see CUSTOM FORMAT section"
+ " for list of available values",
+ )
+ parser.add_argument(
+ "-o",
+ "--output",
+ dest="output_file",
+ action="store",
+ nargs="?",
+ type=argparse.FileType("w", encoding="utf-8"),
+ default=sys.stdout,
+ help="write report to filename",
+ )
+ group = parser.add_mutually_exclusive_group(required=False)
+ group.add_argument(
+ "-v",
+ "--verbose",
+ dest="verbose",
+ action="store_true",
+ help="output extra information like excluded and included files",
+ )
+ parser.add_argument(
+ "-d",
+ "--debug",
+ dest="debug",
+ action="store_true",
+ help="turn on debug mode",
+ )
+ group.add_argument(
+ "-q",
+ "--quiet",
+ "--silent",
+ dest="quiet",
+ action="store_true",
+ help="only show output in the case of an error",
+ )
+ parser.add_argument(
+ "--ignore-nosec",
+ dest="ignore_nosec",
+ action="store_true",
+ help="do not skip lines with # nosec comments",
+ )
+ parser.add_argument(
+ "-x",
+ "--exclude",
+ dest="excluded_paths",
+ action="store",
+ default=",".join(constants.EXCLUDE),
+ help="comma-separated list of paths (glob patterns "
+ "supported) to exclude from scan "
+ "(note that these are in addition to the excluded "
+ "paths provided in the config file) (default: "
+ + ",".join(constants.EXCLUDE)
+ + ")",
+ )
+ parser.add_argument(
+ "-b",
+ "--baseline",
+ dest="baseline",
+ action="store",
+ default=None,
+ help="path of a baseline report to compare against "
+ "(only JSON-formatted files are accepted)",
+ )
+ parser.add_argument(
+ "--ini",
+ dest="ini_path",
+ action="store",
+ default=None,
+ help="path to a .bandit file that supplies command line arguments",
+ )
+ parser.add_argument(
+ "--exit-zero",
+ action="store_true",
+ dest="exit_zero",
+ default=False,
+ help="exit with 0, " "even with results found",
+ )
+ python_ver = sys.version.replace("\n", "")
+ parser.add_argument(
+ "--version",
+ action="version",
+ version=f"%(prog)s {bandit.__version__}\n"
+ f" python version = {python_ver}",
+ )
+
+ parser.set_defaults(debug=False)
+ parser.set_defaults(verbose=False)
+ parser.set_defaults(quiet=False)
+ parser.set_defaults(ignore_nosec=False)
+
+ plugin_info = [
+ f"{a[0]}\t{a[1].name}" for a in extension_mgr.plugins_by_id.items()
+ ]
+ blacklist_info = []
+ for a in extension_mgr.blacklist.items():
+ for b in a[1]:
+ blacklist_info.append(f"{b['id']}\t{b['name']}")
+
+ plugin_list = "\n\t".join(sorted(set(plugin_info + blacklist_info)))
+ dedent_text = textwrap.dedent(
+ """
+ CUSTOM FORMATTING
+ -----------------
+
+ Available tags:
+
+ {abspath}, {relpath}, {line}, {col}, {test_id},
+ {severity}, {msg}, {confidence}, {range}
+
+ Example usage:
+
+ Default template:
+ bandit -r examples/ --format custom --msg-template \\
+ "{abspath}:{line}: {test_id}[bandit]: {severity}: {msg}"
+
+ Provides same output as:
+ bandit -r examples/ --format custom
+
+ Tags can also be formatted in python string.format() style:
+ bandit -r examples/ --format custom --msg-template \\
+ "{relpath:20.20s}: {line:03}: {test_id:^8}: DEFECT: {msg:>20}"
+
+ See python documentation for more information about formatting style:
+ https://docs.python.org/3/library/string.html
+
+ The following tests were discovered and loaded:
+ -----------------------------------------------
+ """
+ )
+ parser.epilog = dedent_text + f"\t{plugin_list}"
+
+ # setup work - parse arguments, and initialize BanditManager
+ args = parser.parse_args()
+ # Check if `--msg-template` is not present without custom formatter
+ if args.output_format != "custom" and args.msg_template is not None:
+ parser.error("--msg-template can only be used with --format=custom")
+
+ # Check if confidence or severity level have been specified with strings
+ if args.severity_string is not None:
+ if args.severity_string == "all":
+ args.severity = 1
+ elif args.severity_string == "low":
+ args.severity = 2
+ elif args.severity_string == "medium":
+ args.severity = 3
+ elif args.severity_string == "high":
+ args.severity = 4
+ # Other strings will be blocked by argparse
+
+ if args.confidence_string is not None:
+ if args.confidence_string == "all":
+ args.confidence = 1
+ elif args.confidence_string == "low":
+ args.confidence = 2
+ elif args.confidence_string == "medium":
+ args.confidence = 3
+ elif args.confidence_string == "high":
+ args.confidence = 4
+ # Other strings will be blocked by argparse
+
+ # Handle .bandit files in projects to pass cmdline args from file
+ ini_options = _get_options_from_ini(args.ini_path, args.targets)
+ if ini_options:
+ # prefer command line, then ini file
+ args.config_file = _log_option_source(
+ parser.get_default("configfile"),
+ args.config_file,
+ ini_options.get("configfile"),
+ "config file",
+ )
+
+ args.excluded_paths = _log_option_source(
+ parser.get_default("excluded_paths"),
+ args.excluded_paths,
+ ini_options.get("exclude"),
+ "excluded paths",
+ )
+
+ args.skips = _log_option_source(
+ parser.get_default("skips"),
+ args.skips,
+ ini_options.get("skips"),
+ "skipped tests",
+ )
+
+ args.tests = _log_option_source(
+ parser.get_default("tests"),
+ args.tests,
+ ini_options.get("tests"),
+ "selected tests",
+ )
+
+ ini_targets = ini_options.get("targets")
+ if ini_targets:
+ ini_targets = ini_targets.split(",")
+
+ args.targets = _log_option_source(
+ parser.get_default("targets"),
+ args.targets,
+ ini_targets,
+ "selected targets",
+ )
+
+ # TODO(tmcpeak): any other useful options to pass from .bandit?
+
+ args.recursive = _log_option_source(
+ parser.get_default("recursive"),
+ args.recursive,
+ ini_options.get("recursive"),
+ "recursive scan",
+ )
+
+ args.agg_type = _log_option_source(
+ parser.get_default("agg_type"),
+ args.agg_type,
+ ini_options.get("aggregate"),
+ "aggregate output type",
+ )
+
+ args.context_lines = _log_option_source(
+ parser.get_default("context_lines"),
+ args.context_lines,
+ int(ini_options.get("number") or 0) or None,
+ "max code lines output for issue",
+ )
+
+ args.profile = _log_option_source(
+ parser.get_default("profile"),
+ args.profile,
+ ini_options.get("profile"),
+ "profile",
+ )
+
+ args.severity = _log_option_source(
+ parser.get_default("severity"),
+ args.severity,
+ ini_options.get("level"),
+ "severity level",
+ )
+
+ args.confidence = _log_option_source(
+ parser.get_default("confidence"),
+ args.confidence,
+ ini_options.get("confidence"),
+ "confidence level",
+ )
+
+ args.output_format = _log_option_source(
+ parser.get_default("output_format"),
+ args.output_format,
+ ini_options.get("format"),
+ "output format",
+ )
+
+ args.msg_template = _log_option_source(
+ parser.get_default("msg_template"),
+ args.msg_template,
+ ini_options.get("msg-template"),
+ "output message template",
+ )
+
+ args.output_file = _log_option_source(
+ parser.get_default("output_file"),
+ args.output_file,
+ ini_options.get("output"),
+ "output file",
+ )
+
+ args.verbose = _log_option_source(
+ parser.get_default("verbose"),
+ args.verbose,
+ ini_options.get("verbose"),
+ "output extra information",
+ )
+
+ args.debug = _log_option_source(
+ parser.get_default("debug"),
+ args.debug,
+ ini_options.get("debug"),
+ "debug mode",
+ )
+
+ args.quiet = _log_option_source(
+ parser.get_default("quiet"),
+ args.quiet,
+ ini_options.get("quiet"),
+ "silent mode",
+ )
+
+ args.ignore_nosec = _log_option_source(
+ parser.get_default("ignore_nosec"),
+ args.ignore_nosec,
+ ini_options.get("ignore-nosec"),
+ "do not skip lines with # nosec",
+ )
+
+ args.baseline = _log_option_source(
+ parser.get_default("baseline"),
+ args.baseline,
+ ini_options.get("baseline"),
+ "path of a baseline report",
+ )
+
+ try:
+ b_conf = b_config.BanditConfig(config_file=args.config_file)
+ except utils.ConfigError as e:
+ LOG.error(e)
+ sys.exit(2)
+
+ if not args.targets:
+ parser.print_usage()
+ sys.exit(2)
+
+ # if the log format string was set in the options, reinitialize
+ if b_conf.get_option("log_format"):
+ log_format = b_conf.get_option("log_format")
+ _init_logger(log_level=logging.DEBUG, log_format=log_format)
+
+ if args.quiet:
+ _init_logger(log_level=logging.WARN)
+
+ try:
+ profile = _get_profile(b_conf, args.profile, args.config_file)
+ _log_info(args, profile)
+
+ profile["include"].update(args.tests.split(",") if args.tests else [])
+ profile["exclude"].update(args.skips.split(",") if args.skips else [])
+ extension_mgr.validate_profile(profile)
+
+ except (utils.ProfileNotFound, ValueError) as e:
+ LOG.error(e)
+ sys.exit(2)
+
+ b_mgr = b_manager.BanditManager(
+ b_conf,
+ args.agg_type,
+ args.debug,
+ profile=profile,
+ verbose=args.verbose,
+ quiet=args.quiet,
+ ignore_nosec=args.ignore_nosec,
+ )
+
+ if args.baseline is not None:
+ try:
+ with open(args.baseline) as bl:
+ data = bl.read()
+ b_mgr.populate_baseline(data)
+ except OSError:
+ LOG.warning("Could not open baseline report: %s", args.baseline)
+ sys.exit(2)
+
+ if args.output_format not in baseline_formatters:
+ LOG.warning(
+ "Baseline must be used with one of the following "
+ "formats: " + str(baseline_formatters)
+ )
+ sys.exit(2)
+
+ if args.output_format != "json":
+ if args.config_file:
+ LOG.info("using config: %s", args.config_file)
+
+ LOG.info(
+ "running on Python %d.%d.%d",
+ sys.version_info.major,
+ sys.version_info.minor,
+ sys.version_info.micro,
+ )
+
+ # initiate file discovery step within Bandit Manager
+ b_mgr.discover_files(args.targets, args.recursive, args.excluded_paths)
+
+ if not b_mgr.b_ts.tests:
+ LOG.error("No tests would be run, please check the profile.")
+ sys.exit(2)
+
+ # initiate execution of tests within Bandit Manager
+ b_mgr.run_tests()
+ LOG.debug(b_mgr.b_ma)
+ LOG.debug(b_mgr.metrics)
+
+ # trigger output of results by Bandit Manager
+ sev_level = constants.RANKING[args.severity - 1]
+ conf_level = constants.RANKING[args.confidence - 1]
+ b_mgr.output_results(
+ args.context_lines,
+ sev_level,
+ conf_level,
+ args.output_file,
+ args.output_format,
+ args.msg_template,
+ )
+
+ if (
+ b_mgr.results_count(sev_filter=sev_level, conf_filter=conf_level) > 0
+ and not args.exit_zero
+ ):
+ sys.exit(1)
+ else:
+ sys.exit(0)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__init__.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/__init__.py
new file mode 100644
index 00000000..2efdc4dc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/__init__.py
@@ -0,0 +1,15 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+from bandit.core import config # noqa
+from bandit.core import context # noqa
+from bandit.core import manager # noqa
+from bandit.core import meta_ast # noqa
+from bandit.core import node_visitor # noqa
+from bandit.core import test_set # noqa
+from bandit.core import tester # noqa
+from bandit.core import utils # noqa
+from bandit.core.constants import * # noqa
+from bandit.core.issue import * # noqa
+from bandit.core.test_properties import * # noqa
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..48b87e92
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/blacklisting.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/blacklisting.cpython-312.pyc
new file mode 100644
index 00000000..1e73dd4d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/blacklisting.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/config.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/config.cpython-312.pyc
new file mode 100644
index 00000000..d028d56d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/config.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/constants.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/constants.cpython-312.pyc
new file mode 100644
index 00000000..4f621930
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/constants.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/context.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/context.cpython-312.pyc
new file mode 100644
index 00000000..ad0fd324
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/context.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/docs_utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/docs_utils.cpython-312.pyc
new file mode 100644
index 00000000..fa9e3873
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/docs_utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/extension_loader.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/extension_loader.cpython-312.pyc
new file mode 100644
index 00000000..2f7b30fa
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/extension_loader.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/issue.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/issue.cpython-312.pyc
new file mode 100644
index 00000000..54c15e72
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/issue.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/manager.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/manager.cpython-312.pyc
new file mode 100644
index 00000000..a72ece0c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/manager.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/meta_ast.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/meta_ast.cpython-312.pyc
new file mode 100644
index 00000000..af62fec9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/meta_ast.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/metrics.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/metrics.cpython-312.pyc
new file mode 100644
index 00000000..8d348680
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/metrics.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/node_visitor.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/node_visitor.cpython-312.pyc
new file mode 100644
index 00000000..6d04e5c9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/node_visitor.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/test_properties.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/test_properties.cpython-312.pyc
new file mode 100644
index 00000000..e4468793
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/test_properties.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/test_set.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/test_set.cpython-312.pyc
new file mode 100644
index 00000000..375bb26f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/test_set.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/tester.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/tester.cpython-312.pyc
new file mode 100644
index 00000000..e1b15bd1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/tester.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/utils.cpython-312.pyc
new file mode 100644
index 00000000..43ba1ab2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/core/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/blacklisting.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/blacklisting.py
new file mode 100644
index 00000000..3d05fbaa
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/blacklisting.py
@@ -0,0 +1,72 @@
+#
+# Copyright 2016 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+
+from bandit.core import issue
+
+
+def report_issue(check, name):
+ return issue.Issue(
+ severity=check.get("level", "MEDIUM"),
+ confidence="HIGH",
+ cwe=check.get("cwe", issue.Cwe.NOTSET),
+ text=check["message"].replace("{name}", name),
+ ident=name,
+ test_id=check.get("id", "LEGACY"),
+ )
+
+
+def blacklist(context, config):
+ """Generic blacklist test, B001.
+
+ This generic blacklist test will be called for any encountered node with
+ defined blacklist data available. This data is loaded via plugins using
+ the 'bandit.blacklists' entry point. Please see the documentation for more
+ details. Each blacklist datum has a unique bandit ID that may be used for
+ filtering purposes, or alternatively all blacklisting can be filtered using
+ the id of this built in test, 'B001'.
+ """
+ blacklists = config
+ node_type = context.node.__class__.__name__
+
+ if node_type == "Call":
+ func = context.node.func
+ if isinstance(func, ast.Name) and func.id == "__import__":
+ if len(context.node.args):
+ if isinstance(
+ context.node.args[0], ast.Constant
+ ) and isinstance(context.node.args[0].value, str):
+ name = context.node.args[0].value
+ else:
+ # TODO(??): import through a variable, need symbol tab
+ name = "UNKNOWN"
+ else:
+ name = "" # handle '__import__()'
+ else:
+ name = context.call_function_name_qual
+ # In the case the Call is an importlib.import, treat the first
+ # argument name as an actual import module name.
+ # Will produce None if argument is not a literal or identifier
+ if name in ["importlib.import_module", "importlib.__import__"]:
+ if context.call_args_count > 0:
+ name = context.call_args[0]
+ else:
+ name = context.call_keywords["name"]
+ for check in blacklists[node_type]:
+ for qn in check["qualnames"]:
+ if name is not None and name == qn:
+ return report_issue(check, name)
+
+ if node_type.startswith("Import"):
+ prefix = ""
+ if node_type == "ImportFrom":
+ if context.node.module is not None:
+ prefix = context.node.module + "."
+
+ for check in blacklists[node_type]:
+ for name in context.node.names:
+ for qn in check["qualnames"]:
+ if (prefix + name.name).startswith(qn):
+ return report_issue(check, name.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/config.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/config.py
new file mode 100644
index 00000000..dbc68fb7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/config.py
@@ -0,0 +1,271 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import logging
+import sys
+
+import yaml
+
+if sys.version_info >= (3, 11):
+ import tomllib
+else:
+ try:
+ import tomli as tomllib
+ except ImportError:
+ tomllib = None
+
+from bandit.core import constants
+from bandit.core import extension_loader
+from bandit.core import utils
+
+LOG = logging.getLogger(__name__)
+
+
+class BanditConfig:
+ def __init__(self, config_file=None):
+ """Attempt to initialize a config dictionary from a yaml file.
+
+ Error out if loading the yaml file fails for any reason.
+ :param config_file: The Bandit yaml config file
+
+ :raises bandit.utils.ConfigError: If the config is invalid or
+ unreadable.
+ """
+ self.config_file = config_file
+ self._config = {}
+
+ if config_file:
+ try:
+ f = open(config_file, "rb")
+ except OSError:
+ raise utils.ConfigError(
+ "Could not read config file.", config_file
+ )
+
+ if config_file.endswith(".toml"):
+ if tomllib is None:
+ raise utils.ConfigError(
+ "toml parser not available, reinstall with toml extra",
+ config_file,
+ )
+
+ try:
+ with f:
+ self._config = (
+ tomllib.load(f).get("tool", {}).get("bandit", {})
+ )
+ except tomllib.TOMLDecodeError as err:
+ LOG.error(err)
+ raise utils.ConfigError("Error parsing file.", config_file)
+ else:
+ try:
+ with f:
+ self._config = yaml.safe_load(f)
+ except yaml.YAMLError as err:
+ LOG.error(err)
+ raise utils.ConfigError("Error parsing file.", config_file)
+
+ self.validate(config_file)
+
+ # valid config must be a dict
+ if not isinstance(self._config, dict):
+ raise utils.ConfigError("Error parsing file.", config_file)
+
+ self.convert_legacy_config()
+
+ else:
+ # use sane defaults
+ self._config["plugin_name_pattern"] = "*.py"
+ self._config["include"] = ["*.py", "*.pyw"]
+
+ self._init_settings()
+
+ def get_option(self, option_string):
+ """Returns the option from the config specified by the option_string.
+
+ '.' can be used to denote levels, for example to retrieve the options
+ from the 'a' profile you can use 'profiles.a'
+ :param option_string: The string specifying the option to retrieve
+ :return: The object specified by the option_string, or None if it can't
+ be found.
+ """
+ option_levels = option_string.split(".")
+ cur_item = self._config
+ for level in option_levels:
+ if cur_item and (level in cur_item):
+ cur_item = cur_item[level]
+ else:
+ return None
+
+ return cur_item
+
+ def get_setting(self, setting_name):
+ if setting_name in self._settings:
+ return self._settings[setting_name]
+ else:
+ return None
+
+ @property
+ def config(self):
+ """Property to return the config dictionary
+
+ :return: Config dictionary
+ """
+ return self._config
+
+ def _init_settings(self):
+ """This function calls a set of other functions (one per setting)
+
+ This function calls a set of other functions (one per setting) to build
+ out the _settings dictionary. Each other function will set values from
+ the config (if set), otherwise use defaults (from constants if
+ possible).
+ :return: -
+ """
+ self._settings = {}
+ self._init_plugin_name_pattern()
+
+ def _init_plugin_name_pattern(self):
+ """Sets settings['plugin_name_pattern'] from default or config file."""
+ plugin_name_pattern = constants.plugin_name_pattern
+ if self.get_option("plugin_name_pattern"):
+ plugin_name_pattern = self.get_option("plugin_name_pattern")
+ self._settings["plugin_name_pattern"] = plugin_name_pattern
+
+ def convert_legacy_config(self):
+ updated_profiles = self.convert_names_to_ids()
+ bad_calls, bad_imports = self.convert_legacy_blacklist_data()
+
+ if updated_profiles:
+ self.convert_legacy_blacklist_tests(
+ updated_profiles, bad_calls, bad_imports
+ )
+ self._config["profiles"] = updated_profiles
+
+ def convert_names_to_ids(self):
+ """Convert test names to IDs, unknown names are left unchanged."""
+ extman = extension_loader.MANAGER
+
+ updated_profiles = {}
+ for name, profile in (self.get_option("profiles") or {}).items():
+ # NOTE(tkelsey): can't use default of get() because value is
+ # sometimes explicitly 'None', for example when the list is given
+ # in yaml but not populated with any values.
+ include = {
+ (extman.get_test_id(i) or i)
+ for i in (profile.get("include") or [])
+ }
+ exclude = {
+ (extman.get_test_id(i) or i)
+ for i in (profile.get("exclude") or [])
+ }
+ updated_profiles[name] = {"include": include, "exclude": exclude}
+ return updated_profiles
+
+ def convert_legacy_blacklist_data(self):
+ """Detect legacy blacklist data and convert it to new format."""
+ bad_calls_list = []
+ bad_imports_list = []
+
+ bad_calls = self.get_option("blacklist_calls") or {}
+ bad_calls = bad_calls.get("bad_name_sets", {})
+ for item in bad_calls:
+ for key, val in item.items():
+ val["name"] = key
+ val["message"] = val["message"].replace("{func}", "{name}")
+ bad_calls_list.append(val)
+
+ bad_imports = self.get_option("blacklist_imports") or {}
+ bad_imports = bad_imports.get("bad_import_sets", {})
+ for item in bad_imports:
+ for key, val in item.items():
+ val["name"] = key
+ val["message"] = val["message"].replace("{module}", "{name}")
+ val["qualnames"] = val["imports"]
+ del val["imports"]
+ bad_imports_list.append(val)
+
+ if bad_imports_list or bad_calls_list:
+ LOG.warning(
+ "Legacy blacklist data found in config, overriding "
+ "data plugins"
+ )
+ return bad_calls_list, bad_imports_list
+
+ @staticmethod
+ def convert_legacy_blacklist_tests(profiles, bad_imports, bad_calls):
+ """Detect old blacklist tests, convert to use new builtin."""
+
+ def _clean_set(name, data):
+ if name in data:
+ data.remove(name)
+ data.add("B001")
+
+ for name, profile in profiles.items():
+ blacklist = {}
+ include = profile["include"]
+ exclude = profile["exclude"]
+
+ name = "blacklist_calls"
+ if name in include and name not in exclude:
+ blacklist.setdefault("Call", []).extend(bad_calls)
+
+ _clean_set(name, include)
+ _clean_set(name, exclude)
+
+ name = "blacklist_imports"
+ if name in include and name not in exclude:
+ blacklist.setdefault("Import", []).extend(bad_imports)
+ blacklist.setdefault("ImportFrom", []).extend(bad_imports)
+ blacklist.setdefault("Call", []).extend(bad_imports)
+
+ _clean_set(name, include)
+ _clean_set(name, exclude)
+ _clean_set("blacklist_import_func", include)
+ _clean_set("blacklist_import_func", exclude)
+
+ # This can happen with a legacy config that includes
+ # blacklist_calls but exclude blacklist_imports for example
+ if "B001" in include and "B001" in exclude:
+ exclude.remove("B001")
+
+ profile["blacklist"] = blacklist
+
+ def validate(self, path):
+ """Validate the config data."""
+ legacy = False
+ message = (
+ "Config file has an include or exclude reference "
+ "to legacy test '{0}' but no configuration data for "
+ "it. Configuration data is required for this test. "
+ "Please consider switching to the new config file "
+ "format, the tool 'bandit-config-generator' can help "
+ "you with this."
+ )
+
+ def _test(key, block, exclude, include):
+ if key in exclude or key in include:
+ if self._config.get(block) is None:
+ raise utils.ConfigError(message.format(key), path)
+
+ if "profiles" in self._config:
+ legacy = True
+ for profile in self._config["profiles"].values():
+ inc = profile.get("include") or set()
+ exc = profile.get("exclude") or set()
+
+ _test("blacklist_imports", "blacklist_imports", inc, exc)
+ _test("blacklist_import_func", "blacklist_imports", inc, exc)
+ _test("blacklist_calls", "blacklist_calls", inc, exc)
+
+ # show deprecation message
+ if legacy:
+ LOG.warning(
+ "Config file '%s' contains deprecated legacy config "
+ "data. Please consider upgrading to the new config "
+ "format. The tool 'bandit-config-generator' can help "
+ "you with this. Support for legacy configs will be "
+ "removed in a future bandit version.",
+ path,
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/constants.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/constants.py
new file mode 100644
index 00000000..dd8ddeb9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/constants.py
@@ -0,0 +1,40 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+# default plugin name pattern
+plugin_name_pattern = "*.py"
+
+RANKING = ["UNDEFINED", "LOW", "MEDIUM", "HIGH"]
+RANKING_VALUES = {"UNDEFINED": 1, "LOW": 3, "MEDIUM": 5, "HIGH": 10}
+CRITERIA = [("SEVERITY", "UNDEFINED"), ("CONFIDENCE", "UNDEFINED")]
+
+# add each ranking to globals, to allow direct access in module name space
+for rank in RANKING:
+ globals()[rank] = rank
+
+CONFIDENCE_DEFAULT = "UNDEFINED"
+
+# A list of values Python considers to be False.
+# These can be useful in tests to check if a value is True or False.
+# We don't handle the case of user-defined classes being false.
+# These are only useful when we have a constant in code. If we
+# have a variable we cannot determine if False.
+# See https://docs.python.org/3/library/stdtypes.html#truth-value-testing
+FALSE_VALUES = [None, False, "False", 0, 0.0, 0j, "", (), [], {}]
+
+# override with "log_format" option in config file
+log_format_string = "[%(module)s]\t%(levelname)s\t%(message)s"
+
+# Directories to exclude by default
+EXCLUDE = (
+ ".svn",
+ "CVS",
+ ".bzr",
+ ".hg",
+ ".git",
+ "__pycache__",
+ ".tox",
+ ".eggs",
+ "*.egg",
+)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/context.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/context.py
new file mode 100644
index 00000000..8de21b26
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/context.py
@@ -0,0 +1,316 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+
+from bandit.core import utils
+
+
+class Context:
+ def __init__(self, context_object=None):
+ """Initialize the class with a context, empty dict otherwise
+
+ :param context_object: The context object to create class from
+ :return: -
+ """
+ if context_object is not None:
+ self._context = context_object
+ else:
+ self._context = dict()
+
+ def __repr__(self):
+ """Generate representation of object for printing / interactive use
+
+ Most likely only interested in non-default properties, so we return
+ the string version of _context.
+
+ Example string returned:
+ , 'function': None,
+ 'name': 'socket', 'imports': set(['socket']), 'module': None,
+ 'filename': 'examples/binding.py',
+ 'call': <_ast.Call object at 0x110252510>, 'lineno': 3,
+ 'import_aliases': {}, 'qualname': 'socket.socket'}>
+
+ :return: A string representation of the object
+ """
+ return f""
+
+ @property
+ def call_args(self):
+ """Get a list of function args
+
+ :return: A list of function args
+ """
+ args = []
+ if "call" in self._context and hasattr(self._context["call"], "args"):
+ for arg in self._context["call"].args:
+ if hasattr(arg, "attr"):
+ args.append(arg.attr)
+ else:
+ args.append(self._get_literal_value(arg))
+ return args
+
+ @property
+ def call_args_count(self):
+ """Get the number of args a function call has
+
+ :return: The number of args a function call has or None
+ """
+ if "call" in self._context and hasattr(self._context["call"], "args"):
+ return len(self._context["call"].args)
+ else:
+ return None
+
+ @property
+ def call_function_name(self):
+ """Get the name (not FQ) of a function call
+
+ :return: The name (not FQ) of a function call
+ """
+ return self._context.get("name")
+
+ @property
+ def call_function_name_qual(self):
+ """Get the FQ name of a function call
+
+ :return: The FQ name of a function call
+ """
+ return self._context.get("qualname")
+
+ @property
+ def call_keywords(self):
+ """Get a dictionary of keyword parameters
+
+ :return: A dictionary of keyword parameters for a call as strings
+ """
+ if "call" in self._context and hasattr(
+ self._context["call"], "keywords"
+ ):
+ return_dict = {}
+ for li in self._context["call"].keywords:
+ if hasattr(li.value, "attr"):
+ return_dict[li.arg] = li.value.attr
+ else:
+ return_dict[li.arg] = self._get_literal_value(li.value)
+ return return_dict
+ else:
+ return None
+
+ @property
+ def node(self):
+ """Get the raw AST node associated with the context
+
+ :return: The raw AST node associated with the context
+ """
+ return self._context.get("node")
+
+ @property
+ def string_val(self):
+ """Get the value of a standalone unicode or string object
+
+ :return: value of a standalone unicode or string object
+ """
+ return self._context.get("str")
+
+ @property
+ def bytes_val(self):
+ """Get the value of a standalone bytes object (py3 only)
+
+ :return: value of a standalone bytes object
+ """
+ return self._context.get("bytes")
+
+ @property
+ def string_val_as_escaped_bytes(self):
+ """Get escaped value of the object.
+
+ Turn the value of a string or bytes object into byte sequence with
+ unknown, control, and \\ characters escaped.
+
+ This function should be used when looking for a known sequence in a
+ potentially badly encoded string in the code.
+
+ :return: sequence of printable ascii bytes representing original string
+ """
+ val = self.string_val
+ if val is not None:
+ # it's any of str or unicode in py2, or str in py3
+ return val.encode("unicode_escape")
+
+ val = self.bytes_val
+ if val is not None:
+ return utils.escaped_bytes_representation(val)
+
+ return None
+
+ @property
+ def statement(self):
+ """Get the raw AST for the current statement
+
+ :return: The raw AST for the current statement
+ """
+ return self._context.get("statement")
+
+ @property
+ def function_def_defaults_qual(self):
+ """Get a list of fully qualified default values in a function def
+
+ :return: List of defaults
+ """
+ defaults = []
+ if (
+ "node" in self._context
+ and hasattr(self._context["node"], "args")
+ and hasattr(self._context["node"].args, "defaults")
+ ):
+ for default in self._context["node"].args.defaults:
+ defaults.append(
+ utils.get_qual_attr(
+ default, self._context["import_aliases"]
+ )
+ )
+ return defaults
+
+ def _get_literal_value(self, literal):
+ """Utility function to turn AST literals into native Python types
+
+ :param literal: The AST literal to convert
+ :return: The value of the AST literal
+ """
+ if isinstance(literal, ast.Constant):
+ if isinstance(literal.value, bool):
+ literal_value = str(literal.value)
+ elif literal.value is None:
+ literal_value = str(literal.value)
+ else:
+ literal_value = literal.value
+
+ elif isinstance(literal, ast.List):
+ return_list = list()
+ for li in literal.elts:
+ return_list.append(self._get_literal_value(li))
+ literal_value = return_list
+
+ elif isinstance(literal, ast.Tuple):
+ return_tuple = tuple()
+ for ti in literal.elts:
+ return_tuple += (self._get_literal_value(ti),)
+ literal_value = return_tuple
+
+ elif isinstance(literal, ast.Set):
+ return_set = set()
+ for si in literal.elts:
+ return_set.add(self._get_literal_value(si))
+ literal_value = return_set
+
+ elif isinstance(literal, ast.Dict):
+ literal_value = dict(zip(literal.keys, literal.values))
+
+ elif isinstance(literal, ast.Name):
+ literal_value = literal.id
+
+ else:
+ literal_value = None
+
+ return literal_value
+
+ def get_call_arg_value(self, argument_name):
+ """Gets the value of a named argument in a function call.
+
+ :return: named argument value
+ """
+ kwd_values = self.call_keywords
+ if kwd_values is not None and argument_name in kwd_values:
+ return kwd_values[argument_name]
+
+ def check_call_arg_value(self, argument_name, argument_values=None):
+ """Checks for a value of a named argument in a function call.
+
+ Returns none if the specified argument is not found.
+ :param argument_name: A string - name of the argument to look for
+ :param argument_values: the value, or list of values to test against
+ :return: Boolean True if argument found and matched, False if
+ found and not matched, None if argument not found at all
+ """
+ arg_value = self.get_call_arg_value(argument_name)
+ if arg_value is not None:
+ if not isinstance(argument_values, list):
+ # if passed a single value, or a tuple, convert to a list
+ argument_values = list((argument_values,))
+ for val in argument_values:
+ if arg_value == val:
+ return True
+ return False
+ else:
+ # argument name not found, return None to allow testing for this
+ # eventuality
+ return None
+
+ def get_lineno_for_call_arg(self, argument_name):
+ """Get the line number for a specific named argument
+
+ In case the call is split over multiple lines, get the correct one for
+ the argument.
+ :param argument_name: A string - name of the argument to look for
+ :return: Integer - the line number of the found argument, or -1
+ """
+ if hasattr(self.node, "keywords"):
+ for key in self.node.keywords:
+ if key.arg == argument_name:
+ return key.value.lineno
+
+ def get_call_arg_at_position(self, position_num):
+ """Returns positional argument at the specified position (if it exists)
+
+ :param position_num: The index of the argument to return the value for
+ :return: Value of the argument at the specified position if it exists
+ """
+ max_args = self.call_args_count
+ if max_args and position_num < max_args:
+ arg = self._context["call"].args[position_num]
+ return getattr(arg, "attr", None) or self._get_literal_value(arg)
+ else:
+ return None
+
+ def is_module_being_imported(self, module):
+ """Check for the specified module is currently being imported
+
+ :param module: The module name to look for
+ :return: True if the module is found, False otherwise
+ """
+ return self._context.get("module") == module
+
+ def is_module_imported_exact(self, module):
+ """Check if a specified module has been imported; only exact matches.
+
+ :param module: The module name to look for
+ :return: True if the module is found, False otherwise
+ """
+ return module in self._context.get("imports", [])
+
+ def is_module_imported_like(self, module):
+ """Check if a specified module has been imported
+
+ Check if a specified module has been imported; specified module exists
+ as part of any import statement.
+ :param module: The module name to look for
+ :return: True if the module is found, False otherwise
+ """
+ if "imports" in self._context:
+ for imp in self._context["imports"]:
+ if module in imp:
+ return True
+ return False
+
+ @property
+ def filename(self):
+ return self._context.get("filename")
+
+ @property
+ def file_data(self):
+ return self._context.get("file_data")
+
+ @property
+ def import_aliases(self):
+ return self._context.get("import_aliases")
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/docs_utils.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/docs_utils.py
new file mode 100644
index 00000000..5a5575b5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/docs_utils.py
@@ -0,0 +1,54 @@
+#
+# Copyright 2016 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import bandit
+
+
+def get_url(bid):
+ # where our docs are hosted
+ base_url = f"https://bandit.readthedocs.io/en/{bandit.__version__}/"
+
+ # NOTE(tkelsey): for some reason this import can't be found when stevedore
+ # loads up the formatter plugin that imports this file. It is available
+ # later though.
+ from bandit.core import extension_loader
+
+ info = extension_loader.MANAGER.plugins_by_id.get(bid)
+ if info is not None:
+ return f"{base_url}plugins/{bid.lower()}_{info.plugin.__name__}.html"
+
+ info = extension_loader.MANAGER.blacklist_by_id.get(bid)
+ if info is not None:
+ template = "blacklists/blacklist_{kind}.html#{id}-{name}"
+ info["name"] = info["name"].replace("_", "-")
+
+ if info["id"].startswith("B3"): # B3XX
+ # Some of the links are combined, so we have exception cases
+ if info["id"] in ["B304", "B305"]:
+ info = info.copy()
+ info["id"] = "b304-b305"
+ info["name"] = "ciphers-and-modes"
+ elif info["id"] in [
+ "B313",
+ "B314",
+ "B315",
+ "B316",
+ "B317",
+ "B318",
+ "B319",
+ "B320",
+ ]:
+ info = info.copy()
+ info["id"] = "b313-b320"
+ ext = template.format(
+ kind="calls", id=info["id"], name=info["name"]
+ )
+ else:
+ ext = template.format(
+ kind="imports", id=info["id"], name=info["name"]
+ )
+
+ return base_url + ext.lower()
+
+ return base_url # no idea, give the docs main page
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/extension_loader.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/extension_loader.py
new file mode 100644
index 00000000..ec28a0ab
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/extension_loader.py
@@ -0,0 +1,114 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+import logging
+import sys
+
+from stevedore import extension
+
+from bandit.core import utils
+
+LOG = logging.getLogger(__name__)
+
+
+class Manager:
+ # These IDs are for bandit built in tests
+ builtin = ["B001"] # Built in blacklist test
+
+ def __init__(
+ self,
+ formatters_namespace="bandit.formatters",
+ plugins_namespace="bandit.plugins",
+ blacklists_namespace="bandit.blacklists",
+ ):
+ # Cache the extension managers, loaded extensions, and extension names
+ self.load_formatters(formatters_namespace)
+ self.load_plugins(plugins_namespace)
+ self.load_blacklists(blacklists_namespace)
+
+ def load_formatters(self, formatters_namespace):
+ self.formatters_mgr = extension.ExtensionManager(
+ namespace=formatters_namespace,
+ invoke_on_load=False,
+ verify_requirements=False,
+ )
+ self.formatters = list(self.formatters_mgr)
+ self.formatter_names = self.formatters_mgr.names()
+
+ def load_plugins(self, plugins_namespace):
+ self.plugins_mgr = extension.ExtensionManager(
+ namespace=plugins_namespace,
+ invoke_on_load=False,
+ verify_requirements=False,
+ )
+
+ def test_has_id(plugin):
+ if not hasattr(plugin.plugin, "_test_id"):
+ # logger not setup yet, so using print
+ print(
+ f"WARNING: Test '{plugin.name}' has no ID, skipping.",
+ file=sys.stderr,
+ )
+ return False
+ return True
+
+ self.plugins = list(filter(test_has_id, list(self.plugins_mgr)))
+ self.plugin_names = [plugin.name for plugin in self.plugins]
+ self.plugins_by_id = {p.plugin._test_id: p for p in self.plugins}
+ self.plugins_by_name = {p.name: p for p in self.plugins}
+
+ def get_test_id(self, test_name):
+ if test_name in self.plugins_by_name:
+ return self.plugins_by_name[test_name].plugin._test_id
+ if test_name in self.blacklist_by_name:
+ return self.blacklist_by_name[test_name]["id"]
+ return None
+
+ def load_blacklists(self, blacklist_namespace):
+ self.blacklists_mgr = extension.ExtensionManager(
+ namespace=blacklist_namespace,
+ invoke_on_load=False,
+ verify_requirements=False,
+ )
+ self.blacklist = {}
+ blacklist = list(self.blacklists_mgr)
+ for item in blacklist:
+ for key, val in item.plugin().items():
+ utils.check_ast_node(key)
+ self.blacklist.setdefault(key, []).extend(val)
+
+ self.blacklist_by_id = {}
+ self.blacklist_by_name = {}
+ for val in self.blacklist.values():
+ for b in val:
+ self.blacklist_by_id[b["id"]] = b
+ self.blacklist_by_name[b["name"]] = b
+
+ def validate_profile(self, profile):
+ """Validate that everything in the configured profiles looks good."""
+ for inc in profile["include"]:
+ if not self.check_id(inc):
+ LOG.warning(f"Unknown test found in profile: {inc}")
+
+ for exc in profile["exclude"]:
+ if not self.check_id(exc):
+ LOG.warning(f"Unknown test found in profile: {exc}")
+
+ union = set(profile["include"]) & set(profile["exclude"])
+ if len(union) > 0:
+ raise ValueError(
+ f"Non-exclusive include/exclude test sets: {union}"
+ )
+
+ def check_id(self, test):
+ return (
+ test in self.plugins_by_id
+ or test in self.blacklist_by_id
+ or test in self.builtin
+ )
+
+
+# Using entry-points and pkg_resources *can* be expensive. So let's load these
+# once, store them on the object, and have a module global object for
+# accessing them. After the first time this module is imported, it should save
+# this attribute on the module and not have to reload the entry-points.
+MANAGER = Manager()
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/issue.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/issue.py
new file mode 100644
index 00000000..b2d90154
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/issue.py
@@ -0,0 +1,245 @@
+#
+# Copyright 2015 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import linecache
+
+from bandit.core import constants
+
+
+class Cwe:
+ NOTSET = 0
+ IMPROPER_INPUT_VALIDATION = 20
+ PATH_TRAVERSAL = 22
+ OS_COMMAND_INJECTION = 78
+ XSS = 79
+ BASIC_XSS = 80
+ SQL_INJECTION = 89
+ CODE_INJECTION = 94
+ IMPROPER_WILDCARD_NEUTRALIZATION = 155
+ HARD_CODED_PASSWORD = 259
+ IMPROPER_ACCESS_CONTROL = 284
+ IMPROPER_CERT_VALIDATION = 295
+ CLEARTEXT_TRANSMISSION = 319
+ INADEQUATE_ENCRYPTION_STRENGTH = 326
+ BROKEN_CRYPTO = 327
+ INSUFFICIENT_RANDOM_VALUES = 330
+ INSECURE_TEMP_FILE = 377
+ UNCONTROLLED_RESOURCE_CONSUMPTION = 400
+ DOWNLOAD_OF_CODE_WITHOUT_INTEGRITY_CHECK = 494
+ DESERIALIZATION_OF_UNTRUSTED_DATA = 502
+ MULTIPLE_BINDS = 605
+ IMPROPER_CHECK_OF_EXCEPT_COND = 703
+ INCORRECT_PERMISSION_ASSIGNMENT = 732
+ INAPPROPRIATE_ENCODING_FOR_OUTPUT_CONTEXT = 838
+
+ MITRE_URL_PATTERN = "https://cwe.mitre.org/data/definitions/%s.html"
+
+ def __init__(self, id=NOTSET):
+ self.id = id
+
+ def link(self):
+ if self.id == Cwe.NOTSET:
+ return ""
+
+ return Cwe.MITRE_URL_PATTERN % str(self.id)
+
+ def __str__(self):
+ if self.id == Cwe.NOTSET:
+ return ""
+
+ return "CWE-%i (%s)" % (self.id, self.link())
+
+ def as_dict(self):
+ return (
+ {"id": self.id, "link": self.link()}
+ if self.id != Cwe.NOTSET
+ else {}
+ )
+
+ def as_jsons(self):
+ return str(self.as_dict())
+
+ def from_dict(self, data):
+ if "id" in data:
+ self.id = int(data["id"])
+ else:
+ self.id = Cwe.NOTSET
+
+ def __eq__(self, other):
+ return self.id == other.id
+
+ def __ne__(self, other):
+ return self.id != other.id
+
+ def __hash__(self):
+ return id(self)
+
+
+class Issue:
+ def __init__(
+ self,
+ severity,
+ cwe=0,
+ confidence=constants.CONFIDENCE_DEFAULT,
+ text="",
+ ident=None,
+ lineno=None,
+ test_id="",
+ col_offset=-1,
+ end_col_offset=0,
+ ):
+ self.severity = severity
+ self.cwe = Cwe(cwe)
+ self.confidence = confidence
+ if isinstance(text, bytes):
+ text = text.decode("utf-8")
+ self.text = text
+ self.ident = ident
+ self.fname = ""
+ self.fdata = None
+ self.test = ""
+ self.test_id = test_id
+ self.lineno = lineno
+ self.col_offset = col_offset
+ self.end_col_offset = end_col_offset
+ self.linerange = []
+
+ def __str__(self):
+ return (
+ "Issue: '%s' from %s:%s: CWE: %s, Severity: %s Confidence: "
+ "%s at %s:%i:%i"
+ ) % (
+ self.text,
+ self.test_id,
+ (self.ident or self.test),
+ str(self.cwe),
+ self.severity,
+ self.confidence,
+ self.fname,
+ self.lineno,
+ self.col_offset,
+ )
+
+ def __eq__(self, other):
+ # if the issue text, severity, confidence, and filename match, it's
+ # the same issue from our perspective
+ match_types = [
+ "text",
+ "severity",
+ "cwe",
+ "confidence",
+ "fname",
+ "test",
+ "test_id",
+ ]
+ return all(
+ getattr(self, field) == getattr(other, field)
+ for field in match_types
+ )
+
+ def __ne__(self, other):
+ return not self.__eq__(other)
+
+ def __hash__(self):
+ return id(self)
+
+ def filter(self, severity, confidence):
+ """Utility to filter on confidence and severity
+
+ This function determines whether an issue should be included by
+ comparing the severity and confidence rating of the issue to minimum
+ thresholds specified in 'severity' and 'confidence' respectively.
+
+ Formatters should call manager.filter_results() directly.
+
+ This will return false if either the confidence or severity of the
+ issue are lower than the given threshold values.
+
+ :param severity: Severity threshold
+ :param confidence: Confidence threshold
+ :return: True/False depending on whether issue meets threshold
+
+ """
+ rank = constants.RANKING
+ return rank.index(self.severity) >= rank.index(
+ severity
+ ) and rank.index(self.confidence) >= rank.index(confidence)
+
+ def get_code(self, max_lines=3, tabbed=False):
+ """Gets lines of code from a file the generated this issue.
+
+ :param max_lines: Max lines of context to return
+ :param tabbed: Use tabbing in the output
+ :return: strings of code
+ """
+ lines = []
+ max_lines = max(max_lines, 1)
+ lmin = max(1, self.lineno - max_lines // 2)
+ lmax = lmin + len(self.linerange) + max_lines - 1
+
+ if self.fname == "":
+ self.fdata.seek(0)
+ for line_num in range(1, lmin):
+ self.fdata.readline()
+
+ tmplt = "%i\t%s" if tabbed else "%i %s"
+ for line in range(lmin, lmax):
+ if self.fname == "":
+ text = self.fdata.readline()
+ else:
+ text = linecache.getline(self.fname, line)
+
+ if isinstance(text, bytes):
+ text = text.decode("utf-8")
+
+ if not len(text):
+ break
+ lines.append(tmplt % (line, text))
+ return "".join(lines)
+
+ def as_dict(self, with_code=True, max_lines=3):
+ """Convert the issue to a dict of values for outputting."""
+ out = {
+ "filename": self.fname,
+ "test_name": self.test,
+ "test_id": self.test_id,
+ "issue_severity": self.severity,
+ "issue_cwe": self.cwe.as_dict(),
+ "issue_confidence": self.confidence,
+ "issue_text": self.text.encode("utf-8").decode("utf-8"),
+ "line_number": self.lineno,
+ "line_range": self.linerange,
+ "col_offset": self.col_offset,
+ "end_col_offset": self.end_col_offset,
+ }
+
+ if with_code:
+ out["code"] = self.get_code(max_lines=max_lines)
+ return out
+
+ def from_dict(self, data, with_code=True):
+ self.code = data["code"]
+ self.fname = data["filename"]
+ self.severity = data["issue_severity"]
+ self.cwe = cwe_from_dict(data["issue_cwe"])
+ self.confidence = data["issue_confidence"]
+ self.text = data["issue_text"]
+ self.test = data["test_name"]
+ self.test_id = data["test_id"]
+ self.lineno = data["line_number"]
+ self.linerange = data["line_range"]
+ self.col_offset = data.get("col_offset", 0)
+ self.end_col_offset = data.get("end_col_offset", 0)
+
+
+def cwe_from_dict(data):
+ cwe = Cwe()
+ cwe.from_dict(data)
+ return cwe
+
+
+def issue_from_dict(data):
+ i = Issue(severity=data["issue_severity"])
+ i.from_dict(data)
+ return i
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/manager.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/manager.py
new file mode 100644
index 00000000..ffc13ca9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/manager.py
@@ -0,0 +1,499 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import collections
+import fnmatch
+import io
+import json
+import logging
+import os
+import re
+import sys
+import tokenize
+import traceback
+
+from rich import progress
+
+from bandit.core import constants as b_constants
+from bandit.core import extension_loader
+from bandit.core import issue
+from bandit.core import meta_ast as b_meta_ast
+from bandit.core import metrics
+from bandit.core import node_visitor as b_node_visitor
+from bandit.core import test_set as b_test_set
+
+LOG = logging.getLogger(__name__)
+NOSEC_COMMENT = re.compile(r"#\s*nosec:?\s*(?P[^#]+)?#?")
+NOSEC_COMMENT_TESTS = re.compile(r"(?:(B\d+|[a-z\d_]+),?)+", re.IGNORECASE)
+PROGRESS_THRESHOLD = 50
+
+
+class BanditManager:
+ scope = []
+
+ def __init__(
+ self,
+ config,
+ agg_type,
+ debug=False,
+ verbose=False,
+ quiet=False,
+ profile=None,
+ ignore_nosec=False,
+ ):
+ """Get logger, config, AST handler, and result store ready
+
+ :param config: config options object
+ :type config: bandit.core.BanditConfig
+ :param agg_type: aggregation type
+ :param debug: Whether to show debug messages or not
+ :param verbose: Whether to show verbose output
+ :param quiet: Whether to only show output in the case of an error
+ :param profile_name: Optional name of profile to use (from cmd line)
+ :param ignore_nosec: Whether to ignore #nosec or not
+ :return:
+ """
+ self.debug = debug
+ self.verbose = verbose
+ self.quiet = quiet
+ if not profile:
+ profile = {}
+ self.ignore_nosec = ignore_nosec
+ self.b_conf = config
+ self.files_list = []
+ self.excluded_files = []
+ self.b_ma = b_meta_ast.BanditMetaAst()
+ self.skipped = []
+ self.results = []
+ self.baseline = []
+ self.agg_type = agg_type
+ self.metrics = metrics.Metrics()
+ self.b_ts = b_test_set.BanditTestSet(config, profile)
+ self.scores = []
+
+ def get_skipped(self):
+ ret = []
+ # "skip" is a tuple of name and reason, decode just the name
+ for skip in self.skipped:
+ if isinstance(skip[0], bytes):
+ ret.append((skip[0].decode("utf-8"), skip[1]))
+ else:
+ ret.append(skip)
+ return ret
+
+ def get_issue_list(
+ self, sev_level=b_constants.LOW, conf_level=b_constants.LOW
+ ):
+ return self.filter_results(sev_level, conf_level)
+
+ def populate_baseline(self, data):
+ """Populate a baseline set of issues from a JSON report
+
+ This will populate a list of baseline issues discovered from a previous
+ run of bandit. Later this baseline can be used to filter out the result
+ set, see filter_results.
+ """
+ items = []
+ try:
+ jdata = json.loads(data)
+ items = [issue.issue_from_dict(j) for j in jdata["results"]]
+ except Exception as e:
+ LOG.warning("Failed to load baseline data: %s", e)
+ self.baseline = items
+
+ def filter_results(self, sev_filter, conf_filter):
+ """Returns a list of results filtered by the baseline
+
+ This works by checking the number of results returned from each file we
+ process. If the number of results is different to the number reported
+ for the same file in the baseline, then we return all results for the
+ file. We can't reliably return just the new results, as line numbers
+ will likely have changed.
+
+ :param sev_filter: severity level filter to apply
+ :param conf_filter: confidence level filter to apply
+ """
+
+ results = [
+ i for i in self.results if i.filter(sev_filter, conf_filter)
+ ]
+
+ if not self.baseline:
+ return results
+
+ unmatched = _compare_baseline_results(self.baseline, results)
+ # if it's a baseline we'll return a dictionary of issues and a list of
+ # candidate issues
+ return _find_candidate_matches(unmatched, results)
+
+ def results_count(
+ self, sev_filter=b_constants.LOW, conf_filter=b_constants.LOW
+ ):
+ """Return the count of results
+
+ :param sev_filter: Severity level to filter lower
+ :param conf_filter: Confidence level to filter
+ :return: Number of results in the set
+ """
+ return len(self.get_issue_list(sev_filter, conf_filter))
+
+ def output_results(
+ self,
+ lines,
+ sev_level,
+ conf_level,
+ output_file,
+ output_format,
+ template=None,
+ ):
+ """Outputs results from the result store
+
+ :param lines: How many surrounding lines to show per result
+ :param sev_level: Which severity levels to show (LOW, MEDIUM, HIGH)
+ :param conf_level: Which confidence levels to show (LOW, MEDIUM, HIGH)
+ :param output_file: File to store results
+ :param output_format: output format plugin name
+ :param template: Output template with non-terminal tags
+ (default: {abspath}:{line}:
+ {test_id}[bandit]: {severity}: {msg})
+ :return: -
+ """
+ try:
+ formatters_mgr = extension_loader.MANAGER.formatters_mgr
+ if output_format not in formatters_mgr:
+ output_format = (
+ "screen"
+ if (
+ sys.stdout.isatty()
+ and os.getenv("NO_COLOR") is None
+ and os.getenv("TERM") != "dumb"
+ )
+ else "txt"
+ )
+
+ formatter = formatters_mgr[output_format]
+ report_func = formatter.plugin
+ if output_format == "custom":
+ report_func(
+ self,
+ fileobj=output_file,
+ sev_level=sev_level,
+ conf_level=conf_level,
+ template=template,
+ )
+ else:
+ report_func(
+ self,
+ fileobj=output_file,
+ sev_level=sev_level,
+ conf_level=conf_level,
+ lines=lines,
+ )
+
+ except Exception as e:
+ raise RuntimeError(
+ f"Unable to output report using "
+ f"'{output_format}' formatter: {str(e)}"
+ )
+
+ def discover_files(self, targets, recursive=False, excluded_paths=""):
+ """Add tests directly and from a directory to the test set
+
+ :param targets: The command line list of files and directories
+ :param recursive: True/False - whether to add all files from dirs
+ :return:
+ """
+ # We'll mantain a list of files which are added, and ones which have
+ # been explicitly excluded
+ files_list = set()
+ excluded_files = set()
+
+ excluded_path_globs = self.b_conf.get_option("exclude_dirs") or []
+ included_globs = self.b_conf.get_option("include") or ["*.py"]
+
+ # if there are command line provided exclusions add them to the list
+ if excluded_paths:
+ for path in excluded_paths.split(","):
+ if os.path.isdir(path):
+ path = os.path.join(path, "*")
+
+ excluded_path_globs.append(path)
+
+ # build list of files we will analyze
+ for fname in targets:
+ # if this is a directory and recursive is set, find all files
+ if os.path.isdir(fname):
+ if recursive:
+ new_files, newly_excluded = _get_files_from_dir(
+ fname,
+ included_globs=included_globs,
+ excluded_path_strings=excluded_path_globs,
+ )
+ files_list.update(new_files)
+ excluded_files.update(newly_excluded)
+ else:
+ LOG.warning(
+ "Skipping directory (%s), use -r flag to "
+ "scan contents",
+ fname,
+ )
+
+ else:
+ # if the user explicitly mentions a file on command line,
+ # we'll scan it, regardless of whether it's in the included
+ # file types list
+ if _is_file_included(
+ fname,
+ included_globs,
+ excluded_path_globs,
+ enforce_glob=False,
+ ):
+ if fname != "-":
+ fname = os.path.join(".", fname)
+ files_list.add(fname)
+ else:
+ excluded_files.add(fname)
+
+ self.files_list = sorted(files_list)
+ self.excluded_files = sorted(excluded_files)
+
+ def run_tests(self):
+ """Runs through all files in the scope
+
+ :return: -
+ """
+ # if we have problems with a file, we'll remove it from the files_list
+ # and add it to the skipped list instead
+ new_files_list = list(self.files_list)
+ if (
+ len(self.files_list) > PROGRESS_THRESHOLD
+ and LOG.getEffectiveLevel() <= logging.INFO
+ ):
+ files = progress.track(self.files_list)
+ else:
+ files = self.files_list
+
+ for count, fname in enumerate(files):
+ LOG.debug("working on file : %s", fname)
+
+ try:
+ if fname == "-":
+ open_fd = os.fdopen(sys.stdin.fileno(), "rb", 0)
+ fdata = io.BytesIO(open_fd.read())
+ new_files_list = [
+ "" if x == "-" else x for x in new_files_list
+ ]
+ self._parse_file("", fdata, new_files_list)
+ else:
+ with open(fname, "rb") as fdata:
+ self._parse_file(fname, fdata, new_files_list)
+ except OSError as e:
+ self.skipped.append((fname, e.strerror))
+ new_files_list.remove(fname)
+
+ # reflect any files which may have been skipped
+ self.files_list = new_files_list
+
+ # do final aggregation of metrics
+ self.metrics.aggregate()
+
+ def _parse_file(self, fname, fdata, new_files_list):
+ try:
+ # parse the current file
+ data = fdata.read()
+ lines = data.splitlines()
+ self.metrics.begin(fname)
+ self.metrics.count_locs(lines)
+ # nosec_lines is a dict of line number -> set of tests to ignore
+ # for the line
+ nosec_lines = dict()
+ try:
+ fdata.seek(0)
+ tokens = tokenize.tokenize(fdata.readline)
+
+ if not self.ignore_nosec:
+ for toktype, tokval, (lineno, _), _, _ in tokens:
+ if toktype == tokenize.COMMENT:
+ nosec_lines[lineno] = _parse_nosec_comment(tokval)
+
+ except tokenize.TokenError:
+ pass
+ score = self._execute_ast_visitor(fname, fdata, data, nosec_lines)
+ self.scores.append(score)
+ self.metrics.count_issues([score])
+ except KeyboardInterrupt:
+ sys.exit(2)
+ except SyntaxError:
+ self.skipped.append(
+ (fname, "syntax error while parsing AST from file")
+ )
+ new_files_list.remove(fname)
+ except Exception as e:
+ LOG.error(
+ "Exception occurred when executing tests against %s.", fname
+ )
+ if not LOG.isEnabledFor(logging.DEBUG):
+ LOG.error(
+ 'Run "bandit --debug %s" to see the full traceback.', fname
+ )
+
+ self.skipped.append((fname, "exception while scanning file"))
+ new_files_list.remove(fname)
+ LOG.debug(" Exception string: %s", e)
+ LOG.debug(" Exception traceback: %s", traceback.format_exc())
+
+ def _execute_ast_visitor(self, fname, fdata, data, nosec_lines):
+ """Execute AST parse on each file
+
+ :param fname: The name of the file being parsed
+ :param data: Original file contents
+ :param lines: The lines of code to process
+ :return: The accumulated test score
+ """
+ score = []
+ res = b_node_visitor.BanditNodeVisitor(
+ fname,
+ fdata,
+ self.b_ma,
+ self.b_ts,
+ self.debug,
+ nosec_lines,
+ self.metrics,
+ )
+
+ score = res.process(data)
+ self.results.extend(res.tester.results)
+ return score
+
+
+def _get_files_from_dir(
+ files_dir, included_globs=None, excluded_path_strings=None
+):
+ if not included_globs:
+ included_globs = ["*.py"]
+ if not excluded_path_strings:
+ excluded_path_strings = []
+
+ files_list = set()
+ excluded_files = set()
+
+ for root, _, files in os.walk(files_dir):
+ for filename in files:
+ path = os.path.join(root, filename)
+ if _is_file_included(path, included_globs, excluded_path_strings):
+ files_list.add(path)
+ else:
+ excluded_files.add(path)
+
+ return files_list, excluded_files
+
+
+def _is_file_included(
+ path, included_globs, excluded_path_strings, enforce_glob=True
+):
+ """Determine if a file should be included based on filename
+
+ This utility function determines if a file should be included based
+ on the file name, a list of parsed extensions, excluded paths, and a flag
+ specifying whether extensions should be enforced.
+
+ :param path: Full path of file to check
+ :param parsed_extensions: List of parsed extensions
+ :param excluded_paths: List of paths (globbing supported) from which we
+ should not include files
+ :param enforce_glob: Can set to false to bypass extension check
+ :return: Boolean indicating whether a file should be included
+ """
+ return_value = False
+
+ # if this is matches a glob of files we look at, and it isn't in an
+ # excluded path
+ if _matches_glob_list(path, included_globs) or not enforce_glob:
+ if not _matches_glob_list(path, excluded_path_strings) and not any(
+ x in path for x in excluded_path_strings
+ ):
+ return_value = True
+
+ return return_value
+
+
+def _matches_glob_list(filename, glob_list):
+ for glob in glob_list:
+ if fnmatch.fnmatch(filename, glob):
+ return True
+ return False
+
+
+def _compare_baseline_results(baseline, results):
+ """Compare a baseline list of issues to list of results
+
+ This function compares a baseline set of issues to a current set of issues
+ to find results that weren't present in the baseline.
+
+ :param baseline: Baseline list of issues
+ :param results: Current list of issues
+ :return: List of unmatched issues
+ """
+ return [a for a in results if a not in baseline]
+
+
+def _find_candidate_matches(unmatched_issues, results_list):
+ """Returns a dictionary with issue candidates
+
+ For example, let's say we find a new command injection issue in a file
+ which used to have two. Bandit can't tell which of the command injection
+ issues in the file are new, so it will show all three. The user should
+ be able to pick out the new one.
+
+ :param unmatched_issues: List of issues that weren't present before
+ :param results_list: main list of current Bandit findings
+ :return: A dictionary with a list of candidates for each issue
+ """
+
+ issue_candidates = collections.OrderedDict()
+
+ for unmatched in unmatched_issues:
+ issue_candidates[unmatched] = [
+ i for i in results_list if unmatched == i
+ ]
+
+ return issue_candidates
+
+
+def _find_test_id_from_nosec_string(extman, match):
+ test_id = extman.check_id(match)
+ if test_id:
+ return match
+ # Finding by short_id didn't work, let's check the test name
+ test_id = extman.get_test_id(match)
+ if not test_id:
+ # Name and short id didn't work:
+ LOG.warning(
+ "Test in comment: %s is not a test name or id, ignoring", match
+ )
+ return test_id # We want to return None or the string here regardless
+
+
+def _parse_nosec_comment(comment):
+ found_no_sec_comment = NOSEC_COMMENT.search(comment)
+ if not found_no_sec_comment:
+ # there was no nosec comment
+ return None
+
+ matches = found_no_sec_comment.groupdict()
+ nosec_tests = matches.get("tests", set())
+
+ # empty set indicates that there was a nosec comment without specific
+ # test ids or names
+ test_ids = set()
+ if nosec_tests:
+ extman = extension_loader.MANAGER
+ # lookup tests by short code or name
+ for test in NOSEC_COMMENT_TESTS.finditer(nosec_tests):
+ test_match = test.group(1)
+ test_id = _find_test_id_from_nosec_string(extman, test_match)
+ if test_id:
+ test_ids.add(test_id)
+
+ return test_ids
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/meta_ast.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/meta_ast.py
new file mode 100644
index 00000000..7bcd7f8b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/meta_ast.py
@@ -0,0 +1,44 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import collections
+import logging
+
+LOG = logging.getLogger(__name__)
+
+
+class BanditMetaAst:
+ nodes = collections.OrderedDict()
+
+ def __init__(self):
+ pass
+
+ def add_node(self, node, parent_id, depth):
+ """Add a node to the AST node collection
+
+ :param node: The AST node to add
+ :param parent_id: The ID of the node's parent
+ :param depth: The depth of the node
+ :return: -
+ """
+ node_id = hex(id(node))
+ LOG.debug("adding node : %s [%s]", node_id, depth)
+ self.nodes[node_id] = {
+ "raw": node,
+ "parent_id": parent_id,
+ "depth": depth,
+ }
+
+ def __str__(self):
+ """Dumps a listing of all of the nodes
+
+ Dumps a listing of all of the nodes for debugging purposes
+ :return: -
+ """
+ tmpstr = ""
+ for k, v in self.nodes.items():
+ tmpstr += f"Node: {k}\n"
+ tmpstr += f"\t{str(v)}\n"
+ tmpstr += f"Length: {len(self.nodes)}\n"
+ return tmpstr
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/metrics.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/metrics.py
new file mode 100644
index 00000000..c2122908
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/metrics.py
@@ -0,0 +1,106 @@
+#
+# Copyright 2015 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import collections
+
+from bandit.core import constants
+
+
+class Metrics:
+ """Bandit metric gathering.
+
+ This class is a singleton used to gather and process metrics collected when
+ processing a code base with bandit. Metric collection is stateful, that
+ is, an active metric block will be set when requested and all subsequent
+ operations will effect that metric block until it is replaced by a setting
+ a new one.
+ """
+
+ def __init__(self):
+ self.data = dict()
+ self.data["_totals"] = {
+ "loc": 0,
+ "nosec": 0,
+ "skipped_tests": 0,
+ }
+
+ # initialize 0 totals for criteria and rank; this will be reset later
+ for rank in constants.RANKING:
+ for criteria in constants.CRITERIA:
+ self.data["_totals"][f"{criteria[0]}.{rank}"] = 0
+
+ def begin(self, fname):
+ """Begin a new metric block.
+
+ This starts a new metric collection name "fname" and makes is active.
+ :param fname: the metrics unique name, normally the file name.
+ """
+ self.data[fname] = {
+ "loc": 0,
+ "nosec": 0,
+ "skipped_tests": 0,
+ }
+ self.current = self.data[fname]
+
+ def note_nosec(self, num=1):
+ """Note a "nosec" comment.
+
+ Increment the currently active metrics nosec count.
+ :param num: number of nosecs seen, defaults to 1
+ """
+ self.current["nosec"] += num
+
+ def note_skipped_test(self, num=1):
+ """Note a "nosec BXXX, BYYY, ..." comment.
+
+ Increment the currently active metrics skipped_tests count.
+ :param num: number of skipped_tests seen, defaults to 1
+ """
+ self.current["skipped_tests"] += num
+
+ def count_locs(self, lines):
+ """Count lines of code.
+
+ We count lines that are not empty and are not comments. The result is
+ added to our currently active metrics loc count (normally this is 0).
+
+ :param lines: lines in the file to process
+ """
+
+ def proc(line):
+ tmp = line.strip()
+ return bool(tmp and not tmp.startswith(b"#"))
+
+ self.current["loc"] += sum(proc(line) for line in lines)
+
+ def count_issues(self, scores):
+ self.current.update(self._get_issue_counts(scores))
+
+ def aggregate(self):
+ """Do final aggregation of metrics."""
+ c = collections.Counter()
+ for fname in self.data:
+ c.update(self.data[fname])
+ self.data["_totals"] = dict(c)
+
+ @staticmethod
+ def _get_issue_counts(scores):
+ """Get issue counts aggregated by confidence/severity rankings.
+
+ :param scores: list of scores to aggregate / count
+ :return: aggregated total (count) of issues identified
+ """
+ issue_counts = {}
+ for score in scores:
+ for criteria, _ in constants.CRITERIA:
+ for i, rank in enumerate(constants.RANKING):
+ label = f"{criteria}.{rank}"
+ if label not in issue_counts:
+ issue_counts[label] = 0
+ count = (
+ score[criteria][i]
+ // constants.RANKING_VALUES[rank]
+ )
+ issue_counts[label] += count
+ return issue_counts
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/node_visitor.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/node_visitor.py
new file mode 100644
index 00000000..fcad0512
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/node_visitor.py
@@ -0,0 +1,297 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+import logging
+import operator
+
+from bandit.core import constants
+from bandit.core import tester as b_tester
+from bandit.core import utils as b_utils
+
+LOG = logging.getLogger(__name__)
+
+
+class BanditNodeVisitor:
+ def __init__(
+ self, fname, fdata, metaast, testset, debug, nosec_lines, metrics
+ ):
+ self.debug = debug
+ self.nosec_lines = nosec_lines
+ self.scores = {
+ "SEVERITY": [0] * len(constants.RANKING),
+ "CONFIDENCE": [0] * len(constants.RANKING),
+ }
+ self.depth = 0
+ self.fname = fname
+ self.fdata = fdata
+ self.metaast = metaast
+ self.testset = testset
+ self.imports = set()
+ self.import_aliases = {}
+ self.tester = b_tester.BanditTester(
+ self.testset, self.debug, nosec_lines, metrics
+ )
+
+ # in some cases we can't determine a qualified name
+ try:
+ self.namespace = b_utils.get_module_qualname_from_path(fname)
+ except b_utils.InvalidModulePath:
+ LOG.warning(
+ "Unable to find qualified name for module: %s", self.fname
+ )
+ self.namespace = ""
+ LOG.debug("Module qualified name: %s", self.namespace)
+ self.metrics = metrics
+
+ def visit_ClassDef(self, node):
+ """Visitor for AST ClassDef node
+
+ Add class name to current namespace for all descendants.
+ :param node: Node being inspected
+ :return: -
+ """
+ # For all child nodes, add this class name to current namespace
+ self.namespace = b_utils.namespace_path_join(self.namespace, node.name)
+
+ def visit_FunctionDef(self, node):
+ """Visitor for AST FunctionDef nodes
+
+ add relevant information about the node to
+ the context for use in tests which inspect function definitions.
+ Add the function name to the current namespace for all descendants.
+ :param node: The node that is being inspected
+ :return: -
+ """
+
+ self.context["function"] = node
+ qualname = self.namespace + "." + b_utils.get_func_name(node)
+ name = qualname.split(".")[-1]
+
+ self.context["qualname"] = qualname
+ self.context["name"] = name
+
+ # For all child nodes and any tests run, add this function name to
+ # current namespace
+ self.namespace = b_utils.namespace_path_join(self.namespace, name)
+ self.update_scores(self.tester.run_tests(self.context, "FunctionDef"))
+
+ def visit_Call(self, node):
+ """Visitor for AST Call nodes
+
+ add relevant information about the node to
+ the context for use in tests which inspect function calls.
+ :param node: The node that is being inspected
+ :return: -
+ """
+
+ self.context["call"] = node
+ qualname = b_utils.get_call_name(node, self.import_aliases)
+ name = qualname.split(".")[-1]
+
+ self.context["qualname"] = qualname
+ self.context["name"] = name
+
+ self.update_scores(self.tester.run_tests(self.context, "Call"))
+
+ def visit_Import(self, node):
+ """Visitor for AST Import nodes
+
+ add relevant information about node to
+ the context for use in tests which inspect imports.
+ :param node: The node that is being inspected
+ :return: -
+ """
+ for nodename in node.names:
+ if nodename.asname:
+ self.import_aliases[nodename.asname] = nodename.name
+ self.imports.add(nodename.name)
+ self.context["module"] = nodename.name
+ self.update_scores(self.tester.run_tests(self.context, "Import"))
+
+ def visit_ImportFrom(self, node):
+ """Visitor for AST ImportFrom nodes
+
+ add relevant information about node to
+ the context for use in tests which inspect imports.
+ :param node: The node that is being inspected
+ :return: -
+ """
+ module = node.module
+ if module is None:
+ return self.visit_Import(node)
+
+ for nodename in node.names:
+ # TODO(ljfisher) Names in import_aliases could be overridden
+ # by local definitions. If this occurs bandit will see the
+ # name in import_aliases instead of the local definition.
+ # We need better tracking of names.
+ if nodename.asname:
+ self.import_aliases[nodename.asname] = (
+ module + "." + nodename.name
+ )
+ else:
+ # Even if import is not aliased we need an entry that maps
+ # name to module.name. For example, with 'from a import b'
+ # b should be aliased to the qualified name a.b
+ self.import_aliases[nodename.name] = (
+ module + "." + nodename.name
+ )
+ self.imports.add(module + "." + nodename.name)
+ self.context["module"] = module
+ self.context["name"] = nodename.name
+ self.update_scores(self.tester.run_tests(self.context, "ImportFrom"))
+
+ def visit_Constant(self, node):
+ """Visitor for AST Constant nodes
+
+ call the appropriate method for the node type.
+ this maintains compatibility with <3.6 and 3.8+
+
+ This code is heavily influenced by Anthony Sottile (@asottile) here:
+ https://bugs.python.org/msg342486
+
+ :param node: The node that is being inspected
+ :return: -
+ """
+ if isinstance(node.value, str):
+ self.visit_Str(node)
+ elif isinstance(node.value, bytes):
+ self.visit_Bytes(node)
+
+ def visit_Str(self, node):
+ """Visitor for AST String nodes
+
+ add relevant information about node to
+ the context for use in tests which inspect strings.
+ :param node: The node that is being inspected
+ :return: -
+ """
+ self.context["str"] = node.value
+ if not isinstance(node._bandit_parent, ast.Expr): # docstring
+ self.context["linerange"] = b_utils.linerange(node._bandit_parent)
+ self.update_scores(self.tester.run_tests(self.context, "Str"))
+
+ def visit_Bytes(self, node):
+ """Visitor for AST Bytes nodes
+
+ add relevant information about node to
+ the context for use in tests which inspect strings.
+ :param node: The node that is being inspected
+ :return: -
+ """
+ self.context["bytes"] = node.value
+ if not isinstance(node._bandit_parent, ast.Expr): # docstring
+ self.context["linerange"] = b_utils.linerange(node._bandit_parent)
+ self.update_scores(self.tester.run_tests(self.context, "Bytes"))
+
+ def pre_visit(self, node):
+ self.context = {}
+ self.context["imports"] = self.imports
+ self.context["import_aliases"] = self.import_aliases
+
+ if self.debug:
+ LOG.debug(ast.dump(node))
+ self.metaast.add_node(node, "", self.depth)
+
+ if hasattr(node, "lineno"):
+ self.context["lineno"] = node.lineno
+
+ if hasattr(node, "col_offset"):
+ self.context["col_offset"] = node.col_offset
+ if hasattr(node, "end_col_offset"):
+ self.context["end_col_offset"] = node.end_col_offset
+
+ self.context["node"] = node
+ self.context["linerange"] = b_utils.linerange(node)
+ self.context["filename"] = self.fname
+ self.context["file_data"] = self.fdata
+
+ LOG.debug(
+ "entering: %s %s [%s]", hex(id(node)), type(node), self.depth
+ )
+ self.depth += 1
+ LOG.debug(self.context)
+ return True
+
+ def visit(self, node):
+ name = node.__class__.__name__
+ method = "visit_" + name
+ visitor = getattr(self, method, None)
+ if visitor is not None:
+ if self.debug:
+ LOG.debug("%s called (%s)", method, ast.dump(node))
+ visitor(node)
+ else:
+ self.update_scores(self.tester.run_tests(self.context, name))
+
+ def post_visit(self, node):
+ self.depth -= 1
+ LOG.debug("%s\texiting : %s", self.depth, hex(id(node)))
+
+ # HACK(tkelsey): this is needed to clean up post-recursion stuff that
+ # gets setup in the visit methods for these node types.
+ if isinstance(node, (ast.FunctionDef, ast.ClassDef)):
+ self.namespace = b_utils.namespace_path_split(self.namespace)[0]
+
+ def generic_visit(self, node):
+ """Drive the visitor."""
+ for _, value in ast.iter_fields(node):
+ if isinstance(value, list):
+ max_idx = len(value) - 1
+ for idx, item in enumerate(value):
+ if isinstance(item, ast.AST):
+ if idx < max_idx:
+ item._bandit_sibling = value[idx + 1]
+ else:
+ item._bandit_sibling = None
+ item._bandit_parent = node
+
+ if self.pre_visit(item):
+ self.visit(item)
+ self.generic_visit(item)
+ self.post_visit(item)
+
+ elif isinstance(value, ast.AST):
+ value._bandit_sibling = None
+ value._bandit_parent = node
+ if self.pre_visit(value):
+ self.visit(value)
+ self.generic_visit(value)
+ self.post_visit(value)
+
+ def update_scores(self, scores):
+ """Score updater
+
+ Since we moved from a single score value to a map of scores per
+ severity, this is needed to update the stored list.
+ :param score: The score list to update our scores with
+ """
+ # we'll end up with something like:
+ # SEVERITY: {0, 0, 0, 10} where 10 is weighted by finding and level
+ for score_type in self.scores:
+ self.scores[score_type] = list(
+ map(operator.add, self.scores[score_type], scores[score_type])
+ )
+
+ def process(self, data):
+ """Main process loop
+
+ Build and process the AST
+ :param lines: lines code to process
+ :return score: the aggregated score for the current file
+ """
+ f_ast = ast.parse(data)
+ self.generic_visit(f_ast)
+ # Run tests that do not require access to the AST,
+ # but only to the whole file source:
+ self.context = {
+ "file_data": self.fdata,
+ "filename": self.fname,
+ "lineno": 0,
+ "linerange": [0, 1],
+ "col_offset": 0,
+ }
+ self.update_scores(self.tester.run_tests(self.context, "File"))
+ return self.scores
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/test_properties.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/test_properties.py
new file mode 100644
index 00000000..f6d4da1a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/test_properties.py
@@ -0,0 +1,83 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import logging
+
+from bandit.core import utils
+
+LOG = logging.getLogger(__name__)
+
+
+def checks(*args):
+ """Decorator function to set checks to be run."""
+
+ def wrapper(func):
+ if not hasattr(func, "_checks"):
+ func._checks = []
+ for arg in args:
+ if arg == "File":
+ func._checks.append("File")
+ else:
+ func._checks.append(utils.check_ast_node(arg))
+
+ LOG.debug("checks() decorator executed")
+ LOG.debug(" func._checks: %s", func._checks)
+ return func
+
+ return wrapper
+
+
+def takes_config(*args):
+ """Test function takes config
+
+ Use of this delegate before a test function indicates that it should be
+ passed data from the config file. Passing a name parameter allows
+ aliasing tests and thus sharing config options.
+ """
+ name = ""
+
+ def _takes_config(func):
+ if not hasattr(func, "_takes_config"):
+ func._takes_config = name
+ return func
+
+ if len(args) == 1 and callable(args[0]):
+ name = args[0].__name__
+ return _takes_config(args[0])
+ else:
+ name = args[0]
+ return _takes_config
+
+
+def test_id(id_val):
+ """Test function identifier
+
+ Use this decorator before a test function indicates its simple ID
+ """
+
+ def _has_id(func):
+ if not hasattr(func, "_test_id"):
+ func._test_id = id_val
+ return func
+
+ return _has_id
+
+
+def accepts_baseline(*args):
+ """Decorator to indicate formatter accepts baseline results
+
+ Use of this decorator before a formatter indicates that it is able to deal
+ with baseline results. Specifically this means it has a way to display
+ candidate results and know when it should do so.
+ """
+
+ def wrapper(func):
+ if not hasattr(func, "_accepts_baseline"):
+ func._accepts_baseline = True
+
+ LOG.debug("accepts_baseline() decorator executed on %s", func.__name__)
+
+ return func
+
+ return wrapper(args[0])
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/test_set.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/test_set.py
new file mode 100644
index 00000000..1e7dd0d8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/test_set.py
@@ -0,0 +1,114 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import importlib
+import logging
+
+from bandit.core import blacklisting
+from bandit.core import extension_loader
+
+LOG = logging.getLogger(__name__)
+
+
+class BanditTestSet:
+ def __init__(self, config, profile=None):
+ if not profile:
+ profile = {}
+ extman = extension_loader.MANAGER
+ filtering = self._get_filter(config, profile)
+ self.plugins = [
+ p for p in extman.plugins if p.plugin._test_id in filtering
+ ]
+ self.plugins.extend(self._load_builtins(filtering, profile))
+ self._load_tests(config, self.plugins)
+
+ @staticmethod
+ def _get_filter(config, profile):
+ extman = extension_loader.MANAGER
+
+ inc = set(profile.get("include", []))
+ exc = set(profile.get("exclude", []))
+
+ all_blacklist_tests = set()
+ for _, tests in extman.blacklist.items():
+ all_blacklist_tests.update(t["id"] for t in tests)
+
+ # this block is purely for backwards compatibility, the rules are as
+ # follows:
+ # B001,B401 means B401
+ # B401 means B401
+ # B001 means all blacklist tests
+ if "B001" in inc:
+ if not inc.intersection(all_blacklist_tests):
+ inc.update(all_blacklist_tests)
+ inc.discard("B001")
+ if "B001" in exc:
+ if not exc.intersection(all_blacklist_tests):
+ exc.update(all_blacklist_tests)
+ exc.discard("B001")
+
+ if inc:
+ filtered = inc
+ else:
+ filtered = set(extman.plugins_by_id.keys())
+ filtered.update(extman.builtin)
+ filtered.update(all_blacklist_tests)
+ return filtered - exc
+
+ def _load_builtins(self, filtering, profile):
+ """loads up builtin functions, so they can be filtered."""
+
+ class Wrapper:
+ def __init__(self, name, plugin):
+ self.name = name
+ self.plugin = plugin
+
+ extman = extension_loader.MANAGER
+ blacklist = profile.get("blacklist")
+ if not blacklist: # not overridden by legacy data
+ blacklist = {}
+ for node, tests in extman.blacklist.items():
+ values = [t for t in tests if t["id"] in filtering]
+ if values:
+ blacklist[node] = values
+
+ if not blacklist:
+ return []
+
+ # this dresses up the blacklist to look like a plugin, but
+ # the '_checks' data comes from the blacklist information.
+ # the '_config' is the filtered blacklist data set.
+ blacklisting.blacklist._test_id = "B001"
+ blacklisting.blacklist._checks = blacklist.keys()
+ blacklisting.blacklist._config = blacklist
+
+ return [Wrapper("blacklist", blacklisting.blacklist)]
+
+ def _load_tests(self, config, plugins):
+ """Builds a dict mapping tests to node types."""
+ self.tests = {}
+ for plugin in plugins:
+ if hasattr(plugin.plugin, "_takes_config"):
+ # TODO(??): config could come from profile ...
+ cfg = config.get_option(plugin.plugin._takes_config)
+ if cfg is None:
+ genner = importlib.import_module(plugin.plugin.__module__)
+ cfg = genner.gen_config(plugin.plugin._takes_config)
+ plugin.plugin._config = cfg
+ for check in plugin.plugin._checks:
+ self.tests.setdefault(check, []).append(plugin.plugin)
+ LOG.debug(
+ "added function %s (%s) targeting %s",
+ plugin.name,
+ plugin.plugin._test_id,
+ check,
+ )
+
+ def get_tests(self, checktype):
+ """Returns all tests that are of type checktype
+
+ :param checktype: The type of test to filter on
+ :return: A list of tests which are of the specified type
+ """
+ return self.tests.get(checktype) or []
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/tester.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/tester.py
new file mode 100644
index 00000000..e92c29fb
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/tester.py
@@ -0,0 +1,166 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import copy
+import logging
+import warnings
+
+from bandit.core import constants
+from bandit.core import context as b_context
+from bandit.core import utils
+
+warnings.formatwarning = utils.warnings_formatter
+LOG = logging.getLogger(__name__)
+
+
+class BanditTester:
+ def __init__(self, testset, debug, nosec_lines, metrics):
+ self.results = []
+ self.testset = testset
+ self.last_result = None
+ self.debug = debug
+ self.nosec_lines = nosec_lines
+ self.metrics = metrics
+
+ def run_tests(self, raw_context, checktype):
+ """Runs all tests for a certain type of check, for example
+
+ Runs all tests for a certain type of check, for example 'functions'
+ store results in results.
+
+ :param raw_context: Raw context dictionary
+ :param checktype: The type of checks to run
+ :return: a score based on the number and type of test results with
+ extra metrics about nosec comments
+ """
+
+ scores = {
+ "SEVERITY": [0] * len(constants.RANKING),
+ "CONFIDENCE": [0] * len(constants.RANKING),
+ }
+
+ tests = self.testset.get_tests(checktype)
+ for test in tests:
+ name = test.__name__
+ # execute test with an instance of the context class
+ temp_context = copy.copy(raw_context)
+ context = b_context.Context(temp_context)
+ try:
+ if hasattr(test, "_config"):
+ result = test(context, test._config)
+ else:
+ result = test(context)
+
+ if result is not None:
+ nosec_tests_to_skip = self._get_nosecs_from_contexts(
+ temp_context, test_result=result
+ )
+
+ if isinstance(temp_context["filename"], bytes):
+ result.fname = temp_context["filename"].decode("utf-8")
+ else:
+ result.fname = temp_context["filename"]
+ result.fdata = temp_context["file_data"]
+
+ if result.lineno is None:
+ result.lineno = temp_context["lineno"]
+ if result.linerange == []:
+ result.linerange = temp_context["linerange"]
+ if result.col_offset == -1:
+ result.col_offset = temp_context["col_offset"]
+ result.end_col_offset = temp_context.get(
+ "end_col_offset", 0
+ )
+ result.test = name
+ if result.test_id == "":
+ result.test_id = test._test_id
+
+ # don't skip the test if there was no nosec comment
+ if nosec_tests_to_skip is not None:
+ # If the set is empty then it means that nosec was
+ # used without test number -> update nosecs counter.
+ # If the test id is in the set of tests to skip,
+ # log and increment the skip by test count.
+ if not nosec_tests_to_skip:
+ LOG.debug("skipped, nosec without test number")
+ self.metrics.note_nosec()
+ continue
+ if result.test_id in nosec_tests_to_skip:
+ LOG.debug(
+ f"skipped, nosec for test {result.test_id}"
+ )
+ self.metrics.note_skipped_test()
+ continue
+
+ self.results.append(result)
+
+ LOG.debug("Issue identified by %s: %s", name, result)
+ sev = constants.RANKING.index(result.severity)
+ val = constants.RANKING_VALUES[result.severity]
+ scores["SEVERITY"][sev] += val
+ con = constants.RANKING.index(result.confidence)
+ val = constants.RANKING_VALUES[result.confidence]
+ scores["CONFIDENCE"][con] += val
+ else:
+ nosec_tests_to_skip = self._get_nosecs_from_contexts(
+ temp_context
+ )
+ if (
+ nosec_tests_to_skip
+ and test._test_id in nosec_tests_to_skip
+ ):
+ LOG.warning(
+ f"nosec encountered ({test._test_id}), but no "
+ f"failed test on line {temp_context['lineno']}"
+ )
+
+ except Exception as e:
+ self.report_error(name, context, e)
+ if self.debug:
+ raise
+ LOG.debug("Returning scores: %s", scores)
+ return scores
+
+ def _get_nosecs_from_contexts(self, context, test_result=None):
+ """Use context and optional test result to get set of tests to skip.
+ :param context: temp context
+ :param test_result: optional test result
+ :return: set of tests to skip for the line based on contexts
+ """
+ nosec_tests_to_skip = set()
+ base_tests = (
+ self.nosec_lines.get(test_result.lineno, None)
+ if test_result
+ else None
+ )
+ context_tests = utils.get_nosec(self.nosec_lines, context)
+
+ # if both are none there were no comments
+ # this is explicitly different from being empty.
+ # empty set indicates blanket nosec comment without
+ # individual test names or ids
+ if base_tests is None and context_tests is None:
+ nosec_tests_to_skip = None
+
+ # combine tests from current line and context line
+ if base_tests is not None:
+ nosec_tests_to_skip.update(base_tests)
+ if context_tests is not None:
+ nosec_tests_to_skip.update(context_tests)
+
+ return nosec_tests_to_skip
+
+ @staticmethod
+ def report_error(test, context, error):
+ what = "Bandit internal error running: "
+ what += f"{test} "
+ what += "on file %s at line %i: " % (
+ context._context["filename"],
+ context._context["lineno"],
+ )
+ what += str(error)
+ import traceback
+
+ what += traceback.format_exc()
+ LOG.error(what)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/core/utils.py b/Backend/venv/lib/python3.12/site-packages/bandit/core/utils.py
new file mode 100644
index 00000000..496d4803
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/core/utils.py
@@ -0,0 +1,398 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+import logging
+import os.path
+import sys
+
+try:
+ import configparser
+except ImportError:
+ import ConfigParser as configparser
+
+LOG = logging.getLogger(__name__)
+
+
+"""Various helper functions."""
+
+
+def _get_attr_qual_name(node, aliases):
+ """Get a the full name for the attribute node.
+
+ This will resolve a pseudo-qualified name for the attribute
+ rooted at node as long as all the deeper nodes are Names or
+ Attributes. This will give you how the code referenced the name but
+ will not tell you what the name actually refers to. If we
+ encounter a node without a static name we punt with an
+ empty string. If this encounters something more complex, such as
+ foo.mylist[0](a,b) we just return empty string.
+
+ :param node: AST Name or Attribute node
+ :param aliases: Import aliases dictionary
+ :returns: Qualified name referred to by the attribute or name.
+ """
+ if isinstance(node, ast.Name):
+ if node.id in aliases:
+ return aliases[node.id]
+ return node.id
+ elif isinstance(node, ast.Attribute):
+ name = f"{_get_attr_qual_name(node.value, aliases)}.{node.attr}"
+ if name in aliases:
+ return aliases[name]
+ return name
+ else:
+ return ""
+
+
+def get_call_name(node, aliases):
+ if isinstance(node.func, ast.Name):
+ if deepgetattr(node, "func.id") in aliases:
+ return aliases[deepgetattr(node, "func.id")]
+ return deepgetattr(node, "func.id")
+ elif isinstance(node.func, ast.Attribute):
+ return _get_attr_qual_name(node.func, aliases)
+ else:
+ return ""
+
+
+def get_func_name(node):
+ return node.name # TODO(tkelsey): get that qualname using enclosing scope
+
+
+def get_qual_attr(node, aliases):
+ if isinstance(node, ast.Attribute):
+ try:
+ val = deepgetattr(node, "value.id")
+ if val in aliases:
+ prefix = aliases[val]
+ else:
+ prefix = deepgetattr(node, "value.id")
+ except Exception:
+ # NOTE(tkelsey): degrade gracefully when we can't get the fully
+ # qualified name for an attr, just return its base name.
+ prefix = ""
+
+ return f"{prefix}.{node.attr}"
+ else:
+ return "" # TODO(tkelsey): process other node types
+
+
+def deepgetattr(obj, attr):
+ """Recurses through an attribute chain to get the ultimate value."""
+ for key in attr.split("."):
+ obj = getattr(obj, key)
+ return obj
+
+
+class InvalidModulePath(Exception):
+ pass
+
+
+class ConfigError(Exception):
+ """Raised when the config file fails validation."""
+
+ def __init__(self, message, config_file):
+ self.config_file = config_file
+ self.message = f"{config_file} : {message}"
+ super().__init__(self.message)
+
+
+class ProfileNotFound(Exception):
+ """Raised when chosen profile cannot be found."""
+
+ def __init__(self, config_file, profile):
+ self.config_file = config_file
+ self.profile = profile
+ message = "Unable to find profile ({}) in config file: {}".format(
+ self.profile,
+ self.config_file,
+ )
+ super().__init__(message)
+
+
+def warnings_formatter(
+ message, category=UserWarning, filename="", lineno=-1, line=""
+):
+ """Monkey patch for warnings.warn to suppress cruft output."""
+ return f"{message}\n"
+
+
+def get_module_qualname_from_path(path):
+ """Get the module's qualified name by analysis of the path.
+
+ Resolve the absolute pathname and eliminate symlinks. This could result in
+ an incorrect name if symlinks are used to restructure the python lib
+ directory.
+
+ Starting from the right-most directory component look for __init__.py in
+ the directory component. If it exists then the directory name is part of
+ the module name. Move left to the subsequent directory components until a
+ directory is found without __init__.py.
+
+ :param: Path to module file. Relative paths will be resolved relative to
+ current working directory.
+ :return: fully qualified module name
+ """
+
+ (head, tail) = os.path.split(path)
+ if head == "" or tail == "":
+ raise InvalidModulePath(
+ f'Invalid python file path: "{path}" Missing path or file name'
+ )
+
+ qname = [os.path.splitext(tail)[0]]
+ while head not in ["/", ".", ""]:
+ if os.path.isfile(os.path.join(head, "__init__.py")):
+ (head, tail) = os.path.split(head)
+ qname.insert(0, tail)
+ else:
+ break
+
+ qualname = ".".join(qname)
+ return qualname
+
+
+def namespace_path_join(base, name):
+ """Extend the current namespace path with an additional name
+
+ Take a namespace path (i.e., package.module.class) and extends it
+ with an additional name (i.e., package.module.class.subclass).
+ This is similar to how os.path.join works.
+
+ :param base: (String) The base namespace path.
+ :param name: (String) The new name to append to the base path.
+ :returns: (String) A new namespace path resulting from combination of
+ base and name.
+ """
+ return f"{base}.{name}"
+
+
+def namespace_path_split(path):
+ """Split the namespace path into a pair (head, tail).
+
+ Tail will be the last namespace path component and head will
+ be everything leading up to that in the path. This is similar to
+ os.path.split.
+
+ :param path: (String) A namespace path.
+ :returns: (String, String) A tuple where the first component is the base
+ path and the second is the last path component.
+ """
+ return tuple(path.rsplit(".", 1))
+
+
+def escaped_bytes_representation(b):
+ """PY3 bytes need escaping for comparison with other strings.
+
+ In practice it turns control characters into acceptable codepoints then
+ encodes them into bytes again to turn unprintable bytes into printable
+ escape sequences.
+
+ This is safe to do for the whole range 0..255 and result matches
+ unicode_escape on a unicode string.
+ """
+ return b.decode("unicode_escape").encode("unicode_escape")
+
+
+def calc_linerange(node):
+ """Calculate linerange for subtree"""
+ if hasattr(node, "_bandit_linerange"):
+ return node._bandit_linerange
+
+ lines_min = 9999999999
+ lines_max = -1
+ if hasattr(node, "lineno"):
+ lines_min = node.lineno
+ lines_max = node.lineno
+ for n in ast.iter_child_nodes(node):
+ lines_minmax = calc_linerange(n)
+ lines_min = min(lines_min, lines_minmax[0])
+ lines_max = max(lines_max, lines_minmax[1])
+
+ node._bandit_linerange = (lines_min, lines_max)
+
+ return (lines_min, lines_max)
+
+
+def linerange(node):
+ """Get line number range from a node."""
+ if hasattr(node, "lineno"):
+ return list(range(node.lineno, node.end_lineno + 1))
+ else:
+ if hasattr(node, "_bandit_linerange_stripped"):
+ lines_minmax = node._bandit_linerange_stripped
+ return list(range(lines_minmax[0], lines_minmax[1] + 1))
+
+ strip = {
+ "body": None,
+ "orelse": None,
+ "handlers": None,
+ "finalbody": None,
+ }
+ for key in strip.keys():
+ if hasattr(node, key):
+ strip[key] = getattr(node, key)
+ setattr(node, key, [])
+
+ lines_min = 9999999999
+ lines_max = -1
+ if hasattr(node, "lineno"):
+ lines_min = node.lineno
+ lines_max = node.lineno
+ for n in ast.iter_child_nodes(node):
+ lines_minmax = calc_linerange(n)
+ lines_min = min(lines_min, lines_minmax[0])
+ lines_max = max(lines_max, lines_minmax[1])
+
+ for key in strip.keys():
+ if strip[key] is not None:
+ setattr(node, key, strip[key])
+
+ if lines_max == -1:
+ lines_min = 0
+ lines_max = 1
+
+ node._bandit_linerange_stripped = (lines_min, lines_max)
+
+ lines = list(range(lines_min, lines_max + 1))
+
+ """Try and work around a known Python bug with multi-line strings."""
+ # deal with multiline strings lineno behavior (Python issue #16806)
+ if hasattr(node, "_bandit_sibling") and hasattr(
+ node._bandit_sibling, "lineno"
+ ):
+ start = min(lines)
+ delta = node._bandit_sibling.lineno - start
+ if delta > 1:
+ return list(range(start, node._bandit_sibling.lineno))
+ return lines
+
+
+def concat_string(node, stop=None):
+ """Builds a string from a ast.BinOp chain.
+
+ This will build a string from a series of ast.Constant nodes wrapped in
+ ast.BinOp nodes. Something like "a" + "b" + "c" or "a %s" % val etc.
+ The provided node can be any participant in the BinOp chain.
+
+ :param node: (ast.Constant or ast.BinOp) The node to process
+ :param stop: (ast.Constant or ast.BinOp) Optional base node to stop at
+ :returns: (Tuple) the root node of the expression, the string value
+ """
+
+ def _get(node, bits, stop=None):
+ if node != stop:
+ bits.append(
+ _get(node.left, bits, stop)
+ if isinstance(node.left, ast.BinOp)
+ else node.left
+ )
+ bits.append(
+ _get(node.right, bits, stop)
+ if isinstance(node.right, ast.BinOp)
+ else node.right
+ )
+
+ bits = [node]
+ while isinstance(node._bandit_parent, ast.BinOp):
+ node = node._bandit_parent
+ if isinstance(node, ast.BinOp):
+ _get(node, bits, stop)
+ return (
+ node,
+ " ".join(
+ [
+ x.value
+ for x in bits
+ if isinstance(x, ast.Constant) and isinstance(x.value, str)
+ ]
+ ),
+ )
+
+
+def get_called_name(node):
+ """Get a function name from an ast.Call node.
+
+ An ast.Call node representing a method call with present differently to one
+ wrapping a function call: thing.call() vs call(). This helper will grab the
+ unqualified call name correctly in either case.
+
+ :param node: (ast.Call) the call node
+ :returns: (String) the function name
+ """
+ func = node.func
+ try:
+ return func.attr if isinstance(func, ast.Attribute) else func.id
+ except AttributeError:
+ return ""
+
+
+def get_path_for_function(f):
+ """Get the path of the file where the function is defined.
+
+ :returns: the path, or None if one could not be found or f is not a real
+ function
+ """
+
+ if hasattr(f, "__module__"):
+ module_name = f.__module__
+ elif hasattr(f, "im_func"):
+ module_name = f.im_func.__module__
+ else:
+ LOG.warning("Cannot resolve file where %s is defined", f)
+ return None
+
+ module = sys.modules[module_name]
+ if hasattr(module, "__file__"):
+ return module.__file__
+ else:
+ LOG.warning("Cannot resolve file path for module %s", module_name)
+ return None
+
+
+def parse_ini_file(f_loc):
+ config = configparser.ConfigParser()
+ try:
+ config.read(f_loc)
+ return {k: v for k, v in config.items("bandit")}
+
+ except (configparser.Error, KeyError, TypeError):
+ LOG.warning(
+ "Unable to parse config file %s or missing [bandit] " "section",
+ f_loc,
+ )
+
+ return None
+
+
+def check_ast_node(name):
+ "Check if the given name is that of a valid AST node."
+ try:
+ # These ast Node types don't exist in Python 3.14, but plugins may
+ # still check on them.
+ if sys.version_info >= (3, 14) and name in (
+ "Num",
+ "Str",
+ "Ellipsis",
+ "NameConstant",
+ "Bytes",
+ ):
+ return name
+
+ node = getattr(ast, name)
+ if issubclass(node, ast.AST):
+ return name
+ except AttributeError: # nosec(tkelsey): catching expected exception
+ pass
+
+ raise TypeError(f"Error: {name} is not a valid node type in AST")
+
+
+def get_nosec(nosec_lines, context):
+ for lineno in context["linerange"]:
+ nosec = nosec_lines.get(lineno, None)
+ if nosec is not None:
+ return nosec
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/python_jose-3.3.0.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__init__.py
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/python_jose-3.3.0.dist-info/REQUESTED
rename to Backend/venv/lib/python3.12/site-packages/bandit/formatters/__init__.py
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..f35e48b3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/csv.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/csv.cpython-312.pyc
new file mode 100644
index 00000000..37055087
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/csv.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/custom.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/custom.cpython-312.pyc
new file mode 100644
index 00000000..005e55e7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/custom.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/html.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/html.cpython-312.pyc
new file mode 100644
index 00000000..d6bf999f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/html.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/json.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/json.cpython-312.pyc
new file mode 100644
index 00000000..473be434
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/json.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/sarif.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/sarif.cpython-312.pyc
new file mode 100644
index 00000000..8d72f77b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/sarif.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/screen.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/screen.cpython-312.pyc
new file mode 100644
index 00000000..ad7a0d2e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/screen.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/text.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/text.cpython-312.pyc
new file mode 100644
index 00000000..5e9cf75a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/text.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/utils.cpython-312.pyc
new file mode 100644
index 00000000..1560702c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/xml.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/xml.cpython-312.pyc
new file mode 100644
index 00000000..7c2bba3d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/xml.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/yaml.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/yaml.cpython-312.pyc
new file mode 100644
index 00000000..e9eedbce
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/__pycache__/yaml.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/csv.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/csv.py
new file mode 100644
index 00000000..6cde187f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/csv.py
@@ -0,0 +1,82 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=============
+CSV Formatter
+=============
+
+This formatter outputs the issues in a comma separated values format.
+
+:Example:
+
+.. code-block:: none
+
+ filename,test_name,test_id,issue_severity,issue_confidence,issue_cwe,
+ issue_text,line_number,line_range,more_info
+ examples/yaml_load.py,blacklist_calls,B301,MEDIUM,HIGH,
+ https://cwe.mitre.org/data/definitions/20.html,"Use of unsafe yaml
+ load. Allows instantiation of arbitrary objects. Consider yaml.safe_load().
+ ",5,[5],https://bandit.readthedocs.io/en/latest/
+
+.. versionadded:: 0.11.0
+
+.. versionchanged:: 1.5.0
+ New field `more_info` added to output
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+# Necessary for this formatter to work when imported on Python 2. Importing
+# the standard library's csv module conflicts with the name of this module.
+import csv
+import logging
+import sys
+
+from bandit.core import docs_utils
+
+LOG = logging.getLogger(__name__)
+
+
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """Prints issues in CSV format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ results = manager.get_issue_list(
+ sev_level=sev_level, conf_level=conf_level
+ )
+
+ with fileobj:
+ fieldnames = [
+ "filename",
+ "test_name",
+ "test_id",
+ "issue_severity",
+ "issue_confidence",
+ "issue_cwe",
+ "issue_text",
+ "line_number",
+ "col_offset",
+ "end_col_offset",
+ "line_range",
+ "more_info",
+ ]
+
+ writer = csv.DictWriter(
+ fileobj, fieldnames=fieldnames, extrasaction="ignore"
+ )
+ writer.writeheader()
+ for result in results:
+ r = result.as_dict(with_code=False)
+ r["issue_cwe"] = r["issue_cwe"]["link"]
+ r["more_info"] = docs_utils.get_url(r["test_id"])
+ writer.writerow(r)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("CSV output written to file: %s", fileobj.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/custom.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/custom.py
new file mode 100644
index 00000000..e9381ea0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/custom.py
@@ -0,0 +1,161 @@
+#
+# Copyright (c) 2017 Hewlett Packard Enterprise
+#
+# SPDX-License-Identifier: Apache-2.0
+"""
+================
+Custom Formatter
+================
+
+This formatter outputs the issues in custom machine-readable format.
+
+default template: ``{abspath}:{line}: {test_id}[bandit]: {severity}: {msg}``
+
+:Example:
+
+.. code-block:: none
+
+ /usr/lib/python3.6/site-packages/openlp/core/utils/__init__.py:\
+405: B310[bandit]: MEDIUM: Audit url open for permitted schemes. \
+Allowing use of file:/ or custom schemes is often unexpected.
+
+.. versionadded:: 1.5.0
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+import logging
+import os
+import re
+import string
+import sys
+
+from bandit.core import test_properties
+
+LOG = logging.getLogger(__name__)
+
+
+class SafeMapper(dict):
+ """Safe mapper to handle format key errors"""
+
+ @classmethod # To prevent PEP8 warnings in the test suite
+ def __missing__(cls, key):
+ return "{%s}" % key
+
+
+@test_properties.accepts_baseline
+def report(manager, fileobj, sev_level, conf_level, template=None):
+ """Prints issues in custom format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param template: Output template with non-terminal tags
+ (default: '{abspath}:{line}:
+ {test_id}[bandit]: {severity}: {msg}')
+ """
+
+ machine_output = {"results": [], "errors": []}
+ for fname, reason in manager.get_skipped():
+ machine_output["errors"].append({"filename": fname, "reason": reason})
+
+ results = manager.get_issue_list(
+ sev_level=sev_level, conf_level=conf_level
+ )
+
+ msg_template = template
+ if template is None:
+ msg_template = "{abspath}:{line}: {test_id}[bandit]: {severity}: {msg}"
+
+ # Dictionary of non-terminal tags that will be expanded
+ tag_mapper = {
+ "abspath": lambda issue: os.path.abspath(issue.fname),
+ "relpath": lambda issue: os.path.relpath(issue.fname),
+ "line": lambda issue: issue.lineno,
+ "col": lambda issue: issue.col_offset,
+ "end_col": lambda issue: issue.end_col_offset,
+ "test_id": lambda issue: issue.test_id,
+ "severity": lambda issue: issue.severity,
+ "msg": lambda issue: issue.text,
+ "confidence": lambda issue: issue.confidence,
+ "range": lambda issue: issue.linerange,
+ "cwe": lambda issue: issue.cwe,
+ }
+
+ # Create dictionary with tag sets to speed up search for similar tags
+ tag_sim_dict = {tag: set(tag) for tag, _ in tag_mapper.items()}
+
+ # Parse the format_string template and check the validity of tags
+ try:
+ parsed_template_orig = list(string.Formatter().parse(msg_template))
+ # of type (literal_text, field_name, fmt_spec, conversion)
+
+ # Check the format validity only, ignore keys
+ string.Formatter().vformat(msg_template, (), SafeMapper(line=0))
+ except ValueError as e:
+ LOG.error("Template is not in valid format: %s", e.args[0])
+ sys.exit(2)
+
+ tag_set = {t[1] for t in parsed_template_orig if t[1] is not None}
+ if not tag_set:
+ LOG.error("No tags were found in the template. Are you missing '{}'?")
+ sys.exit(2)
+
+ def get_similar_tag(tag):
+ similarity_list = [
+ (len(set(tag) & t_set), t) for t, t_set in tag_sim_dict.items()
+ ]
+ return sorted(similarity_list)[-1][1]
+
+ tag_blacklist = []
+ for tag in tag_set:
+ # check if the tag is in dictionary
+ if tag not in tag_mapper:
+ similar_tag = get_similar_tag(tag)
+ LOG.warning(
+ "Tag '%s' was not recognized and will be skipped, "
+ "did you mean to use '%s'?",
+ tag,
+ similar_tag,
+ )
+ tag_blacklist += [tag]
+
+ # Compose the message template back with the valid values only
+ msg_parsed_template_list = []
+ for literal_text, field_name, fmt_spec, conversion in parsed_template_orig:
+ if literal_text:
+ # if there is '{' or '}', double it to prevent expansion
+ literal_text = re.sub("{", "{{", literal_text)
+ literal_text = re.sub("}", "}}", literal_text)
+ msg_parsed_template_list.append(literal_text)
+
+ if field_name is not None:
+ if field_name in tag_blacklist:
+ msg_parsed_template_list.append(field_name)
+ continue
+ # Append the fmt_spec part
+ params = [field_name, fmt_spec, conversion]
+ markers = ["", ":", "!"]
+ msg_parsed_template_list.append(
+ ["{"]
+ + [f"{m + p}" if p else "" for m, p in zip(markers, params)]
+ + ["}"]
+ )
+
+ msg_parsed_template = (
+ "".join([item for lst in msg_parsed_template_list for item in lst])
+ + "\n"
+ )
+ with fileobj:
+ for defect in results:
+ evaluated_tags = SafeMapper(
+ (k, v(defect)) for k, v in tag_mapper.items()
+ )
+ output = msg_parsed_template.format(**evaluated_tags)
+
+ fileobj.write(output)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("Result written to file: %s", fileobj.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/html.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/html.py
new file mode 100644
index 00000000..fb09f835
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/html.py
@@ -0,0 +1,394 @@
+# Copyright (c) 2015 Rackspace, Inc.
+# Copyright (c) 2015 Hewlett Packard Enterprise
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==============
+HTML formatter
+==============
+
+This formatter outputs the issues as HTML.
+
+:Example:
+
+.. code-block:: html
+
+
+
+
+
+
+
+
+ Bandit Report
+
+
+
+
+
+
+
+
+
+
+ Metrics:
+
+ Total lines of code: 9
+ Total lines skipped (#nosec): 0
+
+
+
+
+
+.. versionadded:: 0.14.0
+
+.. versionchanged:: 1.5.0
+ New field `more_info` added to output
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+import logging
+import sys
+from html import escape as html_escape
+
+from bandit.core import docs_utils
+from bandit.core import test_properties
+from bandit.formatters import utils
+
+LOG = logging.getLogger(__name__)
+
+
+@test_properties.accepts_baseline
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """Writes issues to 'fileobj' in HTML format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ header_block = """
+
+
+
+
+
+
+
+ Bandit Report
+
+
+
+
+"""
+
+ report_block = """
+
+{metrics}
+{skipped}
+
+
+
+ {results}
+
+
+
+
+"""
+
+ issue_block = """
+
+
+ {test_name}: {test_text}
+ Test ID: {test_id}
+ Severity: {severity}
+ Confidence: {confidence}
+ CWE: CWE-{cwe.id}
+ File: {path}
+ Line number: {line_number}
+ More info: {url}
+{code}
+{candidates}
+
+
+"""
+
+ code_block = """
+
+
+{code}
+
+
+"""
+
+ candidate_block = """
+
+
+Candidates:
+{candidate_list}
+
+"""
+
+ candidate_issue = """
+
+
+
{code}
+
+
+"""
+
+ skipped_block = """
+
+
+
+Skipped files:
+{files_list}
+
+
+"""
+
+ metrics_block = """
+
+
+
+ Metrics:
+
+ Total lines of code: {loc}
+ Total lines skipped (#nosec): {nosec}
+
+
+
+"""
+
+ issues = manager.get_issue_list(sev_level=sev_level, conf_level=conf_level)
+
+ baseline = not isinstance(issues, list)
+
+ # build the skipped string to insert in the report
+ skipped_str = "".join(
+ f"{fname} reason: {reason} "
+ for fname, reason in manager.get_skipped()
+ )
+ if skipped_str:
+ skipped_text = skipped_block.format(files_list=skipped_str)
+ else:
+ skipped_text = ""
+
+ # build the results string to insert in the report
+ results_str = ""
+ for index, issue in enumerate(issues):
+ if not baseline or len(issues[issue]) == 1:
+ candidates = ""
+ safe_code = html_escape(
+ issue.get_code(lines, True).strip("\n").lstrip(" ")
+ )
+ code = code_block.format(code=safe_code)
+ else:
+ candidates_str = ""
+ code = ""
+ for candidate in issues[issue]:
+ candidate_code = html_escape(
+ candidate.get_code(lines, True).strip("\n").lstrip(" ")
+ )
+ candidates_str += candidate_issue.format(code=candidate_code)
+
+ candidates = candidate_block.format(candidate_list=candidates_str)
+
+ url = docs_utils.get_url(issue.test_id)
+ results_str += issue_block.format(
+ issue_no=index,
+ issue_class=f"issue-sev-{issue.severity.lower()}",
+ test_name=issue.test,
+ test_id=issue.test_id,
+ test_text=issue.text,
+ severity=issue.severity,
+ confidence=issue.confidence,
+ cwe=issue.cwe,
+ cwe_link=issue.cwe.link(),
+ path=issue.fname,
+ code=code,
+ candidates=candidates,
+ url=url,
+ line_number=issue.lineno,
+ )
+
+ # build the metrics string to insert in the report
+ metrics_summary = metrics_block.format(
+ loc=manager.metrics.data["_totals"]["loc"],
+ nosec=manager.metrics.data["_totals"]["nosec"],
+ )
+
+ # build the report and output it
+ report_contents = report_block.format(
+ metrics=metrics_summary, skipped=skipped_text, results=results_str
+ )
+
+ with fileobj:
+ wrapped_file = utils.wrap_file_object(fileobj)
+ wrapped_file.write(header_block)
+ wrapped_file.write(report_contents)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("HTML output written to file: %s", fileobj.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/json.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/json.py
new file mode 100644
index 00000000..3a954a4d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/json.py
@@ -0,0 +1,155 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==============
+JSON formatter
+==============
+
+This formatter outputs the issues in JSON.
+
+:Example:
+
+.. code-block:: javascript
+
+ {
+ "errors": [],
+ "generated_at": "2015-12-16T22:27:34Z",
+ "metrics": {
+ "_totals": {
+ "CONFIDENCE.HIGH": 1,
+ "CONFIDENCE.LOW": 0,
+ "CONFIDENCE.MEDIUM": 0,
+ "CONFIDENCE.UNDEFINED": 0,
+ "SEVERITY.HIGH": 0,
+ "SEVERITY.LOW": 0,
+ "SEVERITY.MEDIUM": 1,
+ "SEVERITY.UNDEFINED": 0,
+ "loc": 5,
+ "nosec": 0
+ },
+ "examples/yaml_load.py": {
+ "CONFIDENCE.HIGH": 1,
+ "CONFIDENCE.LOW": 0,
+ "CONFIDENCE.MEDIUM": 0,
+ "CONFIDENCE.UNDEFINED": 0,
+ "SEVERITY.HIGH": 0,
+ "SEVERITY.LOW": 0,
+ "SEVERITY.MEDIUM": 1,
+ "SEVERITY.UNDEFINED": 0,
+ "loc": 5,
+ "nosec": 0
+ }
+ },
+ "results": [
+ {
+ "code": "4 ystr = yaml.dump({'a' : 1, 'b' : 2, 'c' : 3})\n5
+ y = yaml.load(ystr)\n6 yaml.dump(y)\n",
+ "filename": "examples/yaml_load.py",
+ "issue_confidence": "HIGH",
+ "issue_severity": "MEDIUM",
+ "issue_cwe": {
+ "id": 20,
+ "link": "https://cwe.mitre.org/data/definitions/20.html"
+ },
+ "issue_text": "Use of unsafe yaml load. Allows instantiation of
+ arbitrary objects. Consider yaml.safe_load().\n",
+ "line_number": 5,
+ "line_range": [
+ 5
+ ],
+ "more_info": "https://bandit.readthedocs.io/en/latest/",
+ "test_name": "blacklist_calls",
+ "test_id": "B301"
+ }
+ ]
+ }
+
+.. versionadded:: 0.10.0
+
+.. versionchanged:: 1.5.0
+ New field `more_info` added to output
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+# Necessary so we can import the standard library json module while continuing
+# to name this file json.py. (Python 2 only)
+import datetime
+import json
+import logging
+import operator
+import sys
+
+from bandit.core import docs_utils
+from bandit.core import test_properties
+
+LOG = logging.getLogger(__name__)
+
+
+@test_properties.accepts_baseline
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """''Prints issues in JSON format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ machine_output = {"results": [], "errors": []}
+ for fname, reason in manager.get_skipped():
+ machine_output["errors"].append({"filename": fname, "reason": reason})
+
+ results = manager.get_issue_list(
+ sev_level=sev_level, conf_level=conf_level
+ )
+
+ baseline = not isinstance(results, list)
+
+ if baseline:
+ collector = []
+ for r in results:
+ d = r.as_dict(max_lines=lines)
+ d["more_info"] = docs_utils.get_url(d["test_id"])
+ if len(results[r]) > 1:
+ d["candidates"] = [
+ c.as_dict(max_lines=lines) for c in results[r]
+ ]
+ collector.append(d)
+
+ else:
+ collector = [r.as_dict(max_lines=lines) for r in results]
+ for elem in collector:
+ elem["more_info"] = docs_utils.get_url(elem["test_id"])
+
+ itemgetter = operator.itemgetter
+ if manager.agg_type == "vuln":
+ machine_output["results"] = sorted(
+ collector, key=itemgetter("test_name")
+ )
+ else:
+ machine_output["results"] = sorted(
+ collector, key=itemgetter("filename")
+ )
+
+ machine_output["metrics"] = manager.metrics.data
+
+ # timezone agnostic format
+ TS_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
+ time_string = datetime.datetime.now(datetime.timezone.utc).strftime(
+ TS_FORMAT
+ )
+ machine_output["generated_at"] = time_string
+
+ result = json.dumps(
+ machine_output, sort_keys=True, indent=2, separators=(",", ": ")
+ )
+
+ with fileobj:
+ fileobj.write(result)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("JSON output written to file: %s", fileobj.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/sarif.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/sarif.py
new file mode 100644
index 00000000..5b06ce71
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/sarif.py
@@ -0,0 +1,374 @@
+# Copyright (c) Microsoft. All Rights Reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Note: this code mostly incorporated from
+# https://github.com/microsoft/bandit-sarif-formatter
+#
+r"""
+===============
+SARIF formatter
+===============
+
+This formatter outputs the issues in SARIF formatted JSON.
+
+:Example:
+
+.. code-block:: javascript
+
+ {
+ "runs": [
+ {
+ "tool": {
+ "driver": {
+ "name": "Bandit",
+ "organization": "PyCQA",
+ "rules": [
+ {
+ "id": "B101",
+ "name": "assert_used",
+ "properties": {
+ "tags": [
+ "security",
+ "external/cwe/cwe-703"
+ ],
+ "precision": "high"
+ },
+ "helpUri": "https://bandit.readthedocs.io/en/1.7.8/plugins/b101_assert_used.html"
+ }
+ ],
+ "version": "1.7.8",
+ "semanticVersion": "1.7.8"
+ }
+ },
+ "invocations": [
+ {
+ "executionSuccessful": true,
+ "endTimeUtc": "2024-03-05T03:28:48Z"
+ }
+ ],
+ "properties": {
+ "metrics": {
+ "_totals": {
+ "loc": 1,
+ "nosec": 0,
+ "skipped_tests": 0,
+ "SEVERITY.UNDEFINED": 0,
+ "CONFIDENCE.UNDEFINED": 0,
+ "SEVERITY.LOW": 1,
+ "CONFIDENCE.LOW": 0,
+ "SEVERITY.MEDIUM": 0,
+ "CONFIDENCE.MEDIUM": 0,
+ "SEVERITY.HIGH": 0,
+ "CONFIDENCE.HIGH": 1
+ },
+ "./examples/assert.py": {
+ "loc": 1,
+ "nosec": 0,
+ "skipped_tests": 0,
+ "SEVERITY.UNDEFINED": 0,
+ "SEVERITY.LOW": 1,
+ "SEVERITY.MEDIUM": 0,
+ "SEVERITY.HIGH": 0,
+ "CONFIDENCE.UNDEFINED": 0,
+ "CONFIDENCE.LOW": 0,
+ "CONFIDENCE.MEDIUM": 0,
+ "CONFIDENCE.HIGH": 1
+ }
+ }
+ },
+ "results": [
+ {
+ "message": {
+ "text": "Use of assert detected. The enclosed code will be removed when compiling to optimised byte code."
+ },
+ "level": "note",
+ "locations": [
+ {
+ "physicalLocation": {
+ "region": {
+ "snippet": {
+ "text": "assert True\n"
+ },
+ "endColumn": 11,
+ "endLine": 1,
+ "startColumn": 0,
+ "startLine": 1
+ },
+ "artifactLocation": {
+ "uri": "examples/assert.py"
+ },
+ "contextRegion": {
+ "snippet": {
+ "text": "assert True\n"
+ },
+ "endLine": 1,
+ "startLine": 1
+ }
+ }
+ }
+ ],
+ "properties": {
+ "issue_confidence": "HIGH",
+ "issue_severity": "LOW"
+ },
+ "ruleId": "B101",
+ "ruleIndex": 0
+ }
+ ]
+ }
+ ],
+ "version": "2.1.0",
+ "$schema": "https://json.schemastore.org/sarif-2.1.0.json"
+ }
+
+.. versionadded:: 1.7.8
+
+""" # noqa: E501
+import datetime
+import logging
+import pathlib
+import sys
+import urllib.parse as urlparse
+
+import sarif_om as om
+from jschema_to_python.to_json import to_json
+
+import bandit
+from bandit.core import docs_utils
+
+LOG = logging.getLogger(__name__)
+SCHEMA_URI = "https://json.schemastore.org/sarif-2.1.0.json"
+SCHEMA_VER = "2.1.0"
+TS_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
+
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """Prints issues in SARIF format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ log = om.SarifLog(
+ schema_uri=SCHEMA_URI,
+ version=SCHEMA_VER,
+ runs=[
+ om.Run(
+ tool=om.Tool(
+ driver=om.ToolComponent(
+ name="Bandit",
+ organization=bandit.__author__,
+ semantic_version=bandit.__version__,
+ version=bandit.__version__,
+ )
+ ),
+ invocations=[
+ om.Invocation(
+ end_time_utc=datetime.datetime.now(
+ datetime.timezone.utc
+ ).strftime(TS_FORMAT),
+ execution_successful=True,
+ )
+ ],
+ properties={"metrics": manager.metrics.data},
+ )
+ ],
+ )
+
+ run = log.runs[0]
+ invocation = run.invocations[0]
+
+ skips = manager.get_skipped()
+ add_skipped_file_notifications(skips, invocation)
+
+ issues = manager.get_issue_list(sev_level=sev_level, conf_level=conf_level)
+
+ add_results(issues, run)
+
+ serializedLog = to_json(log)
+
+ with fileobj:
+ fileobj.write(serializedLog)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("SARIF output written to file: %s", fileobj.name)
+
+
+def add_skipped_file_notifications(skips, invocation):
+ if skips is None or len(skips) == 0:
+ return
+
+ if invocation.tool_configuration_notifications is None:
+ invocation.tool_configuration_notifications = []
+
+ for skip in skips:
+ (file_name, reason) = skip
+
+ notification = om.Notification(
+ level="error",
+ message=om.Message(text=reason),
+ locations=[
+ om.Location(
+ physical_location=om.PhysicalLocation(
+ artifact_location=om.ArtifactLocation(
+ uri=to_uri(file_name)
+ )
+ )
+ )
+ ],
+ )
+
+ invocation.tool_configuration_notifications.append(notification)
+
+
+def add_results(issues, run):
+ if run.results is None:
+ run.results = []
+
+ rules = {}
+ rule_indices = {}
+ for issue in issues:
+ result = create_result(issue, rules, rule_indices)
+ run.results.append(result)
+
+ if len(rules) > 0:
+ run.tool.driver.rules = list(rules.values())
+
+
+def create_result(issue, rules, rule_indices):
+ issue_dict = issue.as_dict()
+
+ rule, rule_index = create_or_find_rule(issue_dict, rules, rule_indices)
+
+ physical_location = om.PhysicalLocation(
+ artifact_location=om.ArtifactLocation(
+ uri=to_uri(issue_dict["filename"])
+ )
+ )
+
+ add_region_and_context_region(
+ physical_location,
+ issue_dict["line_range"],
+ issue_dict["col_offset"],
+ issue_dict["end_col_offset"],
+ issue_dict["code"],
+ )
+
+ return om.Result(
+ rule_id=rule.id,
+ rule_index=rule_index,
+ message=om.Message(text=issue_dict["issue_text"]),
+ level=level_from_severity(issue_dict["issue_severity"]),
+ locations=[om.Location(physical_location=physical_location)],
+ properties={
+ "issue_confidence": issue_dict["issue_confidence"],
+ "issue_severity": issue_dict["issue_severity"],
+ },
+ )
+
+
+def level_from_severity(severity):
+ if severity == "HIGH":
+ return "error"
+ elif severity == "MEDIUM":
+ return "warning"
+ elif severity == "LOW":
+ return "note"
+ else:
+ return "warning"
+
+
+def add_region_and_context_region(
+ physical_location, line_range, col_offset, end_col_offset, code
+):
+ if code:
+ first_line_number, snippet_lines = parse_code(code)
+ snippet_line = snippet_lines[line_range[0] - first_line_number]
+ snippet = om.ArtifactContent(text=snippet_line)
+ else:
+ snippet = None
+
+ physical_location.region = om.Region(
+ start_line=line_range[0],
+ end_line=line_range[1] if len(line_range) > 1 else line_range[0],
+ start_column=col_offset + 1,
+ end_column=end_col_offset + 1,
+ snippet=snippet,
+ )
+
+ if code:
+ physical_location.context_region = om.Region(
+ start_line=first_line_number,
+ end_line=first_line_number + len(snippet_lines) - 1,
+ snippet=om.ArtifactContent(text="".join(snippet_lines)),
+ )
+
+
+def parse_code(code):
+ code_lines = code.split("\n")
+
+ # The last line from the split has nothing in it; it's an artifact of the
+ # last "real" line ending in a newline. Unless, of course, it doesn't:
+ last_line = code_lines[len(code_lines) - 1]
+
+ last_real_line_ends_in_newline = False
+ if len(last_line) == 0:
+ code_lines.pop()
+ last_real_line_ends_in_newline = True
+
+ snippet_lines = []
+ first_line_number = 0
+ first = True
+ for code_line in code_lines:
+ number_and_snippet_line = code_line.split(" ", 1)
+ if first:
+ first_line_number = int(number_and_snippet_line[0])
+ first = False
+
+ snippet_line = number_and_snippet_line[1] + "\n"
+ snippet_lines.append(snippet_line)
+
+ if not last_real_line_ends_in_newline:
+ last_line = snippet_lines[len(snippet_lines) - 1]
+ snippet_lines[len(snippet_lines) - 1] = last_line[: len(last_line) - 1]
+
+ return first_line_number, snippet_lines
+
+
+def create_or_find_rule(issue_dict, rules, rule_indices):
+ rule_id = issue_dict["test_id"]
+ if rule_id in rules:
+ return rules[rule_id], rule_indices[rule_id]
+
+ rule = om.ReportingDescriptor(
+ id=rule_id,
+ name=issue_dict["test_name"],
+ help_uri=docs_utils.get_url(rule_id),
+ properties={
+ "tags": [
+ "security",
+ f"external/cwe/cwe-{issue_dict['issue_cwe'].get('id')}",
+ ],
+ "precision": issue_dict["issue_confidence"].lower(),
+ },
+ )
+
+ index = len(rules)
+ rules[rule_id] = rule
+ rule_indices[rule_id] = index
+ return rule, index
+
+
+def to_uri(file_path):
+ pure_path = pathlib.PurePath(file_path)
+ if pure_path.is_absolute():
+ return pure_path.as_uri()
+ else:
+ # Replace backslashes with slashes.
+ posix_path = pure_path.as_posix()
+ # %-encode special characters.
+ return urlparse.quote(posix_path)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/screen.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/screen.py
new file mode 100644
index 00000000..7421c3ea
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/screen.py
@@ -0,0 +1,244 @@
+# Copyright (c) 2015 Hewlett Packard Enterprise
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+================
+Screen formatter
+================
+
+This formatter outputs the issues as color coded text to screen.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B506: yaml_load] Use of unsafe yaml load. Allows
+ instantiation of arbitrary objects. Consider yaml.safe_load().
+
+ Severity: Medium Confidence: High
+ CWE: CWE-20 (https://cwe.mitre.org/data/definitions/20.html)
+ More Info: https://bandit.readthedocs.io/en/latest/
+ Location: examples/yaml_load.py:5
+ 4 ystr = yaml.dump({'a' : 1, 'b' : 2, 'c' : 3})
+ 5 y = yaml.load(ystr)
+ 6 yaml.dump(y)
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.5.0
+ New field `more_info` added to output
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+import datetime
+import logging
+import sys
+
+from bandit.core import constants
+from bandit.core import docs_utils
+from bandit.core import test_properties
+
+IS_WIN_PLATFORM = sys.platform.startswith("win32")
+COLORAMA = False
+
+# This fixes terminal colors not displaying properly on Windows systems.
+# Colorama will intercept any ANSI escape codes and convert them to the
+# proper Windows console API calls to change text color.
+if IS_WIN_PLATFORM:
+ try:
+ import colorama
+ except ImportError:
+ pass
+ else:
+ COLORAMA = True
+
+
+LOG = logging.getLogger(__name__)
+
+COLOR = {
+ "DEFAULT": "\033[0m",
+ "HEADER": "\033[95m",
+ "LOW": "\033[94m",
+ "MEDIUM": "\033[93m",
+ "HIGH": "\033[91m",
+}
+
+
+def header(text, *args):
+ return f"{COLOR['HEADER']}{text % args}{COLOR['DEFAULT']}"
+
+
+def get_verbose_details(manager):
+ bits = []
+ bits.append(header("Files in scope (%i):", len(manager.files_list)))
+ tpl = "\t%s (score: {SEVERITY: %i, CONFIDENCE: %i})"
+ bits.extend(
+ [
+ tpl % (item, sum(score["SEVERITY"]), sum(score["CONFIDENCE"]))
+ for (item, score) in zip(manager.files_list, manager.scores)
+ ]
+ )
+ bits.append(header("Files excluded (%i):", len(manager.excluded_files)))
+ bits.extend([f"\t{fname}" for fname in manager.excluded_files])
+ return "\n".join([str(bit) for bit in bits])
+
+
+def get_metrics(manager):
+ bits = []
+ bits.append(header("\nRun metrics:"))
+ for criteria, _ in constants.CRITERIA:
+ bits.append(f"\tTotal issues (by {criteria.lower()}):")
+ for rank in constants.RANKING:
+ bits.append(
+ "\t\t%s: %s"
+ % (
+ rank.capitalize(),
+ manager.metrics.data["_totals"][f"{criteria}.{rank}"],
+ )
+ )
+ return "\n".join([str(bit) for bit in bits])
+
+
+def _output_issue_str(
+ issue, indent, show_lineno=True, show_code=True, lines=-1
+):
+ # returns a list of lines that should be added to the existing lines list
+ bits = []
+ bits.append(
+ "%s%s>> Issue: [%s:%s] %s"
+ % (
+ indent,
+ COLOR[issue.severity],
+ issue.test_id,
+ issue.test,
+ issue.text,
+ )
+ )
+
+ bits.append(
+ "%s Severity: %s Confidence: %s"
+ % (
+ indent,
+ issue.severity.capitalize(),
+ issue.confidence.capitalize(),
+ )
+ )
+
+ bits.append(f"{indent} CWE: {str(issue.cwe)}")
+
+ bits.append(f"{indent} More Info: {docs_utils.get_url(issue.test_id)}")
+
+ bits.append(
+ "%s Location: %s:%s:%s%s"
+ % (
+ indent,
+ issue.fname,
+ issue.lineno if show_lineno else "",
+ issue.col_offset if show_lineno else "",
+ COLOR["DEFAULT"],
+ )
+ )
+
+ if show_code:
+ bits.extend(
+ [indent + line for line in issue.get_code(lines, True).split("\n")]
+ )
+
+ return "\n".join([bit for bit in bits])
+
+
+def get_results(manager, sev_level, conf_level, lines):
+ bits = []
+ issues = manager.get_issue_list(sev_level, conf_level)
+ baseline = not isinstance(issues, list)
+ candidate_indent = " " * 10
+
+ if not len(issues):
+ return "\tNo issues identified."
+
+ for issue in issues:
+ # if not a baseline or only one candidate we know the issue
+ if not baseline or len(issues[issue]) == 1:
+ bits.append(_output_issue_str(issue, "", lines=lines))
+
+ # otherwise show the finding and the candidates
+ else:
+ bits.append(
+ _output_issue_str(
+ issue, "", show_lineno=False, show_code=False
+ )
+ )
+
+ bits.append("\n-- Candidate Issues --")
+ for candidate in issues[issue]:
+ bits.append(
+ _output_issue_str(candidate, candidate_indent, lines=lines)
+ )
+ bits.append("\n")
+ bits.append("-" * 50)
+
+ return "\n".join([bit for bit in bits])
+
+
+def do_print(bits):
+ # needed so we can mock this stuff
+ print("\n".join([bit for bit in bits]))
+
+
+@test_properties.accepts_baseline
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """Prints discovered issues formatted for screen reading
+
+ This makes use of VT100 terminal codes for colored text.
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ if IS_WIN_PLATFORM and COLORAMA:
+ colorama.init()
+
+ bits = []
+ if not manager.quiet or manager.results_count(sev_level, conf_level):
+ bits.append(
+ header(
+ "Run started:%s", datetime.datetime.now(datetime.timezone.utc)
+ )
+ )
+
+ if manager.verbose:
+ bits.append(get_verbose_details(manager))
+
+ bits.append(header("\nTest results:"))
+ bits.append(get_results(manager, sev_level, conf_level, lines))
+ bits.append(header("\nCode scanned:"))
+ bits.append(
+ "\tTotal lines of code: %i"
+ % (manager.metrics.data["_totals"]["loc"])
+ )
+
+ bits.append(
+ "\tTotal lines skipped (#nosec): %i"
+ % (manager.metrics.data["_totals"]["nosec"])
+ )
+
+ bits.append(get_metrics(manager))
+ skipped = manager.get_skipped()
+ bits.append(header("Files skipped (%i):", len(skipped)))
+ bits.extend(["\t%s (%s)" % skip for skip in skipped])
+ do_print(bits)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info(
+ "Screen formatter output was not written to file: %s, "
+ "consider '-f txt'",
+ fileobj.name,
+ )
+
+ if IS_WIN_PLATFORM and COLORAMA:
+ colorama.deinit()
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/text.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/text.py
new file mode 100644
index 00000000..93249180
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/text.py
@@ -0,0 +1,200 @@
+# Copyright (c) 2015 Hewlett Packard Enterprise
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==============
+Text Formatter
+==============
+
+This formatter outputs the issues as plain text.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B301:blacklist_calls] Use of unsafe yaml load. Allows
+ instantiation of arbitrary objects. Consider yaml.safe_load().
+
+ Severity: Medium Confidence: High
+ CWE: CWE-20 (https://cwe.mitre.org/data/definitions/20.html)
+ More Info: https://bandit.readthedocs.io/en/latest/
+ Location: examples/yaml_load.py:5
+ 4 ystr = yaml.dump({'a' : 1, 'b' : 2, 'c' : 3})
+ 5 y = yaml.load(ystr)
+ 6 yaml.dump(y)
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.5.0
+ New field `more_info` added to output
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+import datetime
+import logging
+import sys
+
+from bandit.core import constants
+from bandit.core import docs_utils
+from bandit.core import test_properties
+from bandit.formatters import utils
+
+LOG = logging.getLogger(__name__)
+
+
+def get_verbose_details(manager):
+ bits = []
+ bits.append(f"Files in scope ({len(manager.files_list)}):")
+ tpl = "\t%s (score: {SEVERITY: %i, CONFIDENCE: %i})"
+ bits.extend(
+ [
+ tpl % (item, sum(score["SEVERITY"]), sum(score["CONFIDENCE"]))
+ for (item, score) in zip(manager.files_list, manager.scores)
+ ]
+ )
+ bits.append(f"Files excluded ({len(manager.excluded_files)}):")
+ bits.extend([f"\t{fname}" for fname in manager.excluded_files])
+ return "\n".join([bit for bit in bits])
+
+
+def get_metrics(manager):
+ bits = []
+ bits.append("\nRun metrics:")
+ for criteria, _ in constants.CRITERIA:
+ bits.append(f"\tTotal issues (by {criteria.lower()}):")
+ for rank in constants.RANKING:
+ bits.append(
+ "\t\t%s: %s"
+ % (
+ rank.capitalize(),
+ manager.metrics.data["_totals"][f"{criteria}.{rank}"],
+ )
+ )
+ return "\n".join([bit for bit in bits])
+
+
+def _output_issue_str(
+ issue, indent, show_lineno=True, show_code=True, lines=-1
+):
+ # returns a list of lines that should be added to the existing lines list
+ bits = []
+ bits.append(
+ f"{indent}>> Issue: [{issue.test_id}:{issue.test}] {issue.text}"
+ )
+
+ bits.append(
+ "%s Severity: %s Confidence: %s"
+ % (
+ indent,
+ issue.severity.capitalize(),
+ issue.confidence.capitalize(),
+ )
+ )
+
+ bits.append(f"{indent} CWE: {str(issue.cwe)}")
+
+ bits.append(f"{indent} More Info: {docs_utils.get_url(issue.test_id)}")
+
+ bits.append(
+ "%s Location: %s:%s:%s"
+ % (
+ indent,
+ issue.fname,
+ issue.lineno if show_lineno else "",
+ issue.col_offset if show_lineno else "",
+ )
+ )
+
+ if show_code:
+ bits.extend(
+ [indent + line for line in issue.get_code(lines, True).split("\n")]
+ )
+
+ return "\n".join([bit for bit in bits])
+
+
+def get_results(manager, sev_level, conf_level, lines):
+ bits = []
+ issues = manager.get_issue_list(sev_level, conf_level)
+ baseline = not isinstance(issues, list)
+ candidate_indent = " " * 10
+
+ if not len(issues):
+ return "\tNo issues identified."
+
+ for issue in issues:
+ # if not a baseline or only one candidate we know the issue
+ if not baseline or len(issues[issue]) == 1:
+ bits.append(_output_issue_str(issue, "", lines=lines))
+
+ # otherwise show the finding and the candidates
+ else:
+ bits.append(
+ _output_issue_str(
+ issue, "", show_lineno=False, show_code=False
+ )
+ )
+
+ bits.append("\n-- Candidate Issues --")
+ for candidate in issues[issue]:
+ bits.append(
+ _output_issue_str(candidate, candidate_indent, lines=lines)
+ )
+ bits.append("\n")
+ bits.append("-" * 50)
+ return "\n".join([bit for bit in bits])
+
+
+@test_properties.accepts_baseline
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """Prints discovered issues in the text format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ bits = []
+
+ if not manager.quiet or manager.results_count(sev_level, conf_level):
+ bits.append(
+ f"Run started:{datetime.datetime.now(datetime.timezone.utc)}"
+ )
+
+ if manager.verbose:
+ bits.append(get_verbose_details(manager))
+
+ bits.append("\nTest results:")
+ bits.append(get_results(manager, sev_level, conf_level, lines))
+ bits.append("\nCode scanned:")
+ bits.append(
+ "\tTotal lines of code: %i"
+ % (manager.metrics.data["_totals"]["loc"])
+ )
+
+ bits.append(
+ "\tTotal lines skipped (#nosec): %i"
+ % (manager.metrics.data["_totals"]["nosec"])
+ )
+ bits.append(
+ "\tTotal potential issues skipped due to specifically being "
+ "disabled (e.g., #nosec BXXX): %i"
+ % (manager.metrics.data["_totals"]["skipped_tests"])
+ )
+
+ skipped = manager.get_skipped()
+ bits.append(get_metrics(manager))
+ bits.append(f"Files skipped ({len(skipped)}):")
+ bits.extend(["\t%s (%s)" % skip for skip in skipped])
+ result = "\n".join([bit for bit in bits]) + "\n"
+
+ with fileobj:
+ wrapped_file = utils.wrap_file_object(fileobj)
+ wrapped_file.write(result)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("Text output written to file: %s", fileobj.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/utils.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/utils.py
new file mode 100644
index 00000000..ebe9f921
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/utils.py
@@ -0,0 +1,14 @@
+# Copyright (c) 2016 Rackspace, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+"""Utility functions for formatting plugins for Bandit."""
+import io
+
+
+def wrap_file_object(fileobj):
+ """If the fileobj passed in cannot handle text, use TextIOWrapper
+ to handle the conversion.
+ """
+ if isinstance(fileobj, io.TextIOBase):
+ return fileobj
+ return io.TextIOWrapper(fileobj)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/xml.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/xml.py
new file mode 100644
index 00000000..d2b2067f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/xml.py
@@ -0,0 +1,97 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=============
+XML Formatter
+=============
+
+This formatter outputs the issues as XML.
+
+:Example:
+
+.. code-block:: xml
+
+
+ Test ID: B301
+ Severity: MEDIUM Confidence: HIGH
+ CWE: CWE-20 (https://cwe.mitre.org/data/definitions/20.html) Use of unsafe
+ yaml load.
+ Allows instantiation of arbitrary objects. Consider yaml.safe_load().
+
+ Location examples/yaml_load.py:5
+
+.. versionadded:: 0.12.0
+
+.. versionchanged:: 1.5.0
+ New field `more_info` added to output
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+import logging
+import sys
+from xml.etree import ElementTree as ET # nosec: B405
+
+from bandit.core import docs_utils
+
+LOG = logging.getLogger(__name__)
+
+
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """Prints issues in XML format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ issues = manager.get_issue_list(sev_level=sev_level, conf_level=conf_level)
+ root = ET.Element("testsuite", name="bandit", tests=str(len(issues)))
+
+ for issue in issues:
+ test = issue.test
+ testcase = ET.SubElement(
+ root, "testcase", classname=issue.fname, name=test
+ )
+
+ text = (
+ "Test ID: %s Severity: %s Confidence: %s\nCWE: %s\n%s\n"
+ "Location %s:%s"
+ )
+ text %= (
+ issue.test_id,
+ issue.severity,
+ issue.confidence,
+ issue.cwe,
+ issue.text,
+ issue.fname,
+ issue.lineno,
+ )
+ ET.SubElement(
+ testcase,
+ "error",
+ more_info=docs_utils.get_url(issue.test_id),
+ type=issue.severity,
+ message=issue.text,
+ ).text = text
+
+ tree = ET.ElementTree(root)
+
+ if fileobj.name == sys.stdout.name:
+ fileobj = sys.stdout.buffer
+ elif fileobj.mode == "w":
+ fileobj.close()
+ fileobj = open(fileobj.name, "wb")
+
+ with fileobj:
+ tree.write(fileobj, encoding="utf-8", xml_declaration=True)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("XML output written to file: %s", fileobj.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/formatters/yaml.py b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/yaml.py
new file mode 100644
index 00000000..42110907
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/formatters/yaml.py
@@ -0,0 +1,126 @@
+# Copyright (c) 2017 VMware, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==============
+YAML Formatter
+==============
+
+This formatter outputs the issues in a yaml format.
+
+:Example:
+
+.. code-block:: none
+
+ errors: []
+ generated_at: '2017-03-09T22:29:30Z'
+ metrics:
+ _totals:
+ CONFIDENCE.HIGH: 1
+ CONFIDENCE.LOW: 0
+ CONFIDENCE.MEDIUM: 0
+ CONFIDENCE.UNDEFINED: 0
+ SEVERITY.HIGH: 0
+ SEVERITY.LOW: 0
+ SEVERITY.MEDIUM: 1
+ SEVERITY.UNDEFINED: 0
+ loc: 9
+ nosec: 0
+ examples/yaml_load.py:
+ CONFIDENCE.HIGH: 1
+ CONFIDENCE.LOW: 0
+ CONFIDENCE.MEDIUM: 0
+ CONFIDENCE.UNDEFINED: 0
+ SEVERITY.HIGH: 0
+ SEVERITY.LOW: 0
+ SEVERITY.MEDIUM: 1
+ SEVERITY.UNDEFINED: 0
+ loc: 9
+ nosec: 0
+ results:
+ - code: '5 ystr = yaml.dump({''a'' : 1, ''b'' : 2, ''c'' : 3})\n
+ 6 y = yaml.load(ystr)\n7 yaml.dump(y)\n'
+ filename: examples/yaml_load.py
+ issue_confidence: HIGH
+ issue_severity: MEDIUM
+ issue_text: Use of unsafe yaml load. Allows instantiation of arbitrary
+ objects.
+ Consider yaml.safe_load().
+ line_number: 6
+ line_range:
+ - 6
+ more_info: https://bandit.readthedocs.io/en/latest/
+ test_id: B506
+ test_name: yaml_load
+
+.. versionadded:: 1.5.0
+
+.. versionchanged:: 1.7.3
+ New field `CWE` added to output
+
+"""
+# Necessary for this formatter to work when imported on Python 2. Importing
+# the standard library's yaml module conflicts with the name of this module.
+import datetime
+import logging
+import operator
+import sys
+
+import yaml
+
+from bandit.core import docs_utils
+
+LOG = logging.getLogger(__name__)
+
+
+def report(manager, fileobj, sev_level, conf_level, lines=-1):
+ """Prints issues in YAML format
+
+ :param manager: the bandit manager object
+ :param fileobj: The output file object, which may be sys.stdout
+ :param sev_level: Filtering severity level
+ :param conf_level: Filtering confidence level
+ :param lines: Number of lines to report, -1 for all
+ """
+
+ machine_output = {"results": [], "errors": []}
+ for fname, reason in manager.get_skipped():
+ machine_output["errors"].append({"filename": fname, "reason": reason})
+
+ results = manager.get_issue_list(
+ sev_level=sev_level, conf_level=conf_level
+ )
+
+ collector = [r.as_dict(max_lines=lines) for r in results]
+ for elem in collector:
+ elem["more_info"] = docs_utils.get_url(elem["test_id"])
+
+ itemgetter = operator.itemgetter
+ if manager.agg_type == "vuln":
+ machine_output["results"] = sorted(
+ collector, key=itemgetter("test_name")
+ )
+ else:
+ machine_output["results"] = sorted(
+ collector, key=itemgetter("filename")
+ )
+
+ machine_output["metrics"] = manager.metrics.data
+
+ for result in machine_output["results"]:
+ if "code" in result:
+ code = result["code"].replace("\n", "\\n")
+ result["code"] = code
+
+ # timezone agnostic format
+ TS_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
+ time_string = datetime.datetime.now(datetime.timezone.utc).strftime(
+ TS_FORMAT
+ )
+ machine_output["generated_at"] = time_string
+
+ yaml.safe_dump(machine_output, fileobj, default_flow_style=False)
+
+ if fileobj.name != sys.stdout.name:
+ LOG.info("YAML output written to file: %s", fileobj.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/python_multipart-0.0.6.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__init__.py
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/python_multipart-0.0.6.dist-info/REQUESTED
rename to Backend/venv/lib/python3.12/site-packages/bandit/plugins/__init__.py
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..1b18ef60
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/app_debug.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/app_debug.cpython-312.pyc
new file mode 100644
index 00000000..ffd334f7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/app_debug.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/asserts.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/asserts.cpython-312.pyc
new file mode 100644
index 00000000..b69718aa
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/asserts.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/crypto_request_no_cert_validation.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/crypto_request_no_cert_validation.cpython-312.pyc
new file mode 100644
index 00000000..a34f5659
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/crypto_request_no_cert_validation.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/django_sql_injection.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/django_sql_injection.cpython-312.pyc
new file mode 100644
index 00000000..bb18df9c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/django_sql_injection.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/django_xss.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/django_xss.cpython-312.pyc
new file mode 100644
index 00000000..0a6e1be1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/django_xss.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/exec.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/exec.cpython-312.pyc
new file mode 100644
index 00000000..964bfa21
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/exec.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_bad_file_permissions.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_bad_file_permissions.cpython-312.pyc
new file mode 100644
index 00000000..16ece63e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_bad_file_permissions.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_bind_all_interfaces.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_bind_all_interfaces.cpython-312.pyc
new file mode 100644
index 00000000..a5518aae
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_bind_all_interfaces.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_hardcoded_password.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_hardcoded_password.cpython-312.pyc
new file mode 100644
index 00000000..6c064c1c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_hardcoded_password.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_hardcoded_tmp.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_hardcoded_tmp.cpython-312.pyc
new file mode 100644
index 00000000..adc213e0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/general_hardcoded_tmp.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/hashlib_insecure_functions.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/hashlib_insecure_functions.cpython-312.pyc
new file mode 100644
index 00000000..94f8a20b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/hashlib_insecure_functions.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/huggingface_unsafe_download.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/huggingface_unsafe_download.cpython-312.pyc
new file mode 100644
index 00000000..ec4e8fc0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/huggingface_unsafe_download.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_paramiko.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_paramiko.cpython-312.pyc
new file mode 100644
index 00000000..79dcc6fd
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_paramiko.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_shell.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_shell.cpython-312.pyc
new file mode 100644
index 00000000..394c1164
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_shell.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_sql.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_sql.cpython-312.pyc
new file mode 100644
index 00000000..6accdf05
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_sql.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_wildcard.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_wildcard.cpython-312.pyc
new file mode 100644
index 00000000..6af278cf
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/injection_wildcard.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/insecure_ssl_tls.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/insecure_ssl_tls.cpython-312.pyc
new file mode 100644
index 00000000..9c84fbec
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/insecure_ssl_tls.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/jinja2_templates.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/jinja2_templates.cpython-312.pyc
new file mode 100644
index 00000000..89814604
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/jinja2_templates.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/logging_config_insecure_listen.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/logging_config_insecure_listen.cpython-312.pyc
new file mode 100644
index 00000000..ad95f57f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/logging_config_insecure_listen.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/mako_templates.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/mako_templates.cpython-312.pyc
new file mode 100644
index 00000000..94bf3f8c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/mako_templates.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/markupsafe_markup_xss.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/markupsafe_markup_xss.cpython-312.pyc
new file mode 100644
index 00000000..076e74a5
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/markupsafe_markup_xss.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/pytorch_load.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/pytorch_load.cpython-312.pyc
new file mode 100644
index 00000000..844787f3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/pytorch_load.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/request_without_timeout.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/request_without_timeout.cpython-312.pyc
new file mode 100644
index 00000000..1147e8e9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/request_without_timeout.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/snmp_security_check.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/snmp_security_check.cpython-312.pyc
new file mode 100644
index 00000000..00cee1d9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/snmp_security_check.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/ssh_no_host_key_verification.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/ssh_no_host_key_verification.cpython-312.pyc
new file mode 100644
index 00000000..4b46ecf4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/ssh_no_host_key_verification.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/tarfile_unsafe_members.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/tarfile_unsafe_members.cpython-312.pyc
new file mode 100644
index 00000000..fb50fee3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/tarfile_unsafe_members.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/trojansource.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/trojansource.cpython-312.pyc
new file mode 100644
index 00000000..5d0abe62
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/trojansource.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/try_except_continue.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/try_except_continue.cpython-312.pyc
new file mode 100644
index 00000000..0600d863
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/try_except_continue.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/try_except_pass.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/try_except_pass.cpython-312.pyc
new file mode 100644
index 00000000..7ba2ccc9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/try_except_pass.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/weak_cryptographic_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/weak_cryptographic_key.cpython-312.pyc
new file mode 100644
index 00000000..6f46a8bd
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/weak_cryptographic_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/yaml_load.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/yaml_load.cpython-312.pyc
new file mode 100644
index 00000000..b28d74f4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/__pycache__/yaml_load.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/app_debug.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/app_debug.py
new file mode 100644
index 00000000..3b18996f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/app_debug.py
@@ -0,0 +1,63 @@
+#
+# Copyright 2015 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+======================================================
+B201: Test for use of flask app with debug set to true
+======================================================
+
+Running Flask applications in debug mode results in the Werkzeug debugger
+being enabled. This includes a feature that allows arbitrary code execution.
+Documentation for both Flask [1]_ and Werkzeug [2]_ strongly suggests that
+debug mode should never be enabled on production systems.
+
+Operating a production server with debug mode enabled was the probable cause
+of the Patreon breach in 2015 [3]_.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: A Flask app appears to be run with debug=True, which exposes
+ the Werkzeug debugger and allows the execution of arbitrary code.
+ Severity: High Confidence: High
+ CWE: CWE-94 (https://cwe.mitre.org/data/definitions/94.html)
+ Location: examples/flask_debug.py:10
+ 9 #bad
+ 10 app.run(debug=True)
+ 11
+
+.. seealso::
+
+ .. [1] https://flask.palletsprojects.com/en/1.1.x/quickstart/#debug-mode
+ .. [2] https://werkzeug.palletsprojects.com/en/1.0.x/debug/
+ .. [3] https://labs.detectify.com/2015/10/02/how-patreon-got-hacked-publicly-exposed-werkzeug-debugger/
+ .. https://cwe.mitre.org/data/definitions/94.html
+
+.. versionadded:: 0.15.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+""" # noqa: E501
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.test_id("B201")
+@test.checks("Call")
+def flask_debug_true(context):
+ if context.is_module_imported_like("flask"):
+ if context.call_function_name_qual.endswith(".run"):
+ if context.check_call_arg_value("debug", "True"):
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.CODE_INJECTION,
+ text="A Flask app appears to be run with debug=True, "
+ "which exposes the Werkzeug debugger and allows "
+ "the execution of arbitrary code.",
+ lineno=context.get_lineno_for_call_arg("debug"),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/asserts.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/asserts.py
new file mode 100644
index 00000000..b32007c6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/asserts.py
@@ -0,0 +1,83 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+============================
+B101: Test for use of assert
+============================
+
+This plugin test checks for the use of the Python ``assert`` keyword. It was
+discovered that some projects used assert to enforce interface constraints.
+However, assert is removed with compiling to optimised byte code (`python -O`
+producing \*.opt-1.pyc files). This caused various protections to be removed.
+Consider raising a semantically meaningful error or ``AssertionError`` instead.
+
+Please see
+https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement for
+more info on ``assert``.
+
+**Config Options:**
+
+You can configure files that skip this check. This is often useful when you
+use assert statements in test cases.
+
+.. code-block:: yaml
+
+ assert_used:
+ skips: ['*_test.py', '*test_*.py']
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Use of assert detected. The enclosed code will be removed when
+ compiling to optimised byte code.
+ Severity: Low Confidence: High
+ CWE: CWE-703 (https://cwe.mitre.org/data/definitions/703.html)
+ Location: ./examples/assert.py:1
+ 1 assert logged_in
+ 2 display_assets()
+
+.. seealso::
+
+ - https://bugs.launchpad.net/juniperopenstack/+bug/1456193
+ - https://bugs.launchpad.net/heat/+bug/1397883
+ - https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement
+ - https://cwe.mitre.org/data/definitions/703.html
+
+.. versionadded:: 0.11.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import fnmatch
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def gen_config(name):
+ if name == "assert_used":
+ return {"skips": []}
+
+
+@test.takes_config
+@test.test_id("B101")
+@test.checks("Assert")
+def assert_used(context, config):
+ for skip in config.get("skips", []):
+ if fnmatch.fnmatch(context.filename, skip):
+ return None
+
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.IMPROPER_CHECK_OF_EXCEPT_COND,
+ text=(
+ "Use of assert detected. The enclosed code "
+ "will be removed when compiling to optimised byte code."
+ ),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/crypto_request_no_cert_validation.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/crypto_request_no_cert_validation.py
new file mode 100644
index 00000000..11791ed1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/crypto_request_no_cert_validation.py
@@ -0,0 +1,75 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=============================================
+B501: Test for missing certificate validation
+=============================================
+
+Encryption in general is typically critical to the security of many
+applications. Using TLS can greatly increase security by guaranteeing the
+identity of the party you are communicating with. This is accomplished by one
+or both parties presenting trusted certificates during the connection
+initialization phase of TLS.
+
+When HTTPS request methods are used, certificates are validated automatically
+which is the desired behavior. If certificate validation is explicitly turned
+off Bandit will return a HIGH severity error.
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [request_with_no_cert_validation] Call to requests with
+ verify=False disabling SSL certificate checks, security issue.
+ Severity: High Confidence: High
+ CWE: CWE-295 (https://cwe.mitre.org/data/definitions/295.html)
+ Location: examples/requests-ssl-verify-disabled.py:4
+ 3 requests.get('https://gmail.com', verify=True)
+ 4 requests.get('https://gmail.com', verify=False)
+ 5 requests.post('https://gmail.com', verify=True)
+
+.. seealso::
+
+ - https://security.openstack.org/guidelines/dg_move-data-securely.html
+ - https://security.openstack.org/guidelines/dg_validate-certificates.html
+ - https://cwe.mitre.org/data/definitions/295.html
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+.. versionchanged:: 1.7.5
+ Added check for httpx module
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B501")
+def request_with_no_cert_validation(context):
+ HTTP_VERBS = {"get", "options", "head", "post", "put", "patch", "delete"}
+ HTTPX_ATTRS = {"request", "stream", "Client", "AsyncClient"} | HTTP_VERBS
+ qualname = context.call_function_name_qual.split(".")[0]
+
+ if (
+ qualname == "requests"
+ and context.call_function_name in HTTP_VERBS
+ or qualname == "httpx"
+ and context.call_function_name in HTTPX_ATTRS
+ ):
+ if context.check_call_arg_value("verify", "False"):
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.IMPROPER_CERT_VALIDATION,
+ text=f"Call to {qualname} with verify=False disabling SSL "
+ "certificate checks, security issue.",
+ lineno=context.get_lineno_for_call_arg("verify"),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/django_sql_injection.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/django_sql_injection.py
new file mode 100644
index 00000000..d27ba7d1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/django_sql_injection.py
@@ -0,0 +1,155 @@
+#
+# Copyright (C) 2018 [Victor Torre](https://github.com/ehooo)
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def keywords2dict(keywords):
+ kwargs = {}
+ for node in keywords:
+ if isinstance(node, ast.keyword):
+ kwargs[node.arg] = node.value
+ return kwargs
+
+
+@test.checks("Call")
+@test.test_id("B610")
+def django_extra_used(context):
+ """**B610: Potential SQL injection on extra function**
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [B610:django_extra_used] Use of extra potential SQL attack vector.
+ Severity: Medium Confidence: Medium
+ CWE: CWE-89 (https://cwe.mitre.org/data/definitions/89.html)
+ Location: examples/django_sql_injection_extra.py:29:0
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b610_django_extra_used.html
+ 28 tables_str = 'django_content_type" WHERE "auth_user"."username"="admin'
+ 29 User.objects.all().extra(tables=[tables_str]).distinct()
+
+ .. seealso::
+
+ - https://docs.djangoproject.com/en/dev/topics/security/\
+#sql-injection-protection
+ - https://cwe.mitre.org/data/definitions/89.html
+
+ .. versionadded:: 1.5.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+ description = "Use of extra potential SQL attack vector."
+ if context.call_function_name == "extra":
+ kwargs = keywords2dict(context.node.keywords)
+ args = context.node.args
+ if args:
+ if len(args) >= 1:
+ kwargs["select"] = args[0]
+ if len(args) >= 2:
+ kwargs["where"] = args[1]
+ if len(args) >= 3:
+ kwargs["params"] = args[2]
+ if len(args) >= 4:
+ kwargs["tables"] = args[3]
+ if len(args) >= 5:
+ kwargs["order_by"] = args[4]
+ if len(args) >= 6:
+ kwargs["select_params"] = args[5]
+ insecure = False
+ for key in ["where", "tables"]:
+ if key in kwargs:
+ if isinstance(kwargs[key], ast.List):
+ for val in kwargs[key].elts:
+ if not (
+ isinstance(val, ast.Constant)
+ and isinstance(val.value, str)
+ ):
+ insecure = True
+ break
+ else:
+ insecure = True
+ break
+ if not insecure and "select" in kwargs:
+ if isinstance(kwargs["select"], ast.Dict):
+ for k in kwargs["select"].keys:
+ if not (
+ isinstance(k, ast.Constant)
+ and isinstance(k.value, str)
+ ):
+ insecure = True
+ break
+ if not insecure:
+ for v in kwargs["select"].values:
+ if not (
+ isinstance(v, ast.Constant)
+ and isinstance(v.value, str)
+ ):
+ insecure = True
+ break
+ else:
+ insecure = True
+
+ if insecure:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.SQL_INJECTION,
+ text=description,
+ )
+
+
+@test.checks("Call")
+@test.test_id("B611")
+def django_rawsql_used(context):
+ """**B611: Potential SQL injection on RawSQL function**
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [B611:django_rawsql_used] Use of RawSQL potential SQL attack vector.
+ Severity: Medium Confidence: Medium
+ CWE: CWE-89 (https://cwe.mitre.org/data/definitions/89.html)
+ Location: examples/django_sql_injection_raw.py:11:26
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b611_django_rawsql_used.html
+ 10 ' WHERE "username"="admin" OR 1=%s --'
+ 11 User.objects.annotate(val=RawSQL(raw, [0]))
+
+ .. seealso::
+
+ - https://docs.djangoproject.com/en/dev/topics/security/\
+#sql-injection-protection
+ - https://cwe.mitre.org/data/definitions/89.html
+
+ .. versionadded:: 1.5.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+ description = "Use of RawSQL potential SQL attack vector."
+ if context.is_module_imported_like("django.db.models"):
+ if context.call_function_name == "RawSQL":
+ if context.node.args:
+ sql = context.node.args[0]
+ else:
+ kwargs = keywords2dict(context.node.keywords)
+ sql = kwargs["sql"]
+
+ if not (
+ isinstance(sql, ast.Constant) and isinstance(sql.value, str)
+ ):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.SQL_INJECTION,
+ text=description,
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/django_xss.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/django_xss.py
new file mode 100644
index 00000000..1a0958a8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/django_xss.py
@@ -0,0 +1,287 @@
+#
+# Copyright 2018 Victor Torre
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+class DeepAssignation:
+ def __init__(self, var_name, ignore_nodes=None):
+ self.var_name = var_name
+ self.ignore_nodes = ignore_nodes
+
+ def is_assigned_in(self, items):
+ assigned = []
+ for ast_inst in items:
+ new_assigned = self.is_assigned(ast_inst)
+ if new_assigned:
+ if isinstance(new_assigned, (list, tuple)):
+ assigned.extend(new_assigned)
+ else:
+ assigned.append(new_assigned)
+ return assigned
+
+ def is_assigned(self, node):
+ assigned = False
+ if self.ignore_nodes:
+ if isinstance(self.ignore_nodes, (list, tuple, object)):
+ if isinstance(node, self.ignore_nodes):
+ return assigned
+
+ if isinstance(node, ast.Expr):
+ assigned = self.is_assigned(node.value)
+ elif isinstance(node, ast.FunctionDef):
+ for name in node.args.args:
+ if isinstance(name, ast.Name):
+ if name.id == self.var_name.id:
+ # If is param the assignations are not affected
+ return assigned
+ assigned = self.is_assigned_in(node.body)
+ elif isinstance(node, ast.With):
+ for withitem in node.items:
+ var_id = getattr(withitem.optional_vars, "id", None)
+ if var_id == self.var_name.id:
+ assigned = node
+ else:
+ assigned = self.is_assigned_in(node.body)
+ elif isinstance(node, ast.Try):
+ assigned = []
+ assigned.extend(self.is_assigned_in(node.body))
+ assigned.extend(self.is_assigned_in(node.handlers))
+ assigned.extend(self.is_assigned_in(node.orelse))
+ assigned.extend(self.is_assigned_in(node.finalbody))
+ elif isinstance(node, ast.ExceptHandler):
+ assigned = []
+ assigned.extend(self.is_assigned_in(node.body))
+ elif isinstance(node, (ast.If, ast.For, ast.While)):
+ assigned = []
+ assigned.extend(self.is_assigned_in(node.body))
+ assigned.extend(self.is_assigned_in(node.orelse))
+ elif isinstance(node, ast.AugAssign):
+ if isinstance(node.target, ast.Name):
+ if node.target.id == self.var_name.id:
+ assigned = node.value
+ elif isinstance(node, ast.Assign) and node.targets:
+ target = node.targets[0]
+ if isinstance(target, ast.Name):
+ if target.id == self.var_name.id:
+ assigned = node.value
+ elif isinstance(target, ast.Tuple) and isinstance(
+ node.value, ast.Tuple
+ ):
+ pos = 0
+ for name in target.elts:
+ if name.id == self.var_name.id:
+ assigned = node.value.elts[pos]
+ break
+ pos += 1
+ return assigned
+
+
+def evaluate_var(xss_var, parent, until, ignore_nodes=None):
+ secure = False
+ if isinstance(xss_var, ast.Name):
+ if isinstance(parent, ast.FunctionDef):
+ for name in parent.args.args:
+ if name.arg == xss_var.id:
+ return False # Params are not secure
+
+ analyser = DeepAssignation(xss_var, ignore_nodes)
+ for node in parent.body:
+ if node.lineno >= until:
+ break
+ to = analyser.is_assigned(node)
+ if to:
+ if isinstance(to, ast.Constant) and isinstance(to.value, str):
+ secure = True
+ elif isinstance(to, ast.Name):
+ secure = evaluate_var(to, parent, to.lineno, ignore_nodes)
+ elif isinstance(to, ast.Call):
+ secure = evaluate_call(to, parent, ignore_nodes)
+ elif isinstance(to, (list, tuple)):
+ num_secure = 0
+ for some_to in to:
+ if isinstance(some_to, ast.Constant) and isinstance(
+ some_to.value, str
+ ):
+ num_secure += 1
+ elif isinstance(some_to, ast.Name):
+ if evaluate_var(
+ some_to, parent, node.lineno, ignore_nodes
+ ):
+ num_secure += 1
+ else:
+ break
+ else:
+ break
+ if num_secure == len(to):
+ secure = True
+ else:
+ secure = False
+ break
+ else:
+ secure = False
+ break
+ return secure
+
+
+def evaluate_call(call, parent, ignore_nodes=None):
+ secure = False
+ evaluate = False
+ if isinstance(call, ast.Call) and isinstance(call.func, ast.Attribute):
+ if (
+ isinstance(call.func.value, ast.Constant)
+ and call.func.attr == "format"
+ ):
+ evaluate = True
+ if call.keywords:
+ evaluate = False # TODO(??) get support for this
+
+ if evaluate:
+ args = list(call.args)
+ num_secure = 0
+ for arg in args:
+ if isinstance(arg, ast.Constant) and isinstance(arg.value, str):
+ num_secure += 1
+ elif isinstance(arg, ast.Name):
+ if evaluate_var(arg, parent, call.lineno, ignore_nodes):
+ num_secure += 1
+ else:
+ break
+ elif isinstance(arg, ast.Call):
+ if evaluate_call(arg, parent, ignore_nodes):
+ num_secure += 1
+ else:
+ break
+ elif isinstance(arg, ast.Starred) and isinstance(
+ arg.value, (ast.List, ast.Tuple)
+ ):
+ args.extend(arg.value.elts)
+ num_secure += 1
+ else:
+ break
+ secure = num_secure == len(args)
+
+ return secure
+
+
+def transform2call(var):
+ if isinstance(var, ast.BinOp):
+ is_mod = isinstance(var.op, ast.Mod)
+ is_left_str = isinstance(var.left, ast.Constant) and isinstance(
+ var.left.value, str
+ )
+ if is_mod and is_left_str:
+ new_call = ast.Call()
+ new_call.args = []
+ new_call.args = []
+ new_call.keywords = None
+ new_call.lineno = var.lineno
+ new_call.func = ast.Attribute()
+ new_call.func.value = var.left
+ new_call.func.attr = "format"
+ if isinstance(var.right, ast.Tuple):
+ new_call.args = var.right.elts
+ else:
+ new_call.args = [var.right]
+ return new_call
+
+
+def check_risk(node):
+ description = "Potential XSS on mark_safe function."
+ xss_var = node.args[0]
+
+ secure = False
+
+ if isinstance(xss_var, ast.Name):
+ # Check if the var are secure
+ parent = node._bandit_parent
+ while not isinstance(parent, (ast.Module, ast.FunctionDef)):
+ parent = parent._bandit_parent
+
+ is_param = False
+ if isinstance(parent, ast.FunctionDef):
+ for name in parent.args.args:
+ if name.arg == xss_var.id:
+ is_param = True
+ break
+
+ if not is_param:
+ secure = evaluate_var(xss_var, parent, node.lineno)
+ elif isinstance(xss_var, ast.Call):
+ parent = node._bandit_parent
+ while not isinstance(parent, (ast.Module, ast.FunctionDef)):
+ parent = parent._bandit_parent
+ secure = evaluate_call(xss_var, parent)
+ elif isinstance(xss_var, ast.BinOp):
+ is_mod = isinstance(xss_var.op, ast.Mod)
+ is_left_str = isinstance(xss_var.left, ast.Constant) and isinstance(
+ xss_var.left.value, str
+ )
+ if is_mod and is_left_str:
+ parent = node._bandit_parent
+ while not isinstance(parent, (ast.Module, ast.FunctionDef)):
+ parent = parent._bandit_parent
+ new_call = transform2call(xss_var)
+ secure = evaluate_call(new_call, parent)
+
+ if not secure:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BASIC_XSS,
+ text=description,
+ )
+
+
+@test.checks("Call")
+@test.test_id("B703")
+def django_mark_safe(context):
+ """**B703: Potential XSS on mark_safe function**
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [B703:django_mark_safe] Potential XSS on mark_safe function.
+ Severity: Medium Confidence: High
+ CWE: CWE-80 (https://cwe.mitre.org/data/definitions/80.html)
+ Location: examples/mark_safe_insecure.py:159:4
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b703_django_mark_safe.html
+ 158 str_arg = 'could be insecure'
+ 159 safestring.mark_safe(str_arg)
+
+ .. seealso::
+
+ - https://docs.djangoproject.com/en/dev/topics/security/\
+#cross-site-scripting-xss-protection
+ - https://docs.djangoproject.com/en/dev/ref/utils/\
+#module-django.utils.safestring
+ - https://docs.djangoproject.com/en/dev/ref/utils/\
+#django.utils.html.format_html
+ - https://cwe.mitre.org/data/definitions/80.html
+
+ .. versionadded:: 1.5.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+ if context.is_module_imported_like("django.utils.safestring"):
+ affected_functions = [
+ "mark_safe",
+ "SafeText",
+ "SafeUnicode",
+ "SafeString",
+ "SafeBytes",
+ ]
+ if context.call_function_name in affected_functions:
+ xss = context.node.args[0]
+ if not (
+ isinstance(xss, ast.Constant) and isinstance(xss.value, str)
+ ):
+ return check_risk(context.node)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/exec.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/exec.py
new file mode 100644
index 00000000..3e462478
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/exec.py
@@ -0,0 +1,55 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==============================
+B102: Test for the use of exec
+==============================
+
+This plugin test checks for the use of Python's `exec` method or keyword. The
+Python docs succinctly describe why the use of `exec` is risky.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Use of exec detected.
+ Severity: Medium Confidence: High
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/exec.py:2
+ 1 exec("do evil")
+
+
+.. seealso::
+
+ - https://docs.python.org/3/library/functions.html#exec
+ - https://www.python.org/dev/peps/pep-0551/#background
+ - https://www.python.org/dev/peps/pep-0578/#suggested-audit-hook-locations
+ - https://cwe.mitre.org/data/definitions/78.html
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def exec_issue():
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="Use of exec detected.",
+ )
+
+
+@test.checks("Call")
+@test.test_id("B102")
+def exec_used(context):
+ if context.call_function_name_qual == "exec":
+ return exec_issue()
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_bad_file_permissions.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_bad_file_permissions.py
new file mode 100644
index 00000000..7d3fce4d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_bad_file_permissions.py
@@ -0,0 +1,99 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==================================================
+B103: Test for setting permissive file permissions
+==================================================
+
+POSIX based operating systems utilize a permissions model to protect access to
+parts of the file system. This model supports three roles "owner", "group"
+and "world" each role may have a combination of "read", "write" or "execute"
+flags sets. Python provides ``chmod`` to manipulate POSIX style permissions.
+
+This plugin test looks for the use of ``chmod`` and will alert when it is used
+to set particularly permissive control flags. A MEDIUM warning is generated if
+a file is set to group write or executable and a HIGH warning is reported if a
+file is set world write or executable. Warnings are given with HIGH confidence.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Probable insecure usage of temp file/directory.
+ Severity: Medium Confidence: Medium
+ CWE: CWE-732 (https://cwe.mitre.org/data/definitions/732.html)
+ Location: ./examples/os-chmod.py:15
+ 14 os.chmod('/etc/hosts', 0o777)
+ 15 os.chmod('/tmp/oh_hai', 0x1ff)
+ 16 os.chmod('/etc/passwd', stat.S_IRWXU)
+
+ >> Issue: Chmod setting a permissive mask 0777 on file (key_file).
+ Severity: High Confidence: High
+ CWE: CWE-732 (https://cwe.mitre.org/data/definitions/732.html)
+ Location: ./examples/os-chmod.py:17
+ 16 os.chmod('/etc/passwd', stat.S_IRWXU)
+ 17 os.chmod(key_file, 0o777)
+ 18
+
+.. seealso::
+
+ - https://security.openstack.org/guidelines/dg_apply-restrictive-file-permissions.html
+ - https://en.wikipedia.org/wiki/File_system_permissions
+ - https://security.openstack.org
+ - https://cwe.mitre.org/data/definitions/732.html
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+.. versionchanged:: 1.7.5
+ Added checks for S_IWGRP and S_IXOTH
+
+""" # noqa: E501
+import stat
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def _stat_is_dangerous(mode):
+ return (
+ mode & stat.S_IWOTH
+ or mode & stat.S_IWGRP
+ or mode & stat.S_IXGRP
+ or mode & stat.S_IXOTH
+ )
+
+
+@test.checks("Call")
+@test.test_id("B103")
+def set_bad_file_permissions(context):
+ if "chmod" in context.call_function_name:
+ if context.call_args_count == 2:
+ mode = context.get_call_arg_at_position(1)
+
+ if (
+ mode is not None
+ and isinstance(mode, int)
+ and _stat_is_dangerous(mode)
+ ):
+ # world writable is an HIGH, group executable is a MEDIUM
+ if mode & stat.S_IWOTH:
+ sev_level = bandit.HIGH
+ else:
+ sev_level = bandit.MEDIUM
+
+ filename = context.get_call_arg_at_position(0)
+ if filename is None:
+ filename = "NOT PARSED"
+ return bandit.Issue(
+ severity=sev_level,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.INCORRECT_PERMISSION_ASSIGNMENT,
+ text="Chmod setting a permissive mask %s on file (%s)."
+ % (oct(mode), filename),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_bind_all_interfaces.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_bind_all_interfaces.py
new file mode 100644
index 00000000..58b840e8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_bind_all_interfaces.py
@@ -0,0 +1,52 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+========================================
+B104: Test for binding to all interfaces
+========================================
+
+Binding to all network interfaces can potentially open up a service to traffic
+on unintended interfaces, that may not be properly documented or secured. This
+plugin test looks for a string pattern "0.0.0.0" that may indicate a hardcoded
+binding to all network interfaces.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Possible binding to all interfaces.
+ Severity: Medium Confidence: Medium
+ CWE: CWE-605 (https://cwe.mitre.org/data/definitions/605.html)
+ Location: ./examples/binding.py:4
+ 3 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ 4 s.bind(('0.0.0.0', 31137))
+ 5 s.bind(('192.168.0.1', 8080))
+
+.. seealso::
+
+ - https://nvd.nist.gov/vuln/detail/CVE-2018-1281
+ - https://cwe.mitre.org/data/definitions/605.html
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Str")
+@test.test_id("B104")
+def hardcoded_bind_all_interfaces(context):
+ if context.string_val == "0.0.0.0": # nosec: B104
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.MULTIPLE_BINDS,
+ text="Possible binding to all interfaces.",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_hardcoded_password.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_hardcoded_password.py
new file mode 100644
index 00000000..8cde2bb5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_hardcoded_password.py
@@ -0,0 +1,269 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+import re
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+RE_WORDS = "(pas+wo?r?d|pass(phrase)?|pwd|token|secrete?)"
+RE_CANDIDATES = re.compile(
+ "(^{0}$|_{0}_|^{0}_|_{0}$)".format(RE_WORDS), re.IGNORECASE
+)
+
+
+def _report(value):
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.HARD_CODED_PASSWORD,
+ text=f"Possible hardcoded password: '{value}'",
+ )
+
+
+@test.checks("Str")
+@test.test_id("B105")
+def hardcoded_password_string(context):
+ """**B105: Test for use of hard-coded password strings**
+
+ The use of hard-coded passwords increases the possibility of password
+ guessing tremendously. This plugin test looks for all string literals and
+ checks the following conditions:
+
+ - assigned to a variable that looks like a password
+ - assigned to a dict key that looks like a password
+ - assigned to a class attribute that looks like a password
+ - used in a comparison with a variable that looks like a password
+
+ Variables are considered to look like a password if they have match any one
+ of:
+
+ - "password"
+ - "pass"
+ - "passwd"
+ - "pwd"
+ - "secret"
+ - "token"
+ - "secrete"
+
+ Note: this can be noisy and may generate false positives.
+
+ **Config Options:**
+
+ None
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: Possible hardcoded password '(root)'
+ Severity: Low Confidence: Low
+ CWE: CWE-259 (https://cwe.mitre.org/data/definitions/259.html)
+ Location: ./examples/hardcoded-passwords.py:5
+ 4 def someFunction2(password):
+ 5 if password == "root":
+ 6 print("OK, logged in")
+
+ .. seealso::
+
+ - https://www.owasp.org/index.php/Use_of_hard-coded_password
+ - https://cwe.mitre.org/data/definitions/259.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """
+ node = context.node
+ if isinstance(node._bandit_parent, ast.Assign):
+ # looks for "candidate='some_string'"
+ for targ in node._bandit_parent.targets:
+ if isinstance(targ, ast.Name) and RE_CANDIDATES.search(targ.id):
+ return _report(node.value)
+ elif isinstance(targ, ast.Attribute) and RE_CANDIDATES.search(
+ targ.attr
+ ):
+ return _report(node.value)
+
+ elif isinstance(
+ node._bandit_parent, ast.Subscript
+ ) and RE_CANDIDATES.search(node.value):
+ # Py39+: looks for "dict[candidate]='some_string'"
+ # subscript -> index -> string
+ assign = node._bandit_parent._bandit_parent
+ if (
+ isinstance(assign, ast.Assign)
+ and isinstance(assign.value, ast.Constant)
+ and isinstance(assign.value.value, str)
+ ):
+ return _report(assign.value.value)
+
+ elif isinstance(node._bandit_parent, ast.Index) and RE_CANDIDATES.search(
+ node.value
+ ):
+ # looks for "dict[candidate]='some_string'"
+ # assign -> subscript -> index -> string
+ assign = node._bandit_parent._bandit_parent._bandit_parent
+ if (
+ isinstance(assign, ast.Assign)
+ and isinstance(assign.value, ast.Constant)
+ and isinstance(assign.value.value, str)
+ ):
+ return _report(assign.value.value)
+
+ elif isinstance(node._bandit_parent, ast.Compare):
+ # looks for "candidate == 'some_string'"
+ comp = node._bandit_parent
+ if isinstance(comp.left, ast.Name):
+ if RE_CANDIDATES.search(comp.left.id):
+ if isinstance(
+ comp.comparators[0], ast.Constant
+ ) and isinstance(comp.comparators[0].value, str):
+ return _report(comp.comparators[0].value)
+ elif isinstance(comp.left, ast.Attribute):
+ if RE_CANDIDATES.search(comp.left.attr):
+ if isinstance(
+ comp.comparators[0], ast.Constant
+ ) and isinstance(comp.comparators[0].value, str):
+ return _report(comp.comparators[0].value)
+
+
+@test.checks("Call")
+@test.test_id("B106")
+def hardcoded_password_funcarg(context):
+ """**B106: Test for use of hard-coded password function arguments**
+
+ The use of hard-coded passwords increases the possibility of password
+ guessing tremendously. This plugin test looks for all function calls being
+ passed a keyword argument that is a string literal. It checks that the
+ assigned local variable does not look like a password.
+
+ Variables are considered to look like a password if they have match any one
+ of:
+
+ - "password"
+ - "pass"
+ - "passwd"
+ - "pwd"
+ - "secret"
+ - "token"
+ - "secrete"
+
+ Note: this can be noisy and may generate false positives.
+
+ **Config Options:**
+
+ None
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [B106:hardcoded_password_funcarg] Possible hardcoded
+ password: 'blerg'
+ Severity: Low Confidence: Medium
+ CWE: CWE-259 (https://cwe.mitre.org/data/definitions/259.html)
+ Location: ./examples/hardcoded-passwords.py:16
+ 15
+ 16 doLogin(password="blerg")
+
+ .. seealso::
+
+ - https://www.owasp.org/index.php/Use_of_hard-coded_password
+ - https://cwe.mitre.org/data/definitions/259.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """
+ # looks for "function(candidate='some_string')"
+ for kw in context.node.keywords:
+ if (
+ isinstance(kw.value, ast.Constant)
+ and isinstance(kw.value.value, str)
+ and RE_CANDIDATES.search(kw.arg)
+ ):
+ return _report(kw.value.value)
+
+
+@test.checks("FunctionDef")
+@test.test_id("B107")
+def hardcoded_password_default(context):
+ """**B107: Test for use of hard-coded password argument defaults**
+
+ The use of hard-coded passwords increases the possibility of password
+ guessing tremendously. This plugin test looks for all function definitions
+ that specify a default string literal for some argument. It checks that
+ the argument does not look like a password.
+
+ Variables are considered to look like a password if they have match any one
+ of:
+
+ - "password"
+ - "pass"
+ - "passwd"
+ - "pwd"
+ - "secret"
+ - "token"
+ - "secrete"
+
+ Note: this can be noisy and may generate false positives. We do not
+ report on None values which can be legitimately used as a default value,
+ when initializing a function or class.
+
+ **Config Options:**
+
+ None
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [B107:hardcoded_password_default] Possible hardcoded
+ password: 'Admin'
+ Severity: Low Confidence: Medium
+ CWE: CWE-259 (https://cwe.mitre.org/data/definitions/259.html)
+ Location: ./examples/hardcoded-passwords.py:1
+
+ 1 def someFunction(user, password="Admin"):
+ 2 print("Hi " + user)
+
+ .. seealso::
+
+ - https://www.owasp.org/index.php/Use_of_hard-coded_password
+ - https://cwe.mitre.org/data/definitions/259.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """
+ # looks for "def function(candidate='some_string')"
+
+ # this pads the list of default values with "None" if nothing is given
+ defs = [None] * (
+ len(context.node.args.args) - len(context.node.args.defaults)
+ )
+ defs.extend(context.node.args.defaults)
+
+ # go through all (param, value)s and look for candidates
+ for key, val in zip(context.node.args.args, defs):
+ if isinstance(key, (ast.Name, ast.arg)):
+ # Skip if the default value is None
+ if val is None or (
+ isinstance(val, ast.Constant) and val.value is None
+ ):
+ continue
+ if (
+ isinstance(val, ast.Constant)
+ and isinstance(val.value, str)
+ and RE_CANDIDATES.search(key.arg)
+ ):
+ return _report(val.value)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_hardcoded_tmp.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_hardcoded_tmp.py
new file mode 100644
index 00000000..ecf89952
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/general_hardcoded_tmp.py
@@ -0,0 +1,79 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+===================================================
+B108: Test for insecure usage of tmp file/directory
+===================================================
+
+Safely creating a temporary file or directory means following a number of rules
+(see the references for more details). This plugin test looks for strings
+starting with (configurable) commonly used temporary paths, for example:
+
+ - /tmp
+ - /var/tmp
+ - /dev/shm
+
+**Config Options:**
+
+This test plugin takes a similarly named config block,
+`hardcoded_tmp_directory`. The config block provides a Python list, `tmp_dirs`,
+that lists string fragments indicating possible temporary file paths. Any
+string starting with one of these fragments will report a MEDIUM confidence
+issue.
+
+.. code-block:: yaml
+
+ hardcoded_tmp_directory:
+ tmp_dirs: ['/tmp', '/var/tmp', '/dev/shm']
+
+
+:Example:
+
+.. code-block: none
+
+ >> Issue: Probable insecure usage of temp file/directory.
+ Severity: Medium Confidence: Medium
+ CWE: CWE-377 (https://cwe.mitre.org/data/definitions/377.html)
+ Location: ./examples/hardcoded-tmp.py:1
+ 1 f = open('/tmp/abc', 'w')
+ 2 f.write('def')
+
+.. seealso::
+
+ - https://security.openstack.org/guidelines/dg_using-temporary-files-securely.html
+ - https://cwe.mitre.org/data/definitions/377.html
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+""" # noqa: E501
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def gen_config(name):
+ if name == "hardcoded_tmp_directory":
+ return {"tmp_dirs": ["/tmp", "/var/tmp", "/dev/shm"]} # nosec: B108
+
+
+@test.takes_config
+@test.checks("Str")
+@test.test_id("B108")
+def hardcoded_tmp_directory(context, config):
+ if config is not None and "tmp_dirs" in config:
+ tmp_dirs = config["tmp_dirs"]
+ else:
+ tmp_dirs = ["/tmp", "/var/tmp", "/dev/shm"] # nosec: B108
+
+ if any(context.string_val.startswith(s) for s in tmp_dirs):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.INSECURE_TEMP_FILE,
+ text="Probable insecure usage of temp file/directory.",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/hashlib_insecure_functions.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/hashlib_insecure_functions.py
new file mode 100644
index 00000000..4b63de1e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/hashlib_insecure_functions.py
@@ -0,0 +1,121 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+======================================================================
+B324: Test use of insecure md4, md5, or sha1 hash functions in hashlib
+======================================================================
+
+This plugin checks for the usage of the insecure MD4, MD5, or SHA1 hash
+functions in ``hashlib`` and ``crypt``. The ``hashlib.new`` function provides
+the ability to construct a new hashing object using the named algorithm. This
+can be used to create insecure hash functions like MD4 and MD5 if they are
+passed as algorithm names to this function.
+
+This check does additional checking for usage of keyword usedforsecurity on all
+function variations of hashlib.
+
+Similar to ``hashlib``, this plugin also checks for usage of one of the
+``crypt`` module's weak hashes. ``crypt`` also permits MD5 among other weak
+hash variants.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B324:hashlib] Use of weak MD4, MD5, or SHA1 hash for
+ security. Consider usedforsecurity=False
+ Severity: High Confidence: High
+ CWE: CWE-327 (https://cwe.mitre.org/data/definitions/327.html)
+ Location: examples/hashlib_new_insecure_functions.py:3:0
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b324_hashlib.html
+ 2
+ 3 hashlib.new('md5')
+ 4
+
+.. seealso::
+
+ - https://cwe.mitre.org/data/definitions/327.html
+
+.. versionadded:: 1.5.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+.. versionchanged:: 1.7.6
+ Added check for the crypt module weak hashes
+
+""" # noqa: E501
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+WEAK_HASHES = ("md4", "md5", "sha", "sha1")
+WEAK_CRYPT_HASHES = ("METHOD_CRYPT", "METHOD_MD5", "METHOD_BLOWFISH")
+
+
+def _hashlib_func(context, func):
+ keywords = context.call_keywords
+
+ if func in WEAK_HASHES:
+ if keywords.get("usedforsecurity", "True") == "True":
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text=f"Use of weak {func.upper()} hash for security. "
+ "Consider usedforsecurity=False",
+ lineno=context.node.lineno,
+ )
+ elif func == "new":
+ args = context.call_args
+ name = args[0] if args else keywords.get("name", None)
+ if isinstance(name, str) and name.lower() in WEAK_HASHES:
+ if keywords.get("usedforsecurity", "True") == "True":
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text=f"Use of weak {name.upper()} hash for "
+ "security. Consider usedforsecurity=False",
+ lineno=context.node.lineno,
+ )
+
+
+def _crypt_crypt(context, func):
+ args = context.call_args
+ keywords = context.call_keywords
+
+ if func == "crypt":
+ name = args[1] if len(args) > 1 else keywords.get("salt", None)
+ if isinstance(name, str) and name in WEAK_CRYPT_HASHES:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text=f"Use of insecure crypt.{name.upper()} hash function.",
+ lineno=context.node.lineno,
+ )
+ elif func == "mksalt":
+ name = args[0] if args else keywords.get("method", None)
+ if isinstance(name, str) and name in WEAK_CRYPT_HASHES:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text=f"Use of insecure crypt.{name.upper()} hash function.",
+ lineno=context.node.lineno,
+ )
+
+
+@test.test_id("B324")
+@test.checks("Call")
+def hashlib(context):
+ if isinstance(context.call_function_name_qual, str):
+ qualname_list = context.call_function_name_qual.split(".")
+ func = qualname_list[-1]
+
+ if "hashlib" in qualname_list:
+ return _hashlib_func(context, func)
+
+ elif "crypt" in qualname_list and func in ("crypt", "mksalt"):
+ return _crypt_crypt(context, func)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/huggingface_unsafe_download.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/huggingface_unsafe_download.py
new file mode 100644
index 00000000..e51181a4
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/huggingface_unsafe_download.py
@@ -0,0 +1,153 @@
+# SPDX-License-Identifier: Apache-2.0
+r"""
+================================================
+B615: Test for unsafe Hugging Face Hub downloads
+================================================
+
+This plugin checks for unsafe downloads from Hugging Face Hub without proper
+integrity verification. Downloading models, datasets, or files without
+specifying a revision based on an immmutable revision (commit) can
+lead to supply chain attacks where malicious actors could
+replace model files and use an existing tag or branch name
+to serve malicious content.
+
+The secure approach is to:
+
+1. Pin to specific revisions/commits when downloading models, files or datasets
+
+Common unsafe patterns:
+- ``AutoModel.from_pretrained("org/model-name")``
+- ``AutoModel.from_pretrained("org/model-name", revision="main")``
+- ``AutoModel.from_pretrained("org/model-name", revision="v1.0.0")``
+- ``load_dataset("org/dataset-name")`` without revision
+- ``load_dataset("org/dataset-name", revision="main")``
+- ``load_dataset("org/dataset-name", revision="v1.0")``
+- ``AutoTokenizer.from_pretrained("org/model-name")``
+- ``AutoTokenizer.from_pretrained("org/model-name", revision="main")``
+- ``AutoTokenizer.from_pretrained("org/model-name", revision="v3.3.0")``
+- ``hf_hub_download(repo_id="org/model_name", filename="file_name")``
+- ``hf_hub_download(repo_id="org/model_name",
+ filename="file_name",
+ revision="main"
+ )``
+- ``hf_hub_download(repo_id="org/model_name",
+ filename="file_name",
+ revision="v2.0.0"
+ )``
+- ``snapshot_download(repo_id="org/model_name")``
+- ``snapshot_download(repo_id="org/model_name", revision="main")``
+- ``snapshot_download(repo_id="org/model_name", revision="refs/pr/1")``
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Unsafe Hugging Face Hub download without revision pinning
+ Severity: Medium Confidence: High
+ CWE: CWE-494 (https://cwe.mitre.org/data/definitions/494.html)
+ Location: examples/huggingface_unsafe_download.py:8
+ 7 # Unsafe: no revision specified
+ 8 model = AutoModel.from_pretrained("org/model_name")
+ 9
+
+.. seealso::
+
+ - https://cwe.mitre.org/data/definitions/494.html
+ - https://huggingface.co/docs/huggingface_hub/en/guides/download
+
+.. versionadded:: 1.8.6
+
+"""
+import string
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B615")
+def huggingface_unsafe_download(context):
+ """
+ This plugin checks for unsafe artifact download from Hugging Face Hub
+ without immutable/reproducible revision pinning.
+ """
+ # Check if any HuggingFace-related modules are imported
+ hf_modules = [
+ "transformers",
+ "datasets",
+ "huggingface_hub",
+ ]
+
+ # Check if any HF modules are imported
+ hf_imported = any(
+ context.is_module_imported_like(module) for module in hf_modules
+ )
+
+ if not hf_imported:
+ return
+
+ qualname = context.call_function_name_qual
+ if not isinstance(qualname, str):
+ return
+
+ unsafe_patterns = {
+ # transformers library patterns
+ "from_pretrained": ["transformers"],
+ # datasets library patterns
+ "load_dataset": ["datasets"],
+ # huggingface_hub patterns
+ "hf_hub_download": ["huggingface_hub"],
+ "snapshot_download": ["huggingface_hub"],
+ "repository_id": ["huggingface_hub"],
+ }
+
+ qualname_parts = qualname.split(".")
+ func_name = qualname_parts[-1]
+
+ if func_name not in unsafe_patterns:
+ return
+
+ required_modules = unsafe_patterns[func_name]
+ if not any(module in qualname_parts for module in required_modules):
+ return
+
+ # Check for revision parameter (the key security control)
+ revision_value = context.get_call_arg_value("revision")
+ commit_id_value = context.get_call_arg_value("commit_id")
+
+ # Check if a revision or commit_id is specified
+ revision_to_check = revision_value or commit_id_value
+
+ if revision_to_check is not None:
+ # Check if it's a secure revision (looks like a commit hash)
+ # Commit hashes: 40 chars (full SHA) or 7+ chars (short SHA)
+ if isinstance(revision_to_check, str):
+ # Remove quotes if present
+ revision_str = str(revision_to_check).strip("\"'")
+
+ # Check if it looks like a commit hash (hexadecimal string)
+ # Must be at least 7 characters and all hexadecimal
+ is_hex = all(c in string.hexdigits for c in revision_str)
+ if len(revision_str) >= 7 and is_hex:
+ # This looks like a commit hash, which is secure
+ return
+
+ # Edge case: check if this is a local path (starts with ./ or /)
+ first_arg = context.get_call_arg_at_position(0)
+ if first_arg and isinstance(first_arg, str):
+ if first_arg.startswith(("./", "/", "../")):
+ # Local paths are generally safer
+ return
+
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ text=(
+ f"Unsafe Hugging Face Hub download without revision pinning "
+ f"in {func_name}()"
+ ),
+ cwe=issue.Cwe.DOWNLOAD_OF_CODE_WITHOUT_INTEGRITY_CHECK,
+ lineno=context.get_lineno_for_call_arg(func_name),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_paramiko.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_paramiko.py
new file mode 100644
index 00000000..674fe0b9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_paramiko.py
@@ -0,0 +1,63 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==============================================
+B601: Test for shell injection within Paramiko
+==============================================
+
+Paramiko is a Python library designed to work with the SSH2 protocol for secure
+(encrypted and authenticated) connections to remote machines. It is intended to
+run commands on a remote host. These commands are run within a shell on the
+target and are thus vulnerable to various shell injection attacks. Bandit
+reports a MEDIUM issue when it detects the use of Paramiko's "exec_command"
+method advising the user to check inputs are correctly sanitized.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Possible shell injection via Paramiko call, check inputs are
+ properly sanitized.
+ Severity: Medium Confidence: Medium
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/paramiko_injection.py:4
+ 3 # this is not safe
+ 4 paramiko.exec_command('something; really; unsafe')
+ 5
+
+.. seealso::
+
+ - https://security.openstack.org
+ - https://github.com/paramiko/paramiko
+ - https://www.owasp.org/index.php/Command_Injection
+ - https://cwe.mitre.org/data/definitions/78.html
+
+.. versionadded:: 0.12.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B601")
+def paramiko_calls(context):
+ issue_text = (
+ "Possible shell injection via Paramiko call, check inputs "
+ "are properly sanitized."
+ )
+ for module in ["paramiko"]:
+ if context.is_module_imported_like(module):
+ if context.call_function_name in ["exec_command"]:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text=issue_text,
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_shell.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_shell.py
new file mode 100644
index 00000000..3c678ee1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_shell.py
@@ -0,0 +1,706 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import ast
+import re
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+# yuck, regex: starts with a windows drive letter (eg C:)
+# or one of our path delimeter characters (/, \, .)
+full_path_match = re.compile(r"^(?:[A-Za-z](?=\:)|[\\\/\.])")
+
+
+def _evaluate_shell_call(context):
+ no_formatting = isinstance(
+ context.node.args[0], ast.Constant
+ ) and isinstance(context.node.args[0].value, str)
+
+ if no_formatting:
+ return bandit.LOW
+ else:
+ return bandit.HIGH
+
+
+def gen_config(name):
+ if name == "shell_injection":
+ return {
+ # Start a process using the subprocess module, or one of its
+ # wrappers.
+ "subprocess": [
+ "subprocess.Popen",
+ "subprocess.call",
+ "subprocess.check_call",
+ "subprocess.check_output",
+ "subprocess.run",
+ ],
+ # Start a process with a function vulnerable to shell injection.
+ "shell": [
+ "os.system",
+ "os.popen",
+ "os.popen2",
+ "os.popen3",
+ "os.popen4",
+ "popen2.popen2",
+ "popen2.popen3",
+ "popen2.popen4",
+ "popen2.Popen3",
+ "popen2.Popen4",
+ "commands.getoutput",
+ "commands.getstatusoutput",
+ "subprocess.getoutput",
+ "subprocess.getstatusoutput",
+ ],
+ # Start a process with a function that is not vulnerable to shell
+ # injection.
+ "no_shell": [
+ "os.execl",
+ "os.execle",
+ "os.execlp",
+ "os.execlpe",
+ "os.execv",
+ "os.execve",
+ "os.execvp",
+ "os.execvpe",
+ "os.spawnl",
+ "os.spawnle",
+ "os.spawnlp",
+ "os.spawnlpe",
+ "os.spawnv",
+ "os.spawnve",
+ "os.spawnvp",
+ "os.spawnvpe",
+ "os.startfile",
+ ],
+ }
+
+
+def has_shell(context):
+ keywords = context.node.keywords
+ result = False
+ if "shell" in context.call_keywords:
+ for key in keywords:
+ if key.arg == "shell":
+ val = key.value
+ if isinstance(val, ast.Constant) and (
+ isinstance(val.value, int)
+ or isinstance(val.value, float)
+ or isinstance(val.value, complex)
+ ):
+ result = bool(val.value)
+ elif isinstance(val, ast.List):
+ result = bool(val.elts)
+ elif isinstance(val, ast.Dict):
+ result = bool(val.keys)
+ elif isinstance(val, ast.Name) and val.id in ["False", "None"]:
+ result = False
+ elif isinstance(val, ast.Constant):
+ result = val.value
+ else:
+ result = True
+ return result
+
+
+@test.takes_config("shell_injection")
+@test.checks("Call")
+@test.test_id("B602")
+def subprocess_popen_with_shell_equals_true(context, config):
+ """**B602: Test for use of popen with shell equals true**
+
+ Python possesses many mechanisms to invoke an external executable. However,
+ doing so may present a security issue if appropriate care is not taken to
+ sanitize any user provided or variable input.
+
+ This plugin test is part of a family of tests built to check for process
+ spawning and warn appropriately. Specifically, this test looks for the
+ spawning of a subprocess using a command shell. This type of subprocess
+ invocation is dangerous as it is vulnerable to various shell injection
+ attacks. Great care should be taken to sanitize all input in order to
+ mitigate this risk. Calls of this type are identified by a parameter of
+ 'shell=True' being given.
+
+ Additionally, this plugin scans the command string given and adjusts its
+ reported severity based on how it is presented. If the command string is a
+ simple static string containing no special shell characters, then the
+ resulting issue has low severity. If the string is static, but contains
+ shell formatting characters or wildcards, then the reported issue is
+ medium. Finally, if the string is computed using Python's string
+ manipulation or formatting operations, then the reported issue has high
+ severity. These severity levels reflect the likelihood that the code is
+ vulnerable to injection.
+
+ See also:
+
+ - :doc:`../plugins/linux_commands_wildcard_injection`
+ - :doc:`../plugins/subprocess_without_shell_equals_true`
+ - :doc:`../plugins/start_process_with_no_shell`
+ - :doc:`../plugins/start_process_with_a_shell`
+ - :doc:`../plugins/start_process_with_partial_path`
+
+ **Config Options:**
+
+ This plugin test shares a configuration with others in the same family,
+ namely `shell_injection`. This configuration is divided up into three
+ sections, `subprocess`, `shell` and `no_shell`. They each list Python calls
+ that spawn subprocesses, invoke commands within a shell, or invoke commands
+ without a shell (by replacing the calling process) respectively.
+
+ This plugin specifically scans for methods listed in `subprocess` section
+ that have shell=True specified.
+
+ .. code-block:: yaml
+
+ shell_injection:
+
+ # Start a process using the subprocess module, or one of its
+ wrappers.
+ subprocess:
+ - subprocess.Popen
+ - subprocess.call
+
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: subprocess call with shell=True seems safe, but may be
+ changed in the future, consider rewriting without shell
+ Severity: Low Confidence: High
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/subprocess_shell.py:21
+ 20 subprocess.check_call(['/bin/ls', '-l'], shell=False)
+ 21 subprocess.check_call('/bin/ls -l', shell=True)
+ 22
+
+ >> Issue: call with shell=True contains special shell characters,
+ consider moving extra logic into Python code
+ Severity: Medium Confidence: High
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/subprocess_shell.py:26
+ 25
+ 26 subprocess.Popen('/bin/ls *', shell=True)
+ 27 subprocess.Popen('/bin/ls %s' % ('something',), shell=True)
+
+ >> Issue: subprocess call with shell=True identified, security issue.
+ Severity: High Confidence: High
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/subprocess_shell.py:27
+ 26 subprocess.Popen('/bin/ls *', shell=True)
+ 27 subprocess.Popen('/bin/ls %s' % ('something',), shell=True)
+ 28 subprocess.Popen('/bin/ls {}'.format('something'), shell=True)
+
+ .. seealso::
+
+ - https://security.openstack.org
+ - https://docs.python.org/3/library/subprocess.html#frequently-used-arguments
+ - https://security.openstack.org/guidelines/dg_use-subprocess-securely.html
+ - https://security.openstack.org/guidelines/dg_avoid-shell-true.html
+ - https://cwe.mitre.org/data/definitions/78.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+ if config and context.call_function_name_qual in config["subprocess"]:
+ if has_shell(context):
+ if len(context.call_args) > 0:
+ sev = _evaluate_shell_call(context)
+ if sev == bandit.LOW:
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="subprocess call with shell=True seems safe, but "
+ "may be changed in the future, consider "
+ "rewriting without shell",
+ lineno=context.get_lineno_for_call_arg("shell"),
+ )
+ else:
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="subprocess call with shell=True identified, "
+ "security issue.",
+ lineno=context.get_lineno_for_call_arg("shell"),
+ )
+
+
+@test.takes_config("shell_injection")
+@test.checks("Call")
+@test.test_id("B603")
+def subprocess_without_shell_equals_true(context, config):
+ """**B603: Test for use of subprocess without shell equals true**
+
+ Python possesses many mechanisms to invoke an external executable. However,
+ doing so may present a security issue if appropriate care is not taken to
+ sanitize any user provided or variable input.
+
+ This plugin test is part of a family of tests built to check for process
+ spawning and warn appropriately. Specifically, this test looks for the
+ spawning of a subprocess without the use of a command shell. This type of
+ subprocess invocation is not vulnerable to shell injection attacks, but
+ care should still be taken to ensure validity of input.
+
+ Because this is a lesser issue than that described in
+ `subprocess_popen_with_shell_equals_true` a LOW severity warning is
+ reported.
+
+ See also:
+
+ - :doc:`../plugins/linux_commands_wildcard_injection`
+ - :doc:`../plugins/subprocess_popen_with_shell_equals_true`
+ - :doc:`../plugins/start_process_with_no_shell`
+ - :doc:`../plugins/start_process_with_a_shell`
+ - :doc:`../plugins/start_process_with_partial_path`
+
+ **Config Options:**
+
+ This plugin test shares a configuration with others in the same family,
+ namely `shell_injection`. This configuration is divided up into three
+ sections, `subprocess`, `shell` and `no_shell`. They each list Python calls
+ that spawn subprocesses, invoke commands within a shell, or invoke commands
+ without a shell (by replacing the calling process) respectively.
+
+ This plugin specifically scans for methods listed in `subprocess` section
+ that have shell=False specified.
+
+ .. code-block:: yaml
+
+ shell_injection:
+ # Start a process using the subprocess module, or one of its
+ wrappers.
+ subprocess:
+ - subprocess.Popen
+ - subprocess.call
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: subprocess call - check for execution of untrusted input.
+ Severity: Low Confidence: High
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/subprocess_shell.py:23
+ 22
+ 23 subprocess.check_output(['/bin/ls', '-l'])
+ 24
+
+ .. seealso::
+
+ - https://security.openstack.org
+ - https://docs.python.org/3/library/subprocess.html#frequently-used-arguments
+ - https://security.openstack.org/guidelines/dg_avoid-shell-true.html
+ - https://security.openstack.org/guidelines/dg_use-subprocess-securely.html
+ - https://cwe.mitre.org/data/definitions/78.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+ if config and context.call_function_name_qual in config["subprocess"]:
+ if not has_shell(context):
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="subprocess call - check for execution of untrusted "
+ "input.",
+ lineno=context.get_lineno_for_call_arg("shell"),
+ )
+
+
+@test.takes_config("shell_injection")
+@test.checks("Call")
+@test.test_id("B604")
+def any_other_function_with_shell_equals_true(context, config):
+ """**B604: Test for any function with shell equals true**
+
+ Python possesses many mechanisms to invoke an external executable. However,
+ doing so may present a security issue if appropriate care is not taken to
+ sanitize any user provided or variable input.
+
+ This plugin test is part of a family of tests built to check for process
+ spawning and warn appropriately. Specifically, this plugin test
+ interrogates method calls for the presence of a keyword parameter `shell`
+ equalling true. It is related to detection of shell injection issues and is
+ intended to catch custom wrappers to vulnerable methods that may have been
+ created.
+
+ See also:
+
+ - :doc:`../plugins/linux_commands_wildcard_injection`
+ - :doc:`../plugins/subprocess_popen_with_shell_equals_true`
+ - :doc:`../plugins/subprocess_without_shell_equals_true`
+ - :doc:`../plugins/start_process_with_no_shell`
+ - :doc:`../plugins/start_process_with_a_shell`
+ - :doc:`../plugins/start_process_with_partial_path`
+
+ **Config Options:**
+
+ This plugin test shares a configuration with others in the same family,
+ namely `shell_injection`. This configuration is divided up into three
+ sections, `subprocess`, `shell` and `no_shell`. They each list Python calls
+ that spawn subprocesses, invoke commands within a shell, or invoke commands
+ without a shell (by replacing the calling process) respectively.
+
+ Specifically, this plugin excludes those functions listed under the
+ subprocess section, these methods are tested in a separate specific test
+ plugin and this exclusion prevents duplicate issue reporting.
+
+ .. code-block:: yaml
+
+ shell_injection:
+ # Start a process using the subprocess module, or one of its
+ wrappers.
+ subprocess: [subprocess.Popen, subprocess.call,
+ subprocess.check_call, subprocess.check_output
+ execute_with_timeout]
+
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: Function call with shell=True parameter identified, possible
+ security issue.
+ Severity: Medium Confidence: High
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/subprocess_shell.py:9
+ 8 pop('/bin/gcc --version', shell=True)
+ 9 Popen('/bin/gcc --version', shell=True)
+ 10
+
+ .. seealso::
+
+ - https://security.openstack.org/guidelines/dg_avoid-shell-true.html
+ - https://security.openstack.org/guidelines/dg_use-subprocess-securely.html
+ - https://cwe.mitre.org/data/definitions/78.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+ if config and context.call_function_name_qual not in config["subprocess"]:
+ if has_shell(context):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.LOW,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="Function call with shell=True parameter identified, "
+ "possible security issue.",
+ lineno=context.get_lineno_for_call_arg("shell"),
+ )
+
+
+@test.takes_config("shell_injection")
+@test.checks("Call")
+@test.test_id("B605")
+def start_process_with_a_shell(context, config):
+ """**B605: Test for starting a process with a shell**
+
+ Python possesses many mechanisms to invoke an external executable. However,
+ doing so may present a security issue if appropriate care is not taken to
+ sanitize any user provided or variable input.
+
+ This plugin test is part of a family of tests built to check for process
+ spawning and warn appropriately. Specifically, this test looks for the
+ spawning of a subprocess using a command shell. This type of subprocess
+ invocation is dangerous as it is vulnerable to various shell injection
+ attacks. Great care should be taken to sanitize all input in order to
+ mitigate this risk. Calls of this type are identified by the use of certain
+ commands which are known to use shells. Bandit will report a LOW
+ severity warning.
+
+ See also:
+
+ - :doc:`../plugins/linux_commands_wildcard_injection`
+ - :doc:`../plugins/subprocess_without_shell_equals_true`
+ - :doc:`../plugins/start_process_with_no_shell`
+ - :doc:`../plugins/start_process_with_partial_path`
+ - :doc:`../plugins/subprocess_popen_with_shell_equals_true`
+
+ **Config Options:**
+
+ This plugin test shares a configuration with others in the same family,
+ namely `shell_injection`. This configuration is divided up into three
+ sections, `subprocess`, `shell` and `no_shell`. They each list Python calls
+ that spawn subprocesses, invoke commands within a shell, or invoke commands
+ without a shell (by replacing the calling process) respectively.
+
+ This plugin specifically scans for methods listed in `shell` section.
+
+ .. code-block:: yaml
+
+ shell_injection:
+ shell:
+ - os.system
+ - os.popen
+ - os.popen2
+ - os.popen3
+ - os.popen4
+ - popen2.popen2
+ - popen2.popen3
+ - popen2.popen4
+ - popen2.Popen3
+ - popen2.Popen4
+ - commands.getoutput
+ - commands.getstatusoutput
+ - subprocess.getoutput
+ - subprocess.getstatusoutput
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: Starting a process with a shell: check for injection.
+ Severity: Low Confidence: Medium
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: examples/os_system.py:3
+ 2
+ 3 os.system('/bin/echo hi')
+
+ .. seealso::
+
+ - https://security.openstack.org
+ - https://docs.python.org/3/library/os.html#os.system
+ - https://docs.python.org/3/library/subprocess.html#frequently-used-arguments
+ - https://security.openstack.org/guidelines/dg_use-subprocess-securely.html
+ - https://cwe.mitre.org/data/definitions/78.html
+
+ .. versionadded:: 0.10.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+ if config and context.call_function_name_qual in config["shell"]:
+ if len(context.call_args) > 0:
+ sev = _evaluate_shell_call(context)
+ if sev == bandit.LOW:
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="Starting a process with a shell: "
+ "Seems safe, but may be changed in the future, "
+ "consider rewriting without shell",
+ )
+ else:
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="Starting a process with a shell, possible injection"
+ " detected, security issue.",
+ )
+
+
+@test.takes_config("shell_injection")
+@test.checks("Call")
+@test.test_id("B606")
+def start_process_with_no_shell(context, config):
+ """**B606: Test for starting a process with no shell**
+
+ Python possesses many mechanisms to invoke an external executable. However,
+ doing so may present a security issue if appropriate care is not taken to
+ sanitize any user provided or variable input.
+
+ This plugin test is part of a family of tests built to check for process
+ spawning and warn appropriately. Specifically, this test looks for the
+ spawning of a subprocess in a way that doesn't use a shell. Although this
+ is generally safe, it maybe useful for penetration testing workflows to
+ track where external system calls are used. As such a LOW severity message
+ is generated.
+
+ See also:
+
+ - :doc:`../plugins/linux_commands_wildcard_injection`
+ - :doc:`../plugins/subprocess_without_shell_equals_true`
+ - :doc:`../plugins/start_process_with_a_shell`
+ - :doc:`../plugins/start_process_with_partial_path`
+ - :doc:`../plugins/subprocess_popen_with_shell_equals_true`
+
+ **Config Options:**
+
+ This plugin test shares a configuration with others in the same family,
+ namely `shell_injection`. This configuration is divided up into three
+ sections, `subprocess`, `shell` and `no_shell`. They each list Python calls
+ that spawn subprocesses, invoke commands within a shell, or invoke commands
+ without a shell (by replacing the calling process) respectively.
+
+ This plugin specifically scans for methods listed in `no_shell` section.
+
+ .. code-block:: yaml
+
+ shell_injection:
+ no_shell:
+ - os.execl
+ - os.execle
+ - os.execlp
+ - os.execlpe
+ - os.execv
+ - os.execve
+ - os.execvp
+ - os.execvpe
+ - os.spawnl
+ - os.spawnle
+ - os.spawnlp
+ - os.spawnlpe
+ - os.spawnv
+ - os.spawnve
+ - os.spawnvp
+ - os.spawnvpe
+ - os.startfile
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [start_process_with_no_shell] Starting a process without a
+ shell.
+ Severity: Low Confidence: Medium
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: examples/os-spawn.py:8
+ 7 os.spawnv(mode, path, args)
+ 8 os.spawnve(mode, path, args, env)
+ 9 os.spawnvp(mode, file, args)
+
+ .. seealso::
+
+ - https://security.openstack.org
+ - https://docs.python.org/3/library/os.html#os.system
+ - https://docs.python.org/3/library/subprocess.html#frequently-used-arguments
+ - https://security.openstack.org/guidelines/dg_use-subprocess-securely.html
+ - https://cwe.mitre.org/data/definitions/78.html
+
+ .. versionadded:: 0.10.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+
+ if config and context.call_function_name_qual in config["no_shell"]:
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="Starting a process without a shell.",
+ )
+
+
+@test.takes_config("shell_injection")
+@test.checks("Call")
+@test.test_id("B607")
+def start_process_with_partial_path(context, config):
+ """**B607: Test for starting a process with a partial path**
+
+ Python possesses many mechanisms to invoke an external executable. If the
+ desired executable path is not fully qualified relative to the filesystem
+ root then this may present a potential security risk.
+
+ In POSIX environments, the `PATH` environment variable is used to specify a
+ set of standard locations that will be searched for the first matching
+ named executable. While convenient, this behavior may allow a malicious
+ actor to exert control over a system. If they are able to adjust the
+ contents of the `PATH` variable, or manipulate the file system, then a
+ bogus executable may be discovered in place of the desired one. This
+ executable will be invoked with the user privileges of the Python process
+ that spawned it, potentially a highly privileged user.
+
+ This test will scan the parameters of all configured Python methods,
+ looking for paths that do not start at the filesystem root, that is, do not
+ have a leading '/' character.
+
+ **Config Options:**
+
+ This plugin test shares a configuration with others in the same family,
+ namely `shell_injection`. This configuration is divided up into three
+ sections, `subprocess`, `shell` and `no_shell`. They each list Python calls
+ that spawn subprocesses, invoke commands within a shell, or invoke commands
+ without a shell (by replacing the calling process) respectively.
+
+ This test will scan parameters of all methods in all sections. Note that
+ methods are fully qualified and de-aliased prior to checking.
+
+ .. code-block:: yaml
+
+ shell_injection:
+ # Start a process using the subprocess module, or one of its
+ wrappers.
+ subprocess:
+ - subprocess.Popen
+ - subprocess.call
+
+ # Start a process with a function vulnerable to shell injection.
+ shell:
+ - os.system
+ - os.popen
+ - popen2.Popen3
+ - popen2.Popen4
+ - commands.getoutput
+ - commands.getstatusoutput
+ # Start a process with a function that is not vulnerable to shell
+ injection.
+ no_shell:
+ - os.execl
+ - os.execle
+
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: Starting a process with a partial executable path
+ Severity: Low Confidence: High
+ CWE: CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/partial_path_process.py:3
+ 2 from subprocess import Popen as pop
+ 3 pop('gcc --version', shell=False)
+
+ .. seealso::
+
+ - https://security.openstack.org
+ - https://docs.python.org/3/library/os.html#process-management
+ - https://cwe.mitre.org/data/definitions/78.html
+
+ .. versionadded:: 0.13.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """
+
+ if config and len(context.call_args):
+ if (
+ context.call_function_name_qual in config["subprocess"]
+ or context.call_function_name_qual in config["shell"]
+ or context.call_function_name_qual in config["no_shell"]
+ ):
+ node = context.node.args[0]
+ # some calls take an arg list, check the first part
+ if isinstance(node, ast.List) and node.elts:
+ node = node.elts[0]
+
+ # make sure the param is a string literal and not a var name
+ if (
+ isinstance(node, ast.Constant)
+ and isinstance(node.value, str)
+ and not full_path_match.match(node.value)
+ ):
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.OS_COMMAND_INJECTION,
+ text="Starting a process with a partial executable path",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_sql.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_sql.py
new file mode 100644
index 00000000..c4054a6a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_sql.py
@@ -0,0 +1,143 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+============================
+B608: Test for SQL injection
+============================
+
+An SQL injection attack consists of insertion or "injection" of a SQL query via
+the input data given to an application. It is a very common attack vector. This
+plugin test looks for strings that resemble SQL statements that are involved in
+some form of string building operation. For example:
+
+ - "SELECT %s FROM derp;" % var
+ - "SELECT thing FROM " + tab
+ - "SELECT " + val + " FROM " + tab + ...
+ - "SELECT {} FROM derp;".format(var)
+ - f"SELECT foo FROM bar WHERE id = {product}"
+
+Unless care is taken to sanitize and control the input data when building such
+SQL statement strings, an injection attack becomes possible. If strings of this
+nature are discovered, a LOW confidence issue is reported. In order to boost
+result confidence, this plugin test will also check to see if the discovered
+string is in use with standard Python DBAPI calls `execute` or `executemany`.
+If so, a MEDIUM issue is reported. For example:
+
+ - cursor.execute("SELECT %s FROM derp;" % var)
+
+Use of str.replace in the string construction can also be dangerous.
+For example:
+
+- "SELECT * FROM foo WHERE id = '[VALUE]'".replace("[VALUE]", identifier)
+
+However, such cases are always reported with LOW confidence to compensate
+for false positives, since valid uses of str.replace can be common.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Possible SQL injection vector through string-based query
+ construction.
+ Severity: Medium Confidence: Low
+ CWE: CWE-89 (https://cwe.mitre.org/data/definitions/89.html)
+ Location: ./examples/sql_statements.py:4
+ 3 query = "DELETE FROM foo WHERE id = '%s'" % identifier
+ 4 query = "UPDATE foo SET value = 'b' WHERE id = '%s'" % identifier
+ 5
+
+.. seealso::
+
+ - https://www.owasp.org/index.php/SQL_Injection
+ - https://security.openstack.org/guidelines/dg_parameterize-database-queries.html
+ - https://cwe.mitre.org/data/definitions/89.html
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+.. versionchanged:: 1.7.7
+ Flag when str.replace is used in the string construction
+
+""" # noqa: E501
+import ast
+import re
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+from bandit.core import utils
+
+SIMPLE_SQL_RE = re.compile(
+ r"(select\s.*from\s|"
+ r"delete\s+from\s|"
+ r"insert\s+into\s.*values\s|"
+ r"update\s.*set\s)",
+ re.IGNORECASE | re.DOTALL,
+)
+
+
+def _check_string(data):
+ return SIMPLE_SQL_RE.search(data) is not None
+
+
+def _evaluate_ast(node):
+ wrapper = None
+ statement = ""
+ str_replace = False
+
+ if isinstance(node._bandit_parent, ast.BinOp):
+ out = utils.concat_string(node, node._bandit_parent)
+ wrapper = out[0]._bandit_parent
+ statement = out[1]
+ elif isinstance(
+ node._bandit_parent, ast.Attribute
+ ) and node._bandit_parent.attr in ("format", "replace"):
+ statement = node.value
+ # Hierarchy for "".format() is Wrapper -> Call -> Attribute -> Str
+ wrapper = node._bandit_parent._bandit_parent._bandit_parent
+ if node._bandit_parent.attr == "replace":
+ str_replace = True
+ elif hasattr(ast, "JoinedStr") and isinstance(
+ node._bandit_parent, ast.JoinedStr
+ ):
+ substrings = [
+ child
+ for child in node._bandit_parent.values
+ if isinstance(child, ast.Constant) and isinstance(child.value, str)
+ ]
+ # JoinedStr consists of list of Constant and FormattedValue
+ # instances. Let's perform one test for the whole string
+ # and abandon all parts except the first one to raise one
+ # failed test instead of many for the same SQL statement.
+ if substrings and node == substrings[0]:
+ statement = "".join([str(child.value) for child in substrings])
+ wrapper = node._bandit_parent._bandit_parent
+
+ if isinstance(wrapper, ast.Call): # wrapped in "execute" call?
+ names = ["execute", "executemany"]
+ name = utils.get_called_name(wrapper)
+ return (name in names, statement, str_replace)
+ else:
+ return (False, statement, str_replace)
+
+
+@test.checks("Str")
+@test.test_id("B608")
+def hardcoded_sql_expressions(context):
+ execute_call, statement, str_replace = _evaluate_ast(context.node)
+ if _check_string(statement):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=(
+ bandit.MEDIUM
+ if execute_call and not str_replace
+ else bandit.LOW
+ ),
+ cwe=issue.Cwe.SQL_INJECTION,
+ text="Possible SQL injection vector through string-based "
+ "query construction.",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_wildcard.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_wildcard.py
new file mode 100644
index 00000000..46f6b5b6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/injection_wildcard.py
@@ -0,0 +1,144 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+========================================
+B609: Test for use of wildcard injection
+========================================
+
+Python provides a number of methods that emulate the behavior of standard Linux
+command line utilities. Like their Linux counterparts, these commands may take
+a wildcard "\*" character in place of a file system path. This is interpreted
+to mean "any and all files or folders" and can be used to build partially
+qualified paths, such as "/home/user/\*".
+
+The use of partially qualified paths may result in unintended consequences if
+an unexpected file or symlink is placed into the path location given. This
+becomes particularly dangerous when combined with commands used to manipulate
+file permissions or copy data off of a system.
+
+This test plugin looks for usage of the following commands in conjunction with
+wild card parameters:
+
+- 'chown'
+- 'chmod'
+- 'tar'
+- 'rsync'
+
+As well as any method configured in the shell or subprocess injection test
+configurations.
+
+
+**Config Options:**
+
+This plugin test shares a configuration with others in the same family, namely
+`shell_injection`. This configuration is divided up into three sections,
+`subprocess`, `shell` and `no_shell`. They each list Python calls that spawn
+subprocesses, invoke commands within a shell, or invoke commands without a
+shell (by replacing the calling process) respectively.
+
+This test will scan parameters of all methods in all sections. Note that
+methods are fully qualified and de-aliased prior to checking.
+
+
+.. code-block:: yaml
+
+ shell_injection:
+ # Start a process using the subprocess module, or one of its wrappers.
+ subprocess:
+ - subprocess.Popen
+ - subprocess.call
+
+ # Start a process with a function vulnerable to shell injection.
+ shell:
+ - os.system
+ - os.popen
+ - popen2.Popen3
+ - popen2.Popen4
+ - commands.getoutput
+ - commands.getstatusoutput
+ # Start a process with a function that is not vulnerable to shell
+ injection.
+ no_shell:
+ - os.execl
+ - os.execle
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Possible wildcard injection in call: subprocess.Popen
+ Severity: High Confidence: Medium
+ CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/wildcard-injection.py:8
+ 7 o.popen2('/bin/chmod *')
+ 8 subp.Popen('/bin/chown *', shell=True)
+ 9
+
+ >> Issue: subprocess call - check for execution of untrusted input.
+ Severity: Low Confidence: High
+ CWE-78 (https://cwe.mitre.org/data/definitions/78.html)
+ Location: ./examples/wildcard-injection.py:11
+ 10 # Not vulnerable to wildcard injection
+ 11 subp.Popen('/bin/rsync *')
+ 12 subp.Popen("/bin/chmod *")
+
+
+.. seealso::
+
+ - https://security.openstack.org
+ - https://en.wikipedia.org/wiki/Wildcard_character
+ - https://www.defensecode.com/public/DefenseCode_Unix_WildCards_Gone_Wild.txt
+ - https://cwe.mitre.org/data/definitions/78.html
+
+.. versionadded:: 0.9.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+from bandit.plugins import injection_shell # NOTE(tkelsey): shared config
+
+gen_config = injection_shell.gen_config
+
+
+@test.takes_config("shell_injection")
+@test.checks("Call")
+@test.test_id("B609")
+def linux_commands_wildcard_injection(context, config):
+ if not ("shell" in config and "subprocess" in config):
+ return
+
+ vulnerable_funcs = ["chown", "chmod", "tar", "rsync"]
+ if context.call_function_name_qual in config["shell"] or (
+ context.call_function_name_qual in config["subprocess"]
+ and context.check_call_arg_value("shell", "True")
+ ):
+ if context.call_args_count >= 1:
+ call_argument = context.get_call_arg_at_position(0)
+ argument_string = ""
+ if isinstance(call_argument, list):
+ for li in call_argument:
+ argument_string += f" {li}"
+ elif isinstance(call_argument, str):
+ argument_string = call_argument
+
+ if argument_string != "":
+ for vulnerable_func in vulnerable_funcs:
+ if (
+ vulnerable_func in argument_string
+ and "*" in argument_string
+ ):
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.IMPROPER_WILDCARD_NEUTRALIZATION,
+ text="Possible wildcard injection in call: %s"
+ % context.call_function_name_qual,
+ lineno=context.get_lineno_for_call_arg("shell"),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/insecure_ssl_tls.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/insecure_ssl_tls.py
new file mode 100644
index 00000000..319abcf1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/insecure_ssl_tls.py
@@ -0,0 +1,285 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def get_bad_proto_versions(config):
+ return config["bad_protocol_versions"]
+
+
+def gen_config(name):
+ if name == "ssl_with_bad_version":
+ return {
+ "bad_protocol_versions": [
+ "PROTOCOL_SSLv2",
+ "SSLv2_METHOD",
+ "SSLv23_METHOD",
+ "PROTOCOL_SSLv3", # strict option
+ "PROTOCOL_TLSv1", # strict option
+ "SSLv3_METHOD", # strict option
+ "TLSv1_METHOD",
+ "PROTOCOL_TLSv1_1",
+ "TLSv1_1_METHOD",
+ ]
+ } # strict option
+
+
+@test.takes_config
+@test.checks("Call")
+@test.test_id("B502")
+def ssl_with_bad_version(context, config):
+ """**B502: Test for SSL use with bad version used**
+
+ Several highly publicized exploitable flaws have been discovered
+ in all versions of SSL and early versions of TLS. It is strongly
+ recommended that use of the following known broken protocol versions be
+ avoided:
+
+ - SSL v2
+ - SSL v3
+ - TLS v1
+ - TLS v1.1
+
+ This plugin test scans for calls to Python methods with parameters that
+ indicate the used broken SSL/TLS protocol versions. Currently, detection
+ supports methods using Python's native SSL/TLS support and the pyOpenSSL
+ module. A HIGH severity warning will be reported whenever known broken
+ protocol versions are detected.
+
+ It is worth noting that native support for TLS 1.2 is only available in
+ more recent Python versions, specifically 2.7.9 and up, and 3.x
+
+ A note on 'SSLv23':
+
+ Amongst the available SSL/TLS versions provided by Python/pyOpenSSL there
+ exists the option to use SSLv23. This very poorly named option actually
+ means "use the highest version of SSL/TLS supported by both the server and
+ client". This may (and should be) a version well in advance of SSL v2 or
+ v3. Bandit can scan for the use of SSLv23 if desired, but its detection
+ does not necessarily indicate a problem.
+
+ When using SSLv23 it is important to also provide flags to explicitly
+ exclude bad versions of SSL/TLS from the protocol versions considered. Both
+ the Python native and pyOpenSSL modules provide the ``OP_NO_SSLv2`` and
+ ``OP_NO_SSLv3`` flags for this purpose.
+
+ **Config Options:**
+
+ .. code-block:: yaml
+
+ ssl_with_bad_version:
+ bad_protocol_versions:
+ - PROTOCOL_SSLv2
+ - SSLv2_METHOD
+ - SSLv23_METHOD
+ - PROTOCOL_SSLv3 # strict option
+ - PROTOCOL_TLSv1 # strict option
+ - SSLv3_METHOD # strict option
+ - TLSv1_METHOD # strict option
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: ssl.wrap_socket call with insecure SSL/TLS protocol version
+ identified, security issue.
+ Severity: High Confidence: High
+ CWE: CWE-327 (https://cwe.mitre.org/data/definitions/327.html)
+ Location: ./examples/ssl-insecure-version.py:13
+ 12 # strict tests
+ 13 ssl.wrap_socket(ssl_version=ssl.PROTOCOL_SSLv3)
+ 14 ssl.wrap_socket(ssl_version=ssl.PROTOCOL_TLSv1)
+
+ .. seealso::
+
+ - :func:`ssl_with_bad_defaults`
+ - :func:`ssl_with_no_version`
+ - https://heartbleed.com/
+ - https://en.wikipedia.org/wiki/POODLE
+ - https://security.openstack.org/guidelines/dg_move-data-securely.html
+ - https://cwe.mitre.org/data/definitions/327.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ .. versionchanged:: 1.7.5
+ Added TLS 1.1
+
+ """
+ bad_ssl_versions = get_bad_proto_versions(config)
+ if context.call_function_name_qual == "ssl.wrap_socket":
+ if context.check_call_arg_value("ssl_version", bad_ssl_versions):
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text="ssl.wrap_socket call with insecure SSL/TLS protocol "
+ "version identified, security issue.",
+ lineno=context.get_lineno_for_call_arg("ssl_version"),
+ )
+ elif context.call_function_name_qual == "pyOpenSSL.SSL.Context":
+ if context.check_call_arg_value("method", bad_ssl_versions):
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text="SSL.Context call with insecure SSL/TLS protocol "
+ "version identified, security issue.",
+ lineno=context.get_lineno_for_call_arg("method"),
+ )
+
+ elif (
+ context.call_function_name_qual != "ssl.wrap_socket"
+ and context.call_function_name_qual != "pyOpenSSL.SSL.Context"
+ ):
+ if context.check_call_arg_value(
+ "method", bad_ssl_versions
+ ) or context.check_call_arg_value("ssl_version", bad_ssl_versions):
+ lineno = context.get_lineno_for_call_arg(
+ "method"
+ ) or context.get_lineno_for_call_arg("ssl_version")
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text="Function call with insecure SSL/TLS protocol "
+ "identified, possible security issue.",
+ lineno=lineno,
+ )
+
+
+@test.takes_config("ssl_with_bad_version")
+@test.checks("FunctionDef")
+@test.test_id("B503")
+def ssl_with_bad_defaults(context, config):
+ """**B503: Test for SSL use with bad defaults specified**
+
+ This plugin is part of a family of tests that detect the use of known bad
+ versions of SSL/TLS, please see :doc:`../plugins/ssl_with_bad_version` for
+ a complete discussion. Specifically, this plugin test scans for Python
+ methods with default parameter values that specify the use of broken
+ SSL/TLS protocol versions. Currently, detection supports methods using
+ Python's native SSL/TLS support and the pyOpenSSL module. A MEDIUM severity
+ warning will be reported whenever known broken protocol versions are
+ detected.
+
+ **Config Options:**
+
+ This test shares the configuration provided for the standard
+ :doc:`../plugins/ssl_with_bad_version` test, please refer to its
+ documentation.
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: Function definition identified with insecure SSL/TLS protocol
+ version by default, possible security issue.
+ Severity: Medium Confidence: Medium
+ CWE: CWE-327 (https://cwe.mitre.org/data/definitions/327.html)
+ Location: ./examples/ssl-insecure-version.py:28
+ 27
+ 28 def open_ssl_socket(version=SSL.SSLv2_METHOD):
+ 29 pass
+
+ .. seealso::
+
+ - :func:`ssl_with_bad_version`
+ - :func:`ssl_with_no_version`
+ - https://heartbleed.com/
+ - https://en.wikipedia.org/wiki/POODLE
+ - https://security.openstack.org/guidelines/dg_move-data-securely.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ .. versionchanged:: 1.7.5
+ Added TLS 1.1
+
+ """
+
+ bad_ssl_versions = get_bad_proto_versions(config)
+ for default in context.function_def_defaults_qual:
+ val = default.split(".")[-1]
+ if val in bad_ssl_versions:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text="Function definition identified with insecure SSL/TLS "
+ "protocol version by default, possible security "
+ "issue.",
+ )
+
+
+@test.checks("Call")
+@test.test_id("B504")
+def ssl_with_no_version(context):
+ """**B504: Test for SSL use with no version specified**
+
+ This plugin is part of a family of tests that detect the use of known bad
+ versions of SSL/TLS, please see :doc:`../plugins/ssl_with_bad_version` for
+ a complete discussion. Specifically, This plugin test scans for specific
+ methods in Python's native SSL/TLS support and the pyOpenSSL module that
+ configure the version of SSL/TLS protocol to use. These methods are known
+ to provide default value that maximize compatibility, but permit use of the
+ aforementioned broken protocol versions. A LOW severity warning will be
+ reported whenever this is detected.
+
+ **Config Options:**
+
+ This test shares the configuration provided for the standard
+ :doc:`../plugins/ssl_with_bad_version` test, please refer to its
+ documentation.
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: ssl.wrap_socket call with no SSL/TLS protocol version
+ specified, the default SSLv23 could be insecure, possible security
+ issue.
+ Severity: Low Confidence: Medium
+ CWE: CWE-327 (https://cwe.mitre.org/data/definitions/327.html)
+ Location: ./examples/ssl-insecure-version.py:23
+ 22
+ 23 ssl.wrap_socket()
+ 24
+
+ .. seealso::
+
+ - :func:`ssl_with_bad_version`
+ - :func:`ssl_with_bad_defaults`
+ - https://heartbleed.com/
+ - https://en.wikipedia.org/wiki/POODLE
+ - https://security.openstack.org/guidelines/dg_move-data-securely.html
+
+ .. versionadded:: 0.9.0
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """
+ if context.call_function_name_qual == "ssl.wrap_socket":
+ if context.check_call_arg_value("ssl_version") is None:
+ # check_call_arg_value() returns False if the argument is found
+ # but does not match the supplied value (or the default None).
+ # It returns None if the arg_name passed doesn't exist. This
+ # tests for that (ssl_version is not specified).
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.BROKEN_CRYPTO,
+ text="ssl.wrap_socket call with no SSL/TLS protocol version "
+ "specified, the default SSLv23 could be insecure, "
+ "possible security issue.",
+ lineno=context.get_lineno_for_call_arg("ssl_version"),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/jinja2_templates.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/jinja2_templates.py
new file mode 100644
index 00000000..3374205f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/jinja2_templates.py
@@ -0,0 +1,134 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==========================================
+B701: Test for not auto escaping in jinja2
+==========================================
+
+Jinja2 is a Python HTML templating system. It is typically used to build web
+applications, though appears in other places well, notably the Ansible
+automation system. When configuring the Jinja2 environment, the option to use
+autoescaping on input can be specified. When autoescaping is enabled, Jinja2
+will filter input strings to escape any HTML content submitted via template
+variables. Without escaping HTML input the application becomes vulnerable to
+Cross Site Scripting (XSS) attacks.
+
+Unfortunately, autoescaping is False by default. Thus this plugin test will
+warn on omission of an autoescape setting, as well as an explicit setting of
+false. A HIGH severity warning is generated in either of these scenarios.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Using jinja2 templates with autoescape=False is dangerous and can
+ lead to XSS. Use autoescape=True to mitigate XSS vulnerabilities.
+ Severity: High Confidence: High
+ CWE: CWE-94 (https://cwe.mitre.org/data/definitions/94.html)
+ Location: ./examples/jinja2_templating.py:11
+ 10 templateEnv = jinja2.Environment(autoescape=False,
+ loader=templateLoader)
+ 11 Environment(loader=templateLoader,
+ 12 load=templateLoader,
+ 13 autoescape=False)
+ 14
+
+ >> Issue: By default, jinja2 sets autoescape to False. Consider using
+ autoescape=True or use the select_autoescape function to mitigate XSS
+ vulnerabilities.
+ Severity: High Confidence: High
+ CWE: CWE-94 (https://cwe.mitre.org/data/definitions/94.html)
+ Location: ./examples/jinja2_templating.py:15
+ 14
+ 15 Environment(loader=templateLoader,
+ 16 load=templateLoader)
+ 17
+ 18 Environment(autoescape=select_autoescape(['html', 'htm', 'xml']),
+ 19 loader=templateLoader)
+
+
+.. seealso::
+
+ - `OWASP XSS `__
+ - https://realpython.com/primer-on-jinja-templating/
+ - https://jinja.palletsprojects.com/en/2.11.x/api/#autoescaping
+ - https://security.openstack.org/guidelines/dg_cross-site-scripting-xss.html
+ - https://cwe.mitre.org/data/definitions/94.html
+
+.. versionadded:: 0.10.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B701")
+def jinja2_autoescape_false(context):
+ # check type just to be safe
+ if isinstance(context.call_function_name_qual, str):
+ qualname_list = context.call_function_name_qual.split(".")
+ func = qualname_list[-1]
+ if "jinja2" in qualname_list and func == "Environment":
+ for node in ast.walk(context.node):
+ if isinstance(node, ast.keyword):
+ # definite autoescape = False
+ if getattr(node, "arg", None) == "autoescape" and (
+ getattr(node.value, "id", None) == "False"
+ or getattr(node.value, "value", None) is False
+ ):
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.CODE_INJECTION,
+ text="Using jinja2 templates with autoescape="
+ "False is dangerous and can lead to XSS. "
+ "Use autoescape=True or use the "
+ "select_autoescape function to mitigate XSS "
+ "vulnerabilities.",
+ )
+ # found autoescape
+ if getattr(node, "arg", None) == "autoescape":
+ value = getattr(node, "value", None)
+ if (
+ getattr(value, "id", None) == "True"
+ or getattr(value, "value", None) is True
+ ):
+ return
+ # Check if select_autoescape function is used.
+ elif isinstance(value, ast.Call) and (
+ getattr(value.func, "attr", None)
+ == "select_autoescape"
+ or getattr(value.func, "id", None)
+ == "select_autoescape"
+ ):
+ return
+ else:
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.CODE_INJECTION,
+ text="Using jinja2 templates with autoescape="
+ "False is dangerous and can lead to XSS. "
+ "Ensure autoescape=True or use the "
+ "select_autoescape function to mitigate "
+ "XSS vulnerabilities.",
+ )
+ # We haven't found a keyword named autoescape, indicating default
+ # behavior
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.CODE_INJECTION,
+ text="By default, jinja2 sets autoescape to False. Consider "
+ "using autoescape=True or use the select_autoescape "
+ "function to mitigate XSS vulnerabilities.",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/logging_config_insecure_listen.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/logging_config_insecure_listen.py
new file mode 100644
index 00000000..96815f03
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/logging_config_insecure_listen.py
@@ -0,0 +1,58 @@
+# Copyright (c) 2022 Rajesh Pangare
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+====================================================
+B612: Test for insecure use of logging.config.listen
+====================================================
+
+This plugin test checks for the unsafe usage of the
+``logging.config.listen`` function. The logging.config.listen
+function provides the ability to listen for external
+configuration files on a socket server. Because portions of the
+configuration are passed through eval(), use of this function
+may open its users to a security risk. While the function only
+binds to a socket on localhost, and so does not accept connections
+from remote machines, there are scenarios where untrusted code
+could be run under the account of the process which calls listen().
+
+logging.config.listen provides the ability to verify bytes received
+across the socket with signature verification or encryption/decryption.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B612:logging_config_listen] Use of insecure
+ logging.config.listen detected.
+ Severity: Medium Confidence: High
+ CWE: CWE-94 (https://cwe.mitre.org/data/definitions/94.html)
+ Location: examples/logging_config_insecure_listen.py:3:4
+ 2
+ 3 t = logging.config.listen(9999)
+
+.. seealso::
+
+ - https://docs.python.org/3/library/logging.config.html#logging.config.listen
+
+.. versionadded:: 1.7.5
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B612")
+def logging_config_insecure_listen(context):
+ if (
+ context.call_function_name_qual == "logging.config.listen"
+ and "verify" not in context.call_keywords
+ ):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.CODE_INJECTION,
+ text="Use of insecure logging.config.listen detected.",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/mako_templates.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/mako_templates.py
new file mode 100644
index 00000000..21e81510
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/mako_templates.py
@@ -0,0 +1,69 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+====================================
+B702: Test for use of mako templates
+====================================
+
+Mako is a Python templating system often used to build web applications. It is
+the default templating system used in Pylons and Pyramid. Unlike Jinja2 (an
+alternative templating system), Mako has no environment wide variable escaping
+mechanism. Because of this, all input variables must be carefully escaped
+before use to prevent possible vulnerabilities to Cross Site Scripting (XSS)
+attacks.
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Mako templates allow HTML/JS rendering by default and are
+ inherently open to XSS attacks. Ensure variables in all templates are
+ properly sanitized via the 'n', 'h' or 'x' flags (depending on context).
+ For example, to HTML escape the variable 'data' do ${ data |h }.
+ Severity: Medium Confidence: High
+ CWE: CWE-80 (https://cwe.mitre.org/data/definitions/80.html)
+ Location: ./examples/mako_templating.py:10
+ 9
+ 10 mako.template.Template("hern")
+ 11 template.Template("hern")
+
+
+.. seealso::
+
+ - https://www.makotemplates.org/
+ - `OWASP XSS `__
+ - https://security.openstack.org/guidelines/dg_cross-site-scripting-xss.html
+ - https://cwe.mitre.org/data/definitions/80.html
+
+.. versionadded:: 0.10.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B702")
+def use_of_mako_templates(context):
+ # check type just to be safe
+ if isinstance(context.call_function_name_qual, str):
+ qualname_list = context.call_function_name_qual.split(".")
+ func = qualname_list[-1]
+ if "mako" in qualname_list and func == "Template":
+ # unlike Jinja2, mako does not have a template wide autoescape
+ # feature and thus each variable must be carefully sanitized.
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.BASIC_XSS,
+ text="Mako templates allow HTML/JS rendering by default and "
+ "are inherently open to XSS attacks. Ensure variables "
+ "in all templates are properly sanitized via the 'n', "
+ "'h' or 'x' flags (depending on context). For example, "
+ "to HTML escape the variable 'data' do ${ data |h }.",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/markupsafe_markup_xss.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/markupsafe_markup_xss.py
new file mode 100644
index 00000000..7eae9050
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/markupsafe_markup_xss.py
@@ -0,0 +1,118 @@
+# Copyright (c) 2025 David Salvisberg
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+============================================
+B704: Potential XSS on markupsafe.Markup use
+============================================
+
+``markupsafe.Markup`` does not perform any escaping, so passing dynamic
+content, like f-strings, variables or interpolated strings will potentially
+lead to XSS vulnerabilities, especially if that data was submitted by users.
+
+Instead you should interpolate the resulting ``markupsafe.Markup`` object,
+which will perform escaping, or use ``markupsafe.escape``.
+
+
+**Config Options:**
+
+This plugin allows you to specify additional callable that should be treated
+like ``markupsafe.Markup``. By default we recognize ``flask.Markup`` as
+an alias, but there are other subclasses or similar classes in the wild
+that you may wish to treat the same.
+
+Additionally there is a whitelist for callable names, whose result may
+be safely passed into ``markupsafe.Markup``. This is useful for escape
+functions like e.g. ``bleach.clean`` which don't themselves return
+``markupsafe.Markup``, so they need to be wrapped. Take care when using
+this setting, since incorrect use may introduce false negatives.
+
+These two options can be set in a shared configuration section
+`markupsafe_xss`.
+
+
+.. code-block:: yaml
+
+ markupsafe_xss:
+ # Recognize additional aliases
+ extend_markup_names:
+ - webhelpers.html.literal
+ - my_package.Markup
+
+ # Allow the output of these functions to pass into Markup
+ allowed_calls:
+ - bleach.clean
+ - my_package.sanitize
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B704:markupsafe_markup_xss] Potential XSS with
+ ``markupsafe.Markup`` detected. Do not use ``Markup``
+ on untrusted data.
+ Severity: Medium Confidence: High
+ CWE: CWE-79 (https://cwe.mitre.org/data/definitions/79.html)
+ Location: ./examples/markupsafe_markup_xss.py:5:0
+ 4 content = ""
+ 5 Markup(f"unsafe {content}")
+ 6 flask.Markup("unsafe {}".format(content))
+
+.. seealso::
+
+ - https://pypi.org/project/MarkupSafe/
+ - https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup
+ - https://cwe.mitre.org/data/definitions/79.html
+
+.. versionadded:: 1.8.3
+
+"""
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+from bandit.core.utils import get_call_name
+
+
+def gen_config(name):
+ if name == "markupsafe_xss":
+ return {
+ "extend_markup_names": [],
+ "allowed_calls": [],
+ }
+
+
+@test.takes_config("markupsafe_xss")
+@test.checks("Call")
+@test.test_id("B704")
+def markupsafe_markup_xss(context, config):
+
+ qualname = context.call_function_name_qual
+ if qualname not in ("markupsafe.Markup", "flask.Markup"):
+ if qualname not in config.get("extend_markup_names", []):
+ # not a Markup call
+ return None
+
+ args = context.node.args
+ if not args or isinstance(args[0], ast.Constant):
+ # both no arguments and a constant are fine
+ return None
+
+ allowed_calls = config.get("allowed_calls", [])
+ if (
+ allowed_calls
+ and isinstance(args[0], ast.Call)
+ and get_call_name(args[0], context.import_aliases) in allowed_calls
+ ):
+ # the argument contains a whitelisted call
+ return None
+
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.XSS,
+ text=f"Potential XSS with ``{qualname}`` detected. Do "
+ f"not use ``{context.call_function_name}`` on untrusted data.",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/pytorch_load.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/pytorch_load.py
new file mode 100644
index 00000000..ef3e49fc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/pytorch_load.py
@@ -0,0 +1,81 @@
+# Copyright (c) 2024 Stacklok, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==================================
+B614: Test for unsafe PyTorch load
+==================================
+
+This plugin checks for unsafe use of `torch.load`. Using `torch.load` with
+untrusted data can lead to arbitrary code execution. There are two safe
+alternatives:
+
+1. Use `torch.load` with `weights_only=True` where only tensor data is
+ extracted, and no arbitrary Python objects are deserialized
+2. Use the `safetensors` library from huggingface, which provides a safe
+ deserialization mechanism
+
+With `weights_only=True`, PyTorch enforces a strict type check, ensuring
+that only torch.Tensor objects are loaded.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Use of unsafe PyTorch load
+ Severity: Medium Confidence: High
+ CWE: CWE-94 (https://cwe.mitre.org/data/definitions/94.html)
+ Location: examples/pytorch_load_save.py:8
+ 7 loaded_model.load_state_dict(torch.load('model_weights.pth'))
+ 8 another_model.load_state_dict(torch.load('model_weights.pth',
+ map_location='cpu'))
+ 9
+ 10 print("Model loaded successfully!")
+
+.. seealso::
+
+ - https://cwe.mitre.org/data/definitions/94.html
+ - https://pytorch.org/docs/stable/generated/torch.load.html#torch.load
+ - https://github.com/huggingface/safetensors
+
+.. versionadded:: 1.7.10
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B614")
+def pytorch_load(context):
+ """
+ This plugin checks for unsafe use of `torch.load`. Using `torch.load`
+ with untrusted data can lead to arbitrary code execution. The safe
+ alternative is to use `weights_only=True` or the safetensors library.
+ """
+ imported = context.is_module_imported_exact("torch")
+ qualname = context.call_function_name_qual
+ if not imported and isinstance(qualname, str):
+ return
+
+ qualname_list = qualname.split(".")
+ func = qualname_list[-1]
+ if all(
+ [
+ "torch" in qualname_list,
+ func == "load",
+ ]
+ ):
+ # For torch.load, check if weights_only=True is specified
+ weights_only = context.get_call_arg_value("weights_only")
+ if weights_only == "True" or weights_only is True:
+ return
+
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ text="Use of unsafe PyTorch load",
+ cwe=issue.Cwe.DESERIALIZATION_OF_UNTRUSTED_DATA,
+ lineno=context.get_lineno_for_call_arg("load"),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/request_without_timeout.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/request_without_timeout.py
new file mode 100644
index 00000000..c6439001
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/request_without_timeout.py
@@ -0,0 +1,84 @@
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=======================================
+B113: Test for missing requests timeout
+=======================================
+
+This plugin test checks for ``requests`` or ``httpx`` calls without a timeout
+specified.
+
+Nearly all production code should use this parameter in nearly all requests,
+Failure to do so can cause your program to hang indefinitely.
+
+When request methods are used without the timeout parameter set,
+Bandit will return a MEDIUM severity error.
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B113:request_without_timeout] Call to requests without timeout
+ Severity: Medium Confidence: Low
+ CWE: CWE-400 (https://cwe.mitre.org/data/definitions/400.html)
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b113_request_without_timeout.html
+ Location: examples/requests-missing-timeout.py:3:0
+ 2
+ 3 requests.get('https://gmail.com')
+ 4 requests.get('https://gmail.com', timeout=None)
+
+ --------------------------------------------------
+ >> Issue: [B113:request_without_timeout] Call to requests with timeout set to None
+ Severity: Medium Confidence: Low
+ CWE: CWE-400 (https://cwe.mitre.org/data/definitions/400.html)
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b113_request_without_timeout.html
+ Location: examples/requests-missing-timeout.py:4:0
+ 3 requests.get('https://gmail.com')
+ 4 requests.get('https://gmail.com', timeout=None)
+ 5 requests.get('https://gmail.com', timeout=5)
+
+.. seealso::
+
+ - https://requests.readthedocs.io/en/latest/user/advanced/#timeouts
+
+.. versionadded:: 1.7.5
+
+.. versionchanged:: 1.7.10
+ Added check for httpx module
+
+""" # noqa: E501
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B113")
+def request_without_timeout(context):
+ HTTP_VERBS = {"get", "options", "head", "post", "put", "patch", "delete"}
+ HTTPX_ATTRS = {"request", "stream", "Client", "AsyncClient"} | HTTP_VERBS
+ qualname = context.call_function_name_qual.split(".")[0]
+
+ if qualname == "requests" and context.call_function_name in HTTP_VERBS:
+ # check for missing timeout
+ if context.check_call_arg_value("timeout") is None:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.LOW,
+ cwe=issue.Cwe.UNCONTROLLED_RESOURCE_CONSUMPTION,
+ text=f"Call to {qualname} without timeout",
+ )
+ if (
+ qualname == "requests"
+ and context.call_function_name in HTTP_VERBS
+ or qualname == "httpx"
+ and context.call_function_name in HTTPX_ATTRS
+ ):
+ # check for timeout=None
+ if context.check_call_arg_value("timeout", "None"):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.LOW,
+ cwe=issue.Cwe.UNCONTROLLED_RESOURCE_CONSUMPTION,
+ text=f"Call to {qualname} with timeout set to None",
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/snmp_security_check.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/snmp_security_check.py
new file mode 100644
index 00000000..a915ed89
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/snmp_security_check.py
@@ -0,0 +1,110 @@
+#
+# Copyright (c) 2018 SolarWinds, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B508")
+def snmp_insecure_version_check(context):
+ """**B508: Checking for insecure SNMP versions**
+
+ This test is for checking for the usage of insecure SNMP version like
+ v1, v2c
+
+ Please update your code to use more secure versions of SNMP.
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [B508:snmp_insecure_version_check] The use of SNMPv1 and
+ SNMPv2 is insecure. You should use SNMPv3 if able.
+ Severity: Medium Confidence: High
+ CWE: CWE-319 (https://cwe.mitre.org/data/definitions/319.html)
+ Location: examples/snmp.py:4:4
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b508_snmp_insecure_version_check.html
+ 3 # SHOULD FAIL
+ 4 a = CommunityData('public', mpModel=0)
+ 5 # SHOULD FAIL
+
+ .. seealso::
+
+ - http://snmplabs.com/pysnmp/examples/hlapi/asyncore/sync/manager/cmdgen/snmp-versions.html
+ - https://cwe.mitre.org/data/definitions/319.html
+
+ .. versionadded:: 1.7.2
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+
+ if context.call_function_name_qual == "pysnmp.hlapi.CommunityData":
+ # We called community data. Lets check our args
+ if context.check_call_arg_value(
+ "mpModel", 0
+ ) or context.check_call_arg_value("mpModel", 1):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.CLEARTEXT_TRANSMISSION,
+ text="The use of SNMPv1 and SNMPv2 is insecure. "
+ "You should use SNMPv3 if able.",
+ lineno=context.get_lineno_for_call_arg("CommunityData"),
+ )
+
+
+@test.checks("Call")
+@test.test_id("B509")
+def snmp_crypto_check(context):
+ """**B509: Checking for weak cryptography**
+
+ This test is for checking for the usage of insecure SNMP cryptography:
+ v3 using noAuthNoPriv.
+
+ Please update your code to use more secure versions of SNMP. For example:
+
+ Instead of:
+ `CommunityData('public', mpModel=0)`
+
+ Use (Defaults to usmHMACMD5AuthProtocol and usmDESPrivProtocol
+ `UsmUserData("securityName", "authName", "privName")`
+
+ :Example:
+
+ .. code-block:: none
+
+ >> Issue: [B509:snmp_crypto_check] You should not use SNMPv3 without encryption. noAuthNoPriv & authNoPriv is insecure
+ Severity: Medium CWE: CWE-319 (https://cwe.mitre.org/data/definitions/319.html) Confidence: High
+ Location: examples/snmp.py:6:11
+ More Info: https://bandit.readthedocs.io/en/latest/plugins/b509_snmp_crypto_check.html
+ 5 # SHOULD FAIL
+ 6 insecure = UsmUserData("securityName")
+ 7 # SHOULD FAIL
+
+ .. seealso::
+
+ - http://snmplabs.com/pysnmp/examples/hlapi/asyncore/sync/manager/cmdgen/snmp-versions.html
+ - https://cwe.mitre.org/data/definitions/319.html
+
+ .. versionadded:: 1.7.2
+
+ .. versionchanged:: 1.7.3
+ CWE information added
+
+ """ # noqa: E501
+
+ if context.call_function_name_qual == "pysnmp.hlapi.UsmUserData":
+ if context.call_args_count < 3:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.CLEARTEXT_TRANSMISSION,
+ text="You should not use SNMPv3 without encryption. "
+ "noAuthNoPriv & authNoPriv is insecure",
+ lineno=context.get_lineno_for_call_arg("UsmUserData"),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/ssh_no_host_key_verification.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/ssh_no_host_key_verification.py
new file mode 100644
index 00000000..51be2eb4
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/ssh_no_host_key_verification.py
@@ -0,0 +1,76 @@
+# Copyright (c) 2018 VMware, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+==========================================
+B507: Test for missing host key validation
+==========================================
+
+Encryption in general is typically critical to the security of many
+applications. Using SSH can greatly increase security by guaranteeing the
+identity of the party you are communicating with. This is accomplished by one
+or both parties presenting trusted host keys during the connection
+initialization phase of SSH.
+
+When paramiko methods are used, host keys are verified by default. If host key
+verification is disabled, Bandit will return a HIGH severity error.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B507:ssh_no_host_key_verification] Paramiko call with policy set
+ to automatically trust the unknown host key.
+ Severity: High Confidence: Medium
+ CWE: CWE-295 (https://cwe.mitre.org/data/definitions/295.html)
+ Location: examples/no_host_key_verification.py:4
+ 3 ssh_client = client.SSHClient()
+ 4 ssh_client.set_missing_host_key_policy(client.AutoAddPolicy)
+ 5 ssh_client.set_missing_host_key_policy(client.WarningPolicy)
+
+
+.. versionadded:: 1.5.1
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.checks("Call")
+@test.test_id("B507")
+def ssh_no_host_key_verification(context):
+ if (
+ context.is_module_imported_like("paramiko")
+ and context.call_function_name == "set_missing_host_key_policy"
+ and context.node.args
+ ):
+ policy_argument = context.node.args[0]
+
+ policy_argument_value = None
+ if isinstance(policy_argument, ast.Attribute):
+ policy_argument_value = policy_argument.attr
+ elif isinstance(policy_argument, ast.Name):
+ policy_argument_value = policy_argument.id
+ elif isinstance(policy_argument, ast.Call):
+ if isinstance(policy_argument.func, ast.Attribute):
+ policy_argument_value = policy_argument.func.attr
+ elif isinstance(policy_argument.func, ast.Name):
+ policy_argument_value = policy_argument.func.id
+
+ if policy_argument_value in ["AutoAddPolicy", "WarningPolicy"]:
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.IMPROPER_CERT_VALIDATION,
+ text="Paramiko call with policy set to automatically trust "
+ "the unknown host key.",
+ lineno=context.get_lineno_for_call_arg(
+ "set_missing_host_key_policy"
+ ),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/tarfile_unsafe_members.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/tarfile_unsafe_members.py
new file mode 100644
index 00000000..499a6678
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/tarfile_unsafe_members.py
@@ -0,0 +1,121 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+r"""
+=================================
+B202: Test for tarfile.extractall
+=================================
+
+This plugin will look for usage of ``tarfile.extractall()``
+
+Severity are set as follows:
+
+* ``tarfile.extractall(members=function(tarfile))`` - LOW
+* ``tarfile.extractall(members=?)`` - member is not a function - MEDIUM
+* ``tarfile.extractall()`` - members from the archive is trusted - HIGH
+
+Use ``tarfile.extractall(members=function_name)`` and define a function
+that will inspect each member. Discard files that contain a directory
+traversal sequences such as ``../`` or ``\..`` along with all special filetypes
+unless you explicitly need them.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B202:tarfile_unsafe_members] tarfile.extractall used without
+ any validation. You should check members and discard dangerous ones
+ Severity: High Confidence: High
+ CWE: CWE-22 (https://cwe.mitre.org/data/definitions/22.html)
+ Location: examples/tarfile_extractall.py:8
+ More Info:
+ https://bandit.readthedocs.io/en/latest/plugins/b202_tarfile_unsafe_members.html
+ 7 tar = tarfile.open(filename)
+ 8 tar.extractall(path=tempfile.mkdtemp())
+ 9 tar.close()
+
+
+.. seealso::
+
+ - https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extractall
+ - https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo
+
+.. versionadded:: 1.7.5
+
+.. versionchanged:: 1.7.8
+ Added check for filter parameter
+
+"""
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def exec_issue(level, members=""):
+ if level == bandit.LOW:
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.LOW,
+ cwe=issue.Cwe.PATH_TRAVERSAL,
+ text="Usage of tarfile.extractall(members=function(tarfile)). "
+ "Make sure your function properly discards dangerous members "
+ "{members}).".format(members=members),
+ )
+ elif level == bandit.MEDIUM:
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.PATH_TRAVERSAL,
+ text="Found tarfile.extractall(members=?) but couldn't "
+ "identify the type of members. "
+ "Check if the members were properly validated "
+ "{members}).".format(members=members),
+ )
+ else:
+ return bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.PATH_TRAVERSAL,
+ text="tarfile.extractall used without any validation. "
+ "Please check and discard dangerous members.",
+ )
+
+
+def get_members_value(context):
+ for keyword in context.node.keywords:
+ if keyword.arg == "members":
+ arg = keyword.value
+ if isinstance(arg, ast.Call):
+ return {"Function": arg.func.id}
+ else:
+ value = arg.id if isinstance(arg, ast.Name) else arg
+ return {"Other": value}
+
+
+def is_filter_data(context):
+ for keyword in context.node.keywords:
+ if keyword.arg == "filter":
+ arg = keyword.value
+ return isinstance(arg, ast.Constant) and arg.value == "data"
+
+
+@test.test_id("B202")
+@test.checks("Call")
+def tarfile_unsafe_members(context):
+ if all(
+ [
+ context.is_module_imported_exact("tarfile"),
+ "extractall" in context.call_function_name,
+ ]
+ ):
+ if "filter" in context.call_keywords and is_filter_data(context):
+ return None
+ if "members" in context.call_keywords:
+ members = get_members_value(context)
+ if "Function" in members:
+ return exec_issue(bandit.LOW, members)
+ else:
+ return exec_issue(bandit.MEDIUM, members)
+ return exec_issue(bandit.HIGH)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/trojansource.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/trojansource.py
new file mode 100644
index 00000000..ddf24483
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/trojansource.py
@@ -0,0 +1,79 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=====================================================
+B613: TrojanSource - Bidirectional control characters
+=====================================================
+
+This plugin checks for the presence of unicode bidirectional control characters
+in Python source files. Those characters can be embedded in comments and strings
+to reorder source code characters in a way that changes its logic.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [B613:trojansource] A Python source file contains bidirectional control characters ('\u202e').
+ Severity: High Confidence: Medium
+ CWE: CWE-838 (https://cwe.mitre.org/data/definitions/838.html)
+ More Info: https://bandit.readthedocs.io/en/1.7.5/plugins/b113_trojansource.html
+ Location: examples/trojansource.py:4:25
+ 3 access_level = "user"
+ 4 if access_level != 'none': # Check if admin ' and access_level != 'user
+ 5 print("You are an admin.\n")
+
+.. seealso::
+
+ - https://trojansource.codes/
+ - https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-42574
+
+.. versionadded:: 1.7.10
+
+""" # noqa: E501
+from tokenize import detect_encoding
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+BIDI_CHARACTERS = (
+ "\u202a",
+ "\u202b",
+ "\u202c",
+ "\u202d",
+ "\u202e",
+ "\u2066",
+ "\u2067",
+ "\u2068",
+ "\u2069",
+ "\u200f",
+)
+
+
+@test.test_id("B613")
+@test.checks("File")
+def trojansource(context):
+ with open(context.filename, "rb") as src_file:
+ encoding, _ = detect_encoding(src_file.readline)
+ with open(context.filename, encoding=encoding) as src_file:
+ for lineno, line in enumerate(src_file.readlines(), start=1):
+ for char in BIDI_CHARACTERS:
+ try:
+ col_offset = line.index(char) + 1
+ except ValueError:
+ continue
+ text = (
+ "A Python source file contains bidirectional"
+ " control characters (%r)." % char
+ )
+ b_issue = bandit.Issue(
+ severity=bandit.HIGH,
+ confidence=bandit.MEDIUM,
+ cwe=issue.Cwe.INAPPROPRIATE_ENCODING_FOR_OUTPUT_CONTEXT,
+ text=text,
+ lineno=lineno,
+ col_offset=col_offset,
+ )
+ b_issue.linerange = [lineno]
+ return b_issue
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/try_except_continue.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/try_except_continue.py
new file mode 100644
index 00000000..c2e3ad49
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/try_except_continue.py
@@ -0,0 +1,108 @@
+# Copyright 2016 IBM Corp.
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=============================================
+B112: Test for a continue in the except block
+=============================================
+
+Errors in Python code bases are typically communicated using ``Exceptions``.
+An exception object is 'raised' in the event of an error and can be 'caught' at
+a later point in the program, typically some error handling or logging action
+will then be performed.
+
+However, it is possible to catch an exception and silently ignore it while in
+a loop. This is illustrated with the following example
+
+.. code-block:: python
+
+ while keep_going:
+ try:
+ do_some_stuff()
+ except Exception:
+ continue
+
+This pattern is considered bad practice in general, but also represents a
+potential security issue. A larger than normal volume of errors from a service
+can indicate an attempt is being made to disrupt or interfere with it. Thus
+errors should, at the very least, be logged.
+
+There are rare situations where it is desirable to suppress errors, but this is
+typically done with specific exception types, rather than the base Exception
+class (or no type). To accommodate this, the test may be configured to ignore
+'try, except, continue' where the exception is typed. For example, the
+following would not generate a warning if the configuration option
+``checked_typed_exception`` is set to False:
+
+.. code-block:: python
+
+ while keep_going:
+ try:
+ do_some_stuff()
+ except ZeroDivisionError:
+ continue
+
+**Config Options:**
+
+.. code-block:: yaml
+
+ try_except_continue:
+ check_typed_exception: True
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Try, Except, Continue detected.
+ Severity: Low Confidence: High
+ CWE: CWE-703 (https://cwe.mitre.org/data/definitions/703.html)
+ Location: ./examples/try_except_continue.py:5
+ 4 a = i
+ 5 except:
+ 6 continue
+
+.. seealso::
+
+ - https://security.openstack.org
+ - https://cwe.mitre.org/data/definitions/703.html
+
+.. versionadded:: 1.0.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def gen_config(name):
+ if name == "try_except_continue":
+ return {"check_typed_exception": False}
+
+
+@test.takes_config
+@test.checks("ExceptHandler")
+@test.test_id("B112")
+def try_except_continue(context, config):
+ node = context.node
+ if len(node.body) == 1:
+ if (
+ not config["check_typed_exception"]
+ and node.type is not None
+ and getattr(node.type, "id", None) != "Exception"
+ ):
+ return
+
+ if isinstance(node.body[0], ast.Continue):
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.IMPROPER_CHECK_OF_EXCEPT_COND,
+ text=("Try, Except, Continue detected."),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/try_except_pass.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/try_except_pass.py
new file mode 100644
index 00000000..eda0ef80
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/try_except_pass.py
@@ -0,0 +1,106 @@
+#
+# Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=========================================
+B110: Test for a pass in the except block
+=========================================
+
+Errors in Python code bases are typically communicated using ``Exceptions``.
+An exception object is 'raised' in the event of an error and can be 'caught' at
+a later point in the program, typically some error handling or logging action
+will then be performed.
+
+However, it is possible to catch an exception and silently ignore it. This is
+illustrated with the following example
+
+.. code-block:: python
+
+ try:
+ do_some_stuff()
+ except Exception:
+ pass
+
+This pattern is considered bad practice in general, but also represents a
+potential security issue. A larger than normal volume of errors from a service
+can indicate an attempt is being made to disrupt or interfere with it. Thus
+errors should, at the very least, be logged.
+
+There are rare situations where it is desirable to suppress errors, but this is
+typically done with specific exception types, rather than the base Exception
+class (or no type). To accommodate this, the test may be configured to ignore
+'try, except, pass' where the exception is typed. For example, the following
+would not generate a warning if the configuration option
+``checked_typed_exception`` is set to False:
+
+.. code-block:: python
+
+ try:
+ do_some_stuff()
+ except ZeroDivisionError:
+ pass
+
+**Config Options:**
+
+.. code-block:: yaml
+
+ try_except_pass:
+ check_typed_exception: True
+
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: Try, Except, Pass detected.
+ Severity: Low Confidence: High
+ CWE: CWE-703 (https://cwe.mitre.org/data/definitions/703.html)
+ Location: ./examples/try_except_pass.py:4
+ 3 a = 1
+ 4 except:
+ 5 pass
+
+.. seealso::
+
+ - https://security.openstack.org
+ - https://cwe.mitre.org/data/definitions/703.html
+
+.. versionadded:: 0.13.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import ast
+
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def gen_config(name):
+ if name == "try_except_pass":
+ return {"check_typed_exception": False}
+
+
+@test.takes_config
+@test.checks("ExceptHandler")
+@test.test_id("B110")
+def try_except_pass(context, config):
+ node = context.node
+ if len(node.body) == 1:
+ if (
+ not config["check_typed_exception"]
+ and node.type is not None
+ and getattr(node.type, "id", None) != "Exception"
+ ):
+ return
+
+ if isinstance(node.body[0], ast.Pass):
+ return bandit.Issue(
+ severity=bandit.LOW,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.IMPROPER_CHECK_OF_EXCEPT_COND,
+ text=("Try, Except, Pass detected."),
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/weak_cryptographic_key.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/weak_cryptographic_key.py
new file mode 100644
index 00000000..da73ced6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/weak_cryptographic_key.py
@@ -0,0 +1,165 @@
+# Copyright (c) 2015 VMware, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+=========================================
+B505: Test for weak cryptographic key use
+=========================================
+
+As computational power increases, so does the ability to break ciphers with
+smaller key lengths. The recommended key length size for RSA and DSA algorithms
+is 2048 and higher. 1024 bits and below are now considered breakable. EC key
+length sizes are recommended to be 224 and higher with 160 and below considered
+breakable. This plugin test checks for use of any key less than those limits
+and returns a high severity error if lower than the lower threshold and a
+medium severity error for those lower than the higher threshold.
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: DSA key sizes below 1024 bits are considered breakable.
+ Severity: High Confidence: High
+ CWE: CWE-326 (https://cwe.mitre.org/data/definitions/326.html)
+ Location: examples/weak_cryptographic_key_sizes.py:36
+ 35 # Also incorrect: without keyword args
+ 36 dsa.generate_private_key(512,
+ 37 backends.default_backend())
+ 38 rsa.generate_private_key(3,
+
+.. seealso::
+
+ - https://csrc.nist.gov/publications/detail/sp/800-131a/rev-2/final
+ - https://security.openstack.org/guidelines/dg_strong-crypto.html
+ - https://cwe.mitre.org/data/definitions/326.html
+
+.. versionadded:: 0.14.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+def gen_config(name):
+ if name == "weak_cryptographic_key":
+ return {
+ "weak_key_size_dsa_high": 1024,
+ "weak_key_size_dsa_medium": 2048,
+ "weak_key_size_rsa_high": 1024,
+ "weak_key_size_rsa_medium": 2048,
+ "weak_key_size_ec_high": 160,
+ "weak_key_size_ec_medium": 224,
+ }
+
+
+def _classify_key_size(config, key_type, key_size):
+ if isinstance(key_size, str):
+ # size provided via a variable - can't process it at the moment
+ return
+
+ key_sizes = {
+ "DSA": [
+ (config["weak_key_size_dsa_high"], bandit.HIGH),
+ (config["weak_key_size_dsa_medium"], bandit.MEDIUM),
+ ],
+ "RSA": [
+ (config["weak_key_size_rsa_high"], bandit.HIGH),
+ (config["weak_key_size_rsa_medium"], bandit.MEDIUM),
+ ],
+ "EC": [
+ (config["weak_key_size_ec_high"], bandit.HIGH),
+ (config["weak_key_size_ec_medium"], bandit.MEDIUM),
+ ],
+ }
+
+ for size, level in key_sizes[key_type]:
+ if key_size < size:
+ return bandit.Issue(
+ severity=level,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.INADEQUATE_ENCRYPTION_STRENGTH,
+ text="%s key sizes below %d bits are considered breakable. "
+ % (key_type, size),
+ )
+
+
+def _weak_crypto_key_size_cryptography_io(context, config):
+ func_key_type = {
+ "cryptography.hazmat.primitives.asymmetric.dsa."
+ "generate_private_key": "DSA",
+ "cryptography.hazmat.primitives.asymmetric.rsa."
+ "generate_private_key": "RSA",
+ "cryptography.hazmat.primitives.asymmetric.ec."
+ "generate_private_key": "EC",
+ }
+ arg_position = {
+ "DSA": 0,
+ "RSA": 1,
+ "EC": 0,
+ }
+ key_type = func_key_type.get(context.call_function_name_qual)
+ if key_type in ["DSA", "RSA"]:
+ key_size = (
+ context.get_call_arg_value("key_size")
+ or context.get_call_arg_at_position(arg_position[key_type])
+ or 2048
+ )
+ return _classify_key_size(config, key_type, key_size)
+ elif key_type == "EC":
+ curve_key_sizes = {
+ "SECT571K1": 571,
+ "SECT571R1": 570,
+ "SECP521R1": 521,
+ "BrainpoolP512R1": 512,
+ "SECT409K1": 409,
+ "SECT409R1": 409,
+ "BrainpoolP384R1": 384,
+ "SECP384R1": 384,
+ "SECT283K1": 283,
+ "SECT283R1": 283,
+ "BrainpoolP256R1": 256,
+ "SECP256K1": 256,
+ "SECP256R1": 256,
+ "SECT233K1": 233,
+ "SECT233R1": 233,
+ "SECP224R1": 224,
+ "SECP192R1": 192,
+ "SECT163K1": 163,
+ "SECT163R2": 163,
+ }
+ curve = context.get_call_arg_value("curve") or (
+ len(context.call_args) > arg_position[key_type]
+ and context.call_args[arg_position[key_type]]
+ )
+ key_size = curve_key_sizes[curve] if curve in curve_key_sizes else 224
+ return _classify_key_size(config, key_type, key_size)
+
+
+def _weak_crypto_key_size_pycrypto(context, config):
+ func_key_type = {
+ "Crypto.PublicKey.DSA.generate": "DSA",
+ "Crypto.PublicKey.RSA.generate": "RSA",
+ "Cryptodome.PublicKey.DSA.generate": "DSA",
+ "Cryptodome.PublicKey.RSA.generate": "RSA",
+ }
+ key_type = func_key_type.get(context.call_function_name_qual)
+ if key_type:
+ key_size = (
+ context.get_call_arg_value("bits")
+ or context.get_call_arg_at_position(0)
+ or 2048
+ )
+ return _classify_key_size(config, key_type, key_size)
+
+
+@test.takes_config
+@test.checks("Call")
+@test.test_id("B505")
+def weak_cryptographic_key(context, config):
+ return _weak_crypto_key_size_cryptography_io(
+ context, config
+ ) or _weak_crypto_key_size_pycrypto(context, config)
diff --git a/Backend/venv/lib/python3.12/site-packages/bandit/plugins/yaml_load.py b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/yaml_load.py
new file mode 100644
index 00000000..2304c1d7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/bandit/plugins/yaml_load.py
@@ -0,0 +1,76 @@
+#
+# Copyright (c) 2016 Rackspace, Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+r"""
+===============================
+B506: Test for use of yaml load
+===============================
+
+This plugin test checks for the unsafe usage of the ``yaml.load`` function from
+the PyYAML package. The yaml.load function provides the ability to construct
+an arbitrary Python object, which may be dangerous if you receive a YAML
+document from an untrusted source. The function yaml.safe_load limits this
+ability to simple Python objects like integers or lists.
+
+Please see
+https://pyyaml.org/wiki/PyYAMLDocumentation#LoadingYAML for more information
+on ``yaml.load`` and yaml.safe_load
+
+:Example:
+
+.. code-block:: none
+
+ >> Issue: [yaml_load] Use of unsafe yaml load. Allows instantiation of
+ arbitrary objects. Consider yaml.safe_load().
+ Severity: Medium Confidence: High
+ CWE: CWE-20 (https://cwe.mitre.org/data/definitions/20.html)
+ Location: examples/yaml_load.py:5
+ 4 ystr = yaml.dump({'a' : 1, 'b' : 2, 'c' : 3})
+ 5 y = yaml.load(ystr)
+ 6 yaml.dump(y)
+
+.. seealso::
+
+ - https://pyyaml.org/wiki/PyYAMLDocumentation#LoadingYAML
+ - https://cwe.mitre.org/data/definitions/20.html
+
+.. versionadded:: 1.0.0
+
+.. versionchanged:: 1.7.3
+ CWE information added
+
+"""
+import bandit
+from bandit.core import issue
+from bandit.core import test_properties as test
+
+
+@test.test_id("B506")
+@test.checks("Call")
+def yaml_load(context):
+ imported = context.is_module_imported_exact("yaml")
+ qualname = context.call_function_name_qual
+ if not imported and isinstance(qualname, str):
+ return
+
+ qualname_list = qualname.split(".")
+ func = qualname_list[-1]
+ if all(
+ [
+ "yaml" in qualname_list,
+ func == "load",
+ not context.check_call_arg_value("Loader", "SafeLoader"),
+ not context.check_call_arg_value("Loader", "CSafeLoader"),
+ not context.get_call_arg_at_position(1) == "SafeLoader",
+ not context.get_call_arg_at_position(1) == "CSafeLoader",
+ ]
+ ):
+ return bandit.Issue(
+ severity=bandit.MEDIUM,
+ confidence=bandit.HIGH,
+ cwe=issue.Cwe.IMPROPER_INPUT_VALIDATION,
+ text="Use of unsafe yaml load. Allows instantiation of"
+ " arbitrary objects. Consider yaml.safe_load().",
+ lineno=context.node.lineno,
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean/__init__.py b/Backend/venv/lib/python3.12/site-packages/boolean/__init__.py
new file mode 100644
index 00000000..9a38c725
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean/__init__.py
@@ -0,0 +1,31 @@
+"""
+Boolean Algebra.
+
+This module defines a Boolean Algebra over the set {TRUE, FALSE} with boolean
+variables and the boolean functions AND, OR, NOT. For extensive documentation
+look either into the docs directory or view it online, at
+https://booleanpy.readthedocs.org/en/latest/.
+
+Copyright (c) Sebastian Kraemer, basti.kr@gmail.com and others
+
+SPDX-License-Identifier: BSD-2-Clause
+"""
+
+from boolean.boolean import (
+ AND,
+ NOT,
+ OR,
+ PARSE_ERRORS,
+ TOKEN_AND,
+ TOKEN_FALSE,
+ TOKEN_LPAR,
+ TOKEN_NOT,
+ TOKEN_OR,
+ TOKEN_RPAR,
+ TOKEN_SYMBOL,
+ TOKEN_TRUE,
+ BooleanAlgebra,
+ Expression,
+ ParseError,
+ Symbol,
+)
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..5117edd3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/boolean.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/boolean.cpython-312.pyc
new file mode 100644
index 00000000..775e7f69
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/boolean.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/test_boolean.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/test_boolean.cpython-312.pyc
new file mode 100644
index 00000000..1fd3a9e0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/boolean/__pycache__/test_boolean.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean/boolean.py b/Backend/venv/lib/python3.12/site-packages/boolean/boolean.py
new file mode 100644
index 00000000..5cb43ff0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean/boolean.py
@@ -0,0 +1,1662 @@
+"""
+Boolean expressions algebra.
+
+This module defines a Boolean algebra over the set {TRUE, FALSE} with boolean
+variables called Symbols and the boolean functions AND, OR, NOT.
+
+Some basic logic comparison is supported: two expressions can be
+compared for equivalence or containment. Furthermore you can simplify
+an expression and obtain its normal form.
+
+You can create expressions in Python using familiar boolean operators
+or parse expressions from strings. The parsing can be extended with
+your own tokenizer. You can also customize how expressions behave and
+how they are presented.
+
+For extensive documentation look either into the docs directory or view it
+online, at https://booleanpy.readthedocs.org/en/latest/.
+
+Copyright (c) Sebastian Kraemer, basti.kr@gmail.com and others
+
+SPDX-License-Identifier: BSD-2-Clause
+"""
+
+import inspect
+import itertools
+from functools import reduce # NOQA
+from operator import and_ as and_operator
+from operator import or_ as or_operator
+
+# Set to True to enable tracing for parsing
+TRACE_PARSE = False
+
+# Token types for standard operators and parens
+TOKEN_AND = 1
+TOKEN_OR = 2
+TOKEN_NOT = 3
+TOKEN_LPAR = 4
+TOKEN_RPAR = 5
+TOKEN_TRUE = 6
+TOKEN_FALSE = 7
+TOKEN_SYMBOL = 8
+
+TOKEN_TYPES = {
+ TOKEN_AND: "AND",
+ TOKEN_OR: "OR",
+ TOKEN_NOT: "NOT",
+ TOKEN_LPAR: "(",
+ TOKEN_RPAR: ")",
+ TOKEN_TRUE: "TRUE",
+ TOKEN_FALSE: "FALSE",
+ TOKEN_SYMBOL: "SYMBOL",
+}
+
+# parsing error code and messages
+PARSE_UNKNOWN_TOKEN = 1
+PARSE_UNBALANCED_CLOSING_PARENS = 2
+PARSE_INVALID_EXPRESSION = 3
+PARSE_INVALID_NESTING = 4
+PARSE_INVALID_SYMBOL_SEQUENCE = 5
+PARSE_INVALID_OPERATOR_SEQUENCE = 6
+
+PARSE_ERRORS = {
+ PARSE_UNKNOWN_TOKEN: "Unknown token",
+ PARSE_UNBALANCED_CLOSING_PARENS: "Unbalanced parenthesis",
+ PARSE_INVALID_EXPRESSION: "Invalid expression",
+ PARSE_INVALID_NESTING: "Invalid expression nesting such as (AND xx)",
+ PARSE_INVALID_SYMBOL_SEQUENCE: "Invalid symbols sequence such as (A B)",
+ PARSE_INVALID_OPERATOR_SEQUENCE: "Invalid operator sequence without symbols such as AND OR or OR OR",
+}
+
+
+class ParseError(Exception):
+ """
+ Raised when the parser or tokenizer encounters a syntax error. Instances of
+ this class have attributes token_type, token_string, position, error_code to
+ access the details of the error. str() of the exception instance returns a
+ formatted message.
+ """
+
+ def __init__(self, token_type=None, token_string="", position=-1, error_code=0):
+ self.token_type = token_type
+ self.token_string = token_string
+ self.position = position
+ self.error_code = error_code
+
+ def __str__(self, *args, **kwargs):
+ emsg = PARSE_ERRORS.get(self.error_code, "Unknown parsing error")
+
+ tstr = ""
+ if self.token_string:
+ tstr = f' for token: "{self.token_string}"'
+
+ pos = ""
+ if self.position > 0:
+ pos = f" at position: {self.position}"
+
+ return f"{emsg}{tstr}{pos}"
+
+
+class BooleanAlgebra(object):
+ """
+ An algebra is defined by:
+
+ - the types of its operations and Symbol.
+ - the tokenizer used when parsing expressions from strings.
+
+ This class also serves as a base class for all boolean expressions,
+ including base elements, functions and variable symbols.
+ """
+
+ def __init__(
+ self,
+ TRUE_class=None,
+ FALSE_class=None,
+ Symbol_class=None,
+ NOT_class=None,
+ AND_class=None,
+ OR_class=None,
+ allowed_in_token=(".", ":", "_"),
+ ):
+ """
+ The types for TRUE, FALSE, NOT, AND, OR and Symbol define the boolean
+ algebra elements, operations and Symbol variable. They default to the
+ standard classes if not provided.
+
+ You can customize an algebra by providing alternative subclasses of the
+ standard types.
+ """
+ # TRUE and FALSE base elements are algebra-level "singleton" instances
+ self.TRUE = TRUE_class or _TRUE
+ self.TRUE = self.TRUE()
+
+ self.FALSE = FALSE_class or _FALSE
+ self.FALSE = self.FALSE()
+
+ # they cross-reference each other
+ self.TRUE.dual = self.FALSE
+ self.FALSE.dual = self.TRUE
+
+ # boolean operation types, defaulting to the standard types
+ self.NOT = NOT_class or NOT
+ self.AND = AND_class or AND
+ self.OR = OR_class or OR
+
+ # class used for Symbols
+ self.Symbol = Symbol_class or Symbol
+
+ tf_nao = {
+ "TRUE": self.TRUE,
+ "FALSE": self.FALSE,
+ "NOT": self.NOT,
+ "AND": self.AND,
+ "OR": self.OR,
+ "Symbol": self.Symbol,
+ }
+
+ # setup cross references such that all algebra types and
+ # objects hold a named attribute for every other types and
+ # objects, including themselves.
+ for obj in tf_nao.values():
+ for name, value in tf_nao.items():
+ setattr(obj, name, value)
+
+ # Set the set of characters allowed in tokens
+ self.allowed_in_token = allowed_in_token
+
+ def definition(self):
+ """
+ Return a tuple of this algebra defined elements and types as:
+ (TRUE, FALSE, NOT, AND, OR, Symbol)
+ """
+ return self.TRUE, self.FALSE, self.NOT, self.AND, self.OR, self.Symbol
+
+ def symbols(self, *args):
+ """
+ Return a tuple of symbols building a new Symbol from each argument.
+ """
+ return tuple(map(self.Symbol, args))
+
+ def parse(self, expr, simplify=False):
+ """
+ Return a boolean expression parsed from `expr` either a unicode string
+ or tokens iterable.
+
+ Optionally simplify the expression if `simplify` is True.
+
+ Raise ParseError on errors.
+
+ If `expr` is a string, the standard `tokenizer` is used for tokenization
+ and the algebra configured Symbol type is used to create Symbol
+ instances from Symbol tokens.
+
+ If `expr` is an iterable, it should contain 3-tuples of: (token_type,
+ token_string, token_position). In this case, the `token_type` can be
+ a Symbol instance or one of the TOKEN_* constant types.
+ See the `tokenize()` method for detailed specification.
+ """
+
+ precedence = {self.NOT: 5, self.AND: 10, self.OR: 15, TOKEN_LPAR: 20}
+
+ if isinstance(expr, str):
+ tokenized = self.tokenize(expr)
+ else:
+ tokenized = iter(expr)
+
+ if TRACE_PARSE:
+ tokenized = list(tokenized)
+ print("tokens:")
+ for t in tokenized:
+ print(t)
+ tokenized = iter(tokenized)
+
+ # the abstract syntax tree for this expression that will be build as we
+ # process tokens
+ # the first two items are None
+ # symbol items are appended to this structure
+ ast = [None, None]
+
+ def is_sym(_t):
+ return isinstance(_t, Symbol) or _t in (TOKEN_TRUE, TOKEN_FALSE, TOKEN_SYMBOL)
+
+ def is_operator(_t):
+ return _t in (TOKEN_AND, TOKEN_OR)
+
+ prev_token = None
+ for token_type, token_string, token_position in tokenized:
+ if TRACE_PARSE:
+ print(
+ "\nprocessing token_type:",
+ repr(token_type),
+ "token_string:",
+ repr(token_string),
+ "token_position:",
+ repr(token_position),
+ )
+
+ if prev_token:
+ prev_token_type, _prev_token_string, _prev_token_position = prev_token
+ if TRACE_PARSE:
+ print(" prev_token:", repr(prev_token))
+
+ if is_sym(prev_token_type) and (
+ is_sym(token_type)
+ ): # or token_type == TOKEN_LPAR) :
+ raise ParseError(
+ token_type, token_string, token_position, PARSE_INVALID_SYMBOL_SEQUENCE
+ )
+
+ if is_operator(prev_token_type) and (
+ is_operator(token_type) or token_type == TOKEN_RPAR
+ ):
+ raise ParseError(
+ token_type, token_string, token_position, PARSE_INVALID_OPERATOR_SEQUENCE
+ )
+
+ else:
+ if is_operator(token_type):
+ raise ParseError(
+ token_type, token_string, token_position, PARSE_INVALID_OPERATOR_SEQUENCE
+ )
+
+ if token_type == TOKEN_SYMBOL:
+ ast.append(self.Symbol(token_string))
+ if TRACE_PARSE:
+ print(" ast: token_type is TOKEN_SYMBOL: append new symbol", repr(ast))
+
+ elif isinstance(token_type, Symbol):
+ ast.append(token_type)
+ if TRACE_PARSE:
+ print(" ast: token_type is Symbol): append existing symbol", repr(ast))
+
+ elif token_type == TOKEN_TRUE:
+ ast.append(self.TRUE)
+ if TRACE_PARSE:
+ print(" ast: token_type is TOKEN_TRUE:", repr(ast))
+
+ elif token_type == TOKEN_FALSE:
+ ast.append(self.FALSE)
+ if TRACE_PARSE:
+ print(" ast: token_type is TOKEN_FALSE:", repr(ast))
+
+ elif token_type == TOKEN_NOT:
+ ast = [ast, self.NOT]
+ if TRACE_PARSE:
+ print(" ast: token_type is TOKEN_NOT:", repr(ast))
+
+ elif token_type == TOKEN_AND:
+ ast = self._start_operation(ast, self.AND, precedence)
+ if TRACE_PARSE:
+ print(" ast:token_type is TOKEN_AND: start_operation", ast)
+
+ elif token_type == TOKEN_OR:
+ ast = self._start_operation(ast, self.OR, precedence)
+ if TRACE_PARSE:
+ print(" ast:token_type is TOKEN_OR: start_operation", ast)
+
+ elif token_type == TOKEN_LPAR:
+ if prev_token:
+ # Check that an opening parens is preceded by a function
+ # or an opening parens
+ if prev_token_type not in (TOKEN_NOT, TOKEN_AND, TOKEN_OR, TOKEN_LPAR):
+ raise ParseError(
+ token_type, token_string, token_position, PARSE_INVALID_NESTING
+ )
+ ast = [ast, TOKEN_LPAR]
+
+ elif token_type == TOKEN_RPAR:
+ while True:
+ if ast[0] is None:
+ raise ParseError(
+ token_type,
+ token_string,
+ token_position,
+ PARSE_UNBALANCED_CLOSING_PARENS,
+ )
+
+ if ast[1] is TOKEN_LPAR:
+ ast[0].append(ast[2])
+ if TRACE_PARSE:
+ print("ast9:", repr(ast))
+ ast = ast[0]
+ if TRACE_PARSE:
+ print("ast10:", repr(ast))
+ break
+
+ if isinstance(ast[1], int):
+ raise ParseError(
+ token_type,
+ token_string,
+ token_position,
+ PARSE_UNBALANCED_CLOSING_PARENS,
+ )
+
+ # the parens are properly nested
+ # the top ast node should be a function subclass
+ if not (inspect.isclass(ast[1]) and issubclass(ast[1], Function)):
+ raise ParseError(
+ token_type, token_string, token_position, PARSE_INVALID_NESTING
+ )
+
+ subex = ast[1](*ast[2:])
+ ast[0].append(subex)
+ if TRACE_PARSE:
+ print("ast11:", repr(ast))
+ ast = ast[0]
+ if TRACE_PARSE:
+ print("ast12:", repr(ast))
+ else:
+ raise ParseError(token_type, token_string, token_position, PARSE_UNKNOWN_TOKEN)
+
+ prev_token = (token_type, token_string, token_position)
+
+ try:
+ while True:
+ if ast[0] is None:
+ if TRACE_PARSE:
+ print("ast[0] is None:", repr(ast))
+ if ast[1] is None:
+ if TRACE_PARSE:
+ print(" ast[1] is None:", repr(ast))
+ if len(ast) != 3:
+ raise ParseError(error_code=PARSE_INVALID_EXPRESSION)
+ parsed = ast[2]
+ if TRACE_PARSE:
+ print(" parsed = ast[2]:", repr(parsed))
+
+ else:
+ # call the function in ast[1] with the rest of the ast as args
+ parsed = ast[1](*ast[2:])
+ if TRACE_PARSE:
+ print(" parsed = ast[1](*ast[2:]):", repr(parsed))
+ break
+ else:
+ if TRACE_PARSE:
+ print("subex = ast[1](*ast[2:]):", repr(ast))
+ subex = ast[1](*ast[2:])
+ ast[0].append(subex)
+ if TRACE_PARSE:
+ print(" ast[0].append(subex):", repr(ast))
+ ast = ast[0]
+ if TRACE_PARSE:
+ print(" ast = ast[0]:", repr(ast))
+ except TypeError:
+ raise ParseError(error_code=PARSE_INVALID_EXPRESSION)
+
+ if simplify:
+ return parsed.simplify()
+
+ if TRACE_PARSE:
+ print("final parsed:", repr(parsed))
+ return parsed
+
+ def _start_operation(self, ast, operation, precedence):
+ """
+ Return an AST where all operations of lower precedence are finalized.
+ """
+ if TRACE_PARSE:
+ print(" start_operation:", repr(operation), "AST:", ast)
+
+ op_prec = precedence[operation]
+ while True:
+ if ast[1] is None:
+ # [None, None, x]
+ if TRACE_PARSE:
+ print(" start_op: ast[1] is None:", repr(ast))
+ ast[1] = operation
+ if TRACE_PARSE:
+ print(" --> start_op: ast[1] is None:", repr(ast))
+ return ast
+
+ prec = precedence[ast[1]]
+ if prec > op_prec: # op=&, [ast, |, x, y] -> [[ast, |, x], &, y]
+ if TRACE_PARSE:
+ print(" start_op: prec > op_prec:", repr(ast))
+ ast = [ast, operation, ast.pop(-1)]
+ if TRACE_PARSE:
+ print(" --> start_op: prec > op_prec:", repr(ast))
+ return ast
+
+ if prec == op_prec: # op=&, [ast, &, x] -> [ast, &, x]
+ if TRACE_PARSE:
+ print(" start_op: prec == op_prec:", repr(ast))
+ return ast
+
+ if not (inspect.isclass(ast[1]) and issubclass(ast[1], Function)):
+ # the top ast node should be a function subclass at this stage
+ raise ParseError(error_code=PARSE_INVALID_NESTING)
+
+ if ast[0] is None: # op=|, [None, &, x, y] -> [None, |, x&y]
+ if TRACE_PARSE:
+ print(" start_op: ast[0] is None:", repr(ast))
+ subexp = ast[1](*ast[2:])
+ new_ast = [ast[0], operation, subexp]
+ if TRACE_PARSE:
+ print(" --> start_op: ast[0] is None:", repr(new_ast))
+ return new_ast
+
+ else: # op=|, [[ast, &, x], ~, y] -> [ast, &, x, ~y]
+ if TRACE_PARSE:
+ print(" start_op: else:", repr(ast))
+ ast[0].append(ast[1](*ast[2:]))
+ ast = ast[0]
+ if TRACE_PARSE:
+ print(" --> start_op: else:", repr(ast))
+
+ def tokenize(self, expr):
+ """
+ Return an iterable of 3-tuple describing each token given an expression
+ unicode string.
+
+ This 3-tuple contains (token, token string, position):
+
+ - token: either a Symbol instance or one of TOKEN_* token types.
+ - token string: the original token unicode string.
+ - position: some simple object describing the starting position of the
+ original token string in the `expr` string. It can be an int for a
+ character offset, or a tuple of starting (row/line, column).
+
+ The token position is used only for error reporting and can be None or
+ empty.
+
+ Raise ParseError on errors. The ParseError.args is a tuple of:
+ (token_string, position, error message)
+
+ You can use this tokenizer as a base to create specialized tokenizers
+ for your custom algebra by subclassing BooleanAlgebra. See also the
+ tests for other examples of alternative tokenizers.
+
+ This tokenizer has these characteristics:
+
+ - The `expr` string can span multiple lines,
+ - Whitespace is not significant.
+ - The returned position is the starting character offset of a token.
+ - A TOKEN_SYMBOL is returned for valid identifiers which is a string
+ without spaces.
+
+ - These are valid identifiers:
+ - Python identifiers.
+ - a string even if starting with digits
+ - digits (except for 0 and 1).
+ - dotted names : foo.bar consist of one token.
+ - names with colons: foo:bar consist of one token.
+
+ - These are not identifiers:
+ - quoted strings.
+ - any punctuation which is not an operation
+
+ - Recognized operators are (in any upper/lower case combinations):
+
+ - for and: '*', '&', 'and'
+ - for or: '+', '|', 'or'
+ - for not: '~', '!', 'not'
+
+ - Recognized special symbols are (in any upper/lower case combinations):
+
+ - True symbols: 1 and True
+ - False symbols: 0, False and None
+ """
+ if not isinstance(expr, str):
+ raise TypeError(f"expr must be string but it is {type(expr)}.")
+
+ # mapping of lowercase token strings to a token type id for the standard
+ # operators, parens and common true or false symbols, as used in the
+ # default tokenizer implementation.
+ TOKENS = {
+ "*": TOKEN_AND,
+ "&": TOKEN_AND,
+ "and": TOKEN_AND,
+ "+": TOKEN_OR,
+ "|": TOKEN_OR,
+ "or": TOKEN_OR,
+ "~": TOKEN_NOT,
+ "!": TOKEN_NOT,
+ "not": TOKEN_NOT,
+ "(": TOKEN_LPAR,
+ ")": TOKEN_RPAR,
+ "[": TOKEN_LPAR,
+ "]": TOKEN_RPAR,
+ "true": TOKEN_TRUE,
+ "1": TOKEN_TRUE,
+ "false": TOKEN_FALSE,
+ "0": TOKEN_FALSE,
+ "none": TOKEN_FALSE,
+ }
+
+ position = 0
+ length = len(expr)
+
+ while position < length:
+ tok = expr[position]
+
+ sym = tok.isalnum() or tok == "_"
+ if sym:
+ position += 1
+ while position < length:
+ char = expr[position]
+ if char.isalnum() or char in self.allowed_in_token:
+ position += 1
+ tok += char
+ else:
+ break
+ position -= 1
+
+ try:
+ yield TOKENS[tok.lower()], tok, position
+ except KeyError:
+ if sym:
+ yield TOKEN_SYMBOL, tok, position
+ elif tok not in (" ", "\t", "\r", "\n"):
+ raise ParseError(
+ token_string=tok, position=position, error_code=PARSE_UNKNOWN_TOKEN
+ )
+
+ position += 1
+
+ def _recurse_distributive(self, expr, operation_inst):
+ """
+ Recursively flatten, simplify and apply the distributive laws to the
+ `expr` expression. Distributivity is considered for the AND or OR
+ `operation_inst` instance.
+ """
+ if expr.isliteral:
+ return expr
+
+ args = (self._recurse_distributive(arg, operation_inst) for arg in expr.args)
+ args = tuple(arg.simplify() for arg in args)
+ if len(args) == 1:
+ return args[0]
+
+ flattened_expr = expr.__class__(*args)
+
+ dualoperation = operation_inst.dual
+ if isinstance(flattened_expr, dualoperation):
+ flattened_expr = flattened_expr.distributive()
+ return flattened_expr
+
+ def normalize(self, expr, operation):
+ """
+ Return a normalized expression transformed to its normal form in the
+ given AND or OR operation.
+
+ The new expression arguments will satisfy these conditions:
+
+ - ``operation(*args) == expr`` (here mathematical equality is meant)
+ - the operation does not occur in any of its arg.
+ - NOT is only appearing in literals (aka. Negation normal form).
+
+ The operation must be an AND or OR operation or a subclass.
+ """
+ # Ensure that the operation is not NOT
+ assert operation in (
+ self.AND,
+ self.OR,
+ )
+ # Move NOT inwards.
+ expr = expr.literalize()
+ # Simplify first otherwise _recurse_distributive() may take forever.
+ expr = expr.simplify()
+ operation_example = operation(self.TRUE, self.FALSE)
+
+ # For large dual operations build up from normalized subexpressions,
+ # otherwise we can get exponential blowup midway through
+ expr.args = tuple(self.normalize(a, operation) for a in expr.args)
+ if len(expr.args) > 1 and (
+ (operation == self.AND and isinstance(expr, self.OR))
+ or (operation == self.OR and isinstance(expr, self.AND))
+ ):
+ args = expr.args
+ expr_class = expr.__class__
+ expr = args[0]
+ for arg in args[1:]:
+ expr = expr_class(expr, arg)
+ expr = self._recurse_distributive(expr, operation_example)
+ # Canonicalize
+ expr = expr.simplify()
+
+ else:
+ expr = self._recurse_distributive(expr, operation_example)
+ # Canonicalize
+ expr = expr.simplify()
+
+ return expr
+
+ def cnf(self, expr):
+ """
+ Return a conjunctive normal form of the `expr` expression.
+ """
+ return self.normalize(expr, self.AND)
+
+ conjunctive_normal_form = cnf
+
+ def dnf(self, expr):
+ """
+ Return a disjunctive normal form of the `expr` expression.
+ """
+ return self.normalize(expr, self.OR)
+
+ disjunctive_normal_form = dnf
+
+
+class Expression(object):
+ """
+ Abstract base class for all boolean expressions, including functions and
+ variable symbols.
+ """
+
+ # these class attributes are configured when a new BooleanAlgebra is created
+ TRUE = None
+ FALSE = None
+ NOT = None
+ AND = None
+ OR = None
+ Symbol = None
+
+ def __init__(self):
+ # Defines sort and comparison order between expressions arguments
+ self.sort_order = None
+
+ # Store arguments aka. subterms of this expressions.
+ # subterms are either literals or expressions.
+ self.args = tuple()
+
+ # True is this is a literal expression such as a Symbol, TRUE or FALSE
+ self.isliteral = False
+
+ # True if this expression has been simplified to in canonical form.
+ self.iscanonical = False
+
+ @property
+ def objects(self):
+ """
+ Return a set of all associated objects with this expression symbols.
+ Include recursively subexpressions objects.
+ """
+ return set(s.obj for s in self.symbols)
+
+ def get_literals(self):
+ """
+ Return a list of all the literals contained in this expression.
+ Include recursively subexpressions symbols.
+ This includes duplicates.
+ """
+ if self.isliteral:
+ return [self]
+ if not self.args:
+ return []
+ return list(itertools.chain.from_iterable(arg.get_literals() for arg in self.args))
+
+ @property
+ def literals(self):
+ """
+ Return a set of all literals contained in this expression.
+ Include recursively subexpressions literals.
+ """
+ return set(self.get_literals())
+
+ def literalize(self):
+ """
+ Return an expression where NOTs are only occurring as literals.
+ Applied recursively to subexpressions.
+ """
+ if self.isliteral:
+ return self
+ args = tuple(arg.literalize() for arg in self.args)
+ if all(arg is self.args[i] for i, arg in enumerate(args)):
+ return self
+
+ return self.__class__(*args)
+
+ def get_symbols(self):
+ """
+ Return a list of all the symbols contained in this expression.
+ Include subexpressions symbols recursively.
+ This includes duplicates.
+ """
+ return [s if isinstance(s, Symbol) else s.args[0] for s in self.get_literals()]
+
+ @property
+ def symbols(
+ self,
+ ):
+ """
+ Return a list of all the symbols contained in this expression.
+ Include subexpressions symbols recursively.
+ This includes duplicates.
+ """
+ return set(self.get_symbols())
+
+ def subs(self, substitutions, default=None, simplify=False):
+ """
+ Return an expression where all subterms of this expression are
+ by the new expression using a `substitutions` mapping of:
+ {expr: replacement}
+
+ Return the provided `default` value if this expression has no elements,
+ e.g. is empty.
+
+ Simplify the results if `simplify` is True.
+
+ Return this expression unmodified if nothing could be substituted. Note
+ that a possible usage of this function is to check for expression
+ containment as the expression will be returned unmodified if if does not
+ contain any of the provided substitutions.
+ """
+ # shortcut: check if we have our whole expression as a possible
+ # subsitution source
+ for expr, substitution in substitutions.items():
+ if expr == self:
+ return substitution
+
+ # otherwise, do a proper substitution of subexpressions
+ expr = self._subs(substitutions, default, simplify)
+ return self if expr is None else expr
+
+ def _subs(self, substitutions, default, simplify):
+ """
+ Return an expression where all subterms are substituted by the new
+ expression using a `substitutions` mapping of: {expr: replacement}
+ """
+ # track the new list of unchanged args or replaced args through
+ # a substitution
+ new_arguments = []
+ changed_something = False
+
+ # shortcut for basic logic True or False
+ if self is self.TRUE or self is self.FALSE:
+ return self
+
+ # if the expression has no elements, e.g. is empty, do not apply
+ # substitutions
+ if not self.args:
+ return default
+
+ # iterate the subexpressions: either plain symbols or a subexpressions
+ for arg in self.args:
+ # collect substitutions for exact matches
+ # break as soon as we have a match
+ for expr, substitution in substitutions.items():
+ if arg == expr:
+ new_arguments.append(substitution)
+ changed_something = True
+ break
+
+ # this will execute only if we did not break out of the
+ # loop, e.g. if we did not change anything and did not
+ # collect any substitutions
+ else:
+ # recursively call _subs on each arg to see if we get a
+ # substituted arg
+ new_arg = arg._subs(substitutions, default, simplify)
+ if new_arg is None:
+ # if we did not collect a substitution for this arg,
+ # keep the arg as-is, it is not replaced by anything
+ new_arguments.append(arg)
+ else:
+ # otherwise, we add the substitution for this arg instead
+ new_arguments.append(new_arg)
+ changed_something = True
+
+ if not changed_something:
+ return
+
+ # here we did some substitution: we return a new expression
+ # built from the new_arguments
+ newexpr = self.__class__(*new_arguments)
+ return newexpr.simplify() if simplify else newexpr
+
+ def simplify(self):
+ """
+ Return a new simplified expression in canonical form built from this
+ expression. The simplified expression may be exactly the same as this
+ expression.
+
+ Subclasses override this method to compute actual simplification.
+ """
+ return self
+
+ def __hash__(self):
+ """
+ Expressions are immutable and hashable. The hash of Functions is
+ computed by respecting the structure of the whole expression by mixing
+ the class name hash and the recursive hash of a frozenset of arguments.
+ Hash of elements is based on their boolean equivalent. Hash of symbols
+ is based on their object.
+ """
+ if not self.args:
+ arghash = id(self)
+ else:
+ arghash = hash(frozenset(map(hash, self.args)))
+ return hash(self.__class__.__name__) ^ arghash
+
+ def __eq__(self, other):
+ """
+ Test if other element is structurally the same as itself.
+
+ This method does not make any simplification or transformation, so it
+ will return False although the expression terms may be mathematically
+ equal. Use simplify() before testing equality to check the mathematical
+ equality.
+
+ For literals, plain equality is used.
+
+ For functions, equality uses the facts that operations are:
+
+ - commutative: order does not matter and different orders are equal.
+ - idempotent: so args can appear more often in one term than in the other.
+ """
+ if self is other:
+ return True
+
+ if isinstance(other, self.__class__):
+ return frozenset(self.args) == frozenset(other.args)
+
+ return NotImplemented
+
+ def __ne__(self, other):
+ return not self == other
+
+ def __lt__(self, other):
+ if self.sort_order is not None and other.sort_order is not None:
+ if self.sort_order == other.sort_order:
+ return NotImplemented
+ return self.sort_order < other.sort_order
+ return NotImplemented
+
+ def __gt__(self, other):
+ lt = other.__lt__(self)
+ if lt is NotImplemented:
+ self_lt = self.__lt__(other)
+ if self_lt is NotImplemented:
+ # `return not NotImplemented`` no longer works in Python 3.14
+ return False
+ else:
+ return not self_lt
+ return lt
+
+ def __and__(self, other):
+ return self.AND(self, other)
+
+ __mul__ = __and__
+
+ def __invert__(self):
+ return self.NOT(self)
+
+ def __or__(self, other):
+ return self.OR(self, other)
+
+ __add__ = __or__
+
+ def __bool__(self):
+ raise TypeError("Cannot evaluate expression as a Python Boolean.")
+
+ __nonzero__ = __bool__
+
+
+class BaseElement(Expression):
+ """
+ Abstract base class for the base elements TRUE and FALSE of the boolean
+ algebra.
+ """
+
+ def __init__(self):
+ super(BaseElement, self).__init__()
+ self.sort_order = 0
+ self.iscanonical = True
+ # The dual Base Element class for this element: TRUE.dual returns
+ # _FALSE() and FALSE.dual returns _TRUE(). This is a cyclic reference
+ # and therefore only assigned after creation of the singletons,
+ self.dual = None
+
+ def __lt__(self, other):
+ if isinstance(other, BaseElement):
+ return self == self.FALSE
+ return NotImplemented
+
+ __nonzero__ = __bool__ = lambda s: None
+
+ def pretty(self, indent=0, debug=False):
+ """
+ Return a pretty formatted representation of self.
+ """
+ return (" " * indent) + repr(self)
+
+
+class _TRUE(BaseElement):
+ """
+ Boolean base element TRUE.
+ Not meant to be subclassed nor instantiated directly.
+ """
+
+ def __init__(self):
+ super(_TRUE, self).__init__()
+ # assigned at singleton creation: self.dual = FALSE
+
+ def __hash__(self):
+ return hash(True)
+
+ def __eq__(self, other):
+ return self is other or other is True or isinstance(other, _TRUE)
+
+ def __str__(self):
+ return "1"
+
+ def __repr__(self):
+ return "TRUE"
+
+ def __call__(self):
+ return self
+
+ __nonzero__ = __bool__ = lambda s: True
+
+
+class _FALSE(BaseElement):
+ """
+ Boolean base element FALSE.
+ Not meant to be subclassed nor instantiated directly.
+ """
+
+ def __init__(self):
+ super(_FALSE, self).__init__()
+ # assigned at singleton creation: self.dual = TRUE
+
+ def __hash__(self):
+ return hash(False)
+
+ def __eq__(self, other):
+ return self is other or other is False or isinstance(other, _FALSE)
+
+ def __str__(self):
+ return "0"
+
+ def __repr__(self):
+ return "FALSE"
+
+ def __call__(self):
+ return self
+
+ __nonzero__ = __bool__ = lambda s: False
+
+
+class Symbol(Expression):
+ """
+ Boolean variable.
+
+ A Symbol can hold an object used to determine equality between symbols.
+ """
+
+ def __init__(self, obj):
+ super(Symbol, self).__init__()
+ self.sort_order = 5
+ # Store an associated object. This object determines equality
+ self.obj = obj
+ self.iscanonical = True
+ self.isliteral = True
+
+ def __call__(self, **kwargs):
+ """
+ Return the evaluated value for this symbol from kwargs
+ """
+ return kwargs[self.obj]
+
+ def __hash__(self):
+ if self.obj is None: # Anonymous Symbol.
+ return id(self)
+ return hash(self.obj)
+
+ def __eq__(self, other):
+ if self is other:
+ return True
+ if isinstance(other, self.__class__):
+ return self.obj == other.obj
+ return NotImplemented
+
+ def __lt__(self, other):
+ comparator = Expression.__lt__(self, other)
+ if comparator is not NotImplemented:
+ return comparator
+ if isinstance(other, Symbol):
+ return self.obj < other.obj
+ return NotImplemented
+
+ def __str__(self):
+ return str(self.obj)
+
+ def __repr__(self):
+ obj = f"'{self.obj}'" if isinstance(self.obj, str) else repr(self.obj)
+ return f"{self.__class__.__name__}({obj})"
+
+ def pretty(self, indent=0, debug=False):
+ """
+ Return a pretty formatted representation of self.
+ """
+ debug_details = ""
+ if debug:
+ debug_details += f""
+
+ obj = f"'{self.obj}'" if isinstance(self.obj, str) else repr(self.obj)
+ return (" " * indent) + f"{self.__class__.__name__}({debug_details}{obj})"
+
+
+class Function(Expression):
+ """
+ Boolean function.
+
+ A boolean function takes n (one or more) boolean expressions as arguments
+ where n is called the order of the function and maps them to one of the base
+ elements TRUE or FALSE. Implemented functions are AND, OR and NOT.
+ """
+
+ def __init__(self, *args):
+ super(Function, self).__init__()
+
+ # Specifies an infix notation of an operator for printing such as | or &.
+ self.operator = None
+
+ assert all(
+ isinstance(arg, Expression) for arg in args
+ ), f"Bad arguments: all arguments must be an Expression: {args!r}"
+ self.args = tuple(args)
+
+ def __str__(self):
+ args = self.args
+ if len(args) == 1:
+ if self.isliteral:
+ return f"{self.operator}{args[0]}"
+ return f"{self.operator}({args[0]})"
+
+ args_str = []
+ for arg in args:
+ if arg.isliteral:
+ args_str.append(str(arg))
+ else:
+ args_str.append(f"({arg})")
+
+ return self.operator.join(args_str)
+
+ def __repr__(self):
+ args = ", ".join(map(repr, self.args))
+ return f"{self.__class__.__name__}({args})"
+
+ def pretty(self, indent=0, debug=False):
+ """
+ Return a pretty formatted representation of self as an indented tree.
+
+ If debug is True, also prints debug information for each expression arg.
+
+ For example:
+
+ >>> print(BooleanAlgebra().parse(
+ ... u'not a and not b and not (a and ba and c) and c or c').pretty())
+ OR(
+ AND(
+ NOT(Symbol('a')),
+ NOT(Symbol('b')),
+ NOT(
+ AND(
+ Symbol('a'),
+ Symbol('ba'),
+ Symbol('c')
+ )
+ ),
+ Symbol('c')
+ ),
+ Symbol('c')
+ )
+ """
+ debug_details = ""
+ if debug:
+ debug_details += f">> class NOT2(NOT):
+ ... def __init__(self, *args):
+ ... super(NOT2, self).__init__(*args)
+ ... self.operator = '!'
+ """
+
+ def __init__(self, arg1):
+ super(NOT, self).__init__(arg1)
+ self.isliteral = isinstance(self.args[0], Symbol)
+ self.operator = "~"
+
+ def literalize(self):
+ """
+ Return an expression where NOTs are only occurring as literals.
+ """
+ expr = self.demorgan()
+ if isinstance(expr, self.__class__):
+ return expr
+ return expr.literalize()
+
+ def simplify(self):
+ """
+ Return a simplified expr in canonical form.
+
+ This means double negations are canceled out and all contained boolean
+ objects are in their canonical form.
+ """
+ if self.iscanonical:
+ return self
+
+ expr = self.cancel()
+ if not isinstance(expr, self.__class__):
+ return expr.simplify()
+
+ if expr.args[0] in (
+ self.TRUE,
+ self.FALSE,
+ ):
+ return expr.args[0].dual
+
+ expr = self.__class__(expr.args[0].simplify())
+ expr.iscanonical = True
+ return expr
+
+ def cancel(self):
+ """
+ Cancel itself and following NOTs as far as possible.
+ Returns the simplified expression.
+ """
+ expr = self
+ while True:
+ arg = expr.args[0]
+ if not isinstance(arg, self.__class__):
+ return expr
+ expr = arg.args[0]
+ if not isinstance(expr, self.__class__):
+ return expr
+
+ def demorgan(self):
+ """
+ Return a expr where the NOT function is moved inward.
+ This is achieved by canceling double NOTs and using De Morgan laws.
+ """
+ expr = self.cancel()
+ if expr.isliteral or not isinstance(expr, self.NOT):
+ return expr
+ op = expr.args[0]
+ return op.dual(*(self.__class__(arg).cancel() for arg in op.args))
+
+ def __call__(self, **kwargs):
+ """
+ Return the evaluated (negated) value for this function.
+ """
+ return not self.args[0](**kwargs)
+
+ def __lt__(self, other):
+ return self.args[0] < other
+
+ def pretty(self, indent=1, debug=False):
+ """
+ Return a pretty formatted representation of self.
+ Include additional debug details if `debug` is True.
+ """
+ debug_details = ""
+ if debug:
+ debug_details += f""
+ if self.isliteral:
+ pretty_literal = self.args[0].pretty(indent=0, debug=debug)
+ return (" " * indent) + f"{self.__class__.__name__}({debug_details}{pretty_literal})"
+ else:
+ return super(NOT, self).pretty(indent=indent, debug=debug)
+
+
+class DualBase(Function):
+ """
+ Base class for AND and OR function.
+
+ This class uses the duality principle to combine similar methods of AND
+ and OR. Both operations take two or more arguments and can be created using
+ "|" for OR and "&" for AND.
+ """
+
+ _pyoperator = None
+
+ def __init__(self, arg1, arg2, *args):
+ super(DualBase, self).__init__(arg1, arg2, *args)
+
+ # identity element for the specific operation.
+ # This will be TRUE for the AND operation and FALSE for the OR operation.
+ self.identity = None
+
+ # annihilator element for this function.
+ # This will be FALSE for the AND operation and TRUE for the OR operation.
+ self.annihilator = None
+
+ # dual class of this function.
+ # This means OR.dual returns AND and AND.dual returns OR.
+ self.dual = None
+
+ def __contains__(self, expr):
+ """
+ Test if expr is a subterm of this expression.
+ """
+ if expr in self.args:
+ return True
+
+ if isinstance(expr, self.__class__):
+ return all(arg in self.args for arg in expr.args)
+
+ def simplify(self, sort=True):
+ """
+ Return a new simplified expression in canonical form from this
+ expression.
+
+ For simplification of AND and OR fthe ollowing rules are used
+ recursively bottom up:
+
+ - Associativity (output does not contain same operations nested)::
+
+ (A & B) & C = A & (B & C) = A & B & C
+ (A | B) | C = A | (B | C) = A | B | C
+
+
+ - Annihilation::
+
+ A & 0 = 0, A | 1 = 1
+
+ - Idempotence (e.g. removing duplicates)::
+
+ A & A = A, A | A = A
+
+ - Identity::
+
+ A & 1 = A, A | 0 = A
+
+ - Complementation::
+
+ A & ~A = 0, A | ~A = 1
+
+ - Elimination::
+
+ (A & B) | (A & ~B) = A, (A | B) & (A | ~B) = A
+
+ - Absorption::
+
+ A & (A | B) = A, A | (A & B) = A
+
+ - Negative absorption::
+
+ A & (~A | B) = A & B, A | (~A & B) = A | B
+
+ - Commutativity (output is always sorted)::
+
+ A & B = B & A, A | B = B | A
+
+ Other boolean objects are also in their canonical form.
+ """
+ # TODO: Refactor DualBase.simplify into different "sub-evals".
+
+ # If self is already canonical do nothing.
+ if self.iscanonical:
+ return self
+
+ # Otherwise bring arguments into canonical form.
+ args = [arg.simplify() for arg in self.args]
+
+ # Create new instance of own class with canonical args.
+ # TODO: Only create new class if some args changed.
+ expr = self.__class__(*args)
+
+ # Literalize before doing anything, this also applies De Morgan's Law
+ expr = expr.literalize()
+
+ # Associativity:
+ # (A & B) & C = A & (B & C) = A & B & C
+ # (A | B) | C = A | (B | C) = A | B | C
+ expr = expr.flatten()
+
+ # Annihilation: A & 0 = 0, A | 1 = 1
+ if self.annihilator in expr.args:
+ return self.annihilator
+
+ # Idempotence: A & A = A, A | A = A
+ # this boils down to removing duplicates
+ args = []
+ for arg in expr.args:
+ if arg not in args:
+ args.append(arg)
+ if len(args) == 1:
+ return args[0]
+
+ # Identity: A & 1 = A, A | 0 = A
+ if self.identity in args:
+ args.remove(self.identity)
+ if len(args) == 1:
+ return args[0]
+
+ # Complementation: A & ~A = 0, A | ~A = 1
+ for arg in args:
+ if self.NOT(arg) in args:
+ return self.annihilator
+
+ # Elimination: (A & B) | (A & ~B) = A, (A | B) & (A | ~B) = A
+ i = 0
+ while i < len(args) - 1:
+ j = i + 1
+ ai = args[i]
+ if not isinstance(ai, self.dual):
+ i += 1
+ continue
+ while j < len(args):
+ aj = args[j]
+ if not isinstance(aj, self.dual) or len(ai.args) != len(aj.args):
+ j += 1
+ continue
+
+ # Find terms where only one arg is different.
+ negated = None
+ for arg in ai.args:
+ # FIXME: what does this pass Do?
+ if arg in aj.args:
+ pass
+ elif self.NOT(arg).cancel() in aj.args:
+ if negated is None:
+ negated = arg
+ else:
+ negated = None
+ break
+ else:
+ negated = None
+ break
+
+ # If the different arg is a negation simplify the expr.
+ if negated is not None:
+ # Cancel out one of the two terms.
+ del args[j]
+ aiargs = list(ai.args)
+ aiargs.remove(negated)
+ if len(aiargs) == 1:
+ args[i] = aiargs[0]
+ else:
+ args[i] = self.dual(*aiargs)
+
+ if len(args) == 1:
+ return args[0]
+ else:
+ # Now the other simplifications have to be redone.
+ return self.__class__(*args).simplify()
+ j += 1
+ i += 1
+
+ # Absorption: A & (A | B) = A, A | (A & B) = A
+ # Negative absorption: A & (~A | B) = A & B, A | (~A & B) = A | B
+ args = self.absorb(args)
+ if len(args) == 1:
+ return args[0]
+
+ # Commutativity: A & B = B & A, A | B = B | A
+ if sort:
+ args.sort()
+
+ # Create new (now canonical) expression.
+ expr = self.__class__(*args)
+ expr.iscanonical = True
+ return expr
+
+ def flatten(self):
+ """
+ Return a new expression where nested terms of this expression are
+ flattened as far as possible.
+
+ E.g.::
+
+ A & (B & C) becomes A & B & C.
+ """
+ args = list(self.args)
+ i = 0
+ for arg in self.args:
+ if isinstance(arg, self.__class__):
+ args[i : i + 1] = arg.args
+ i += len(arg.args)
+ else:
+ i += 1
+
+ return self.__class__(*args)
+
+ def absorb(self, args):
+ """
+ Given an `args` sequence of expressions, return a new list of expression
+ applying absorption and negative absorption.
+
+ See https://en.wikipedia.org/wiki/Absorption_law
+
+ Absorption::
+
+ A & (A | B) = A, A | (A & B) = A
+
+ Negative absorption::
+
+ A & (~A | B) = A & B, A | (~A & B) = A | B
+ """
+ args = list(args)
+ if not args:
+ args = list(self.args)
+ i = 0
+ while i < len(args):
+ absorber = args[i]
+ j = 0
+ while j < len(args):
+ if j == i:
+ j += 1
+ continue
+ target = args[j]
+ if not isinstance(target, self.dual):
+ j += 1
+ continue
+
+ # Absorption
+ if absorber in target:
+ del args[j]
+ if j < i:
+ i -= 1
+ continue
+
+ # Negative absorption
+ neg_absorber = self.NOT(absorber).cancel()
+ if neg_absorber in target:
+ b = target.subtract(neg_absorber, simplify=False)
+ if b is None:
+ del args[j]
+ if j < i:
+ i -= 1
+ continue
+ else:
+ if b in args:
+ del args[j]
+ if j < i:
+ i -= 1
+ else:
+ args[j] = b
+ j += 1
+ continue
+
+ if isinstance(absorber, self.dual):
+ remove = None
+ for arg in absorber.args:
+ narg = self.NOT(arg).cancel()
+ if arg in target.args:
+ pass
+ elif narg in target.args:
+ if remove is None:
+ remove = narg
+ else:
+ remove = None
+ break
+ else:
+ remove = None
+ break
+ if remove is not None:
+ args[j] = target.subtract(remove, simplify=True)
+ j += 1
+ i += 1
+
+ return args
+
+ def subtract(self, expr, simplify):
+ """
+ Return a new expression where the `expr` expression has been removed
+ from this expression if it exists.
+ """
+ args = self.args
+ if expr in self.args:
+ args = list(self.args)
+ args.remove(expr)
+ elif isinstance(expr, self.__class__):
+ if all(arg in self.args for arg in expr.args):
+ args = tuple(arg for arg in self.args if arg not in expr)
+ if len(args) == 0:
+ return None
+ if len(args) == 1:
+ return args[0]
+
+ newexpr = self.__class__(*args)
+ if simplify:
+ newexpr = newexpr.simplify()
+ return newexpr
+
+ def distributive(self):
+ """
+ Return a term where the leading AND or OR terms are switched.
+
+ This is done by applying the distributive laws::
+
+ A & (B|C) = (A&B) | (A&C)
+ A | (B&C) = (A|B) & (A|C)
+ """
+ dual = self.dual
+ args = list(self.args)
+ for i, arg in enumerate(args):
+ if isinstance(arg, dual):
+ args[i] = arg.args
+ else:
+ args[i] = (arg,)
+
+ prod = itertools.product(*args)
+ args = tuple(self.__class__(*arg).simplify() for arg in prod)
+
+ if len(args) == 1:
+ return args[0]
+ else:
+ return dual(*args)
+
+ def __lt__(self, other):
+ comparator = Expression.__lt__(self, other)
+ if comparator is not NotImplemented:
+ return comparator
+
+ if isinstance(other, self.__class__):
+ lenself = len(self.args)
+ lenother = len(other.args)
+ for i in range(min(lenself, lenother)):
+ if self.args[i] == other.args[i]:
+ continue
+
+ comparator = self.args[i] < other.args[i]
+ if comparator is not NotImplemented:
+ return comparator
+
+ if lenself != lenother:
+ return lenself < lenother
+ return NotImplemented
+
+ def __call__(self, **kwargs):
+ """
+ Return the evaluation of this expression by calling each of its arg as
+ arg(**kwargs) and applying its corresponding Python operator (and or or)
+ to the results.
+
+ Reduce is used as in e.g. AND(a, b, c, d) == AND(a, AND(b, AND(c, d)))
+ ore.g. OR(a, b, c, d) == OR(a, OR(b, OR(c, d)))
+ """
+ return reduce(self._pyoperator, (a(**kwargs) for a in self.args))
+
+
+class AND(DualBase):
+ """
+ Boolean AND operation, taking two or more arguments.
+
+ It can also be created by using "&" between two boolean expressions.
+
+ You can subclass to define alternative string representation by overriding
+ self.operator.
+
+ For example:
+
+ >>> class AND2(AND):
+ ... def __init__(self, *args):
+ ... super(AND2, self).__init__(*args)
+ ... self.operator = 'AND'
+ """
+
+ _pyoperator = and_operator
+
+ def __init__(self, arg1, arg2, *args):
+ super(AND, self).__init__(arg1, arg2, *args)
+ self.sort_order = 10
+ self.identity = self.TRUE
+ self.annihilator = self.FALSE
+ self.dual = self.OR
+ self.operator = "&"
+
+
+class OR(DualBase):
+ """
+ Boolean OR operation, taking two or more arguments
+
+ It can also be created by using "|" between two boolean expressions.
+
+ You can subclass to define alternative string representation by overriding
+ self.operator.
+
+ For example:
+
+ >>> class OR2(OR):
+ ... def __init__(self, *args):
+ ... super(OR2, self).__init__(*args)
+ ... self.operator = 'OR'
+ """
+
+ _pyoperator = or_operator
+
+ def __init__(self, arg1, arg2, *args):
+ super(OR, self).__init__(arg1, arg2, *args)
+ self.sort_order = 25
+ self.identity = self.FALSE
+ self.annihilator = self.TRUE
+ self.dual = self.AND
+ self.operator = "|"
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean/test_boolean.py b/Backend/venv/lib/python3.12/site-packages/boolean/test_boolean.py
new file mode 100644
index 00000000..93be5480
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean/test_boolean.py
@@ -0,0 +1,1352 @@
+"""
+Boolean Algebra.
+
+Tests
+
+Copyright (c) Sebastian Kraemer, basti.kr@gmail.com and others
+SPDX-License-Identifier: BSD-2-Clause
+"""
+
+import unittest
+from unittest.case import expectedFailure
+
+from boolean import (
+ TOKEN_AND,
+ TOKEN_FALSE,
+ TOKEN_LPAR,
+ TOKEN_NOT,
+ TOKEN_OR,
+ TOKEN_RPAR,
+ TOKEN_SYMBOL,
+ TOKEN_TRUE,
+ BooleanAlgebra,
+ ParseError,
+ Symbol,
+)
+from boolean.boolean import (
+ PARSE_INVALID_EXPRESSION,
+ PARSE_INVALID_NESTING,
+ PARSE_INVALID_OPERATOR_SEQUENCE,
+ PARSE_INVALID_SYMBOL_SEQUENCE,
+ PARSE_UNKNOWN_TOKEN,
+)
+
+
+class BooleanAlgebraTestCase(unittest.TestCase):
+ def test_creation(self):
+ algebra = BooleanAlgebra()
+ expr_str = "(a|b|c)&d&(~e|(f&g))"
+ expr = algebra.parse(expr_str)
+ assert str(expr) == expr_str
+
+ def test_parse_with_mixed_operators_multilines_and_custom_symbol(self):
+ class MySymbol(Symbol):
+ pass
+
+ expr_str = """(a or ~ b +_c ) and
+ d & ( ! e_
+ | (my * g OR 1 or 0) ) AND that """
+
+ algebra = BooleanAlgebra(Symbol_class=MySymbol)
+ expr = algebra.parse(expr_str)
+
+ expected = algebra.AND(
+ algebra.OR(
+ algebra.Symbol("a"),
+ algebra.NOT(algebra.Symbol("b")),
+ algebra.Symbol("_c"),
+ ),
+ algebra.Symbol("d"),
+ algebra.OR(
+ algebra.NOT(algebra.Symbol("e_")),
+ algebra.OR(
+ algebra.AND(
+ algebra.Symbol("my"),
+ algebra.Symbol("g"),
+ ),
+ algebra.TRUE,
+ algebra.FALSE,
+ ),
+ ),
+ algebra.Symbol("that"),
+ )
+
+ assert expr.pretty() == expected.pretty()
+ assert expr == expected
+
+ def test_parse_recognizes_trueish_and_falsish_symbol_tokens(self):
+ expr_str = "True or False or None or 0 or 1 or TRue or FalSE or NONe"
+ algebra = BooleanAlgebra()
+ expr = algebra.parse(expr_str)
+ expected = algebra.OR(
+ algebra.TRUE,
+ algebra.FALSE,
+ algebra.FALSE,
+ algebra.FALSE,
+ algebra.TRUE,
+ algebra.TRUE,
+ algebra.FALSE,
+ algebra.FALSE,
+ )
+ assert expr == expected
+
+ def test_parse_can_use_iterable_from_alternative_tokenizer(self):
+ class CustomSymbol(Symbol):
+ pass
+
+ class CustomAlgebra(BooleanAlgebra):
+ def __init__(self, Symbol_class=CustomSymbol):
+ super(CustomAlgebra, self).__init__(Symbol_class=Symbol_class)
+
+ def tokenize(self, s):
+ "Sample tokenizer using custom operators and symbols"
+ ops = {
+ "WHY_NOT": TOKEN_OR,
+ "ALSO": TOKEN_AND,
+ "NEITHER": TOKEN_NOT,
+ "(": TOKEN_LPAR,
+ ")": TOKEN_RPAR,
+ }
+
+ for row, line in enumerate(s.splitlines(False)):
+ for col, tok in enumerate(line.split()):
+ if tok in ops:
+ yield ops[tok], tok, (row, col)
+ elif tok == "Custom":
+ yield self.Symbol(tok), tok, (row, col)
+ else:
+ yield TOKEN_SYMBOL, tok, (row, col)
+
+ expr_str = """( Custom WHY_NOT regular ) ALSO NEITHER (
+ not_custom ALSO standard )
+ """
+
+ algebra = CustomAlgebra()
+ expr = algebra.parse(expr_str)
+ expected = algebra.AND(
+ algebra.OR(
+ algebra.Symbol("Custom"),
+ algebra.Symbol("regular"),
+ ),
+ algebra.NOT(
+ algebra.AND(
+ algebra.Symbol("not_custom"),
+ algebra.Symbol("standard"),
+ ),
+ ),
+ )
+ assert expr == expected
+
+ def test_parse_with_advanced_tokenizer_example(self):
+ import tokenize
+ from io import StringIO
+
+ class PlainVar(Symbol):
+ "Plain boolean variable"
+
+ class ColonDotVar(Symbol):
+ "Colon and dot-separated string boolean variable"
+
+ class AdvancedAlgebra(BooleanAlgebra):
+ def tokenize(self, expr):
+ """
+ Example custom tokenizer derived from the standard Python tokenizer
+ with a few extra features: #-style comments are supported and a
+ colon- and dot-separated string is recognized and stored in custom
+ symbols. In contrast with the standard tokenizer, only these
+ boolean operators are recognized : & | ! and or not.
+
+ For more advanced tokenization you could also consider forking the
+ `tokenize` standard library module.
+ """
+
+ if not isinstance(expr, str):
+ raise TypeError("expr must be string but it is %s." % type(expr))
+
+ # mapping of lowercase token strings to a token object instance for
+ # standard operators, parens and common true or false symbols
+ TOKENS = {
+ "&": TOKEN_AND,
+ "and": TOKEN_AND,
+ "|": TOKEN_OR,
+ "or": TOKEN_OR,
+ "!": TOKEN_NOT,
+ "not": TOKEN_NOT,
+ "(": TOKEN_LPAR,
+ ")": TOKEN_RPAR,
+ "true": TOKEN_TRUE,
+ "1": TOKEN_TRUE,
+ "false": TOKEN_FALSE,
+ "0": TOKEN_FALSE,
+ "none": TOKEN_FALSE,
+ }
+
+ ignored_token_types = (
+ tokenize.NL,
+ tokenize.NEWLINE,
+ tokenize.COMMENT,
+ tokenize.INDENT,
+ tokenize.DEDENT,
+ tokenize.ENDMARKER,
+ )
+
+ # note: an unbalanced expression may raise a TokenError here.
+ tokens = (
+ (
+ toktype,
+ tok,
+ row,
+ col,
+ )
+ for toktype, tok, (
+ row,
+ col,
+ ), _, _ in tokenize.generate_tokens(StringIO(expr).readline)
+ if tok and tok.strip()
+ )
+
+ COLON_DOT = (
+ ":",
+ ".",
+ )
+
+ def build_symbol(current_dotted):
+ if current_dotted:
+ if any(s in current_dotted for s in COLON_DOT):
+ sym = ColonDotVar(current_dotted)
+ else:
+ sym = PlainVar(current_dotted)
+ return sym
+
+ # accumulator for dotted symbols that span several `tokenize` tokens
+ dotted, srow, scol = "", None, None
+
+ for toktype, tok, row, col in tokens:
+ if toktype in ignored_token_types:
+ # we reached a break point and should yield the current dotted
+ symbol = build_symbol(dotted)
+ if symbol is not None:
+ yield symbol, dotted, (srow, scol)
+ dotted, srow, scol = "", None, None
+
+ continue
+
+ std_token = TOKENS.get(tok.lower())
+ if std_token is not None:
+ # we reached a break point and should yield the current dotted
+ symbol = build_symbol(dotted)
+ if symbol is not None:
+ yield symbol, dotted, (srow, scol)
+ dotted, srow, scol = "", 0, 0
+
+ yield std_token, tok, (row, col)
+
+ continue
+
+ if toktype == tokenize.NAME or (toktype == tokenize.OP and tok in COLON_DOT):
+ if not dotted:
+ srow = row
+ scol = col
+ dotted += tok
+
+ else:
+ raise TypeError(
+ "Unknown token: %(tok)r at line: %(row)r, column: %(col)r" % locals()
+ )
+
+ test_expr = """
+ (colon1:dot1.dot2 or colon2_name:col_on3:do_t1.do_t2.do_t3 )
+ and
+ ( plain_symbol & !Custom )
+ """
+
+ algebra = AdvancedAlgebra()
+ expr = algebra.parse(test_expr)
+ expected = algebra.AND(
+ algebra.OR(
+ ColonDotVar("colon1:dot1.dot2"),
+ ColonDotVar("colon2_name:col_on3:do_t1.do_t2.do_t3"),
+ ),
+ algebra.AND(PlainVar("plain_symbol"), algebra.NOT(PlainVar("Custom"))),
+ )
+ assert expr == expected
+
+ def test_allowing_additional_characters_in_tokens(self):
+ algebra = BooleanAlgebra(allowed_in_token=(".", "_", "-", "+"))
+ test_expr = "l-a AND b+c"
+
+ expr = algebra.parse(test_expr)
+ expected = algebra.AND(algebra.Symbol("l-a"), algebra.Symbol("b+c"))
+ assert expr == expected
+
+ def test_parse_raise_ParseError1(self):
+ algebra = BooleanAlgebra()
+ expr = "l-a AND none"
+
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_UNKNOWN_TOKEN
+
+ def test_parse_raise_ParseError2(self):
+ algebra = BooleanAlgebra()
+ expr = "(l-a + AND l-b"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_UNKNOWN_TOKEN
+
+ def test_parse_raise_ParseError3(self):
+ algebra = BooleanAlgebra()
+ expr = "(l-a + AND l-b)"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_UNKNOWN_TOKEN
+
+ def test_parse_raise_ParseError4(self):
+ algebra = BooleanAlgebra()
+ expr = "(l-a AND l-b"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_UNKNOWN_TOKEN
+
+ def test_parse_raise_ParseError5(self):
+ algebra = BooleanAlgebra()
+ expr = "(l-a + AND l-b))"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_UNKNOWN_TOKEN
+
+ def test_parse_raise_ParseError6(self):
+ algebra = BooleanAlgebra()
+ expr = "(l-a AND l-b))"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_UNKNOWN_TOKEN
+
+ def test_parse_raise_ParseError7(self):
+ algebra = BooleanAlgebra()
+ expr = "l-a AND"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_UNKNOWN_TOKEN
+
+ def test_parse_raise_ParseError8(self):
+ algebra = BooleanAlgebra()
+ expr = "OR l-a"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_INVALID_OPERATOR_SEQUENCE
+
+ def test_parse_raise_ParseError9(self):
+ algebra = BooleanAlgebra()
+ expr = "+ l-a"
+ try:
+ algebra.parse(expr)
+ self.fail("Exception should be raised when parsing '%s'" % expr)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_INVALID_OPERATOR_SEQUENCE
+
+ def test_parse_side_by_side_symbols_should_raise_exception_but_not(self):
+ algebra = BooleanAlgebra()
+ expr_str = "a or b c"
+ try:
+ algebra.parse(expr_str)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_INVALID_SYMBOL_SEQUENCE
+
+ def test_parse_side_by_side_symbols_should_raise_exception_but_not2(self):
+ algebra = BooleanAlgebra()
+ expr_str = "(a or b) c"
+ try:
+ algebra.parse(expr_str)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_INVALID_EXPRESSION
+
+ def test_parse_side_by_side_symbols_raise_exception(self):
+ algebra = BooleanAlgebra()
+ expr_str = "a b"
+ try:
+ algebra.parse(expr_str)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_INVALID_SYMBOL_SEQUENCE
+
+ def test_parse_side_by_side_symbols_with_parens_raise_exception(self):
+ algebra = BooleanAlgebra()
+ expr_str = "(a) (b)"
+ try:
+ algebra.parse(expr_str)
+ except ParseError as pe:
+ assert pe.error_code == PARSE_INVALID_NESTING
+
+
+class BaseElementTestCase(unittest.TestCase):
+ def test_creation(self):
+ from boolean.boolean import BaseElement
+
+ algebra = BooleanAlgebra()
+ assert algebra.TRUE == algebra.TRUE
+ BaseElement()
+ self.assertRaises(TypeError, BaseElement, 2)
+ self.assertRaises(TypeError, BaseElement, "a")
+ assert algebra.TRUE is algebra.TRUE
+ assert algebra.TRUE is not algebra.FALSE
+ assert algebra.FALSE is algebra.FALSE
+ assert bool(algebra.TRUE) is True
+ assert bool(algebra.FALSE) is False
+ assert algebra.TRUE == True
+ assert algebra.FALSE == False
+
+ def test_literals(self):
+ algebra = BooleanAlgebra()
+ assert algebra.TRUE.literals == set()
+ assert algebra.FALSE.literals == set()
+
+ def test_literalize(self):
+ algebra = BooleanAlgebra()
+ assert algebra.TRUE.literalize() == algebra.TRUE
+ assert algebra.FALSE.literalize() == algebra.FALSE
+
+ def test_simplify(self):
+ algebra = BooleanAlgebra()
+ assert algebra.TRUE.simplify() == algebra.TRUE
+ assert algebra.FALSE.simplify() == algebra.FALSE
+
+ def test_simplify_two_algebra(self):
+ algebra1 = BooleanAlgebra()
+ algebra2 = BooleanAlgebra()
+ assert algebra1.TRUE.simplify() == algebra2.TRUE
+ assert algebra1.FALSE.simplify() == algebra2.FALSE
+
+ def test_dual(self):
+ algebra = BooleanAlgebra()
+ assert algebra.TRUE.dual == algebra.FALSE
+ assert algebra.FALSE.dual == algebra.TRUE
+
+ def test_equality(self):
+ algebra = BooleanAlgebra()
+ assert algebra.TRUE == algebra.TRUE
+ assert algebra.FALSE == algebra.FALSE
+ assert algebra.TRUE != algebra.FALSE
+
+ def test_order(self):
+ algebra = BooleanAlgebra()
+ assert algebra.FALSE < algebra.TRUE
+ assert algebra.TRUE > algebra.FALSE
+
+ def test_printing(self):
+ algebra = BooleanAlgebra()
+ assert str(algebra.TRUE) == "1"
+ assert str(algebra.FALSE) == "0"
+ assert repr(algebra.TRUE) == "TRUE"
+ assert repr(algebra.FALSE) == "FALSE"
+
+
+class SymbolTestCase(unittest.TestCase):
+ def test_init(self):
+ Symbol(1)
+ Symbol("a")
+ Symbol(None)
+ Symbol(sum)
+ Symbol((1, 2, 3))
+ Symbol([1, 2])
+
+ def test_isliteral(self):
+ assert Symbol(1).isliteral is True
+
+ def test_literals(self):
+ l1 = Symbol(1)
+ l2 = Symbol(1)
+ assert l1 in l1.literals
+ assert l1 in l2.literals
+ assert l2 in l1.literals
+ assert l2 in l2.literals
+ self.assertRaises(AttributeError, setattr, l1, "literals", 1)
+
+ def test_literalize(self):
+ s = Symbol(1)
+ assert s.literalize() == s
+
+ def test_simplify(self):
+ s = Symbol(1)
+ assert s.simplify() == s
+
+ def test_simplify_different_instances(self):
+ s1 = Symbol(1)
+ s2 = Symbol(1)
+ assert s1.simplify() == s2.simplify()
+
+ def test_equal_symbols(self):
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ a2 = algebra.Symbol("a")
+
+ c = algebra.Symbol("b")
+ d = algebra.Symbol("d")
+ e = algebra.Symbol("e")
+
+ # Test __eq__.
+ assert a == a
+ assert a == a2
+ assert not a == c
+ assert not a2 == c
+ assert d == d
+ assert not d == e
+ assert not a == d
+ # Test __ne__.
+ assert not a != a
+ assert not a != a2
+ assert a != c
+ assert a2 != c
+
+ def test_order(self):
+ S = Symbol
+ assert S("x") < S("y")
+ assert S("y") > S("x")
+ assert S(1) < S(2)
+ assert S(2) > S(1)
+
+ def test_printing(self):
+ assert str(Symbol("a")) == "a"
+ assert str(Symbol(1)) == "1"
+ assert repr(Symbol("a")) == "Symbol('a')"
+ assert repr(Symbol(1)) == "Symbol(1)"
+
+
+class NOTTestCase(unittest.TestCase):
+ def test_init(self):
+ algebra = BooleanAlgebra()
+ self.assertRaises(TypeError, algebra.NOT)
+ self.assertRaises(TypeError, algebra.NOT, "a", "b")
+ algebra.NOT(algebra.Symbol("a"))
+ assert (algebra.NOT(algebra.TRUE)).simplify() == algebra.FALSE
+ assert (algebra.NOT(algebra.FALSE)).simplify() == algebra.TRUE
+
+ def test_isliteral(self):
+ algebra = BooleanAlgebra()
+ s = algebra.Symbol(1)
+ assert algebra.NOT(s).isliteral
+ assert not algebra.parse("~(a|b)").isliteral
+
+ def test_literals(self):
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ l = ~a
+ assert l.isliteral
+ assert l in l.literals
+ assert len(l.literals) == 1
+
+ l = algebra.parse("~(a&a)")
+ assert not l.isliteral
+ assert a in l.literals
+ assert len(l.literals) == 1
+
+ l = algebra.parse("~(a&a)", simplify=True)
+ assert l.isliteral
+
+ def test_literalize(self):
+ parse = BooleanAlgebra().parse
+ assert parse("~a") == parse("~a").literalize()
+ assert parse("~a|~b") == parse("~(a&b)").literalize()
+ assert parse("~a&~b") == parse("~(a|b)").literalize()
+
+ def test_simplify(self):
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ assert ~a == ~a
+ assert algebra.Symbol("a") == algebra.Symbol("a")
+ assert algebra.parse("~~a") != a
+ assert (~~a).simplify() == a
+ assert (~~~a).simplify() == ~a
+ assert (~~~~a).simplify() == a
+ assert (~(a & a & a)).simplify() == (~(a & a & a)).simplify()
+ assert algebra.parse("~~a", simplify=True) == a
+ algebra2 = BooleanAlgebra()
+ assert algebra2.parse("~~a", simplify=True) == a
+
+ def test_cancel(self):
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ assert (~a).cancel() == ~a
+ assert algebra.parse("~~a").cancel() == a
+ assert algebra.parse("~~~a").cancel() == ~a
+ assert algebra.parse("~~~~a").cancel() == a
+
+ def test_demorgan(self):
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ b = algebra.Symbol("b")
+ c = algebra.Symbol("c")
+ assert algebra.parse("~(a&b)").demorgan() == ~a | ~b
+ assert algebra.parse("~(a|b|c)").demorgan() == algebra.parse("~a&~b&~c")
+ assert algebra.parse("~(~a&b)").demorgan() == a | ~b
+ assert (~~(a & b | c)).demorgan() == a & b | c
+ assert (~~~(a & b | c)).demorgan() == ~(a & b) & ~c
+ assert algebra.parse("~" * 10 + "(a&b|c)").demorgan() == a & b | c
+ assert algebra.parse("~" * 11 + "(a&b|c)").demorgan() == (~(a & b | c)).demorgan()
+ _0 = algebra.FALSE
+ _1 = algebra.TRUE
+ assert (~(_0)).demorgan() == _1
+ assert (~(_1)).demorgan() == _0
+
+ def test_order(self):
+ algebra = BooleanAlgebra()
+ x = algebra.Symbol(1)
+ y = algebra.Symbol(2)
+ assert x < ~x
+ assert ~x > x
+ assert ~x < y
+ assert y > ~x
+
+ def test_printing(self):
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ assert str(~a) == "~a"
+ assert repr(~a) == "NOT(Symbol('a'))"
+ expr = algebra.parse("~(a&a)")
+ assert str(expr) == "~(a&a)"
+ assert repr(expr), "NOT(AND(Symbol('a') == Symbol('a')))"
+
+
+class DualBaseTestCase(unittest.TestCase):
+
+ maxDiff = None
+
+ def test_init(self):
+ from boolean.boolean import DualBase
+
+ a, b, c = Symbol("a"), Symbol("b"), Symbol("c")
+ t1 = DualBase(a, b)
+ t2 = DualBase(a, b, c)
+ t3 = DualBase(a, a)
+ t4 = DualBase(a, b, c)
+
+ self.assertRaises(TypeError, DualBase)
+ for term in (t1, t2, t3, t4):
+ assert isinstance(term, DualBase)
+
+ def test_isliteral(self):
+ from boolean.boolean import DualBase
+
+ a, b, c = Symbol("a"), Symbol("b"), Symbol("c")
+ t1 = DualBase(a, b)
+ t2 = DualBase(a, b, c)
+
+ assert not t1.isliteral
+ assert not t2.isliteral
+
+ def test_literals(self):
+ from boolean.boolean import DualBase
+
+ a, b, c = Symbol("a"), Symbol("b"), Symbol("c")
+ t1 = DualBase(a, b)
+ t2 = DualBase(a, b, c)
+ t3 = DualBase(a, a)
+ t4 = DualBase(a, b, c)
+
+ for term in (t1, t2, t3, t4):
+ assert a in term.literals
+ for term in (t1, t2, t4):
+ assert b in term.literals
+ for term in (t2, t4):
+ assert c in term.literals
+
+ def test_literalize(self):
+ parse = BooleanAlgebra().parse
+ assert parse("a|~(b|c)").literalize() == parse("a|(~b&~c)")
+
+ def test_annihilator(self):
+ algebra = BooleanAlgebra()
+ assert algebra.parse("a&a").annihilator == algebra.FALSE
+ assert algebra.parse("a|a").annihilator == algebra.TRUE
+
+ def test_identity(self):
+ algebra = BooleanAlgebra()
+ assert algebra.parse("a|b").identity == algebra.FALSE
+ assert algebra.parse("a&b").identity == algebra.TRUE
+
+ def test_dual(self):
+ algebra = BooleanAlgebra()
+ assert algebra.AND(algebra.Symbol("a"), algebra.Symbol("b")).dual == algebra.OR
+ assert algebra.OR(algebra.Symbol("a"), algebra.Symbol("b")).dual == algebra.AND
+
+ assert algebra.parse("a|b").dual == algebra.AND
+ assert algebra.parse("a&b").dual == algebra.OR
+
+ def test_simplify(self):
+ algebra1 = BooleanAlgebra()
+ algebra2 = BooleanAlgebra()
+ a = algebra1.Symbol("a")
+ b = algebra1.Symbol("b")
+ c = algebra1.Symbol("c")
+
+ _0 = algebra1.FALSE
+ _1 = algebra1.TRUE
+ # Idempotence
+ assert (a & a).simplify() == a
+ # Idempotence + Associativity
+ assert (a | (a | b)).simplify() == a | b
+ # Annihilation
+ assert (a & _0).simplify() == _0
+ assert (a | _1).simplify() == _1
+ # Identity
+ assert (a & _1).simplify() == a
+ assert (a | _0).simplify() == a
+ # Complementation
+ assert (a & ~a).simplify() == _0
+ assert (a | ~a).simplify() == _1
+ # Absorption
+ assert (a & (a | b)).simplify() == a
+ assert (a | (a & b)).simplify() == a
+ assert ((b & a) | (b & a & c)).simplify() == b & a
+
+ # Elimination
+ assert ((a & ~b) | (a & b)).simplify() == a
+
+ # Commutativity + Non-Commutativity
+ sorted_expression = (b & b & a).simplify()
+ unsorted_expression = (b & b & a).simplify(sort=False)
+ assert unsorted_expression == sorted_expression
+ assert sorted_expression.pretty() != unsorted_expression.pretty()
+
+ sorted_expression = (b | b | a).simplify()
+ unsorted_expression = (b | b | a).simplify(sort=False)
+ assert unsorted_expression == sorted_expression
+ assert sorted_expression.pretty() != unsorted_expression.pretty()
+
+ expected = algebra1.parse("(a&b)|(b&c)|(a&c)")
+ result = algebra1.parse("(~a&b&c) | (a&~b&c) | (a&b&~c) | (a&b&c)", simplify=True)
+ assert result == expected
+
+ expected = algebra1.parse("(a&b)|(b&c)|(a&c)")
+ result = algebra2.parse("(~a&b&c) | (a&~b&c) | (a&b&~c) | (a&b&c)", simplify=True)
+ assert result == expected
+
+ expected = algebra1.parse("b&d")
+ result = algebra1.parse("(a&b&c&d) | (b&d)", simplify=True)
+ assert result == expected
+
+ expected = algebra1.parse("b&d")
+ result = algebra2.parse("(a&b&c&d) | (b&d)", simplify=True)
+ assert result == expected
+
+ expected = algebra1.parse("(~b&~d&a) | (~c&~d&b) | (a&c&d)", simplify=True)
+ result = algebra1.parse(
+ """(~a&b&~c&~d) | (a&~b&~c&~d) | (a&~b&c&~d) |
+ (a&~b&c&d) | (a&b&~c&~d) | (a&b&c&d)""",
+ simplify=True,
+ )
+ assert result.pretty() == expected.pretty()
+
+ expected = algebra1.parse("(~b&~d&a) | (~c&~d&b) | (a&c&d)", simplify=True)
+ result = algebra2.parse(
+ """(~a&b&~c&~d) | (a&~b&~c&~d) | (a&~b&c&~d) |
+ (a&~b&c&d) | (a&b&~c&~d) | (a&b&c&d)""",
+ simplify=True,
+ )
+ assert result.pretty() == expected.pretty()
+
+ def test_absorption_invariant_to_order(self):
+ algebra = BooleanAlgebra()
+
+ a, b = algebra.symbols("a", "b")
+
+ e = (~a | ~b) & b & ~a
+ args = [
+ ~a | ~b,
+ ~a,
+ b,
+ ]
+
+ result_original = e.absorb(args)
+
+ args[1], args[2] = args[2], args[1]
+ result_swapped = e.absorb(args)
+
+ assert len(result_original) == 2
+ assert len(result_swapped) == 2
+ assert result_original[0] == result_swapped[1]
+ assert result_original[1] == result_swapped[0]
+
+ @expectedFailure
+ def test_parse_complex_expression_should_create_same_expression_as_python(self):
+ algebra = BooleanAlgebra()
+ a, b, c = algebra.symbols(*"abc")
+
+ test_expression_str = """(~a | ~b | ~c)"""
+ parsed = algebra.parse(test_expression_str)
+ test_expression = ~a | ~b | ~c # & ~d
+ # print()
+ # print('parsed')
+ # print(parsed.pretty())
+ # print('python')
+ # print(test_expression.pretty())
+ # we have a different behavior for expressions built from python expressions
+ # vs. expression built from an object tree vs. expression built from a parse
+ assert parsed.pretty() == test_expression.pretty()
+ assert parsed == test_expression
+
+ @expectedFailure
+ def test_simplify_complex_expression_parsed_with_simplify(self):
+ # FIXME: THIS SHOULD NOT FAIL
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ b = algebra.Symbol("b")
+ c = algebra.Symbol("c")
+ d = algebra.Symbol("d")
+
+ test_expression_str = """
+ (~a&~b&~c&~d) | (~a&~b&~c&d) | (~a&b&~c&~d) |
+ (~a&b&c&d) | (~a&b&~c&d) | (~a&b&c&~d) |
+ (a&~b&~c&d) | (~a&b&c&d) | (a&~b&c&d) | (a&b&c&d)
+ """
+
+ parsed = algebra.parse(test_expression_str, simplify=True)
+
+ test_expression = (
+ (~a & ~b & ~c & ~d)
+ | (~a & ~b & ~c & d)
+ | (~a & b & ~c & ~d)
+ | (~a & b & c & d)
+ | (~a & b & ~c & d)
+ | (~a & b & c & ~d)
+ | (a & ~b & ~c & d)
+ | (~a & b & c & d)
+ | (a & ~b & c & d)
+ | (a & b & c & d)
+ ).simplify()
+
+ # we have a different simplify behavior for expressions built from python expressions
+ # vs. expression built from an object tree vs. expression built from a parse
+ assert parsed.pretty() == test_expression.pretty()
+
+ @expectedFailure
+ def test_complex_expression_without_parens_parsed_or_built_in_python_should_be_identical(self):
+ # FIXME: THIS SHOULD NOT FAIL
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ b = algebra.Symbol("b")
+ c = algebra.Symbol("c")
+ d = algebra.Symbol("d")
+
+ test_expression_str = """
+ ~a&~b&~c&~d | ~a&~b&~c&d | ~a&b&~c&~d |
+ ~a&b&c&d | ~a&b&~c&d | ~a&b&c&~d |
+ a&~b&~c&d | ~a&b&c&d | a&~b&c&d | a&b&c&d
+ """
+
+ parsed = algebra.parse(test_expression_str)
+
+ test_expression = (
+ ~a & ~b & ~c & ~d
+ | ~a & ~b & ~c & d
+ | ~a & b & ~c & ~d
+ | ~a & b & c & d
+ | ~a & b & ~c & d
+ | ~a & b & c & ~d
+ | a & ~b & ~c & d
+ | ~a & b & c & d
+ | a & ~b & c & d
+ | a & b & c & d
+ )
+
+ assert parsed.pretty() == test_expression.pretty()
+
+ @expectedFailure
+ def test_simplify_complex_expression_parsed_then_simplified(self):
+ # FIXME: THIS SHOULD NOT FAIL
+
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ b = algebra.Symbol("b")
+ c = algebra.Symbol("c")
+ d = algebra.Symbol("d")
+ parse = algebra.parse
+
+ test_expression_str = "".join(
+ """
+ (~a&~b&~c&~d) | (~a&~b&~c&d) | (~a&b&~c&~d) |
+ (~a&b&c&d) | (~a&b&~c&d) | (~a&b&c&~d) |
+ (a&~b&~c&d) | (~a&b&c&d) | (a&~b&c&d) | (a&b&c&d)
+ """.split()
+ )
+
+ test_expression = (
+ (~a & ~b & ~c & ~d)
+ | (~a & ~b & ~c & d)
+ | (~a & b & ~c & ~d)
+ | (~a & b & c & d)
+ | (~a & b & ~c & d)
+ | (~a & b & c & ~d)
+ | (a & ~b & ~c & d)
+ | (~a & b & c & d)
+ | (a & ~b & c & d)
+ | (a & b & c & d)
+ )
+
+ parsed = parse(test_expression_str)
+ assert test_expression_str == str(parsed)
+
+ expected = (a & ~b & d) | (~a & b) | (~a & ~c) | (b & c & d)
+ assert test_expression.simplify().pretty() == expected.pretty()
+
+ parsed = parse(test_expression_str, simplify=True)
+
+ # FIXME: THIS SHOULD NOT FAIL
+ # we have a different simplify behavior for expressions built from python expressions
+ # vs. expression built from an object tree vs. expression built from a parse
+ assert parsed.simplify().pretty() == expected.simplify().pretty()
+
+ expected_str = "(a&~b&d)|(~a&b)|(~a&~c)|(b&c&d)"
+ assert str(parsed) == expected_str
+
+ parsed2 = parse(test_expression_str)
+ assert parsed2.simplify().pretty() == expected.pretty()
+
+ assert str(parsed2.simplify()) == expected_str
+
+ expected = algebra.OR(
+ algebra.AND(
+ algebra.NOT(algebra.Symbol("a")),
+ algebra.NOT(algebra.Symbol("b")),
+ algebra.NOT(algebra.Symbol("c")),
+ algebra.NOT(algebra.Symbol("d")),
+ ),
+ algebra.AND(
+ algebra.NOT(algebra.Symbol("a")),
+ algebra.NOT(algebra.Symbol("b")),
+ algebra.NOT(algebra.Symbol("c")),
+ algebra.Symbol("d"),
+ ),
+ algebra.AND(
+ algebra.NOT(algebra.Symbol("a")),
+ algebra.Symbol("b"),
+ algebra.NOT(algebra.Symbol("c")),
+ algebra.NOT(algebra.Symbol("d")),
+ ),
+ algebra.AND(
+ algebra.NOT(algebra.Symbol("a")),
+ algebra.Symbol("b"),
+ algebra.Symbol("c"),
+ algebra.Symbol("d"),
+ ),
+ algebra.AND(
+ algebra.NOT(algebra.Symbol("a")),
+ algebra.Symbol("b"),
+ algebra.NOT(algebra.Symbol("c")),
+ algebra.Symbol("d"),
+ ),
+ algebra.AND(
+ algebra.NOT(algebra.Symbol("a")),
+ algebra.Symbol("b"),
+ algebra.Symbol("c"),
+ algebra.NOT(algebra.Symbol("d")),
+ ),
+ algebra.AND(
+ algebra.Symbol("a"),
+ algebra.NOT(algebra.Symbol("b")),
+ algebra.NOT(algebra.Symbol("c")),
+ algebra.Symbol("d"),
+ ),
+ algebra.AND(
+ algebra.NOT(algebra.Symbol("a")),
+ algebra.Symbol("b"),
+ algebra.Symbol("c"),
+ algebra.Symbol("d"),
+ ),
+ algebra.AND(
+ algebra.Symbol("a"),
+ algebra.NOT(algebra.Symbol("b")),
+ algebra.Symbol("c"),
+ algebra.Symbol("d"),
+ ),
+ algebra.AND(
+ algebra.Symbol("a"), algebra.Symbol("b"), algebra.Symbol("c"), algebra.Symbol("d")
+ ),
+ )
+
+ result = parse(test_expression_str)
+ result = result.simplify()
+ assert result == expected
+
+ def test_parse_invalid_nested_and_should_raise_a_proper_exception(self):
+ algebra = BooleanAlgebra()
+ expr = """a (and b)"""
+
+ with self.assertRaises(ParseError) as context:
+ algebra.parse(expr)
+
+ assert context.exception.error_code == PARSE_INVALID_NESTING
+
+ def test_subtract(self):
+ parse = BooleanAlgebra().parse
+ expr = parse("a&b&c")
+ p1 = parse("b&d")
+ p2 = parse("a&c")
+ result = parse("b")
+ assert expr.subtract(p1, simplify=True) == expr
+ assert expr.subtract(p2, simplify=True) == result
+
+ def test_flatten(self):
+ parse = BooleanAlgebra().parse
+
+ t1 = parse("a & (b&c)")
+ t2 = parse("a&b&c")
+ assert t1 != t2
+ assert t1.flatten() == t2
+
+ t1 = parse("a | ((b&c) | (a&c)) | b")
+ t2 = parse("a | (b&c) | (a&c) | b")
+ assert t1 != t2
+ assert t1.flatten() == t2
+
+ def test_distributive(self):
+ algebra = BooleanAlgebra()
+ a = algebra.Symbol("a")
+ b = algebra.Symbol("b")
+ c = algebra.Symbol("c")
+ d = algebra.Symbol("d")
+ e = algebra.Symbol("e")
+ assert (a & (b | c)).distributive() == (a & b) | (a & c)
+ t1 = algebra.AND(a, (b | c), (d | e))
+ t2 = algebra.OR(
+ algebra.AND(a, b, d), algebra.AND(a, b, e), algebra.AND(a, c, d), algebra.AND(a, c, e)
+ )
+ assert t1.distributive() == t2
+
+ def test_equal(self):
+ from boolean.boolean import DualBase
+
+ a, b, c = Symbol("a"), Symbol("b"), Symbol("c")
+ t1 = DualBase(a, b)
+ t1_2 = DualBase(b, a)
+
+ t2 = DualBase(a, b, c)
+ t2_2 = DualBase(b, c, a)
+
+ # Test __eq__.
+ assert t1 == t1
+ assert t1_2 == t1
+ assert t2_2 == t2
+ assert not t1 == t2
+ assert not t1 == 1
+ assert not t1 is True
+ assert not t1 is None
+
+ # Test __ne__.
+ assert not t1 != t1
+ assert not t1_2 != t1
+ assert not t2_2 != t2
+ assert t1 != t2
+ assert t1 != 1
+ assert t1 is not True
+ assert t1 is not None
+
+ def test_order(self):
+ algebra = BooleanAlgebra()
+ x, y, z = algebra.Symbol(1), algebra.Symbol(2), algebra.Symbol(3)
+ assert algebra.AND(x, y) < algebra.AND(x, y, z)
+ assert not algebra.AND(x, y) > algebra.AND(x, y, z)
+ assert algebra.AND(x, y) < algebra.AND(x, z)
+ assert not algebra.AND(x, y) > algebra.AND(x, z)
+ assert algebra.AND(x, y) < algebra.AND(y, z)
+ assert not algebra.AND(x, y) > algebra.AND(y, z)
+ assert not algebra.AND(x, y) < algebra.AND(x, y)
+ assert not algebra.AND(x, y) > algebra.AND(x, y)
+
+ def test_printing(self):
+ parse = BooleanAlgebra().parse
+ assert str(parse("a&a")) == "a&a"
+ assert repr(parse("a&a")), "AND(Symbol('a') == Symbol('a'))"
+ assert str(parse("a|a")) == "a|a"
+ assert repr(parse("a|a")), "OR(Symbol('a') == Symbol('a'))"
+ assert str(parse("(a|b)&c")) == "(a|b)&c"
+ assert repr(parse("(a|b)&c")), "AND(OR(Symbol('a'), Symbol('b')) == Symbol('c'))"
+
+
+class OtherTestCase(unittest.TestCase):
+ def test_class_order(self):
+ # FIXME: this test is cryptic: what does it do?
+ algebra = BooleanAlgebra()
+ order = (
+ (algebra.TRUE, algebra.FALSE),
+ (algebra.Symbol("y"), algebra.Symbol("x")),
+ (algebra.parse("x&y"),),
+ (algebra.parse("x|y"),),
+ )
+ for i, tests in enumerate(order):
+ for case1 in tests:
+ for j in range(i + 1, len(order)):
+ for case2 in order[j]:
+ assert case1 < case2
+ assert case2 > case1
+
+ def test_parse(self):
+ algebra = BooleanAlgebra()
+ a, b, c = algebra.Symbol("a"), algebra.Symbol("b"), algebra.Symbol("c")
+ assert algebra.parse("0") == algebra.FALSE
+ assert algebra.parse("(0)") == algebra.FALSE
+ assert algebra.parse("1") == algebra.TRUE
+ assert algebra.parse("(1)") == algebra.TRUE
+ assert algebra.parse("a") == a
+ assert algebra.parse("(a)") == a
+ assert algebra.parse("(a)") == a
+ assert algebra.parse("~a") == algebra.parse("~(a)")
+ assert algebra.parse("~(a)") == algebra.parse("(~a)")
+ assert algebra.parse("~a") == ~a
+ assert algebra.parse("(~a)") == ~a
+ assert algebra.parse("~~a", simplify=True) == (~~a).simplify()
+ assert algebra.parse("a&b") == a & b
+ assert algebra.parse("~a&b") == ~a & b
+ assert algebra.parse("a&~b") == a & ~b
+ assert algebra.parse("a&b&c") == algebra.parse("a&b&c")
+ assert algebra.parse("a&b&c") == algebra.AND(a, b, c)
+ assert algebra.parse("~a&~b&~c") == algebra.parse("~a&~b&~c")
+ assert algebra.parse("~a&~b&~c") == algebra.AND(~a, ~b, ~c)
+ assert algebra.parse("a|b") == a | b
+ assert algebra.parse("~a|b") == ~a | b
+ assert algebra.parse("a|~b") == a | ~b
+ assert algebra.parse("a|b|c") == algebra.parse("a|b|c")
+ assert algebra.parse("a|b|c") == algebra.OR(a, b, c)
+ assert algebra.parse("~a|~b|~c") == algebra.OR(~a, ~b, ~c)
+ assert algebra.parse("(a|b)") == a | b
+ assert algebra.parse("a&(a|b)", simplify=True) == (a & (a | b)).simplify()
+ assert algebra.parse("a&(a|~b)", simplify=True) == (a & (a | ~b)).simplify()
+ assert (
+ algebra.parse("(a&b)|(b&((c|a)&(b|(c&a))))", simplify=True)
+ == ((a & b) | (b & ((c | a) & (b | (c & a))))).simplify()
+ )
+ assert algebra.parse("(a&b)|(b&((c|a)&(b|(c&a))))", simplify=True) == algebra.parse(
+ "a&b | b&(c|a)&(b|c&a)", simplify=True
+ )
+ assert algebra.Symbol("1abc") == algebra.parse("1abc")
+ assert algebra.Symbol("_abc") == algebra.parse("_abc")
+
+ def test_subs(self):
+ algebra = BooleanAlgebra()
+ a, b, c = algebra.Symbol("a"), algebra.Symbol("b"), algebra.Symbol("c")
+ expr = a & b | c
+ assert expr.subs({a: b}).simplify() == b | c
+ assert expr.subs({a: a}).simplify() == expr
+ assert expr.subs({a: b | c}).simplify() == algebra.parse("(b|c)&b|c").simplify()
+ assert expr.subs({a & b: a}).simplify() == a | c
+ assert expr.subs({c: algebra.TRUE}).simplify() == algebra.TRUE
+
+ def test_subs_default(self):
+ algebra = BooleanAlgebra()
+ a, b, c = algebra.Symbol("a"), algebra.Symbol("b"), algebra.Symbol("c")
+ expr = a & b | c
+ assert expr.subs({}, default=algebra.TRUE).simplify() == algebra.TRUE
+ assert (
+ expr.subs({a: algebra.FALSE, c: algebra.FALSE}, default=algebra.TRUE).simplify()
+ == algebra.FALSE
+ )
+ assert algebra.TRUE.subs({}, default=algebra.FALSE).simplify() == algebra.TRUE
+ assert algebra.FALSE.subs({}, default=algebra.TRUE).simplify() == algebra.FALSE
+
+ def test_normalize(self):
+ algebra = BooleanAlgebra()
+
+ expr = algebra.parse("a&b")
+ assert algebra.dnf(expr) == expr
+ assert algebra.cnf(expr) == expr
+
+ expr = algebra.parse("a|b")
+ assert algebra.dnf(expr) == expr
+ assert algebra.cnf(expr) == expr
+
+ expr = algebra.parse("(a&b)|(c&b)")
+ result_dnf = algebra.parse("(a&b)|(b&c)")
+ result_cnf = algebra.parse("b&(a|c)")
+ assert algebra.dnf(expr) == result_dnf
+ assert algebra.cnf(expr) == result_cnf
+
+ expr = algebra.parse("(a|b)&(c|b)")
+ result_dnf = algebra.parse("b|(a&c)")
+ result_cnf = algebra.parse("(a|b)&(b|c)")
+ assert algebra.dnf(expr) == result_dnf
+ assert algebra.cnf(expr) == result_cnf
+
+ expr = algebra.parse("((s|a)&(s|b)&(s|c)&(s|d)&(e|c|d))|(a&e&d)")
+ result = algebra.normalize(expr, expr.AND)
+ expected = algebra.parse("(a|s)&(b|e|s)&(c|d|e)&(c|e|s)&(d|s)")
+ assert expected == result
+
+ def test_get_literals_return_all_literals_in_original_order(self):
+ alg = BooleanAlgebra()
+ exp = alg.parse("a and b or a and c")
+ assert [
+ alg.Symbol("a"),
+ alg.Symbol("b"),
+ alg.Symbol("a"),
+ alg.Symbol("c"),
+ ] == exp.get_literals()
+
+ def test_get_symbols_return_all_symbols_in_original_order(self):
+ alg = BooleanAlgebra()
+ exp = alg.parse("a and b or True and a and c")
+ assert [
+ alg.Symbol("a"),
+ alg.Symbol("b"),
+ alg.Symbol("a"),
+ alg.Symbol("c"),
+ ] == exp.get_symbols()
+
+ def test_literals_return_set_of_unique_literals(self):
+ alg = BooleanAlgebra()
+ exp = alg.parse("a and b or a and c")
+ assert set([alg.Symbol("a"), alg.Symbol("b"), alg.Symbol("c")]) == exp.literals
+
+ def test_literals_and_negation(self):
+ alg = BooleanAlgebra()
+ exp = alg.parse("a and not b and not not c")
+ assert set([alg.Symbol("a"), alg.parse("not b"), alg.parse("not c")]) == exp.literals
+
+ def test_symbols_and_negation(self):
+ alg = BooleanAlgebra()
+ exp = alg.parse("a and not b and not not c")
+ assert set([alg.Symbol("a"), alg.Symbol("b"), alg.Symbol("c")]) == exp.symbols
+
+ def test_objects_return_set_of_unique_Symbol_objs(self):
+ alg = BooleanAlgebra()
+ exp = alg.parse("a and b or a and c")
+ assert set(["a", "b", "c"]) == exp.objects
+
+ def test_normalize_blowup(self):
+ from boolean import AND, NOT, OR
+ from collections import defaultdict
+
+ # Subclasses to count calls to simplify
+ class CountingNot(NOT):
+ def simplify(self):
+ counts["CountingNot"] += 1
+ return super().simplify()
+
+ class CountingAnd(AND):
+ def simplify(self, sort=True):
+ counts["CountingAnd"] += 1
+ return super().simplify(sort=sort)
+
+ class CountingOr(OR):
+ def simplify(self, sort=True):
+ counts["CountingOr"] += 1
+ return super().simplify(sort=sort)
+
+ counts = defaultdict(int)
+
+ # Real-world example of a complex expression with simple CNF/DNF form.
+ # Note this is a more reduced, milder version of the problem, for rapid
+ # testing.
+ formula = """
+ a & (
+ (b & c & d & e & f & g)
+ | (c & f & g & h & i & j)
+ | (c & d & f & g & i & l & o & u)
+ | (c & e & f & g & i & p & y & ~v)
+ | (c & f & g & i & j & z & ~(c & f & g & i & j & k))
+ | (c & f & g & t & ~(b & c & d & e & f & g))
+ | (c & f & g & ~t & ~(b & c & d & e & f & g))
+ )
+ """
+ algebra = BooleanAlgebra(
+ NOT_class=CountingNot,
+ AND_class=CountingAnd,
+ OR_class=CountingOr,
+ )
+
+ expr = algebra.parse(formula)
+ cnf = algebra.cnf(expr)
+ assert str(cnf) == "a&c&f&g"
+ # We should get exactly this count of calls.
+ # before we had a combinatorial explosion
+ assert counts == {"CountingAnd": 44, "CountingNot": 193, "CountingOr": 2490}
+
+
+class BooleanBoolTestCase(unittest.TestCase):
+ def test_bool(self):
+ algebra = BooleanAlgebra()
+ a, b, c = algebra.Symbol("a"), algebra.Symbol("b"), algebra.Symbol("c")
+ expr = a & b | c
+ self.assertRaises(TypeError, bool, expr.subs({a: algebra.TRUE}))
+ self.assertRaises(TypeError, bool, expr.subs({b: algebra.TRUE}))
+ self.assertRaises(TypeError, bool, expr.subs({c: algebra.TRUE}))
+ self.assertRaises(TypeError, bool, expr.subs({a: algebra.TRUE, b: algebra.TRUE}))
+ result = expr.subs({c: algebra.TRUE}, simplify=True)
+ result = result.simplify()
+ assert result == algebra.TRUE
+
+ result = expr.subs({a: algebra.TRUE, b: algebra.TRUE}, simplify=True)
+ result = result.simplify()
+ assert result == algebra.TRUE
+
+
+class CustomSymbolTestCase(unittest.TestCase):
+ def test_custom_symbol(self):
+ class CustomSymbol(Symbol):
+ def __init__(self, name, value="value"):
+ self.var = value
+ super(CustomSymbol, self).__init__(name)
+
+ try:
+ CustomSymbol("a", value="This is A")
+ except TypeError as e:
+ self.fail(e)
+
+
+class CallabilityTestCase(unittest.TestCase):
+ def test_and(self):
+ algebra = BooleanAlgebra()
+ exp = algebra.parse("a&b&c")
+ for a in [True, False]:
+ for b in [True, False]:
+ for c in [True, False]:
+ assert exp(a=a, b=b, c=c) == (a and b and c)
+
+ def test_or(self):
+ algebra = BooleanAlgebra()
+ exp = algebra.parse("a|b|c")
+ for a in [True, False]:
+ for b in [True, False]:
+ for c in [True, False]:
+ assert exp(a=a, b=b, c=c) == (a or b or c)
+
+ def test_not(self):
+ algebra = BooleanAlgebra()
+ exp = algebra.parse("!a")
+ for a in [True, False]:
+ assert exp(a=a) == (not a)
+
+ def test_symbol(self):
+ algebra = BooleanAlgebra()
+ exp = algebra.parse("a")
+ for a in [True, False]:
+ assert exp(a=a) == a
+
+ def test_composite(self):
+ algebra = BooleanAlgebra()
+ exp = algebra.parse("!(a|b&(a|!c))")
+ for a in [True, False]:
+ for b in [True, False]:
+ for c in [True, False]:
+ assert exp(a=a, b=b, c=c) == (not (a or b and (a or not c)))
+
+ def test_negate_A_or_B(self):
+ algebra = BooleanAlgebra()
+ exp = algebra.parse("!(a|b)")
+ for a in [True, False]:
+ for b in [True, False]:
+ assert exp(a=a, b=b) == (not (a or b))
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/METADATA
new file mode 100644
index 00000000..161b2c66
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/METADATA
@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: boolean.py
+Version: 5.0
+Summary: Define boolean algebras, create and parse boolean expressions and create custom boolean DSL.
+Home-page: https://github.com/bastikr/boolean.py
+Author: Sebastian Kraemer
+Author-email: basti.kr@gmail.com
+License: BSD-2-Clause
+Keywords: boolean expression,boolean algebra,logic,expression parser
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: README.rst
+License-File: CHANGELOG.rst
+Provides-Extra: testing
+Requires-Dist: pytest!=7.0.0,>=6; extra == "testing"
+Requires-Dist: pytest-xdist>=2; extra == "testing"
+Provides-Extra: dev
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Provides-Extra: linting
+Requires-Dist: black; extra == "linting"
+Requires-Dist: isort; extra == "linting"
+Requires-Dist: pycodestyle; extra == "linting"
+Provides-Extra: docs
+Requires-Dist: Sphinx>=3.3.1; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=0.5.0; extra == "docs"
+Requires-Dist: doc8>=0.8.1; extra == "docs"
+Requires-Dist: sphinxcontrib-apidoc>=0.3.0; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: summary
+
+
+
+This library helps you deal with boolean expressions and algebra with variables
+and the boolean functions AND, OR, NOT.
+
+You can parse expressions from strings and simplify and compare expressions.
+You can also easily create your custom algreba and mini DSL and create custom
+tokenizers to handle custom expressions.
+
+For extensive documentation look either into the docs directory or view it online, at
+https://booleanpy.readthedocs.org/en/latest/
+
+https://github.com/bastikr/boolean.py
+
+Copyright (c) 2009-2020 Sebastian Kraemer, basti.kr@gmail.com and others
+SPDX-License-Identifier: BSD-2-Clause
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/RECORD
new file mode 100644
index 00000000..ce54414f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/RECORD
@@ -0,0 +1,14 @@
+boolean/__init__.py,sha256=z1FOZZg2mXnYeAPS9csinA_JVjEI5GhhOGncVdoEqpA,657
+boolean/__pycache__/__init__.cpython-312.pyc,,
+boolean/__pycache__/boolean.cpython-312.pyc,,
+boolean/__pycache__/test_boolean.cpython-312.pyc,,
+boolean/boolean.py,sha256=6Wl7LT9Zci81eTiQYUtfSxGAifUQtyjnTS76av2Whlw,54740
+boolean/test_boolean.py,sha256=FXCBgBHKtY7rJOe8BZ-o1OS5xgj7tQKRAZWLtWZEr0c,47024
+boolean_py-5.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+boolean_py-5.0.dist-info/METADATA,sha256=nkOurhenMHOr7mHetfsmff3w7rZ9bjEjJwtSqsXth_o,2342
+boolean_py-5.0.dist-info/RECORD,,
+boolean_py-5.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+boolean_py-5.0.dist-info/licenses/CHANGELOG.rst,sha256=ZoWRYBmJ4IRdco2zn9y_AFMjllsaDbdYCYjaeOFjxRk,3036
+boolean_py-5.0.dist-info/licenses/LICENSE.txt,sha256=XqDN-M_IJLRGzM9Zf_ZRjDYHplnpgEvHXxJh-casSto,1321
+boolean_py-5.0.dist-info/licenses/README.rst,sha256=wVkJntSukf9-G6Q-Uve-9fq5Y97q5H5Nai7G_XPqTLs,2839
+boolean_py-5.0.dist-info/top_level.txt,sha256=K_8zC8vXmHwYzBbAvKPwu6nrmYI0TFM-kD-gR1qmxHE,8
diff --git a/Backend/venv/lib/python3.12/site-packages/PyMySQL-1.1.0.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/WHEEL
similarity index 65%
rename from Backend/venv/lib/python3.12/site-packages/PyMySQL-1.1.0.dist-info/WHEEL
rename to Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/WHEEL
index 1f37c02f..1eb3c49d 100644
--- a/Backend/venv/lib/python3.12/site-packages/PyMySQL-1.1.0.dist-info/WHEEL
+++ b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/WHEEL
@@ -1,5 +1,5 @@
Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: setuptools (78.1.0)
Root-Is-Purelib: true
Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/CHANGELOG.rst b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/CHANGELOG.rst
new file mode 100644
index 00000000..9696081a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/CHANGELOG.rst
@@ -0,0 +1,140 @@
+
+Changelog
+=========
+
+
+next
+----
+
+5.0 (2025-04-03)
+----------------
+
+* API changes
+
+ * Drop support for Python versions older than 3.9.
+ * Add support by testing on Python 3.11 to 3.14
+ * Fix absorption issues https://github.com/bastikr/boolean.py/issues/111 and
+ https://github.com/bastikr/boolean.py/issues/112
+
+
+
+4.0 (2022-05-05)
+----------------
+
+* API changes
+
+ * Drop support for Python 2.
+ * Test on Python 3.10
+ * Make Expression.sort_order an instance attributes and not a class attribute
+
+* Misc.
+
+ * Correct licensing documentation
+ * Improve docstringf and apply minor refactorings
+ * Adopt black code style and isort for imports
+ * Drop Travis and use GitHub actions for CI
+
+
+3.8 (2020-06-10)
+----------------
+
+* API changes
+
+ * Add support for evaluation of boolean expression.
+ Thank you to Lars van Gemerden @gemerden
+
+* Bug fixes
+
+ * Fix parsing of tokens that have a number as the first character.
+ Thank you to Jeff Cohen @ jcohen28
+ * Restore proper Python 2 compatibility.
+ Thank you to Benjy Weinberger @benjyw
+
+* Improve documentation
+
+ * Add pointers to Linux distro packages.
+ Thank you to Max Mehl @mxmehl and Carmen Bianca Bakker @carmenbianca
+ * Fix typo.
+ Thank you to Gabriel Niebler @der-gabe
+
+
+3.7 (2019-10-04)
+----------------
+
+* API changes
+
+ * Add new sort argument to simplify() to optionally not sort when simplifying
+ expressions (e.g. not applying "commutativity"). Thank you to Steven Esser
+ @majurg for this
+ * Add new argument to tokenizer to optionally accept extra characters in symbol
+ tokens. Thank you to @carpie for this
+
+
+3.6 (2018-08-06)
+----------------
+
+* No API changes
+
+* Bug fixes
+
+ * Fix De Morgan's laws effect on double negation propositions. Thank you to Douglas Cardoso for this
+ * Improve error checking when parsing
+
+
+3.5 (Nov 1, 2017)
+-----------------
+
+* No API changes
+
+* Bug fixes
+
+ * Documentation updates and add testing for Python 3.6. Thank you to Alexander Lisianoi @alisianoi
+ * Improve testng and expression equivalence checks
+ * Improve subs() method to an expression
+
+
+
+3.4 (May 12, 2017)
+------------------
+
+* No API changes
+
+* Bug fixes and improvements
+
+ * Fix various documentation typos and improve tests . Thank you to Alexander Lisianoi @alisianoi
+ * Fix handling for literals vs. symbols in negations Thank you to @YaronK
+
+
+3.3 (2017-02-09)
+----------------
+
+* API changes
+
+ * #40 and #50 Expression.subs() now takes 'default' thanks to @kronuz
+ * #45 simplify=False is now the default for parse and related functions or methods.
+ * #40 Use "&" and "|" as default operators
+
+* Bug fixes
+
+ * #60 Fix bug for "a or b c" which is not a valid expression
+ * #58 Fix math formula display in docs
+ * Improve handling of parse errors
+
+
+2.0.0 (2016-05-11)
+------------------
+
+* API changes
+
+ * New algebra definition. Refactored class hierarchy. Improved parsing.
+
+* New features
+
+ * possibility to subclass algebra definition
+ * new normal forms shortcuts for DNF and CNF.
+
+
+1.1 (2016-04-06)
+------------------
+
+* Initial release on Pypi.
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/LICENSE.txt b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/LICENSE.txt
new file mode 100644
index 00000000..23738369
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/LICENSE.txt
@@ -0,0 +1,23 @@
+Copyright (c) Sebastian Kraemer, basti.kr@gmail.com and others
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/README.rst b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/README.rst
new file mode 100644
index 00000000..b24e991b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/licenses/README.rst
@@ -0,0 +1,114 @@
+boolean.py
+==========
+
+"boolean.py" is a small library implementing a boolean algebra. It
+defines two base elements, TRUE and FALSE, and a Symbol class that can
+take on one of these two values. Calculations are done in terms of AND,
+OR and NOT - other compositions like XOR and NAND are not implemented
+but can be emulated with AND or and NOT. Expressions are constructed
+from parsed strings or in Python.
+
+It runs on Python 3.6+
+You can use older version 3.x for Python 2.7+ support.
+
+https://github.com/bastikr/boolean.py
+
+Build status: |Build Status|
+
+
+Example
+-------
+
+::
+
+ >>> import boolean
+ >>> algebra = boolean.BooleanAlgebra()
+ >>> expression1 = algebra.parse(u'apple and (oranges or banana) and not banana', simplify=False)
+ >>> expression1
+ AND(Symbol('apple'), OR(Symbol('oranges'), Symbol('banana')), NOT(Symbol('banana')))
+
+ >>> expression2 = algebra.parse('(oranges | banana) and not banana & apple', simplify=True)
+ >>> expression2
+ AND(Symbol('apple'), NOT(Symbol('banana')), Symbol('oranges'))
+
+ >>> expression1 == expression2
+ False
+ >>> expression1.simplify() == expression2
+ True
+
+
+Documentation
+-------------
+
+http://readthedocs.org/docs/booleanpy/en/latest/
+
+
+Installation
+------------
+
+Installation via pip
+~~~~~~~~~~~~~~~~~~~~
+
+To install boolean.py, you need to have the following pieces of software
+on your computer:
+
+- Python 3.6+
+- pip
+
+You then only need to run the following command:
+
+``pip install boolean.py``
+
+
+Installation via package managers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are packages available for easy install on some operating systems.
+You are welcome to help us package this tool for more distributions!
+
+- boolean.py has been packaged as Arch Linux, Fedora, openSus,
+ nixpkgs, Guix, DragonFly and FreeBSD
+ `packages `__ .
+
+In particular:
+
+- Arch Linux (AUR):
+ `python-boolean.py `__
+- Fedora:
+ `python-boolean.py `__
+- openSUSE:
+ `python-boolean.py `__
+
+
+Testing
+-------
+
+Test ``boolean.py`` with your current Python environment:
+
+``python setup.py test``
+
+Test with all of the supported Python environments using ``tox``:
+
+::
+
+ pip install -r requirements-dev.txt
+ tox
+
+If ``tox`` throws ``InterpreterNotFound``, limit it to python
+interpreters that are actually installed on your machine:
+
+::
+
+ tox -e py36
+
+Alternatively use pytest.
+
+
+License
+-------
+
+Copyright (c) Sebastian Kraemer, basti.kr@gmail.com and others
+SPDX-License-Identifier: BSD-2-Clause
+
+.. |Build Status| image:: https://travis-ci.org/bastikr/boolean.py.svg?branch=master
+ :target: https://travis-ci.org/bastikr/boolean.py
diff --git a/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/top_level.txt b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/top_level.txt
new file mode 100644
index 00000000..7b19ee8d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/boolean_py-5.0.dist-info/top_level.txt
@@ -0,0 +1 @@
+boolean
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/METADATA
new file mode 100644
index 00000000..9ae72989
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/METADATA
@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: CacheControl
+Version: 0.14.4
+Summary: httplib2 caching for requests
+Keywords: requests,http,caching,web
+Author: Eric Larson, Frost Ming, William Woodruff
+Author-email: Eric Larson , Frost Ming , William Woodruff
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Dist: requests>=2.16.0
+Requires-Dist: msgpack>=0.5.2,<2.0.0
+Requires-Dist: cachecontrol[filecache,redis] ; extra == 'dev'
+Requires-Dist: cherrypy ; extra == 'dev'
+Requires-Dist: cheroot>=11.1.2 ; extra == 'dev'
+Requires-Dist: codespell ; extra == 'dev'
+Requires-Dist: furo ; extra == 'dev'
+Requires-Dist: mypy ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: pytest-cov ; extra == 'dev'
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: sphinx ; extra == 'dev'
+Requires-Dist: sphinx-copybutton ; extra == 'dev'
+Requires-Dist: types-redis ; extra == 'dev'
+Requires-Dist: types-requests ; extra == 'dev'
+Requires-Dist: filelock>=3.8.0 ; extra == 'filecache'
+Requires-Dist: redis>=2.10.5 ; extra == 'redis'
+Requires-Python: >=3.10
+Project-URL: Homepage, https://pypi.org/project/CacheControl/
+Project-URL: Issues, https://github.com/psf/cachecontrol/issues
+Project-URL: Source, https://github.com/psf/cachecontrol
+Provides-Extra: dev
+Provides-Extra: filecache
+Provides-Extra: redis
+Description-Content-Type: text/x-rst
+
+..
+ SPDX-FileCopyrightText: SPDX-FileCopyrightText: 2015 Eric Larson
+
+ SPDX-License-Identifier: Apache-2.0
+
+==============
+ CacheControl
+==============
+
+.. image:: https://img.shields.io/pypi/v/cachecontrol.svg
+ :target: https://pypi.python.org/pypi/cachecontrol
+ :alt: Latest Version
+
+.. image:: https://github.com/psf/cachecontrol/actions/workflows/tests.yml/badge.svg
+ :target: https://github.com/psf/cachecontrol/actions/workflows/tests.yml
+
+CacheControl is a port of the caching algorithms in httplib2_ for use with
+requests_ session object.
+
+It was written because httplib2's better support for caching is often
+mitigated by its lack of thread safety. The same is true of requests in
+terms of caching.
+
+
+Quickstart
+==========
+
+.. code-block:: python
+
+ import requests
+
+ from cachecontrol import CacheControl
+
+
+ sess = requests.session()
+ cached_sess = CacheControl(sess)
+
+ response = cached_sess.get('https://google.com')
+
+If the URL contains any caching based headers, it will cache the
+result in a simple dictionary.
+
+For more info, check out the docs_
+
+.. _docs: http://cachecontrol.readthedocs.org/en/latest/
+.. _httplib2: https://github.com/httplib2/httplib2
+.. _requests: http://docs.python-requests.org/
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/RECORD
new file mode 100644
index 00000000..15cb96d7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/RECORD
@@ -0,0 +1,32 @@
+../../../bin/doesitcache,sha256=LAkUy8WeaPfL_WyyNHrqy09H01bOSM8481l-oiKVBGo,228
+cachecontrol-0.14.4.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+cachecontrol-0.14.4.dist-info/METADATA,sha256=o7eXpgH_41Bc5LDGNTY8zyaplZ8kkOkC-EGktZlrXMQ,3074
+cachecontrol-0.14.4.dist-info/RECORD,,
+cachecontrol-0.14.4.dist-info/WHEEL,sha256=w4ZtLaDgMAZW2MMZZwtH8zENekoQYBCeullI-zsXJQk,78
+cachecontrol-0.14.4.dist-info/entry_points.txt,sha256=HjCekaRCv8kfNqP5WehMR29IWxIA5VrhoOeKrCykCLc,56
+cachecontrol-0.14.4.dist-info/licenses/LICENSE.txt,sha256=hu7uh74qQ_P_H1ZJb0UfaSQ5JvAl_tuwM2ZsMExMFhs,558
+cachecontrol/__init__.py,sha256=aMPfN_9huuMwdL8qh269agzp2ugriVc2okgB4PGHcS0,702
+cachecontrol/__pycache__/__init__.cpython-312.pyc,,
+cachecontrol/__pycache__/_cmd.cpython-312.pyc,,
+cachecontrol/__pycache__/adapter.cpython-312.pyc,,
+cachecontrol/__pycache__/cache.cpython-312.pyc,,
+cachecontrol/__pycache__/controller.cpython-312.pyc,,
+cachecontrol/__pycache__/filewrapper.cpython-312.pyc,,
+cachecontrol/__pycache__/heuristics.cpython-312.pyc,,
+cachecontrol/__pycache__/serialize.cpython-312.pyc,,
+cachecontrol/__pycache__/wrapper.cpython-312.pyc,,
+cachecontrol/_cmd.py,sha256=4l2UbK9N85Vr_KTkF4LjvSlsr-TZnOXTfT2NODlIMtc,1672
+cachecontrol/adapter.py,sha256=VBORpVV3mQCLgGa5Mk531KtjoaYTZs4HBd222GfdL4o,6478
+cachecontrol/cache.py,sha256=OXwv7Fn2AwnKNiahJHnjtvaKLndvVLv_-zO-ltlV9qI,1953
+cachecontrol/caches/__init__.py,sha256=3-BaJBXjdt-4iFbv-799XjzRBsd6zF9wOEqOdDuAAro,279
+cachecontrol/caches/__pycache__/__init__.cpython-312.pyc,,
+cachecontrol/caches/__pycache__/file_cache.cpython-312.pyc,,
+cachecontrol/caches/__pycache__/redis_cache.cpython-312.pyc,,
+cachecontrol/caches/file_cache.py,sha256=0Df9CcKBaGjKF4dhkFGncLx-YHae0BOPd0jo67mG1rQ,4093
+cachecontrol/caches/redis_cache.py,sha256=94Qw4INGwjHcCDwMnOe0gbbcP2fttrlui-e1-Yutclw,1374
+cachecontrol/controller.py,sha256=qZF9BOy_aDElMAXPejH5ohixTgkxYkXWPoB0Ocer_Vk,19030
+cachecontrol/filewrapper.py,sha256=DhxC_rSk-beKdbsYhfvBUDovQHX9r3gHH_jP9-q_mKk,4354
+cachecontrol/heuristics.py,sha256=ccecGyeEycWDY_Kfnx41ebYl7eSdDCLM5X6Sx0f5fZE,4869
+cachecontrol/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cachecontrol/serialize.py,sha256=dP5k_UKYUAano6TKG9qlbKHbFMonz0AV_lYR3IFCGMg,5110
+cachecontrol/wrapper.py,sha256=KyaQ4Bq1RqsX-zA4pXH62nmcU511ECIGn5gCvmNIj20,1328
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/WHEEL
new file mode 100644
index 00000000..fedee5b3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/WHEEL
@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.9
+Root-Is-Purelib: true
+Tag: py3-none-any
\ No newline at end of file
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/entry_points.txt b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/entry_points.txt
new file mode 100644
index 00000000..7c31574e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/entry_points.txt
@@ -0,0 +1,3 @@
+[console_scripts]
+doesitcache = cachecontrol._cmd:main
+
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/licenses/LICENSE.txt b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/licenses/LICENSE.txt
new file mode 100644
index 00000000..d8b3b56d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol-0.14.4.dist-info/licenses/LICENSE.txt
@@ -0,0 +1,13 @@
+Copyright 2012-2021 Eric Larson
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__init__.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__init__.py
new file mode 100644
index 00000000..4d3837ae
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__init__.py
@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""CacheControl import Interface.
+
+Make it easy to import from cachecontrol without long namespaces.
+"""
+
+import importlib.metadata
+
+from cachecontrol.adapter import CacheControlAdapter
+from cachecontrol.controller import CacheController
+from cachecontrol.wrapper import CacheControl
+
+__author__ = "Eric Larson"
+__email__ = "eric@ionrock.org"
+__version__ = importlib.metadata.version("cachecontrol")
+
+__all__ = [
+ "__author__",
+ "__email__",
+ "__version__",
+ "CacheControlAdapter",
+ "CacheController",
+ "CacheControl",
+]
+
+import logging
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..ab3deec6
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/_cmd.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/_cmd.cpython-312.pyc
new file mode 100644
index 00000000..993964ef
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/_cmd.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/adapter.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/adapter.cpython-312.pyc
new file mode 100644
index 00000000..9012bb5b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/adapter.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/cache.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/cache.cpython-312.pyc
new file mode 100644
index 00000000..5a3dd89e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/cache.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/controller.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/controller.cpython-312.pyc
new file mode 100644
index 00000000..532b7d54
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/controller.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/filewrapper.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/filewrapper.cpython-312.pyc
new file mode 100644
index 00000000..2a884481
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/filewrapper.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/heuristics.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/heuristics.cpython-312.pyc
new file mode 100644
index 00000000..c05fcf74
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/heuristics.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/serialize.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/serialize.cpython-312.pyc
new file mode 100644
index 00000000..458e93b9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/serialize.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/wrapper.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/wrapper.cpython-312.pyc
new file mode 100644
index 00000000..1cb6abfb
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/__pycache__/wrapper.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/_cmd.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/_cmd.py
new file mode 100644
index 00000000..684a4a8b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/_cmd.py
@@ -0,0 +1,70 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+import logging
+from argparse import ArgumentParser
+from typing import TYPE_CHECKING
+
+import requests
+
+from cachecontrol.adapter import CacheControlAdapter
+from cachecontrol.cache import DictCache
+from cachecontrol.controller import logger
+
+if TYPE_CHECKING:
+ from argparse import Namespace
+
+ from cachecontrol.controller import CacheController
+
+
+def setup_logging() -> None:
+ logger.setLevel(logging.DEBUG)
+ handler = logging.StreamHandler()
+ logger.addHandler(handler)
+
+
+def get_session() -> requests.Session:
+ adapter = CacheControlAdapter(
+ DictCache(), cache_etags=True, serializer=None, heuristic=None
+ )
+ sess = requests.Session()
+ sess.mount("http://", adapter)
+ sess.mount("https://", adapter)
+
+ sess.cache_controller = adapter.controller # type: ignore[attr-defined]
+ return sess
+
+
+def get_args() -> Namespace:
+ parser = ArgumentParser()
+ parser.add_argument("url", help="The URL to try and cache")
+ return parser.parse_args()
+
+
+def main() -> None:
+ args = get_args()
+ sess = get_session()
+
+ # Make a request to get a response
+ resp = sess.get(args.url)
+
+ # Turn on logging
+ setup_logging()
+
+ # try setting the cache
+ cache_controller: CacheController = (
+ sess.cache_controller # type: ignore[attr-defined]
+ )
+ cache_controller.cache_response(resp.request, resp.raw)
+
+ # Now try to get it
+ if cache_controller.cached_request(resp.request):
+ print("Cached!")
+ else:
+ print("Not cached :(")
+
+
+if __name__ == "__main__":
+ main()
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/adapter.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/adapter.py
new file mode 100644
index 00000000..4f4c185a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/adapter.py
@@ -0,0 +1,167 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+import functools
+import weakref
+import zlib
+from typing import TYPE_CHECKING, Any, Collection, Mapping
+
+from requests.adapters import HTTPAdapter
+
+from cachecontrol.cache import DictCache
+from cachecontrol.controller import PERMANENT_REDIRECT_STATUSES, CacheController
+from cachecontrol.filewrapper import CallbackFileWrapper
+
+if TYPE_CHECKING:
+ from requests import PreparedRequest, Response
+ from urllib3 import HTTPResponse
+
+ from cachecontrol.cache import BaseCache
+ from cachecontrol.heuristics import BaseHeuristic
+ from cachecontrol.serialize import Serializer
+
+
+class CacheControlAdapter(HTTPAdapter):
+ invalidating_methods = {"PUT", "PATCH", "DELETE"}
+
+ def __init__(
+ self,
+ cache: BaseCache | None = None,
+ cache_etags: bool = True,
+ controller_class: type[CacheController] | None = None,
+ serializer: Serializer | None = None,
+ heuristic: BaseHeuristic | None = None,
+ cacheable_methods: Collection[str] | None = None,
+ *args: Any,
+ **kw: Any,
+ ) -> None:
+ super().__init__(*args, **kw)
+ self.cache = DictCache() if cache is None else cache
+ self.heuristic = heuristic
+ self.cacheable_methods = cacheable_methods or ("GET",)
+
+ controller_factory = controller_class or CacheController
+ self.controller = controller_factory(
+ self.cache, cache_etags=cache_etags, serializer=serializer
+ )
+
+ def send(
+ self,
+ request: PreparedRequest,
+ stream: bool = False,
+ timeout: None | float | tuple[float, float] | tuple[float, None] = None,
+ verify: bool | str = True,
+ cert: (None | bytes | str | tuple[bytes | str, bytes | str]) = None,
+ proxies: Mapping[str, str] | None = None,
+ cacheable_methods: Collection[str] | None = None,
+ ) -> Response:
+ """
+ Send a request. Use the request information to see if it
+ exists in the cache and cache the response if we need to and can.
+ """
+ cacheable = cacheable_methods or self.cacheable_methods
+ if request.method in cacheable:
+ try:
+ cached_response = self.controller.cached_request(request)
+ except zlib.error:
+ cached_response = None
+ if cached_response:
+ return self.build_response(request, cached_response, from_cache=True)
+
+ # check for etags and add headers if appropriate
+ request.headers.update(self.controller.conditional_headers(request))
+
+ resp = super().send(request, stream, timeout, verify, cert, proxies)
+
+ return resp
+
+ def build_response( # type: ignore[override]
+ self,
+ request: PreparedRequest,
+ response: HTTPResponse,
+ from_cache: bool = False,
+ cacheable_methods: Collection[str] | None = None,
+ ) -> Response:
+ """
+ Build a response by making a request or using the cache.
+
+ This will end up calling send and returning a potentially
+ cached response
+ """
+ cacheable = cacheable_methods or self.cacheable_methods
+ if not from_cache and request.method in cacheable:
+ # Check for any heuristics that might update headers
+ # before trying to cache.
+ if self.heuristic:
+ response = self.heuristic.apply(response)
+
+ # apply any expiration heuristics
+ if response.status == 304:
+ # We must have sent an ETag request. This could mean
+ # that we've been expired already or that we simply
+ # have an etag. In either case, we want to try and
+ # update the cache if that is the case.
+ cached_response = self.controller.update_cached_response(
+ request, response
+ )
+
+ if cached_response is not response:
+ from_cache = True
+
+ # We are done with the server response, read a
+ # possible response body (compliant servers will
+ # not return one, but we cannot be 100% sure) and
+ # release the connection back to the pool.
+ response.read(decode_content=False)
+ response.release_conn()
+
+ response = cached_response
+
+ # We always cache the 301 responses
+ elif int(response.status) in PERMANENT_REDIRECT_STATUSES:
+ self.controller.cache_response(request, response)
+ else:
+ # Wrap the response file with a wrapper that will cache the
+ # response when the stream has been consumed.
+ response._fp = CallbackFileWrapper( # type: ignore[assignment]
+ response._fp, # type: ignore[arg-type]
+ functools.partial(
+ self.controller.cache_response, request, weakref.ref(response)
+ ),
+ )
+ if response.chunked:
+ super_update_chunk_length = response.__class__._update_chunk_length
+
+ def _update_chunk_length(
+ weak_self: weakref.ReferenceType[HTTPResponse],
+ ) -> None:
+ self = weak_self()
+ if self is None:
+ return
+
+ super_update_chunk_length(self)
+ if self.chunk_left == 0:
+ self._fp._close() # type: ignore[union-attr]
+
+ response._update_chunk_length = functools.partial( # type: ignore[method-assign]
+ _update_chunk_length, weakref.ref(response)
+ )
+
+ resp: Response = super().build_response(request, response)
+
+ # See if we should invalidate the cache.
+ if request.method in self.invalidating_methods and resp.ok:
+ assert request.url is not None
+ cache_url = self.controller.cache_url(request.url)
+ self.cache.delete(cache_url)
+
+ # Give the request a from_cache attr to let people use it
+ resp.from_cache = from_cache # type: ignore[attr-defined]
+
+ return resp
+
+ def close(self) -> None:
+ self.cache.close()
+ super().close() # type: ignore[no-untyped-call]
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/cache.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/cache.py
new file mode 100644
index 00000000..91598e92
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/cache.py
@@ -0,0 +1,75 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+The cache object API for implementing caches. The default is a thread
+safe in-memory dictionary.
+"""
+
+from __future__ import annotations
+
+from threading import Lock
+from typing import IO, TYPE_CHECKING, MutableMapping
+
+if TYPE_CHECKING:
+ from datetime import datetime
+
+
+class BaseCache:
+ def get(self, key: str) -> bytes | None:
+ raise NotImplementedError()
+
+ def set(
+ self, key: str, value: bytes, expires: int | datetime | None = None
+ ) -> None:
+ raise NotImplementedError()
+
+ def delete(self, key: str) -> None:
+ raise NotImplementedError()
+
+ def close(self) -> None:
+ pass
+
+
+class DictCache(BaseCache):
+ def __init__(self, init_dict: MutableMapping[str, bytes] | None = None) -> None:
+ self.lock = Lock()
+ self.data = init_dict or {}
+
+ def get(self, key: str) -> bytes | None:
+ return self.data.get(key, None)
+
+ def set(
+ self, key: str, value: bytes, expires: int | datetime | None = None
+ ) -> None:
+ with self.lock:
+ self.data.update({key: value})
+
+ def delete(self, key: str) -> None:
+ with self.lock:
+ if key in self.data:
+ self.data.pop(key)
+
+
+class SeparateBodyBaseCache(BaseCache):
+ """
+ In this variant, the body is not stored mixed in with the metadata, but is
+ passed in (as a bytes-like object) in a separate call to ``set_body()``.
+
+ That is, the expected interaction pattern is::
+
+ cache.set(key, serialized_metadata)
+ cache.set_body(key)
+
+ Similarly, the body should be loaded separately via ``get_body()``.
+ """
+
+ def set_body(self, key: str, body: bytes) -> None:
+ raise NotImplementedError()
+
+ def get_body(self, key: str) -> IO[bytes] | None:
+ """
+ Return the body as file-like object.
+ """
+ raise NotImplementedError()
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__init__.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__init__.py
new file mode 100644
index 00000000..44a1af87
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__init__.py
@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from cachecontrol.caches.file_cache import FileCache, SeparateBodyFileCache
+from cachecontrol.caches.redis_cache import RedisCache
+
+__all__ = ["FileCache", "SeparateBodyFileCache", "RedisCache"]
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..85eb0cc2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/file_cache.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/file_cache.cpython-312.pyc
new file mode 100644
index 00000000..ba0dc269
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/file_cache.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/redis_cache.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/redis_cache.cpython-312.pyc
new file mode 100644
index 00000000..602380ea
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/__pycache__/redis_cache.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/file_cache.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/file_cache.py
new file mode 100644
index 00000000..b0bf5bfa
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/file_cache.py
@@ -0,0 +1,145 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+import hashlib
+import os
+import tempfile
+from textwrap import dedent
+from typing import IO, TYPE_CHECKING
+from pathlib import Path
+
+from cachecontrol.cache import BaseCache, SeparateBodyBaseCache
+from cachecontrol.controller import CacheController
+
+if TYPE_CHECKING:
+ from datetime import datetime
+
+ from filelock import BaseFileLock
+
+
+class _FileCacheMixin:
+ """Shared implementation for both FileCache variants."""
+
+ def __init__(
+ self,
+ directory: str | Path,
+ forever: bool = False,
+ filemode: int = 0o0600,
+ dirmode: int = 0o0700,
+ lock_class: type[BaseFileLock] | None = None,
+ ) -> None:
+ try:
+ if lock_class is None:
+ from filelock import FileLock
+
+ lock_class = FileLock
+ except ImportError:
+ notice = dedent(
+ """
+ NOTE: In order to use the FileCache you must have
+ filelock installed. You can install it via pip:
+ pip install cachecontrol[filecache]
+ """
+ )
+ raise ImportError(notice)
+
+ self.directory = directory
+ self.forever = forever
+ self.filemode = filemode
+ self.dirmode = dirmode
+ self.lock_class = lock_class
+
+ @staticmethod
+ def encode(x: str) -> str:
+ return hashlib.sha224(x.encode()).hexdigest()
+
+ def _fn(self, name: str) -> str:
+ # NOTE: This method should not change as some may depend on it.
+ # See: https://github.com/ionrock/cachecontrol/issues/63
+ hashed = self.encode(name)
+ parts = list(hashed[:5]) + [hashed]
+ return os.path.join(self.directory, *parts)
+
+ def get(self, key: str) -> bytes | None:
+ name = self._fn(key)
+ try:
+ with open(name, "rb") as fh:
+ return fh.read()
+
+ except FileNotFoundError:
+ return None
+
+ def set(
+ self, key: str, value: bytes, expires: int | datetime | None = None
+ ) -> None:
+ name = self._fn(key)
+ self._write(name, value)
+
+ def _write(self, path: str, data: bytes) -> None:
+ """
+ Safely write the data to the given path.
+ """
+ # Make sure the directory exists
+ dirname = os.path.dirname(path)
+ os.makedirs(dirname, self.dirmode, exist_ok=True)
+
+ with self.lock_class(path + ".lock"):
+ # Write our actual file
+ (fd, name) = tempfile.mkstemp(dir=dirname)
+ try:
+ os.write(fd, data)
+ finally:
+ os.close(fd)
+ os.chmod(name, self.filemode)
+ os.replace(name, path)
+
+ def _delete(self, key: str, suffix: str) -> None:
+ name = self._fn(key) + suffix
+ if not self.forever:
+ try:
+ os.remove(name)
+ except FileNotFoundError:
+ pass
+
+
+class FileCache(_FileCacheMixin, BaseCache):
+ """
+ Traditional FileCache: body is stored in memory, so not suitable for large
+ downloads.
+ """
+
+ def delete(self, key: str) -> None:
+ self._delete(key, "")
+
+
+class SeparateBodyFileCache(_FileCacheMixin, SeparateBodyBaseCache):
+ """
+ Memory-efficient FileCache: body is stored in a separate file, reducing
+ peak memory usage.
+ """
+
+ def get_body(self, key: str) -> IO[bytes] | None:
+ name = self._fn(key) + ".body"
+ try:
+ return open(name, "rb")
+ except FileNotFoundError:
+ return None
+
+ def set_body(self, key: str, body: bytes) -> None:
+ name = self._fn(key) + ".body"
+ self._write(name, body)
+
+ def delete(self, key: str) -> None:
+ self._delete(key, "")
+ self._delete(key, ".body")
+
+
+def url_to_file_path(url: str, filecache: FileCache) -> str:
+ """Return the file cache path based on the URL.
+
+ This does not ensure the file exists!
+ """
+ key = CacheController.cache_url(url)
+ return filecache._fn(key)
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/redis_cache.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/redis_cache.py
new file mode 100644
index 00000000..f859e719
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/caches/redis_cache.py
@@ -0,0 +1,48 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+
+from datetime import datetime, timezone
+from typing import TYPE_CHECKING
+
+from cachecontrol.cache import BaseCache
+
+if TYPE_CHECKING:
+ from redis import Redis
+
+
+class RedisCache(BaseCache):
+ def __init__(self, conn: Redis[bytes]) -> None:
+ self.conn = conn
+
+ def get(self, key: str) -> bytes | None:
+ return self.conn.get(key)
+
+ def set(
+ self, key: str, value: bytes, expires: int | datetime | None = None
+ ) -> None:
+ if not expires:
+ self.conn.set(key, value)
+ elif isinstance(expires, datetime):
+ now_utc = datetime.now(timezone.utc)
+ if expires.tzinfo is None:
+ now_utc = now_utc.replace(tzinfo=None)
+ delta = expires - now_utc
+ self.conn.setex(key, int(delta.total_seconds()), value)
+ else:
+ self.conn.setex(key, expires, value)
+
+ def delete(self, key: str) -> None:
+ self.conn.delete(key)
+
+ def clear(self) -> None:
+ """Helper for clearing all the keys in a database. Use with
+ caution!"""
+ for key in self.conn.keys():
+ self.conn.delete(key)
+
+ def close(self) -> None:
+ """Redis uses connection pooling, no need to close the connection."""
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/controller.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/controller.py
new file mode 100644
index 00000000..c7dd8a17
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/controller.py
@@ -0,0 +1,511 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+The httplib2 algorithms ported for use with requests.
+"""
+
+from __future__ import annotations
+
+import calendar
+import logging
+import re
+import time
+import weakref
+from email.utils import parsedate_tz
+from typing import TYPE_CHECKING, Collection, Mapping
+
+from requests.structures import CaseInsensitiveDict
+
+from cachecontrol.cache import DictCache, SeparateBodyBaseCache
+from cachecontrol.serialize import Serializer
+
+if TYPE_CHECKING:
+ from typing import Literal
+
+ from requests import PreparedRequest
+ from urllib3 import HTTPResponse
+
+ from cachecontrol.cache import BaseCache
+
+logger = logging.getLogger(__name__)
+
+URI = re.compile(r"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?")
+
+PERMANENT_REDIRECT_STATUSES = (301, 308)
+
+
+def parse_uri(uri: str) -> tuple[str, str, str, str, str]:
+ """Parses a URI using the regex given in Appendix B of RFC 3986.
+
+ (scheme, authority, path, query, fragment) = parse_uri(uri)
+ """
+ match = URI.match(uri)
+ assert match is not None
+ groups = match.groups()
+ return (groups[1], groups[3], groups[4], groups[6], groups[8])
+
+
+class CacheController:
+ """An interface to see if request should cached or not."""
+
+ def __init__(
+ self,
+ cache: BaseCache | None = None,
+ cache_etags: bool = True,
+ serializer: Serializer | None = None,
+ status_codes: Collection[int] | None = None,
+ ):
+ self.cache = DictCache() if cache is None else cache
+ self.cache_etags = cache_etags
+ self.serializer = serializer or Serializer()
+ self.cacheable_status_codes = status_codes or (200, 203, 300, 301, 308)
+
+ @classmethod
+ def _urlnorm(cls, uri: str) -> str:
+ """Normalize the URL to create a safe key for the cache"""
+ (scheme, authority, path, query, fragment) = parse_uri(uri)
+ if not scheme or not authority:
+ raise Exception("Only absolute URIs are allowed. uri = %s" % uri)
+
+ scheme = scheme.lower()
+ authority = authority.lower()
+
+ if not path:
+ path = "/"
+
+ # Could do syntax based normalization of the URI before
+ # computing the digest. See Section 6.2.2 of Std 66.
+ request_uri = query and "?".join([path, query]) or path
+ defrag_uri = scheme + "://" + authority + request_uri
+
+ return defrag_uri
+
+ @classmethod
+ def cache_url(cls, uri: str) -> str:
+ return cls._urlnorm(uri)
+
+ def parse_cache_control(self, headers: Mapping[str, str]) -> dict[str, int | None]:
+ known_directives = {
+ # https://tools.ietf.org/html/rfc7234#section-5.2
+ "max-age": (int, True),
+ "max-stale": (int, False),
+ "min-fresh": (int, True),
+ "no-cache": (None, False),
+ "no-store": (None, False),
+ "no-transform": (None, False),
+ "only-if-cached": (None, False),
+ "must-revalidate": (None, False),
+ "public": (None, False),
+ "private": (None, False),
+ "proxy-revalidate": (None, False),
+ "s-maxage": (int, True),
+ }
+
+ cc_headers = headers.get("cache-control", headers.get("Cache-Control", ""))
+
+ retval: dict[str, int | None] = {}
+
+ for cc_directive in cc_headers.split(","):
+ if not cc_directive.strip():
+ continue
+
+ parts = cc_directive.split("=", 1)
+ directive = parts[0].strip()
+
+ try:
+ typ, required = known_directives[directive]
+ except KeyError:
+ logger.debug("Ignoring unknown cache-control directive: %s", directive)
+ continue
+
+ if not typ or not required:
+ retval[directive] = None
+ if typ:
+ try:
+ retval[directive] = typ(parts[1].strip())
+ except IndexError:
+ if required:
+ logger.debug(
+ "Missing value for cache-control " "directive: %s",
+ directive,
+ )
+ except ValueError:
+ logger.debug(
+ "Invalid value for cache-control directive " "%s, must be %s",
+ directive,
+ typ.__name__,
+ )
+
+ return retval
+
+ def _load_from_cache(self, request: PreparedRequest) -> HTTPResponse | None:
+ """
+ Load a cached response, or return None if it's not available.
+ """
+ # We do not support caching of partial content: so if the request contains a
+ # Range header then we don't want to load anything from the cache.
+ if "Range" in request.headers:
+ return None
+
+ cache_url = request.url
+ assert cache_url is not None
+ cache_data = self.cache.get(cache_url)
+ if cache_data is None:
+ logger.debug("No cache entry available")
+ return None
+
+ if isinstance(self.cache, SeparateBodyBaseCache):
+ body_file = self.cache.get_body(cache_url)
+ else:
+ body_file = None
+
+ result = self.serializer.loads(request, cache_data, body_file)
+ if result is None:
+ logger.warning("Cache entry deserialization failed, entry ignored")
+ return result
+
+ def cached_request(self, request: PreparedRequest) -> HTTPResponse | Literal[False]:
+ """
+ Return a cached response if it exists in the cache, otherwise
+ return False.
+ """
+ assert request.url is not None
+ cache_url = self.cache_url(request.url)
+ logger.debug('Looking up "%s" in the cache', cache_url)
+ cc = self.parse_cache_control(request.headers)
+
+ # Bail out if the request insists on fresh data
+ if "no-cache" in cc:
+ logger.debug('Request header has "no-cache", cache bypassed')
+ return False
+
+ if "max-age" in cc and cc["max-age"] == 0:
+ logger.debug('Request header has "max_age" as 0, cache bypassed')
+ return False
+
+ # Check whether we can load the response from the cache:
+ resp = self._load_from_cache(request)
+ if not resp:
+ return False
+
+ # If we have a cached permanent redirect, return it immediately. We
+ # don't need to test our response for other headers b/c it is
+ # intrinsically "cacheable" as it is Permanent.
+ #
+ # See:
+ # https://tools.ietf.org/html/rfc7231#section-6.4.2
+ #
+ # Client can try to refresh the value by repeating the request
+ # with cache busting headers as usual (ie no-cache).
+ if int(resp.status) in PERMANENT_REDIRECT_STATUSES:
+ msg = (
+ "Returning cached permanent redirect response "
+ "(ignoring date and etag information)"
+ )
+ logger.debug(msg)
+ return resp
+
+ headers: CaseInsensitiveDict[str] = CaseInsensitiveDict(resp.headers)
+ if not headers or "date" not in headers:
+ if "etag" not in headers:
+ # Without date or etag, the cached response can never be used
+ # and should be deleted.
+ logger.debug("Purging cached response: no date or etag")
+ self.cache.delete(cache_url)
+ logger.debug("Ignoring cached response: no date")
+ return False
+
+ now = time.time()
+ time_tuple = parsedate_tz(headers["date"])
+ assert time_tuple is not None
+ date = calendar.timegm(time_tuple[:6])
+ current_age = max(0, now - date)
+ logger.debug("Current age based on date: %i", current_age)
+
+ # TODO: There is an assumption that the result will be a
+ # urllib3 response object. This may not be best since we
+ # could probably avoid instantiating or constructing the
+ # response until we know we need it.
+ resp_cc = self.parse_cache_control(headers)
+
+ # determine freshness
+ freshness_lifetime = 0
+
+ # Check the max-age pragma in the cache control header
+ max_age = resp_cc.get("max-age")
+ if max_age is not None:
+ freshness_lifetime = max_age
+ logger.debug("Freshness lifetime from max-age: %i", freshness_lifetime)
+
+ # If there isn't a max-age, check for an expires header
+ elif "expires" in headers:
+ expires = parsedate_tz(headers["expires"])
+ if expires is not None:
+ expire_time = calendar.timegm(expires[:6]) - date
+ freshness_lifetime = max(0, expire_time)
+ logger.debug("Freshness lifetime from expires: %i", freshness_lifetime)
+
+ # Determine if we are setting freshness limit in the
+ # request. Note, this overrides what was in the response.
+ max_age = cc.get("max-age")
+ if max_age is not None:
+ freshness_lifetime = max_age
+ logger.debug(
+ "Freshness lifetime from request max-age: %i", freshness_lifetime
+ )
+
+ min_fresh = cc.get("min-fresh")
+ if min_fresh is not None:
+ # adjust our current age by our min fresh
+ current_age += min_fresh
+ logger.debug("Adjusted current age from min-fresh: %i", current_age)
+
+ # Return entry if it is fresh enough
+ if freshness_lifetime > current_age:
+ logger.debug('The response is "fresh", returning cached response')
+ logger.debug("%i > %i", freshness_lifetime, current_age)
+ return resp
+
+ # we're not fresh. If we don't have an Etag, clear it out
+ if "etag" not in headers:
+ logger.debug('The cached response is "stale" with no etag, purging')
+ self.cache.delete(cache_url)
+
+ # return the original handler
+ return False
+
+ def conditional_headers(self, request: PreparedRequest) -> dict[str, str]:
+ resp = self._load_from_cache(request)
+ new_headers = {}
+
+ if resp:
+ headers: CaseInsensitiveDict[str] = CaseInsensitiveDict(resp.headers)
+
+ if "etag" in headers:
+ new_headers["If-None-Match"] = headers["ETag"]
+
+ if "last-modified" in headers:
+ new_headers["If-Modified-Since"] = headers["Last-Modified"]
+
+ return new_headers
+
+ def _cache_set(
+ self,
+ cache_url: str,
+ request: PreparedRequest,
+ response: HTTPResponse,
+ body: bytes | None = None,
+ expires_time: int | None = None,
+ ) -> None:
+ """
+ Store the data in the cache.
+ """
+ if isinstance(self.cache, SeparateBodyBaseCache):
+ # We pass in the body separately; just put a placeholder empty
+ # string in the metadata.
+ self.cache.set(
+ cache_url,
+ self.serializer.dumps(request, response, b""),
+ expires=expires_time,
+ )
+ # body is None can happen when, for example, we're only updating
+ # headers, as is the case in update_cached_response().
+ if body is not None:
+ self.cache.set_body(cache_url, body)
+ else:
+ self.cache.set(
+ cache_url,
+ self.serializer.dumps(request, response, body),
+ expires=expires_time,
+ )
+
+ def cache_response(
+ self,
+ request: PreparedRequest,
+ response_or_ref: HTTPResponse | weakref.ReferenceType[HTTPResponse],
+ body: bytes | None = None,
+ status_codes: Collection[int] | None = None,
+ ) -> None:
+ """
+ Algorithm for caching requests.
+
+ This assumes a requests Response object.
+ """
+ if isinstance(response_or_ref, weakref.ReferenceType):
+ response = response_or_ref()
+ if response is None:
+ # The weakref can be None only in case the user used streamed request
+ # and did not consume or close it, and holds no reference to requests.Response.
+ # In such case, we don't want to cache the response.
+ return
+ else:
+ response = response_or_ref
+
+ # From httplib2: Don't cache 206's since we aren't going to
+ # handle byte range requests
+ cacheable_status_codes = status_codes or self.cacheable_status_codes
+ if response.status not in cacheable_status_codes:
+ logger.debug(
+ "Status code %s not in %s", response.status, cacheable_status_codes
+ )
+ return
+
+ response_headers: CaseInsensitiveDict[str] = CaseInsensitiveDict(
+ response.headers
+ )
+
+ if "date" in response_headers:
+ time_tuple = parsedate_tz(response_headers["date"])
+ assert time_tuple is not None
+ date = calendar.timegm(time_tuple[:6])
+ else:
+ date = 0
+
+ # If we've been given a body, our response has a Content-Length, that
+ # Content-Length is valid then we can check to see if the body we've
+ # been given matches the expected size, and if it doesn't we'll just
+ # skip trying to cache it.
+ if (
+ body is not None
+ and "content-length" in response_headers
+ and response_headers["content-length"].isdigit()
+ and int(response_headers["content-length"]) != len(body)
+ ):
+ return
+
+ cc_req = self.parse_cache_control(request.headers)
+ cc = self.parse_cache_control(response_headers)
+
+ assert request.url is not None
+ cache_url = self.cache_url(request.url)
+ logger.debug('Updating cache with response from "%s"', cache_url)
+
+ # Delete it from the cache if we happen to have it stored there
+ no_store = False
+ if "no-store" in cc:
+ no_store = True
+ logger.debug('Response header has "no-store"')
+ if "no-store" in cc_req:
+ no_store = True
+ logger.debug('Request header has "no-store"')
+ if no_store and self.cache.get(cache_url):
+ logger.debug('Purging existing cache entry to honor "no-store"')
+ self.cache.delete(cache_url)
+ if no_store:
+ return
+
+ # https://tools.ietf.org/html/rfc7234#section-4.1:
+ # A Vary header field-value of "*" always fails to match.
+ # Storing such a response leads to a deserialization warning
+ # during cache lookup and is not allowed to ever be served,
+ # so storing it can be avoided.
+ if "*" in response_headers.get("vary", ""):
+ logger.debug('Response header has "Vary: *"')
+ return
+
+ # If we've been given an etag, then keep the response
+ if self.cache_etags and "etag" in response_headers:
+ expires_time = 0
+ if response_headers.get("expires"):
+ expires = parsedate_tz(response_headers["expires"])
+ if expires is not None:
+ expires_time = calendar.timegm(expires[:6]) - date
+
+ expires_time = max(expires_time, 14 * 86400)
+
+ logger.debug(f"etag object cached for {expires_time} seconds")
+ logger.debug("Caching due to etag")
+ self._cache_set(cache_url, request, response, body, expires_time)
+
+ # Add to the cache any permanent redirects. We do this before looking
+ # that the Date headers.
+ elif int(response.status) in PERMANENT_REDIRECT_STATUSES:
+ logger.debug("Caching permanent redirect")
+ self._cache_set(cache_url, request, response, b"")
+
+ # Add to the cache if the response headers demand it. If there
+ # is no date header then we can't do anything about expiring
+ # the cache.
+ elif "date" in response_headers:
+ time_tuple = parsedate_tz(response_headers["date"])
+ assert time_tuple is not None
+ date = calendar.timegm(time_tuple[:6])
+ # cache when there is a max-age > 0
+ max_age = cc.get("max-age")
+ if max_age is not None and max_age > 0:
+ logger.debug("Caching b/c date exists and max-age > 0")
+ expires_time = max_age
+ self._cache_set(
+ cache_url,
+ request,
+ response,
+ body,
+ expires_time,
+ )
+
+ # If the request can expire, it means we should cache it
+ # in the meantime.
+ elif "expires" in response_headers:
+ if response_headers["expires"]:
+ expires = parsedate_tz(response_headers["expires"])
+ if expires is not None:
+ expires_time = calendar.timegm(expires[:6]) - date
+ else:
+ expires_time = None
+
+ logger.debug(
+ "Caching b/c of expires header. expires in {} seconds".format(
+ expires_time
+ )
+ )
+ self._cache_set(
+ cache_url,
+ request,
+ response,
+ body,
+ expires_time,
+ )
+
+ def update_cached_response(
+ self, request: PreparedRequest, response: HTTPResponse
+ ) -> HTTPResponse:
+ """On a 304 we will get a new set of headers that we want to
+ update our cached value with, assuming we have one.
+
+ This should only ever be called when we've sent an ETag and
+ gotten a 304 as the response.
+ """
+ assert request.url is not None
+ cache_url = self.cache_url(request.url)
+ cached_response = self._load_from_cache(request)
+
+ if not cached_response:
+ # we didn't have a cached response
+ return response
+
+ # Lets update our headers with the headers from the new request:
+ # http://tools.ietf.org/html/draft-ietf-httpbis-p4-conditional-26#section-4.1
+ #
+ # The server isn't supposed to send headers that would make
+ # the cached body invalid. But... just in case, we'll be sure
+ # to strip out ones we know that might be problematic due to
+ # typical assumptions.
+ excluded_headers = ["content-length"]
+
+ cached_response.headers.update(
+ {
+ k: v
+ for k, v in response.headers.items()
+ if k.lower() not in excluded_headers
+ }
+ )
+
+ # we want a 200 b/c we have content via the cache
+ cached_response.status = 200
+
+ # update our cache
+ self._cache_set(cache_url, request, cached_response)
+
+ return cached_response
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/filewrapper.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/filewrapper.py
new file mode 100644
index 00000000..6569fb5c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/filewrapper.py
@@ -0,0 +1,121 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+import mmap
+from tempfile import NamedTemporaryFile
+from typing import TYPE_CHECKING, Any, Callable
+
+if TYPE_CHECKING:
+ from collections.abc import Buffer
+ from http.client import HTTPResponse
+
+
+class CallbackFileWrapper:
+ """
+ Small wrapper around a fp object which will tee everything read into a
+ buffer, and when that file is closed it will execute a callback with the
+ contents of that buffer.
+
+ All attributes are proxied to the underlying file object.
+
+ This class uses members with a double underscore (__) leading prefix so as
+ not to accidentally shadow an attribute.
+
+ The data is stored in a temporary file until it is all available. As long
+ as the temporary files directory is disk-based (sometimes it's a
+ memory-backed-``tmpfs`` on Linux), data will be unloaded to disk if memory
+ pressure is high. For small files the disk usually won't be used at all,
+ it'll all be in the filesystem memory cache, so there should be no
+ performance impact.
+ """
+
+ def __init__(
+ self, fp: HTTPResponse, callback: Callable[[Buffer], None] | None
+ ) -> None:
+ self.__buf = NamedTemporaryFile("rb+", delete=True)
+ self.__fp = fp
+ self.__callback = callback
+
+ def __getattr__(self, name: str) -> Any:
+ # The vagaries of garbage collection means that self.__fp is
+ # not always set. By using __getattribute__ and the private
+ # name[0] allows looking up the attribute value and raising an
+ # AttributeError when it doesn't exist. This stop things from
+ # infinitely recursing calls to getattr in the case where
+ # self.__fp hasn't been set.
+ #
+ # [0] https://docs.python.org/2/reference/expressions.html#atom-identifiers
+ fp = self.__getattribute__("_CallbackFileWrapper__fp")
+ return getattr(fp, name)
+
+ def __is_fp_closed(self) -> bool:
+ try:
+ return self.__fp.fp is None
+
+ except AttributeError:
+ pass
+
+ try:
+ closed: bool = self.__fp.closed
+ return closed
+
+ except AttributeError:
+ pass
+
+ # We just don't cache it then.
+ # TODO: Add some logging here...
+ return False
+
+ def _close(self) -> None:
+ result: Buffer
+ if self.__callback:
+ if self.__buf.tell() == 0:
+ # Empty file:
+ result = b""
+ else:
+ # Return the data without actually loading it into memory,
+ # relying on Python's buffer API and mmap(). mmap() just gives
+ # a view directly into the filesystem's memory cache, so it
+ # doesn't result in duplicate memory use.
+ self.__buf.seek(0, 0)
+ result = memoryview(
+ mmap.mmap(self.__buf.fileno(), 0, access=mmap.ACCESS_READ)
+ )
+ self.__callback(result)
+
+ # We assign this to None here, because otherwise we can get into
+ # really tricky problems where the CPython interpreter dead locks
+ # because the callback is holding a reference to something which
+ # has a __del__ method. Setting this to None breaks the cycle
+ # and allows the garbage collector to do it's thing normally.
+ self.__callback = None
+
+ # Closing the temporary file releases memory and frees disk space.
+ # Important when caching big files.
+ self.__buf.close()
+
+ def read(self, amt: int | None = None) -> bytes:
+ data: bytes = self.__fp.read(amt)
+ if data:
+ # We may be dealing with b'', a sign that things are over:
+ # it's passed e.g. after we've already closed self.__buf.
+ self.__buf.write(data)
+ if self.__is_fp_closed():
+ self._close()
+
+ return data
+
+ def _safe_read(self, amt: int) -> bytes:
+ data: bytes = self.__fp._safe_read(amt) # type: ignore[attr-defined]
+ if amt == 2 and data == b"\r\n":
+ # urllib executes this read to toss the CRLF at the end
+ # of the chunk.
+ return data
+
+ self.__buf.write(data)
+ if self.__is_fp_closed():
+ self._close()
+
+ return data
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/heuristics.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/heuristics.py
new file mode 100644
index 00000000..d95e78a9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/heuristics.py
@@ -0,0 +1,157 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+import calendar
+import time
+from datetime import datetime, timedelta, timezone
+from email.utils import formatdate, parsedate, parsedate_tz
+from typing import TYPE_CHECKING, Any, Mapping
+
+if TYPE_CHECKING:
+ from urllib3 import HTTPResponse
+
+TIME_FMT = "%a, %d %b %Y %H:%M:%S GMT"
+
+
+def expire_after(delta: timedelta, date: datetime | None = None) -> datetime:
+ date = date or datetime.now(timezone.utc)
+ return date + delta
+
+
+def datetime_to_header(dt: datetime) -> str:
+ return formatdate(calendar.timegm(dt.timetuple()))
+
+
+class BaseHeuristic:
+ def warning(self, response: HTTPResponse) -> str | None:
+ """
+ Return a valid 1xx warning header value describing the cache
+ adjustments.
+
+ The response is provided too allow warnings like 113
+ http://tools.ietf.org/html/rfc7234#section-5.5.4 where we need
+ to explicitly say response is over 24 hours old.
+ """
+ return '110 - "Response is Stale"'
+
+ def update_headers(self, response: HTTPResponse) -> dict[str, str]:
+ """Update the response headers with any new headers.
+
+ NOTE: This SHOULD always include some Warning header to
+ signify that the response was cached by the client, not
+ by way of the provided headers.
+ """
+ return {}
+
+ def apply(self, response: HTTPResponse) -> HTTPResponse:
+ updated_headers = self.update_headers(response)
+
+ if updated_headers:
+ response.headers.update(updated_headers)
+ warning_header_value = self.warning(response)
+ if warning_header_value is not None:
+ response.headers.update({"Warning": warning_header_value})
+
+ return response
+
+
+class OneDayCache(BaseHeuristic):
+ """
+ Cache the response by providing an expires 1 day in the
+ future.
+ """
+
+ def update_headers(self, response: HTTPResponse) -> dict[str, str]:
+ headers = {}
+
+ if "expires" not in response.headers:
+ date = parsedate(response.headers["date"])
+ expires = expire_after(
+ timedelta(days=1),
+ date=datetime(*date[:6], tzinfo=timezone.utc), # type: ignore[index,misc]
+ )
+ headers["expires"] = datetime_to_header(expires)
+ headers["cache-control"] = "public"
+ return headers
+
+
+class ExpiresAfter(BaseHeuristic):
+ """
+ Cache **all** requests for a defined time period.
+ """
+
+ def __init__(self, **kw: Any) -> None:
+ self.delta = timedelta(**kw)
+
+ def update_headers(self, response: HTTPResponse) -> dict[str, str]:
+ expires = expire_after(self.delta)
+ return {"expires": datetime_to_header(expires), "cache-control": "public"}
+
+ def warning(self, response: HTTPResponse) -> str | None:
+ tmpl = "110 - Automatically cached for %s. Response might be stale"
+ return tmpl % self.delta
+
+
+class LastModified(BaseHeuristic):
+ """
+ If there is no Expires header already, fall back on Last-Modified
+ using the heuristic from
+ http://tools.ietf.org/html/rfc7234#section-4.2.2
+ to calculate a reasonable value.
+
+ Firefox also does something like this per
+ https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching_FAQ
+ http://lxr.mozilla.org/mozilla-release/source/netwerk/protocol/http/nsHttpResponseHead.cpp#397
+ Unlike mozilla we limit this to 24-hr.
+ """
+
+ cacheable_by_default_statuses = {
+ 200,
+ 203,
+ 204,
+ 206,
+ 300,
+ 301,
+ 404,
+ 405,
+ 410,
+ 414,
+ 501,
+ }
+
+ def update_headers(self, resp: HTTPResponse) -> dict[str, str]:
+ headers: Mapping[str, str] = resp.headers
+
+ if "expires" in headers:
+ return {}
+
+ if "cache-control" in headers and headers["cache-control"] != "public":
+ return {}
+
+ if resp.status not in self.cacheable_by_default_statuses:
+ return {}
+
+ if "date" not in headers or "last-modified" not in headers:
+ return {}
+
+ time_tuple = parsedate_tz(headers["date"])
+ assert time_tuple is not None
+ date = calendar.timegm(time_tuple[:6])
+ last_modified = parsedate(headers["last-modified"])
+ if last_modified is None:
+ return {}
+
+ now = time.time()
+ current_age = max(0, now - date)
+ delta = date - calendar.timegm(last_modified)
+ freshness_lifetime = max(0, min(delta / 10, 24 * 3600))
+ if freshness_lifetime <= current_age:
+ return {}
+
+ expires = date + freshness_lifetime
+ return {"expires": time.strftime(TIME_FMT, time.gmtime(expires))}
+
+ def warning(self, resp: HTTPResponse) -> str | None:
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/py.typed b/Backend/venv/lib/python3.12/site-packages/cachecontrol/py.typed
new file mode 100644
index 00000000..e69de29b
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/serialize.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/serialize.py
new file mode 100644
index 00000000..83bce073
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/serialize.py
@@ -0,0 +1,146 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+import io
+from typing import IO, TYPE_CHECKING, Any, Mapping, cast
+
+import msgpack
+from requests.structures import CaseInsensitiveDict
+from urllib3 import HTTPResponse
+
+if TYPE_CHECKING:
+ from requests import PreparedRequest
+
+
+class Serializer:
+ serde_version = "4"
+
+ def dumps(
+ self,
+ request: PreparedRequest,
+ response: HTTPResponse,
+ body: bytes | None = None,
+ ) -> bytes:
+ response_headers: CaseInsensitiveDict[str] = CaseInsensitiveDict(
+ response.headers
+ )
+
+ if body is None:
+ # When a body isn't passed in, we'll read the response. We
+ # also update the response with a new file handler to be
+ # sure it acts as though it was never read.
+ body = response.read(decode_content=False)
+ response._fp = io.BytesIO(body) # type: ignore[assignment]
+ response.length_remaining = len(body)
+
+ data = {
+ "response": {
+ "body": body, # Empty bytestring if body is stored separately
+ "headers": {str(k): str(v) for k, v in response.headers.items()},
+ "status": response.status,
+ "version": response.version,
+ "reason": str(response.reason),
+ "decode_content": response.decode_content,
+ }
+ }
+
+ # Construct our vary headers
+ data["vary"] = {}
+ if "vary" in response_headers:
+ varied_headers = response_headers["vary"].split(",")
+ for header in varied_headers:
+ header = str(header).strip()
+ header_value = request.headers.get(header, None)
+ if header_value is not None:
+ header_value = str(header_value)
+ data["vary"][header] = header_value
+
+ return b",".join([f"cc={self.serde_version}".encode(), self.serialize(data)])
+
+ def serialize(self, data: dict[str, Any]) -> bytes:
+ return cast(bytes, msgpack.dumps(data, use_bin_type=True))
+
+ def loads(
+ self,
+ request: PreparedRequest,
+ data: bytes,
+ body_file: IO[bytes] | None = None,
+ ) -> HTTPResponse | None:
+ # Short circuit if we've been given an empty set of data
+ if not data:
+ return None
+
+ # Previous versions of this library supported other serialization
+ # formats, but these have all been removed.
+ if not data.startswith(f"cc={self.serde_version},".encode()):
+ return None
+
+ data = data[5:]
+ return self._loads_v4(request, data, body_file)
+
+ def prepare_response(
+ self,
+ request: PreparedRequest,
+ cached: Mapping[str, Any],
+ body_file: IO[bytes] | None = None,
+ ) -> HTTPResponse | None:
+ """Verify our vary headers match and construct a real urllib3
+ HTTPResponse object.
+ """
+ # Special case the '*' Vary value as it means we cannot actually
+ # determine if the cached response is suitable for this request.
+ # This case is also handled in the controller code when creating
+ # a cache entry, but is left here for backwards compatibility.
+ if "*" in cached.get("vary", {}):
+ return None
+
+ # Ensure that the Vary headers for the cached response match our
+ # request
+ for header, value in cached.get("vary", {}).items():
+ if request.headers.get(header, None) != value:
+ return None
+
+ body_raw = cached["response"].pop("body")
+
+ headers: CaseInsensitiveDict[str] = CaseInsensitiveDict(
+ data=cached["response"]["headers"]
+ )
+ if headers.get("transfer-encoding", "") == "chunked":
+ headers.pop("transfer-encoding")
+
+ cached["response"]["headers"] = headers
+
+ try:
+ body: IO[bytes]
+ if body_file is None:
+ body = io.BytesIO(body_raw)
+ else:
+ body = body_file
+ except TypeError:
+ # This can happen if cachecontrol serialized to v1 format (pickle)
+ # using Python 2. A Python 2 str(byte string) will be unpickled as
+ # a Python 3 str (unicode string), which will cause the above to
+ # fail with:
+ #
+ # TypeError: 'str' does not support the buffer interface
+ body = io.BytesIO(body_raw.encode("utf8"))
+
+ # Discard any `strict` parameter serialized by older version of cachecontrol.
+ cached["response"].pop("strict", None)
+
+ return HTTPResponse(body=body, preload_content=False, **cached["response"])
+
+ def _loads_v4(
+ self,
+ request: PreparedRequest,
+ data: bytes,
+ body_file: IO[bytes] | None = None,
+ ) -> HTTPResponse | None:
+ try:
+ cached = msgpack.loads(data, raw=False)
+ except ValueError:
+ return None
+
+ return self.prepare_response(request, cached, body_file)
diff --git a/Backend/venv/lib/python3.12/site-packages/cachecontrol/wrapper.py b/Backend/venv/lib/python3.12/site-packages/cachecontrol/wrapper.py
new file mode 100644
index 00000000..37ee07c7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cachecontrol/wrapper.py
@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: 2015 Eric Larson
+#
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Collection
+
+from cachecontrol.adapter import CacheControlAdapter
+from cachecontrol.cache import DictCache
+
+if TYPE_CHECKING:
+ import requests
+
+ from cachecontrol.cache import BaseCache
+ from cachecontrol.controller import CacheController
+ from cachecontrol.heuristics import BaseHeuristic
+ from cachecontrol.serialize import Serializer
+
+
+def CacheControl(
+ sess: requests.Session,
+ cache: BaseCache | None = None,
+ cache_etags: bool = True,
+ serializer: Serializer | None = None,
+ heuristic: BaseHeuristic | None = None,
+ controller_class: type[CacheController] | None = None,
+ adapter_class: type[CacheControlAdapter] | None = None,
+ cacheable_methods: Collection[str] | None = None,
+) -> requests.Session:
+ cache = DictCache() if cache is None else cache
+ adapter_class = adapter_class or CacheControlAdapter
+ adapter = adapter_class(
+ cache,
+ cache_etags=cache_etags,
+ serializer=serializer,
+ heuristic=heuristic,
+ controller_class=controller_class,
+ cacheable_methods=cacheable_methods,
+ )
+ sess.mount("http://", adapter)
+ sess.mount("https://", adapter)
+
+ return sess
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/__init__.py
new file mode 100644
index 00000000..96bef1fb
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/__init__.py
@@ -0,0 +1,25 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Python library for CycloneDX
+"""
+
+# !! version is managed by semantic_release
+# do not use typing here, or else `semantic_release` might have issues finding the variable
+__version__ = "9.1.0" # noqa:Q000
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..d17b4bb8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/__pycache__/spdx.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/__pycache__/spdx.cpython-312.pyc
new file mode 100644
index 00000000..e3677b3b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/__pycache__/spdx.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__init__.py
new file mode 100644
index 00000000..93ec7d3d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__init__.py
@@ -0,0 +1,25 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+!!! ALL SYMBOLS IN HERE ARE INTERNAL.
+Everything might change without any notice.
+"""
+
+# THIS FILE IS INTENDED TO BE EMPTY.
+# Put symbols in own modules/packages, not in this file!
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..61b9971d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/bom_ref.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/bom_ref.cpython-312.pyc
new file mode 100644
index 00000000..80b26955
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/bom_ref.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/compare.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/compare.cpython-312.pyc
new file mode 100644
index 00000000..a49d4a23
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/compare.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/hash.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/hash.cpython-312.pyc
new file mode 100644
index 00000000..a378e4ea
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/hash.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/time.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/time.cpython-312.pyc
new file mode 100644
index 00000000..b3c7cae2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/__pycache__/time.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/bom_ref.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/bom_ref.py
new file mode 100644
index 00000000..b6fefd22
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/bom_ref.py
@@ -0,0 +1,51 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+!!! ALL SYMBOLS IN HERE ARE INTERNAL.
+Everything might change without any notice.
+"""
+
+from typing import Literal, Optional, Union, overload
+
+from ..model.bom_ref import BomRef
+
+
+@overload
+def bom_ref_from_str(bom_ref: BomRef, optional: bool = ...) -> BomRef:
+ ... # pragma: no cover
+
+
+@overload
+def bom_ref_from_str(bom_ref: Optional[str], optional: Literal[False] = False) -> BomRef:
+ ... # pragma: no cover
+
+
+@overload
+def bom_ref_from_str(bom_ref: Optional[str], optional: Literal[True] = ...) -> Optional[BomRef]:
+ ... # pragma: no cover
+
+
+def bom_ref_from_str(bom_ref: Optional[Union[str, BomRef]], optional: bool = False) -> Optional[BomRef]:
+ if isinstance(bom_ref, BomRef):
+ return bom_ref
+ if bom_ref:
+ return BomRef(value=str(bom_ref))
+ return None \
+ if optional \
+ else BomRef()
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/compare.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/compare.py
new file mode 100644
index 00000000..bd64e692
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/compare.py
@@ -0,0 +1,82 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+!!! ALL SYMBOLS IN HERE ARE INTERNAL.
+Everything might change without any notice.
+"""
+
+from itertools import zip_longest
+from typing import TYPE_CHECKING, Any, Dict, Optional, Tuple
+
+if TYPE_CHECKING: # pragma: no cover
+ from packageurl import PackageURL
+
+
+class ComparableTuple(Tuple[Optional[Any], ...]):
+ """
+ Allows comparison of tuples, allowing for None values.
+ """
+
+ def __lt__(self, other: Any) -> bool:
+ for s, o in zip_longest(self, other):
+ if s == o:
+ continue
+ # the idea is to have any consistent order, not necessarily "natural" order.
+ if s is None:
+ return False
+ if o is None:
+ return True
+ return bool(s < o)
+ return False
+
+ def __gt__(self, other: Any) -> bool:
+ for s, o in zip_longest(self, other):
+ if s == o:
+ continue
+ # the idea is to have any consistent order, not necessarily "natural" order.
+ if s is None:
+ return True
+ if o is None:
+ return False
+ return bool(s > o)
+ return False
+
+
+class ComparableDict(ComparableTuple):
+ """
+ Allows comparison of dictionaries, allowing for missing/None values.
+ """
+
+ def __new__(cls, d: Dict[Any, Any]) -> 'ComparableDict':
+ return super(ComparableDict, cls).__new__(cls, sorted(d.items()))
+
+
+class ComparablePackageURL(ComparableTuple):
+ """
+ Allows comparison of PackageURL, allowing for qualifiers.
+ """
+
+ def __new__(cls, p: 'PackageURL') -> 'ComparablePackageURL':
+ return super(ComparablePackageURL, cls).__new__(cls, (
+ p.type,
+ p.namespace,
+ p.version,
+ ComparableDict(p.qualifiers) if isinstance(p.qualifiers, dict) else p.qualifiers,
+ p.subpath
+ ))
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/hash.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/hash.py
new file mode 100644
index 00000000..4fc17f5e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/hash.py
@@ -0,0 +1,43 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+!!! ALL SYMBOLS IN HERE ARE INTERNAL.
+Everything might change without any notice.
+"""
+
+
+from hashlib import sha1
+
+
+def file_sha1sum(filename: str) -> str:
+ """
+ Generate a SHA1 hash of the provided file.
+
+ Args:
+ filename:
+ Absolute path to file to hash as `str`
+
+ Returns:
+ SHA-1 hash
+ """
+ h = sha1() # nosec B303, B324
+ with open(filename, 'rb') as f:
+ for byte_block in iter(lambda: f.read(4096), b''):
+ h.update(byte_block)
+ return h.hexdigest()
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/time.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/time.py
new file mode 100644
index 00000000..8a2a19d4
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/_internal/time.py
@@ -0,0 +1,29 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+!!! ALL SYMBOLS IN HERE ARE INTERNAL.
+Everything might change without any notice.
+"""
+
+
+from datetime import datetime, timezone
+
+
+def get_now_utc() -> datetime:
+ return datetime.now(tz=timezone.utc)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__init__.py
new file mode 100644
index 00000000..ec68e667
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__init__.py
@@ -0,0 +1,20 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+"""
+Builders used in this library.
+"""
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..c02ebec7
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__pycache__/this.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__pycache__/this.cpython-312.pyc
new file mode 100644
index 00000000..425fd9d0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/__pycache__/this.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/this.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/this.py
new file mode 100644
index 00000000..8f81a8ff
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/builder/this.py
@@ -0,0 +1,83 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+"""Representation of this very python library."""
+
+__all__ = ['this_component', 'this_tool', ]
+
+from .. import __version__ as __ThisVersion # noqa: N812
+from ..model import ExternalReference, ExternalReferenceType, XsUri
+from ..model.component import Component, ComponentType
+from ..model.license import DisjunctiveLicense, LicenseAcknowledgement
+from ..model.tool import Tool
+
+# !!! keep this file in sync with `pyproject.toml`
+
+
+def this_component() -> Component:
+ """Representation of this very python library as a :class:`Component`."""
+ return Component(
+ type=ComponentType.LIBRARY,
+ group='CycloneDX',
+ name='cyclonedx-python-lib',
+ version=__ThisVersion or 'UNKNOWN',
+ description='Python library for CycloneDX',
+ licenses=(DisjunctiveLicense(id='Apache-2.0',
+ acknowledgement=LicenseAcknowledgement.DECLARED),),
+ external_references=(
+ # let's assume this is not a fork
+ ExternalReference(
+ type=ExternalReferenceType.WEBSITE,
+ url=XsUri('https://github.com/CycloneDX/cyclonedx-python-lib/#readme')
+ ),
+ ExternalReference(
+ type=ExternalReferenceType.DOCUMENTATION,
+ url=XsUri('https://cyclonedx-python-library.readthedocs.io/')
+ ),
+ ExternalReference(
+ type=ExternalReferenceType.VCS,
+ url=XsUri('https://github.com/CycloneDX/cyclonedx-python-lib')
+ ),
+ ExternalReference(
+ type=ExternalReferenceType.BUILD_SYSTEM,
+ url=XsUri('https://github.com/CycloneDX/cyclonedx-python-lib/actions')
+ ),
+ ExternalReference(
+ type=ExternalReferenceType.ISSUE_TRACKER,
+ url=XsUri('https://github.com/CycloneDX/cyclonedx-python-lib/issues')
+ ),
+ ExternalReference(
+ type=ExternalReferenceType.LICENSE,
+ url=XsUri('https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/LICENSE')
+ ),
+ ExternalReference(
+ type=ExternalReferenceType.RELEASE_NOTES,
+ url=XsUri('https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/CHANGELOG.md')
+ ),
+ # we cannot assert where the lib was fetched from, but we can give a hint
+ ExternalReference(
+ type=ExternalReferenceType.DISTRIBUTION,
+ url=XsUri('https://pypi.org/project/cyclonedx-python-lib/')
+ ),
+ ),
+ # to be extended...
+ )
+
+
+def this_tool() -> Tool:
+ """Representation of this very python library as a :class:`Tool`."""
+ return Tool.from_component(this_component())
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__init__.py
new file mode 100644
index 00000000..886b63d1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__init__.py
@@ -0,0 +1,33 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Exceptions that are specific to the CycloneDX library implementation.
+"""
+
+
+class CycloneDxException(Exception): # noqa: N818
+ """
+ Root exception thrown by this library.
+ """
+ pass
+
+
+class MissingOptionalDependencyException(CycloneDxException): # noqa: N818
+ """Validation did not happen, due to missing dependencies."""
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..b7ad6201
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/factory.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/factory.cpython-312.pyc
new file mode 100644
index 00000000..87115202
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/factory.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/model.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/model.cpython-312.pyc
new file mode 100644
index 00000000..d4d0dd06
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/model.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/output.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/output.cpython-312.pyc
new file mode 100644
index 00000000..40427f91
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/output.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/serialization.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/serialization.cpython-312.pyc
new file mode 100644
index 00000000..52c71a19
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/__pycache__/serialization.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/factory.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/factory.py
new file mode 100644
index 00000000..2ddbb327
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/factory.py
@@ -0,0 +1,58 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Exceptions relating to specific conditions that occur when factoring a model.
+"""
+
+from . import CycloneDxException
+
+
+class CycloneDxFactoryException(CycloneDxException):
+ """
+ Base exception that covers all exceptions that may be thrown during model factoring..
+ """
+ pass
+
+
+class LicenseChoiceFactoryException(CycloneDxFactoryException):
+ """
+ Base exception that covers all LicenseChoiceFactory exceptions.
+ """
+ pass
+
+
+class InvalidSpdxLicenseException(LicenseChoiceFactoryException):
+ """
+ Thrown when an invalid SPDX License is provided.
+ """
+ pass
+
+
+class LicenseFactoryException(CycloneDxFactoryException):
+ """
+ Base exception that covers all LicenseFactory exceptions.
+ """
+ pass
+
+
+class InvalidLicenseExpressionException(LicenseFactoryException):
+ """
+ Thrown when an invalid License expressions is provided.
+ """
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/model.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/model.py
new file mode 100644
index 00000000..3484b606
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/model.py
@@ -0,0 +1,133 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Exceptions relating to specific conditions that occur when modelling CycloneDX BOM.
+"""
+
+from . import CycloneDxException
+
+
+class CycloneDxModelException(CycloneDxException):
+ """
+ Base exception that covers all exceptions that may be thrown during model creation.
+ """
+ pass
+
+
+class InvalidLocaleTypeException(CycloneDxModelException):
+ """
+ Raised when the supplied locale does not conform to ISO-639 specification.
+
+ Good examples:
+ - en
+ - en-US
+ - en-GB
+ - fr
+ - fr-CA
+
+ The language code MUST be lowercase. If the country code is specified, the country code MUST be upper case.
+ The language code and country code MUST be separated by a minus sign.
+ """
+ pass
+
+
+class InvalidNistQuantumSecurityLevelException(CycloneDxModelException):
+ """
+ Raised when an invalid value is provided for an NIST Quantum Security Level
+ as defined at https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/
+ evaluation-criteria/security-(evaluation-criteria).
+ """
+ pass
+
+
+class InvalidOmniBorIdException(CycloneDxModelException):
+ """
+ Raised when a supplied value for an OmniBOR ID does not meet the format requirements
+ as defined at https://www.iana.org/assignments/uri-schemes/prov/gitoid.
+ """
+ pass
+
+
+class InvalidRelatedCryptoMaterialSizeException(CycloneDxModelException):
+ """
+ Raised when the supplied size of a Related Crypto Material is negative.
+ """
+ pass
+
+
+class InvalidSwhidException(CycloneDxModelException):
+ """
+ Raised when a supplied value for an Swhid does not meet the format requirements
+ as defined at https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html.
+ """
+ pass
+
+
+class InvalidUriException(CycloneDxModelException):
+ """
+ Raised when a `str` is provided that needs to be a valid URI, but isn't.
+ """
+ pass
+
+
+class MutuallyExclusivePropertiesException(CycloneDxModelException):
+ """
+ Raised when mutually exclusive properties are provided.
+ """
+ pass
+
+
+class NoPropertiesProvidedException(CycloneDxModelException):
+ """
+ Raised when attempting to construct a model class and providing NO values (where all properites are defined as
+ Optional, but at least one is required).
+ """
+ pass
+
+
+class UnknownComponentDependencyException(CycloneDxModelException):
+ """
+ Exception raised when a dependency has been noted for a Component that is NOT a Component BomRef in this Bom.
+ """
+ pass
+
+
+class UnknownHashTypeException(CycloneDxModelException):
+ """
+ Exception raised when we are unable to determine the type of hash from a composite hash string.
+ """
+ pass
+
+
+class LicenseExpressionAlongWithOthersException(CycloneDxModelException):
+ """
+ Exception raised when a LicenseExpression was detected along with other licenses.
+ If a LicenseExpression exists, than it must stand alone.
+
+ See https://github.com/CycloneDX/specification/pull/205
+ """
+ pass
+
+
+class InvalidCreIdException(CycloneDxModelException):
+ """
+ Raised when a supplied value for an CRE ID does not meet the format requirements
+ as defined at https://opencre.org/
+ """
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/output.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/output.py
new file mode 100644
index 00000000..8b84c20a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/output.py
@@ -0,0 +1,39 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Exceptions that are for specific error scenarios during the output of a Model to a SBOM.
+"""
+
+from . import CycloneDxException
+
+
+class BomGenerationErrorException(CycloneDxException):
+ """
+ Raised if there is an unknown error.
+ """
+ pass
+
+
+class FormatNotSupportedException(CycloneDxException):
+ """
+ Exception raised when attempting to output a BOM to a format not supported in the requested version.
+
+ For example, JSON is not supported prior to 1.2.
+ """
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/serialization.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/serialization.py
new file mode 100644
index 00000000..2c53beb5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/exception/serialization.py
@@ -0,0 +1,52 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Exceptions relating to specific conditions that occur when (de)serializing/(de)normalizing CycloneDX BOM.
+"""
+
+from . import CycloneDxException
+
+
+class CycloneDxSerializationException(CycloneDxException):
+ """
+ Base exception that covers all exceptions that may be thrown during model serializing/normalizing.
+ """
+ pass
+
+
+class CycloneDxDeserializationException(CycloneDxException):
+ """
+ Base exception that covers all exceptions that may be thrown during model deserializing/denormalizing.
+ """
+ pass
+
+
+class SerializationOfUnsupportedComponentTypeException(CycloneDxSerializationException):
+ """
+ Raised when attempting serializing/normalizing a :py:class:`cyclonedx.model.component.Component`
+ to a :py:class:`cyclonedx.schema.schema.BaseSchemaVersion`
+ which does not support that :py:class:`cyclonedx.model.component.ComponentType`
+ .
+ """
+
+
+class SerializationOfUnexpectedValueException(CycloneDxSerializationException, ValueError):
+ """
+ Raised when attempting serializing/normalizing a type that is not expected there.
+ """
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__init__.py
new file mode 100644
index 00000000..ffb3ca2f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__init__.py
@@ -0,0 +1,20 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+"""
+Factories used in this library.
+"""
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..9016410d
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__pycache__/license.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__pycache__/license.cpython-312.pyc
new file mode 100644
index 00000000..d304c221
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/__pycache__/license.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/license.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/license.py
new file mode 100644
index 00000000..40d4484d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/factory/license.py
@@ -0,0 +1,88 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+from typing import TYPE_CHECKING, Optional
+
+from ..exception.factory import InvalidLicenseExpressionException, InvalidSpdxLicenseException
+from ..model.license import DisjunctiveLicense, LicenseExpression
+from ..spdx import fixup_id as spdx_fixup, is_expression as is_spdx_expression
+
+if TYPE_CHECKING: # pragma: no cover
+ from ..model import AttachedText, XsUri
+ from ..model.license import License, LicenseAcknowledgement
+
+
+class LicenseFactory:
+ """Factory for :class:`cyclonedx.model.license.License`."""
+
+ def make_from_string(self, value: str, *,
+ license_text: Optional['AttachedText'] = None,
+ license_url: Optional['XsUri'] = None,
+ license_acknowledgement: Optional['LicenseAcknowledgement'] = None
+ ) -> 'License':
+ """Make a :class:`cyclonedx.model.license.License` from a string."""
+ try:
+ return self.make_with_id(value,
+ text=license_text,
+ url=license_url,
+ acknowledgement=license_acknowledgement)
+ except InvalidSpdxLicenseException:
+ pass
+ try:
+ return self.make_with_expression(value,
+ acknowledgement=license_acknowledgement)
+ except InvalidLicenseExpressionException:
+ pass
+ return self.make_with_name(value,
+ text=license_text,
+ url=license_url,
+ acknowledgement=license_acknowledgement)
+
+ def make_with_expression(self, expression: str, *,
+ acknowledgement: Optional['LicenseAcknowledgement'] = None
+ ) -> LicenseExpression:
+ """Make a :class:`cyclonedx.model.license.LicenseExpression` with a compound expression.
+
+ Utilizes :func:`cyclonedx.spdx.is_expression`.
+
+ :raises InvalidLicenseExpressionException: if param `value` is not known/supported license expression
+ """
+ if is_spdx_expression(expression):
+ return LicenseExpression(expression, acknowledgement=acknowledgement)
+ raise InvalidLicenseExpressionException(expression)
+
+ def make_with_id(self, spdx_id: str, *,
+ text: Optional['AttachedText'] = None,
+ url: Optional['XsUri'] = None,
+ acknowledgement: Optional['LicenseAcknowledgement'] = None
+ ) -> DisjunctiveLicense:
+ """Make a :class:`cyclonedx.model.license.DisjunctiveLicense` from an SPDX-ID.
+
+ :raises InvalidSpdxLicenseException: if param `spdx_id` was not known/supported SPDX-ID
+ """
+ spdx_license_id = spdx_fixup(spdx_id)
+ if spdx_license_id is None:
+ raise InvalidSpdxLicenseException(spdx_id)
+ return DisjunctiveLicense(id=spdx_license_id, text=text, url=url, acknowledgement=acknowledgement)
+
+ def make_with_name(self, name: str, *,
+ text: Optional['AttachedText'] = None,
+ url: Optional['XsUri'] = None,
+ acknowledgement: Optional['LicenseAcknowledgement'] = None
+ ) -> DisjunctiveLicense:
+ """Make a :class:`cyclonedx.model.license.DisjunctiveLicense` with a name."""
+ return DisjunctiveLicense(name=name, text=text, url=url, acknowledgement=acknowledgement)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__init__.py
new file mode 100644
index 00000000..b2e40187
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__init__.py
@@ -0,0 +1,1298 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+"""
+Uniform set of models to represent objects within a CycloneDX software bill-of-materials.
+
+You can either create a `cyclonedx.model.bom.Bom` yourself programmatically, or generate a `cyclonedx.model.bom.Bom`
+from a `cyclonedx.parser.BaseParser` implementation.
+"""
+
+import re
+from datetime import datetime
+from enum import Enum
+from functools import reduce
+from json import loads as json_loads
+from typing import Any, Dict, FrozenSet, Generator, Iterable, List, Optional, Tuple, Type, Union
+from urllib.parse import quote as url_quote
+from uuid import UUID
+from warnings import warn
+from xml.etree.ElementTree import Element as XmlElement # nosec B405
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..exception.model import InvalidLocaleTypeException, InvalidUriException, UnknownHashTypeException
+from ..exception.serialization import CycloneDxDeserializationException, SerializationOfUnexpectedValueException
+from ..schema.schema import (
+ SchemaVersion1Dot0,
+ SchemaVersion1Dot1,
+ SchemaVersion1Dot2,
+ SchemaVersion1Dot3,
+ SchemaVersion1Dot4,
+ SchemaVersion1Dot5,
+ SchemaVersion1Dot6,
+)
+from .bom_ref import BomRef
+
+_BOM_LINK_PREFIX = 'urn:cdx:'
+
+
+@serializable.serializable_enum
+class DataFlow(str, Enum):
+ """
+ This is our internal representation of the dataFlowType simple type within the CycloneDX standard.
+
+ .. note::
+ See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/xml/#type_dataFlowType
+ """
+ INBOUND = 'inbound'
+ OUTBOUND = 'outbound'
+ BI_DIRECTIONAL = 'bi-directional'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_class
+class DataClassification:
+ """
+ This is our internal representation of the `dataClassificationType` complex type within the CycloneDX standard.
+
+ DataClassification might be deprecated since CycloneDX 1.5, but it is not deprecated in this library.
+ In fact, this library will try to provide a compatibility layer if needed.
+
+ .. note::
+ See the CycloneDX Schema for dataClassificationType:
+ https://cyclonedx.org/docs/1.6/xml/#type_dataClassificationType
+ """
+
+ def __init__(
+ self, *,
+ flow: DataFlow,
+ classification: str,
+ ) -> None:
+ self.flow = flow
+ self.classification = classification
+
+ @property
+ @serializable.xml_attribute()
+ def flow(self) -> DataFlow:
+ """
+ Specifies the flow direction of the data.
+
+ Valid values are: inbound, outbound, bi-directional, and unknown.
+
+ Direction is relative to the service.
+
+ - Inbound flow states that data enters the service
+ - Outbound flow states that data leaves the service
+ - Bi-directional states that data flows both ways
+ - Unknown states that the direction is not known
+
+ Returns:
+ `DataFlow`
+ """
+ return self._flow
+
+ @flow.setter
+ def flow(self, flow: DataFlow) -> None:
+ self._flow = flow
+
+ @property
+ @serializable.xml_name('.')
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def classification(self) -> str:
+ """
+ Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
+
+ Returns:
+ `str`
+ """
+ return self._classification
+
+ @classification.setter
+ def classification(self, classification: str) -> None:
+ self._classification = classification
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.flow, self.classification
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, DataClassification):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: object) -> bool:
+ if isinstance(other, DataClassification):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class Encoding(str, Enum):
+ """
+ This is our internal representation of the encoding simple type within the CycloneDX standard.
+
+ .. note::
+ See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_encoding
+ """
+ BASE_64 = 'base64'
+
+
+@serializable.serializable_class
+class AttachedText:
+ """
+ This is our internal representation of the `attachedTextType` complex type within the CycloneDX standard.
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_attachedTextType
+ """
+
+ DEFAULT_CONTENT_TYPE = 'text/plain'
+
+ def __init__(
+ self, *,
+ content: str,
+ content_type: str = DEFAULT_CONTENT_TYPE,
+ encoding: Optional[Encoding] = None,
+ ) -> None:
+ self.content_type = content_type
+ self.encoding = encoding
+ self.content = content
+
+ @property
+ @serializable.xml_attribute()
+ @serializable.xml_name('content-type')
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def content_type(self) -> str:
+ """
+ Specifies the content type of the text. Defaults to text/plain if not specified.
+
+ Returns:
+ `str`
+ """
+ return self._content_type
+
+ @content_type.setter
+ def content_type(self, content_type: str) -> None:
+ self._content_type = content_type
+
+ @property
+ @serializable.xml_attribute()
+ def encoding(self) -> Optional[Encoding]:
+ """
+ Specifies the optional encoding the text is represented in.
+
+ Returns:
+ `Encoding` if set else `None`
+ """
+ return self._encoding
+
+ @encoding.setter
+ def encoding(self, encoding: Optional[Encoding]) -> None:
+ self._encoding = encoding
+
+ @property
+ @serializable.xml_name('.')
+ def content(self) -> str:
+ """
+ The attachment data.
+
+ Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment
+ text.
+
+ Returns:
+ `str`
+ """
+ return self._content
+
+ @content.setter
+ def content(self, content: str) -> None:
+ self._content = content
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.content_type, self.encoding, self.content,
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, AttachedText):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, AttachedText):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class HashAlgorithm(str, Enum):
+ """
+ This is our internal representation of the hashAlg simple type within the CycloneDX standard.
+
+ .. note::
+ See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_hashAlg
+ """
+ # see `_HashTypeRepositorySerializationHelper.__CASES` for view/case map
+ BLAKE2B_256 = 'BLAKE2b-256' # Only supported in >= 1.2
+ BLAKE2B_384 = 'BLAKE2b-384' # Only supported in >= 1.2
+ BLAKE2B_512 = 'BLAKE2b-512' # Only supported in >= 1.2
+ BLAKE3 = 'BLAKE3' # Only supported in >= 1.2
+ MD5 = 'MD5'
+ SHA_1 = 'SHA-1'
+ SHA_256 = 'SHA-256'
+ SHA_384 = 'SHA-384'
+ SHA_512 = 'SHA-512'
+ SHA3_256 = 'SHA3-256'
+ SHA3_384 = 'SHA3-384' # Only supported in >= 1.2
+ SHA3_512 = 'SHA3-512'
+
+
+class _HashTypeRepositorySerializationHelper(serializable.helpers.BaseHelper):
+ """ THIS CLASS IS NON-PUBLIC API """
+
+ __CASES: Dict[Type[serializable.ViewType], FrozenSet[HashAlgorithm]] = dict()
+ __CASES[SchemaVersion1Dot0] = frozenset({
+ HashAlgorithm.MD5,
+ HashAlgorithm.SHA_1,
+ HashAlgorithm.SHA_256,
+ HashAlgorithm.SHA_384,
+ HashAlgorithm.SHA_512,
+ HashAlgorithm.SHA3_256,
+ HashAlgorithm.SHA3_512,
+ })
+ __CASES[SchemaVersion1Dot1] = __CASES[SchemaVersion1Dot0]
+ __CASES[SchemaVersion1Dot2] = __CASES[SchemaVersion1Dot1] | {
+ HashAlgorithm.BLAKE2B_256,
+ HashAlgorithm.BLAKE2B_384,
+ HashAlgorithm.BLAKE2B_512,
+ HashAlgorithm.BLAKE3,
+ HashAlgorithm.SHA3_384,
+ }
+ __CASES[SchemaVersion1Dot3] = __CASES[SchemaVersion1Dot2]
+ __CASES[SchemaVersion1Dot4] = __CASES[SchemaVersion1Dot3]
+ __CASES[SchemaVersion1Dot5] = __CASES[SchemaVersion1Dot4]
+ __CASES[SchemaVersion1Dot6] = __CASES[SchemaVersion1Dot5]
+
+ @classmethod
+ def __prep(cls, hts: Iterable['HashType'], view: Type[serializable.ViewType]) -> Generator['HashType', None, None]:
+ cases = cls.__CASES.get(view, ())
+ for ht in hts:
+ if ht.alg in cases:
+ yield ht
+ else:
+ warn(f'serialization omitted due to unsupported HashAlgorithm: {ht!r}',
+ category=UserWarning, stacklevel=0)
+
+ @classmethod
+ def json_normalize(cls, o: Iterable['HashType'], *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> List[Any]:
+ assert view is not None
+ return [
+ json_loads(
+ ht.as_json( # type:ignore[attr-defined]
+ view_=view)
+ ) for ht in cls.__prep(o, view)
+ ]
+
+ @classmethod
+ def xml_normalize(cls, o: Iterable['HashType'], *,
+ element_name: str,
+ view: Optional[Type[serializable.ViewType]],
+ xmlns: Optional[str],
+ **__: Any) -> XmlElement:
+ assert view is not None
+ elem = XmlElement(element_name)
+ elem.extend(
+ ht.as_xml( # type:ignore[attr-defined]
+ view_=view, as_string=False, element_name='hash', xmlns=xmlns
+ ) for ht in cls.__prep(o, view)
+ )
+ return elem
+
+ @classmethod
+ def json_denormalize(cls, o: Any,
+ **__: Any) -> List['HashType']:
+ return [
+ HashType.from_json( # type:ignore[attr-defined]
+ ht) for ht in o
+ ]
+
+ @classmethod
+ def xml_denormalize(cls, o: 'XmlElement', *,
+ default_ns: Optional[str],
+ **__: Any) -> List['HashType']:
+ return [
+ HashType.from_xml( # type:ignore[attr-defined]
+ ht, default_ns) for ht in o
+ ]
+
+
+_MAP_HASHLIB: Dict[str, HashAlgorithm] = {
+ # from hashlib.algorithms_guaranteed
+ 'md5': HashAlgorithm.MD5,
+ 'sha1': HashAlgorithm.SHA_1,
+ # sha224:
+ 'sha256': HashAlgorithm.SHA_256,
+ 'sha384': HashAlgorithm.SHA_384,
+ 'sha512': HashAlgorithm.SHA_512,
+ # blake2b:
+ # blake2s:
+ # sha3_224:
+ 'sha3_256': HashAlgorithm.SHA3_256,
+ 'sha3_384': HashAlgorithm.SHA3_384,
+ 'sha3_512': HashAlgorithm.SHA3_512,
+ # shake_128:
+ # shake_256:
+}
+
+
+@serializable.serializable_class
+class HashType:
+ """
+ This is our internal representation of the hashType complex type within the CycloneDX standard.
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_hashType
+ """
+
+ @staticmethod
+ def from_hashlib_alg(hashlib_alg: str, content: str) -> 'HashType':
+ """
+ Attempts to convert a hashlib-algorithm to our internal model classes.
+
+ Args:
+ hashlib_alg:
+ Hash algorith - like it is used by `hashlib`.
+ Example: `sha256`.
+
+ content:
+ Hash value.
+
+ Raises:
+ `UnknownHashTypeException` if the algorithm of hash cannot be determined.
+
+ Returns:
+ An instance of `HashType`.
+ """
+ alg = _MAP_HASHLIB.get(hashlib_alg.lower())
+ if alg is None:
+ raise UnknownHashTypeException(f'Unable to determine hash alg for {hashlib_alg!r}')
+ return HashType(alg=alg, content=content)
+
+ @staticmethod
+ def from_composite_str(composite_hash: str) -> 'HashType':
+ """
+ Attempts to convert a string which includes both the Hash Algorithm and Hash Value and represent using our
+ internal model classes.
+
+ Args:
+ composite_hash:
+ Composite Hash string of the format `HASH_ALGORITHM`:`HASH_VALUE`.
+ Example: `sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b`.
+
+ Valid case insensitive prefixes are:
+ `md5`, `sha1`, `sha256`, `sha384`, `sha512`, `blake2b256`, `blake2b384`, `blake2b512`,
+ `blake2256`, `blake2384`, `blake2512`, `sha3-256`, `sha3-384`, `sha3-512`,
+ `blake3`.
+
+ Raises:
+ `UnknownHashTypeException` if the type of hash cannot be determined.
+
+ Returns:
+ An instance of `HashType`.
+ """
+ parts = composite_hash.split(':')
+
+ algorithm_prefix = parts[0].lower()
+ if algorithm_prefix == 'md5':
+ return HashType(
+ alg=HashAlgorithm.MD5,
+ content=parts[1].lower()
+ )
+ elif algorithm_prefix[0:4] == 'sha3':
+ return HashType(
+ alg=getattr(HashAlgorithm, f'SHA3_{algorithm_prefix[5:]}'),
+ content=parts[1].lower()
+ )
+ elif algorithm_prefix == 'sha1':
+ return HashType(
+ alg=HashAlgorithm.SHA_1,
+ content=parts[1].lower()
+ )
+ elif algorithm_prefix[0:3] == 'sha':
+ # This is actually SHA2...
+ return HashType(
+ alg=getattr(HashAlgorithm, f'SHA_{algorithm_prefix[3:]}'),
+ content=parts[1].lower()
+ )
+ elif algorithm_prefix[0:7] == 'blake2b':
+ return HashType(
+ alg=getattr(HashAlgorithm, f'BLAKE2B_{algorithm_prefix[7:]}'),
+ content=parts[1].lower()
+ )
+ elif algorithm_prefix[0:6] == 'blake2':
+ return HashType(
+ alg=getattr(HashAlgorithm, f'BLAKE2B_{algorithm_prefix[6:]}'),
+ content=parts[1].lower()
+ )
+ elif algorithm_prefix[0:6] == 'blake3':
+ return HashType(
+ alg=HashAlgorithm.BLAKE3,
+ content=parts[1].lower()
+ )
+ raise UnknownHashTypeException(f'Unable to determine hash type from {composite_hash!r}')
+
+ def __init__(
+ self, *,
+ alg: HashAlgorithm,
+ content: str,
+ ) -> None:
+ self.alg = alg
+ self.content = content
+
+ @property
+ @serializable.xml_attribute()
+ def alg(self) -> HashAlgorithm:
+ """
+ Specifies the algorithm used to create the hash.
+
+ Returns:
+ `HashAlgorithm`
+ """
+ return self._alg
+
+ @alg.setter
+ def alg(self, alg: HashAlgorithm) -> None:
+ self._alg = alg
+
+ @property
+ @serializable.xml_name('.')
+ @serializable.xml_string(serializable.XmlStringSerializationType.TOKEN)
+ def content(self) -> str:
+ """
+ Hash value content.
+
+ Returns:
+ `str`
+ """
+ return self._content
+
+ @content.setter
+ def content(self, content: str) -> None:
+ self._content = content
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.alg, self.content
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, HashType):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, HashType):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class ExternalReferenceType(str, Enum):
+ """
+ Enum object that defines the permissible 'types' for an External Reference according to the CycloneDX schema.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReferenceType
+ """
+ # see `_ExternalReferenceSerializationHelper.__CASES` for view/case map
+ ADVERSARY_MODEL = 'adversary-model' # Only supported in >= 1.5
+ ADVISORIES = 'advisories'
+ ATTESTATION = 'attestation' # Only supported in >= 1.5
+ BOM = 'bom'
+ BUILD_META = 'build-meta'
+ BUILD_SYSTEM = 'build-system'
+ CERTIFICATION_REPORT = 'certification-report' # Only supported in >= 1.5
+ CHAT = 'chat'
+ CODIFIED_INFRASTRUCTURE = 'codified-infrastructure' # Only supported in >= 1.5
+ COMPONENT_ANALYSIS_REPORT = 'component-analysis-report' # Only supported in >= 1.5
+ CONFIGURATION = 'configuration' # Only supported in >= 1.5
+ DIGITAL_SIGNATURE = 'digital-signature' # Only supported in >= 1.6
+ DISTRIBUTION = 'distribution'
+ DISTRIBUTION_INTAKE = 'distribution-intake' # Only supported in >= 1.5
+ DOCUMENTATION = 'documentation'
+ DYNAMIC_ANALYSIS_REPORT = 'dynamic-analysis-report' # Only supported in >= 1.5
+ ELECTRONIC_SIGNATURE = 'electronic-signature' # Only supported in >= 1.6
+ EVIDENCE = 'evidence' # Only supported in >= 1.5
+ EXPLOITABILITY_STATEMENT = 'exploitability-statement' # Only supported in >= 1.5
+ FORMULATION = 'formulation' # Only supported in >= 1.5
+ ISSUE_TRACKER = 'issue-tracker'
+ LICENSE = 'license'
+ LOG = 'log' # Only supported in >= 1.5
+ MAILING_LIST = 'mailing-list'
+ MATURITY_REPORT = 'maturity-report' # Only supported in >= 1.5
+ MODEL_CARD = 'model-card' # Only supported in >= 1.5
+ PENTEST_REPORT = 'pentest-report' # Only supported in >= 1.5
+ POAM = 'poam' # Only supported in >= 1.5
+ QUALITY_METRICS = 'quality-metrics' # Only supported in >= 1.5
+ RELEASE_NOTES = 'release-notes' # Only supported in >= 1.4
+ RFC_9166 = 'rfc-9116' # Only supported in >= 1.6
+ RISK_ASSESSMENT = 'risk-assessment' # Only supported in >= 1.5
+ RUNTIME_ANALYSIS_REPORT = 'runtime-analysis-report' # Only supported in >= 1.5
+ SECURITY_CONTACT = 'security-contact' # Only supported in >= 1.5
+ STATIC_ANALYSIS_REPORT = 'static-analysis-report' # Only supported in >= 1.5
+ SOCIAL = 'social'
+ SOURCE_DISTRIBUTION = 'source-distribution' # Only supported in >= 1.6
+ SCM = 'vcs'
+ SUPPORT = 'support'
+ THREAT_MODEL = 'threat-model' # Only supported in >= 1.5
+ VCS = 'vcs'
+ VULNERABILITY_ASSERTION = 'vulnerability-assertion' # Only supported in >= 1.5
+ WEBSITE = 'website'
+ # --
+ OTHER = 'other'
+
+
+class _ExternalReferenceSerializationHelper(serializable.helpers.BaseHelper):
+ """ THIS CLASS IS NON-PUBLIC API """
+
+ __CASES: Dict[Type[serializable.ViewType], FrozenSet[ExternalReferenceType]] = dict()
+ __CASES[SchemaVersion1Dot1] = frozenset({
+ ExternalReferenceType.VCS,
+ ExternalReferenceType.ISSUE_TRACKER,
+ ExternalReferenceType.WEBSITE,
+ ExternalReferenceType.ADVISORIES,
+ ExternalReferenceType.BOM,
+ ExternalReferenceType.MAILING_LIST,
+ ExternalReferenceType.SOCIAL,
+ ExternalReferenceType.CHAT,
+ ExternalReferenceType.DOCUMENTATION,
+ ExternalReferenceType.SUPPORT,
+ ExternalReferenceType.DISTRIBUTION,
+ ExternalReferenceType.LICENSE,
+ ExternalReferenceType.BUILD_META,
+ ExternalReferenceType.BUILD_SYSTEM,
+ ExternalReferenceType.OTHER,
+ })
+ __CASES[SchemaVersion1Dot2] = __CASES[SchemaVersion1Dot1]
+ __CASES[SchemaVersion1Dot3] = __CASES[SchemaVersion1Dot2]
+ __CASES[SchemaVersion1Dot4] = __CASES[SchemaVersion1Dot3] | {
+ ExternalReferenceType.RELEASE_NOTES
+ }
+ __CASES[SchemaVersion1Dot5] = __CASES[SchemaVersion1Dot4] | {
+ ExternalReferenceType.DISTRIBUTION_INTAKE,
+ ExternalReferenceType.SECURITY_CONTACT,
+ ExternalReferenceType.MODEL_CARD,
+ ExternalReferenceType.LOG,
+ ExternalReferenceType.CONFIGURATION,
+ ExternalReferenceType.EVIDENCE,
+ ExternalReferenceType.FORMULATION,
+ ExternalReferenceType.ATTESTATION,
+ ExternalReferenceType.THREAT_MODEL,
+ ExternalReferenceType.ADVERSARY_MODEL,
+ ExternalReferenceType.RISK_ASSESSMENT,
+ ExternalReferenceType.VULNERABILITY_ASSERTION,
+ ExternalReferenceType.EXPLOITABILITY_STATEMENT,
+ ExternalReferenceType.PENTEST_REPORT,
+ ExternalReferenceType.STATIC_ANALYSIS_REPORT,
+ ExternalReferenceType.DYNAMIC_ANALYSIS_REPORT,
+ ExternalReferenceType.RUNTIME_ANALYSIS_REPORT,
+ ExternalReferenceType.COMPONENT_ANALYSIS_REPORT,
+ ExternalReferenceType.MATURITY_REPORT,
+ ExternalReferenceType.CERTIFICATION_REPORT,
+ ExternalReferenceType.QUALITY_METRICS,
+ ExternalReferenceType.CODIFIED_INFRASTRUCTURE,
+ ExternalReferenceType.POAM,
+ }
+ __CASES[SchemaVersion1Dot6] = __CASES[SchemaVersion1Dot5] | {
+ ExternalReferenceType.SOURCE_DISTRIBUTION,
+ ExternalReferenceType.ELECTRONIC_SIGNATURE,
+ ExternalReferenceType.DIGITAL_SIGNATURE,
+ ExternalReferenceType.RFC_9166,
+ }
+
+ @classmethod
+ def __normalize(cls, extref: ExternalReferenceType, view: Type[serializable.ViewType]) -> str:
+ return (
+ extref
+ if extref in cls.__CASES.get(view, ())
+ else ExternalReferenceType.OTHER
+ ).value
+
+ @classmethod
+ def json_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> str:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def xml_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> str:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def deserialize(cls, o: Any) -> ExternalReferenceType:
+ return ExternalReferenceType(o)
+
+
+@serializable.serializable_class
+class XsUri(serializable.helpers.BaseHelper):
+ """
+ Helper class that allows us to perform validation on data strings that are defined as xs:anyURI
+ in CycloneDX schema.
+
+ Developers can just use this via `str(XsUri('https://www.google.com'))`.
+
+ .. note::
+ See XSD definition for xsd:anyURI: http://www.datypic.com/sc/xsd/t-xsd_anyURI.html
+ See JSON Schema definition for iri-reference: https://tools.ietf.org/html/rfc3987
+ """
+
+ _INVALID_URI_REGEX = re.compile(r'%(?![0-9A-F]{2})|#.*#', re.IGNORECASE + re.MULTILINE)
+
+ __SPEC_REPLACEMENTS = (
+ (' ', '%20'),
+ ('"', '%22'),
+ ("'", '%27'),
+ ('[', '%5B'),
+ (']', '%5D'),
+ ('<', '%3C'),
+ ('>', '%3E'),
+ ('{', '%7B'),
+ ('}', '%7D'),
+ )
+
+ @staticmethod
+ def __spec_replace(v: str, r: Tuple[str, str]) -> str:
+ return v.replace(*r)
+
+ @classmethod
+ def _spec_migrate(cls, o: str) -> str:
+ """
+ Make a string valid to
+ - XML::anyURI spec.
+ - JSON::iri-reference spec.
+
+ BEST EFFORT IMPLEMENTATION
+
+ @see http://www.w3.org/TR/xmlschema-2/#anyURI
+ @see http://www.datypic.com/sc/xsd/t-xsd_anyURI.html
+ @see https://datatracker.ietf.org/doc/html/rfc2396
+ @see https://datatracker.ietf.org/doc/html/rfc3987
+ """
+ return reduce(cls.__spec_replace, cls.__SPEC_REPLACEMENTS, o)
+
+ def __init__(self, uri: str) -> None:
+ if re.search(XsUri._INVALID_URI_REGEX, uri):
+ raise InvalidUriException(
+ f"Supplied value '{uri}' does not appear to be a valid URI."
+ )
+ self._uri = self._spec_migrate(uri)
+
+ def __eq__(self, other: Any) -> bool:
+ if isinstance(other, XsUri):
+ return self._uri == other._uri
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, XsUri):
+ return self._uri < other._uri
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self._uri)
+
+ def __repr__(self) -> str:
+ return f''
+
+ def __str__(self) -> str:
+ return self._uri
+
+ @property
+ @serializable.json_name('.')
+ @serializable.xml_name('.')
+ def uri(self) -> str:
+ return self._uri
+
+ @classmethod
+ def serialize(cls, o: Any) -> str:
+ if isinstance(o, XsUri):
+ return str(o)
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-XsUri: {o!r}')
+
+ @classmethod
+ def deserialize(cls, o: Any) -> 'XsUri':
+ try:
+ return XsUri(uri=str(o))
+ except ValueError as err:
+ raise CycloneDxDeserializationException(
+ f'XsUri string supplied does not parse: {o!r}'
+ ) from err
+
+ @classmethod
+ def make_bom_link(
+ cls,
+ serial_number: Union[UUID, str],
+ version: int = 1,
+ bom_ref: Optional[Union[str, BomRef]] = None
+ ) -> 'XsUri':
+ """
+ Generate a BOM-Link URI.
+
+ Args:
+ serial_number: The unique serial number of the BOM.
+ version: The version of the BOM. The default version is 1.
+ bom_ref: The unique identifier of the component, service, or vulnerability within the BOM.
+
+ Returns:
+ XsUri: Instance of XsUri with the generated BOM-Link URI.
+ """
+ bom_ref_part = f'#{url_quote(str(bom_ref))}' if bom_ref else ''
+ return cls(f'{_BOM_LINK_PREFIX}{serial_number}/{version}{bom_ref_part}')
+
+ def is_bom_link(self) -> bool:
+ """
+ Check if the URI is a BOM-Link.
+
+ Returns:
+ `bool`
+ """
+ return self._uri.startswith(_BOM_LINK_PREFIX)
+
+
+@serializable.serializable_class
+class ExternalReference:
+ """
+ This is our internal representation of an ExternalReference complex type that can be used in multiple places within
+ a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReference
+ """
+
+ def __init__(
+ self, *,
+ type: ExternalReferenceType,
+ url: XsUri,
+ comment: Optional[str] = None,
+ hashes: Optional[Iterable[HashType]] = None,
+ ) -> None:
+ self.url = url
+ self.comment = comment
+ self.type = type
+ self.hashes = hashes or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(1)
+ def url(self) -> XsUri:
+ """
+ The URL to the external reference.
+
+ Returns:
+ `XsUri`
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: XsUri) -> None:
+ self._url = url
+
+ @property
+ def comment(self) -> Optional[str]:
+ """
+ An optional comment describing the external reference.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._comment
+
+ @comment.setter
+ def comment(self, comment: Optional[str]) -> None:
+ self._comment = comment
+
+ @property
+ @serializable.type_mapping(_ExternalReferenceSerializationHelper)
+ @serializable.xml_attribute()
+ def type(self) -> ExternalReferenceType:
+ """
+ Specifies the type of external reference.
+
+ There are built-in types to describe common references. If a type does not exist for the reference being
+ referred to, use the "other" type.
+
+ Returns:
+ `ExternalReferenceType`
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: ExternalReferenceType) -> None:
+ self._type = type
+
+ @property
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.type_mapping(_HashTypeRepositorySerializationHelper)
+ def hashes(self) -> 'SortedSet[HashType]':
+ """
+ The hashes of the external reference (if applicable).
+
+ Returns:
+ Set of `HashType`
+ """
+ return self._hashes
+
+ @hashes.setter
+ def hashes(self, hashes: Iterable[HashType]) -> None:
+ self._hashes = SortedSet(hashes)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self._type, self._url, self._comment,
+ _ComparableTuple(self._hashes)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, ExternalReference):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, ExternalReference):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Property:
+ """
+ This is our internal representation of `propertyType` complex type that can be used in multiple places within
+ a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_propertyType
+
+ Specifies an individual property with a name and value.
+ """
+
+ def __init__(
+ self, *,
+ name: str,
+ value: Optional[str] = None,
+ ) -> None:
+ self.name = name
+ self.value = value
+
+ @property
+ @serializable.xml_attribute()
+ def name(self) -> str:
+ """
+ The name of the property.
+
+ Duplicate names are allowed, each potentially having a different value.
+
+ Returns:
+ `str`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_name('.')
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def value(self) -> Optional[str]:
+ """
+ Value of this Property.
+
+ Returns:
+ `str`
+ """
+ return self._value
+
+ @value.setter
+ def value(self, value: Optional[str]) -> None:
+ self._value = value
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.name, self.value
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Property):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Property):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class NoteText:
+ """
+ This is our internal representation of the Note.text complex type that can be used in multiple places within
+ a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_releaseNotesType
+ """
+
+ DEFAULT_CONTENT_TYPE: str = 'text/plain'
+
+ def __init__(
+ self, *,
+ content: str,
+ content_type: Optional[str] = None,
+ encoding: Optional[Encoding] = None,
+ ) -> None:
+ self.content = content
+ self.content_type = content_type or NoteText.DEFAULT_CONTENT_TYPE
+ self.encoding = encoding
+
+ @property
+ @serializable.xml_name('.')
+ def content(self) -> str:
+ """
+ Get the text content of this Note.
+
+ Returns:
+ `str` note content
+ """
+ return self._content
+
+ @content.setter
+ def content(self, content: str) -> None:
+ self._content = content
+
+ @property
+ @serializable.xml_attribute()
+ @serializable.xml_name('content-type')
+ def content_type(self) -> Optional[str]:
+ """
+ Get the content-type of this Note.
+
+ Defaults to 'text/plain' if one was not explicitly specified.
+
+ Returns:
+ `str` content-type
+ """
+ return self._content_type
+
+ @content_type.setter
+ def content_type(self, content_type: str) -> None:
+ self._content_type = content_type
+
+ @property
+ @serializable.xml_attribute()
+ def encoding(self) -> Optional[Encoding]:
+ """
+ Get the encoding method used for the note's content.
+
+ Returns:
+ `Encoding` if set else `None`
+ """
+ return self._encoding
+
+ @encoding.setter
+ def encoding(self, encoding: Optional[Encoding]) -> None:
+ self._encoding = encoding
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.content, self.content_type, self.encoding
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, NoteText):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, NoteText):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Note:
+ """
+ This is our internal representation of the Note complex type that can be used in multiple places within
+ a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_releaseNotesType
+
+ @todo: Replace ``NoteText`` with ``AttachedText``?
+ """
+
+ _LOCALE_TYPE_REGEX = re.compile(r'^[a-z]{2}(?:\-[A-Z]{2})?$')
+
+ def __init__(
+ self, *,
+ text: NoteText,
+ locale: Optional[str] = None,
+ ) -> None:
+ self.text = text
+ self.locale = locale
+
+ @property
+ def text(self) -> NoteText:
+ """
+ Specifies the full content of the release note.
+
+ Returns:
+ `NoteText`
+ """
+ return self._text
+
+ @text.setter
+ def text(self, text: NoteText) -> None:
+ self._text = text
+
+ @property
+ @serializable.xml_sequence(1)
+ def locale(self) -> Optional[str]:
+ """
+ Get the ISO locale of this Note.
+
+ The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code.
+
+ Examples include: "en", "en-US", "fr" and "fr-CA".
+
+ Returns:
+ `str` locale if set else `None`
+ """
+ return self._locale
+
+ @locale.setter
+ def locale(self, locale: Optional[str]) -> None:
+ self._locale = locale
+ if isinstance(locale, str):
+ if not re.search(Note._LOCALE_TYPE_REGEX, locale):
+ self._locale = None
+ raise InvalidLocaleTypeException(
+ f'Supplied locale {locale!r} is not a valid locale.'
+ ' Locale string should be formatted as the ISO-639 (or higher) language code and optional'
+ " ISO-3166 (or higher) country code. according to ISO-639 format. Examples include: 'en', 'en-US'."
+ )
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.locale, self.text
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Note):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Note):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class IdentifiableAction:
+ """
+ This is our internal representation of the `identifiableActionType` complex type.
+
+ .. note::
+ See the CycloneDX specification: https://cyclonedx.org/docs/1.6/xml/#type_identifiableActionType
+ """
+
+ def __init__(
+ self, *,
+ timestamp: Optional[datetime] = None,
+ name: Optional[str] = None,
+ email: Optional[str] = None,
+ ) -> None:
+ self.timestamp = timestamp
+ self.name = name
+ self.email = email
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ def timestamp(self) -> Optional[datetime]:
+ """
+ The timestamp in which the action occurred.
+
+ Returns:
+ `datetime` if set else `None`
+ """
+ return self._timestamp
+
+ @timestamp.setter
+ def timestamp(self, timestamp: Optional[datetime]) -> None:
+ self._timestamp = timestamp
+
+ @property
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ The name of the individual who performed the action.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def email(self) -> Optional[str]:
+ """
+ The email address of the individual who performed the action.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._email
+
+ @email.setter
+ def email(self, email: Optional[str]) -> None:
+ self._email = email
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.timestamp, self.name, self.email
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, IdentifiableAction):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, IdentifiableAction):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Copyright:
+ """
+ This is our internal representation of the `copyrightsType` complex type.
+
+ .. note::
+ See the CycloneDX specification: https://cyclonedx.org/docs/1.6/xml/#type_copyrightsType
+ """
+
+ def __init__(
+ self, *,
+ text: str,
+ ) -> None:
+ self.text = text
+
+ @property
+ @serializable.xml_name('.')
+ def text(self) -> str:
+ """
+ Copyright statement.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._text
+
+ @text.setter
+ def text(self, text: str) -> None:
+ self._text = text
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Copyright):
+ return self._text == other._text
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Copyright):
+ return self._text < other._text
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self._text)
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..8bd8721a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/bom.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/bom.cpython-312.pyc
new file mode 100644
index 00000000..fe9001d9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/bom.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/bom_ref.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/bom_ref.cpython-312.pyc
new file mode 100644
index 00000000..18f1142e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/bom_ref.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/component.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/component.cpython-312.pyc
new file mode 100644
index 00000000..9d75634e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/component.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/contact.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/contact.cpython-312.pyc
new file mode 100644
index 00000000..f2655626
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/contact.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/crypto.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/crypto.cpython-312.pyc
new file mode 100644
index 00000000..f69a66a9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/crypto.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/definition.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/definition.cpython-312.pyc
new file mode 100644
index 00000000..85190653
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/definition.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/dependency.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/dependency.cpython-312.pyc
new file mode 100644
index 00000000..d228f54a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/dependency.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/impact_analysis.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/impact_analysis.cpython-312.pyc
new file mode 100644
index 00000000..c6cb9d96
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/impact_analysis.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/issue.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/issue.cpython-312.pyc
new file mode 100644
index 00000000..f4e26752
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/issue.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/license.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/license.cpython-312.pyc
new file mode 100644
index 00000000..ebd10b62
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/license.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/lifecycle.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/lifecycle.cpython-312.pyc
new file mode 100644
index 00000000..e7c85ea3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/lifecycle.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/release_note.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/release_note.cpython-312.pyc
new file mode 100644
index 00000000..d0052a32
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/release_note.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/service.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/service.cpython-312.pyc
new file mode 100644
index 00000000..73120f8e
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/service.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/tool.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/tool.cpython-312.pyc
new file mode 100644
index 00000000..7c8dca91
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/tool.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/vulnerability.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/vulnerability.cpython-312.pyc
new file mode 100644
index 00000000..d96b6dc1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/__pycache__/vulnerability.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/bom.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/bom.py
new file mode 100644
index 00000000..130074ee
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/bom.py
@@ -0,0 +1,748 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from datetime import datetime
+from itertools import chain
+from typing import TYPE_CHECKING, Generator, Iterable, Optional, Union
+from uuid import UUID, uuid4
+from warnings import warn
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from .._internal.time import get_now_utc as _get_now_utc
+from ..exception.model import LicenseExpressionAlongWithOthersException, UnknownComponentDependencyException
+from ..schema.schema import (
+ SchemaVersion1Dot0,
+ SchemaVersion1Dot1,
+ SchemaVersion1Dot2,
+ SchemaVersion1Dot3,
+ SchemaVersion1Dot4,
+ SchemaVersion1Dot5,
+ SchemaVersion1Dot6,
+)
+from ..serialization import UrnUuidHelper
+from . import _BOM_LINK_PREFIX, ExternalReference, Property
+from .bom_ref import BomRef
+from .component import Component
+from .contact import OrganizationalContact, OrganizationalEntity
+from .definition import Definitions
+from .dependency import Dependable, Dependency
+from .license import License, LicenseExpression, LicenseRepository, _LicenseRepositorySerializationHelper
+from .lifecycle import Lifecycle, LifecycleRepository, _LifecycleRepositoryHelper
+from .service import Service
+from .tool import Tool, ToolRepository, _ToolRepositoryHelper
+from .vulnerability import Vulnerability
+
+if TYPE_CHECKING: # pragma: no cover
+ from packageurl import PackageURL
+
+
+@serializable.serializable_class
+class BomMetaData:
+ """
+ This is our internal representation of the metadata complex type within the CycloneDX standard.
+
+ .. note::
+ See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata
+ """
+
+ def __init__(
+ self, *,
+ tools: Optional[Union[Iterable[Tool], ToolRepository]] = None,
+ authors: Optional[Iterable[OrganizationalContact]] = None,
+ component: Optional[Component] = None,
+ supplier: Optional[OrganizationalEntity] = None,
+ licenses: Optional[Iterable[License]] = None,
+ properties: Optional[Iterable[Property]] = None,
+ timestamp: Optional[datetime] = None,
+ manufacturer: Optional[OrganizationalEntity] = None,
+ lifecycles: Optional[Iterable[Lifecycle]] = None,
+ # Deprecated as of v1.6
+ manufacture: Optional[OrganizationalEntity] = None,
+ ) -> None:
+ self.timestamp = timestamp or _get_now_utc()
+ self.tools = tools or [] # type:ignore[assignment]
+ self.authors = authors or [] # type:ignore[assignment]
+ self.component = component
+ self.supplier = supplier
+ self.licenses = licenses or [] # type:ignore[assignment]
+ self.properties = properties or [] # type:ignore[assignment]
+ self.manufacturer = manufacturer
+ self.lifecycles = lifecycles or [] # type:ignore[assignment]
+
+ self.manufacture = manufacture
+ if manufacture:
+ warn(
+ '`bom.metadata.manufacture` is deprecated from CycloneDX v1.6 onwards. '
+ 'Please use `bom.metadata.component.manufacturer` instead.',
+ DeprecationWarning)
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(1)
+ def timestamp(self) -> datetime:
+ """
+ The date and time (in UTC) when this BomMetaData was created.
+
+ Returns:
+ `datetime` instance in UTC timezone
+ """
+ return self._timestamp
+
+ @timestamp.setter
+ def timestamp(self, timestamp: datetime) -> None:
+ self._timestamp = timestamp
+
+ @property
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.type_mapping(_LifecycleRepositoryHelper)
+ @serializable.xml_sequence(2)
+ def lifecycles(self) -> LifecycleRepository:
+ """
+ An optional list of BOM lifecycle stages.
+
+ Returns:
+ Set of `Lifecycle`
+ """
+ return self._lifecycles
+
+ @lifecycles.setter
+ def lifecycles(self, lifecycles: Iterable[Lifecycle]) -> None:
+ self._lifecycles = LifecycleRepository(lifecycles)
+
+ @property
+ @serializable.type_mapping(_ToolRepositoryHelper)
+ @serializable.xml_sequence(3)
+ def tools(self) -> ToolRepository:
+ """
+ Tools used to create this BOM.
+
+ Returns:
+ :class:`ToolRepository` object.
+ """
+ return self._tools
+
+ @tools.setter
+ def tools(self, tools: Union[Iterable[Tool], ToolRepository]) -> None:
+ self._tools = tools \
+ if isinstance(tools, ToolRepository) \
+ else ToolRepository(tools=tools)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'author')
+ @serializable.xml_sequence(4)
+ def authors(self) -> 'SortedSet[OrganizationalContact]':
+ """
+ The person(s) who created the BOM.
+
+ Authors are common in BOMs created through manual processes.
+
+ BOMs created through automated means may not have authors.
+
+ Returns:
+ Set of `OrganizationalContact`
+ """
+ return self._authors
+
+ @authors.setter
+ def authors(self, authors: Iterable[OrganizationalContact]) -> None:
+ self._authors = SortedSet(authors)
+
+ @property
+ @serializable.xml_sequence(5)
+ def component(self) -> Optional[Component]:
+ """
+ The (optional) component that the BOM describes.
+
+ Returns:
+ `cyclonedx.model.component.Component` instance for this Bom Metadata.
+ """
+ return self._component
+
+ @component.setter
+ def component(self, component: Component) -> None:
+ """
+ The (optional) component that the BOM describes.
+
+ Args:
+ component
+ `cyclonedx.model.component.Component` instance to add to this Bom Metadata.
+
+ Returns:
+ None
+ """
+ self._component = component
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(6)
+ def manufacture(self) -> Optional[OrganizationalEntity]:
+ """
+ The organization that manufactured the component that the BOM describes.
+
+ Returns:
+ `OrganizationalEntity` if set else `None`
+ """
+ return self._manufacture
+
+ @manufacture.setter
+ def manufacture(self, manufacture: Optional[OrganizationalEntity]) -> None:
+ """
+ @todo Based on https://github.com/CycloneDX/specification/issues/346,
+ we should set this data on `.component.manufacturer`.
+ """
+ self._manufacture = manufacture
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(7)
+ def manufacturer(self) -> Optional[OrganizationalEntity]:
+ """
+ The organization that created the BOM.
+ Manufacturer is common in BOMs created through automated processes. BOMs created through manual means may have
+ `@.authors` instead.
+
+ Returns:
+ `OrganizationalEntity` if set else `None`
+ """
+ return self._manufacturer
+
+ @manufacturer.setter
+ def manufacturer(self, manufacturer: Optional[OrganizationalEntity]) -> None:
+ self._manufacturer = manufacturer
+
+ @property
+ @serializable.xml_sequence(8)
+ def supplier(self) -> Optional[OrganizationalEntity]:
+ """
+ The organization that supplied the component that the BOM describes.
+
+ The supplier may often be the manufacturer, but may also be a distributor or repackager.
+
+ Returns:
+ `OrganizationalEntity` if set else `None`
+ """
+ return self._supplier
+
+ @supplier.setter
+ def supplier(self, supplier: Optional[OrganizationalEntity]) -> None:
+ self._supplier = supplier
+
+ @property
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.type_mapping(_LicenseRepositorySerializationHelper)
+ @serializable.xml_sequence(9)
+ def licenses(self) -> LicenseRepository:
+ """
+ A optional list of statements about how this BOM is licensed.
+
+ Returns:
+ Set of `LicenseChoice`
+ """
+ return self._licenses
+
+ @licenses.setter
+ def licenses(self, licenses: Iterable[License]) -> None:
+ self._licenses = LicenseRepository(licenses)
+
+ @property
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
+ @serializable.xml_sequence(10)
+ def properties(self) -> 'SortedSet[Property]':
+ """
+ Provides the ability to document properties in a key/value store. This provides flexibility to include data not
+ officially supported in the standard without having to use additional namespaces or create extensions.
+
+ Property names of interest to the general public are encouraged to be registered in the CycloneDX Property
+ Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy. Formal registration is OPTIONAL.
+
+ Return:
+ Set of `Property`
+ """
+ return self._properties
+
+ @properties.setter
+ def properties(self, properties: Iterable[Property]) -> None:
+ self._properties = SortedSet(properties)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ _ComparableTuple(self.authors), self.component, _ComparableTuple(self.licenses), self.manufacture,
+ _ComparableTuple(self.properties),
+ _ComparableTuple(self.lifecycles), self.supplier, self.timestamp, self.tools, self.manufacturer
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, BomMetaData):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class(ignore_during_deserialization=['$schema', 'bom_format', 'spec_version'])
+class Bom:
+ """
+ This is our internal representation of a bill-of-materials (BOM).
+
+ Once you have an instance of `cyclonedx.model.bom.Bom`, you can pass this to an instance of
+ `cyclonedx.output.BaseOutput` to produce a CycloneDX document according to a specific schema version and format.
+ """
+
+ def __init__(
+ self, *,
+ components: Optional[Iterable[Component]] = None,
+ services: Optional[Iterable[Service]] = None,
+ external_references: Optional[Iterable[ExternalReference]] = None,
+ serial_number: Optional[UUID] = None,
+ version: int = 1,
+ metadata: Optional[BomMetaData] = None,
+ dependencies: Optional[Iterable[Dependency]] = None,
+ vulnerabilities: Optional[Iterable[Vulnerability]] = None,
+ properties: Optional[Iterable[Property]] = None,
+ definitions: Optional[Definitions] = None,
+ ) -> None:
+ """
+ Create a new Bom that you can manually/programmatically add data to later.
+
+ Returns:
+ New, empty `cyclonedx.model.bom.Bom` instance.
+ """
+ self.serial_number = serial_number or uuid4()
+ self.version = version
+ self.metadata = metadata or BomMetaData()
+ self.components = components or [] # type:ignore[assignment]
+ self.services = services or [] # type:ignore[assignment]
+ self.external_references = external_references or [] # type:ignore[assignment]
+ self.vulnerabilities = vulnerabilities or [] # type:ignore[assignment]
+ self.dependencies = dependencies or [] # type:ignore[assignment]
+ self.properties = properties or [] # type:ignore[assignment]
+ self.definitions = definitions or Definitions()
+
+ @property
+ @serializable.type_mapping(UrnUuidHelper)
+ @serializable.view(SchemaVersion1Dot1)
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_attribute()
+ def serial_number(self) -> UUID:
+ """
+ Unique UUID for this BOM
+
+ Returns:
+ `UUID` instance
+ `UUID` instance
+ """
+ return self._serial_number
+
+ @serial_number.setter
+ def serial_number(self, serial_number: UUID) -> None:
+ self._serial_number = serial_number
+
+ @property
+ @serializable.xml_attribute()
+ def version(self) -> int:
+ return self._version
+
+ @version.setter
+ def version(self, version: int) -> None:
+ self._version = version
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(10)
+ def metadata(self) -> BomMetaData:
+ """
+ Get our internal metadata object for this Bom.
+
+ Returns:
+ Metadata object instance for this Bom.
+
+ .. note::
+ See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata
+ """
+ return self._metadata
+
+ @metadata.setter
+ def metadata(self, metadata: BomMetaData) -> None:
+ self._metadata = metadata
+
+ @property
+ @serializable.include_none(SchemaVersion1Dot0)
+ @serializable.include_none(SchemaVersion1Dot1)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'component')
+ @serializable.xml_sequence(20)
+ def components(self) -> 'SortedSet[Component]':
+ """
+ Get all the Components currently in this Bom.
+
+ Returns:
+ Set of `Component` in this Bom
+ """
+ return self._components
+
+ @components.setter
+ def components(self, components: Iterable[Component]) -> None:
+ self._components = SortedSet(components)
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'service')
+ @serializable.xml_sequence(30)
+ def services(self) -> 'SortedSet[Service]':
+ """
+ Get all the Services currently in this Bom.
+
+ Returns:
+ Set of `Service` in this BOM
+ """
+ return self._services
+
+ @services.setter
+ def services(self, services: Iterable[Service]) -> None:
+ self._services = SortedSet(services)
+
+ @property
+ @serializable.view(SchemaVersion1Dot1)
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'reference')
+ @serializable.xml_sequence(40)
+ def external_references(self) -> 'SortedSet[ExternalReference]':
+ """
+ Provides the ability to document external references related to the BOM or to the project the BOM describes.
+
+ Returns:
+ Set of `ExternalReference`
+ """
+ return self._external_references
+
+ @external_references.setter
+ def external_references(self, external_references: Iterable[ExternalReference]) -> None:
+ self._external_references = SortedSet(external_references)
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'dependency')
+ @serializable.xml_sequence(50)
+ def dependencies(self) -> 'SortedSet[Dependency]':
+ return self._dependencies
+
+ @dependencies.setter
+ def dependencies(self, dependencies: Iterable[Dependency]) -> None:
+ self._dependencies = SortedSet(dependencies)
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot3)
+ # @serializable.view(SchemaVersion1Dot4)
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(6)
+ # def compositions(self) -> ...:
+ # ... # TODO Since CDX 1.3
+ #
+ # @compositions.setter
+ # def compositions(self, ...) -> None:
+ # ... # TODO Since CDX 1.3
+
+ @property
+ # @serializable.view(SchemaVersion1Dot3) @todo: Update py-serializable to support view by OutputFormat filtering
+ # @serializable.view(SchemaVersion1Dot4) @todo: Update py-serializable to support view by OutputFormat filtering
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
+ @serializable.xml_sequence(70)
+ def properties(self) -> 'SortedSet[Property]':
+ """
+ Provides the ability to document properties in a name/value store. This provides flexibility to include data
+ not officially supported in the standard without having to use additional namespaces or create extensions.
+ Property names of interest to the general public are encouraged to be registered in the CycloneDX Property
+ Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy. Formal registration is OPTIONAL.
+
+ Return:
+ Set of `Property`
+ """
+ return self._properties
+
+ @properties.setter
+ def properties(self, properties: Iterable[Property]) -> None:
+ self._properties = SortedSet(properties)
+
+ @property
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'vulnerability')
+ @serializable.xml_sequence(80)
+ def vulnerabilities(self) -> 'SortedSet[Vulnerability]':
+ """
+ Get all the Vulnerabilities in this BOM.
+
+ Returns:
+ Set of `Vulnerability`
+ """
+ return self._vulnerabilities
+
+ @vulnerabilities.setter
+ def vulnerabilities(self, vulnerabilities: Iterable[Vulnerability]) -> None:
+ self._vulnerabilities = SortedSet(vulnerabilities)
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(9)
+ # def annotations(self) -> ...:
+ # ... # TODO Since CDX 1.5
+ #
+ # @annotations.setter
+ # def annotations(self, ...) -> None:
+ # ... # TODO Since CDX 1.5
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @formulation.xml_sequence(10)
+ # def formulation(self) -> ...:
+ # ... # TODO Since CDX 1.5
+ #
+ # @formulation.setter
+ # def formulation(self, ...) -> None:
+ # ... # TODO Since CDX 1.5
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(110)
+ def definitions(self) -> Optional[Definitions]:
+ """
+ The repository for definitions
+
+ Returns:
+ `Definitions`
+ """
+ return self._definitions if len(self._definitions.standards) > 0 else None
+
+ @definitions.setter
+ def definitions(self, definitions: Definitions) -> None:
+ self._definitions = definitions
+
+ def get_component_by_purl(self, purl: Optional['PackageURL']) -> Optional[Component]:
+ """
+ Get a Component already in the Bom by its PURL
+
+ Args:
+ purl:
+ An instance of `packageurl.PackageURL` to look and find `Component`.
+
+ Returns:
+ `Component` or `None`
+ """
+ if purl:
+ found = [x for x in self.components if x.purl == purl]
+ if len(found) == 1:
+ return found[0]
+
+ return None
+
+ def get_urn_uuid(self) -> str:
+ """
+ Get the unique reference for this Bom.
+
+ Returns:
+ URN formatted UUID that uniquely identified this Bom instance.
+ """
+ return self.serial_number.urn
+
+ def has_component(self, component: Component) -> bool:
+ """
+ Check whether this Bom contains the provided Component.
+
+ Args:
+ component:
+ The instance of `cyclonedx.model.component.Component` to check if this Bom contains.
+
+ Returns:
+ `bool` - `True` if the supplied Component is part of this Bom, `False` otherwise.
+ """
+ return component in self.components
+
+ def _get_all_components(self) -> Generator[Component, None, None]:
+ if self.metadata.component:
+ yield from self.metadata.component.get_all_nested_components(include_self=True)
+ for c in self.components:
+ yield from c.get_all_nested_components(include_self=True)
+
+ def get_vulnerabilities_for_bom_ref(self, bom_ref: BomRef) -> 'SortedSet[Vulnerability]':
+ """
+ Get all known Vulnerabilities that affect the supplied bom_ref.
+
+ Args:
+ bom_ref: `BomRef`
+
+ Returns:
+ `SortedSet` of `Vulnerability`
+ """
+
+ vulnerabilities: SortedSet[Vulnerability] = SortedSet()
+ for v in self.vulnerabilities:
+ for target in v.affects:
+ if target.ref == bom_ref.value:
+ vulnerabilities.add(v)
+ return vulnerabilities
+
+ def has_vulnerabilities(self) -> bool:
+ """
+ Check whether this Bom has any declared vulnerabilities.
+
+ Returns:
+ `bool` - `True` if this Bom has at least one Vulnerability, `False` otherwise.
+ """
+ return bool(self.vulnerabilities)
+
+ def register_dependency(self, target: Dependable, depends_on: Optional[Iterable[Dependable]] = None) -> None:
+ _d = next(filter(lambda _d: _d.ref == target.bom_ref, self.dependencies), None)
+ if _d:
+ # Dependency Target already registered - but it might have new dependencies to add
+ if depends_on:
+ _d.dependencies.update(map(lambda _d: Dependency(ref=_d.bom_ref), depends_on))
+ else:
+ # First time we are seeing this target as a Dependency
+ self._dependencies.add(Dependency(
+ ref=target.bom_ref,
+ dependencies=map(lambda _dep: Dependency(ref=_dep.bom_ref), depends_on) if depends_on else []
+ ))
+
+ if depends_on:
+ # Ensure dependents are registered with no further dependents in the DependencyGraph
+ for _d2 in depends_on:
+ self.register_dependency(target=_d2, depends_on=None)
+
+ def urn(self) -> str:
+ return f'{_BOM_LINK_PREFIX}{self.serial_number}/{self.version}'
+
+ def validate(self) -> bool:
+ """
+ Perform data-model level validations to make sure we have some known data integrity prior to attempting output
+ of this `Bom`
+
+ Returns:
+ `bool`
+ """
+ # 0. Make sure all Dependable have a Dependency entry
+ if self.metadata.component:
+ self.register_dependency(target=self.metadata.component)
+ for _c in self.components:
+ self.register_dependency(target=_c)
+ for _s in self.services:
+ self.register_dependency(target=_s)
+
+ # 1. Make sure dependencies are all in this Bom.
+ component_bom_refs = set(map(lambda c: c.bom_ref, self._get_all_components())) | set(
+ map(lambda s: s.bom_ref, self.services))
+ dependency_bom_refs = set(chain(
+ (d.ref for d in self.dependencies),
+ chain.from_iterable(d.dependencies_as_bom_refs() for d in self.dependencies)
+ ))
+ dependency_diff = dependency_bom_refs - component_bom_refs
+ if len(dependency_diff) > 0:
+ raise UnknownComponentDependencyException(
+ 'One or more Components have Dependency references to Components/Services that are not known in this '
+ f'BOM. They are: {dependency_diff}')
+
+ # 2. if root component is set and there are other components: dependencies should exist for the Component
+ # this BOM is describing
+ if self.metadata.component and len(self.components) > 0 and not any(map(
+ lambda d: d.ref == self.metadata.component.bom_ref and len(d.dependencies) > 0, # type: ignore[union-attr]
+ self.dependencies
+ )):
+ warn(
+ f'The Component this BOM is describing {self.metadata.component.purl} has no defined dependencies '
+ 'which means the Dependency Graph is incomplete - you should add direct dependencies to this '
+ '"root" Component to complete the Dependency Graph data.',
+ category=UserWarning, stacklevel=1
+ )
+
+ # 3. If a LicenseExpression is set, then there must be no other license.
+ # see https://github.com/CycloneDX/specification/pull/205
+ elem: Union[BomMetaData, Component, Service]
+ for elem in chain( # type: ignore[assignment]
+ [self.metadata],
+ self.metadata.component.get_all_nested_components(include_self=True) if self.metadata.component else [],
+ chain.from_iterable(c.get_all_nested_components(include_self=True) for c in self.components),
+ self.services
+ ):
+ if len(elem.licenses) > 1 and any(isinstance(li, LicenseExpression) for li in elem.licenses):
+ raise LicenseExpressionAlongWithOthersException(
+ f'Found LicenseExpression along with others licenses in: {elem!r}')
+
+ return True
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.serial_number, self.version, self.metadata, _ComparableTuple(
+ self.components), _ComparableTuple(self.services),
+ _ComparableTuple(self.external_references), _ComparableTuple(
+ self.dependencies), _ComparableTuple(self.properties),
+ _ComparableTuple(self.vulnerabilities),
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Bom):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/bom_ref.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/bom_ref.py
new file mode 100644
index 00000000..cc4571a7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/bom_ref.py
@@ -0,0 +1,101 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from typing import TYPE_CHECKING, Any, Optional
+
+import py_serializable as serializable
+
+from ..exception.serialization import CycloneDxDeserializationException, SerializationOfUnexpectedValueException
+
+if TYPE_CHECKING: # pragma: no cover
+ from typing import Type, TypeVar
+
+ _T_BR = TypeVar('_T_BR', bound='BomRef')
+
+
+@serializable.serializable_class
+class BomRef(serializable.helpers.BaseHelper):
+ """
+ An identifier that can be used to reference objects elsewhere in the BOM.
+
+ This copies a similar pattern used in the CycloneDX PHP Library.
+
+ .. note::
+ See https://github.com/CycloneDX/cyclonedx-php-library/blob/master/docs/dev/decisions/BomDependencyDataModel.md
+ """
+
+ def __init__(self, value: Optional[str] = None) -> None:
+ self.value = value
+
+ @property
+ @serializable.json_name('.')
+ @serializable.xml_name('.')
+ def value(self) -> Optional[str]:
+ return self._value
+
+ @value.setter
+ def value(self, value: Optional[str]) -> None:
+ # empty strings become `None`
+ self._value = value or None
+
+ def __eq__(self, other: object) -> bool:
+ return (self is other) or (
+ isinstance(other, BomRef)
+ # `None` value is not discriminative in this domain
+ # see also: `BomRefDiscriminator`
+ and other._value is not None
+ and self._value is not None
+ and other._value == self._value
+ )
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, BomRef):
+ return str(self) < str(other)
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self._value or f'__id__{id(self)}')
+
+ def __repr__(self) -> str:
+ return f''
+
+ def __str__(self) -> str:
+ return self._value or ''
+
+ def __bool__(self) -> bool:
+ return self._value is not None
+
+ # region impl BaseHelper
+
+ @classmethod
+ def serialize(cls, o: Any) -> Optional[str]:
+ if isinstance(o, cls):
+ return o.value
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-BomRef: {o!r}')
+
+ @classmethod
+ def deserialize(cls: 'Type[_T_BR]', o: Any) -> '_T_BR':
+ try:
+ return cls(value=str(o))
+ except ValueError as err:
+ raise CycloneDxDeserializationException(
+ f'BomRef string supplied does not parse: {o!r}'
+ ) from err
+
+ # endregion impl BaseHelper
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/component.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/component.py
new file mode 100644
index 00000000..28de1ea0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/component.py
@@ -0,0 +1,1785 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+import re
+from enum import Enum
+from os.path import exists
+from typing import Any, Dict, FrozenSet, Iterable, Optional, Set, Type, Union
+from warnings import warn
+
+# See https://github.com/package-url/packageurl-python/issues/65
+import py_serializable as serializable
+from packageurl import PackageURL
+from sortedcontainers import SortedSet
+
+from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
+from .._internal.compare import ComparablePackageURL as _ComparablePackageURL, ComparableTuple as _ComparableTuple
+from .._internal.hash import file_sha1sum as _file_sha1sum
+from ..exception.model import InvalidOmniBorIdException, InvalidSwhidException
+from ..exception.serialization import (
+ CycloneDxDeserializationException,
+ SerializationOfUnexpectedValueException,
+ SerializationOfUnsupportedComponentTypeException,
+)
+from ..schema.schema import (
+ SchemaVersion1Dot0,
+ SchemaVersion1Dot1,
+ SchemaVersion1Dot2,
+ SchemaVersion1Dot3,
+ SchemaVersion1Dot4,
+ SchemaVersion1Dot5,
+ SchemaVersion1Dot6,
+)
+from ..serialization import PackageUrl as PackageUrlSH
+from . import (
+ AttachedText,
+ Copyright,
+ ExternalReference,
+ HashAlgorithm,
+ HashType,
+ IdentifiableAction,
+ Property,
+ XsUri,
+ _HashTypeRepositorySerializationHelper,
+)
+from .bom_ref import BomRef
+from .contact import OrganizationalContact, OrganizationalEntity
+from .crypto import CryptoProperties
+from .dependency import Dependable
+from .issue import IssueType
+from .license import License, LicenseRepository, _LicenseRepositorySerializationHelper
+from .release_note import ReleaseNotes
+
+
+@serializable.serializable_class
+class Commit:
+ """
+ Our internal representation of the `commitType` complex type.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_commitType
+ """
+
+ def __init__(
+ self, *,
+ uid: Optional[str] = None,
+ url: Optional[XsUri] = None,
+ author: Optional[IdentifiableAction] = None,
+ committer: Optional[IdentifiableAction] = None,
+ message: Optional[str] = None,
+ ) -> None:
+ self.uid = uid
+ self.url = url
+ self.author = author
+ self.committer = committer
+ self.message = message
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def uid(self) -> Optional[str]:
+ """
+ A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision
+ numbers whereas git uses commit hashes.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._uid
+
+ @uid.setter
+ def uid(self, uid: Optional[str]) -> None:
+ self._uid = uid
+
+ @property
+ @serializable.xml_sequence(2)
+ def url(self) -> Optional[XsUri]:
+ """
+ The URL to the commit. This URL will typically point to a commit in a version control system.
+
+ Returns:
+ `XsUri` if set else `None`
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: Optional[XsUri]) -> None:
+ self._url = url
+
+ @property
+ @serializable.xml_sequence(3)
+ def author(self) -> Optional[IdentifiableAction]:
+ """
+ The author who created the changes in the commit.
+
+ Returns:
+ `IdentifiableAction` if set else `None`
+ """
+ return self._author
+
+ @author.setter
+ def author(self, author: Optional[IdentifiableAction]) -> None:
+ self._author = author
+
+ @property
+ @serializable.xml_sequence(4)
+ def committer(self) -> Optional[IdentifiableAction]:
+ """
+ The person who committed or pushed the commit
+
+ Returns:
+ `IdentifiableAction` if set else `None`
+ """
+ return self._committer
+
+ @committer.setter
+ def committer(self, committer: Optional[IdentifiableAction]) -> None:
+ self._committer = committer
+
+ @property
+ @serializable.xml_sequence(5)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def message(self) -> Optional[str]:
+ """
+ The text description of the contents of the commit.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._message
+
+ @message.setter
+ def message(self, message: Optional[str]) -> None:
+ self._message = message
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.uid, self.url,
+ self.author, self.committer,
+ self.message
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Commit):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Commit):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class ComponentEvidence:
+ """
+ Our internal representation of the `componentEvidenceType` complex type.
+
+ Provides the ability to document evidence collected through various forms of extraction or analysis.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_componentEvidenceType
+ """
+
+ def __init__(
+ self, *,
+ licenses: Optional[Iterable[License]] = None,
+ copyright: Optional[Iterable[Copyright]] = None,
+ ) -> None:
+ self.licenses = licenses or [] # type:ignore[assignment]
+ self.copyright = copyright or [] # type:ignore[assignment]
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(1)
+ # def identity(self) -> ...:
+ # ... # TODO since CDX1.5
+ #
+ # @identity.setter
+ # def identity(self, ...) -> None:
+ # ... # TODO since CDX1.5
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(2)
+ # def occurrences(self) -> ...:
+ # ... # TODO since CDX1.5
+ #
+ # @occurrences.setter
+ # def occurrences(self, ...) -> None:
+ # ... # TODO since CDX1.5
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(3)
+ # def callstack(self) -> ...:
+ # ... # TODO since CDX1.5
+ #
+ # @callstack.setter
+ # def callstack(self, ...) -> None:
+ # ... # TODO since CDX1.5
+
+ @property
+ @serializable.type_mapping(_LicenseRepositorySerializationHelper)
+ @serializable.xml_sequence(4)
+ def licenses(self) -> LicenseRepository:
+ """
+ Optional list of licenses obtained during analysis.
+
+ Returns:
+ Set of `LicenseChoice`
+ """
+ return self._licenses
+
+ @licenses.setter
+ def licenses(self, licenses: Iterable[License]) -> None:
+ self._licenses = LicenseRepository(licenses)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'text')
+ @serializable.xml_sequence(5)
+ def copyright(self) -> 'SortedSet[Copyright]':
+ """
+ Optional list of copyright statements.
+
+ Returns:
+ Set of `Copyright`
+ """
+ return self._copyright
+
+ @copyright.setter
+ def copyright(self, copyright: Iterable[Copyright]) -> None:
+ self._copyright = SortedSet(copyright)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ _ComparableTuple(self.licenses),
+ _ComparableTuple(self.copyright),
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, ComponentEvidence):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class ComponentScope(str, Enum):
+ """
+ Enum object that defines the permissable 'scopes' for a Component according to the CycloneDX schema.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_scope
+ """
+ # see `_ComponentScopeSerializationHelper.__CASES` for view/case map
+ REQUIRED = 'required'
+ OPTIONAL = 'optional'
+ EXCLUDED = 'excluded' # Only supported in >= 1.1
+
+
+class _ComponentScopeSerializationHelper(serializable.helpers.BaseHelper):
+ """ THIS CLASS IS NON-PUBLIC API """
+
+ __CASES: Dict[Type[serializable.ViewType], FrozenSet[ComponentScope]] = dict()
+ __CASES[SchemaVersion1Dot0] = frozenset({
+ ComponentScope.REQUIRED,
+ ComponentScope.OPTIONAL,
+ })
+ __CASES[SchemaVersion1Dot1] = __CASES[SchemaVersion1Dot0] | {
+ ComponentScope.EXCLUDED,
+ }
+ __CASES[SchemaVersion1Dot2] = __CASES[SchemaVersion1Dot1]
+ __CASES[SchemaVersion1Dot3] = __CASES[SchemaVersion1Dot2]
+ __CASES[SchemaVersion1Dot4] = __CASES[SchemaVersion1Dot3]
+ __CASES[SchemaVersion1Dot5] = __CASES[SchemaVersion1Dot4]
+ __CASES[SchemaVersion1Dot6] = __CASES[SchemaVersion1Dot5]
+
+ @classmethod
+ def __normalize(cls, cs: ComponentScope, view: Type[serializable.ViewType]) -> Optional[str]:
+ return cs.value \
+ if cs in cls.__CASES.get(view, ()) \
+ else None
+
+ @classmethod
+ def json_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> Optional[str]:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def xml_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> Optional[str]:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def deserialize(cls, o: Any) -> ComponentScope:
+ return ComponentScope(o)
+
+
+@serializable.serializable_enum
+class ComponentType(str, Enum):
+ """
+ Enum object that defines the permissible 'types' for a Component according to the CycloneDX schema.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_classification
+ """
+ # see `_ComponentTypeSerializationHelper.__CASES` for view/case map
+ APPLICATION = 'application'
+ CONTAINER = 'container' # Only supported in >= 1.2
+ CRYPTOGRAPHIC_ASSET = 'cryptographic-asset' # Only supported in >= 1.6
+ DATA = 'data' # Only supported in >= 1.5
+ DEVICE = 'device'
+ DEVICE_DRIVER = 'device-driver' # Only supported in >= 1.5
+ FILE = 'file' # Only supported in >= 1.1
+ FIRMWARE = 'firmware' # Only supported in >= 1.2
+ FRAMEWORK = 'framework'
+ LIBRARY = 'library'
+ MACHINE_LEARNING_MODEL = 'machine-learning-model' # Only supported in >= 1.5
+ OPERATING_SYSTEM = 'operating-system'
+ PLATFORM = 'platform' # Only supported in >= 1.5
+
+
+class _ComponentTypeSerializationHelper(serializable.helpers.BaseHelper):
+ """ THIS CLASS IS NON-PUBLIC API """
+
+ __CASES: Dict[Type[serializable.ViewType], FrozenSet[ComponentType]] = dict()
+ __CASES[SchemaVersion1Dot0] = frozenset({
+ ComponentType.APPLICATION,
+ ComponentType.DEVICE,
+ ComponentType.FRAMEWORK,
+ ComponentType.LIBRARY,
+ ComponentType.OPERATING_SYSTEM,
+ })
+ __CASES[SchemaVersion1Dot1] = __CASES[SchemaVersion1Dot0] | {
+ ComponentType.FILE,
+ }
+ __CASES[SchemaVersion1Dot2] = __CASES[SchemaVersion1Dot1] | {
+ ComponentType.CONTAINER,
+ ComponentType.FIRMWARE,
+ }
+ __CASES[SchemaVersion1Dot3] = __CASES[SchemaVersion1Dot2]
+ __CASES[SchemaVersion1Dot4] = __CASES[SchemaVersion1Dot3]
+ __CASES[SchemaVersion1Dot5] = __CASES[SchemaVersion1Dot4] | {
+ ComponentType.DATA,
+ ComponentType.DEVICE_DRIVER,
+ ComponentType.MACHINE_LEARNING_MODEL,
+ ComponentType.PLATFORM,
+ }
+ __CASES[SchemaVersion1Dot6] = __CASES[SchemaVersion1Dot5] | {
+ ComponentType.CRYPTOGRAPHIC_ASSET,
+ }
+
+ @classmethod
+ def __normalize(cls, ct: ComponentType, view: Type[serializable.ViewType]) -> Optional[str]:
+ if ct in cls.__CASES.get(view, ()):
+ return ct.value
+ raise SerializationOfUnsupportedComponentTypeException(f'unsupported {ct!r} for view {view!r}')
+
+ @classmethod
+ def json_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> Optional[str]:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def xml_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> Optional[str]:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def deserialize(cls, o: Any) -> ComponentType:
+ return ComponentType(o)
+
+
+@serializable.serializable_class
+class Diff:
+ """
+ Our internal representation of the `diffType` complex type.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_diffType
+ """
+
+ def __init__(
+ self, *,
+ text: Optional[AttachedText] = None,
+ url: Optional[XsUri] = None,
+ ) -> None:
+ self.text = text
+ self.url = url
+
+ @property
+ def text(self) -> Optional[AttachedText]:
+ """
+ Specifies the optional text of the diff.
+
+ Returns:
+ `AttachedText` if set else `None`
+ """
+ return self._text
+
+ @text.setter
+ def text(self, text: Optional[AttachedText]) -> None:
+ self._text = text
+
+ @property
+ def url(self) -> Optional[XsUri]:
+ """
+ Specifies the URL to the diff.
+
+ Returns:
+ `XsUri` if set else `None`
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: Optional[XsUri]) -> None:
+ self._url = url
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.url,
+ self.text,
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Diff):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Diff):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class PatchClassification(str, Enum):
+ """
+ Enum object that defines the permissible `patchClassification`s.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_patchClassification
+ """
+ BACKPORT = 'backport'
+ CHERRY_PICK = 'cherry-pick'
+ MONKEY = 'monkey'
+ UNOFFICIAL = 'unofficial'
+
+
+@serializable.serializable_class
+class Patch:
+ """
+ Our internal representation of the `patchType` complex type.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_patchType
+ """
+
+ def __init__(
+ self, *,
+ type: PatchClassification,
+ diff: Optional[Diff] = None,
+ resolves: Optional[Iterable[IssueType]] = None,
+ ) -> None:
+ self.type = type
+ self.diff = diff
+ self.resolves = resolves or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_attribute()
+ def type(self) -> PatchClassification:
+ """
+ Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or
+ functionality.
+
+ Returns:
+ `PatchClassification`
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: PatchClassification) -> None:
+ self._type = type
+
+ @property
+ def diff(self) -> Optional[Diff]:
+ """
+ The patch file (or diff) that show changes.
+
+ .. note::
+ Refer to https://en.wikipedia.org/wiki/Diff.
+
+ Returns:
+ `Diff` if set else `None`
+ """
+ return self._diff
+
+ @diff.setter
+ def diff(self, diff: Optional[Diff]) -> None:
+ self._diff = diff
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'issue')
+ def resolves(self) -> 'SortedSet[IssueType]':
+ """
+ Optional list of issues resolved by this patch.
+
+ Returns:
+ Set of `IssueType`
+ """
+ return self._resolves
+
+ @resolves.setter
+ def resolves(self, resolves: Iterable[IssueType]) -> None:
+ self._resolves = SortedSet(resolves)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.type, self.diff,
+ _ComparableTuple(self.resolves)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Patch):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Patch):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Pedigree:
+ """
+ Our internal representation of the `pedigreeType` complex type.
+
+ Component pedigree is a way to document complex supply chain scenarios where components are created, distributed,
+ modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the
+ beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation
+ may not be known.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_pedigreeType
+ """
+
+ def __init__(
+ self, *,
+ ancestors: Optional[Iterable['Component']] = None,
+ descendants: Optional[Iterable['Component']] = None,
+ variants: Optional[Iterable['Component']] = None,
+ commits: Optional[Iterable[Commit]] = None,
+ patches: Optional[Iterable[Patch]] = None,
+ notes: Optional[str] = None,
+ ) -> None:
+ self.ancestors = ancestors or [] # type:ignore[assignment]
+ self.descendants = descendants or [] # type:ignore[assignment]
+ self.variants = variants or [] # type:ignore[assignment]
+ self.commits = commits or [] # type:ignore[assignment]
+ self.patches = patches or [] # type:ignore[assignment]
+ self.notes = notes
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'component')
+ @serializable.xml_sequence(1)
+ def ancestors(self) -> "SortedSet['Component']":
+ """
+ Describes zero or more components in which a component is derived from. This is commonly used to describe forks
+ from existing projects where the forked version contains a ancestor node containing the original component it
+ was forked from.
+
+ For example, Component A is the original component. Component B is the component being used and documented in
+ the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the
+ original component from which Component B is derived from.
+
+ Returns:
+ Set of `Component`
+ """
+ return self._ancestors
+
+ @ancestors.setter
+ def ancestors(self, ancestors: Iterable['Component']) -> None:
+ self._ancestors = SortedSet(ancestors)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'component')
+ @serializable.xml_sequence(2)
+ def descendants(self) -> "SortedSet['Component']":
+ """
+ Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of
+ an original or root component.
+
+ Returns:
+ Set of `Component`
+ """
+ return self._descendants
+
+ @descendants.setter
+ def descendants(self, descendants: Iterable['Component']) -> None:
+ self._descendants = SortedSet(descendants)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'component')
+ @serializable.xml_sequence(3)
+ def variants(self) -> "SortedSet['Component']":
+ """
+ Variants describe relations where the relationship between the components are not known. For example, if
+ Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is
+ derived from the other, or if they share a common ancestor.
+
+ Returns:
+ Set of `Component`
+ """
+ return self._variants
+
+ @variants.setter
+ def variants(self, variants: Iterable['Component']) -> None:
+ self._variants = SortedSet(variants)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'commit')
+ @serializable.xml_sequence(4)
+ def commits(self) -> 'SortedSet[Commit]':
+ """
+ A list of zero or more commits which provide a trail describing how the component deviates from an ancestor,
+ descendant, or variant.
+
+ Returns:
+ Set of `Commit`
+ """
+ return self._commits
+
+ @commits.setter
+ def commits(self, commits: Iterable[Commit]) -> None:
+ self._commits = SortedSet(commits)
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'patch')
+ @serializable.xml_sequence(5)
+ def patches(self) -> 'SortedSet[Patch]':
+ """
+ A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant.
+ Patches may be complimentary to commits or may be used in place of commits.
+
+ Returns:
+ Set of `Patch`
+ """
+ return self._patches
+
+ @patches.setter
+ def patches(self, patches: Iterable[Patch]) -> None:
+ self._patches = SortedSet(patches)
+
+ @property
+ @serializable.xml_sequence(6)
+ def notes(self) -> Optional[str]:
+ """
+ Notes, observations, and other non-structured commentary describing the components pedigree.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._notes
+
+ @notes.setter
+ def notes(self, notes: Optional[str]) -> None:
+ self._notes = notes
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ _ComparableTuple(self.ancestors),
+ _ComparableTuple(self.descendants),
+ _ComparableTuple(self.variants),
+ _ComparableTuple(self.commits),
+ _ComparableTuple(self.patches),
+ self.notes
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Pedigree):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Swid:
+ """
+ Our internal representation of the `swidType` complex type.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_swidType
+ """
+
+ def __init__(
+ self, *,
+ tag_id: str,
+ name: str,
+ version: Optional[str] = None,
+ tag_version: Optional[int] = None,
+ patch: Optional[bool] = None,
+ text: Optional[AttachedText] = None,
+ url: Optional[XsUri] = None,
+ ) -> None:
+ self.tag_id = tag_id
+ self.name = name
+ self.version = version
+ self.tag_version = tag_version
+ self.patch = patch
+ self.text = text
+ self.url = url
+
+ @property
+ @serializable.xml_attribute()
+ def tag_id(self) -> str:
+ """
+ Maps to the tagId of a SoftwareIdentity.
+
+ Returns:
+ `str`
+ """
+ return self._tag_id
+
+ @tag_id.setter
+ def tag_id(self, tag_id: str) -> None:
+ self._tag_id = tag_id
+
+ @property
+ @serializable.xml_attribute()
+ def name(self) -> str:
+ """
+ Maps to the name of a SoftwareIdentity.
+
+ Returns:
+ `str`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_attribute()
+ def version(self) -> Optional[str]:
+ """
+ Maps to the version of a SoftwareIdentity.
+
+ Returns:
+ `str` if set else `None`.
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: Optional[str]) -> None:
+ self._version = version
+
+ @property
+ @serializable.xml_attribute()
+ def tag_version(self) -> Optional[int]:
+ """
+ Maps to the tagVersion of a SoftwareIdentity.
+
+ Returns:
+ `int` if set else `None`
+ """
+ return self._tag_version
+
+ @tag_version.setter
+ def tag_version(self, tag_version: Optional[int]) -> None:
+ self._tag_version = tag_version
+
+ @property
+ @serializable.xml_attribute()
+ def patch(self) -> Optional[bool]:
+ """
+ Maps to the patch of a SoftwareIdentity.
+
+ Returns:
+ `bool` if set else `None`
+ """
+ return self._patch
+
+ @patch.setter
+ def patch(self, patch: Optional[bool]) -> None:
+ self._patch = patch
+
+ @property
+ def text(self) -> Optional[AttachedText]:
+ """
+ Specifies the full content of the SWID tag.
+
+ Returns:
+ `AttachedText` if set else `None`
+ """
+ return self._text
+
+ @text.setter
+ def text(self, text: Optional[AttachedText]) -> None:
+ self._text = text
+
+ @property
+ def url(self) -> Optional[XsUri]:
+ """
+ The URL to the SWID file.
+
+ Returns:
+ `XsUri` if set else `None`
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: Optional[XsUri]) -> None:
+ self._url = url
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.tag_id,
+ self.name, self.version,
+ self.tag_version,
+ self.patch,
+ self.url,
+ self.text,
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Swid):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class OmniborId(serializable.helpers.BaseHelper):
+ """
+ Helper class that allows us to perform validation on data strings that must conform to
+ https://www.iana.org/assignments/uri-schemes/prov/gitoid.
+
+ """
+
+ _VALID_OMNIBOR_ID_REGEX = re.compile(r'^gitoid:(blob|tree|commit|tag):sha(1|256):([a-z0-9]+)$')
+
+ def __init__(self, id: str) -> None:
+ if OmniborId._VALID_OMNIBOR_ID_REGEX.match(id) is None:
+ raise InvalidOmniBorIdException(
+ f'Supplied value "{id} does not meet format specification.'
+ )
+ self._id = id
+
+ @property
+ @serializable.json_name('.')
+ @serializable.xml_name('.')
+ def id(self) -> str:
+ return self._id
+
+ @classmethod
+ def serialize(cls, o: Any) -> str:
+ if isinstance(o, OmniborId):
+ return str(o)
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-OmniBorId: {o!r}')
+
+ @classmethod
+ def deserialize(cls, o: Any) -> 'OmniborId':
+ try:
+ return OmniborId(id=str(o))
+ except ValueError as err:
+ raise CycloneDxDeserializationException(
+ f'OmniBorId string supplied does not parse: {o!r}'
+ ) from err
+
+ def __eq__(self, other: Any) -> bool:
+ if isinstance(other, OmniborId):
+ return self._id == other._id
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, OmniborId):
+ return self._id < other._id
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self._id)
+
+ def __repr__(self) -> str:
+ return f''
+
+ def __str__(self) -> str:
+ return self._id
+
+
+@serializable.serializable_class
+class Swhid(serializable.helpers.BaseHelper):
+ """
+ Helper class that allows us to perform validation on data strings that must conform to
+ https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html.
+
+ """
+
+ _VALID_SWHID_REGEX = re.compile(r'^swh:1:(cnp|rel|rev|dir|cnt):([0-9a-z]{40})(.*)?$')
+
+ def __init__(self, id: str) -> None:
+ if Swhid._VALID_SWHID_REGEX.match(id) is None:
+ raise InvalidSwhidException(
+ f'Supplied value "{id} does not meet format specification.'
+ )
+ self._id = id
+
+ @property
+ @serializable.json_name('.')
+ @serializable.xml_name('.')
+ def id(self) -> str:
+ return self._id
+
+ @classmethod
+ def serialize(cls, o: Any) -> str:
+ if isinstance(o, Swhid):
+ return str(o)
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-Swhid: {o!r}')
+
+ @classmethod
+ def deserialize(cls, o: Any) -> 'Swhid':
+ try:
+ return Swhid(id=str(o))
+ except ValueError as err:
+ raise CycloneDxDeserializationException(
+ f'Swhid string supplied does not parse: {o!r}'
+ ) from err
+
+ def __eq__(self, other: Any) -> bool:
+ if isinstance(other, Swhid):
+ return self._id == other._id
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Swhid):
+ return self._id < other._id
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self._id)
+
+ def __repr__(self) -> str:
+ return f''
+
+ def __str__(self) -> str:
+ return self._id
+
+
+@serializable.serializable_class
+class Component(Dependable):
+ """
+ This is our internal representation of a Component within a Bom.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_component
+ """
+
+ @staticmethod
+ def for_file(absolute_file_path: str, path_for_bom: Optional[str]) -> 'Component':
+ """
+ Helper method to create a Component that represents the provided local file as a Component.
+
+ Args:
+ absolute_file_path:
+ Absolute path to the file you wish to represent
+ path_for_bom:
+ Optionally, if supplied this is the path that will be used to identify the file in the BOM
+
+ Returns:
+ `Component` representing the supplied file
+ """
+ if not exists(absolute_file_path):
+ raise FileExistsError(f'Supplied file path {absolute_file_path!r} does not exist')
+
+ sha1_hash: str = _file_sha1sum(absolute_file_path)
+ return Component(
+ name=path_for_bom if path_for_bom else absolute_file_path,
+ version=f'0.0.0-{sha1_hash[0:12]}',
+ hashes=[
+ HashType(alg=HashAlgorithm.SHA_1, content=sha1_hash)
+ ],
+ type=ComponentType.FILE, purl=PackageURL(
+ type='generic', name=path_for_bom if path_for_bom else absolute_file_path,
+ version=f'0.0.0-{sha1_hash[0:12]}'
+ )
+ )
+
+ def __init__(
+ self, *,
+ name: str,
+ type: ComponentType = ComponentType.LIBRARY,
+ mime_type: Optional[str] = None,
+ bom_ref: Optional[Union[str, BomRef]] = None,
+ supplier: Optional[OrganizationalEntity] = None,
+ publisher: Optional[str] = None,
+ group: Optional[str] = None,
+ version: Optional[str] = None,
+ description: Optional[str] = None,
+ scope: Optional[ComponentScope] = None,
+ hashes: Optional[Iterable[HashType]] = None,
+ licenses: Optional[Iterable[License]] = None,
+ copyright: Optional[str] = None,
+ purl: Optional[PackageURL] = None,
+ external_references: Optional[Iterable[ExternalReference]] = None,
+ properties: Optional[Iterable[Property]] = None,
+ release_notes: Optional[ReleaseNotes] = None,
+ cpe: Optional[str] = None,
+ swid: Optional[Swid] = None,
+ pedigree: Optional[Pedigree] = None,
+ components: Optional[Iterable['Component']] = None,
+ evidence: Optional[ComponentEvidence] = None,
+ modified: bool = False,
+ manufacturer: Optional[OrganizationalEntity] = None,
+ authors: Optional[Iterable[OrganizationalContact]] = None,
+ omnibor_ids: Optional[Iterable[OmniborId]] = None,
+ swhids: Optional[Iterable[Swhid]] = None,
+ crypto_properties: Optional[CryptoProperties] = None,
+ tags: Optional[Iterable[str]] = None,
+ # Deprecated in v1.6
+ author: Optional[str] = None,
+ ) -> None:
+ self.type = type
+ self.mime_type = mime_type
+ self._bom_ref = _bom_ref_from_str(bom_ref)
+ self.supplier = supplier
+ self.manufacturer = manufacturer
+ self.authors = authors or [] # type:ignore[assignment]
+ self.author = author
+ self.publisher = publisher
+ self.group = group
+ self.name = name
+ self.version = version
+ self.description = description
+ self.scope = scope
+ self.hashes = hashes or [] # type:ignore[assignment]
+ self.licenses = licenses or [] # type:ignore[assignment]
+ self.copyright = copyright
+ self.cpe = cpe
+ self.purl = purl
+ self.omnibor_ids = omnibor_ids or [] # type:ignore[assignment]
+ self.swhids = swhids or [] # type:ignore[assignment]
+ self.swid = swid
+ self.modified = modified
+ self.pedigree = pedigree
+ self.external_references = external_references or [] # type:ignore[assignment]
+ self.properties = properties or [] # type:ignore[assignment]
+ self.components = components or [] # type:ignore[assignment]
+ self.evidence = evidence
+ self.release_notes = release_notes
+ self.crypto_properties = crypto_properties
+ self.tags = tags or [] # type:ignore[assignment]
+
+ if modified:
+ warn('`.component.modified` is deprecated from CycloneDX v1.3 onwards. '
+ 'Please use `@.pedigree` instead.', DeprecationWarning)
+ if author:
+ warn('`.component.author` is deprecated from CycloneDX v1.6 onwards. '
+ 'Please use `@.authors` or `@.manufacturer` instead.', DeprecationWarning)
+
+ @property
+ @serializable.type_mapping(_ComponentTypeSerializationHelper)
+ @serializable.xml_attribute()
+ def type(self) -> ComponentType:
+ """
+ Get the type of this Component.
+
+ Returns:
+ Declared type of this Component as `ComponentType`.
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: ComponentType) -> None:
+ self._type = type
+
+ @property
+ @serializable.xml_string(serializable.XmlStringSerializationType.TOKEN)
+ def mime_type(self) -> Optional[str]:
+ """
+ Get any declared mime-type for this Component.
+
+ When used on file components, the mime-type can provide additional context about the kind of file being
+ represented such as an image, font, or executable. Some library or framework components may also have an
+ associated mime-type.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._mime_type
+
+ @mime_type.setter
+ def mime_type(self, mime_type: Optional[str]) -> None:
+ self._mime_type = mime_type
+
+ @property
+ @serializable.json_name('bom-ref')
+ @serializable.type_mapping(BomRef)
+ @serializable.view(SchemaVersion1Dot1)
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_attribute()
+ @serializable.xml_name('bom-ref')
+ def bom_ref(self) -> BomRef:
+ """
+ An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
+ unique within the BOM.
+
+ Returns:
+ `BomRef`
+ """
+ return self._bom_ref
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(1)
+ def supplier(self) -> Optional[OrganizationalEntity]:
+ """
+ The organization that supplied the component. The supplier may often be the manufacture, but may also be a
+ distributor or repackager.
+
+ Returns:
+ `OrganizationalEntity` if set else `None`
+ """
+ return self._supplier
+
+ @supplier.setter
+ def supplier(self, supplier: Optional[OrganizationalEntity]) -> None:
+ self._supplier = supplier
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(2)
+ def manufacturer(self) -> Optional[OrganizationalEntity]:
+ """
+ The organization that created the component.
+ Manufacturer is common in components created through automated processes.
+ Components created through manual means may have `@.authors` instead.
+
+ Returns:
+ `OrganizationalEntity` if set else `None`
+ """
+ return self._manufacturer
+
+ @manufacturer.setter
+ def manufacturer(self, manufacturer: Optional[OrganizationalEntity]) -> None:
+ self._manufacturer = manufacturer
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'author')
+ @serializable.xml_sequence(3)
+ def authors(self) -> 'SortedSet[OrganizationalContact]':
+ """
+ The person(s) who created the component.
+ Authors are common in components created through manual processes.
+ Components created through automated means may have `@.manufacturer` instead.
+
+ Returns:
+ `Iterable[OrganizationalContact]` if set else `None`
+ """
+ return self._authors
+
+ @authors.setter
+ def authors(self, authors: Iterable[OrganizationalContact]) -> None:
+ self._authors = SortedSet(authors)
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6) # todo: this is deprecated in v1.6?
+ @serializable.xml_sequence(4)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def author(self) -> Optional[str]:
+ """
+ The person(s) or organization(s) that authored the component.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._author
+
+ @author.setter
+ def author(self, author: Optional[str]) -> None:
+ self._author = author
+
+ @property
+ @serializable.xml_sequence(5)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def publisher(self) -> Optional[str]:
+ """
+ The person(s) or organization(s) that published the component
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._publisher
+
+ @publisher.setter
+ def publisher(self, publisher: Optional[str]) -> None:
+ self._publisher = publisher
+
+ @property
+ @serializable.xml_sequence(6)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def group(self) -> Optional[str]:
+ """
+ The grouping name or identifier. This will often be a shortened, single name of the company or project that
+ produced the component, or the source package or domain name. Whitespace and special characters should be
+ avoided.
+
+ Examples include: `apache`, `org.apache.commons`, and `apache.org`.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._group
+
+ @group.setter
+ def group(self, group: Optional[str]) -> None:
+ self._group = group
+
+ @property
+ @serializable.xml_sequence(7)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> str:
+ """
+ The name of the component.
+
+ This will often be a shortened, single name of the component.
+
+ Examples: `commons-lang3` and `jquery`.
+
+ Returns:
+ `str`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ self._name = name
+
+ @property
+ @serializable.include_none(SchemaVersion1Dot0, '')
+ @serializable.include_none(SchemaVersion1Dot1, '')
+ @serializable.include_none(SchemaVersion1Dot2, '')
+ @serializable.include_none(SchemaVersion1Dot3, '')
+ @serializable.xml_sequence(8)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def version(self) -> Optional[str]:
+ """
+ The component version. The version should ideally comply with semantic versioning but is not enforced.
+
+ This is NOT optional for CycloneDX Schema Version < 1.4 but was agreed to default to an empty string where a
+ version was not supplied for schema versions < 1.4
+
+ Returns:
+ Declared version of this Component as `str` or `None`
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: Optional[str]) -> None:
+ if version and len(version) > 1024:
+ warn('`.component.version`has a maximum length of 1024 from CycloneDX v1.6 onwards.', UserWarning)
+ self._version = version
+
+ @property
+ @serializable.xml_sequence(9)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def description(self) -> Optional[str]:
+ """
+ Get the description of this Component.
+
+ Returns:
+ `str` if set, else `None`.
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ @property
+ @serializable.type_mapping(_ComponentScopeSerializationHelper)
+ @serializable.xml_sequence(10)
+ def scope(self) -> Optional[ComponentScope]:
+ """
+ Specifies the scope of the component.
+
+ If scope is not specified, 'required' scope should be assumed by the consumer of the BOM.
+
+ Returns:
+ `ComponentScope` or `None`
+ """
+ return self._scope
+
+ @scope.setter
+ def scope(self, scope: Optional[ComponentScope]) -> None:
+ self._scope = scope
+
+ @property
+ @serializable.type_mapping(_HashTypeRepositorySerializationHelper)
+ @serializable.xml_sequence(11)
+ def hashes(self) -> 'SortedSet[HashType]':
+ """
+ Optional list of hashes that help specify the integrity of this Component.
+
+ Returns:
+ Set of `HashType`
+ """
+ return self._hashes
+
+ @hashes.setter
+ def hashes(self, hashes: Iterable[HashType]) -> None:
+ self._hashes = SortedSet(hashes)
+
+ @property
+ @serializable.view(SchemaVersion1Dot1)
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.type_mapping(_LicenseRepositorySerializationHelper)
+ @serializable.xml_sequence(12)
+ def licenses(self) -> LicenseRepository:
+ """
+ A optional list of statements about how this Component is licensed.
+
+ Returns:
+ Set of `LicenseChoice`
+ """
+ return self._licenses
+
+ @licenses.setter
+ def licenses(self, licenses: Iterable[License]) -> None:
+ self._licenses = LicenseRepository(licenses)
+
+ @property
+ @serializable.xml_sequence(13)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def copyright(self) -> Optional[str]:
+ """
+ An optional copyright notice informing users of the underlying claims to copyright ownership in a published
+ work.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._copyright
+
+ @copyright.setter
+ def copyright(self, copyright: Optional[str]) -> None:
+ self._copyright = copyright
+
+ @property
+ @serializable.xml_sequence(14)
+ def cpe(self) -> Optional[str]:
+ """
+ Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification.
+ See https://nvd.nist.gov/products/cpe
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._cpe
+
+ @cpe.setter
+ def cpe(self, cpe: Optional[str]) -> None:
+ self._cpe = cpe
+
+ @property
+ @serializable.type_mapping(PackageUrlSH)
+ @serializable.xml_sequence(15)
+ def purl(self) -> Optional[PackageURL]:
+ """
+ Specifies the package-url (PURL).
+
+ The purl, if specified, must be valid and conform to the specification defined at:
+ https://github.com/package-url/purl-spec
+
+ Returns:
+ `PackageURL` or `None`
+ """
+ return self._purl
+
+ @purl.setter
+ def purl(self, purl: Optional[PackageURL]) -> None:
+ self._purl = purl
+
+ @property
+ @serializable.json_name('omniborId')
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, child_name='omniborId')
+ @serializable.xml_sequence(16)
+ def omnibor_ids(self) -> 'SortedSet[OmniborId]':
+ """
+ Specifies the OmniBOR Artifact ID. The OmniBOR, if specified, MUST be valid and conform to the specification
+ defined at: https://www.iana.org/assignments/uri-schemes/prov/gitoid
+
+ Returns:
+ `Iterable[str]` or `None`
+ """
+
+ return self._omnibor_ids
+
+ @omnibor_ids.setter
+ def omnibor_ids(self, omnibor_ids: Iterable[OmniborId]) -> None:
+ self._omnibor_ids = SortedSet(omnibor_ids)
+
+ @property
+ @serializable.json_name('swhid')
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, child_name='swhid')
+ @serializable.xml_sequence(17)
+ def swhids(self) -> 'SortedSet[Swhid]':
+ """
+ Specifies the Software Heritage persistent identifier (SWHID). The SWHID, if specified, MUST be valid and
+ conform to the specification defined at:
+ https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html
+
+ Returns:
+ `Iterable[Swhid]` if set else `None`
+ """
+ return self._swhids
+
+ @swhids.setter
+ def swhids(self, swhids: Iterable[Swhid]) -> None:
+ self._swhids = SortedSet(swhids)
+
+ @property
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(18)
+ def swid(self) -> Optional[Swid]:
+ """
+ Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
+
+ Returns:
+ `Swid` if set else `None`
+ """
+ return self._swid
+
+ @swid.setter
+ def swid(self, swid: Optional[Swid]) -> None:
+ self._swid = swid
+
+ @property
+ @serializable.view(SchemaVersion1Dot0) # todo: Deprecated in v1.3
+ @serializable.xml_sequence(19)
+ def modified(self) -> bool:
+ return self._modified
+
+ @modified.setter
+ def modified(self, modified: bool) -> None:
+ self._modified = modified
+
+ @property
+ @serializable.view(SchemaVersion1Dot1)
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(20)
+ def pedigree(self) -> Optional[Pedigree]:
+ """
+ Component pedigree is a way to document complex supply chain scenarios where components are created,
+ distributed, modified, redistributed, combined with other components, etc.
+
+ Returns:
+ `Pedigree` if set else `None`
+ """
+ return self._pedigree
+
+ @pedigree.setter
+ def pedigree(self, pedigree: Optional[Pedigree]) -> None:
+ self._pedigree = pedigree
+
+ @property
+ @serializable.view(SchemaVersion1Dot1)
+ @serializable.view(SchemaVersion1Dot2)
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'reference')
+ @serializable.xml_sequence(21)
+ def external_references(self) -> 'SortedSet[ExternalReference]':
+ """
+ Provides the ability to document external references related to the component or to the project the component
+ describes.
+
+ Returns:
+ Set of `ExternalReference`
+ """
+ return self._external_references
+
+ @external_references.setter
+ def external_references(self, external_references: Iterable[ExternalReference]) -> None:
+ self._external_references = SortedSet(external_references)
+
+ @property
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
+ @serializable.xml_sequence(22)
+ def properties(self) -> 'SortedSet[Property]':
+ """
+ Provides the ability to document properties in a key/value store. This provides flexibility to include data not
+ officially supported in the standard without having to use additional namespaces or create extensions.
+
+ Return:
+ Set of `Property`
+ """
+ return self._properties
+
+ @properties.setter
+ def properties(self, properties: Iterable[Property]) -> None:
+ self._properties = SortedSet(properties)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'component')
+ @serializable.xml_sequence(23)
+ def components(self) -> "SortedSet['Component']":
+ """
+ A list of software and hardware components included in the parent component. This is not a dependency tree. It
+ provides a way to specify a hierarchical representation of component assemblies, similar to system -> subsystem
+ -> parts assembly in physical supply chains.
+
+ Returns:
+ Set of `Component`
+ """
+ return self._components
+
+ @components.setter
+ def components(self, components: Iterable['Component']) -> None:
+ self._components = SortedSet(components)
+
+ @property
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(24)
+ def evidence(self) -> Optional[ComponentEvidence]:
+ """
+ Provides the ability to document evidence collected through various forms of extraction or analysis.
+
+ Returns:
+ `ComponentEvidence` if set else `None`
+ """
+ return self._evidence
+
+ @evidence.setter
+ def evidence(self, evidence: Optional[ComponentEvidence]) -> None:
+ self._evidence = evidence
+
+ @property
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(25)
+ def release_notes(self) -> Optional[ReleaseNotes]:
+ """
+ Specifies optional release notes.
+
+ Returns:
+ `ReleaseNotes` or `None`
+ """
+ return self._release_notes
+
+ @release_notes.setter
+ def release_notes(self, release_notes: Optional[ReleaseNotes]) -> None:
+ self._release_notes = release_notes
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(22)
+ # def model_card(self) -> ...:
+ # ... # TODO since CDX1.5
+ #
+ # @model_card.setter
+ # def model_card(self, ...) -> None:
+ # ... # TODO since CDX1.5
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(23)
+ # def data(self) -> ...:
+ # ... # TODO since CDX1.5
+ #
+ # @data.setter
+ # def data(self, ...) -> None:
+ # ... # TODO since CDX1.5
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(30)
+ def crypto_properties(self) -> Optional[CryptoProperties]:
+ """
+ Cryptographic assets have properties that uniquely define them and that make them actionable for further
+ reasoning. As an example, it makes a difference if one knows the algorithm family (e.g. AES) or the specific
+ variant or instantiation (e.g. AES-128-GCM). This is because the security level and the algorithm primitive
+ (authenticated encryption) is only defined by the definition of the algorithm variant. The presence of a weak
+ cryptographic algorithm like SHA1 vs. HMAC-SHA1 also makes a difference.
+
+ Returns:
+ `CryptoProperties` or `None`
+ """
+ return self._crypto_properties
+
+ @crypto_properties.setter
+ def crypto_properties(self, crypto_properties: Optional[CryptoProperties]) -> None:
+ self._crypto_properties = crypto_properties
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'tag')
+ @serializable.xml_sequence(31)
+ def tags(self) -> 'SortedSet[str]':
+ """
+ Textual strings that aid in discovery, search, and retrieval of the associated object.
+ Tags often serve as a way to group or categorize similar or related objects by various attributes.
+
+ Returns:
+ `Iterable[str]`
+ """
+ return self._tags
+
+ @tags.setter
+ def tags(self, tags: Iterable[str]) -> None:
+ self._tags = SortedSet(tags)
+
+ def get_all_nested_components(self, include_self: bool = False) -> Set['Component']:
+ components = set()
+ if include_self:
+ components.add(self)
+
+ for c in self.components:
+ components.update(c.get_all_nested_components(include_self=True))
+
+ return components
+
+ def get_pypi_url(self) -> str:
+ if self.version:
+ return f'https://pypi.org/project/{self.name}/{self.version}'
+ else:
+ return f'https://pypi.org/project/{self.name}'
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.type, self.group, self.name, self.version,
+ self.bom_ref.value,
+ None if self.purl is None else _ComparablePackageURL(self.purl),
+ self.swid, self.cpe, _ComparableTuple(self.swhids),
+ self.supplier, self.author, self.publisher,
+ self.description,
+ self.mime_type, self.scope, _ComparableTuple(self.hashes),
+ _ComparableTuple(self.licenses), self.copyright,
+ self.pedigree,
+ _ComparableTuple(self.external_references), _ComparableTuple(self.properties),
+ _ComparableTuple(self.components), self.evidence, self.release_notes, self.modified,
+ _ComparableTuple(self.authors), _ComparableTuple(self.omnibor_ids), self.manufacturer,
+ self.crypto_properties, _ComparableTuple(self.tags),
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Component):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Component):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/contact.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/contact.py
new file mode 100644
index 00000000..cea865e7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/contact.py
@@ -0,0 +1,386 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from typing import Any, Iterable, Optional, Union
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..schema.schema import SchemaVersion1Dot6
+from . import XsUri
+from .bom_ref import BomRef
+
+
+@serializable.serializable_class
+class PostalAddress:
+ """
+ This is our internal representation of the `postalAddressType` complex type that can be used in multiple places
+ within a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_postalAddressType
+ """
+
+ def __init__(
+ self, *,
+ bom_ref: Optional[Union[str, BomRef]] = None,
+ country: Optional[str] = None,
+ region: Optional[str] = None,
+ locality: Optional[str] = None,
+ post_office_box_number: Optional[str] = None,
+ postal_code: Optional[str] = None,
+ street_address: Optional[str] = None,
+ ) -> None:
+ self._bom_ref = _bom_ref_from_str(bom_ref, optional=True)
+ self.country = country
+ self.region = region
+ self.locality = locality
+ self.post_office_box_number = post_office_box_number
+ self.postal_code = postal_code
+ self.street_address = street_address
+
+ @property
+ @serializable.json_name('bom-ref')
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_attribute()
+ @serializable.xml_name('bom-ref')
+ def bom_ref(self) -> Optional[BomRef]:
+ """
+ An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
+ unique within the BOM.
+
+ Returns:
+ `BomRef`
+ """
+ return self._bom_ref
+
+ @property
+ @serializable.xml_sequence(10)
+ def country(self) -> Optional[str]:
+ """
+ The country name or the two-letter ISO 3166-1 country code.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._country
+
+ @country.setter
+ def country(self, country: Optional[str]) -> None:
+ self._country = country
+
+ @property
+ @serializable.xml_sequence(20)
+ def region(self) -> Optional[str]:
+ """
+ The region or state in the country. For example, Texas.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._region
+
+ @region.setter
+ def region(self, region: Optional[str]) -> None:
+ self._region = region
+
+ @property
+ @serializable.xml_sequence(30)
+ def locality(self) -> Optional[str]:
+ """
+ The locality or city within the country. For example, Austin.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._locality
+
+ @locality.setter
+ def locality(self, locality: Optional[str]) -> None:
+ self._locality = locality
+
+ @property
+ @serializable.xml_sequence(40)
+ def post_office_box_number(self) -> Optional[str]:
+ """
+ The post office box number. For example, 901.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._post_office_box_number
+
+ @post_office_box_number.setter
+ def post_office_box_number(self, post_office_box_number: Optional[str]) -> None:
+ self._post_office_box_number = post_office_box_number
+
+ @property
+ @serializable.xml_sequence(60)
+ def postal_code(self) -> Optional[str]:
+ """
+ The postal code. For example, 78758.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._postal_code
+
+ @postal_code.setter
+ def postal_code(self, postal_code: Optional[str]) -> None:
+ self._postal_code = postal_code
+
+ @property
+ @serializable.xml_sequence(70)
+ def street_address(self) -> Optional[str]:
+ """
+ The street address. For example, 100 Main Street.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._street_address
+
+ @street_address.setter
+ def street_address(self, street_address: Optional[str]) -> None:
+ self._street_address = street_address
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.country, self.region, self.locality, self.postal_code,
+ self.post_office_box_number,
+ self.street_address,
+ None if self.bom_ref is None else self.bom_ref.value,
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, PostalAddress):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, PostalAddress):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class OrganizationalContact:
+ """
+ This is our internal representation of the `organizationalContact` complex type that can be used in multiple places
+ within a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_organizationalContact
+ """
+
+ def __init__(
+ self, *,
+ name: Optional[str] = None,
+ phone: Optional[str] = None,
+ email: Optional[str] = None,
+ ) -> None:
+ self.name = name
+ self.email = email
+ self.phone = phone
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ Get the name of the contact.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_sequence(2)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def email(self) -> Optional[str]:
+ """
+ Get the email of the contact.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._email
+
+ @email.setter
+ def email(self, email: Optional[str]) -> None:
+ self._email = email
+
+ @property
+ @serializable.xml_sequence(3)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def phone(self) -> Optional[str]:
+ """
+ Get the phone of the contact.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._phone
+
+ @phone.setter
+ def phone(self, phone: Optional[str]) -> None:
+ self._phone = phone
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.name, self.email, self.phone
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, OrganizationalContact):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, OrganizationalContact):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class OrganizationalEntity:
+ """
+ This is our internal representation of the `organizationalEntity` complex type that can be used in multiple places
+ within a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_organizationalEntity
+ """
+
+ def __init__(
+ self, *,
+ name: Optional[str] = None,
+ urls: Optional[Iterable[XsUri]] = None,
+ contacts: Optional[Iterable[OrganizationalContact]] = None,
+ address: Optional[PostalAddress] = None,
+ ) -> None:
+ self.name = name
+ self.address = address
+ self.urls = urls or [] # type:ignore[assignment]
+ self.contacts = contacts or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(10)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ Get the name of the organization.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(20)
+ def address(self) -> Optional[PostalAddress]:
+ """
+ The physical address (location) of the organization.
+
+ Returns:
+ `PostalAddress` or `None`
+ """
+ return self._address
+
+ @address.setter
+ def address(self, address: Optional[PostalAddress]) -> None:
+ self._address = address
+
+ @property
+ @serializable.json_name('url')
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, 'url')
+ @serializable.xml_sequence(30)
+ def urls(self) -> 'SortedSet[XsUri]':
+ """
+ Get a list of URLs of the organization. Multiple URLs are allowed.
+
+ Returns:
+ Set of `XsUri`
+ """
+ return self._urls
+
+ @urls.setter
+ def urls(self, urls: Iterable[XsUri]) -> None:
+ self._urls = SortedSet(urls)
+
+ @property
+ @serializable.json_name('contact')
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, 'contact')
+ @serializable.xml_sequence(40)
+ def contacts(self) -> 'SortedSet[OrganizationalContact]':
+ """
+ Get a list of contact person at the organization. Multiple contacts are allowed.
+
+ Returns:
+ Set of `OrganizationalContact`
+ """
+ return self._contacts
+
+ @contacts.setter
+ def contacts(self, contacts: Iterable[OrganizationalContact]) -> None:
+ self._contacts = SortedSet(contacts)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.name, _ComparableTuple(self.urls), _ComparableTuple(self.contacts)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, OrganizationalEntity):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, OrganizationalEntity):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/crypto.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/crypto.py
new file mode 100644
index 00000000..765e840b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/crypto.py
@@ -0,0 +1,1598 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+"""
+This set of classes represents cryptoPropertiesType Complex Type in the CycloneDX standard.
+
+.. note::
+ Introduced in CycloneDX v1.6
+
+.. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+"""
+
+from datetime import datetime
+from enum import Enum
+from typing import Any, Iterable, Optional
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..exception.model import InvalidNistQuantumSecurityLevelException, InvalidRelatedCryptoMaterialSizeException
+from ..schema.schema import SchemaVersion1Dot6
+from .bom_ref import BomRef
+
+
+@serializable.serializable_enum
+class CryptoAssetType(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.assetType ENUM type within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ ALGORITHM = 'algorithm'
+ CERTIFICATE = 'certificate'
+ PROTOCOL = 'protocol'
+ RELATED_CRYPTO_MATERIAL = 'related-crypto-material'
+
+
+@serializable.serializable_enum
+class CryptoPrimitive(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties.primitive ENUM type within the
+ CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ AE = 'ae'
+ BLOCK_CIPHER = 'block-cipher'
+ COMBINER = 'combiner'
+ DRBG = 'drbg'
+ HASH = 'hash'
+ KDF = 'kdf'
+ KEM = 'kem'
+ KEY_AGREE = 'key-agree'
+ MAC = 'mac'
+ PKE = 'pke'
+ SIGNATURE = 'signature'
+ STREAM_CIPHER = 'stream-cipher'
+ XOF = 'xof'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class CryptoExecutionEnvironment(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties.executionEnvironment ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ HARDWARE = 'hardware'
+ SOFTWARE_ENCRYPTED_RAM = 'software-encrypted-ram'
+ SOFTWARE_PLAIN_RAM = 'software-plain-ram'
+ SOFTWARE_TEE = 'software-tee'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class CryptoImplementationPlatform(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties.implementationPlatform ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ ARMV7_A = 'armv7-a'
+ ARMV7_M = 'armv7-m'
+ ARMV8_A = 'armv8-a'
+ ARMV8_M = 'armv8-m'
+ ARMV9_A = 'armv9-a'
+ ARMV9_M = 'armv9-m'
+ GENERIC = 'generic'
+ PPC64 = 'ppc64'
+ PPC64LE = 'ppc64le'
+ S390X = 's390x'
+ X86_32 = 'x86_32'
+ X86_64 = 'x86_64'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class CryptoCertificationLevel(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties.certificationLevel ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ NONE = 'none'
+
+ FIPS140_1_L1 = 'fips140-1-l1'
+ FIPS140_1_L2 = 'fips140-1-l2'
+ FIPS140_1_L3 = 'fips140-1-l3'
+ FIPS140_1_L4 = 'fips140-1-l4'
+ FIPS140_2_L1 = 'fips140-2-l1'
+ FIPS140_2_L2 = 'fips140-2-l2'
+ FIPS140_2_L3 = 'fips140-2-l3'
+ FIPS140_2_L4 = 'fips140-2-l4'
+ FIPS140_3_L1 = 'fips140-3-l1'
+ FIPS140_3_L2 = 'fips140-3-l2'
+ FIPS140_3_L3 = 'fips140-3-l3'
+ FIPS140_3_L4 = 'fips140-3-l4'
+ CC_EAL1 = 'cc-eal1'
+ CC_EAL1_PLUS = 'cc-eal1+'
+ CC_EAL2 = 'cc-eal2'
+ CC_EAL2_PLUS = 'cc-eal2+'
+ CC_EAL3 = 'cc-eal3'
+ CC_EAL3_PLUS = 'cc-eal3+'
+ CC_EAL4 = 'cc-eal4'
+ CC_EAL4_PLUS = 'cc-eal4+'
+ CC_EAL5 = 'cc-eal5'
+ CC_EAL5_PLUS = 'cc-eal5+'
+ CC_EAL6 = 'cc-eal6'
+ CC_EAL6_PLUS = 'cc-eal6+'
+ CC_EAL7 = 'cc-eal7'
+ CC_EAL7_PLUS = 'cc-eal7+'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class CryptoMode(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties.mode ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ CBC = 'cbc'
+ CCM = 'ccm'
+ CFB = 'cfb'
+ CTR = 'ctr'
+ ECB = 'ecb'
+ GCM = 'gcm'
+ OFB = 'ofb'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class CryptoPadding(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties.padding ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ PKCS5 = 'pkcs5'
+ PKCS7 = 'pkcs7'
+ PKCS1V15 = 'pkcs1v15'
+ OAEP = 'oaep'
+ RAW = 'raw'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class CryptoFunction(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties.cryptoFunctions.cryptoFunction
+ ENUM type within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ DECAPSULATE = 'decapsulate'
+ DECRYPT = 'decrypt'
+ DIGEST = 'digest'
+ ENCAPSULATE = 'encapsulate'
+ ENCRYPT = 'encrypt'
+ GENERATE = 'generate'
+ KEYDERIVE = 'keyderive'
+ KEYGEN = 'keygen'
+ SIGN = 'sign'
+ TAG = 'tag'
+ VERIFY = 'verify'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_class
+class AlgorithmProperties:
+ """
+ This is our internal representation of the cryptoPropertiesType.algorithmProperties ENUM type within the CycloneDX
+ standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ primitive: Optional[CryptoPrimitive] = None,
+ parameter_set_identifier: Optional[str] = None,
+ curve: Optional[str] = None,
+ execution_environment: Optional[CryptoExecutionEnvironment] = None,
+ implementation_platform: Optional[CryptoImplementationPlatform] = None,
+ certification_levels: Optional[Iterable[CryptoCertificationLevel]] = None,
+ mode: Optional[CryptoMode] = None,
+ padding: Optional[CryptoPadding] = None,
+ crypto_functions: Optional[Iterable[CryptoFunction]] = None,
+ classical_security_level: Optional[int] = None,
+ nist_quantum_security_level: Optional[int] = None,
+ ) -> None:
+ self.primitive = primitive
+ self.parameter_set_identifier = parameter_set_identifier
+ self.curve = curve
+ self.execution_environment = execution_environment
+ self.implementation_platform = implementation_platform
+ self.certification_levels = certification_levels or [] # type:ignore[assignment]
+ self.mode = mode
+ self.padding = padding
+ self.crypto_functions = crypto_functions or [] # type:ignore[assignment]
+ self.classical_security_level = classical_security_level
+ self.nist_quantum_security_level = nist_quantum_security_level
+
+ @property
+ @serializable.xml_sequence(1)
+ def primitive(self) -> Optional[CryptoPrimitive]:
+ """
+ Cryptographic building blocks used in higher-level cryptographic systems and protocols.
+
+ Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG
+ from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES),
+ streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256),
+ public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256),
+ key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH),
+ key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of
+ multiple algorithms (combiner, e.g. SP800-56Cr2).
+
+ Returns:
+ `CryptoPrimitive` or `None`
+ """
+ return self._primitive
+
+ @primitive.setter
+ def primitive(self, primitive: Optional[CryptoPrimitive]) -> None:
+ self._primitive = primitive
+
+ @property
+ @serializable.xml_sequence(2)
+ def parameter_set_identifier(self) -> Optional[str]:
+ """
+ An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the
+ key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum
+ security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).
+
+ Returns:
+ `str` or `None`
+ """
+ return self._parameter_set_identifier
+
+ @parameter_set_identifier.setter
+ def parameter_set_identifier(self, parameter_set_identifier: Optional[str]) -> None:
+ self._parameter_set_identifier = parameter_set_identifier
+
+ @property
+ @serializable.xml_sequence(3)
+ def curve(self) -> Optional[str]:
+ """
+ The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security
+ strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends use
+ of curve names as defined at https://neuromancer.sk/std/, the source from which can be found at
+ https://github.com/J08nY/std-curves.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._curve
+
+ @curve.setter
+ def curve(self, curve: Optional[str]) -> None:
+ self._curve = curve
+
+ @property
+ @serializable.xml_sequence(4)
+ def execution_environment(self) -> Optional[CryptoExecutionEnvironment]:
+ """
+ The target and execution environment in which the algorithm is implemented in.
+
+ Returns:
+ `CryptoExecutionEnvironment` or `None`
+ """
+ return self._execution_environment
+
+ @execution_environment.setter
+ def execution_environment(self, execution_environment: Optional[CryptoExecutionEnvironment]) -> None:
+ self._execution_environment = execution_environment
+
+ @property
+ @serializable.xml_sequence(4)
+ def implementation_platform(self) -> Optional[CryptoImplementationPlatform]:
+ """
+ The target platform for which the algorithm is implemented. The implementation can be 'generic', running on
+ any platform or for a specific platform.
+
+ Returns:
+ `CryptoImplementationPlatform` or `None`
+ """
+ return self._implementation_platform
+
+ @implementation_platform.setter
+ def implementation_platform(self, implementation_platform: Optional[CryptoImplementationPlatform]) -> None:
+ self._implementation_platform = implementation_platform
+
+ @property
+ @serializable.json_name('certificationLevel')
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, child_name='certificationLevel')
+ @serializable.xml_sequence(5)
+ def certification_levels(self) -> 'SortedSet[CryptoCertificationLevel]':
+ """
+ The certification that the implementation of the cryptographic algorithm has received, if any. Certifications
+ include revisions and levels of FIPS 140 or Common Criteria of different Extended Assurance Levels (CC-EAL).
+
+ Returns:
+ `Iterable[CryptoCertificationLevel]`
+ """
+ return self._certification_levels
+
+ @certification_levels.setter
+ def certification_levels(self, certification_levels: Iterable[CryptoCertificationLevel]) -> None:
+ self._certification_levels = SortedSet(certification_levels)
+
+ @property
+ @serializable.xml_sequence(6)
+ def mode(self) -> Optional[CryptoMode]:
+ """
+ The mode of operation in which the cryptographic algorithm (block cipher) is used.
+
+ Returns:
+ `CryptoMode` or `None`
+ """
+ return self._mode
+
+ @mode.setter
+ def mode(self, mode: Optional[CryptoMode]) -> None:
+ self._mode = mode
+
+ @property
+ @serializable.xml_sequence(8)
+ def padding(self) -> Optional[CryptoPadding]:
+ """
+ The padding scheme that is used for the cryptographic algorithm.
+
+ Returns:
+ `CryptoPadding` or `None`
+ """
+ return self._padding
+
+ @padding.setter
+ def padding(self, padding: Optional[CryptoPadding]) -> None:
+ self._padding = padding
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, child_name='cryptoFunction')
+ @serializable.xml_sequence(9)
+ def crypto_functions(self) -> 'SortedSet[CryptoFunction]':
+ """
+ The cryptographic functions implemented by the cryptographic algorithm.
+
+ Returns:
+ `Iterable[CryptoFunction]`
+ """
+ return self._crypto_functions
+
+ @crypto_functions.setter
+ def crypto_functions(self, crypto_functions: Iterable[CryptoFunction]) -> None:
+ self._crypto_functions = SortedSet(crypto_functions)
+
+ @property
+ @serializable.xml_sequence(10)
+ def classical_security_level(self) -> Optional[int]:
+ """
+ The classical security level that a cryptographic algorithm provides (in bits).
+
+ Returns:
+ `int` or `None`
+ """
+ return self._classical_security_level
+
+ @classical_security_level.setter
+ def classical_security_level(self, classical_security_level: Optional[int]) -> None:
+ self._classical_security_level = classical_security_level
+
+ @property
+ @serializable.xml_sequence(11)
+ def nist_quantum_security_level(self) -> Optional[int]:
+ """
+ The NIST security strength category as defined in
+ https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/
+ evaluation-criteria/security-(evaluation-criteria). A value of 0 indicates that none of the categories are met.
+
+ Returns:
+ `int` or `None`
+ """
+ return self._nist_quantum_security_level
+
+ @nist_quantum_security_level.setter
+ def nist_quantum_security_level(self, nist_quantum_security_level: Optional[int]) -> None:
+ if nist_quantum_security_level is not None and (
+ nist_quantum_security_level < 0
+ or nist_quantum_security_level > 6
+ ):
+ raise InvalidNistQuantumSecurityLevelException(
+ 'NIST Quantum Security Level must be (0 <= value <= 6)'
+ )
+ self._nist_quantum_security_level = nist_quantum_security_level
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.primitive, self._parameter_set_identifier, self.curve, self.execution_environment,
+ self.implementation_platform, _ComparableTuple(self.certification_levels), self.mode, self.padding,
+ _ComparableTuple(self.crypto_functions), self.classical_security_level, self.nist_quantum_security_level,
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, AlgorithmProperties):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class CertificateProperties:
+ """
+ This is our internal representation of the `cryptoPropertiesType.certificateProperties` complex type within
+ CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ subject_name: Optional[str] = None,
+ issuer_name: Optional[str] = None,
+ not_valid_before: Optional[datetime] = None,
+ not_valid_after: Optional[datetime] = None,
+ signature_algorithm_ref: Optional[BomRef] = None,
+ subject_public_key_ref: Optional[BomRef] = None,
+ certificate_format: Optional[str] = None,
+ certificate_extension: Optional[str] = None,
+ ) -> None:
+ self.subject_name = subject_name
+ self.issuer_name = issuer_name
+ self.not_valid_before = not_valid_before
+ self.not_valid_after = not_valid_after
+ self.signature_algorithm_ref = signature_algorithm_ref
+ self.subject_public_key_ref = subject_public_key_ref
+ self.certificate_format = certificate_format
+ self.certificate_extension = certificate_extension
+
+ @property
+ @serializable.xml_sequence(10)
+ def subject_name(self) -> Optional[str]:
+ """
+ The subject name for the certificate.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._subject_name
+
+ @subject_name.setter
+ def subject_name(self, subject_name: Optional[str]) -> None:
+ self._subject_name = subject_name
+
+ @property
+ @serializable.xml_sequence(20)
+ def issuer_name(self) -> Optional[str]:
+ """
+ The issuer name for the certificate.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._issuer_name
+
+ @issuer_name.setter
+ def issuer_name(self, issuer_name: Optional[str]) -> None:
+ self._issuer_name = issuer_name
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(30)
+ def not_valid_before(self) -> Optional[datetime]:
+ """
+ The date and time according to ISO-8601 standard from which the certificate is valid.
+
+ Returns:
+ `datetime` or `None`
+ """
+ return self._not_valid_before
+
+ @not_valid_before.setter
+ def not_valid_before(self, not_valid_before: Optional[datetime]) -> None:
+ self._not_valid_before = not_valid_before
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(40)
+ def not_valid_after(self) -> Optional[datetime]:
+ """
+ The date and time according to ISO-8601 standard from which the certificate is not valid anymore.
+
+ Returns:
+ `datetime` or `None`
+ """
+ return self._not_valid_after
+
+ @not_valid_after.setter
+ def not_valid_after(self, not_valid_after: Optional[datetime]) -> None:
+ self._not_valid_after = not_valid_after
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_sequence(50)
+ def signature_algorithm_ref(self) -> Optional[BomRef]:
+ """
+ The bom-ref to signature algorithm used by the certificate.
+
+ Returns:
+ `BomRef` or `None`
+ """
+ return self._signature_algorithm_ref
+
+ @signature_algorithm_ref.setter
+ def signature_algorithm_ref(self, signature_algorithm_ref: Optional[BomRef]) -> None:
+ self._signature_algorithm_ref = signature_algorithm_ref
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_sequence(60)
+ def subject_public_key_ref(self) -> Optional[BomRef]:
+ """
+ The bom-ref to the public key of the subject.
+
+ Returns:
+ `BomRef` or `None`
+ """
+ return self._subject_public_key_ref
+
+ @subject_public_key_ref.setter
+ def subject_public_key_ref(self, subject_public_key_ref: Optional[BomRef]) -> None:
+ self._subject_public_key_ref = subject_public_key_ref
+
+ @property
+ @serializable.xml_sequence(70)
+ def certificate_format(self) -> Optional[str]:
+ """
+ The format of the certificate. Examples include X.509, PEM, DER, and CVC.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._certificate_format
+
+ @certificate_format.setter
+ def certificate_format(self, certificate_format: Optional[str]) -> None:
+ self._certificate_format = certificate_format
+
+ @property
+ @serializable.xml_sequence(80)
+ def certificate_extension(self) -> Optional[str]:
+ """
+ The file extension of the certificate. Examples include crt, pem, cer, der, and p12.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._certificate_extension
+
+ @certificate_extension.setter
+ def certificate_extension(self, certificate_extension: Optional[str]) -> None:
+ self._certificate_extension = certificate_extension
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.subject_name, self.issuer_name, self.not_valid_before, self.not_valid_after,
+ self.certificate_format, self.certificate_extension
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, CertificateProperties):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class RelatedCryptoMaterialType(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.relatedCryptoMaterialProperties.type ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ ADDITIONAL_DATA = 'additional-data'
+ CIPHERTEXT = 'ciphertext'
+ CREDENTIAL = 'credential'
+ DIGEST = 'digest'
+ INITIALIZATION_VECTOR = 'initialization-vector'
+ KEY = 'key'
+ NONCE = 'nonce'
+ PASSWORD = 'password' # nosec
+ PRIVATE_KEY = 'private-key'
+ PUBLIC_KEY = 'public-key'
+ SALT = 'salt'
+ SECRET_KEY = 'secret-key' # nosec
+ SEED = 'seed'
+ SHARED_SECRET = 'shared-secret' # nosec
+ SIGNATURE = 'signature'
+ TAG = 'tag'
+ TOKEN = 'token' # nosec
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class RelatedCryptoMaterialState(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.relatedCryptoMaterialProperties.state ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ ACTIVE = 'active'
+ COMPROMISED = 'compromised'
+ DEACTIVATED = 'deactivated'
+ DESTROYED = 'destroyed'
+ PRE_ACTIVATION = 'pre-activation'
+ SUSPENDED = 'suspended'
+
+
+@serializable.serializable_class
+class RelatedCryptoMaterialSecuredBy:
+ """
+ This is our internal representation of the `cryptoPropertiesType.relatedCryptoMaterialProperties.securedBy` complex
+ type within CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ mechanism: Optional[str] = None,
+ algorithm_ref: Optional[BomRef] = None,
+ ) -> None:
+ self.mechanism = mechanism
+ self.algorithm_ref = algorithm_ref
+
+ @property
+ @serializable.xml_sequence(10)
+ def mechanism(self) -> Optional[str]:
+ """
+ Specifies the mechanism by which the cryptographic asset is secured by.
+ Examples include HSM, TPM, XGX, Software, and None.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._mechanism
+
+ @mechanism.setter
+ def mechanism(self, mechanism: Optional[str]) -> None:
+ self._mechanism = mechanism
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_sequence(20)
+ def algorithm_ref(self) -> Optional[BomRef]:
+ """
+ The bom-ref to the algorithm.
+
+ Returns:
+ `BomRef` or `None`
+ """
+ return self._algorithm_ref
+
+ @algorithm_ref.setter
+ def algorithm_ref(self, algorithm_ref: Optional[BomRef]) -> None:
+ self._algorithm_ref = algorithm_ref
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.mechanism, self.algorithm_ref
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, RelatedCryptoMaterialSecuredBy):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class RelatedCryptoMaterialProperties:
+ """
+ This is our internal representation of the `cryptoPropertiesType.relatedCryptoMaterialProperties` complex type
+ within CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ type: Optional[RelatedCryptoMaterialType] = None,
+ id: Optional[str] = None,
+ state: Optional[RelatedCryptoMaterialState] = None,
+ algorithm_ref: Optional[BomRef] = None,
+ creation_date: Optional[datetime] = None,
+ activation_date: Optional[datetime] = None,
+ update_date: Optional[datetime] = None,
+ expiration_date: Optional[datetime] = None,
+ value: Optional[str] = None,
+ size: Optional[int] = None,
+ format: Optional[str] = None,
+ secured_by: Optional[RelatedCryptoMaterialSecuredBy] = None,
+ ) -> None:
+ self.type = type
+ self.id = id
+ self.state = state
+ self.algorithm_ref = algorithm_ref
+ self.creation_date = creation_date
+ self.activation_date = activation_date
+ self.update_date = update_date
+ self.expiration_date = expiration_date
+ self.value = value
+ self.size = size
+ self.format = format
+ self.secured_by = secured_by
+
+ @property
+ @serializable.xml_sequence(10)
+ def type(self) -> Optional[RelatedCryptoMaterialType]:
+ """
+ The type for the related cryptographic material.
+
+ Returns
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: Optional[RelatedCryptoMaterialType]) -> None:
+ self._type = type
+
+ @property
+ @serializable.xml_sequence(20)
+ def id(self) -> Optional[str]:
+ """
+ The optional unique identifier for the related cryptographic material.
+
+ :return:
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: Optional[str]) -> None:
+ self._id = id
+
+ @property
+ @serializable.xml_sequence(30)
+ def state(self) -> Optional[RelatedCryptoMaterialState]:
+ """
+ The key state as defined by NIST SP 800-57.
+
+ Returns:
+ `RelatedCryptoMaterialState` or `None`
+ """
+ return self._state
+
+ @state.setter
+ def state(self, state: Optional[RelatedCryptoMaterialState]) -> None:
+ self._state = state
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_sequence(40)
+ def algorithm_ref(self) -> Optional[BomRef]:
+ """
+ The bom-ref to the algorithm used to generate the related cryptographic material.
+
+ Returns:
+ `BomRef` or `None`
+ """
+ return self._algorithm_ref
+
+ @algorithm_ref.setter
+ def algorithm_ref(self, algorithm_ref: Optional[BomRef]) -> None:
+ self._algorithm_ref = algorithm_ref
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(50)
+ def creation_date(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the related cryptographic material was created.
+
+ Returns:
+ `datetime` or `None`
+ """
+ return self._creation_date
+
+ @creation_date.setter
+ def creation_date(self, creation_date: Optional[datetime]) -> None:
+ self._creation_date = creation_date
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(60)
+ def activation_date(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the related cryptographic material was activated.
+
+ Returns:
+ `datetime` or `None`
+ """
+ return self._activation_date
+
+ @activation_date.setter
+ def activation_date(self, activation_date: Optional[datetime]) -> None:
+ self._activation_date = activation_date
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(70)
+ def update_date(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the related cryptographic material was updated.
+
+ Returns:
+ `datetime` or `None`
+ """
+ return self._update_date
+
+ @update_date.setter
+ def update_date(self, update_date: Optional[datetime]) -> None:
+ self._update_date = update_date
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(80)
+ def expiration_date(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the related cryptographic material expires.
+
+ Returns:
+ `datetime` or `None`
+ """
+ return self._expiration_date
+
+ @expiration_date.setter
+ def expiration_date(self, expiration_date: Optional[datetime]) -> None:
+ self._expiration_date = expiration_date
+
+ @property
+ @serializable.xml_sequence(90)
+ def value(self) -> Optional[str]:
+ """
+ The associated value of the cryptographic material.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._value
+
+ @value.setter
+ def value(self, value: Optional[str]) -> None:
+ self._value = value
+
+ @property
+ @serializable.xml_sequence(100)
+ def size(self) -> Optional[int]:
+ """
+ The size of the cryptographic asset (in bits).
+
+ Returns:
+ `int` or `None`
+ """
+ return self._size
+
+ @size.setter
+ def size(self, size: Optional[int]) -> None:
+ if size and size < 0:
+ raise InvalidRelatedCryptoMaterialSizeException('Size must be greater than zero')
+ self._size = size
+
+ @property
+ @serializable.xml_sequence(110)
+ def format(self) -> Optional[str]:
+ """
+ The format of the related cryptographic material (e.g. P8, PEM, DER).
+
+ Returns:
+ `str` or `None`
+ """
+ return self._format
+
+ @format.setter
+ def format(self, format: Optional[str]) -> None:
+ self._format = format
+
+ @property
+ @serializable.xml_sequence(120)
+ def secured_by(self) -> Optional[RelatedCryptoMaterialSecuredBy]:
+ """
+ The mechanism by which the cryptographic asset is secured by.
+
+ Returns:
+ `RelatedCryptoMaterialSecuredBy` or `None`
+ """
+ return self._secured_by
+
+ @secured_by.setter
+ def secured_by(self, secured_by: Optional[RelatedCryptoMaterialSecuredBy]) -> None:
+ self._secured_by = secured_by
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.type, self.id, self.state, self.algorithm_ref, self.creation_date, self.activation_date,
+ self.update_date, self.expiration_date, self.value, self.size, self.format, self.secured_by
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, RelatedCryptoMaterialProperties):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class ProtocolPropertiesType(str, Enum):
+ """
+ This is our internal representation of the cryptoPropertiesType.protocolProperties.type ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ IKE = 'ike'
+ IPSEC = 'ipsec'
+ SSH = 'ssh'
+ SSTP = 'sstp'
+ TLS = 'tls'
+ WPA = 'wpa'
+
+ OTHER = 'other'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_class
+class ProtocolPropertiesCipherSuite:
+ """
+ This is our internal representation of the `cryptoPropertiesType.protocolProperties.cipherSuites.cipherSuite`
+ complex type within CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ name: Optional[str] = None,
+ algorithms: Optional[Iterable[BomRef]] = None,
+ identifiers: Optional[Iterable[str]] = None,
+ ) -> None:
+ self.name = name
+ self.algorithms = algorithms or [] # type:ignore[assignment]
+ self.identifiers = identifiers or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(10)
+ def name(self) -> Optional[str]:
+ """
+ A common name for the cipher suite. For example: TLS_DHE_RSA_WITH_AES_128_CCM.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'algorithm')
+ @serializable.xml_sequence(20)
+ def algorithms(self) -> 'SortedSet[BomRef]':
+ """
+ A list BomRefs to algorithms related to the cipher suite.
+
+ Returns:
+ `Iterable[BomRef]` or `None`
+ """
+ return self._algorithms
+
+ @algorithms.setter
+ def algorithms(self, algorithms: Iterable[BomRef]) -> None:
+ self._algorithms = SortedSet(algorithms)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'identifier')
+ @serializable.xml_sequence(20)
+ def identifiers(self) -> 'SortedSet[str]':
+ """
+ A list of common identifiers for the cipher suite. Examples include 0xC0 and 0x9E.
+
+ Returns:
+ `Iterable[str]` or `None`
+ """
+ return self._identifiers
+
+ @identifiers.setter
+ def identifiers(self, identifiers: Iterable[str]) -> None:
+ self._identifiers = SortedSet(identifiers)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.name, _ComparableTuple(self.algorithms), _ComparableTuple(self.identifiers)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, ProtocolPropertiesCipherSuite):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, ProtocolPropertiesCipherSuite):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Ikev2TransformTypes:
+ """
+ This is our internal representation of the `cryptoPropertiesType.protocolProperties.ikev2TransformTypes`
+ complex type within CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ encr: Optional[Iterable[BomRef]] = None,
+ prf: Optional[Iterable[BomRef]] = None,
+ integ: Optional[Iterable[BomRef]] = None,
+ ke: Optional[Iterable[BomRef]] = None,
+ esn: Optional[bool] = None,
+ auth: Optional[Iterable[BomRef]] = None,
+ ) -> None:
+ self.encr = encr or [] # type:ignore[assignment]
+ self.prf = prf or [] # type:ignore[assignment]
+ self.integ = integ or [] # type:ignore[assignment]
+ self.ke = ke or [] # type:ignore[assignment]
+ self.esn = esn
+ self.auth = auth or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(10)
+ def encr(self) -> 'SortedSet[BomRef]':
+ """
+ Transform Type 1: encryption algorithms.
+
+ Returns:
+ `Iterable[BomRef]` or `None`
+ """
+ return self._encr
+
+ @encr.setter
+ def encr(self, encr: Iterable[BomRef]) -> None:
+ self._encr = SortedSet(encr)
+
+ @property
+ @serializable.xml_sequence(20)
+ def prf(self) -> 'SortedSet[BomRef]':
+ """
+ Transform Type 2: pseudorandom functions.
+
+ Returns:
+ `Iterable[BomRef]` or `None`
+ """
+ return self._prf
+
+ @prf.setter
+ def prf(self, prf: Iterable[BomRef]) -> None:
+ self._prf = SortedSet(prf)
+
+ @property
+ @serializable.xml_sequence(30)
+ def integ(self) -> 'SortedSet[BomRef]':
+ """
+ Transform Type 3: integrity algorithms.
+
+ Returns:
+ `Iterable[BomRef]` or `None`
+ """
+ return self._integ
+
+ @integ.setter
+ def integ(self, integ: Iterable[BomRef]) -> None:
+ self._integ = SortedSet(integ)
+
+ @property
+ @serializable.xml_sequence(40)
+ def ke(self) -> 'SortedSet[BomRef]':
+ """
+ Transform Type 4: Key Exchange Method (KE) per RFC9370, formerly called Diffie-Hellman Group (D-H).
+
+ Returns:
+ `Iterable[BomRef]` or `None`
+ """
+ return self._ke
+
+ @ke.setter
+ def ke(self, ke: Iterable[BomRef]) -> None:
+ self._ke = SortedSet(ke)
+
+ @property
+ @serializable.xml_sequence(50)
+ def esn(self) -> Optional[bool]:
+ """
+ Specifies if an Extended Sequence Number (ESN) is used.
+
+ Returns:
+ `bool` or `None`
+ """
+ return self._esn
+
+ @esn.setter
+ def esn(self, esn: Optional[bool]) -> None:
+ self._esn = esn
+
+ @property
+ @serializable.xml_sequence(60)
+ def auth(self) -> 'SortedSet[BomRef]':
+ """
+ IKEv2 Authentication method.
+
+ Returns:
+ `Iterable[BomRef]` or `None`
+ """
+ return self._auth
+
+ @auth.setter
+ def auth(self, auth: Iterable[BomRef]) -> None:
+ self._auth = SortedSet(auth)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ _ComparableTuple(self.encr),
+ _ComparableTuple(self.prf),
+ _ComparableTuple(self.integ),
+ _ComparableTuple(self.ke),
+ self.esn,
+ _ComparableTuple(self.auth)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Ikev2TransformTypes):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class ProtocolProperties:
+ """
+ This is our internal representation of the `cryptoPropertiesType.protocolProperties` complex type within
+ CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ type: Optional[ProtocolPropertiesType] = None,
+ version: Optional[str] = None,
+ cipher_suites: Optional[Iterable[ProtocolPropertiesCipherSuite]] = None,
+ ikev2_transform_types: Optional[Ikev2TransformTypes] = None,
+ crypto_refs: Optional[Iterable[BomRef]] = None,
+ ) -> None:
+ self.type = type
+ self.version = version
+ self.cipher_suites = cipher_suites or [] # type:ignore[assignment]
+ self.ikev2_transform_types = ikev2_transform_types
+ self.crypto_refs = crypto_refs or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(10)
+ def type(self) -> Optional[ProtocolPropertiesType]:
+ """
+ The concrete protocol type.
+
+ Returns:
+ `ProtocolPropertiesType` or `None`
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: Optional[ProtocolPropertiesType]) -> None:
+ self._type = type
+
+ @property
+ @serializable.xml_sequence(20)
+ def version(self) -> Optional[str]:
+ """
+ The version of the protocol. Examples include 1.0, 1.2, and 1.99.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: Optional[str]) -> None:
+ self._version = version
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'cipherSuite')
+ @serializable.xml_sequence(30)
+ def cipher_suites(self) -> 'SortedSet[ProtocolPropertiesCipherSuite]':
+ """
+ A list of cipher suites related to the protocol.
+
+ Returns:
+ `Iterable[ProtocolPropertiesCipherSuite]`
+ """
+ return self._cipher_suites
+
+ @cipher_suites.setter
+ def cipher_suites(self, cipher_suites: Iterable[ProtocolPropertiesCipherSuite]) -> None:
+ self._cipher_suites = SortedSet(cipher_suites)
+
+ @property
+ @serializable.xml_sequence(40)
+ def ikev2_transform_types(self) -> Optional[Ikev2TransformTypes]:
+ """
+ The IKEv2 transform types supported (types 1-4), defined in RFC7296 section 3.3.2, and additional properties.
+
+ Returns:
+ `Ikev2TransformTypes` or `None`
+ """
+ return self._ikev2_transform_types
+
+ @ikev2_transform_types.setter
+ def ikev2_transform_types(self, ikev2_transform_types: Optional[Ikev2TransformTypes]) -> None:
+ self._ikev2_transform_types = ikev2_transform_types
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, 'cryptoRef')
+ @serializable.json_name('cryptoRefArray')
+ def crypto_refs(self) -> 'SortedSet[BomRef]':
+ """
+ A list of protocol-related cryptographic assets.
+
+ Returns:
+ `Iterable[BomRef]`
+ """
+ return self._crypto_refs
+
+ @crypto_refs.setter
+ def crypto_refs(self, crypto_refs: Iterable[BomRef]) -> None:
+ self._crypto_refs = SortedSet(crypto_refs)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.type,
+ self.version,
+ _ComparableTuple(self.cipher_suites),
+ self.ikev2_transform_types,
+ _ComparableTuple(self.crypto_refs)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, ProtocolProperties):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class CryptoProperties:
+ """
+ This is our internal representation of the `cryptoPropertiesType` complex type within CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+
+ .. note::
+ See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
+ """
+
+ def __init__(
+ self, *,
+ asset_type: Optional[CryptoAssetType] = None,
+ algorithm_properties: Optional[AlgorithmProperties] = None,
+ certificate_properties: Optional[CertificateProperties] = None,
+ related_crypto_material_properties: Optional[RelatedCryptoMaterialProperties] = None,
+ protocol_properties: Optional[ProtocolProperties] = None,
+ oid: Optional[str] = None,
+ ) -> None:
+ self.asset_type = asset_type
+ self.algorithm_properties = algorithm_properties
+ self.certificate_properties = certificate_properties
+ self.related_crypto_material_properties = related_crypto_material_properties
+ self.protocol_properties = protocol_properties
+ self.oid = oid
+
+ @property
+ @serializable.xml_sequence(10)
+ def asset_type(self) -> Optional[CryptoAssetType]:
+ """
+ Cryptographic assets occur in several forms. Algorithms and protocols are most commonly implemented in
+ specialized cryptographic libraries. They may however also be 'hardcoded' in software components. Certificates
+ and related cryptographic material like keys, tokens, secrets or passwords are other cryptographic assets to be
+ modelled.
+
+ Returns:
+ `CryptoAssetType`
+ """
+ return self._asset_type
+
+ @asset_type.setter
+ def asset_type(self, asset_type: Optional[CryptoAssetType]) -> None:
+ self._asset_type = asset_type
+
+ @property
+ @serializable.xml_sequence(20)
+ def algorithm_properties(self) -> Optional[AlgorithmProperties]:
+ """
+ Additional properties specific to a cryptographic algorithm.
+
+ Returns:
+ `AlgorithmProperties` or `None`
+ """
+ return self._algorithm_properties
+
+ @algorithm_properties.setter
+ def algorithm_properties(self, algorithm_properties: Optional[AlgorithmProperties]) -> None:
+ self._algorithm_properties = algorithm_properties
+
+ @property
+ @serializable.xml_sequence(30)
+ def certificate_properties(self) -> Optional[CertificateProperties]:
+ """
+ Properties for cryptographic assets of asset type 'certificate'.
+
+ Returns:
+ `CertificateProperties` or `None`
+ """
+ return self._certificate_properties
+
+ @certificate_properties.setter
+ def certificate_properties(self, certificate_properties: Optional[CertificateProperties]) -> None:
+ self._certificate_properties = certificate_properties
+
+ @property
+ @serializable.xml_sequence(40)
+ def related_crypto_material_properties(self) -> Optional[RelatedCryptoMaterialProperties]:
+ """
+ Properties for cryptographic assets of asset type 'relatedCryptoMaterial'.
+
+ Returns:
+ `RelatedCryptoMaterialProperties` or `None`
+ """
+ return self._related_crypto_material_properties
+
+ @related_crypto_material_properties.setter
+ def related_crypto_material_properties(
+ self,
+ related_crypto_material_properties: Optional[RelatedCryptoMaterialProperties]
+ ) -> None:
+ self._related_crypto_material_properties = related_crypto_material_properties
+
+ @property
+ @serializable.xml_sequence(50)
+ def protocol_properties(self) -> Optional[ProtocolProperties]:
+ """
+ Properties specific to cryptographic assets of type: 'protocol'.
+
+ Returns:
+ `ProtocolProperties` or `None`
+ """
+ return self._protocol_properties
+
+ @protocol_properties.setter
+ def protocol_properties(self, protocol_properties: Optional[ProtocolProperties]) -> None:
+ self._protocol_properties = protocol_properties
+
+ @property
+ @serializable.xml_sequence(60)
+ def oid(self) -> Optional[str]:
+ """
+ The object identifier (OID) of the cryptographic asset.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._oid
+
+ @oid.setter
+ def oid(self, oid: Optional[str]) -> None:
+ self._oid = oid
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.asset_type,
+ self.algorithm_properties,
+ self.certificate_properties,
+ self.related_crypto_material_properties,
+ self.protocol_properties,
+ self.oid,
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, CryptoProperties):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, CryptoProperties):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/definition.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/definition.py
new file mode 100644
index 00000000..675e5476
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/definition.py
@@ -0,0 +1,623 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+import re
+from typing import TYPE_CHECKING, Any, Iterable, Optional, Union
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..exception.model import InvalidCreIdException
+from ..exception.serialization import SerializationOfUnexpectedValueException
+from . import ExternalReference, Property
+from .bom_ref import BomRef
+
+if TYPE_CHECKING: # pragma: no cover
+ from typing import Type, TypeVar
+
+ _T_CreId = TypeVar('_T_CreId', bound='CreId')
+
+
+@serializable.serializable_class
+class CreId(serializable.helpers.BaseHelper):
+ """
+ Helper class that allows us to perform validation on data strings that must conform to
+ Common Requirements Enumeration (CRE) identifier(s).
+
+ """
+
+ _VALID_CRE_REGEX = re.compile(r'^CRE:[0-9]+-[0-9]+$')
+
+ def __init__(self, id: str) -> None:
+ if CreId._VALID_CRE_REGEX.match(id) is None:
+ raise InvalidCreIdException(
+ f'Supplied value "{id} does not meet format specification.'
+ )
+ self._id = id
+
+ @property
+ @serializable.json_name('.')
+ @serializable.xml_name('.')
+ def id(self) -> str:
+ return self._id
+
+ @classmethod
+ def serialize(cls, o: Any) -> str:
+ if isinstance(o, cls):
+ return str(o)
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-CreId: {o!r}')
+
+ @classmethod
+ def deserialize(cls: 'Type[_T_CreId]', o: Any) -> '_T_CreId':
+ return cls(id=str(o))
+
+ def __eq__(self, other: Any) -> bool:
+ if isinstance(other, CreId):
+ return self._id == other._id
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, CreId):
+ return self._id < other._id
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self._id)
+
+ def __repr__(self) -> str:
+ return f''
+
+ def __str__(self) -> str:
+ return self._id
+
+
+@serializable.serializable_class
+class Requirement:
+ """
+ A requirement comprising a standard.
+ """
+
+ def __init__(
+ self, *,
+ bom_ref: Optional[Union[str, BomRef]] = None,
+ identifier: Optional[str] = None,
+ title: Optional[str] = None,
+ text: Optional[str] = None,
+ descriptions: Optional[Iterable[str]] = None,
+ open_cre: Optional[Iterable[CreId]] = None,
+ parent: Optional[Union[str, BomRef]] = None,
+ properties: Optional[Iterable[Property]] = None,
+ external_references: Optional[Iterable[ExternalReference]] = None,
+ ) -> None:
+ self._bom_ref = _bom_ref_from_str(bom_ref)
+ self.identifier = identifier
+ self.title = title
+ self.text = text
+ self.descriptions = descriptions or () # type:ignore[assignment]
+ self.open_cre = open_cre or () # type:ignore[assignment]
+ self.parent = parent # type:ignore[assignment]
+ self.properties = properties or () # type:ignore[assignment]
+ self.external_references = external_references or () # type:ignore[assignment]
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.json_name('bom-ref')
+ @serializable.xml_name('bom-ref')
+ @serializable.xml_attribute()
+ def bom_ref(self) -> BomRef:
+ """
+ An optional identifier which can be used to reference the requirement elsewhere in the BOM.
+ Every bom-ref MUST be unique within the BOM.
+
+ Returns:
+ `BomRef`
+ """
+ return self._bom_ref
+
+ @property
+ @serializable.xml_sequence(1)
+ def identifier(self) -> Optional[str]:
+ """
+ Returns:
+ The identifier of the requirement.
+ """
+ return self._identifier
+
+ @identifier.setter
+ def identifier(self, identifier: Optional[str]) -> None:
+ self._identifier = identifier
+
+ @property
+ @serializable.xml_sequence(2)
+ def title(self) -> Optional[str]:
+ """
+ Returns:
+ The title of the requirement.
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title: Optional[str]) -> None:
+ self._title = title
+
+ @property
+ @serializable.xml_sequence(3)
+ def text(self) -> Optional[str]:
+ """
+ Returns:
+ The text of the requirement.
+ """
+ return self._text
+
+ @text.setter
+ def text(self, text: Optional[str]) -> None:
+ self._text = text
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'description')
+ @serializable.xml_sequence(4)
+ def descriptions(self) -> 'SortedSet[str]':
+ """
+ Returns:
+ A SortedSet of descriptions of the requirement.
+ """
+ return self._descriptions
+
+ @descriptions.setter
+ def descriptions(self, descriptions: Iterable[str]) -> None:
+ self._descriptions = SortedSet(descriptions)
+
+ @property
+ @serializable.json_name('openCre')
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, 'openCre')
+ @serializable.xml_sequence(5)
+ def open_cre(self) -> 'SortedSet[CreId]':
+ """
+ CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each
+ section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all
+ resources map to each other. Use of CRE promotes clear and unambiguous communication among stakeholders.
+
+ Returns:
+ The Common Requirements Enumeration (CRE) identifier(s).
+ CREs must match regular expression: ^CRE:[0-9]+-[0-9]+$
+ """
+ return self._open_cre
+
+ @open_cre.setter
+ def open_cre(self, open_cre: Iterable[CreId]) -> None:
+ self._open_cre = SortedSet(open_cre)
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_sequence(6)
+ def parent(self) -> Optional[BomRef]:
+ """
+ Returns:
+ The optional bom-ref to a parent requirement. This establishes a hierarchy of requirements. Top-level
+ requirements must not define a parent. Only child requirements should define parents.
+ """
+ return self._parent
+
+ @parent.setter
+ def parent(self, parent: Optional[Union[str, BomRef]]) -> None:
+ self._parent = _bom_ref_from_str(parent, optional=True)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
+ @serializable.xml_sequence(7)
+ def properties(self) -> 'SortedSet[Property]':
+ """
+ Provides the ability to document properties in a key/value store. This provides flexibility to include data not
+ officially supported in the standard without having to use additional namespaces or create extensions.
+
+ Return:
+ Set of `Property`
+ """
+ return self._properties
+
+ @properties.setter
+ def properties(self, properties: Iterable[Property]) -> None:
+ self._properties = SortedSet(properties)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'reference')
+ @serializable.xml_sequence(8)
+ def external_references(self) -> 'SortedSet[ExternalReference]':
+ """
+ Provides the ability to document external references related to the component or to the project the component
+ describes.
+
+ Returns:
+ Set of `ExternalReference`
+ """
+ return self._external_references
+
+ @external_references.setter
+ def external_references(self, external_references: Iterable[ExternalReference]) -> None:
+ self._external_references = SortedSet(external_references)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ # all properties are optional - so need to compare all, in hope that one is unique
+ return _ComparableTuple((
+ self.identifier, self.bom_ref.value,
+ self.title, self.text,
+ _ComparableTuple(self.descriptions),
+ _ComparableTuple(self.open_cre), self.parent, _ComparableTuple(self.properties),
+ _ComparableTuple(self.external_references)
+ ))
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Requirement):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Requirement):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Level:
+ """
+ Level of compliance for a standard.
+ """
+
+ def __init__(
+ self, *,
+ bom_ref: Optional[Union[str, BomRef]] = None,
+ identifier: Optional[str] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ requirements: Optional[Iterable[Union[str, BomRef]]] = None,
+ ) -> None:
+ self._bom_ref = _bom_ref_from_str(bom_ref)
+ self.identifier = identifier
+ self.title = title
+ self.description = description
+ self.requirements = requirements or () # type:ignore[assignment]
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.json_name('bom-ref')
+ @serializable.xml_name('bom-ref')
+ @serializable.xml_attribute()
+ def bom_ref(self) -> BomRef:
+ """
+ An optional identifier which can be used to reference the level elsewhere in the BOM.
+ Every bom-ref MUST be unique within the BOM.
+
+ Returns:
+ `BomRef`
+ """
+ return self._bom_ref
+
+ @property
+ @serializable.xml_sequence(1)
+ def identifier(self) -> Optional[str]:
+ """
+ Returns:
+ The identifier of the level.
+ """
+ return self._identifier
+
+ @identifier.setter
+ def identifier(self, identifier: Optional[str]) -> None:
+ self._identifier = identifier
+
+ @property
+ @serializable.xml_sequence(2)
+ def title(self) -> Optional[str]:
+ """
+ Returns:
+ The title of the level.
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title: Optional[str]) -> None:
+ self._title = title
+
+ @property
+ @serializable.xml_sequence(3)
+ def description(self) -> Optional[str]:
+ """
+ Returns:
+ The description of the level.
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ @property
+ @serializable.xml_sequence(4)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'requirement')
+ def requirements(self) -> 'SortedSet[BomRef]':
+ """
+ Returns:
+ A SortedSet of requirements associated with the level.
+ """
+ return self._requirements
+
+ @requirements.setter
+ def requirements(self, requirements: Iterable[Union[str, BomRef]]) -> None:
+ self._requirements = SortedSet(map(_bom_ref_from_str, # type: ignore[arg-type]
+ requirements))
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ # all properties are optional - so need to compare all, in hope that one is unique
+ return _ComparableTuple((
+ self.identifier, self.bom_ref.value,
+ self.title, self.description,
+ _ComparableTuple(self.requirements)
+ ))
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Level):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Level):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Standard:
+ """
+ A standard of regulations, industry or organizational-specific standards, maturity models, best practices,
+ or any other requirements.
+ """
+
+ def __init__(
+ self, *,
+ bom_ref: Optional[Union[str, BomRef]] = None,
+ name: Optional[str] = None,
+ version: Optional[str] = None,
+ description: Optional[str] = None,
+ owner: Optional[str] = None,
+ requirements: Optional[Iterable[Requirement]] = None,
+ levels: Optional[Iterable[Level]] = None,
+ external_references: Optional[Iterable['ExternalReference']] = None
+ # TODO: signature
+ ) -> None:
+ self._bom_ref = _bom_ref_from_str(bom_ref)
+ self.name = name
+ self.version = version
+ self.description = description
+ self.owner = owner
+ self.requirements = requirements or () # type:ignore[assignment]
+ self.levels = levels or () # type:ignore[assignment]
+ self.external_references = external_references or () # type:ignore[assignment]
+ # TODO: signature
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.json_name('bom-ref')
+ @serializable.xml_name('bom-ref')
+ @serializable.xml_attribute()
+ def bom_ref(self) -> BomRef:
+ """
+ An optional identifier which can be used to reference the standard elsewhere in the BOM. Every bom-ref MUST be
+ unique within the BOM.
+
+ Returns:
+ `BomRef`
+ """
+ return self._bom_ref
+
+ @property
+ @serializable.xml_sequence(1)
+ def name(self) -> Optional[str]:
+ """
+ Returns:
+ The name of the standard
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_sequence(2)
+ def version(self) -> Optional[str]:
+ """
+ Returns:
+ The version of the standard
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: Optional[str]) -> None:
+ self._version = version
+
+ @property
+ @serializable.xml_sequence(3)
+ def description(self) -> Optional[str]:
+ """
+ Returns:
+ The description of the standard
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ @property
+ @serializable.xml_sequence(4)
+ def owner(self) -> Optional[str]:
+ """
+ Returns:
+ The owner of the standard, often the entity responsible for its release.
+ """
+ return self._owner
+
+ @owner.setter
+ def owner(self, owner: Optional[str]) -> None:
+ self._owner = owner
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'requirement')
+ @serializable.xml_sequence(5)
+ def requirements(self) -> 'SortedSet[Requirement]':
+ """
+ Returns:
+ A SortedSet of requirements comprising the standard.
+ """
+ return self._requirements
+
+ @requirements.setter
+ def requirements(self, requirements: Iterable[Requirement]) -> None:
+ self._requirements = SortedSet(requirements)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'level')
+ @serializable.xml_sequence(6)
+ def levels(self) -> 'SortedSet[Level]':
+ """
+ Returns:
+ A SortedSet of levels associated with the standard. Some standards have different levels of compliance.
+ """
+ return self._levels
+
+ @levels.setter
+ def levels(self, levels: Iterable[Level]) -> None:
+ self._levels = SortedSet(levels)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'reference')
+ @serializable.xml_sequence(7)
+ def external_references(self) -> 'SortedSet[ExternalReference]':
+ """
+ Returns:
+ A SortedSet of external references associated with the standard.
+ """
+ return self._external_references
+
+ @external_references.setter
+ def external_references(self, external_references: Iterable[ExternalReference]) -> None:
+ self._external_references = SortedSet(external_references)
+
+ # @property
+ # @serializable.xml_sequence(8)
+ # # MUST NOT RENDER FOR XML -- this is JSON only
+ # def signature(self) -> ...:
+ # ...
+ #
+ # @signature.setter
+ # def levels(self, signature: ...) -> None:
+ # ...
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ # all properties are optional - so need to apply all, in hope that one is unique
+ return _ComparableTuple((
+ self.name, self.version,
+ self.bom_ref.value,
+ self.description, self.owner,
+ _ComparableTuple(self.requirements), _ComparableTuple(self.levels),
+ _ComparableTuple(self.external_references)
+ ))
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Standard):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Standard):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class(name='definitions')
+class Definitions:
+ """
+ The repository for definitions
+ """
+
+ def __init__(
+ self, *,
+ standards: Optional[Iterable[Standard]] = None
+ ) -> None:
+ self.standards = standards or () # type:ignore[assignment]
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'standard')
+ @serializable.xml_sequence(1)
+ def standards(self) -> 'SortedSet[Standard]':
+ """
+ Returns:
+ A SortedSet of Standards
+ """
+ return self._standards
+
+ @standards.setter
+ def standards(self, standards: Iterable[Standard]) -> None:
+ self._standards = SortedSet(standards)
+
+ def __bool__(self) -> bool:
+ return len(self._standards) > 0
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ # all properties are optional - so need to apply all, in hope that one is unique
+ return _ComparableTuple(self._standards)
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Definitions):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Definitions):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/dependency.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/dependency.py
new file mode 100644
index 00000000..8241fdfc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/dependency.py
@@ -0,0 +1,116 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from abc import ABC, abstractmethod
+from typing import Any, Iterable, List, Optional, Set
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..exception.serialization import SerializationOfUnexpectedValueException
+from .bom_ref import BomRef
+
+
+class _DependencyRepositorySerializationHelper(serializable.helpers.BaseHelper):
+ """ THIS CLASS IS NON-PUBLIC API """
+
+ @classmethod
+ def serialize(cls, o: Any) -> List[str]:
+ if isinstance(o, (SortedSet, set)):
+ return [str(i.ref) for i in o]
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-DependencyRepository: {o!r}')
+
+ @classmethod
+ def deserialize(cls, o: Any) -> Set['Dependency']:
+ dependencies = set()
+ if isinstance(o, list):
+ for v in o:
+ dependencies.add(Dependency(ref=BomRef(value=v)))
+ return dependencies
+
+
+@serializable.serializable_class
+class Dependency:
+ """
+ Models a Dependency within a BOM.
+
+ .. note::
+ See https://cyclonedx.org/docs/1.6/xml/#type_dependencyType
+ """
+
+ def __init__(self, ref: BomRef, dependencies: Optional[Iterable['Dependency']] = None) -> None:
+ self.ref = ref
+ self.dependencies = dependencies or [] # type:ignore[assignment]
+
+ @property
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_attribute()
+ def ref(self) -> BomRef:
+ return self._ref
+
+ @ref.setter
+ def ref(self, ref: BomRef) -> None:
+ self._ref = ref
+
+ @property
+ @serializable.json_name('dependsOn')
+ @serializable.type_mapping(_DependencyRepositorySerializationHelper)
+ @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, 'dependency')
+ def dependencies(self) -> 'SortedSet[Dependency]':
+ return self._dependencies
+
+ @dependencies.setter
+ def dependencies(self, dependencies: Iterable['Dependency']) -> None:
+ self._dependencies = SortedSet(dependencies)
+
+ def dependencies_as_bom_refs(self) -> Set[BomRef]:
+ return set(map(lambda d: d.ref, self.dependencies))
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.ref, _ComparableTuple(self.dependencies)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Dependency):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Dependency):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+class Dependable(ABC):
+ """
+ Dependable objects can be part of the Dependency Graph
+ """
+
+ @property
+ @abstractmethod
+ def bom_ref(self) -> BomRef:
+ ... # pragma: no cover
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/impact_analysis.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/impact_analysis.py
new file mode 100644
index 00000000..a289daf2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/impact_analysis.py
@@ -0,0 +1,106 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+This set of classes represents the data about Impact Analysis.
+
+Impact Analysis is new for CycloneDX schema version 1.
+
+.. note::
+ See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6
+"""
+
+
+from enum import Enum
+
+import py_serializable as serializable
+
+
+@serializable.serializable_enum
+class ImpactAnalysisAffectedStatus(str, Enum):
+ """
+ Enum object that defines the permissible impact analysis affected states.
+
+ The vulnerability status of a given version or range of versions of a product.
+
+ The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability.
+
+ The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can
+ be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor
+ has not disclosed the status.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisAffectedStatusType
+ """
+
+ AFFECTED = 'affected'
+ UNAFFECTED = 'unaffected'
+ UNKNOWN = 'unknown'
+
+
+@serializable.serializable_enum
+class ImpactAnalysisJustification(str, Enum):
+ """
+ Enum object that defines the rationale of why the impact analysis state was asserted.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisJustificationType
+ """
+
+ CODE_NOT_PRESENT = 'code_not_present'
+ CODE_NOT_REACHABLE = 'code_not_reachable'
+ PROTECTED_AT_PERIMITER = 'protected_at_perimeter'
+ PROTECTED_AT_RUNTIME = 'protected_at_runtime'
+ PROTECTED_BY_COMPILER = 'protected_by_compiler'
+ PROTECTED_BY_MITIGATING_CONTROL = 'protected_by_mitigating_control'
+ REQUIRES_CONFIGURATION = 'requires_configuration'
+ REQUIRES_DEPENDENCY = 'requires_dependency'
+ REQUIRES_ENVIRONMENT = 'requires_environment'
+
+
+@serializable.serializable_enum
+class ImpactAnalysisResponse(str, Enum):
+ """
+ Enum object that defines the valid rationales as to why the impact analysis state was asserted.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisResponsesType
+ """
+
+ CAN_NOT_FIX = 'can_not_fix'
+ ROLLBACK = 'rollback'
+ UPDATE = 'update'
+ WILL_NOT_FIX = 'will_not_fix'
+ WORKAROUND_AVAILABLE = 'workaround_available'
+
+
+@serializable.serializable_enum
+class ImpactAnalysisState(str, Enum):
+ """
+ Enum object that defines the permissible impact analysis states.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisStateType
+ """
+
+ RESOLVED = 'resolved'
+ RESOLVED_WITH_PEDIGREE = 'resolved_with_pedigree'
+ EXPLOITABLE = 'exploitable'
+ IN_TRIAGE = 'in_triage'
+ FALSE_POSITIVE = 'false_positive'
+ NOT_AFFECTED = 'not_affected'
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/issue.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/issue.py
new file mode 100644
index 00000000..4b1f1aa2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/issue.py
@@ -0,0 +1,250 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+from enum import Enum
+from typing import Any, Iterable, Optional
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from . import XsUri
+
+
+@serializable.serializable_enum
+class IssueClassification(str, Enum):
+ """
+ This is our internal representation of the enum `issueClassification`.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_issueClassification
+ """
+ DEFECT = 'defect'
+ ENHANCEMENT = 'enhancement'
+ SECURITY = 'security'
+
+
+@serializable.serializable_class
+class IssueTypeSource:
+ """
+ This is our internal representation ofa source within the IssueType complex type that can be used in multiple
+ places within a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_issueType
+ """
+
+ def __init__(
+ self, *,
+ name: Optional[str] = None,
+ url: Optional[XsUri] = None,
+ ) -> None:
+ self.name = name
+ self.url = url
+
+ @property
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ The name of the source. For example "National Vulnerability Database", "NVD", and "Apache".
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ def url(self) -> Optional[XsUri]:
+ """
+ Optional url of the issue documentation as provided by the source.
+
+ Returns:
+ `XsUri` if set else `None`
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: Optional[XsUri]) -> None:
+ self._url = url
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.name, self.url
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, IssueTypeSource):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, IssueTypeSource):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class IssueType:
+ """
+ This is our internal representation of an IssueType complex type that can be used in multiple places within
+ a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_issueType
+ """
+
+ def __init__(
+ self, *,
+ type: IssueClassification,
+ id: Optional[str] = None,
+ name: Optional[str] = None,
+ description: Optional[str] = None,
+ source: Optional[IssueTypeSource] = None,
+ references: Optional[Iterable[XsUri]] = None,
+ ) -> None:
+ self.type = type
+ self.id = id
+ self.name = name
+ self.description = description
+ self.source = source
+ self.references = references or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_attribute()
+ def type(self) -> IssueClassification:
+ """
+ Specifies the type of issue.
+
+ Returns:
+ `IssueClassification`
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: IssueClassification) -> None:
+ self._type = type
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def id(self) -> Optional[str]:
+ """
+ The identifier of the issue assigned by the source of the issue.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: Optional[str]) -> None:
+ self._id = id
+
+ @property
+ @serializable.xml_sequence(2)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ The name of the issue.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_sequence(3)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def description(self) -> Optional[str]:
+ """
+ A description of the issue.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ @property
+ @serializable.xml_sequence(4)
+ def source(self) -> Optional[IssueTypeSource]:
+ """
+ The source of this issue.
+
+ Returns:
+ `IssueTypeSource` if set else `None`
+ """
+ return self._source
+
+ @source.setter
+ def source(self, source: Optional[IssueTypeSource]) -> None:
+ self._source = source
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'url')
+ @serializable.xml_sequence(5)
+ def references(self) -> 'SortedSet[XsUri]':
+ """
+ Any reference URLs related to this issue.
+
+ Returns:
+ Set of `XsUri`
+ """
+ return self._references
+
+ @references.setter
+ def references(self, references: Iterable[XsUri]) -> None:
+ self._references = SortedSet(references)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.type, self.id, self.name, self.description, self.source,
+ _ComparableTuple(self.references)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, IssueType):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, IssueType):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/license.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/license.py
new file mode 100644
index 00000000..b4348993
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/license.py
@@ -0,0 +1,463 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+License related things
+"""
+
+from enum import Enum
+from json import loads as json_loads
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union
+from warnings import warn
+from xml.etree.ElementTree import Element # nosec B405
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..exception.model import MutuallyExclusivePropertiesException
+from ..exception.serialization import CycloneDxDeserializationException
+from ..schema.schema import SchemaVersion1Dot6
+from . import AttachedText, XsUri
+
+
+@serializable.serializable_enum
+class LicenseAcknowledgement(str, Enum):
+ """
+ This is our internal representation of the `type_licenseAcknowledgementEnumerationType` ENUM type
+ within the CycloneDX standard.
+
+ .. note::
+ Introduced in CycloneDX v1.6
+
+ .. note::
+ See the CycloneDX Schema for hashType:
+ https://cyclonedx.org/docs/1.6/#type_licenseAcknowledgementEnumerationType
+ """
+
+ CONCLUDED = 'concluded'
+ DECLARED = 'declared'
+
+
+# In an error, the name of the enum was `LicenseExpressionAcknowledgement`.
+# Even though this was changed, there might be some downstream usage of this symbol, so we keep it around ...
+LicenseExpressionAcknowledgement = LicenseAcknowledgement
+"""Deprecated alias for :class:`LicenseAcknowledgement`"""
+
+
+@serializable.serializable_class(name='license')
+class DisjunctiveLicense:
+ """
+ This is our internal representation of `licenseType` complex type that can be used in multiple places within
+ a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/json/#components_items_licenses
+ """
+
+ def __init__(
+ self, *,
+ id: Optional[str] = None, name: Optional[str] = None,
+ text: Optional[AttachedText] = None, url: Optional[XsUri] = None,
+ acknowledgement: Optional[LicenseAcknowledgement] = None,
+ ) -> None:
+ if not id and not name:
+ raise MutuallyExclusivePropertiesException('Either `id` or `name` MUST be supplied')
+ if id and name:
+ warn(
+ 'Both `id` and `name` have been supplied - `name` will be ignored!',
+ category=RuntimeWarning, stacklevel=1
+ )
+ self._id = id
+ self._name = name if not id else None
+ self._text = text
+ self._url = url
+ self._acknowledgement = acknowledgement
+
+ @property
+ @serializable.xml_sequence(1)
+ def id(self) -> Optional[str]:
+ """
+ A SPDX license ID.
+
+ .. note::
+ See the list of expected values:
+ https://cyclonedx.org/docs/1.6/json/#components_items_licenses_items_license_id
+
+ Returns:
+ `str` or `None`
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: Optional[str]) -> None:
+ self._id = id
+ if id is not None:
+ self._name = None
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ If SPDX does not define the license used, this field may be used to provide the license name.
+
+ Returns:
+ `str` or `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+ if name is not None:
+ self._id = None
+
+ @property
+ @serializable.xml_sequence(2)
+ def text(self) -> Optional[AttachedText]:
+ """
+ Specifies the optional full text of the attachment
+
+ Returns:
+ `AttachedText` else `None`
+ """
+ return self._text
+
+ @text.setter
+ def text(self, text: Optional[AttachedText]) -> None:
+ self._text = text
+
+ @property
+ @serializable.xml_sequence(3)
+ def url(self) -> Optional[XsUri]:
+ """
+ The URL to the attachment file. If the attachment is a license or BOM, an externalReference should also be
+ specified for completeness.
+
+ Returns:
+ `XsUri` or `None`
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: Optional[XsUri]) -> None:
+ self._url = url
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.view(SchemaVersion1Dot6)
+ # @serializable.xml_sequence(5)
+ # def licensing(self) -> ...:
+ # ... # TODO since CDX1.5
+ #
+ # @licensing.setter
+ # def licensing(self, ...) -> None:
+ # ... # TODO since CDX1.5
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.view(SchemaVersion1Dot6)
+ # @serializable.xml_sequence(6)
+ # def properties(self) -> ...:
+ # ... # TODO since CDX1.5
+ #
+ # @licensing.setter
+ # def properties(self, ...) -> None:
+ # ... # TODO since CDX1.5
+
+ # @property
+ # @serializable.json_name('bom-ref')
+ # @serializable.type_mapping(BomRefHelper)
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.view(SchemaVersion1Dot6)
+ # @serializable.xml_attribute()
+ # @serializable.xml_name('bom-ref')
+ # def bom_ref(self) -> BomRef:
+ # ... # TODO since CDX1.5
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_attribute()
+ def acknowledgement(self) -> Optional[LicenseAcknowledgement]:
+ """
+ Declared licenses and concluded licenses represent two different stages in the licensing process within
+ software development.
+
+ Declared licenses refer to the initial intention of the software authors regarding the
+ licensing terms under which their code is released. On the other hand, concluded licenses are the result of a
+ comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components
+ used, which may differ from the initially declared licenses. While declared licenses provide an upfront
+ indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual
+ licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined
+ in evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
+
+ Returns:
+ `LicenseAcknowledgement` or `None`
+ """
+ return self._acknowledgement
+
+ @acknowledgement.setter
+ def acknowledgement(self, acknowledgement: Optional[LicenseAcknowledgement]) -> None:
+ self._acknowledgement = acknowledgement
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self._acknowledgement,
+ self._id, self._name,
+ self._url,
+ self._text,
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, DisjunctiveLicense):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, DisjunctiveLicense):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ if isinstance(other, LicenseExpression):
+ return False # self after any LicenseExpression
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class(name='expression')
+class LicenseExpression:
+ """
+ This is our internal representation of `licenseType`'s expression type that can be used in multiple places within
+ a CycloneDX BOM document.
+
+ .. note::
+ See the CycloneDX Schema definition:
+ https://cyclonedx.org/docs/1.6/json/#components_items_licenses_items_expression
+ """
+
+ def __init__(
+ self, value: str, *,
+ acknowledgement: Optional[LicenseAcknowledgement] = None,
+ ) -> None:
+ self._value = value
+ self._acknowledgement = acknowledgement
+
+ @property
+ @serializable.xml_name('.')
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ @serializable.json_name('expression')
+ def value(self) -> str:
+ """
+ Value of this LicenseExpression.
+
+ Returns:
+ `str`
+ """
+ return self._value
+
+ @value.setter
+ def value(self, value: str) -> None:
+ self._value = value
+
+ # @property
+ # @serializable.json_name('bom-ref')
+ # @serializable.type_mapping(BomRefHelper)
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.view(SchemaVersion1Dot6)
+ # @serializable.xml_attribute()
+ # @serializable.xml_name('bom-ref')
+ # def bom_ref(self) -> BomRef:
+ # ... # TODO since CDX1.5
+
+ @property
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_attribute()
+ def acknowledgement(self) -> Optional[LicenseAcknowledgement]:
+ """
+ Declared licenses and concluded licenses represent two different stages in the licensing process within
+ software development.
+
+ Declared licenses refer to the initial intention of the software authors regarding the
+ licensing terms under which their code is released. On the other hand, concluded licenses are the result of a
+ comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components
+ used, which may differ from the initially declared licenses. While declared licenses provide an upfront
+ indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual
+ licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined
+ in evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.
+
+ Returns:
+ `LicenseAcknowledgement` or `None`
+ """
+ return self._acknowledgement
+
+ @acknowledgement.setter
+ def acknowledgement(self, acknowledgement: Optional[LicenseAcknowledgement]) -> None:
+ self._acknowledgement = acknowledgement
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self._acknowledgement,
+ self._value,
+ ))
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, LicenseExpression):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, LicenseExpression):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ if isinstance(other, DisjunctiveLicense):
+ return True # self before any DisjunctiveLicense
+ return NotImplemented
+
+ def __repr__(self) -> str:
+ return f''
+
+
+License = Union[LicenseExpression, DisjunctiveLicense]
+"""TypeAlias for a union of supported license models.
+
+- :class:`LicenseExpression`
+- :class:`DisjunctiveLicense`
+"""
+
+if TYPE_CHECKING: # pragma: no cover
+ # workaround for https://github.com/python/mypy/issues/5264
+ # this code path is taken when static code analysis or documentation tools runs through.
+ class LicenseRepository(SortedSet[License]):
+ """Collection of :class:`License`.
+
+ This is a `set`, not a `list`. Order MUST NOT matter here.
+ If you wanted a certain order, then you should also express whether the items are concat by `AND` or `OR`.
+ If you wanted to do so, you should use :class:`LicenseExpression`.
+
+ As a model, this MUST accept multiple :class:`LicenseExpression` along with
+ multiple :class:`DisjunctiveLicense`, as this was an accepted in CycloneDX JSON before v1.5.
+ So for modeling purposes, this is supported.
+ Denormalizers/deserializers will be thankful.
+ The normalization/serialization process SHOULD take care of these facts and do what is needed.
+ """
+
+else:
+ class LicenseRepository(SortedSet):
+ """Collection of :class:`License`.
+
+ This is a `set`, not a `list`. Order MUST NOT matter here.
+ If you wanted a certain order, then you should also express whether the items are concat by `AND` or `OR`.
+ If you wanted to do so, you should use :class:`LicenseExpression`.
+
+ As a model, this MUST accept multiple :class:`LicenseExpression` along with
+ multiple :class:`DisjunctiveLicense`, as this was an accepted in CycloneDX JSON before v1.5.
+ So for modeling purposes, this is supported.
+ Denormalizers/deserializers will be thankful.
+ The normalization/serialization process SHOULD take care of these facts and do what is needed.
+ """
+
+
+class _LicenseRepositorySerializationHelper(serializable.helpers.BaseHelper):
+ """ THIS CLASS IS NON-PUBLIC API """
+
+ @classmethod
+ def json_normalize(cls, o: LicenseRepository, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> Any:
+ if len(o) == 0:
+ return None
+ expression = next((li for li in o if isinstance(li, LicenseExpression)), None)
+ if expression:
+ # mixed license expression and license? this is an invalid constellation according to schema!
+ # see https://github.com/CycloneDX/specification/pull/205
+ # but models need to allow it for backwards compatibility with JSON CDX < 1.5
+ return [json_loads(expression.as_json(view_=view))] # type:ignore[attr-defined]
+ return [
+ {'license': json_loads(
+ li.as_json( # type:ignore[attr-defined]
+ view_=view)
+ )}
+ for li in o
+ if isinstance(li, DisjunctiveLicense)
+ ]
+
+ @classmethod
+ def json_denormalize(cls, o: List[Dict[str, Any]],
+ **__: Any) -> LicenseRepository:
+ repo = LicenseRepository()
+ for li in o:
+ if 'license' in li:
+ repo.add(DisjunctiveLicense.from_json( # type:ignore[attr-defined]
+ li['license']))
+ elif 'expression' in li:
+ repo.add(LicenseExpression.from_json( # type:ignore[attr-defined]
+ li
+ ))
+ else:
+ raise CycloneDxDeserializationException(f'unexpected: {li!r}')
+ return repo
+
+ @classmethod
+ def xml_normalize(cls, o: LicenseRepository, *,
+ element_name: str,
+ view: Optional[Type[serializable.ViewType]],
+ xmlns: Optional[str],
+ **__: Any) -> Optional[Element]:
+ if len(o) == 0:
+ return None
+ elem = Element(element_name)
+ expression = next((li for li in o if isinstance(li, LicenseExpression)), None)
+ if expression:
+ # mixed license expression and license? this is an invalid constellation according to schema!
+ # see https://github.com/CycloneDX/specification/pull/205
+ # but models need to allow it for backwards compatibility with JSON CDX < 1.5
+ elem.append(expression.as_xml( # type:ignore[attr-defined]
+ view_=view, as_string=False, element_name='expression', xmlns=xmlns))
+ else:
+ elem.extend(
+ li.as_xml( # type:ignore[attr-defined]
+ view_=view, as_string=False, element_name='license', xmlns=xmlns)
+ for li in o
+ if isinstance(li, DisjunctiveLicense)
+ )
+ return elem
+
+ @classmethod
+ def xml_denormalize(cls, o: Element,
+ default_ns: Optional[str],
+ **__: Any) -> LicenseRepository:
+ repo = LicenseRepository()
+ for li in o:
+ tag = li.tag if default_ns is None else li.tag.replace(f'{{{default_ns}}}', '')
+ if tag == 'license':
+ repo.add(DisjunctiveLicense.from_xml( # type:ignore[attr-defined]
+ li, default_ns))
+ elif tag == 'expression':
+ repo.add(LicenseExpression.from_xml( # type:ignore[attr-defined]
+ li, default_ns))
+ else:
+ raise CycloneDxDeserializationException(f'unexpected: {li!r}')
+ return repo
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/lifecycle.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/lifecycle.py
new file mode 100644
index 00000000..db688bb8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/lifecycle.py
@@ -0,0 +1,248 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+"""
+ This set of classes represents the lifecycles types in the CycloneDX standard.
+
+.. note::
+ Introduced in CycloneDX v1.5
+
+.. note::
+ See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.6/#metadata_lifecycles
+"""
+
+from enum import Enum
+from json import loads as json_loads
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union
+from xml.etree.ElementTree import Element # nosec B405
+
+import py_serializable as serializable
+from py_serializable.helpers import BaseHelper
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..exception.serialization import CycloneDxDeserializationException
+
+if TYPE_CHECKING: # pragma: no cover
+ from py_serializable import ViewType
+
+
+@serializable.serializable_enum
+class LifecyclePhase(str, Enum):
+ """
+ Enum object that defines the permissible 'phase' for a Lifecycle according to the CycloneDX schema.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_classification
+ """
+ DESIGN = 'design'
+ PRE_BUILD = 'pre-build'
+ BUILD = 'build'
+ POST_BUILD = 'post-build'
+ OPERATIONS = 'operations'
+ DISCOVERY = 'discovery'
+ DECOMMISSION = 'decommission'
+
+
+@serializable.serializable_class
+class PredefinedLifecycle:
+ """
+ Object that defines pre-defined phases in the product lifecycle.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#metadata_lifecycles
+ """
+
+ def __init__(self, phase: LifecyclePhase) -> None:
+ self._phase = phase
+
+ @property
+ def phase(self) -> LifecyclePhase:
+ return self._phase
+
+ @phase.setter
+ def phase(self, phase: LifecyclePhase) -> None:
+ self._phase = phase
+
+ def __hash__(self) -> int:
+ return hash(self._phase)
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, PredefinedLifecycle):
+ return self._phase == other._phase
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, PredefinedLifecycle):
+ return self._phase < other._phase
+ if isinstance(other, NamedLifecycle):
+ return True # put PredefinedLifecycle before any NamedLifecycle
+ return NotImplemented
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class NamedLifecycle:
+ """
+ Object that defines custom state in the product lifecycle.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#metadata_lifecycles
+ """
+
+ def __init__(self, name: str, *, description: Optional[str] = None) -> None:
+ self._name = name
+ self._description = description
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> str:
+ """
+ Name of the lifecycle phase.
+
+ Returns:
+ `str`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_sequence(2)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def description(self) -> Optional[str]:
+ """
+ Description of the lifecycle phase.
+
+ Returns:
+ `str`
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self._name, self._description
+ ))
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, NamedLifecycle):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, NamedLifecycle):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ if isinstance(other, PredefinedLifecycle):
+ return False # put NamedLifecycle after any PredefinedLifecycle
+ return NotImplemented
+
+ def __repr__(self) -> str:
+ return f''
+
+
+Lifecycle = Union[PredefinedLifecycle, NamedLifecycle]
+"""TypeAlias for a union of supported lifecycle models.
+
+- :class:`PredefinedLifecycle`
+- :class:`NamedLifecycle`
+"""
+
+if TYPE_CHECKING: # pragma: no cover
+ # workaround for https://github.com/python/mypy/issues/5264
+ # this code path is taken when static code analysis or documentation tools runs through.
+ class LifecycleRepository(SortedSet[Lifecycle]):
+ """Collection of :class:`Lifecycle`.
+
+ This is a `set`, not a `list`. Order MUST NOT matter here.
+ """
+else:
+ class LifecycleRepository(SortedSet):
+ """Collection of :class:`Lifecycle`.
+
+ This is a `set`, not a `list`. Order MUST NOT matter here.
+ """
+
+
+class _LifecycleRepositoryHelper(BaseHelper):
+ @classmethod
+ def json_normalize(cls, o: LifecycleRepository, *,
+ view: Optional[Type['ViewType']],
+ **__: Any) -> Any:
+ if len(o) == 0:
+ return None
+ return [json_loads(li.as_json( # type:ignore[union-attr]
+ view_=view)) for li in o]
+
+ @classmethod
+ def json_denormalize(cls, o: List[Dict[str, Any]],
+ **__: Any) -> LifecycleRepository:
+ repo = LifecycleRepository()
+ for li in o:
+ if 'phase' in li:
+ repo.add(PredefinedLifecycle.from_json( # type:ignore[attr-defined]
+ li))
+ elif 'name' in li:
+ repo.add(NamedLifecycle.from_json( # type:ignore[attr-defined]
+ li))
+ else:
+ raise CycloneDxDeserializationException(f'unexpected: {li!r}')
+ return repo
+
+ @classmethod
+ def xml_normalize(cls, o: LifecycleRepository, *,
+ element_name: str,
+ view: Optional[Type['ViewType']],
+ xmlns: Optional[str],
+ **__: Any) -> Optional[Element]:
+ if len(o) == 0:
+ return None
+ elem = Element(element_name)
+ for li in o:
+ elem.append(li.as_xml( # type:ignore[union-attr]
+ view_=view, as_string=False, element_name='lifecycle', xmlns=xmlns))
+ return elem
+
+ @classmethod
+ def xml_denormalize(cls, o: Element,
+ default_ns: Optional[str],
+ **__: Any) -> LifecycleRepository:
+ repo = LifecycleRepository()
+ ns_map = {'bom': default_ns or ''}
+ # Do not iterate over `o` and do not check for expected `.tag` of items.
+ # This check could have been done by schema validators before even deserializing.
+ for li in o.iterfind('bom:lifecycle', ns_map):
+ if li.find('bom:phase', ns_map) is not None:
+ repo.add(PredefinedLifecycle.from_xml( # type:ignore[attr-defined]
+ li, default_ns))
+ elif li.find('bom:name', ns_map) is not None:
+ repo.add(NamedLifecycle.from_xml( # type:ignore[attr-defined]
+ li, default_ns))
+ else:
+ raise CycloneDxDeserializationException(f'unexpected content: {li!r}')
+ return repo
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/release_note.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/release_note.py
new file mode 100644
index 00000000..4509bb2b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/release_note.py
@@ -0,0 +1,256 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+from datetime import datetime
+from typing import Iterable, Optional
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..model import Note, Property, XsUri
+from ..model.issue import IssueType
+
+
+@serializable.serializable_class
+class ReleaseNotes:
+ """
+ This is our internal representation of a `releaseNotesType` for a Component in a BOM.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_releaseNotesType
+ """
+
+ def __init__(
+ self, *,
+ type: str, title: Optional[str] = None,
+ featured_image: Optional[XsUri] = None,
+ social_image: Optional[XsUri] = None,
+ description: Optional[str] = None,
+ timestamp: Optional[datetime] = None,
+ aliases: Optional[Iterable[str]] = None,
+ tags: Optional[Iterable[str]] = None,
+ resolves: Optional[Iterable[IssueType]] = None,
+ notes: Optional[Iterable[Note]] = None,
+ properties: Optional[Iterable[Property]] = None,
+ ) -> None:
+ self.type = type
+ self.title = title
+ self.featured_image = featured_image
+ self.social_image = social_image
+ self.description = description
+ self.timestamp = timestamp
+ self.aliases = aliases or [] # type:ignore[assignment]
+ self.tags = tags or [] # type:ignore[assignment]
+ self.resolves = resolves or [] # type:ignore[assignment]
+ self.notes = notes or [] # type:ignore[assignment]
+ self.properties = properties or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def type(self) -> str:
+ """
+ The software versioning type.
+
+ It is **RECOMMENDED** that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'.
+
+ Representing all possible software release types is not practical, so standardizing on the recommended values,
+ whenever possible, is strongly encouraged.
+
+ * **major** = A major release may contain significant changes or may introduce breaking changes.
+ * **minor** = A minor release, also known as an update, may contain a smaller number of changes than major
+ releases.
+ * **patch** = Patch releases are typically unplanned and may resolve defects or important security issues.
+ * **pre-release** = A pre-release may include alpha, beta, or release candidates and typically have limited
+ support. They provide the ability to preview a release prior to its general availability.
+ * **internal** = Internal releases are not for public consumption and are intended to be used exclusively by the
+ project or manufacturer that produced it.
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type: str) -> None:
+ self._type = type
+
+ @property
+ @serializable.xml_sequence(2)
+ def title(self) -> Optional[str]:
+ """
+ The title of the release.
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title: Optional[str]) -> None:
+ self._title = title
+
+ @property
+ @serializable.xml_sequence(3)
+ def featured_image(self) -> Optional[XsUri]:
+ """
+ The URL to an image that may be prominently displayed with the release note.
+ """
+ return self._featured_image
+
+ @featured_image.setter
+ def featured_image(self, featured_image: Optional[XsUri]) -> None:
+ self._featured_image = featured_image
+
+ @property
+ @serializable.xml_sequence(4)
+ def social_image(self) -> Optional[XsUri]:
+ """
+ The URL to an image that may be used in messaging on social media platforms.
+ """
+ return self._social_image
+
+ @social_image.setter
+ def social_image(self, social_image: Optional[XsUri]) -> None:
+ self._social_image = social_image
+
+ @property
+ @serializable.xml_sequence(5)
+ def description(self) -> Optional[str]:
+ """
+ A short description of the release.
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(6)
+ def timestamp(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the release note was created.
+ """
+ return self._timestamp
+
+ @timestamp.setter
+ def timestamp(self, timestamp: Optional[datetime]) -> None:
+ self._timestamp = timestamp
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'alias')
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ @serializable.xml_sequence(7)
+ def aliases(self) -> 'SortedSet[str]':
+ """
+ One or more alternate names the release may be referred to. This may include unofficial terms used by
+ development and marketing teams (e.g. code names).
+
+ Returns:
+ Set of `str`
+ """
+ return self._aliases
+
+ @aliases.setter
+ def aliases(self, aliases: Iterable[str]) -> None:
+ self._aliases = SortedSet(aliases)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'tag')
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ @serializable.xml_sequence(8)
+ def tags(self) -> 'SortedSet[str]':
+ """
+ One or more tags that may aid in search or retrieval of the release note.
+
+ Returns:
+ Set of `str`
+ """
+ return self._tags
+
+ @tags.setter
+ def tags(self, tags: Iterable[str]) -> None:
+ self._tags = SortedSet(tags)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'issue')
+ @serializable.xml_sequence(9)
+ def resolves(self) -> 'SortedSet[IssueType]':
+ """
+ A collection of issues that have been resolved.
+
+ Returns:
+ Set of `IssueType`
+ """
+ return self._resolves
+
+ @resolves.setter
+ def resolves(self, resolves: Iterable[IssueType]) -> None:
+ self._resolves = SortedSet(resolves)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'note')
+ @serializable.xml_sequence(10)
+ def notes(self) -> 'SortedSet[Note]':
+ """
+ Zero or more release notes containing the locale and content. Multiple note elements may be specified to support
+ release notes in a wide variety of languages.
+
+ Returns:
+ Set of `Note`
+ """
+ return self._notes
+
+ @notes.setter
+ def notes(self, notes: Iterable[Note]) -> None:
+ self._notes = SortedSet(notes)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
+ @serializable.xml_sequence(11)
+ def properties(self) -> 'SortedSet[Property]':
+ """
+ Provides the ability to document properties in a name-value store. This provides flexibility to include data not
+ officially supported in the standard without having to use additional namespaces or create extensions. Unlike
+ key-value stores, properties support duplicate names, each potentially having different values.
+
+ Returns:
+ Set of `Property`
+ """
+ return self._properties
+
+ @properties.setter
+ def properties(self, properties: Iterable[Property]) -> None:
+ self._properties = SortedSet(properties)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.type, self.title, self.featured_image, self.social_image, self.description, self.timestamp,
+ _ComparableTuple(self.aliases),
+ _ComparableTuple(self.tags),
+ _ComparableTuple(self.resolves),
+ _ComparableTuple(self.notes),
+ _ComparableTuple(self.properties)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, ReleaseNotes):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/service.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/service.py
new file mode 100644
index 00000000..91541f6b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/service.py
@@ -0,0 +1,380 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+This set of classes represents the data that is possible about known Services.
+
+.. note::
+ See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6/xml/#type_servicesType
+"""
+
+
+from typing import Any, Iterable, Optional, Union
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..schema.schema import SchemaVersion1Dot3, SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6
+from . import DataClassification, ExternalReference, Property, XsUri
+from .bom_ref import BomRef
+from .contact import OrganizationalEntity
+from .dependency import Dependable
+from .license import License, LicenseRepository, _LicenseRepositorySerializationHelper
+from .release_note import ReleaseNotes
+
+
+@serializable.serializable_class
+class Service(Dependable):
+ """
+ Class that models the `service` complex type in the CycloneDX schema.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_service
+ """
+
+ def __init__(
+ self, *,
+ name: str,
+ bom_ref: Optional[Union[str, BomRef]] = None,
+ provider: Optional[OrganizationalEntity] = None,
+ group: Optional[str] = None,
+ version: Optional[str] = None,
+ description: Optional[str] = None,
+ endpoints: Optional[Iterable[XsUri]] = None,
+ authenticated: Optional[bool] = None,
+ x_trust_boundary: Optional[bool] = None,
+ data: Optional[Iterable[DataClassification]] = None,
+ licenses: Optional[Iterable[License]] = None,
+ external_references: Optional[Iterable[ExternalReference]] = None,
+ properties: Optional[Iterable[Property]] = None,
+ services: Optional[Iterable['Service']] = None,
+ release_notes: Optional[ReleaseNotes] = None,
+ ) -> None:
+ self._bom_ref = _bom_ref_from_str(bom_ref)
+ self.provider = provider
+ self.group = group
+ self.name = name
+ self.version = version
+ self.description = description
+ self.endpoints = endpoints or [] # type:ignore[assignment]
+ self.authenticated = authenticated
+ self.x_trust_boundary = x_trust_boundary
+ self.data = data or [] # type:ignore[assignment]
+ self.licenses = licenses or [] # type:ignore[assignment]
+ self.external_references = external_references or [] # type:ignore[assignment]
+ self.services = services or [] # type:ignore[assignment]
+ self.release_notes = release_notes
+ self.properties = properties or [] # type:ignore[assignment]
+
+ @property
+ @serializable.json_name('bom-ref')
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_attribute()
+ @serializable.xml_name('bom-ref')
+ def bom_ref(self) -> BomRef:
+ """
+ An optional identifier which can be used to reference the service elsewhere in the BOM. Uniqueness is enforced
+ within all elements and children of the root-level bom element.
+
+ Returns:
+ `BomRef` unique identifier for this Service
+ """
+ return self._bom_ref
+
+ @property
+ @serializable.xml_sequence(1)
+ def provider(self) -> Optional[OrganizationalEntity]:
+ """
+ Get the organization that provides the service.
+
+ Returns:
+ `OrganizationalEntity` if set else `None`
+ """
+ return self._provider
+
+ @provider.setter
+ def provider(self, provider: Optional[OrganizationalEntity]) -> None:
+ self._provider = provider
+
+ @property
+ @serializable.xml_sequence(2)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def group(self) -> Optional[str]:
+ """
+ The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or
+ project that produced the service or domain name. Whitespace and special characters should be avoided.
+
+ Returns:
+ `str` if provided else `None`
+ """
+ return self._group
+
+ @group.setter
+ def group(self, group: Optional[str]) -> None:
+ self._group = group
+
+ @property
+ @serializable.xml_sequence(3)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> str:
+ """
+ The name of the service. This will often be a shortened, single name of the service.
+
+ Returns:
+ `str`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: str) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_sequence(4)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def version(self) -> Optional[str]:
+ """
+ The service version.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: Optional[str]) -> None:
+ self._version = version
+
+ @property
+ @serializable.xml_sequence(5)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def description(self) -> Optional[str]:
+ """
+ Specifies a description for the service.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'endpoint')
+ @serializable.xml_sequence(6)
+ def endpoints(self) -> 'SortedSet[XsUri]':
+ """
+ A list of endpoints URI's this service provides.
+
+ Returns:
+ Set of `XsUri`
+ """
+ return self._endpoints
+
+ @endpoints.setter
+ def endpoints(self, endpoints: Iterable[XsUri]) -> None:
+ self._endpoints = SortedSet(endpoints)
+
+ @property
+ @serializable.xml_sequence(7)
+ def authenticated(self) -> Optional[bool]:
+ """
+ A boolean value indicating if the service requires authentication. A value of true indicates the service
+ requires authentication prior to use.
+
+ A value of false indicates the service does not require authentication.
+
+ Returns:
+ `bool` if set else `None`
+ """
+ return self._authenticated
+
+ @authenticated.setter
+ def authenticated(self, authenticated: Optional[bool]) -> None:
+ self._authenticated = authenticated
+
+ @property
+ @serializable.json_name('x-trust-boundary')
+ @serializable.xml_name('x-trust-boundary')
+ @serializable.xml_sequence(8)
+ def x_trust_boundary(self) -> Optional[bool]:
+ """
+ A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates
+ that by using the service, a trust boundary is crossed.
+
+ A value of false indicates that by using the service, a trust boundary is not crossed.
+
+ Returns:
+ `bool` if set else `None`
+ """
+ return self._x_trust_boundary
+
+ @x_trust_boundary.setter
+ def x_trust_boundary(self, x_trust_boundary: Optional[bool]) -> None:
+ self._x_trust_boundary = x_trust_boundary
+
+ # @property
+ # ...
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(9)
+ # def trust_zone(self) -> ...:
+ # ... # since CDX1.5
+ #
+ # @trust_zone.setter
+ # def trust_zone(self, ...) -> None:
+ # ... # since CDX1.5
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'classification')
+ @serializable.xml_sequence(10)
+ def data(self) -> 'SortedSet[DataClassification]':
+ """
+ Specifies the data classification.
+
+ Returns:
+ Set of `DataClassification`
+ """
+ # TODO since CDX1.5 also supports `dataflow`, not only `DataClassification`
+ return self._data
+
+ @data.setter
+ def data(self, data: Iterable[DataClassification]) -> None:
+ self._data = SortedSet(data)
+
+ @property
+ @serializable.type_mapping(_LicenseRepositorySerializationHelper)
+ @serializable.xml_sequence(11)
+ def licenses(self) -> LicenseRepository:
+ """
+ A optional list of statements about how this Service is licensed.
+
+ Returns:
+ Set of `LicenseChoice`
+ """
+ # TODO since CDX1.5 also supports `dataflow`, not only `DataClassification`
+ return self._licenses
+
+ @licenses.setter
+ def licenses(self, licenses: Iterable[License]) -> None:
+ self._licenses = LicenseRepository(licenses)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'reference')
+ @serializable.xml_sequence(12)
+ def external_references(self) -> 'SortedSet[ExternalReference]':
+ """
+ Provides the ability to document external references related to the Service.
+
+ Returns:
+ Set of `ExternalReference`
+ """
+ return self._external_references
+
+ @external_references.setter
+ def external_references(self, external_references: Iterable[ExternalReference]) -> None:
+ self._external_references = SortedSet(external_references)
+
+ @property
+ @serializable.view(SchemaVersion1Dot3)
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
+ @serializable.xml_sequence(13)
+ def properties(self) -> 'SortedSet[Property]':
+ """
+ Provides the ability to document properties in a key/value store. This provides flexibility to include data not
+ officially supported in the standard without having to use additional namespaces or create extensions.
+
+ Return:
+ Set of `Property`
+ """
+ return self._properties
+
+ @properties.setter
+ def properties(self, properties: Iterable[Property]) -> None:
+ self._properties = SortedSet(properties)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'service')
+ @serializable.xml_sequence(14)
+ def services(self) -> "SortedSet['Service']":
+ """
+ A list of services included or deployed behind the parent service.
+
+ This is not a dependency tree.
+
+ It provides a way to specify a hierarchical representation of service assemblies.
+
+ Returns:
+ Set of `Service`
+ """
+ return self._services
+
+ @services.setter
+ def services(self, services: Iterable['Service']) -> None:
+ self._services = SortedSet(services)
+
+ @property
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(15)
+ def release_notes(self) -> Optional[ReleaseNotes]:
+ """
+ Specifies optional release notes.
+
+ Returns:
+ `ReleaseNotes` or `None`
+ """
+ return self._release_notes
+
+ @release_notes.setter
+ def release_notes(self, release_notes: Optional[ReleaseNotes]) -> None:
+ self._release_notes = release_notes
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.group, self.name, self.version,
+ self.bom_ref.value,
+ self.provider, self.description,
+ self.authenticated, _ComparableTuple(self.data), _ComparableTuple(self.endpoints),
+ _ComparableTuple(self.external_references), _ComparableTuple(self.licenses),
+ _ComparableTuple(self.properties), self.release_notes, _ComparableTuple(self.services),
+ self.x_trust_boundary
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Service):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Service):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/tool.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/tool.py
new file mode 100644
index 00000000..38b1e065
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/tool.py
@@ -0,0 +1,373 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from itertools import chain
+from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Type, Union
+from warnings import warn
+from xml.etree.ElementTree import Element # nosec B405
+
+import py_serializable as serializable
+from py_serializable.helpers import BaseHelper
+from sortedcontainers import SortedSet
+
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..schema import SchemaVersion
+from ..schema.schema import SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6
+from . import ExternalReference, HashType, _HashTypeRepositorySerializationHelper
+from .component import Component
+from .service import Service
+
+if TYPE_CHECKING: # pragma: no cover
+ from py_serializable import ObjectMetadataLibrary, ViewType
+
+
+@serializable.serializable_class
+class Tool:
+ """
+ This is our internal representation of the `toolType` complex type within the CycloneDX standard.
+
+ Tool(s) are the things used in the creation of the CycloneDX document.
+
+ Tool might be deprecated since CycloneDX 1.5, but it is not deprecated in this library.
+ In fact, this library will try to provide a compatibility layer if needed.
+
+ .. note::
+ See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.6/#type_toolType
+ """
+
+ def __init__(
+ self, *,
+ vendor: Optional[str] = None,
+ name: Optional[str] = None,
+ version: Optional[str] = None,
+ hashes: Optional[Iterable[HashType]] = None,
+ external_references: Optional[Iterable[ExternalReference]] = None,
+ ) -> None:
+ self.vendor = vendor
+ self.name = name
+ self.version = version
+ self.hashes = hashes or () # type:ignore[assignment]
+ self.external_references = external_references or () # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def vendor(self) -> Optional[str]:
+ """
+ The name of the vendor who created the tool.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._vendor
+
+ @vendor.setter
+ def vendor(self, vendor: Optional[str]) -> None:
+ self._vendor = vendor
+
+ @property
+ @serializable.xml_sequence(2)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ The name of the tool.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_sequence(3)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def version(self) -> Optional[str]:
+ """
+ The version of the tool.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: Optional[str]) -> None:
+ self._version = version
+
+ @property
+ @serializable.type_mapping(_HashTypeRepositorySerializationHelper)
+ @serializable.xml_sequence(4)
+ def hashes(self) -> 'SortedSet[HashType]':
+ """
+ The hashes of the tool (if applicable).
+
+ Returns:
+ Set of `HashType`
+ """
+ return self._hashes
+
+ @hashes.setter
+ def hashes(self, hashes: Iterable[HashType]) -> None:
+ self._hashes = SortedSet(hashes)
+
+ @property
+ @serializable.view(SchemaVersion1Dot4)
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'reference')
+ @serializable.xml_sequence(5)
+ def external_references(self) -> 'SortedSet[ExternalReference]':
+ """
+ External References provides a way to document systems, sites, and information that may be relevant but which
+ are not included with the BOM.
+
+ Returns:
+ Set of `ExternalReference`
+ """
+ return self._external_references
+
+ @external_references.setter
+ def external_references(self, external_references: Iterable[ExternalReference]) -> None:
+ self._external_references = SortedSet(external_references)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.vendor, self.name, self.version,
+ _ComparableTuple(self.hashes), _ComparableTuple(self.external_references)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Tool):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Tool):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+ @classmethod
+ def from_component(cls: Type['Tool'], component: 'Component') -> 'Tool':
+ return cls(
+ vendor=component.group,
+ name=component.name,
+ version=component.version,
+ hashes=component.hashes,
+ external_references=component.external_references,
+ )
+
+ @classmethod
+ def from_service(cls: Type['Tool'], service: 'Service') -> 'Tool':
+ return cls(
+ vendor=service.group,
+ name=service.name,
+ version=service.version,
+ external_references=service.external_references,
+ )
+
+
+class ToolRepository:
+ """
+ The repository of tool formats
+ """
+
+ def __init__(
+ self, *,
+ components: Optional[Iterable[Component]] = None,
+ services: Optional[Iterable[Service]] = None,
+ # Deprecated since v1.5
+ tools: Optional[Iterable[Tool]] = None
+ ) -> None:
+ if tools:
+ warn('`@.tools` is deprecated from CycloneDX v1.5 onwards. '
+ 'Please use `@.components` and `@.services` instead.',
+ DeprecationWarning)
+ self.components = components or () # type:ignore[assignment]
+ self.services = services or () # type:ignore[assignment]
+ self.tools = tools or () # type:ignore[assignment]
+
+ @property
+ def components(self) -> 'SortedSet[Component]':
+ """
+ Returns:
+ A SortedSet of Components
+ """
+ return self._components
+
+ @components.setter
+ def components(self, components: Iterable[Component]) -> None:
+ self._components = SortedSet(components)
+
+ @property
+ def services(self) -> 'SortedSet[Service]':
+ """
+ Returns:
+ A SortedSet of Services
+ """
+ return self._services
+
+ @services.setter
+ def services(self, services: Iterable[Service]) -> None:
+ self._services = SortedSet(services)
+
+ @property
+ def tools(self) -> 'SortedSet[Tool]':
+ return self._tools
+
+ @tools.setter
+ def tools(self, tools: Iterable[Tool]) -> None:
+ self._tools = SortedSet(tools)
+
+ def __len__(self) -> int:
+ return len(self._tools) \
+ + len(self._components) \
+ + len(self._services)
+
+ def __bool__(self) -> bool:
+ return len(self._tools) > 0 \
+ or len(self._components) > 0 \
+ or len(self._services) > 0
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ _ComparableTuple(self._tools),
+ _ComparableTuple(self._components),
+ _ComparableTuple(self._services)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, ToolRepository):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+
+class _ToolRepositoryHelper(BaseHelper):
+
+ @staticmethod
+ def __all_as_tools(o: ToolRepository) -> 'SortedSet[Tool]':
+ # use a set here, so the collection gets deduplicated.
+ # use SortedSet set here, so the order stays reproducible.
+ return SortedSet(chain(
+ o.tools,
+ map(Tool.from_component, o.components),
+ map(Tool.from_service, o.services),
+ ))
+
+ @staticmethod
+ def __supports_components_and_services(view: Any) -> bool:
+ try:
+ return view is not None and view().schema_version_enum >= SchemaVersion.V1_5
+ except Exception: # pragma: no cover
+ return False
+
+ @classmethod
+ def json_normalize(cls, o: ToolRepository, *,
+ view: Optional[Type['ViewType']],
+ **__: Any) -> Any:
+ if len(o.tools) > 0 or not cls.__supports_components_and_services(view):
+ ts = cls.__all_as_tools(o)
+ return tuple(ts) if ts else None
+ elem: Dict[str, Any] = {}
+ if o.components:
+ elem['components'] = tuple(o.components)
+ if o.services:
+ elem['services'] = tuple(o.services)
+ return elem or None
+
+ @classmethod
+ def json_denormalize(cls, o: Union[List[Dict[str, Any]], Dict[str, Any]],
+ **__: Any) -> ToolRepository:
+ tools = None
+ components = None
+ services = None
+ if isinstance(o, Dict):
+ components = map(lambda c: Component.from_json( # type:ignore[attr-defined]
+ c), o.get('components', ()))
+ services = map(lambda s: Service.from_json( # type:ignore[attr-defined]
+ s), o.get('services', ()))
+ elif isinstance(o, Iterable):
+ tools = map(lambda t: Tool.from_json( # type:ignore[attr-defined]
+ t), o)
+ return ToolRepository(components=components, services=services, tools=tools)
+
+ @classmethod
+ def xml_normalize(cls, o: ToolRepository, *,
+ element_name: str,
+ view: Optional[Type['ViewType']],
+ xmlns: Optional[str],
+ **__: Any) -> Optional[Element]:
+ elem = Element(element_name)
+ if len(o.tools) > 0 or not cls.__supports_components_and_services(view):
+ elem.extend(
+ ti.as_xml( # type:ignore[attr-defined]
+ view_=view, as_string=False, element_name='tool', xmlns=xmlns)
+ for ti in cls.__all_as_tools(o)
+ )
+ else:
+ if o.components:
+ elem_c = Element(f'{{{xmlns}}}components' if xmlns else 'components')
+ elem_c.extend(
+ ci.as_xml( # type:ignore[attr-defined]
+ view_=view, as_string=False, element_name='component', xmlns=xmlns)
+ for ci in o.components)
+ elem.append(elem_c)
+ if o.services:
+ elem_s = Element(f'{{{xmlns}}}services' if xmlns else 'services')
+ elem_s.extend(
+ si.as_xml( # type:ignore[attr-defined]
+ view_=view, as_string=False, element_name='service', xmlns=xmlns)
+ for si in o.services)
+ elem.append(elem_s)
+ return elem \
+ if len(elem) > 0 \
+ else None
+
+ @classmethod
+ def xml_denormalize(cls, o: Element, *,
+ default_ns: Optional[str],
+ prop_info: 'ObjectMetadataLibrary.SerializableProperty',
+ ctx: Type[Any],
+ **kwargs: Any) -> ToolRepository:
+ ns_map = {'bom': default_ns or ''}
+ # Do not iterate over `o` and do not check for expected `.tag` of items.
+ # This check could have been done by schema validators before even deserializing.
+ tools = None
+ components = None
+ services = None
+ ts = o.findall('bom:tool', ns_map)
+ if len(ts) > 0:
+ tools = map(lambda t: Tool.from_xml( # type:ignore[attr-defined]
+ t, default_ns), ts)
+ else:
+ components = map(lambda c: Component.from_xml( # type:ignore[attr-defined]
+ c, default_ns), o.iterfind('./bom:components/bom:component', ns_map))
+ services = map(lambda s: Service.from_xml( # type:ignore[attr-defined]
+ s, default_ns), o.iterfind('./bom:services/bom:service', ns_map))
+ return ToolRepository(components=components, services=services, tools=tools)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/vulnerability.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/vulnerability.py
new file mode 100644
index 00000000..f2eb1a7f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/model/vulnerability.py
@@ -0,0 +1,1367 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+This set of classes represents the data that is possible about known Vulnerabilities.
+
+Prior to CycloneDX schema version 1.4, vulnerabilities were possible in XML versions ONLY of the standard through
+a schema extension: https://cyclonedx.org/ext/vulnerability.
+
+Since CycloneDX schema version 1.4, this has become part of the core schema.
+
+.. note::
+ See the CycloneDX Schema extension definition https://cyclonedx.org/docs/1.6/#type_vulnerabilitiesType
+"""
+
+
+import re
+from datetime import datetime
+from decimal import Decimal
+from enum import Enum
+from typing import Any, Dict, FrozenSet, Iterable, Optional, Tuple, Type, Union
+
+import py_serializable as serializable
+from sortedcontainers import SortedSet
+
+from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
+from .._internal.compare import ComparableTuple as _ComparableTuple
+from ..exception.model import MutuallyExclusivePropertiesException, NoPropertiesProvidedException
+from ..schema.schema import SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6
+from . import Property, XsUri
+from .bom_ref import BomRef
+from .contact import OrganizationalContact, OrganizationalEntity
+from .impact_analysis import (
+ ImpactAnalysisAffectedStatus,
+ ImpactAnalysisJustification,
+ ImpactAnalysisResponse,
+ ImpactAnalysisState,
+)
+from .tool import Tool, ToolRepository, _ToolRepositoryHelper
+
+
+@serializable.serializable_class
+class BomTargetVersionRange:
+ """
+ Class that represents either a version or version range and its affected status.
+
+ `version` and `version_range` are mutually exclusive.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
+ """
+
+ def __init__(
+ self, *,
+ version: Optional[str] = None,
+ range: Optional[str] = None,
+ status: Optional[ImpactAnalysisAffectedStatus] = None,
+ ) -> None:
+ if not version and not range:
+ raise NoPropertiesProvidedException(
+ 'One of version or range must be provided for BomTargetVersionRange - neither provided.'
+ )
+ if version and range:
+ raise MutuallyExclusivePropertiesException(
+ 'Either version or range should be provided for BomTargetVersionRange - both provided.'
+ )
+ self.version = version
+ self.range = range
+ self.status = status
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def version(self) -> Optional[str]:
+ """
+ A single version of a component or service.
+ """
+ return self._version
+
+ @version.setter
+ def version(self, version: Optional[str]) -> None:
+ self._version = version
+
+ @property
+ @serializable.xml_sequence(2)
+ def range(self) -> Optional[str]:
+ """
+ A version range specified in Package URL Version Range syntax (vers) which is defined at
+ https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst
+
+ .. note::
+ The VERSION-RANGE-SPEC from Package URL is not a formalised standard at the time of writing and this no
+ validation of conformance with this draft standard is performed.
+ """
+ return self._range
+
+ @range.setter
+ def range(self, range: Optional[str]) -> None:
+ self._range = range
+
+ @property
+ @serializable.xml_sequence(3)
+ def status(self) -> Optional[ImpactAnalysisAffectedStatus]:
+ """
+ The vulnerability status for the version or range of versions.
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status: Optional[ImpactAnalysisAffectedStatus]) -> None:
+ self._status = status
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.version, self.range, self.status
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, BomTargetVersionRange):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, BomTargetVersionRange):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class BomTarget:
+ """
+ Class that represents referencing a Component or Service in a BOM.
+
+ Aims to represent the sub-element `target` of the complex type `vulnerabilityType`.
+
+ You can either create a `cyclonedx.model.bom.Bom` yourself programmatically, or generate a `cyclonedx.model.bom.Bom`
+ from a `cyclonedx.parser.BaseParser` implementation.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType
+ """
+
+ def __init__(
+ self, *,
+ ref: str,
+ versions: Optional[Iterable[BomTargetVersionRange]] = None,
+ ) -> None:
+ self.ref = ref
+ self.versions = versions or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_sequence(1)
+ def ref(self) -> str:
+ """
+ Reference to a component or service by the objects `bom-ref`.
+ """
+ return self._ref
+
+ @ref.setter
+ def ref(self, ref: str) -> None:
+ self._ref = ref
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'version')
+ @serializable.xml_sequence(2)
+ def versions(self) -> 'SortedSet[BomTargetVersionRange]':
+ """
+ Zero or more individual versions or range of versions.
+
+ Returns:
+ Set of `BomTargetVersionRange`
+ """
+ return self._versions
+
+ @versions.setter
+ def versions(self, versions: Iterable[BomTargetVersionRange]) -> None:
+ self._versions = SortedSet(versions)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.ref,
+ _ComparableTuple(self.versions)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, BomTarget):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, BomTarget):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class VulnerabilityAnalysis:
+ """
+ Class that models the `analysis` sub-element of the `vulnerabilityType` complex type.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
+ """
+
+ def __init__(
+ self, *,
+ state: Optional[ImpactAnalysisState] = None,
+ justification: Optional[ImpactAnalysisJustification] = None,
+ responses: Optional[Iterable[ImpactAnalysisResponse]] = None,
+ detail: Optional[str] = None,
+ first_issued: Optional[datetime] = None,
+ last_updated: Optional[datetime] = None,
+ ) -> None:
+ self.state = state
+ self.justification = justification
+ self.responses = responses or [] # type:ignore[assignment]
+ self.detail = detail
+ self.first_issued = first_issued
+ self.last_updated = last_updated
+
+ @property
+ @serializable.xml_sequence(1)
+ def state(self) -> Optional[ImpactAnalysisState]:
+ """
+ The declared current state of an occurrence of a vulnerability, after automated or manual analysis.
+
+ Returns:
+ `ImpactAnalysisState` if set else `None`
+ """
+ return self._state
+
+ @state.setter
+ def state(self, state: Optional[ImpactAnalysisState]) -> None:
+ self._state = state
+
+ @property
+ @serializable.xml_sequence(2)
+ def justification(self) -> Optional[ImpactAnalysisJustification]:
+ """
+ The rationale of why the impact analysis state was asserted.
+
+ Returns:
+ `ImpactAnalysisJustification` if set else `None`
+ """
+ return self._justification
+
+ @justification.setter
+ def justification(self, justification: Optional[ImpactAnalysisJustification]) -> None:
+ self._justification = justification
+
+ @property
+ @serializable.json_name('response')
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'response')
+ @serializable.xml_sequence(3)
+ def responses(self) -> 'SortedSet[ImpactAnalysisResponse]':
+ """
+ A list of responses to the vulnerability by the manufacturer, supplier, or project responsible for the
+ affected component or service. More than one response is allowed. Responses are strongly encouraged for
+ vulnerabilities where the analysis state is exploitable.
+
+ Returns:
+ Set of `ImpactAnalysisResponse`
+ """
+ return self._responses
+
+ @responses.setter
+ def responses(self, responses: Iterable[ImpactAnalysisResponse]) -> None:
+ self._responses = SortedSet(responses)
+
+ @property
+ @serializable.xml_sequence(4)
+ def detail(self) -> Optional[str]:
+ """
+ A detailed description of the impact including methods used during assessment. If a vulnerability is not
+ exploitable, this field should include specific details on why the component or service is not impacted by this
+ vulnerability.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._detail
+
+ @detail.setter
+ def detail(self, detail: Optional[str]) -> None:
+ self._detail = detail
+
+ @property
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(5)
+ def first_issued(self) -> Optional[datetime]:
+ return self._first_issued
+
+ @first_issued.setter
+ def first_issued(self, first_issue: Optional[datetime]) -> None:
+ self._first_issued = first_issue
+
+ @property
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(6)
+ def last_updated(self) -> Optional[datetime]:
+ return self._last_updated
+
+ @last_updated.setter
+ def last_updated(self, last_updated: Optional[datetime]) -> None:
+ self._last_updated = last_updated
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.state, self.justification,
+ _ComparableTuple(self.responses),
+ self.detail,
+ self.first_issued, self.last_updated
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, VulnerabilityAnalysis):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class VulnerabilityAdvisory:
+ """
+ Class that models the `advisoryType` complex type.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_advisoryType
+ """
+
+ def __init__(
+ self, *,
+ url: XsUri,
+ title: Optional[str] = None,
+ ) -> None:
+ self.title = title
+ self.url = url
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def title(self) -> Optional[str]:
+ """
+ The title of this advisory.
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title: Optional[str]) -> None:
+ self._title = title
+
+ @property
+ @serializable.xml_sequence(2)
+ def url(self) -> XsUri:
+ """
+ The url of this advisory.
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: XsUri) -> None:
+ self._url = url
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.title, self.url
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, VulnerabilityAdvisory):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, VulnerabilityAdvisory):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class VulnerabilitySource:
+ """
+ Class that models the `vulnerabilitySourceType` complex type.
+
+ This type is used for multiple purposes in the CycloneDX schema.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilitySourceType
+ """
+
+ def __init__(
+ self, *,
+ name: Optional[str] = None,
+ url: Optional[XsUri] = None,
+ ) -> None:
+ self.name = name
+ self.url = url
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def name(self) -> Optional[str]:
+ """
+ Name of this Source.
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name: Optional[str]) -> None:
+ self._name = name
+
+ @property
+ @serializable.xml_sequence(2)
+ def url(self) -> Optional[XsUri]:
+ """
+ The url of this Source.
+ """
+ return self._url
+
+ @url.setter
+ def url(self, url: Optional[XsUri]) -> None:
+ self._url = url
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.name, self.url
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, VulnerabilitySource):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, VulnerabilitySource):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class VulnerabilityReference:
+ """
+ Class that models the nested `reference` within the `vulnerabilityType` complex type.
+
+ Vulnerabilities may benefit from pointers to vulnerabilities that are the equivalent of the vulnerability specified.
+ Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different
+ identifiers. These references provide a way to correlate vulnerabilities across multiple sources of vulnerability
+ intelligence.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
+
+ .. note::
+ Properties ``id`` and ``source`` are mandatory.
+
+ History:
+ * In v1.4 JSON scheme, both properties were mandatory
+ https://github.com/CycloneDX/specification/blob/d570ffb8956d796585b9574e57598c42ee9de770/schema/bom-1.4.schema.json#L1455-L1474
+ * In v1.4 XML schema, both properties were optional
+ https://github.com/CycloneDX/specification/blob/d570ffb8956d796585b9574e57598c42ee9de770/schema/bom-1.4.xsd#L1788-L1797
+ * In v1.5 XML schema, both were mandatory
+ https://github.com/CycloneDX/specification/blob/d570ffb8956d796585b9574e57598c42ee9de770/schema/bom-1.5.xsd#L3364-L3374
+
+ Decision:
+ Since CycloneDXCoreWorkingGroup chose JSON schema as the dominant schema, the one that serves as first spec
+ implementation, and since XML schema was "fixed" to work same as JSON schema, we'd consider it canon/spec that
+ both properties were always mandatory.
+ """
+
+ def __init__(
+ self, *,
+ id: str,
+ source: VulnerabilitySource,
+ ) -> None:
+ self.id = id
+ self.source = source
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def id(self) -> str:
+ """
+ The identifier that uniquely identifies the vulnerability in the associated Source. For example: CVE-2021-39182.
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: str) -> None:
+ self._id = id
+
+ @property
+ @serializable.xml_sequence(2)
+ def source(self) -> VulnerabilitySource:
+ """
+ The source that published the vulnerability.
+ """
+ return self._source
+
+ @source.setter
+ def source(self, source: VulnerabilitySource) -> None:
+ self._source = source
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.id, self.source
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, VulnerabilityReference):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, VulnerabilityReference):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_enum
+class VulnerabilityScoreSource(str, Enum):
+ """
+ Enum object that defines the permissible source types for a Vulnerability's score.
+
+ .. note::
+ See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_scoreSourceType
+
+ .. note::
+ No explicit carry-over from the former schema extension:
+ https://github.com/CycloneDX/specification/blob/master/schema/ext/vulnerability-1.0.xsd
+ """
+ # see `_VulnerabilityScoreSourceSerializationHelper.__CASES` for view/case map
+ CVSS_V2 = 'CVSSv2'
+ CVSS_V3 = 'CVSSv3'
+ CVSS_V3_1 = 'CVSSv31'
+ CVSS_V4 = 'CVSSv4' # Only supported in >= 1.5
+ OWASP = 'OWASP' # Name change in 1.4
+ SSVC = 'SSVC' # Only supported in >= 1.5
+ # --
+ OTHER = 'other'
+
+ @staticmethod
+ def get_from_vector(vector: str) -> 'VulnerabilityScoreSource':
+ """
+ Attempt to derive the correct SourceType from an attack vector.
+
+ For example, often attack vector strings are prefixed with the scheme in question - such
+ that __CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:C/C:L/I:N/A:N__ would be the vector
+ __AV:L/AC:L/PR:N/UI:R/S:C/C:L/I:N/A:N__ under the __CVSS 3__ scheme.
+
+ Returns:
+ Always returns an instance of `VulnerabilityScoreSource`. `VulnerabilityScoreSource.OTHER` is
+ returned if the scheme is not obvious or known to us.
+ """
+ if vector.startswith('CVSS:3.'):
+ return VulnerabilityScoreSource.CVSS_V3
+ elif vector.startswith('CVSS:2.'):
+ return VulnerabilityScoreSource.CVSS_V2
+ elif vector.startswith('OWASP'):
+ return VulnerabilityScoreSource.OWASP
+ else:
+ return VulnerabilityScoreSource.OTHER
+
+ def get_localised_vector(self, vector: str) -> str:
+ """
+ This method will remove any Source Scheme type from the supplied vector, returning just the vector.
+
+ .. Note::
+ Currently supports CVSS 3.x, CVSS 2.x and OWASP schemes.
+
+ Returns:
+ The vector without any scheme prefix as a `str`.
+ """
+ if self == VulnerabilityScoreSource.CVSS_V3 and vector.startswith('CVSS:3.'):
+ return re.sub('^CVSS:3\\.\\d/?', '', vector)
+
+ if self == VulnerabilityScoreSource.CVSS_V2 and vector.startswith('CVSS:2.'):
+ return re.sub('^CVSS:2\\.\\d/?', '', vector)
+
+ if self == VulnerabilityScoreSource.OWASP and vector.startswith('OWASP'):
+ return re.sub('^OWASP/?', '', vector)
+
+ return vector
+
+ def get_value_pre_1_4(self) -> str:
+ """
+ Some of the enum values changed in 1.4 of the CycloneDX spec. This method allows us to
+ backport some of the changes for pre-1.4.
+
+ Returns:
+ `str`
+ """
+ if self == VulnerabilityScoreSource.OWASP:
+ return 'OWASP Risk'
+ return self.value # type:ignore[no-any-return]
+
+
+class _VulnerabilityScoreSourceSerializationHelper(serializable.helpers.BaseHelper):
+ """ THIS CLASS IS NON-PUBLIC API """
+
+ __CASES: Dict[Type[serializable.ViewType], FrozenSet[VulnerabilityScoreSource]] = dict()
+ __CASES[SchemaVersion1Dot4] = frozenset({
+ VulnerabilityScoreSource.CVSS_V2,
+ VulnerabilityScoreSource.CVSS_V3,
+ VulnerabilityScoreSource.CVSS_V3_1,
+ VulnerabilityScoreSource.OWASP,
+ VulnerabilityScoreSource.OTHER,
+ })
+ __CASES[SchemaVersion1Dot5] = __CASES[SchemaVersion1Dot4] | {
+ VulnerabilityScoreSource.CVSS_V4,
+ VulnerabilityScoreSource.SSVC
+ }
+ __CASES[SchemaVersion1Dot6] = __CASES[SchemaVersion1Dot5]
+
+ @classmethod
+ def __normalize(cls, vss: VulnerabilityScoreSource, view: Type[serializable.ViewType]) -> str:
+ return (
+ vss
+ if vss in cls.__CASES.get(view, ())
+ else VulnerabilityScoreSource.OTHER
+ ).value
+
+ @classmethod
+ def json_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> str:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def xml_normalize(cls, o: Any, *,
+ view: Optional[Type[serializable.ViewType]],
+ **__: Any) -> str:
+ assert view is not None
+ return cls.__normalize(o, view)
+
+ @classmethod
+ def deserialize(cls, o: Any) -> VulnerabilityScoreSource:
+ return VulnerabilityScoreSource(o)
+
+
+@serializable.serializable_enum
+class VulnerabilitySeverity(str, Enum):
+ """
+ Class that defines the permissible severities for a Vulnerability.
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_severityType
+ """
+ NONE = 'none'
+ INFO = 'info' # Only >= 1.4
+ LOW = 'low'
+ MEDIUM = 'medium'
+ HIGH = 'high'
+ CRITICAL = 'critical'
+ UNKNOWN = 'unknown'
+
+ @staticmethod
+ def get_from_cvss_scores(scores: Union[Tuple[float, ...], float, None]) -> 'VulnerabilitySeverity':
+ """
+ Derives the Severity of a Vulnerability from it's declared CVSS scores.
+
+ Args:
+ scores: A `tuple` of CVSS scores. CVSS scoring system allows for up to three separate scores.
+
+ Returns:
+ Always returns an instance of `VulnerabilitySeverity`.
+ """
+ if type(scores) is float:
+ scores = (scores,)
+
+ if scores is None:
+ return VulnerabilitySeverity.UNKNOWN
+
+ max_cvss_score: float
+ if isinstance(scores, tuple):
+ max_cvss_score = max(scores)
+ else:
+ max_cvss_score = float(scores)
+
+ if max_cvss_score >= 9.0:
+ return VulnerabilitySeverity.CRITICAL
+ elif max_cvss_score >= 7.0:
+ return VulnerabilitySeverity.HIGH
+ elif max_cvss_score >= 4.0:
+ return VulnerabilitySeverity.MEDIUM
+ elif max_cvss_score > 0.0:
+ return VulnerabilitySeverity.LOW
+ else:
+ return VulnerabilitySeverity.NONE
+
+
+@serializable.serializable_class
+class VulnerabilityRating:
+ """
+ Class that models the `ratingType` complex element CycloneDX core schema.
+
+ This class previously modelled the `scoreType` complexe type in the schema extension used prior to schema version
+ 1.4 - see https://github.com/CycloneDX/specification/blob/master/schema/ext/vulnerability-1.0.xsd.
+
+ .. note::
+ See `ratingType` in https://cyclonedx.org/docs/1.6/xml/#ratingType
+
+ .. warning::
+ As part of implementing support for CycloneDX schema version 1.4, the three score types defined in the schema
+ extension used prior to 1.4 have been deprecated. The deprecated `score_base` should loosely be equivalent to
+ the new `score` in 1.4 schema. Both `score_impact` and `score_exploitability` are deprecated and removed as
+ they are redundant if you have the vector (the vector allows you to calculate the scores).
+ """
+
+ def __init__(
+ self, *,
+ source: Optional[VulnerabilitySource] = None,
+ score: Optional[Decimal] = None,
+ severity: Optional[VulnerabilitySeverity] = None,
+ method: Optional[VulnerabilityScoreSource] = None,
+ vector: Optional[str] = None,
+ justification: Optional[str] = None,
+ ) -> None:
+ self.source = source
+ self.score = score
+ self.severity = severity
+ self.method = method
+ self.vector = vector
+ self.justification = justification
+
+ if vector and method:
+ self.vector = method.get_localised_vector(vector=vector)
+
+ @property
+ @serializable.xml_sequence(1)
+ def source(self) -> Optional[VulnerabilitySource]:
+ """
+ The source that published the vulnerability.
+ """
+ return self._source
+
+ @source.setter
+ def source(self, source: Optional[VulnerabilitySource]) -> None:
+ self._source = source
+
+ @property
+ @serializable.string_format('.1f')
+ @serializable.xml_sequence(2)
+ def score(self) -> Optional[Decimal]:
+ """
+ The numerical score of the rating.
+ """
+ return self._score
+
+ @score.setter
+ def score(self, score: Optional[Decimal]) -> None:
+ self._score = score
+
+ @property
+ @serializable.xml_sequence(3)
+ def severity(self) -> Optional[VulnerabilitySeverity]:
+ """
+ The textual representation of the severity that corresponds to the numerical score of the rating.
+ """
+ return self._severity
+
+ @severity.setter
+ def severity(self, severity: Optional[VulnerabilitySeverity]) -> None:
+ self._severity = severity
+
+ @property
+ @serializable.type_mapping(_VulnerabilityScoreSourceSerializationHelper)
+ @serializable.xml_sequence(4)
+ def method(self) -> Optional[VulnerabilityScoreSource]:
+ """
+ The risk scoring methodology/standard used.
+ """
+ return self._method
+
+ @method.setter
+ def method(self, score_source: Optional[VulnerabilityScoreSource]) -> None:
+ self._method = score_source
+
+ @property
+ @serializable.xml_sequence(5)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def vector(self) -> Optional[str]:
+ """
+ The textual representation of the metric values used to score the vulnerability - also known as the vector.
+ """
+ return self._vector
+
+ @vector.setter
+ def vector(self, vector: Optional[str]) -> None:
+ self._vector = vector
+
+ @property
+ @serializable.xml_sequence(6)
+ def justification(self) -> Optional[str]:
+ """
+ An optional reason for rating the vulnerability as it was.
+ """
+ return self._justification
+
+ @justification.setter
+ def justification(self, justification: Optional[str]) -> None:
+ self._justification = justification
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.severity, self.score or 0,
+ self.source, self.method, self.vector,
+ self.justification
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, VulnerabilityRating):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, VulnerabilityRating):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class VulnerabilityCredits:
+ """
+ Class that models the `credits` of `vulnerabilityType` complex type in the CycloneDX schema (version >= 1.4).
+
+ This class also provides data support for schema versions < 1.4 where Vulnerabilites were possible through a schema
+ extension (in XML only).
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/xml/#type_vulnerabilityType
+ """
+
+ def __init__(
+ self, *,
+ organizations: Optional[Iterable[OrganizationalEntity]] = None,
+ individuals: Optional[Iterable[OrganizationalContact]] = None,
+ ) -> None:
+ self.organizations = organizations or [] # type:ignore[assignment]
+ self.individuals = individuals or [] # type:ignore[assignment]
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'organization')
+ @serializable.xml_sequence(1)
+ def organizations(self) -> 'SortedSet[OrganizationalEntity]':
+ """
+ The organizations credited with vulnerability discovery.
+
+ Returns:
+ Set of `OrganizationalEntity`
+ """
+ return self._organizations
+
+ @organizations.setter
+ def organizations(self, organizations: Iterable[OrganizationalEntity]) -> None:
+ self._organizations = SortedSet(organizations)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'individual')
+ @serializable.xml_sequence(2)
+ def individuals(self) -> 'SortedSet[OrganizationalContact]':
+ """
+ The individuals, not associated with organizations, that are credited with vulnerability discovery.
+
+ Returns:
+ Set of `OrganizationalContact`
+ """
+ return self._individuals
+
+ @individuals.setter
+ def individuals(self, individuals: Iterable[OrganizationalContact]) -> None:
+ self._individuals = SortedSet(individuals)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ _ComparableTuple(self.organizations),
+ _ComparableTuple(self.individuals)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, VulnerabilityCredits):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, VulnerabilityCredits):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
+
+
+@serializable.serializable_class
+class Vulnerability:
+ """
+ Class that models the `vulnerabilityType` complex type in the CycloneDX schema (version >= 1.4).
+
+ This class also provides data support for schema versions < 1.4 where Vulnerabilites were possible through a schema
+ extension (in XML only).
+
+ .. note::
+ See the CycloneDX schema: https://cyclonedx.org/docs/1.6/#type_vulnerabilityType
+ """
+
+ def __init__(
+ self, *,
+ bom_ref: Optional[Union[str, BomRef]] = None,
+ id: Optional[str] = None,
+ source: Optional[VulnerabilitySource] = None,
+ references: Optional[Iterable[VulnerabilityReference]] = None,
+ ratings: Optional[Iterable[VulnerabilityRating]] = None,
+ cwes: Optional[Iterable[int]] = None,
+ description: Optional[str] = None,
+ detail: Optional[str] = None,
+ recommendation: Optional[str] = None,
+ workaround: Optional[str] = None,
+ advisories: Optional[Iterable[VulnerabilityAdvisory]] = None,
+ created: Optional[datetime] = None,
+ published: Optional[datetime] = None,
+ updated: Optional[datetime] = None,
+ credits: Optional[VulnerabilityCredits] = None,
+ tools: Optional[Union[Iterable[Tool], ToolRepository]] = None,
+ analysis: Optional[VulnerabilityAnalysis] = None,
+ affects: Optional[Iterable[BomTarget]] = None,
+ properties: Optional[Iterable[Property]] = None,
+ ) -> None:
+ self._bom_ref = _bom_ref_from_str(bom_ref)
+ self.id = id
+ self.source = source
+ self.references = references or [] # type:ignore[assignment]
+ self.ratings = ratings or [] # type:ignore[assignment]
+ self.cwes = cwes or [] # type:ignore[assignment]
+ self.description = description
+ self.detail = detail
+ self.recommendation = recommendation
+ self.workaround = workaround
+ self.advisories = advisories or [] # type:ignore[assignment]
+ self.created = created
+ self.published = published
+ self.updated = updated
+ self.credits = credits
+ self.tools = tools or [] # type:ignore[assignment]
+ self.analysis = analysis
+ self.affects = affects or [] # type:ignore[assignment]
+ self.properties = properties or [] # type:ignore[assignment]
+
+ @property
+ @serializable.json_name('bom-ref')
+ @serializable.type_mapping(BomRef)
+ @serializable.xml_attribute()
+ @serializable.xml_name('bom-ref')
+ def bom_ref(self) -> BomRef:
+ """
+ Get the unique reference for this Vulnerability in this BOM.
+
+ Returns:
+ `BomRef`
+ """
+ return self._bom_ref
+
+ @property
+ @serializable.xml_sequence(1)
+ @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
+ def id(self) -> Optional[str]:
+ """
+ The identifier that uniquely identifies the vulnerability. For example: CVE-2021-39182.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id: Optional[str]) -> None:
+ self._id = id
+
+ @property
+ @serializable.xml_sequence(2)
+ def source(self) -> Optional[VulnerabilitySource]:
+ """
+ The source that published the vulnerability.
+
+ Returns:
+ `VulnerabilitySource` if set else `None`
+ """
+ return self._source
+
+ @source.setter
+ def source(self, source: Optional[VulnerabilitySource]) -> None:
+ self._source = source
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'reference')
+ @serializable.xml_sequence(3)
+ def references(self) -> 'SortedSet[VulnerabilityReference]':
+ """
+ Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times,
+ the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different
+ identifiers. References provides a way to correlate vulnerabilities across multiple sources of vulnerability
+ intelligence.
+
+ Returns:
+ Set of `VulnerabilityReference`
+ """
+ return self._references
+
+ @references.setter
+ def references(self, references: Iterable[VulnerabilityReference]) -> None:
+ self._references = SortedSet(references)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'rating')
+ @serializable.xml_sequence(4)
+ def ratings(self) -> 'SortedSet[VulnerabilityRating]':
+ """
+ List of vulnerability ratings.
+
+ Returns:
+ Set of `VulnerabilityRating`
+ """
+ return self._ratings
+
+ @ratings.setter
+ def ratings(self, ratings: Iterable[VulnerabilityRating]) -> None:
+ self._ratings = SortedSet(ratings)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'cwe')
+ @serializable.xml_sequence(5)
+ def cwes(self) -> 'SortedSet[int]':
+ """
+ A list of CWE (Common Weakness Enumeration) identifiers.
+
+ .. note::
+ See https://cwe.mitre.org/
+
+ Returns:
+ Set of `int`
+ """
+ return self._cwes
+
+ @cwes.setter
+ def cwes(self, cwes: Iterable[int]) -> None:
+ self._cwes = SortedSet(cwes)
+
+ @property
+ @serializable.xml_sequence(6)
+ def description(self) -> Optional[str]:
+ """
+ A description of the vulnerability as provided by the source.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description: Optional[str]) -> None:
+ self._description = description
+
+ @property
+ @serializable.xml_sequence(7)
+ def detail(self) -> Optional[str]:
+ """
+ If available, an in-depth description of the vulnerability as provided by the source organization. Details
+ often include examples, proof-of-concepts, and other information useful in understanding root cause.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._detail
+
+ @detail.setter
+ def detail(self, detail: Optional[str]) -> None:
+ self._detail = detail
+
+ @property
+ @serializable.xml_sequence(8)
+ def recommendation(self) -> Optional[str]:
+ """
+ Recommendations of how the vulnerability can be remediated or mitigated.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._recommendation
+
+ @recommendation.setter
+ def recommendation(self, recommendation: Optional[str]) -> None:
+ self._recommendation = recommendation
+
+ @property
+ @serializable.view(SchemaVersion1Dot5)
+ @serializable.view(SchemaVersion1Dot6)
+ @serializable.xml_sequence(9)
+ def workaround(self) -> Optional[str]:
+ """
+ A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact.
+ Workarounds often involve changes to configuration or deployments.
+
+ Returns:
+ `str` if set else `None`
+ """
+ return self._workaround
+
+ @workaround.setter
+ def workaround(self, workaround: Optional[str]) -> None:
+ self._workaround = workaround
+
+ # @property
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(10)
+ # def proof_of_concept(self) -> ...:
+ # ... # TODO since CDX 1.5
+ #
+ # @proof_of_concept.setter
+ # def proof_of_concept(self, ...) -> None:
+ # ... # TODO since CDX 1.5
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'advisory')
+ @serializable.xml_sequence(11)
+ def advisories(self) -> 'SortedSet[VulnerabilityAdvisory]':
+ """
+ Advisories relating to the Vulnerability.
+
+ Returns:
+ Set of `VulnerabilityAdvisory`
+ """
+ return self._advisories
+
+ @advisories.setter
+ def advisories(self, advisories: Iterable[VulnerabilityAdvisory]) -> None:
+ self._advisories = SortedSet(advisories)
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(12)
+ def created(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the vulnerability record was created in the vulnerability database.
+
+ Returns:
+ `datetime` if set else `None`
+ """
+ return self._created
+
+ @created.setter
+ def created(self, created: Optional[datetime]) -> None:
+ self._created = created
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(13)
+ def published(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the vulnerability record was first published.
+
+ Returns:
+ `datetime` if set else `None`
+ """
+ return self._published
+
+ @published.setter
+ def published(self, published: Optional[datetime]) -> None:
+ self._published = published
+
+ @property
+ @serializable.type_mapping(serializable.helpers.XsdDateTime)
+ @serializable.xml_sequence(14)
+ def updated(self) -> Optional[datetime]:
+ """
+ The date and time (timestamp) when the vulnerability record was last updated.
+
+ Returns:
+ `datetime` if set else `None`
+ """
+ return self._updated
+
+ @updated.setter
+ def updated(self, updated: Optional[datetime]) -> None:
+ self._updated = updated
+
+ # @property
+ # @serializable.view(SchemaVersion1Dot5)
+ # @serializable.xml_sequence(15)
+ # def rejected(self) -> ...:
+ # ... # TODO since CDX 1.5
+ #
+ # @rejected.setter
+ # def rejected(self, ...) -> None:
+ # ... # TODO since CDX 1.5
+
+ @property
+ @serializable.xml_sequence(16)
+ def credits(self) -> Optional[VulnerabilityCredits]:
+ """
+ Individuals or organizations credited with the discovery of the vulnerability.
+
+ Returns:
+ `VulnerabilityCredits` if set else `None`
+ """
+ return self._credits
+
+ @credits.setter
+ def credits(self, credits: Optional[VulnerabilityCredits]) -> None:
+ self._credits = credits
+
+ @property
+ @serializable.type_mapping(_ToolRepositoryHelper)
+ @serializable.xml_sequence(17)
+ def tools(self) -> ToolRepository:
+ """
+ Tools used to create this BOM.
+
+ Returns:
+ :class:`ToolRepository` object.
+ """
+ return self._tools
+
+ @tools.setter
+ def tools(self, tools: Union[Iterable[Tool], ToolRepository]) -> None:
+ self._tools = tools \
+ if isinstance(tools, ToolRepository) \
+ else ToolRepository(tools=tools)
+
+ @property
+ @serializable.xml_sequence(18)
+ def analysis(self) -> Optional[VulnerabilityAnalysis]:
+ """
+ Analysis of the Vulnerability in your context.
+
+ Returns:
+ `VulnerabilityAnalysis` if set else `None`
+ """
+ return self._analysis
+
+ @analysis.setter
+ def analysis(self, analysis: Optional[VulnerabilityAnalysis]) -> None:
+ self._analysis = analysis
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'target')
+ @serializable.xml_sequence(19)
+ def affects(self) -> 'SortedSet[BomTarget]':
+ """
+ The components or services that are affected by the vulnerability.
+
+ Returns:
+ Set of `BomTarget`
+ """
+ return self._affects
+
+ @affects.setter
+ def affects(self, affects_targets: Iterable[BomTarget]) -> None:
+ self._affects = SortedSet(affects_targets)
+
+ @property
+ @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
+ @serializable.xml_sequence(20)
+ def properties(self) -> 'SortedSet[Property]':
+ """
+ Provides the ability to document properties in a key/value store. This provides flexibility to include data not
+ officially supported in the standard without having to use additional namespaces or create extensions.
+
+ Return:
+ Set of `Property`
+ """
+ return self._properties
+
+ @properties.setter
+ def properties(self, properties: Iterable[Property]) -> None:
+ self._properties = SortedSet(properties)
+
+ def __comparable_tuple(self) -> _ComparableTuple:
+ return _ComparableTuple((
+ self.id, self.bom_ref.value,
+ self.source, _ComparableTuple(self.references),
+ _ComparableTuple(self.ratings), _ComparableTuple(self.cwes), self.description,
+ self.detail, self.recommendation, self.workaround, _ComparableTuple(self.advisories),
+ self.created, self.published, self.updated,
+ self.credits, self.tools, self.analysis,
+ _ComparableTuple(self.affects),
+ _ComparableTuple(self.properties)
+ ))
+
+ def __eq__(self, other: object) -> bool:
+ if isinstance(other, Vulnerability):
+ return self.__comparable_tuple() == other.__comparable_tuple()
+ return False
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, Vulnerability):
+ return self.__comparable_tuple() < other.__comparable_tuple()
+ return NotImplemented
+
+ def __hash__(self) -> int:
+ return hash(self.__comparable_tuple())
+
+ def __repr__(self) -> str:
+ return f''
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__init__.py
new file mode 100644
index 00000000..61868d43
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__init__.py
@@ -0,0 +1,176 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Set of classes and methods for outputting our libraries internal Bom model to CycloneDX documents in varying formats
+and according to different versions of the CycloneDX schema standard.
+"""
+
+import os
+from abc import ABC, abstractmethod
+from itertools import chain
+from random import random
+from typing import TYPE_CHECKING, Any, Iterable, Literal, Mapping, Optional, Type, Union, overload
+
+from ..schema import OutputFormat, SchemaVersion
+
+if TYPE_CHECKING: # pragma: no cover
+ from ..model.bom import Bom
+ from ..model.bom_ref import BomRef
+ from .json import Json as JsonOutputter
+ from .xml import Xml as XmlOutputter
+
+
+class BaseOutput(ABC):
+
+ def __init__(self, bom: 'Bom', **kwargs: int) -> None:
+ super().__init__(**kwargs)
+ self._bom = bom
+ self._generated: bool = False
+
+ @property
+ @abstractmethod
+ def schema_version(self) -> SchemaVersion:
+ ... # pragma: no cover
+
+ @property
+ @abstractmethod
+ def output_format(self) -> OutputFormat:
+ ... # pragma: no cover
+
+ @property
+ def generated(self) -> bool:
+ return self._generated
+
+ @generated.setter
+ def generated(self, generated: bool) -> None:
+ self._generated = generated
+
+ def get_bom(self) -> 'Bom':
+ return self._bom
+
+ def set_bom(self, bom: 'Bom') -> None:
+ self._bom = bom
+
+ @abstractmethod
+ def generate(self, force_regeneration: bool = False) -> None:
+ ... # pragma: no cover
+
+ @abstractmethod
+ def output_as_string(self, *,
+ indent: Optional[Union[int, str]] = None,
+ **kwargs: Any) -> str:
+ ... # pragma: no cover
+
+ def output_to_file(self, filename: str, allow_overwrite: bool = False, *,
+ indent: Optional[Union[int, str]] = None,
+ **kwargs: Any) -> None:
+ # Check directory writable
+ output_filename = os.path.realpath(filename)
+ output_directory = os.path.dirname(output_filename)
+ if not os.access(output_directory, os.W_OK):
+ raise PermissionError(output_directory)
+ if os.path.exists(output_filename) and not allow_overwrite:
+ raise FileExistsError(output_filename)
+ with open(output_filename, mode='wb') as f_out:
+ f_out.write(self.output_as_string(indent=indent).encode('utf-8'))
+
+
+@overload
+def make_outputter(bom: 'Bom', output_format: Literal[OutputFormat.JSON],
+ schema_version: SchemaVersion) -> 'JsonOutputter':
+ ... # pragma: no cover
+
+
+@overload
+def make_outputter(bom: 'Bom', output_format: Literal[OutputFormat.XML],
+ schema_version: SchemaVersion) -> 'XmlOutputter':
+ ... # pragma: no cover
+
+
+@overload
+def make_outputter(bom: 'Bom', output_format: OutputFormat,
+ schema_version: SchemaVersion) -> Union['XmlOutputter', 'JsonOutputter']:
+ ... # pragma: no cover
+
+
+def make_outputter(bom: 'Bom', output_format: OutputFormat, schema_version: SchemaVersion) -> BaseOutput:
+ """
+ Helper method to quickly get the correct output class/formatter.
+
+ Pass in your BOM and optionally an output format and schema version (defaults to XML and latest schema version).
+
+
+ Raises error when no instance could be made.
+
+ :param bom: Bom
+ :param output_format: OutputFormat
+ :param schema_version: SchemaVersion
+ :return: BaseOutput
+ """
+ if TYPE_CHECKING: # pragma: no cover
+ BY_SCHEMA_VERSION: Mapping[SchemaVersion, Type[BaseOutput]] # noqa:N806
+ if OutputFormat.JSON is output_format:
+ from .json import BY_SCHEMA_VERSION
+ elif OutputFormat.XML is output_format:
+ from .xml import BY_SCHEMA_VERSION
+ else:
+ raise ValueError(f'Unexpected output_format: {output_format!r}')
+
+ klass = BY_SCHEMA_VERSION.get(schema_version, None)
+ if klass is None:
+ raise ValueError(f'Unknown {output_format.name}/schema_version: {schema_version!r}')
+ return klass(bom)
+
+
+class BomRefDiscriminator:
+
+ def __init__(self, bomrefs: Iterable['BomRef'], prefix: str = 'BomRef') -> None:
+ # do not use dict/set here, different BomRefs with same value have same hash and would shadow each other
+ self._bomrefs = tuple((bomref, bomref.value) for bomref in bomrefs)
+ self._prefix = prefix
+
+ def __enter__(self) -> None:
+ self.discriminate()
+
+ def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+ self.reset()
+
+ def discriminate(self) -> None:
+ known_values = []
+ for bomref, _ in self._bomrefs:
+ value = bomref.value
+ if value is None or value in known_values:
+ value = self._make_unique()
+ bomref.value = value
+ known_values.append(value)
+
+ def reset(self) -> None:
+ for bomref, original_value in self._bomrefs:
+ bomref.value = original_value
+
+ def _make_unique(self) -> str:
+ return f'{self._prefix}{str(random())[1:]}{str(random())[1:]}' # nosec B311
+
+ @classmethod
+ def from_bom(cls, bom: 'Bom', prefix: str = 'BomRef') -> 'BomRefDiscriminator':
+ return cls(chain(
+ map(lambda c: c.bom_ref, bom._get_all_components()),
+ map(lambda s: s.bom_ref, bom.services),
+ map(lambda v: v.bom_ref, bom.vulnerabilities)
+ ), prefix)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..d121ac0c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/json.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/json.cpython-312.pyc
new file mode 100644
index 00000000..8d058217
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/json.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/xml.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/xml.cpython-312.pyc
new file mode 100644
index 00000000..d98d0d6c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/__pycache__/xml.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/json.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/json.py
new file mode 100644
index 00000000..bece526b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/json.py
@@ -0,0 +1,142 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+from abc import abstractmethod
+from json import dumps as json_dumps, loads as json_loads
+from typing import TYPE_CHECKING, Any, Dict, Literal, Optional, Type, Union
+
+from ..exception.output import FormatNotSupportedException
+from ..schema import OutputFormat, SchemaVersion
+from ..schema.schema import (
+ SCHEMA_VERSIONS,
+ BaseSchemaVersion,
+ SchemaVersion1Dot0,
+ SchemaVersion1Dot1,
+ SchemaVersion1Dot2,
+ SchemaVersion1Dot3,
+ SchemaVersion1Dot4,
+ SchemaVersion1Dot5,
+ SchemaVersion1Dot6,
+)
+from . import BaseOutput, BomRefDiscriminator
+
+if TYPE_CHECKING: # pragma: no cover
+ from ..model.bom import Bom
+
+
+class Json(BaseOutput, BaseSchemaVersion):
+
+ def __init__(self, bom: 'Bom') -> None:
+ super().__init__(bom=bom)
+ self._bom_json: Dict[str, Any] = dict()
+
+ @property
+ def schema_version(self) -> SchemaVersion:
+ return self.schema_version_enum
+
+ @property
+ def output_format(self) -> Literal[OutputFormat.JSON]:
+ return OutputFormat.JSON
+
+ def generate(self, force_regeneration: bool = False) -> None:
+ if self.generated and not force_regeneration:
+ return
+
+ schema_uri: Optional[str] = self._get_schema_uri()
+ if not schema_uri:
+ raise FormatNotSupportedException(
+ f'JSON is not supported by CycloneDX in schema version {self.schema_version.to_version()}')
+
+ _json_core = {
+ '$schema': schema_uri,
+ 'bomFormat': 'CycloneDX',
+ 'specVersion': self.schema_version.to_version()
+ }
+ _view = SCHEMA_VERSIONS.get(self.schema_version_enum)
+ bom = self.get_bom()
+ bom.validate()
+ with BomRefDiscriminator.from_bom(bom):
+ bom_json: Dict[str, Any] = json_loads(
+ bom.as_json( # type:ignore[attr-defined]
+ view_=_view))
+ bom_json.update(_json_core)
+ self._bom_json = bom_json
+ self.generated = True
+
+ def output_as_string(self, *,
+ indent: Optional[Union[int, str]] = None,
+ **kwargs: Any) -> str:
+ self.generate()
+ return json_dumps(self._bom_json,
+ indent=indent)
+
+ @abstractmethod
+ def _get_schema_uri(self) -> Optional[str]:
+ ... # pragma: no cover
+
+
+class JsonV1Dot0(Json, SchemaVersion1Dot0):
+
+ def _get_schema_uri(self) -> None:
+ return None
+
+
+class JsonV1Dot1(Json, SchemaVersion1Dot1):
+
+ def _get_schema_uri(self) -> None:
+ return None
+
+
+class JsonV1Dot2(Json, SchemaVersion1Dot2):
+
+ def _get_schema_uri(self) -> str:
+ return 'http://cyclonedx.org/schema/bom-1.2b.schema.json'
+
+
+class JsonV1Dot3(Json, SchemaVersion1Dot3):
+
+ def _get_schema_uri(self) -> str:
+ return 'http://cyclonedx.org/schema/bom-1.3a.schema.json'
+
+
+class JsonV1Dot4(Json, SchemaVersion1Dot4):
+
+ def _get_schema_uri(self) -> str:
+ return 'http://cyclonedx.org/schema/bom-1.4.schema.json'
+
+
+class JsonV1Dot5(Json, SchemaVersion1Dot5):
+
+ def _get_schema_uri(self) -> str:
+ return 'http://cyclonedx.org/schema/bom-1.5.schema.json'
+
+
+class JsonV1Dot6(Json, SchemaVersion1Dot6):
+
+ def _get_schema_uri(self) -> str:
+ return 'http://cyclonedx.org/schema/bom-1.6.schema.json'
+
+
+BY_SCHEMA_VERSION: Dict[SchemaVersion, Type[Json]] = {
+ SchemaVersion.V1_6: JsonV1Dot6,
+ SchemaVersion.V1_5: JsonV1Dot5,
+ SchemaVersion.V1_4: JsonV1Dot4,
+ SchemaVersion.V1_3: JsonV1Dot3,
+ SchemaVersion.V1_2: JsonV1Dot2,
+ SchemaVersion.V1_1: JsonV1Dot1,
+ SchemaVersion.V1_0: JsonV1Dot0,
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/xml.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/xml.py
new file mode 100644
index 00000000..604b6297
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/output/xml.py
@@ -0,0 +1,135 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from typing import TYPE_CHECKING, Any, Dict, Literal, Optional, Type, Union
+from xml.dom.minidom import parseString as dom_parseString # nosec B408
+from xml.etree.ElementTree import Element as XmlElement, tostring as xml_dumps # nosec B405
+
+from ..schema import OutputFormat, SchemaVersion
+from ..schema.schema import (
+ SCHEMA_VERSIONS,
+ BaseSchemaVersion,
+ SchemaVersion1Dot0,
+ SchemaVersion1Dot1,
+ SchemaVersion1Dot2,
+ SchemaVersion1Dot3,
+ SchemaVersion1Dot4,
+ SchemaVersion1Dot5,
+ SchemaVersion1Dot6,
+)
+from . import BaseOutput, BomRefDiscriminator
+
+if TYPE_CHECKING: # pragma: no cover
+ from ..model.bom import Bom
+
+
+class Xml(BaseSchemaVersion, BaseOutput):
+ def __init__(self, bom: 'Bom') -> None:
+ super().__init__(bom=bom)
+ self._bom_xml: str = ''
+
+ @property
+ def schema_version(self) -> SchemaVersion:
+ return self.schema_version_enum
+
+ @property
+ def output_format(self) -> Literal[OutputFormat.XML]:
+ return OutputFormat.XML
+
+ def generate(self, force_regeneration: bool = False) -> None:
+ if self.generated and not force_regeneration:
+ return
+
+ _view = SCHEMA_VERSIONS[self.schema_version_enum]
+ bom = self.get_bom()
+ bom.validate()
+ xmlns = self.get_target_namespace()
+ with BomRefDiscriminator.from_bom(bom):
+ self._bom_xml = '\n' + xml_dumps(
+ bom.as_xml( # type:ignore[attr-defined]
+ _view, as_string=False, xmlns=xmlns),
+ method='xml', default_namespace=xmlns, encoding='unicode',
+ # `xml-declaration` is inconsistent/bugged in py38,
+ # especially on Windows it will print a non-UTF8 codepage.
+ # Furthermore, it might add an encoding of "utf-8" which is redundant default value of XML.
+ # -> so we write the declaration manually, as long as py38 is supported.
+ xml_declaration=False)
+
+ self.generated = True
+
+ @staticmethod
+ def __make_indent(v: Optional[Union[int, str]]) -> str:
+ if isinstance(v, int):
+ return ' ' * v
+ if isinstance(v, str):
+ return v
+ return ''
+
+ def output_as_string(self, *,
+ indent: Optional[Union[int, str]] = None,
+ **kwargs: Any) -> str:
+ self.generate()
+ return self._bom_xml if indent is None else dom_parseString( # nosecc B318
+ self._bom_xml).toprettyxml(
+ indent=self.__make_indent(indent)
+ # do not set `encoding` - this would convert result to binary, not string
+ )
+
+ def get_target_namespace(self) -> str:
+ return f'http://cyclonedx.org/schema/bom/{self.get_schema_version()}'
+
+
+class XmlV1Dot0(Xml, SchemaVersion1Dot0):
+
+ def _create_bom_element(self) -> XmlElement:
+ return XmlElement('bom', {'xmlns': self.get_target_namespace(), 'version': '1'})
+
+
+class XmlV1Dot1(Xml, SchemaVersion1Dot1):
+ pass
+
+
+class XmlV1Dot2(Xml, SchemaVersion1Dot2):
+ pass
+
+
+class XmlV1Dot3(Xml, SchemaVersion1Dot3):
+ pass
+
+
+class XmlV1Dot4(Xml, SchemaVersion1Dot4):
+ pass
+
+
+class XmlV1Dot5(Xml, SchemaVersion1Dot5):
+ pass
+
+
+class XmlV1Dot6(Xml, SchemaVersion1Dot6):
+ pass
+
+
+BY_SCHEMA_VERSION: Dict[SchemaVersion, Type[Xml]] = {
+ SchemaVersion.V1_6: XmlV1Dot6,
+ SchemaVersion.V1_5: XmlV1Dot5,
+ SchemaVersion.V1_4: XmlV1Dot4,
+ SchemaVersion.V1_3: XmlV1Dot3,
+ SchemaVersion.V1_2: XmlV1Dot2,
+ SchemaVersion.V1_1: XmlV1Dot1,
+ SchemaVersion.V1_0: XmlV1Dot0,
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/py.typed b/Backend/venv/lib/python3.12/site-packages/cyclonedx/py.typed
new file mode 100644
index 00000000..1fd0ed8a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/py.typed
@@ -0,0 +1,2 @@
+# Marker file for PEP 561. This package uses inline types.
+# This file is needed to allow other packages to type-check their code against this package.
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__init__.py
new file mode 100644
index 00000000..0b74ec7d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__init__.py
@@ -0,0 +1,106 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from enum import Enum, auto, unique
+from typing import Any, Type, TypeVar
+
+
+@unique
+class OutputFormat(Enum):
+ """Output formats.
+
+ Cases are hashable.
+
+ Do not rely on the actual/literal values, just use enum cases, like so:
+ my_of = OutputFormat.XML
+ """
+
+ JSON = auto()
+ XML = auto()
+
+ def __hash__(self) -> int:
+ return hash(self.name)
+
+ def __eq__(self, other: Any) -> bool:
+ return self is other
+
+
+_SV = TypeVar('_SV', bound='SchemaVersion')
+
+
+@unique
+class SchemaVersion(Enum):
+ """
+ Schema version.
+
+ Cases are hashable.
+ Cases are comparable(!=,>=,>,==,<,<=)
+
+ Do not rely on the actual/literal values, just use enum cases, like so:
+ my_sv = SchemaVersion.V1_3
+ """
+
+ V1_6 = (1, 6)
+ V1_5 = (1, 5)
+ V1_4 = (1, 4)
+ V1_3 = (1, 3)
+ V1_2 = (1, 2)
+ V1_1 = (1, 1)
+ V1_0 = (1, 0)
+
+ @classmethod
+ def from_version(cls: Type[_SV], version: str) -> _SV:
+ """Return instance based of a version string - e.g. `1.4`"""
+ return cls(tuple(map(int, version.split('.')))[:2])
+
+ def to_version(self) -> str:
+ """Return as a version string - e.g. `1.4`"""
+ return '.'.join(map(str, self.value))
+
+ def __ne__(self, other: Any) -> bool:
+ if isinstance(other, self.__class__):
+ return self.value != other.value
+ return NotImplemented # pragma: no cover
+
+ def __lt__(self, other: Any) -> bool:
+ if isinstance(other, self.__class__):
+ return self.value < other.value
+ return NotImplemented # pragma: no cover
+
+ def __le__(self, other: Any) -> bool:
+ if isinstance(other, self.__class__):
+ return self.value <= other.value
+ return NotImplemented # pragma: no cover
+
+ def __eq__(self, other: Any) -> bool:
+ if isinstance(other, self.__class__):
+ return self.value == other.value
+ return NotImplemented # pragma: no cover
+
+ def __ge__(self, other: Any) -> bool:
+ if isinstance(other, self.__class__):
+ return self.value >= other.value
+ return NotImplemented # pragma: no cover
+
+ def __gt__(self, other: Any) -> bool:
+ if isinstance(other, self.__class__):
+ return self.value > other.value
+ return NotImplemented # pragma: no cover
+
+ def __hash__(self) -> int:
+ return hash(self.name)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..fa4f3f21
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__pycache__/schema.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__pycache__/schema.cpython-312.pyc
new file mode 100644
index 00000000..67dc5615
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/__pycache__/schema.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/README.md b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/README.md
new file mode 100644
index 00000000..9e68f815
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/README.md
@@ -0,0 +1,34 @@
+# Resources: Schema files
+
+some schema for offline use as download via [script](../../../tools/schema-downloader.py).
+original sources:
+
+Currently using version
+[8a27bfd1be5be0dcb2c208a34d2f4fa0b6d75bd7](https://github.com/CycloneDX/specification/commit/8a27bfd1be5be0dcb2c208a34d2f4fa0b6d75bd7)
+
+| file | note |
+|------|------|
+| [`bom-1.0.SNAPSHOT.xsd`](bom-1.0.SNAPSHOT.xsd) | applied changes: 1 |
+| [`bom-1.1.SNAPSHOT.xsd`](bom-1.1.SNAPSHOT.xsd) | applied changes: 1 |
+| [`bom-1.2.SNAPSHOT.xsd`](bom-1.2.SNAPSHOT.xsd) | applied changes: 1 |
+| [`bom-1.3.SNAPSHOT.xsd`](bom-1.3.SNAPSHOT.xsd) | applied changes: 1 |
+| [`bom-1.4.SNAPSHOT.xsd`](bom-1.4.SNAPSHOT.xsd) | applied changes: 1 |
+| [`bom-1.5.SNAPSHOT.xsd`](bom-1.5.SNAPSHOT.xsd) | applied changes: 1 |
+| [`bom-1.6.SNAPSHOT.xsd`](bom-1.6.SNAPSHOT.xsd) | applied changes: 1 |
+| [`bom-1.2.SNAPSHOT.schema.json`](bom-1.2.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`bom-1.3.SNAPSHOT.schema.json`](bom-1.3.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`bom-1.4.SNAPSHOT.schema.json`](bom-1.4.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`bom-1.5.SNAPSHOT.schema.json`](bom-1.5.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`bom-1.6.SNAPSHOT.schema.json`](bom-1.6.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`bom-1.2-strict.SNAPSHOT.schema.json`](bom-1.2-strict.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`bom-1.3-strict.SNAPSHOT.schema.json`](bom-1.3-strict.SNAPSHOT.schema.json) | applied changes: 2,3,4,5 |
+| [`spdx.SNAPSHOT.xsd`](spdx.SNAPSHOT.xsd) | |
+| [`spdx.SNAPSHOT.schema.json`](spdx.SNAPSHOT.schema.json) | |
+| [`jsf-0.82.SNAPSHOT.schema.json`](jsf-0.82.SNAPSHOT.schema.json) | |
+
+changes:
+1. `https?://cyclonedx.org/schema/spdx` was replaced with `spdx.SNAPSHOT.xsd`
+2. `spdx.schema.json` was replaced with `spdx.SNAPSHOT.schema.json`
+3. `jsf-0.82.schema.json` was replaced with `jsf-0.82.SNAPSHOT.schema.json`
+4. `properties.$schema.enum` was removed
+5. `required.version` removed, as it is actually optional with default value
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/__init__.py
new file mode 100644
index 00000000..8ce859cc
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/__init__.py
@@ -0,0 +1,68 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Content in here is internal, not for public use.
+Breaking changes without notice may happen.
+"""
+
+
+from os.path import dirname, join
+from typing import Dict, Optional
+
+from .. import SchemaVersion
+
+__DIR = dirname(__file__)
+
+BOM_XML: Dict[SchemaVersion, Optional[str]] = {
+ SchemaVersion.V1_6: join(__DIR, 'bom-1.6.SNAPSHOT.xsd'),
+ SchemaVersion.V1_5: join(__DIR, 'bom-1.5.SNAPSHOT.xsd'),
+ SchemaVersion.V1_4: join(__DIR, 'bom-1.4.SNAPSHOT.xsd'),
+ SchemaVersion.V1_3: join(__DIR, 'bom-1.3.SNAPSHOT.xsd'),
+ SchemaVersion.V1_2: join(__DIR, 'bom-1.2.SNAPSHOT.xsd'),
+ SchemaVersion.V1_1: join(__DIR, 'bom-1.1.SNAPSHOT.xsd'),
+ SchemaVersion.V1_0: join(__DIR, 'bom-1.0.SNAPSHOT.xsd'),
+}
+
+BOM_JSON: Dict[SchemaVersion, Optional[str]] = {
+ SchemaVersion.V1_6: join(__DIR, 'bom-1.6.SNAPSHOT.schema.json'),
+ SchemaVersion.V1_5: join(__DIR, 'bom-1.5.SNAPSHOT.schema.json'),
+ SchemaVersion.V1_4: join(__DIR, 'bom-1.4.SNAPSHOT.schema.json'),
+ SchemaVersion.V1_3: join(__DIR, 'bom-1.3.SNAPSHOT.schema.json'),
+ SchemaVersion.V1_2: join(__DIR, 'bom-1.2.SNAPSHOT.schema.json'),
+ # <= v1.1 is not defined in JSON
+ SchemaVersion.V1_1: None,
+ SchemaVersion.V1_0: None,
+}
+
+BOM_JSON_STRICT: Dict[SchemaVersion, Optional[str]] = {
+ SchemaVersion.V1_6: BOM_JSON[SchemaVersion.V1_6],
+ SchemaVersion.V1_5: BOM_JSON[SchemaVersion.V1_5],
+ SchemaVersion.V1_4: BOM_JSON[SchemaVersion.V1_4],
+ # <= 1.3 need special files
+ SchemaVersion.V1_3: join(__DIR, 'bom-1.3-strict.SNAPSHOT.schema.json'),
+ SchemaVersion.V1_2: join(__DIR, 'bom-1.2-strict.SNAPSHOT.schema.json'),
+ # <= v1.1 is not defined in JSON
+ SchemaVersion.V1_1: None,
+ SchemaVersion.V1_0: None,
+}
+
+SPDX_JSON = join(__DIR, 'spdx.SNAPSHOT.schema.json')
+SPDX_XML = join(__DIR, 'spdx.SNAPSHOT.xsd')
+
+JSF = join(__DIR, 'jsf-0.82.SNAPSHOT.schema.json')
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..91f200ab
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.0.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.0.SNAPSHOT.xsd
new file mode 100644
index 00000000..64d0e33f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.0.SNAPSHOT.xsd
@@ -0,0 +1,247 @@
+
+
+
+
+
+
+
+
+
+ The person(s) or organization(s) that published the component
+
+
+
+
+ The grouping name or identifier. This will often be a shortened, single
+ name of the company or project that produced the component, or the source package or
+ domain name. Whitespace and special characters should be avoided. Examples include:
+ apache, org.apache.commons, and apache.org.
+
+
+
+
+ The name of the component. This will often be a shortened, single name
+ of the component. Examples: commons-lang3 and jquery
+
+
+
+
+ The component version. The version should ideally comply with semantic versioning
+ but is not enforced.
+
+
+
+
+ Specifies a description for the component
+
+
+
+
+ Specifies the scope of the component. If scope is not specified, 'runtime'
+ scope will be assumed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license ID
+
+
+
+
+ If SPDX does not define the license used, this field may be used to provide the license name
+
+
+
+
+
+
+
+
+
+
+
+ An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.
+
+
+
+
+ Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe
+
+
+
+
+
+ Specifies the package-url (PURL). The purl, if specified, must be valid and conform
+ to the specification defined at: https://github.com/package-url/purl-spec
+
+
+
+
+
+
+ A boolean value indicating is the component has been modified from the original.
+ A value of true indicates the component is a derivative of the original.
+ A value of false indicates the component has not been modified from the original.
+
+
+
+
+
+
+ Specifies optional sub-components. This is not a dependency tree. It simply provides
+ an optional way to group large sets of components together.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the type of component. Software applications, libraries, frameworks, and
+ other dependencies should be classified as 'application'.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies the file hash of the component
+
+
+
+
+
+ Specifies the algorithm used to create hash
+
+
+
+
+
+
+
+
+
+
+ The component is required for runtime
+
+
+
+
+ The component is optional at runtime. Optional components are components that
+ are not capable of being called due to them not be installed or otherwise accessible by any means.
+ Components that are installed but due to configuration or other restrictions are prohibited from
+ being called must be scoped as 'required'.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats. Refer to https://nvd.nist.gov/products/cpe for official specification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ The version allows component publishers/authors to make changes to existing
+ BOMs to update various aspects of the document such as description or licenses. When a system
+ is presented with multiiple BOMs for the same component, the system should use the most recent
+ version of the BOM. The default version is '1' and should be incremented for each version of the
+ BOM that is published. Each version of a component should have a unique BOM and if no changes are
+ made to the BOMs, then each BOM will have a version of '1'.
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
\ No newline at end of file
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.1.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.1.SNAPSHOT.xsd
new file mode 100644
index 00000000..f21e9907
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.1.SNAPSHOT.xsd
@@ -0,0 +1,738 @@
+
+
+
+
+
+
+
+
+ CycloneDX Software Bill-of-Material Specification
+ https://cyclonedx.org/
+ Apache License, Version 2.0
+
+ Steve Springett
+
+
+
+
+
+
+ Identifier-DataType for interlinked elements.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The person(s) or organization(s) that published the component
+
+
+
+
+ The grouping name or identifier. This will often be a shortened, single
+ name of the company or project that produced the component, or the source package or
+ domain name. Whitespace and special characters should be avoided. Examples include:
+ apache, org.apache.commons, and apache.org.
+
+
+
+
+ The name of the component. This will often be a shortened, single name
+ of the component. Examples: commons-lang3 and jquery
+
+
+
+
+ The component version. The version should ideally comply with semantic versioning
+ but is not enforced.
+
+
+
+
+ Specifies a description for the component
+
+
+
+
+ Specifies the scope of the component. If scope is not specified, 'runtime'
+ scope should be assumed by the consumer of the BOM
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license expression.
+ Refer to https://spdx.org/specifications for syntax requirements
+
+
+
+
+
+
+
+ An optional copyright notice informing users of the underlying claims to
+ copyright ownership in a published work.
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version.
+ Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe
+
+
+
+
+
+
+ Specifies the package-url (PURL). The purl, if specified, must be valid and conform
+ to the specification defined at: https://github.com/package-url/purl-spec
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree
+ element instead to supply information on exactly how the component was modified.
+ A boolean value indicating is the component has been modified from the original.
+ A value of true indicates the component is a derivative of the original.
+ A value of false indicates the component has not been modified from the original.
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are
+ created, distributed, modified, redistributed, combined with other components, etc.
+
+
+
+
+
+ Provides the ability to document external references related to the
+ component or to the project the component describes.
+
+
+
+
+
+ Specifies optional sub-components. This is not a dependency tree. It provides a way
+ to specify a hierarchical representation of component assemblies, similar to
+ system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ Specifies the type of component. For software components, classify as application if no more
+ specific appropriate classification is available or cannot be determined for the component.
+ Valid choices are: application, framework, library, operating-system, device, or file
+ Refer to the bom:classification documentation for information describing each one
+
+
+
+
+
+
+ An optional identifier which can be used to reference the component elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ A valid SPDX license ID
+
+
+
+
+ If SPDX does not define the license used, this field may be used to provide the license name
+
+
+
+
+
+ Specifies the optional full text of the license
+
+
+
+
+ The URL to the license file. If specified, a 'license'
+ externalReference should also be specified for completeness.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ Specifies attributes of the license text
+
+
+
+ Specifies the content type of the license text. Defaults to text/plain
+ if not specified.
+
+
+
+
+
+ Specifies the optional encoding the license text is represented in
+
+
+
+
+
+
+
+
+
+ Specifies the file hash of the component
+
+
+
+
+
+ Specifies the algorithm used to create the hash
+
+
+
+
+
+
+
+
+
+
+ The component is required for runtime
+
+
+
+
+ The component is optional at runtime. Optional components are components that
+ are not capable of being called due to them not be installed or otherwise accessible by any means.
+ Components that are installed but due to configuration or other restrictions are prohibited from
+ being called must be scoped as 'required'.
+
+
+
+
+ Components that are excluded provide the ability to document component usage
+ for test and other non-runtime purposes. Excluded components are not reachable within a call
+ graph at runtime.
+
+
+
+
+
+
+
+
+
+ A software application. Refer to https://en.wikipedia.org/wiki/Application_software
+ for information about applications.
+
+
+
+
+ A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework
+ for information on how frameworks vary slightly from libraries.
+
+
+
+
+ A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing)
+ for information about libraries. All third-party and open source reusable components will likely
+ be a library. If the library also has key features of a framework, then it should be classified
+ as a framework. If not, or is unknown, then specifying library is recommended.
+
+
+
+
+ A software operating system without regard to deployment model
+ (i.e. installed on physical hardware, virtual machine, container image, etc) Refer to
+ https://en.wikipedia.org/wiki/Operating_system
+
+
+
+
+ A hardware device such as a processor, or chip-set. A hardware device
+ containing firmware should include a component for the physical hardware itself, and another
+ component of type 'application' or 'operating-system' (whichever is relevant), describing
+ information about the firmware.
+
+
+
+
+ A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file
+ for information about files.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats.
+ Refer to https://nvd.nist.gov/products/cpe for official specification.
+
+
+
+
+
+
+
+
+
+
+ Defines a string representation of a UUID conforming to RFC 4122.
+
+
+
+
+
+
+
+
+
+
+
+ Version Control System
+
+
+
+
+ Issue or defect tracking system, or an Application Lifecycle Management (ALM) system
+
+
+
+
+ Website
+
+
+
+
+ Security advisories
+
+
+
+
+ Bill-of-material document (CycloneDX, SPDX, SWID, etc)
+
+
+
+
+ Mailing list or discussion group
+
+
+
+
+ Social media account
+
+
+
+
+ Real-time chat platform
+
+
+
+
+ Documentation, guides, or how-to instructions
+
+
+
+
+ Community or commercial support
+
+
+
+
+ Direct or repository download location
+
+
+
+
+ The URL to the license file. If a license URL has been defined in the license
+ node, it should also be defined as an external reference for completeness
+
+
+
+
+ Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)
+
+
+
+
+ URL to an automated build system
+
+
+
+
+ Use this if no other types accurately describe the purpose of the external reference
+
+
+
+
+
+
+
+
+ External references provide a way to document systems, sites, and information that may be relevant
+ but which are not included with the BOM.
+
+
+
+
+
+ Zero or more external references can be defined
+
+
+
+
+
+
+
+
+
+ The URL to the external reference
+
+
+
+
+ An optional comment describing the external reference
+
+
+
+
+
+ Specifies the type of external reference. There are built-in types to describe common
+ references. If a type does not exist for the reference being referred to, use the "other" type.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Zero or more commits can be specified.
+
+
+
+
+ Specifies an individual commit.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of the commit. This may be version control
+ specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
+
+
+
+
+
+ The URL to the commit. This URL will typically point to a commit
+ in a version control system.
+
+
+
+
+
+ The author who created the changes in the commit
+
+
+
+
+ The person who committed or pushed the commit
+
+
+
+
+ The text description of the contents of the commit
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The timestamp in which the action occurred
+
+
+
+
+ The name of the individual who performed the action
+
+
+
+
+ The email address of the individual who performed the action
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are created,
+ distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing
+ this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to
+ document variants where the exact relation may not be known.
+
+
+
+
+
+ Describes zero or more components in which a component is derived
+ from. This is commonly used to describe forks from existing projects where the forked version
+ contains a ancestor node containing the original component it was forked from. For example,
+ Component A is the original component. Component B is the component being used and documented
+ in the BOM. However, Component B contains a pedigree node with a single ancestor documenting
+ Component A - the original component from which Component B is derived from.
+
+
+
+
+
+ Descendants are the exact opposite of ancestors. This provides a
+ way to document all forks (and their forks) of an original or root component.
+
+
+
+
+
+ Variants describe relations where the relationship between the
+ components are not known. For example, if Component A contains nearly identical code to
+ Component B. They are both related, but it is unclear if one is derived from the other,
+ or if they share a common ancestor.
+
+
+
+
+
+ A list of zero or more commits which provide a trail describing
+ how the component deviates from an ancestor, descendant, or variant.
+
+
+
+
+ Notes, observations, and other non-structured commentary
+ describing the components pedigree.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ The version allows component publishers/authors to make changes to existing
+ BOMs to update various aspects of the document such as description or licenses. When a system
+ is presented with multiple BOMs for the same component, the system should use the most recent
+ version of the BOM. The default version is '1' and should be incremented for each version of the
+ BOM that is published. Each version of a component should have a unique BOM and if no changes are
+ made to the BOMs, then each BOM will have a version of '1'.
+
+
+
+
+ Every BOM generated should have a unique serial number, even if the contents
+ of the BOM being generated have not changed over time. The process or tool responsible for
+ creating the BOM should create random UUID's for every BOM generated.
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2-strict.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2-strict.SNAPSHOT.schema.json
new file mode 100644
index 00000000..a36fb4b6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2-strict.SNAPSHOT.schema.json
@@ -0,0 +1,1025 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/bom-1.2b.schema.json",
+ "type": "object",
+ "title": "CycloneDX Software Bill-of-Material Specification",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "$schema": {
+ "type": "string"
+ },
+ "bomFormat": {
+ "$id": "#/properties/bomFormat",
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces.",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "$id": "#/properties/specVersion",
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification a BOM is written to (starting at version 1.2)",
+ "examples": ["1.2"]
+ },
+ "serialNumber": {
+ "$id": "#/properties/serialNumber",
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.",
+ "default": "",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "$id": "#/properties/version",
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.",
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$id": "#/properties/metadata",
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "$id": "#/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ },
+ "services": {
+ "$id": "#/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ },
+ "externalReferences": {
+ "$id": "#/properties/externalReferences",
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ },
+ "dependencies": {
+ "$id": "#/properties/dependencies",
+ "type": "array",
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency relationships."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "$comment": "Identifier-DataType for interlinked elements.",
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata Object",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used in the creation of the BOM.",
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Authors",
+ "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "title": "Manufacture",
+ "description": "The organization that manufactured the component that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacture, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "The tool used to create the BOM.",
+ "additionalProperties": false,
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "format": "string",
+ "title": "Tool Vendor",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "name": {
+ "type": "string",
+ "format": "string",
+ "title": "Tool Name",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "version": {
+ "type": "string",
+ "format": "string",
+ "title": "Tool Version",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "hashes": {
+ "$id": "#/definitions/tool/properties/hashes",
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the organization",
+ "default": "",
+ "examples": [
+ "Example Inc."
+ ],
+ "pattern": "^(.*)$"
+ },
+ "url": {
+ "type": "array",
+ "title": "URL",
+ "description": "The URL of the organization. Multiple URLs are allowed.",
+ "default": "",
+ "examples": ["https://example.com"],
+ "pattern": "^(.*)$"
+ },
+ "contact": {
+ "type": "array",
+ "title": "Contact",
+ "description": "A contact at the organization. Multiple contacts are allowed.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "default": "",
+ "examples": ["Contact name"],
+ "pattern": "^(.*)$"
+ },
+ "email": {
+ "type": "string",
+ "title": "Email Address",
+ "description": "The email address of the contact. Multiple email addresses are allowed.",
+ "default": "",
+ "examples": ["firstname.lastname@example.com"],
+ "pattern": "^(.*)$"
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact. Multiple phone numbers are allowed.",
+ "default": "",
+ "examples": ["800-555-1212"],
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component Object",
+ "required": [
+ "type",
+ "name",
+ "version"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "operating-system",
+ "device",
+ "firmware",
+ "file"
+ ],
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.",
+ "default": "",
+ "examples": ["library"],
+ "pattern": "^(.*)$"
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
+ "default": "",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref should be unique.",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The supplier may often be the manufacture, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "author": {
+ "type": "string",
+ "title": "Component Author",
+ "description": "The person(s) or organization(s) that authored the component",
+ "default": "",
+ "examples": ["Acme Inc"],
+ "pattern": "^(.*)$"
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the component",
+ "default": "",
+ "examples": ["Acme Inc"],
+ "pattern": "^(.*)$"
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "default": "",
+ "examples": ["com.acme"],
+ "pattern": "^(.*)$"
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "default": "",
+ "examples": ["tomcat-catalina"],
+ "pattern": "^(.*)$"
+ },
+ "version": {
+ "type": "string",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.",
+ "default": "",
+ "examples": ["9.0.14"],
+ "pattern": "^(.*)$"
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is not specified, 'required' scope should be assumed by the consumer of the BOM",
+ "default": "required",
+ "pattern": "^(.*)$"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "type": "array",
+ "title": "Component License(s)",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ],
+ "pattern": "^(.*)$"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ }
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"],
+ "pattern": "^(.*)$"
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Component Common Platform Enumeration (CPE)",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"],
+ "pattern": "^(.*)$"
+ },
+ "purl": {
+ "type": "string",
+ "title": "Component Package URL (purl)",
+ "default": "",
+ "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"],
+ "pattern": "^(.*)$"
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating is the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
+ "additionalProperties": false,
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured commentary describing the components pedigree.",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "components": {
+ "$id": "#/definitions/component/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "default": "The URL to the SWID file.",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
+ "default": "text/plain"
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is represented in.",
+ "enum": [
+ "base64"
+ ],
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data"
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ],
+ "title": "Hash Algorithm",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Content (value)",
+ "default": "",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License Object",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "$ref": "spdx.SNAPSHOT.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license ID",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "If SPDX does not define the license used, this field may be used to provide the license name",
+ "default": "",
+ "examples": ["Acme Software License"],
+ "pattern": "^(.*)$"
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.",
+ "pattern": "^(.*)$"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "title": "Type",
+ "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality"
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "title": "Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier of the issue assigned by the source of the issue",
+ "pattern": "^(.*)$"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the issue",
+ "pattern": "^(.*)$"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the issue",
+ "pattern": "^(.*)$"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'",
+ "pattern": "^(.*)$"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided by the source",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs are allowed.",
+ "default": "",
+ "examples": ["https://example.com"],
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action",
+ "pattern": "^(.*)$"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "Specifies an individual external reference",
+ "required": [
+ "url",
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the external reference",
+ "pattern": "^(.*)$"
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external reference",
+ "pattern": "^(.*)$"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "distribution",
+ "license",
+ "build-meta",
+ "build-system",
+ "other"
+ ]
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "title": "Reference",
+ "description": "References a component by the components bom-ref attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/refType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components that are dependencies of this dependency object."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service Object",
+ "required": [
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref should be unique.",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
+ "default": "",
+ "examples": ["com.acme"],
+ "pattern": "^(.*)$"
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a shortened, single name of the service.",
+ "default": "",
+ "examples": ["ticker-service"],
+ "pattern": "^(.*)$"
+ },
+ "version": {
+ "type": "string",
+ "title": "Service Version",
+ "description": "The service version.",
+ "default": "",
+ "examples": ["1.0.0"],
+ "pattern": "^(.*)$"
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "endpoints": {
+ "type": "array",
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
+ "default": "",
+ "examples": ["https://example.com/api/v1/ticker"],
+ "pattern": "^(.*)$"
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/dataClassification"},
+ "title": "Data Classification",
+ "description": "Specifies the data classification."
+ },
+ "licenses": {
+ "type": "array",
+ "title": "Component License(s)",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ],
+ "pattern": "^(.*)$"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "services": {
+ "$id": "#/definitions/service/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlow"
+ },
+ "classification": {
+ "type": "string"
+ }
+ }
+ },
+ "dataFlow": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "title": "Data flow direction",
+ "default": "",
+ "pattern": "^(.*)$"
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2.SNAPSHOT.schema.json
new file mode 100644
index 00000000..d23f683b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2.SNAPSHOT.schema.json
@@ -0,0 +1,1000 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/bom-1.2b.schema.json",
+ "type": "object",
+ "title": "CycloneDX Software Bill-of-Material Specification",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion"
+ ],
+ "properties": {
+ "bomFormat": {
+ "$id": "#/properties/bomFormat",
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces.",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "$id": "#/properties/specVersion",
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification a BOM is written to (starting at version 1.2)",
+ "examples": ["1.2"]
+ },
+ "serialNumber": {
+ "$id": "#/properties/serialNumber",
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.",
+ "default": "",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "$id": "#/properties/version",
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.",
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$id": "#/properties/metadata",
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "$id": "#/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ },
+ "services": {
+ "$id": "#/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ },
+ "externalReferences": {
+ "$id": "#/properties/externalReferences",
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ },
+ "dependencies": {
+ "$id": "#/properties/dependencies",
+ "type": "array",
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency relationships."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "$comment": "Identifier-DataType for interlinked elements.",
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata Object",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used in the creation of the BOM.",
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Authors",
+ "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "title": "Manufacture",
+ "description": "The organization that manufactured the component that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacture, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "The tool used to create the BOM.",
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "format": "string",
+ "title": "Tool Vendor",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "name": {
+ "type": "string",
+ "format": "string",
+ "title": "Tool Name",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "version": {
+ "type": "string",
+ "format": "string",
+ "title": "Tool Version",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "hashes": {
+ "$id": "#/definitions/tool/properties/hashes",
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity Object",
+ "description": "",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the organization",
+ "default": "",
+ "examples": [
+ "Example Inc."
+ ],
+ "pattern": "^(.*)$"
+ },
+ "url": {
+ "type": "array",
+ "title": "URL",
+ "description": "The URL of the organization. Multiple URLs are allowed.",
+ "default": "",
+ "examples": ["https://example.com"],
+ "pattern": "^(.*)$"
+ },
+ "contact": {
+ "type": "array",
+ "title": "Contact",
+ "description": "A contact at the organization. Multiple contacts are allowed.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact Object",
+ "description": "",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "default": "",
+ "examples": ["Contact name"],
+ "pattern": "^(.*)$"
+ },
+ "email": {
+ "type": "string",
+ "title": "Email Address",
+ "description": "The email address of the contact. Multiple email addresses are allowed.",
+ "default": "",
+ "examples": ["firstname.lastname@example.com"],
+ "pattern": "^(.*)$"
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact. Multiple phone numbers are allowed.",
+ "default": "",
+ "examples": ["800-555-1212"],
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component Object",
+ "required": [
+ "type",
+ "name",
+ "version"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "operating-system",
+ "device",
+ "firmware",
+ "file"
+ ],
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.",
+ "default": "",
+ "examples": ["library"],
+ "pattern": "^(.*)$"
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
+ "default": "",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref should be unique.",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The supplier may often be the manufacture, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "author": {
+ "type": "string",
+ "title": "Component Author",
+ "description": "The person(s) or organization(s) that authored the component",
+ "default": "",
+ "examples": ["Acme Inc"],
+ "pattern": "^(.*)$"
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the component",
+ "default": "",
+ "examples": ["Acme Inc"],
+ "pattern": "^(.*)$"
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "default": "",
+ "examples": ["com.acme"],
+ "pattern": "^(.*)$"
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "default": "",
+ "examples": ["tomcat-catalina"],
+ "pattern": "^(.*)$"
+ },
+ "version": {
+ "type": "string",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.",
+ "default": "",
+ "examples": ["9.0.14"],
+ "pattern": "^(.*)$"
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is not specified, 'required' scope should be assumed by the consumer of the BOM",
+ "default": "required",
+ "pattern": "^(.*)$"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "type": "array",
+ "title": "Component License(s)",
+ "items": {
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ],
+ "pattern": "^(.*)$"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ }
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"],
+ "pattern": "^(.*)$"
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Component Common Platform Enumeration (CPE)",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"],
+ "pattern": "^(.*)$"
+ },
+ "purl": {
+ "type": "string",
+ "title": "Component Package URL (purl)",
+ "default": "",
+ "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"],
+ "pattern": "^(.*)$"
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating is the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured commentary describing the components pedigree.",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "components": {
+ "$id": "#/definitions/component/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "default": "The URL to the SWID file.",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
+ "default": "text/plain"
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is represented in.",
+ "enum": [
+ "base64"
+ ],
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data"
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ],
+ "title": "Hash Algorithm",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Content (value)",
+ "default": "",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License Object",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "properties": {
+ "id": {
+ "$ref": "spdx.SNAPSHOT.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license ID",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "If SPDX does not define the license used, this field may be used to provide the license name",
+ "default": "",
+ "examples": ["Acme Software License"],
+ "pattern": "^(.*)$"
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.",
+ "pattern": "^(.*)$"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "title": "Type",
+ "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality"
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "title": "Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier of the issue assigned by the source of the issue",
+ "pattern": "^(.*)$"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the issue",
+ "pattern": "^(.*)$"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the issue",
+ "pattern": "^(.*)$"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'",
+ "pattern": "^(.*)$"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided by the source",
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs are allowed.",
+ "default": "",
+ "examples": ["https://example.com"],
+ "pattern": "^(.*)$"
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action",
+ "pattern": "^(.*)$"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "Specifies an individual external reference",
+ "required": [
+ "url",
+ "type"
+ ],
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the external reference",
+ "pattern": "^(.*)$"
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external reference",
+ "pattern": "^(.*)$"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "distribution",
+ "license",
+ "build-meta",
+ "build-system",
+ "other"
+ ]
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.",
+ "required": [
+ "ref"
+ ],
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "format": "string",
+ "title": "Reference",
+ "description": "References a component by the components bom-ref attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/refType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components that are dependencies of this dependency object."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service Object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref should be unique.",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
+ "default": "",
+ "examples": ["com.acme"],
+ "pattern": "^(.*)$"
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a shortened, single name of the service.",
+ "default": "",
+ "examples": ["ticker-service"],
+ "pattern": "^(.*)$"
+ },
+ "version": {
+ "type": "string",
+ "title": "Service Version",
+ "description": "The service version.",
+ "default": "",
+ "examples": ["1.0.0"],
+ "pattern": "^(.*)$"
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service",
+ "default": "",
+ "pattern": "^(.*)$"
+ },
+ "endpoints": {
+ "type": "array",
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
+ "default": "",
+ "examples": ["https://example.com/api/v1/ticker"],
+ "pattern": "^(.*)$"
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/dataClassification"},
+ "title": "Data Classification",
+ "description": "Specifies the data classification."
+ },
+ "licenses": {
+ "type": "array",
+ "title": "Component License(s)",
+ "items": {
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ],
+ "pattern": "^(.*)$"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "services": {
+ "$id": "#/definitions/service/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlow"
+ },
+ "classification": {
+ "type": "string"
+ }
+ }
+ },
+ "dataFlow": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "title": "Data flow direction",
+ "default": "",
+ "pattern": "^(.*)$"
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2.SNAPSHOT.xsd
new file mode 100644
index 00000000..763e6ee6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.2.SNAPSHOT.xsd
@@ -0,0 +1,1425 @@
+
+
+
+
+
+
+
+
+ CycloneDX Software Bill-of-Material Specification
+ https://cyclonedx.org/
+ Apache License, Version 2.0
+
+ Steve Springett
+
+
+
+
+
+
+ Identifier-DataType for interlinked elements.
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the document was created.
+
+
+
+
+ The tool(s) used in the creation of the BOM.
+
+
+
+
+
+
+
+
+
+ The person(s) who created the BOM. Authors are common in BOMs created through
+ manual processes. BOMs created through automated means may not have authors.
+
+
+
+
+
+
+
+
+
+ The component that the BOM describes.
+
+
+
+
+ The organization that manufactured the component that the BOM describes.
+
+
+
+
+ The organization that supplied the component that the BOM describes. The
+ supplier may often be the manufacture, but may also be a distributor or repackager.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the organization
+
+
+
+
+ The URL of the organization. Multiple URLs are allowed.
+
+
+
+
+ A contact person at the organization. Multiple contacts are allowed.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies a tool (manual or automated).
+
+
+
+
+ The vendor of the tool used to create the BOM.
+
+
+
+
+ The name of the tool used to create the BOM.
+
+
+
+
+ The version of the tool used to create the BOM.
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the contact
+
+
+
+
+ The email address of the contact. Multiple email addresses are allowed.
+
+
+
+
+ The phone number of the contact. Multiple phone numbers are allowed.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that supplied the component. The supplier may often
+ be the manufacture, but may also be a distributor or repackager.
+
+
+
+
+ The person(s) or organization(s) that authored the component
+
+
+
+
+ The person(s) or organization(s) that published the component
+
+
+
+
+ The grouping name or identifier. This will often be a shortened, single
+ name of the company or project that produced the component, or the source package or
+ domain name. Whitespace and special characters should be avoided. Examples include:
+ apache, org.apache.commons, and apache.org.
+
+
+
+
+ The name of the component. This will often be a shortened, single name
+ of the component. Examples: commons-lang3 and jquery
+
+
+
+
+ The component version. The version should ideally comply with semantic versioning
+ but is not enforced.
+
+
+
+
+ Specifies a description for the component
+
+
+
+
+ Specifies the scope of the component. If scope is not specified, 'runtime'
+ scope should be assumed by the consumer of the BOM
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license expression.
+ Refer to https://spdx.org/specifications for syntax requirements
+
+
+
+
+
+
+
+ An optional copyright notice informing users of the underlying claims to
+ copyright ownership in a published work.
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version.
+ Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe
+
+
+
+
+
+
+ Specifies the package-url (PURL). The purl, if specified, must be valid and conform
+ to the specification defined at: https://github.com/package-url/purl-spec
+
+
+
+
+
+
+ Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree
+ element instead to supply information on exactly how the component was modified.
+ A boolean value indicating is the component has been modified from the original.
+ A value of true indicates the component is a derivative of the original.
+ A value of false indicates the component has not been modified from the original.
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are
+ created, distributed, modified, redistributed, combined with other components, etc.
+
+
+
+
+
+ Provides the ability to document external references related to the
+ component or to the project the component describes.
+
+
+
+
+
+ Specifies optional sub-components. This is not a dependency tree. It provides a way
+ to specify a hierarchical representation of component assemblies, similar to
+ system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ Specifies the type of component. For software components, classify as application if no more
+ specific appropriate classification is available or cannot be determined for the component.
+
+
+
+
+
+
+ The optional mime-type of the component. When used on file components, the mime-type
+ can provide additional context about the kind of file being represented such as an image,
+ font, or executable. Some library or framework components may also have an associated mime-type.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the component elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ A valid SPDX license ID
+
+
+
+
+ If SPDX does not define the license used, this field may be used to provide the license name
+
+
+
+
+
+ Specifies the optional full text of the attachment
+
+
+
+
+ The URL to the attachment file. If the attachment is a license or BOM,
+ an externalReference should also be specified for completeness.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ Specifies attributes of the text
+
+
+
+ Specifies the content type of the text. Defaults to text/plain
+ if not specified.
+
+
+
+
+
+ Specifies the optional encoding the text is represented in
+
+
+
+
+
+
+
+
+
+ Specifies the file hash of the component
+
+
+
+
+
+ Specifies the algorithm used to create the hash
+
+
+
+
+
+
+
+
+
+
+ The component is required for runtime
+
+
+
+
+ The component is optional at runtime. Optional components are components that
+ are not capable of being called due to them not be installed or otherwise accessible by any means.
+ Components that are installed but due to configuration or other restrictions are prohibited from
+ being called must be scoped as 'required'.
+
+
+
+
+ Components that are excluded provide the ability to document component usage
+ for test and other non-runtime purposes. Excluded components are not reachable within a call
+ graph at runtime.
+
+
+
+
+
+
+
+
+
+ A software application. Refer to https://en.wikipedia.org/wiki/Application_software
+ for information about applications.
+
+
+
+
+ A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework
+ for information on how frameworks vary slightly from libraries.
+
+
+
+
+ A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing)
+ for information about libraries. All third-party and open source reusable components will likely
+ be a library. If the library also has key features of a framework, then it should be classified
+ as a framework. If not, or is unknown, then specifying library is recommended.
+
+
+
+
+ A packaging and/or runtime format, not specific to any particular technology,
+ which isolates software inside the container from software outside of a container through
+ virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization
+
+
+
+
+ A software operating system without regard to deployment model
+ (i.e. installed on physical hardware, virtual machine, image, etc) Refer to
+ https://en.wikipedia.org/wiki/Operating_system
+
+
+
+
+ A hardware device such as a processor, or chip-set. A hardware device
+ containing firmware should include a component for the physical hardware itself, and another
+ component of type 'firmware' or 'operating-system' (whichever is relevant), describing
+ information about the software running on the device.
+
+
+
+
+ A special type of software that provides low-level control over a devices
+ hardware. Refer to https://en.wikipedia.org/wiki/Firmware
+
+
+
+
+ A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file
+ for information about files.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats.
+ Refer to https://nvd.nist.gov/products/cpe for official specification.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the full content of the SWID tag.
+
+
+
+
+ The URL to the SWID file.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Maps to the tagId of a SoftwareIdentity.
+
+
+
+
+ Maps to the name of a SoftwareIdentity.
+
+
+
+
+ Maps to the version of a SoftwareIdentity.
+
+
+
+
+ Maps to the tagVersion of a SoftwareIdentity.
+
+
+
+
+ Maps to the patch of a SoftwareIdentity.
+
+
+
+
+
+
+
+ Defines a string representation of a UUID conforming to RFC 4122.
+
+
+
+
+
+
+
+
+
+
+
+ Version Control System
+
+
+
+
+ Issue or defect tracking system, or an Application Lifecycle Management (ALM) system
+
+
+
+
+ Website
+
+
+
+
+ Security advisories
+
+
+
+
+ Bill-of-material document (CycloneDX, SPDX, SWID, etc)
+
+
+
+
+ Mailing list or discussion group
+
+
+
+
+ Social media account
+
+
+
+
+ Real-time chat platform
+
+
+
+
+ Documentation, guides, or how-to instructions
+
+
+
+
+ Community or commercial support
+
+
+
+
+ Direct or repository download location
+
+
+
+
+ The URL to the license file. If a license URL has been defined in the license
+ node, it should also be defined as an external reference for completeness
+
+
+
+
+ Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)
+
+
+
+
+ URL to an automated build system
+
+
+
+
+ Use this if no other types accurately describe the purpose of the external reference
+
+
+
+
+
+
+
+
+ External references provide a way to document systems, sites, and information that may be relevant
+ but which are not included with the BOM.
+
+
+
+
+
+ Zero or more external references can be defined
+
+
+
+
+
+
+
+
+
+ The URL to the external reference
+
+
+
+
+ An optional comment describing the external reference
+
+
+
+
+
+ Specifies the type of external reference. There are built-in types to describe common
+ references. If a type does not exist for the reference being referred to, use the "other" type.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Zero or more commits can be specified.
+
+
+
+
+ Specifies an individual commit.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of the commit. This may be version control
+ specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
+
+
+
+
+
+ The URL to the commit. This URL will typically point to a commit
+ in a version control system.
+
+
+
+
+
+ The author who created the changes in the commit
+
+
+
+
+ The person who committed or pushed the commit
+
+
+
+
+ The text description of the contents of the commit
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Zero or more patches can be specified.
+
+
+
+
+ Specifies an individual patch.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The patch file (or diff) that show changes.
+ Refer to https://en.wikipedia.org/wiki/Diff
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the purpose for the patch including the resolution of defects,
+ security issues, or new behavior or functionality
+
+
+
+
+
+
+
+
+ A patch which is not developed by the creators or maintainers of the software
+ being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch
+
+
+
+
+ A patch which dynamically modifies runtime behavior.
+ Refer to https://en.wikipedia.org/wiki/Monkey_patch
+
+
+
+
+ A patch which takes code from a newer version of software and applies
+ it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting
+
+
+
+
+ A patch created by selectively applying commits from other versions or
+ branches of the same software.
+
+
+
+
+
+
+
+
+
+ A fault, flaw, or bug in software
+
+
+
+
+ A new feature or behavior in software
+
+
+
+
+ A special type of defect which impacts security
+
+
+
+
+
+
+
+
+
+ Specifies the optional text of the diff
+
+
+
+
+ Specifies the URL to the diff
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The identifier of the issue assigned by the source of the issue
+
+
+
+
+ The name of the issue
+
+
+
+
+ A description of the issue
+
+
+
+
+
+
+ The source of the issue where it is documented.
+
+
+
+
+
+
+ The name of the source. For example "National Vulnerability Database",
+ "NVD", and "Apache"
+
+
+
+
+
+
+ The url of the issue documentation as provided by the source
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the type of issue
+
+
+
+
+
+
+
+
+ The timestamp in which the action occurred
+
+
+
+
+ The name of the individual who performed the action
+
+
+
+
+ The email address of the individual who performed the action
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are created,
+ distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing
+ this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to
+ document variants where the exact relation may not be known.
+
+
+
+
+
+ Describes zero or more components in which a component is derived
+ from. This is commonly used to describe forks from existing projects where the forked version
+ contains a ancestor node containing the original component it was forked from. For example,
+ Component A is the original component. Component B is the component being used and documented
+ in the BOM. However, Component B contains a pedigree node with a single ancestor documenting
+ Component A - the original component from which Component B is derived from.
+
+
+
+
+
+ Descendants are the exact opposite of ancestors. This provides a
+ way to document all forks (and their forks) of an original or root component.
+
+
+
+
+
+ Variants describe relations where the relationship between the
+ components are not known. For example, if Component A contains nearly identical code to
+ Component B. They are both related, but it is unclear if one is derived from the other,
+ or if they share a common ancestor.
+
+
+
+
+
+ A list of zero or more commits which provide a trail describing
+ how the component deviates from an ancestor, descendant, or variant.
+
+
+
+
+ A list of zero or more patches describing how the component
+ deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits
+ or may be used in place of commits.
+
+
+
+
+ Notes, observations, and other non-structured commentary
+ describing the components pedigree.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+ References a component or service by the its bom-ref attribute
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Components that do not have their own dependencies MUST be declared as empty
+ elements within the graph. Components that are not represented in the dependency graph MAY
+ have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque
+ and not an indicator of a component being dependency-free.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that provides the service.
+
+
+
+
+ The grouping name, namespace, or identifier. This will often be a shortened,
+ single name of the company or project that produced the service or domain name.
+ Whitespace and special characters should be avoided.
+
+
+
+
+ The name of the service. This will often be a shortened, single name
+ of the service.
+
+
+
+
+ The service version.
+
+
+
+
+ Specifies a description for the service.
+
+
+
+
+
+
+
+ A service endpoint URI.
+
+
+
+
+
+
+
+ A boolean value indicating if the service requires authentication.
+ A value of true indicates the service requires authentication prior to use.
+ A value of false indicates the service does not require authentication.
+
+
+
+
+ A boolean value indicating if use of the service crosses a trust zone or boundary.
+ A value of true indicates that by using the service, a trust boundary is crossed.
+ A value of false indicates that by using the service, a trust boundary is not crossed.
+
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license expression.
+ Refer to https://spdx.org/specifications for syntax requirements
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the service.
+
+
+
+
+
+ Specifies optional sub-service. This is not a dependency tree. It provides a way
+ to specify a hierarchical representation of service assemblies, similar to
+ system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the service elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ Specifies the flow direction of the data.
+
+
+
+
+
+
+
+
+ Specifies the flow direction of the data. Valid values are:
+ inbound, outbound, bi-directional, and unknown. Direction is relative to the service.
+ Inbound flow states that data enters the service. Outbound flow states that data
+ leaves the service. Bi-directional states that data flows both ways, and unknown
+ states that the direction is not known.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Provides additional information about a BOM.
+
+
+
+
+ Provides the ability to document a list of components.
+
+
+
+
+ Provides the ability to document a list of external services.
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+ Provides the ability to document dependency relationships.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ The version allows component publishers/authors to make changes to existing
+ BOMs to update various aspects of the document such as description or licenses. When a system
+ is presented with multiple BOMs for the same component, the system should use the most recent
+ version of the BOM. The default version is '1' and should be incremented for each version of the
+ BOM that is published. Each version of a component should have a unique BOM and if no changes are
+ made to the BOMs, then each BOM will have a version of '1'.
+
+
+
+
+ Every BOM generated should have a unique serial number, even if the contents
+ of the BOM being generated have not changed over time. The process or tool responsible for
+ creating the BOM should create random UUID's for every BOM generated.
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3-strict.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3-strict.SNAPSHOT.schema.json
new file mode 100644
index 00000000..3f1b82d9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3-strict.SNAPSHOT.schema.json
@@ -0,0 +1,1085 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/bom-1.3a.schema.json",
+ "type": "object",
+ "title": "CycloneDX Software Bill-of-Material Specification",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "$schema": {
+ "type": "string"
+ },
+ "bomFormat": {
+ "$id": "#/properties/bomFormat",
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces.",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "$id": "#/properties/specVersion",
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification a BOM is written to (starting at version 1.2)",
+ "examples": ["1.3"]
+ },
+ "serialNumber": {
+ "$id": "#/properties/serialNumber",
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "$id": "#/properties/version",
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.",
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$id": "#/properties/metadata",
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "$id": "#/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ },
+ "services": {
+ "$id": "#/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ },
+ "externalReferences": {
+ "$id": "#/properties/externalReferences",
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ },
+ "dependencies": {
+ "$id": "#/properties/dependencies",
+ "type": "array",
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency relationships."
+ },
+ "compositions": {
+ "$id": "#/properties/compositions",
+ "type": "array",
+ "items": {"$ref": "#/definitions/compositions"},
+ "uniqueItems": true,
+ "title": "Compositions",
+ "description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "$comment": "Identifier-DataType for interlinked elements.",
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata Object",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used in the creation of the BOM.",
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Authors",
+ "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "title": "Manufacture",
+ "description": "The organization that manufactured the component that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "licenses": {
+ "type": "array",
+ "title": "BOM License(s)",
+ "items": {"$ref": "#/definitions/licenseChoice"}
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "The tool used to create the BOM.",
+ "additionalProperties": false,
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "title": "Tool Vendor",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "name": {
+ "type": "string",
+ "title": "Tool Name",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "version": {
+ "type": "string",
+ "title": "Tool Version",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "hashes": {
+ "$id": "#/definitions/tool/properties/hashes",
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the organization",
+ "examples": [
+ "Example Inc."
+ ]
+ },
+ "url": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "URL",
+ "description": "The URL of the organization. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ },
+ "contact": {
+ "type": "array",
+ "title": "Contact",
+ "description": "A contact at the organization. Multiple contacts are allowed.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "examples": ["Contact name"]
+ },
+ "email": {
+ "type": "string",
+ "title": "Email Address",
+ "description": "The email address of the contact.",
+ "examples": ["firstname.lastname@example.com"]
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact.",
+ "examples": ["800-555-1212"]
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component Object",
+ "required": [
+ "type",
+ "name",
+ "version"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "operating-system",
+ "device",
+ "firmware",
+ "file"
+ ],
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.",
+ "examples": ["library"]
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref should be unique."
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "author": {
+ "type": "string",
+ "title": "Component Author",
+ "description": "The person(s) or organization(s) that authored the component",
+ "examples": ["Acme Inc"]
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the component",
+ "examples": ["Acme Inc"]
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "examples": ["tomcat-catalina"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.",
+ "examples": ["9.0.14"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is not specified, 'required' scope should be assumed by the consumer of the BOM",
+ "default": "required"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"]
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Component Common Platform Enumeration (CPE)",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]
+ },
+ "purl": {
+ "type": "string",
+ "title": "Component Package URL (purl)",
+ "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"]
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating is the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
+ "additionalProperties": false,
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured commentary describing the components pedigree."
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "components": {
+ "$id": "#/definitions/component/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ },
+ "evidence": {
+ "$ref": "#/definitions/componentEvidence",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the SWID file.",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
+ "default": "text/plain"
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is represented in.",
+ "enum": [
+ "base64"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data"
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ],
+ "title": "Hash Algorithm"
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Content (value)",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License Object",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "$ref": "spdx.SNAPSHOT.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license ID",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "If SPDX does not define the license used, this field may be used to provide the license name",
+ "examples": ["Acme Software License"]
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+ "format": "iri-reference"
+ }
+ }
+ },
+ "licenseChoice": {
+ "type": "object",
+ "title": "License(s)",
+ "additionalProperties": false,
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ]
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "title": "Type",
+ "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality"
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "title": "Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier of the issue assigned by the source of the issue"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the issue"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the issue"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided by the source",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "Specifies an individual external reference",
+ "required": [
+ "url",
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the external reference",
+ "format": "iri-reference"
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external reference"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "distribution",
+ "license",
+ "build-meta",
+ "build-system",
+ "other"
+ ]
+ },
+ "hashes": {
+ "$id": "#/definitions/externalReference/properties/hashes",
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the external reference (if applicable)."
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "title": "Reference",
+ "description": "References a component by the components bom-ref attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/refType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components that are dependencies of this dependency object."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service Object",
+ "required": [
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref should be unique."
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a shortened, single name of the service.",
+ "examples": ["ticker-service"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Service Version",
+ "description": "The service version.",
+ "examples": ["1.0.0"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service"
+ },
+ "endpoints": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
+ "examples": ["https://example.com/api/v1/ticker"]
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/dataClassification"},
+ "title": "Data Classification",
+ "description": "Specifies the data classification."
+ },
+ "licenses": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "services": {
+ "$id": "#/definitions/service/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlow"
+ },
+ "classification": {
+ "type": "string"
+ }
+ }
+ },
+ "dataFlow": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "title": "Data flow direction"
+ },
+
+ "copyright": {
+ "type": "object",
+ "title": "Copyright",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string",
+ "title": "Copyright Text"
+ }
+ }
+ },
+
+ "componentEvidence": {
+ "type": "object",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis.",
+ "additionalProperties": false,
+ "properties": {
+ "licenses": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/copyright"},
+ "title": "Copyright"
+ }
+ }
+ },
+ "compositions": {
+ "type": "object",
+ "title": "Compositions",
+ "required": [
+ "aggregate"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "aggregate": {
+ "$ref": "#/definitions/aggregateType",
+ "title": "Aggregate",
+ "description": "Specifies an aggregate type that describe how complete a relationship is."
+ },
+ "assemblies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only."
+ },
+ "dependencies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only."
+ }
+ }
+ },
+ "aggregateType": {
+ "type": "string",
+ "default": "not_specified",
+ "enum": [
+ "complete",
+ "incomplete",
+ "incomplete_first_party_only",
+ "incomplete_third_party_only",
+ "unknown",
+ "not_specified"
+ ]
+ },
+ "property": {
+ "type": "object",
+ "title": "Lightweight name-value pair",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the property. Duplicate names are allowed, each potentially having a different value."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value of the property."
+ }
+ }
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3.SNAPSHOT.schema.json
new file mode 100644
index 00000000..a269ebd7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3.SNAPSHOT.schema.json
@@ -0,0 +1,1057 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/bom-1.3a.schema.json",
+ "type": "object",
+ "title": "CycloneDX Software Bill-of-Material Specification",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion"
+ ],
+ "properties": {
+ "bomFormat": {
+ "$id": "#/properties/bomFormat",
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces.",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "$id": "#/properties/specVersion",
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification a BOM is written to (starting at version 1.2)",
+ "examples": ["1.3"]
+ },
+ "serialNumber": {
+ "$id": "#/properties/serialNumber",
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "$id": "#/properties/version",
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.",
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$id": "#/properties/metadata",
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "$id": "#/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ },
+ "services": {
+ "$id": "#/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ },
+ "externalReferences": {
+ "$id": "#/properties/externalReferences",
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ },
+ "dependencies": {
+ "$id": "#/properties/dependencies",
+ "type": "array",
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency relationships."
+ },
+ "compositions": {
+ "$id": "#/properties/compositions",
+ "type": "array",
+ "items": {"$ref": "#/definitions/compositions"},
+ "uniqueItems": true,
+ "title": "Compositions",
+ "description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "$comment": "Identifier-DataType for interlinked elements.",
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata Object",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used in the creation of the BOM.",
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Authors",
+ "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "title": "Manufacture",
+ "description": "The organization that manufactured the component that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "licenses": {
+ "type": "array",
+ "title": "BOM License(s)",
+ "items": {"$ref": "#/definitions/licenseChoice"}
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "The tool used to create the BOM.",
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "title": "Tool Vendor",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "name": {
+ "type": "string",
+ "title": "Tool Name",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "version": {
+ "type": "string",
+ "title": "Tool Version",
+ "description": "The date and time (timestamp) when the document was created."
+ },
+ "hashes": {
+ "$id": "#/definitions/tool/properties/hashes",
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity Object",
+ "description": "",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the organization",
+ "examples": [
+ "Example Inc."
+ ]
+ },
+ "url": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "URL",
+ "description": "The URL of the organization. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ },
+ "contact": {
+ "type": "array",
+ "title": "Contact",
+ "description": "A contact at the organization. Multiple contacts are allowed.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact Object",
+ "description": "",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "examples": ["Contact name"]
+ },
+ "email": {
+ "type": "string",
+ "title": "Email Address",
+ "description": "The email address of the contact.",
+ "examples": ["firstname.lastname@example.com"]
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact.",
+ "examples": ["800-555-1212"]
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component Object",
+ "required": [
+ "type",
+ "name",
+ "version"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "operating-system",
+ "device",
+ "firmware",
+ "file"
+ ],
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.",
+ "examples": ["library"]
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref should be unique."
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "author": {
+ "type": "string",
+ "title": "Component Author",
+ "description": "The person(s) or organization(s) that authored the component",
+ "examples": ["Acme Inc"]
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the component",
+ "examples": ["Acme Inc"]
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "examples": ["tomcat-catalina"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.",
+ "examples": ["9.0.14"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is not specified, 'required' scope should be assumed by the consumer of the BOM",
+ "default": "required"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "An optional copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"]
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Component Common Platform Enumeration (CPE)",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]
+ },
+ "purl": {
+ "type": "string",
+ "title": "Component Package URL (purl)",
+ "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"]
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating is the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured commentary describing the components pedigree."
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "components": {
+ "$id": "#/definitions/component/properties/components",
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components"
+ },
+ "evidence": {
+ "$ref": "#/definitions/componentEvidence",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the SWID file.",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
+ "default": "text/plain"
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is represented in.",
+ "enum": [
+ "base64"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data"
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ],
+ "title": "Hash Algorithm"
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Content (value)",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License Object",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "properties": {
+ "id": {
+ "$ref": "spdx.SNAPSHOT.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license ID",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "If SPDX does not define the license used, this field may be used to provide the license name",
+ "examples": ["Acme Software License"]
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+ "format": "iri-reference"
+ }
+ }
+ },
+ "licenseChoice": {
+ "type": "object",
+ "title": "License(s)",
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ]
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "title": "Type",
+ "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality"
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "title": "Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier of the issue assigned by the source of the issue"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the issue"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the issue"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided by the source",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "Specifies an individual external reference",
+ "required": [
+ "url",
+ "type"
+ ],
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the external reference",
+ "format": "iri-reference"
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external reference"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "distribution",
+ "license",
+ "build-meta",
+ "build-system",
+ "other"
+ ]
+ },
+ "hashes": {
+ "$id": "#/definitions/externalReference/properties/hashes",
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the external reference (if applicable)."
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.",
+ "required": [
+ "ref"
+ ],
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "title": "Reference",
+ "description": "References a component by the components bom-ref attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/refType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components that are dependencies of this dependency object."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service Object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref should be unique."
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a shortened, single name of the service.",
+ "examples": ["ticker-service"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Service Version",
+ "description": "The service version.",
+ "examples": ["1.0.0"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service"
+ },
+ "endpoints": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
+ "examples": ["https://example.com/api/v1/ticker"]
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/dataClassification"},
+ "title": "Data Classification",
+ "description": "Specifies the data classification."
+ },
+ "licenses": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References"
+ },
+ "services": {
+ "$id": "#/definitions/service/properties/services",
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlow"
+ },
+ "classification": {
+ "type": "string"
+ }
+ }
+ },
+ "dataFlow": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "title": "Data flow direction"
+ },
+
+ "copyright": {
+ "type": "object",
+ "title": "Copyright",
+ "required": [
+ "text"
+ ],
+ "properties": {
+ "text": {
+ "type": "string",
+ "title": "Copyright Text"
+ }
+ }
+ },
+
+ "componentEvidence": {
+ "type": "object",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis.",
+ "properties": {
+ "licenses": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/copyright"},
+ "title": "Copyright"
+ }
+ }
+ },
+ "compositions": {
+ "type": "object",
+ "title": "Compositions",
+ "required": [
+ "aggregate"
+ ],
+ "properties": {
+ "aggregate": {
+ "$ref": "#/definitions/aggregateType",
+ "title": "Aggregate",
+ "description": "Specifies an aggregate type that describe how complete a relationship is."
+ },
+ "assemblies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only."
+ },
+ "dependencies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only."
+ }
+ }
+ },
+ "aggregateType": {
+ "type": "string",
+ "default": "not_specified",
+ "enum": [
+ "complete",
+ "incomplete",
+ "incomplete_first_party_only",
+ "incomplete_third_party_only",
+ "unknown",
+ "not_specified"
+ ]
+ },
+ "property": {
+ "type": "object",
+ "title": "Lightweight name-value pair",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the property. Duplicate names are allowed, each potentially having a different value."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value of the property."
+ }
+ }
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3.SNAPSHOT.xsd
new file mode 100644
index 00000000..150de444
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.3.SNAPSHOT.xsd
@@ -0,0 +1,1640 @@
+
+
+
+
+
+
+
+
+ CycloneDX Software Bill-of-Material Specification
+ https://cyclonedx.org/
+ Apache License, Version 2.0
+
+
+
+
+
+ Identifier-DataType for interlinked elements.
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the document was created.
+
+
+
+
+ The tool(s) used in the creation of the BOM.
+
+
+
+
+
+
+
+
+
+ The person(s) who created the BOM. Authors are common in BOMs created through
+ manual processes. BOMs created through automated means may not have authors.
+
+
+
+
+
+
+
+
+
+ The component that the BOM describes.
+
+
+
+
+ The organization that manufactured the component that the BOM describes.
+
+
+
+
+ The organization that supplied the component that the BOM describes. The
+ supplier may often be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the organization
+
+
+
+
+ The URL of the organization. Multiple URLs are allowed.
+
+
+
+
+ A contact person at the organization. Multiple contacts are allowed.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies a tool (manual or automated).
+
+
+
+
+ The vendor of the tool used to create the BOM.
+
+
+
+
+ The name of the tool used to create the BOM.
+
+
+
+
+ The version of the tool used to create the BOM.
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the contact
+
+
+
+
+ The email address of the contact.
+
+
+
+
+ The phone number of the contact.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that supplied the component. The supplier may often
+ be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+ The person(s) or organization(s) that authored the component
+
+
+
+
+ The person(s) or organization(s) that published the component
+
+
+
+
+ The grouping name or identifier. This will often be a shortened, single
+ name of the company or project that produced the component, or the source package or
+ domain name. Whitespace and special characters should be avoided. Examples include:
+ apache, org.apache.commons, and apache.org.
+
+
+
+
+ The name of the component. This will often be a shortened, single name
+ of the component. Examples: commons-lang3 and jquery
+
+
+
+
+ The component version. The version should ideally comply with semantic versioning
+ but is not enforced.
+
+
+
+
+ Specifies a description for the component
+
+
+
+
+ Specifies the scope of the component. If scope is not specified, 'runtime'
+ scope should be assumed by the consumer of the BOM
+
+
+
+
+
+
+
+
+
+
+
+
+ An optional copyright notice informing users of the underlying claims to
+ copyright ownership in a published work.
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version.
+ Specifies a well-formed CPE name. See https://nvd.nist.gov/products/cpe
+
+
+
+
+
+
+ Specifies the package-url (PURL). The purl, if specified, must be valid and conform
+ to the specification defined at: https://github.com/package-url/purl-spec
+
+
+
+
+
+
+ Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree
+ element instead to supply information on exactly how the component was modified.
+ A boolean value indicating is the component has been modified from the original.
+ A value of true indicates the component is a derivative of the original.
+ A value of false indicates the component has not been modified from the original.
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are
+ created, distributed, modified, redistributed, combined with other components, etc.
+
+
+
+
+
+ Provides the ability to document external references related to the
+ component or to the project the component describes.
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions.
+
+
+
+
+
+ Specifies optional sub-components. This is not a dependency tree. It provides a way
+ to specify a hierarchical representation of component assemblies, similar to
+ system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Provides the ability to document evidence collected through various forms of extraction or analysis.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ Specifies the type of component. For software components, classify as application if no more
+ specific appropriate classification is available or cannot be determined for the component.
+
+
+
+
+
+
+ The optional mime-type of the component. When used on file components, the mime-type
+ can provide additional context about the kind of file being represented such as an image,
+ font, or executable. Some library or framework components may also have an associated mime-type.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the component elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ A valid SPDX license ID
+
+
+
+
+ If SPDX does not define the license used, this field may be used to provide the license name
+
+
+
+
+
+ Specifies the optional full text of the attachment
+
+
+
+
+ The URL to the attachment file. If the attachment is a license or BOM,
+ an externalReference should also be specified for completeness.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ Specifies attributes of the text
+
+
+
+ Specifies the content type of the text. Defaults to text/plain
+ if not specified.
+
+
+
+
+
+ Specifies the optional encoding the text is represented in
+
+
+
+
+
+
+
+
+
+ Specifies the file hash of the component
+
+
+
+
+
+ Specifies the algorithm used to create the hash
+
+
+
+
+
+
+
+
+
+
+ The component is required for runtime
+
+
+
+
+ The component is optional at runtime. Optional components are components that
+ are not capable of being called due to them not be installed or otherwise accessible by any means.
+ Components that are installed but due to configuration or other restrictions are prohibited from
+ being called must be scoped as 'required'.
+
+
+
+
+ Components that are excluded provide the ability to document component usage
+ for test and other non-runtime purposes. Excluded components are not reachable within a call
+ graph at runtime.
+
+
+
+
+
+
+
+
+
+ A software application. Refer to https://en.wikipedia.org/wiki/Application_software
+ for information about applications.
+
+
+
+
+ A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework
+ for information on how frameworks vary slightly from libraries.
+
+
+
+
+ A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing)
+ for information about libraries. All third-party and open source reusable components will likely
+ be a library. If the library also has key features of a framework, then it should be classified
+ as a framework. If not, or is unknown, then specifying library is recommended.
+
+
+
+
+ A packaging and/or runtime format, not specific to any particular technology,
+ which isolates software inside the container from software outside of a container through
+ virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization
+
+
+
+
+ A software operating system without regard to deployment model
+ (i.e. installed on physical hardware, virtual machine, image, etc) Refer to
+ https://en.wikipedia.org/wiki/Operating_system
+
+
+
+
+ A hardware device such as a processor, or chip-set. A hardware device
+ containing firmware should include a component for the physical hardware itself, and another
+ component of type 'firmware' or 'operating-system' (whichever is relevant), describing
+ information about the software running on the device.
+ See also the list of known device properties: https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md
+
+
+
+
+
+ A special type of software that provides low-level control over a devices
+ hardware. Refer to https://en.wikipedia.org/wiki/Firmware
+
+
+
+
+ A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file
+ for information about files.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats.
+ Refer to https://nvd.nist.gov/products/cpe for official specification.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the full content of the SWID tag.
+
+
+
+
+ The URL to the SWID file.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Maps to the tagId of a SoftwareIdentity.
+
+
+
+
+ Maps to the name of a SoftwareIdentity.
+
+
+
+
+ Maps to the version of a SoftwareIdentity.
+
+
+
+
+ Maps to the tagVersion of a SoftwareIdentity.
+
+
+
+
+ Maps to the patch of a SoftwareIdentity.
+
+
+
+
+
+
+
+ Defines a string representation of a UUID conforming to RFC 4122.
+
+
+
+
+
+
+
+
+
+
+
+ Version Control System
+
+
+
+
+ Issue or defect tracking system, or an Application Lifecycle Management (ALM) system
+
+
+
+
+ Website
+
+
+
+
+ Security advisories
+
+
+
+
+ Bill-of-material document (CycloneDX, SPDX, SWID, etc)
+
+
+
+
+ Mailing list or discussion group
+
+
+
+
+ Social media account
+
+
+
+
+ Real-time chat platform
+
+
+
+
+ Documentation, guides, or how-to instructions
+
+
+
+
+ Community or commercial support
+
+
+
+
+ Direct or repository download location
+
+
+
+
+ The URL to the license file. If a license URL has been defined in the license
+ node, it should also be defined as an external reference for completeness
+
+
+
+
+ Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)
+
+
+
+
+ URL to an automated build system
+
+
+
+
+ Use this if no other types accurately describe the purpose of the external reference
+
+
+
+
+
+
+
+
+ External references provide a way to document systems, sites, and information that may be relevant
+ but which are not included with the BOM.
+
+
+
+
+
+ Zero or more external references can be defined
+
+
+
+
+
+
+
+
+
+ The URL to the external reference
+
+
+
+
+ An optional comment describing the external reference
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the type of external reference. There are built-in types to describe common
+ references. If a type does not exist for the reference being referred to, use the "other" type.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Zero or more commits can be specified.
+
+
+
+
+ Specifies an individual commit.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of the commit. This may be version control
+ specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
+
+
+
+
+
+ The URL to the commit. This URL will typically point to a commit
+ in a version control system.
+
+
+
+
+
+ The author who created the changes in the commit
+
+
+
+
+ The person who committed or pushed the commit
+
+
+
+
+ The text description of the contents of the commit
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Zero or more patches can be specified.
+
+
+
+
+ Specifies an individual patch.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The patch file (or diff) that show changes.
+ Refer to https://en.wikipedia.org/wiki/Diff
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the purpose for the patch including the resolution of defects,
+ security issues, or new behavior or functionality
+
+
+
+
+
+
+
+
+ A patch which is not developed by the creators or maintainers of the software
+ being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch
+
+
+
+
+ A patch which dynamically modifies runtime behavior.
+ Refer to https://en.wikipedia.org/wiki/Monkey_patch
+
+
+
+
+ A patch which takes code from a newer version of software and applies
+ it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting
+
+
+
+
+ A patch created by selectively applying commits from other versions or
+ branches of the same software.
+
+
+
+
+
+
+
+
+
+ A fault, flaw, or bug in software
+
+
+
+
+ A new feature or behavior in software
+
+
+
+
+ A special type of defect which impacts security
+
+
+
+
+
+
+
+
+
+ Specifies the optional text of the diff
+
+
+
+
+ Specifies the URL to the diff
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The identifier of the issue assigned by the source of the issue
+
+
+
+
+ The name of the issue
+
+
+
+
+ A description of the issue
+
+
+
+
+
+
+ The source of the issue where it is documented.
+
+
+
+
+
+
+ The name of the source. For example "National Vulnerability Database",
+ "NVD", and "Apache"
+
+
+
+
+
+
+ The url of the issue documentation as provided by the source
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the type of issue
+
+
+
+
+
+
+
+
+ The timestamp in which the action occurred
+
+
+
+
+ The name of the individual who performed the action
+
+
+
+
+ The email address of the individual who performed the action
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are created,
+ distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing
+ this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to
+ document variants where the exact relation may not be known.
+
+
+
+
+
+ Describes zero or more components in which a component is derived
+ from. This is commonly used to describe forks from existing projects where the forked version
+ contains a ancestor node containing the original component it was forked from. For example,
+ Component A is the original component. Component B is the component being used and documented
+ in the BOM. However, Component B contains a pedigree node with a single ancestor documenting
+ Component A - the original component from which Component B is derived from.
+
+
+
+
+
+ Descendants are the exact opposite of ancestors. This provides a
+ way to document all forks (and their forks) of an original or root component.
+
+
+
+
+
+ Variants describe relations where the relationship between the
+ components are not known. For example, if Component A contains nearly identical code to
+ Component B. They are both related, but it is unclear if one is derived from the other,
+ or if they share a common ancestor.
+
+
+
+
+
+ A list of zero or more commits which provide a trail describing
+ how the component deviates from an ancestor, descendant, or variant.
+
+
+
+
+ A list of zero or more patches describing how the component
+ deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits
+ or may be used in place of commits.
+
+
+
+
+ Notes, observations, and other non-structured commentary
+ describing the components pedigree.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+ References a component or service by the its bom-ref attribute
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Components that do not have their own dependencies MUST be declared as empty
+ elements within the graph. Components that are not represented in the dependency graph MAY
+ have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque
+ and not an indicator of a component being dependency-free.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that provides the service.
+
+
+
+
+ The grouping name, namespace, or identifier. This will often be a shortened,
+ single name of the company or project that produced the service or domain name.
+ Whitespace and special characters should be avoided.
+
+
+
+
+ The name of the service. This will often be a shortened, single name
+ of the service.
+
+
+
+
+ The service version.
+
+
+
+
+ Specifies a description for the service.
+
+
+
+
+
+
+
+ A service endpoint URI.
+
+
+
+
+
+
+
+ A boolean value indicating if the service requires authentication.
+ A value of true indicates the service requires authentication prior to use.
+ A value of false indicates the service does not require authentication.
+
+
+
+
+ A boolean value indicating if use of the service crosses a trust zone or boundary.
+ A value of true indicates that by using the service, a trust boundary is crossed.
+ A value of false indicates that by using the service, a trust boundary is not crossed.
+
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the service.
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions.
+
+
+
+
+
+ Specifies optional sub-service. This is not a dependency tree. It provides a way
+ to specify a hierarchical representation of service assemblies, similar to
+ system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the service elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ Specifies the flow direction of the data.
+
+
+
+
+
+
+
+
+ Specifies the flow direction of the data. Valid values are:
+ inbound, outbound, bi-directional, and unknown. Direction is relative to the service.
+ Inbound flow states that data enters the service. Outbound flow states that data
+ leaves the service. Bi-directional states that data flows both ways, and unknown
+ states that the direction is not known.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license expression.
+ Refer to https://spdx.org/specifications for syntax requirements
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Specifies an aggregate type that describe how complete a relationship is.
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Assemblies refer to
+ nested relationships whereby a constituent part may include other constituent parts. References
+ do not cascade to child parts. References are explicit for the specified constituent part only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Dependencies refer to a
+ relationship whereby an independent constituent part requires another independent constituent
+ part. References do not cascade to transitive dependencies. References are explicit for the
+ specified dependency only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The relationship is complete. No further relationships including constituent components, services, or dependencies exist.
+
+
+
+
+ The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.
+
+
+
+
+ The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.
+
+
+
+
+ The relationship completeness is not specified.
+
+
+
+
+
+
+
+
+ References a component or service by the its bom-ref attribute
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies an individual property with a name and value.
+
+
+
+
+
+ The name of the property. Duplicate names are allowed, each potentially having a different value.
+
+
+
+
+
+
+
+
+
+
+
+ Provides additional information about a BOM.
+
+
+
+
+ Provides the ability to document a list of components.
+
+
+
+
+ Provides the ability to document a list of external services.
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+ Provides the ability to document dependency relationships.
+
+
+
+
+ Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness.
+
+
+
+
+ Provides the ability to document properties in a name-value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Unlike key-value
+ stores, properties support duplicate names, each potentially having different values.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ The version allows component publishers/authors to make changes to existing
+ BOMs to update various aspects of the document such as description or licenses. When a system
+ is presented with multiple BOMs for the same component, the system should use the most recent
+ version of the BOM. The default version is '1' and should be incremented for each version of the
+ BOM that is published. Each version of a component should have a unique BOM and if no changes are
+ made to the BOMs, then each BOM will have a version of '1'.
+
+
+
+
+ Every BOM generated should have a unique serial number, even if the contents
+ of the BOM being generated have not changed over time. The process or tool responsible for
+ creating the BOM should create random UUID's for every BOM generated.
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.4.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.4.SNAPSHOT.schema.json
new file mode 100644
index 00000000..48a462e3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.4.SNAPSHOT.schema.json
@@ -0,0 +1,1693 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/bom-1.4.schema.json",
+ "type": "object",
+ "title": "CycloneDX Software Bill of Materials Standard",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "$schema": {
+ "type": "string"
+ },
+ "bomFormat": {
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces. This value MUST be \"CycloneDX\".",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification a BOM conforms to (starting at version 1.2).",
+ "examples": ["1.4"]
+ },
+ "serialNumber": {
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122. Use of serial numbers are RECOMMENDED.",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.",
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components."
+ },
+ "services": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services."
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ },
+ "dependencies": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency relationships."
+ },
+ "compositions": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/compositions"},
+ "uniqueItems": true,
+ "title": "Compositions",
+ "description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness."
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/vulnerability"},
+ "uniqueItems": true,
+ "title": "Vulnerabilities",
+ "description": "Vulnerabilities identified in components or services."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "$comment": "Identifier-DataType for interlinked elements.",
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata Object",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the BOM was created."
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used in the creation of the BOM.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Authors",
+ "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "title": "Manufacture",
+ "description": "The organization that manufactured the component that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "licenses": {
+ "type": "array",
+ "title": "BOM License(s)",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"}
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "Information about the automated or manual tool used",
+ "additionalProperties": false,
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "title": "Tool Vendor",
+ "description": "The name of the vendor who created the tool"
+ },
+ "name": {
+ "type": "string",
+ "title": "Tool Name",
+ "description": "The name of the tool"
+ },
+ "version": {
+ "type": "string",
+ "title": "Tool Version",
+ "description": "The version of the tool"
+ },
+ "hashes": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the organization",
+ "examples": [
+ "Example Inc."
+ ]
+ },
+ "url": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "URL",
+ "description": "The URL of the organization. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ },
+ "contact": {
+ "type": "array",
+ "title": "Contact",
+ "description": "A contact at the organization. Multiple contacts are allowed.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "examples": ["Contact name"]
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "Email Address",
+ "description": "The email address of the contact.",
+ "examples": ["firstname.lastname@example.com"]
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact.",
+ "examples": ["800-555-1212"]
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component Object",
+ "required": [
+ "type",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "operating-system",
+ "device",
+ "firmware",
+ "file"
+ ],
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component. Types include:\n\n* __application__ = A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.\n* __framework__ = A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.\n* __library__ = A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing))\n for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is RECOMMENDED.\n* __container__ = A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization)\n* __operating-system__ = A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system)\n* __device__ = A hardware device such as a processor, or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself, and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device.\n See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).\n* __firmware__ = A special type of software that provides low-level control over a devices hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware)\n* __file__ = A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.",
+ "examples": ["library"]
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "author": {
+ "type": "string",
+ "title": "Component Author",
+ "description": "The person(s) or organization(s) that authored the component",
+ "examples": ["Acme Inc"]
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the component",
+ "examples": ["Acme Inc"]
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "examples": ["tomcat-catalina"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.",
+ "examples": ["9.0.14"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.",
+ "default": "required"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "A copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"]
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Component Common Platform Enumeration (CPE)",
+ "description": "Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See [https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe)",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]
+ },
+ "purl": {
+ "type": "string",
+ "title": "Component Package URL (purl)",
+ "description": "Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec)",
+ "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"]
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for [ISO-IEC 19770-2 Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html)."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "[Deprecated] - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
+ "additionalProperties": false,
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured commentary describing the components pedigree."
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ },
+ "components": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains."
+ },
+ "evidence": {
+ "$ref": "#/definitions/componentEvidence",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the SWID file.",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
+ "default": "text/plain"
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is represented in.",
+ "enum": [
+ "base64"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text."
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ],
+ "title": "Hash Algorithm"
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Content (value)",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License Object",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "$ref": "spdx.SNAPSHOT.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license ID",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "If SPDX does not define the license used, this field may be used to provide the license name",
+ "examples": ["Acme Software License"]
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+ "format": "iri-reference"
+ }
+ }
+ },
+ "licenseChoice": {
+ "type": "object",
+ "title": "License(s)",
+ "additionalProperties": false,
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ]
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "title": "Type",
+ "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.\n\n* __unofficial__ = A patch which is not developed by the creators or maintainers of the software being patched. Refer to [https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch)\n* __monkey__ = A patch which dynamically modifies runtime behavior. Refer to [https://en.wikipedia.org/wiki/Monkey_patch](https://en.wikipedia.org/wiki/Monkey_patch)\n* __backport__ = A patch which takes code from a newer version of software and applies it to older versions of the same software. Refer to [https://en.wikipedia.org/wiki/Backporting](https://en.wikipedia.org/wiki/Backporting)\n* __cherry-pick__ = A patch created by selectively applying commits from other versions or branches of the same software."
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to [https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Diff",
+ "description": "An individual issue that has been resolved.",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "title": "Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier of the issue assigned by the source of the issue"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the issue"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the issue"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided by the source",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "Specifies an individual external reference",
+ "required": [
+ "url",
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the external reference",
+ "format": "iri-reference"
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external reference"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference. There are built-in types to describe common references. If a type does not exist for the reference being referred to, use the \"other\" type.",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "distribution",
+ "license",
+ "build-meta",
+ "build-system",
+ "release-notes",
+ "other"
+ ]
+ },
+ "hashes": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the external reference (if applicable)."
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component. Components that do not have their own dependencies MUST be declared as empty elements within the graph. Components that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a component being dependency-free.",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "title": "Reference",
+ "description": "References a component by the components bom-ref attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/refType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components that are dependencies of this dependency object."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service Object",
+ "required": [
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a shortened, single name of the service.",
+ "examples": ["ticker-service"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Service Version",
+ "description": "The service version.",
+ "examples": ["1.0.0"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service"
+ },
+ "endpoints": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
+ "examples": ["https://example.com/api/v1/ticker"]
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
+ },
+ "data": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/dataClassification"},
+ "title": "Data Classification",
+ "description": "Specifies the data classification."
+ },
+ "licenses": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but which are not included with the BOM."
+ },
+ "services": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services included or deployed behind the parent service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlow",
+ "title": "Directional Flow",
+ "description": "Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known."
+ },
+ "classification": {
+ "type": "string",
+ "title": "Classification",
+ "description": "Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed."
+ }
+ }
+ },
+ "dataFlow": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "title": "Data flow direction",
+ "description": "Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known."
+ },
+
+ "copyright": {
+ "type": "object",
+ "title": "Copyright",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string",
+ "title": "Copyright Text"
+ }
+ }
+ },
+
+ "componentEvidence": {
+ "type": "object",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis.",
+ "additionalProperties": false,
+ "properties": {
+ "licenses": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/copyright"},
+ "title": "Copyright"
+ }
+ }
+ },
+ "compositions": {
+ "type": "object",
+ "title": "Compositions",
+ "required": [
+ "aggregate"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "aggregate": {
+ "$ref": "#/definitions/aggregateType",
+ "title": "Aggregate",
+ "description": "Specifies an aggregate type that describe how complete a relationship is."
+ },
+ "assemblies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only."
+ },
+ "dependencies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "aggregateType": {
+ "type": "string",
+ "default": "not_specified",
+ "enum": [
+ "complete",
+ "incomplete",
+ "incomplete_first_party_only",
+ "incomplete_third_party_only",
+ "unknown",
+ "not_specified"
+ ]
+ },
+ "property": {
+ "type": "object",
+ "title": "Lightweight name-value pair",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the property. Duplicate names are allowed, each potentially having a different value."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value of the property."
+ }
+ }
+ },
+ "localeType": {
+ "type": "string",
+ "pattern": "^([a-z]{2})(-[A-Z]{2})?$",
+ "title": "Locale",
+ "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code MUST be lower case. If the country code is specified, the country code MUST be upper case. The language code and country code MUST be separated by a minus sign. Examples: en, en-US, fr, fr-CA"
+ },
+ "releaseType": {
+ "type": "string",
+ "examples": [
+ "major",
+ "minor",
+ "patch",
+ "pre-release",
+ "internal"
+ ],
+ "description": "The software versioning type. It is RECOMMENDED that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it."
+ },
+ "note": {
+ "type": "object",
+ "title": "Note",
+ "description": "A note containing the locale and content.",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "locale": {
+ "$ref": "#/definitions/localeType",
+ "title": "Locale",
+ "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: \"en\", \"en-US\", \"fr\" and \"fr-CA\""
+ },
+ "text": {
+ "title": "Release note content",
+ "description": "Specifies the full content of the release note.",
+ "$ref": "#/definitions/attachment"
+ }
+ }
+ },
+ "releaseNotes": {
+ "type": "object",
+ "title": "Release notes",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/releaseType",
+ "title": "Type",
+ "description": "The software versioning type the release note describes."
+ },
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "The title of the release."
+ },
+ "featuredImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Featured image",
+ "description": "The URL to an image that may be prominently displayed with the release note."
+ },
+ "socialImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Social image",
+ "description": "The URL to an image that may be used in messaging on social media platforms."
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A short description of the release."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the release note was created."
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Aliases",
+ "description": "One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names)."
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Tags",
+ "description": "One or more tags that may aid in search or retrieval of the release note."
+ },
+ "resolves": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues that have been resolved."
+ },
+ "notes": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/note"},
+ "title": "Notes",
+ "description": "Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "advisory": {
+ "type": "object",
+ "title": "Advisory",
+ "description": "Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.",
+ "required": ["url"],
+ "additionalProperties": false,
+ "properties": {
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "An optional name of the advisory."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "format": "iri-reference",
+ "description": "Location where the advisory can be obtained."
+ }
+ }
+ },
+ "cwe": {
+ "type": "integer",
+ "minimum": 1,
+ "title": "CWE",
+ "description": "Integer representation of a Common Weaknesses Enumerations (CWE). For example 399 (of https://cwe.mitre.org/data/definitions/399.html)"
+ },
+ "severity": {
+ "type": "string",
+ "title": "Severity",
+ "description": "Textual representation of the severity of the vulnerability adopted by the analysis method. If the analysis method uses values other than what is provided, the user is expected to translate appropriately.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ "info",
+ "none",
+ "unknown"
+ ]
+ },
+ "scoreMethod": {
+ "type": "string",
+ "title": "Method",
+ "description": "Specifies the severity or risk scoring methodology or standard used.\n\n* CVSSv2 - [Common Vulnerability Scoring System v2](https://www.first.org/cvss/v2/)\n* CVSSv3 - [Common Vulnerability Scoring System v3](https://www.first.org/cvss/v3-0/)\n* CVSSv31 - [Common Vulnerability Scoring System v3.1](https://www.first.org/cvss/v3-1/)\n* OWASP - [OWASP Risk Rating Methodology](https://owasp.org/www-community/OWASP_Risk_Rating_Methodology)",
+ "enum": [
+ "CVSSv2",
+ "CVSSv3",
+ "CVSSv31",
+ "OWASP",
+ "other"
+ ]
+ },
+ "impactAnalysisState": {
+ "type": "string",
+ "title": "Impact Analysis State",
+ "description": "Declares the current state of an occurrence of a vulnerability, after automated or manual analysis. \n\n* __resolved__ = the vulnerability has been remediated. \n* __resolved\\_with\\_pedigree__ = the vulnerability has been remediated and evidence of the changes are provided in the affected components pedigree containing verifiable commit history and/or diff(s). \n* __exploitable__ = the vulnerability may be directly or indirectly exploitable. \n* __in\\_triage__ = the vulnerability is being investigated. \n* __false\\_positive__ = the vulnerability is not specific to the component or service and was falsely identified or associated. \n* __not\\_affected__ = the component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases.",
+ "enum": [
+ "resolved",
+ "resolved_with_pedigree",
+ "exploitable",
+ "in_triage",
+ "false_positive",
+ "not_affected"
+ ]
+ },
+ "impactAnalysisJustification": {
+ "type": "string",
+ "title": "Impact Analysis Justification",
+ "description": "The rationale of why the impact analysis state was asserted. \n\n* __code\\_not\\_present__ = the code has been removed or tree-shaked. \n* __code\\_not\\_reachable__ = the vulnerable code is not invoked at runtime. \n* __requires\\_configuration__ = exploitability requires a configurable option to be set/unset. \n* __requires\\_dependency__ = exploitability requires a dependency that is not present. \n* __requires\\_environment__ = exploitability requires a certain environment which is not present. \n* __protected\\_by\\_compiler__ = exploitability requires a compiler flag to be set/unset. \n* __protected\\_at\\_runtime__ = exploits are prevented at runtime. \n* __protected\\_at\\_perimeter__ = attacks are blocked at physical, logical, or network perimeter. \n* __protected\\_by\\_mitigating\\_control__ = preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.",
+ "enum": [
+ "code_not_present",
+ "code_not_reachable",
+ "requires_configuration",
+ "requires_dependency",
+ "requires_environment",
+ "protected_by_compiler",
+ "protected_at_runtime",
+ "protected_at_perimeter",
+ "protected_by_mitigating_control"
+ ]
+ },
+ "rating": {
+ "type": "object",
+ "title": "Rating",
+ "description": "Defines the severity or risk ratings of a vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that calculated the severity or risk rating of the vulnerability."
+ },
+ "score": {
+ "type": "number",
+ "title": "Score",
+ "description": "The numerical score of the rating."
+ },
+ "severity": {
+ "$ref": "#/definitions/severity",
+ "description": "Textual representation of the severity that corresponds to the numerical score of the rating."
+ },
+ "method": {
+ "$ref": "#/definitions/scoreMethod"
+ },
+ "vector": {
+ "type": "string",
+ "title": "Vector",
+ "description": "Textual representation of the metric values used to score the vulnerability"
+ },
+ "justification": {
+ "type": "string",
+ "title": "Justification",
+ "description": "An optional reason for rating the vulnerability as it was"
+ }
+ }
+ },
+ "vulnerabilitySource": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of vulnerability information. This is often the organization that published the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the vulnerability documentation as provided by the source.",
+ "examples": [
+ "https://nvd.nist.gov/vuln/detail/CVE-2021-39182"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source.",
+ "examples": [
+ "NVD",
+ "National Vulnerability Database",
+ "OSS Index",
+ "VulnDB",
+ "GitHub Advisories"
+ ]
+ }
+ }
+ },
+ "vulnerability": {
+ "type": "object",
+ "title": "Vulnerability",
+ "description": "Defines a weakness in an component or service that could be exploited or triggered by a threat source.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier that uniquely identifies the vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ },
+ "references": {
+ "type": "array",
+ "title": "References",
+ "description": "Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.",
+ "additionalItems": false,
+ "items": {
+ "required": [
+ "id",
+ "source"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "An identifier that uniquely identifies the vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ }
+ }
+ }
+ },
+ "ratings": {
+ "type": "array",
+ "title": "Ratings",
+ "description": "List of vulnerability ratings",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/rating"
+ }
+ },
+ "cwes": {
+ "type": "array",
+ "title": "CWEs",
+ "description": "List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability. For example 399 (of https://cwe.mitre.org/data/definitions/399.html)",
+ "examples": [399],
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/cwe"
+ }
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the vulnerability as provided by the source."
+ },
+ "detail": {
+ "type": "string",
+ "title": "Details",
+ "description": "If available, an in-depth description of the vulnerability as provided by the source organization. Details often include examples, proof-of-concepts, and other information useful in understanding root cause."
+ },
+ "recommendation": {
+ "type": "string",
+ "title": "Details",
+ "description": "Recommendations of how the vulnerability can be remediated or mitigated."
+ },
+ "advisories": {
+ "type": "array",
+ "title": "Advisories",
+ "description": "Published advisories of the vulnerability if provided.",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/advisory"
+ }
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created",
+ "description": "The date and time (timestamp) when the vulnerability record was created in the vulnerability database."
+ },
+ "published": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Published",
+ "description": "The date and time (timestamp) when the vulnerability record was first published."
+ },
+ "updated": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Updated",
+ "description": "The date and time (timestamp) when the vulnerability record was last updated."
+ },
+ "credits": {
+ "type": "object",
+ "title": "Credits",
+ "description": "Individuals or organizations credited with the discovery of the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "organizations": {
+ "type": "array",
+ "title": "Organizations",
+ "description": "The organizations credited with vulnerability discovery.",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/organizationalEntity"
+ }
+ },
+ "individuals": {
+ "type": "array",
+ "title": "Individuals",
+ "description": "The individuals, not associated with organizations, that are credited with vulnerability discovery.",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/organizationalContact"
+ }
+ }
+ }
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used to identify, confirm, or score the vulnerability.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "analysis": {
+ "type": "object",
+ "title": "Impact Analysis",
+ "description": "An assessment of the impact and exploitability of the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "state": {
+ "$ref": "#/definitions/impactAnalysisState"
+ },
+ "justification": {
+ "$ref": "#/definitions/impactAnalysisJustification"
+ },
+ "response": {
+ "type": "array",
+ "title": "Response",
+ "description": "A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.",
+ "additionalItems": false,
+ "items": {
+ "type": "string",
+ "enum": [
+ "can_not_fix",
+ "will_not_fix",
+ "update",
+ "rollback",
+ "workaround_available"
+ ]
+ }
+ },
+ "detail": {
+ "type": "string",
+ "title": "Detail",
+ "description": "Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability."
+ }
+ }
+ },
+ "affects": {
+ "type": "array",
+ "uniqueItems": true,
+ "additionalItems": false,
+ "items": {
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "title": "Reference",
+ "description": "References a component or service by the objects bom-ref"
+ },
+ "versions": {
+ "type": "array",
+ "title": "Versions",
+ "description": "Zero or more individual versions or range of versions.",
+ "additionalItems": false,
+ "items": {
+ "oneOf": [
+ {
+ "required": ["version"]
+ },
+ {
+ "required": ["range"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "version": {
+ "description": "A single version of a component or service.",
+ "$ref": "#/definitions/version"
+ },
+ "range": {
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
+ "$ref": "#/definitions/range"
+ },
+ "status": {
+ "description": "The vulnerability status for the version or range of versions.",
+ "$ref": "#/definitions/affectedStatus",
+ "default": "affected"
+ }
+ }
+ }
+ }
+ }
+ },
+ "title": "Affects",
+ "description": "The components or services that are affected by the vulnerability."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "affectedStatus": {
+ "description": "The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.",
+ "type": "string",
+ "enum": [
+ "affected",
+ "unaffected",
+ "unknown"
+ ]
+ },
+ "version": {
+ "description": "A single version of a component or service.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "range": {
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "signature": {
+ "$ref": "jsf-0.82.SNAPSHOT.schema.json#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.4.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.4.SNAPSHOT.xsd
new file mode 100644
index 00000000..4b3b250d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.4.SNAPSHOT.xsd
@@ -0,0 +1,2419 @@
+
+
+
+
+
+
+
+
+ CycloneDX Software Bill of Materials Standard
+ https://cyclonedx.org/
+ Apache License, Version 2.0
+
+
+
+
+
+ Identifier-DataType for interlinked elements.
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the BOM was created.
+
+
+
+
+ The tool(s) used in the creation of the BOM.
+
+
+
+
+
+
+
+
+
+ The person(s) who created the BOM. Authors are common in BOMs created through
+ manual processes. BOMs created through automated means may not have authors.
+
+
+
+
+
+
+
+
+
+ The component that the BOM describes.
+
+
+
+
+ The organization that manufactured the component that the BOM describes.
+
+
+
+
+ The organization that supplied the component that the BOM describes. The
+ supplier may often be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the organization
+
+
+
+
+ The URL of the organization. Multiple URLs are allowed.
+
+
+
+
+ A contact person at the organization. Multiple contacts are allowed.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Information about the automated or manual tool used
+
+
+
+
+ The name of the vendor who created the tool
+
+
+
+
+ The name of the tool
+
+
+
+
+ The version of the tool
+
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the tool.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the contact
+
+
+
+
+ The email address of the contact.
+
+
+
+
+ The phone number of the contact.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that supplied the component. The supplier may often
+ be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+ The person(s) or organization(s) that authored the component
+
+
+
+
+ The person(s) or organization(s) that published the component
+
+
+
+
+ The grouping name or identifier. This will often be a shortened, single
+ name of the company or project that produced the component, or the source package or
+ domain name. Whitespace and special characters should be avoided. Examples include:
+ apache, org.apache.commons, and apache.org.
+
+
+
+
+ The name of the component. This will often be a shortened, single name
+ of the component. Examples: commons-lang3 and jquery
+
+
+
+
+ The component version. The version should ideally comply with semantic versioning
+ but is not enforced.
+
+
+
+
+ Specifies a description for the component
+
+
+
+
+ Specifies the scope of the component. If scope is not specified, 'required'
+ scope SHOULD be assumed by the consumer of the BOM.
+
+
+
+
+
+
+
+
+
+
+
+
+ A copyright notice informing users of the underlying claims to
+ copyright ownership in a published work.
+
+
+
+
+
+ Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe
+
+
+
+
+
+
+ Specifies the package-url (purl). The purl, if specified, MUST be valid and conform
+ to the specification defined at: https://github.com/package-url/purl-spec
+
+
+
+
+
+
+ Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree
+ element instead to supply information on exactly how the component was modified.
+ A boolean value indicating if the component has been modified from the original.
+ A value of true indicates the component is a derivative of the original.
+ A value of false indicates the component has not been modified from the original.
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are
+ created, distributed, modified, redistributed, combined with other components, etc.
+
+
+
+
+
+ Provides the ability to document external references related to the
+ component or to the project the component describes.
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ A list of software and hardware components included in the parent component. This is not a
+ dependency tree. It provides a way to specify a hierarchical representation of component
+ assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Provides the ability to document evidence collected through various forms of extraction or analysis.
+
+
+
+
+ Specifies optional release notes.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ Specifies the type of component. For software components, classify as application if no more
+ specific appropriate classification is available or cannot be determined for the component.
+
+
+
+
+
+
+ The OPTIONAL mime-type of the component. When used on file components, the mime-type
+ can provide additional context about the kind of file being represented such as an image,
+ font, or executable. Some library or framework components may also have an associated mime-type.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the component elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ A valid SPDX license ID
+
+
+
+
+ If SPDX does not define the license used, this field may be used to provide the license name
+
+
+
+
+
+ Specifies the optional full text of the attachment
+
+
+
+
+ The URL to the attachment file. If the attachment is a license or BOM,
+ an externalReference should also be specified for completeness.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
+
+
+
+ Specifies the content type of the text. Defaults to text/plain
+ if not specified.
+
+
+
+
+
+ Specifies the optional encoding the text is represented in
+
+
+
+
+
+
+
+
+
+ Specifies the file hash of the component
+
+
+
+
+
+ Specifies the algorithm used to create the hash
+
+
+
+
+
+
+
+
+
+
+ The component is required for runtime
+
+
+
+
+ The component is optional at runtime. Optional components are components that
+ are not capable of being called due to them not be installed or otherwise accessible by any means.
+ Components that are installed but due to configuration or other restrictions are prohibited from
+ being called must be scoped as 'required'.
+
+
+
+
+ Components that are excluded provide the ability to document component usage
+ for test and other non-runtime purposes. Excluded components are not reachable within a call
+ graph at runtime.
+
+
+
+
+
+
+
+
+
+ A software application. Refer to https://en.wikipedia.org/wiki/Application_software
+ for information about applications.
+
+
+
+
+ A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework
+ for information on how frameworks vary slightly from libraries.
+
+
+
+
+ A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing)
+ for information about libraries. All third-party and open source reusable components will likely
+ be a library. If the library also has key features of a framework, then it should be classified
+ as a framework. If not, or is unknown, then specifying library is recommended.
+
+
+
+
+ A packaging and/or runtime format, not specific to any particular technology,
+ which isolates software inside the container from software outside of a container through
+ virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization
+
+
+
+
+ A software operating system without regard to deployment model
+ (i.e. installed on physical hardware, virtual machine, image, etc) Refer to
+ https://en.wikipedia.org/wiki/Operating_system
+
+
+
+
+ A hardware device such as a processor, or chip-set. A hardware device
+ containing firmware SHOULD include a component for the physical hardware itself, and another
+ component of type 'firmware' or 'operating-system' (whichever is relevant), describing
+ information about the software running on the device.
+ See also the list of known device properties: https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md
+
+
+
+
+
+ A special type of software that provides low-level control over a devices
+ hardware. Refer to https://en.wikipedia.org/wiki/Firmware
+
+
+
+
+ A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file
+ for information about files.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats.
+ Refer to https://nvd.nist.gov/products/cpe for official specification.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the full content of the SWID tag.
+
+
+
+
+ The URL to the SWID file.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Maps to the tagId of a SoftwareIdentity.
+
+
+
+
+ Maps to the name of a SoftwareIdentity.
+
+
+
+
+ Maps to the version of a SoftwareIdentity.
+
+
+
+
+ Maps to the tagVersion of a SoftwareIdentity.
+
+
+
+
+ Maps to the patch of a SoftwareIdentity.
+
+
+
+
+
+
+
+ Defines a string representation of a UUID conforming to RFC 4122.
+
+
+
+
+
+
+
+
+
+
+
+ Version Control System
+
+
+
+
+ Issue or defect tracking system, or an Application Lifecycle Management (ALM) system
+
+
+
+
+ Website
+
+
+
+
+ Security advisories
+
+
+
+
+ Bill-of-material document (CycloneDX, SPDX, SWID, etc)
+
+
+
+
+ Mailing list or discussion group
+
+
+
+
+ Social media account
+
+
+
+
+ Real-time chat platform
+
+
+
+
+ Documentation, guides, or how-to instructions
+
+
+
+
+ Community or commercial support
+
+
+
+
+ Direct or repository download location
+
+
+
+
+ The URL to the license file. If a license URL has been defined in the license
+ node, it should also be defined as an external reference for completeness
+
+
+
+
+ Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)
+
+
+
+
+ URL to an automated build system
+
+
+
+
+ URL to release notes
+
+
+
+
+ Use this if no other types accurately describe the purpose of the external reference
+
+
+
+
+
+
+
+
+ External references provide a way to document systems, sites, and information that may be relevant
+ but which are not included with the BOM.
+
+
+
+
+
+ Zero or more external references can be defined
+
+
+
+
+
+
+
+
+
+ The URL to the external reference
+
+
+
+
+ An optional comment describing the external reference
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the type of external reference. There are built-in types to describe common
+ references. If a type does not exist for the reference being referred to, use the "other" type.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Zero or more commits can be specified.
+
+
+
+
+ Specifies an individual commit.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of the commit. This may be version control
+ specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
+
+
+
+
+
+ The URL to the commit. This URL will typically point to a commit
+ in a version control system.
+
+
+
+
+
+ The author who created the changes in the commit
+
+
+
+
+ The person who committed or pushed the commit
+
+
+
+
+ The text description of the contents of the commit
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Zero or more patches can be specified.
+
+
+
+
+ Specifies an individual patch.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The patch file (or diff) that show changes.
+ Refer to https://en.wikipedia.org/wiki/Diff
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the purpose for the patch including the resolution of defects,
+ security issues, or new behavior or functionality
+
+
+
+
+
+
+
+
+ A patch which is not developed by the creators or maintainers of the software
+ being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch
+
+
+
+
+ A patch which dynamically modifies runtime behavior.
+ Refer to https://en.wikipedia.org/wiki/Monkey_patch
+
+
+
+
+ A patch which takes code from a newer version of software and applies
+ it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting
+
+
+
+
+ A patch created by selectively applying commits from other versions or
+ branches of the same software.
+
+
+
+
+
+
+
+
+
+ A fault, flaw, or bug in software
+
+
+
+
+ A new feature or behavior in software
+
+
+
+
+ A special type of defect which impacts security
+
+
+
+
+
+
+
+
+
+ Specifies the optional text of the diff
+
+
+
+
+ Specifies the URL to the diff
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ An individual issue that has been resolved.
+
+
+
+
+
+ The identifier of the issue assigned by the source of the issue
+
+
+
+
+ The name of the issue
+
+
+
+
+ A description of the issue
+
+
+
+
+
+
+ The source of the issue where it is documented.
+
+
+
+
+
+
+ The name of the source. For example "National Vulnerability Database",
+ "NVD", and "Apache"
+
+
+
+
+
+
+ The url of the issue documentation as provided by the source
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the type of issue
+
+
+
+
+
+
+
+
+ The timestamp in which the action occurred
+
+
+
+
+ The name of the individual who performed the action
+
+
+
+
+ The email address of the individual who performed the action
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are created,
+ distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing
+ this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to
+ document variants where the exact relation may not be known.
+
+
+
+
+
+ Describes zero or more components in which a component is derived
+ from. This is commonly used to describe forks from existing projects where the forked version
+ contains a ancestor node containing the original component it was forked from. For example,
+ Component A is the original component. Component B is the component being used and documented
+ in the BOM. However, Component B contains a pedigree node with a single ancestor documenting
+ Component A - the original component from which Component B is derived from.
+
+
+
+
+
+ Descendants are the exact opposite of ancestors. This provides a
+ way to document all forks (and their forks) of an original or root component.
+
+
+
+
+
+ Variants describe relations where the relationship between the
+ components are not known. For example, if Component A contains nearly identical code to
+ Component B. They are both related, but it is unclear if one is derived from the other,
+ or if they share a common ancestor.
+
+
+
+
+
+ A list of zero or more commits which provide a trail describing
+ how the component deviates from an ancestor, descendant, or variant.
+
+
+
+
+ A list of zero or more patches describing how the component
+ deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits
+ or may be used in place of commits.
+
+
+
+
+ Notes, observations, and other non-structured commentary
+ describing the components pedigree.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+ References a component or service by the its bom-ref attribute
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Components that do not have their own dependencies MUST be declared as empty
+ elements within the graph. Components that are not represented in the dependency graph MAY
+ have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque
+ and not an indicator of a component being dependency-free.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that provides the service.
+
+
+
+
+ The grouping name, namespace, or identifier. This will often be a shortened,
+ single name of the company or project that produced the service or domain name.
+ Whitespace and special characters should be avoided.
+
+
+
+
+ The name of the service. This will often be a shortened, single name
+ of the service.
+
+
+
+
+ The service version.
+
+
+
+
+ Specifies a description for the service.
+
+
+
+
+
+
+
+ A service endpoint URI.
+
+
+
+
+
+
+
+ A boolean value indicating if the service requires authentication.
+ A value of true indicates the service requires authentication prior to use.
+ A value of false indicates the service does not require authentication.
+
+
+
+
+ A boolean value indicating if use of the service crosses a trust zone or boundary.
+ A value of true indicates that by using the service, a trust boundary is crossed.
+ A value of false indicates that by using the service, a trust boundary is not crossed.
+
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the service.
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ A list of services included or deployed behind the parent service. This is not a dependency
+ tree. It provides a way to specify a hierarchical representation of service assemblies.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Specifies optional release notes.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the service elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ Specifies the flow direction of the data.
+
+
+
+
+
+
+
+
+ Specifies the flow direction of the data. Valid values are:
+ inbound, outbound, bi-directional, and unknown. Direction is relative to the service.
+ Inbound flow states that data enters the service. Outbound flow states that data
+ leaves the service. Bi-directional states that data flows both ways, and unknown
+ states that the direction is not known.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license expression.
+ Refer to https://spdx.org/specifications for syntax requirements
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Specifies an aggregate type that describe how complete a relationship is.
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Assemblies refer to
+ nested relationships whereby a constituent part may include other constituent parts. References
+ do not cascade to child parts. References are explicit for the specified constituent part only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Dependencies refer to a
+ relationship whereby an independent constituent part requires another independent constituent
+ part. References do not cascade to transitive dependencies. References are explicit for the
+ specified dependency only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The relationship is complete. No further relationships including constituent components, services, or dependencies exist.
+
+
+
+
+ The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.
+
+
+
+
+ The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.
+
+
+
+
+ The relationship completeness is not specified.
+
+
+
+
+
+
+
+
+ Defines a syntax for representing two character language code (ISO-639) followed by an optional two
+ character country code. The language code MUST be lower case. If the country code is specified, the
+ country code MUST be upper case. The language code and country code MUST be separated by a minus sign.
+ Examples: en, en-US, fr, fr-CA
+
+
+
+
+
+
+
+
+
+
+
+ The software versioning type. It is RECOMMENDED that the release type use one
+ of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software
+ release types is not practical, so standardizing on the recommended values, whenever possible,
+ is strongly encouraged.
+ * major = A major release may contain significant changes or may introduce breaking changes.
+ * minor = A minor release, also known as an update, may contain a smaller number of changes than major releases.
+ * patch = Patch releases are typically unplanned and may resolve defects or important security issues.
+ * pre-release = A pre-release may include alpha, beta, or release candidates and typically have
+ limited support. They provide the ability to preview a release prior to its general availability.
+ * internal = Internal releases are not for public consumption and are intended to be used exclusively
+ by the project or manufacturer that produced it.
+
+
+
+
+
+ The title of the release.
+
+
+
+
+ The URL to an image that may be prominently displayed with the release note.
+
+
+
+
+ The URL to an image that may be used in messaging on social media platforms.
+
+
+
+
+ A short description of the release.
+
+
+
+
+ The date and time (timestamp) when the release note was created.
+
+
+
+
+
+
+
+ One or more alternate names the release may be referred to. This may
+ include unofficial terms used by development and marketing teams (e.g. code names).
+
+
+
+
+
+
+
+
+
+
+ One or more tags that may aid in search or retrieval of the release note.
+
+
+
+
+
+
+
+ A collection of issues that have been resolved.
+
+
+
+
+
+
+
+
+
+
+
+
+ Zero or more release notes containing the locale and content. Multiple
+ note elements may be specified to support release notes in a wide variety of languages.
+
+
+
+
+
+ The ISO-639 (or higher) language code and optional ISO-3166
+ (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA".
+
+
+
+
+ Specifies the full content of the release note.
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ References a component or service by the its bom-ref attribute
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies an individual property with a name and value.
+
+
+
+
+
+ The name of the property. Duplicate names are allowed, each potentially having a different value.
+
+
+
+
+
+
+
+
+
+
+ Defines a weakness in an component or service that could be exploited or triggered by a threat source.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The identifier that uniquely identifies the vulnerability. For example:
+ CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876.
+
+
+
+
+ The source that published the vulnerability.
+
+
+
+
+ Zero or more pointers to vulnerabilities that are the equivalent of the
+ vulnerability specified. Often times, the same vulnerability may exist in multiple sources of
+ vulnerability intelligence, but have different identifiers. References provide a way to
+ correlate vulnerabilities across multiple sources of vulnerability intelligence.
+
+
+
+
+
+ A pointer to a vulnerability that is the equivalent of the
+ vulnerability specified.
+
+
+
+
+
+ The identifier that uniquely identifies the vulnerability. For example:
+ CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876.
+
+
+
+
+ The source that published the vulnerability.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ List of vulnerability ratings.
+
+
+
+
+
+
+
+
+
+
+
+ List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability.
+ For example 399 (of https://cwe.mitre.org/data/definitions/399.html)
+
+
+
+
+
+
+
+
+
+ A description of the vulnerability as provided by the source.
+
+
+
+
+ If available, an in-depth description of the vulnerability as provided by the
+ source organization. Details often include examples, proof-of-concepts, and other information
+ useful in understanding root cause.
+
+
+
+
+ Recommendations of how the vulnerability can be remediated or mitigated.
+
+
+
+
+
+
+ Published advisories of the vulnerability if provided.
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was created in the vulnerability database.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was first published.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was last updated.
+
+
+
+
+ Individuals or organizations credited with the discovery of the vulnerability.
+
+
+
+
+
+ The organizations credited with vulnerability discovery.
+
+
+
+
+
+
+
+
+
+ The individuals, not associated with organizations, that are credited with vulnerability discovery.
+
+
+
+
+
+
+
+
+
+
+
+
+ The tool(s) used to identify, confirm, or score the vulnerability.
+
+
+
+
+
+
+
+
+
+
+
+ An assessment of the impact and exploitability of the vulnerability.
+
+
+
+
+
+
+ Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+ A response to the vulnerability by the manufacturer, supplier, or
+ project responsible for the affected component or service. More than one response
+ is allowed. Responses are strongly encouraged for vulnerabilities where the analysis
+ state is exploitable.
+
+
+
+
+
+
+
+
+
+
+ Detailed description of the impact including methods used during assessment.
+ If a vulnerability is not exploitable, this field should include specific details
+ on why the component or service is not impacted by this vulnerability.
+
+
+
+
+
+
+
+
+ The components or services that are affected by the vulnerability.
+
+
+
+
+
+
+
+
+ References a component or service by the objects bom-ref.
+
+
+
+
+ Zero or more individual versions or range of versions.
+
+
+
+
+
+
+
+
+
+ A single version of a component or service.
+
+
+
+
+ A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst
+
+
+
+
+
+
+ The vulnerability status for the version or range of versions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the vulnerability elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+ The name of the source.
+ For example: NVD, National Vulnerability Database, OSS Index, VulnDB, and GitHub Advisories
+
+
+
+
+
+ The url of the vulnerability documentation as provided by the source.
+ For example: https://nvd.nist.gov/vuln/detail/CVE-2021-39182
+
+
+
+
+
+
+
+
+
+ The source that calculated the severity or risk rating of the vulnerability.
+
+
+
+
+ The numerical score of the rating.
+
+
+
+
+ Textual representation of the severity that corresponds to the numerical score of the rating.
+
+
+
+
+ The risk scoring methodology/standard used.
+
+
+
+
+ Textual representation of the metric values used to score the vulnerability.
+
+
+
+
+ An optional reason for rating the vulnerability as it was.
+
+
+
+
+
+
+
+
+
+ An optional name of the advisory.
+
+
+
+
+ Location where the advisory can be obtained.
+
+
+
+
+
+
+
+
+ Textual representation of the severity of the vulnerability adopted by the analysis method. If the
+ analysis method uses values other than what is provided, the user is expected to translate appropriately.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.
+
+
+
+
+
+
+ The vulnerability has been remediated.
+
+
+
+
+
+
+ The vulnerability has been remediated and evidence of the changes are provided in the affected
+ components pedigree containing verifiable commit history and/or diff(s).
+
+
+
+
+
+
+ The vulnerability may be directly or indirectly exploitable.
+
+
+
+
+
+
+ The vulnerability is being investigated.
+
+
+
+
+
+
+ The vulnerability is not specific to the component or service and was falsely identified or associated.
+
+
+
+
+
+
+ The component or service is not affected by the vulnerability. Justification should be specified
+ for all not_affected cases.
+
+
+
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+
+ The code has been removed or tree-shaked.
+
+
+
+
+
+
+ The vulnerable code is not invoked at runtime.
+
+
+
+
+
+
+ Exploitability requires a configurable option to be set/unset.
+
+
+
+
+
+
+ Exploitability requires a dependency that is not present.
+
+
+
+
+
+
+ Exploitability requires a certain environment which is not present.
+
+
+
+
+
+
+ Exploitability requires a compiler flag to be set/unset.
+
+
+
+
+
+
+ Exploits are prevented at runtime.
+
+
+
+
+
+
+ Attacks are blocked at physical, logical, or network perimeter.
+
+
+
+
+
+
+ Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.
+
+
+
+
+
+
+
+
+
+ Specifies the severity or risk scoring methodology or standard used.
+
+
+
+
+
+
+ The rating is based on CVSS v2 standard
+ https://www.first.org/cvss/v2/
+
+
+
+
+
+
+ The rating is based on CVSS v3.0 standard
+ https://www.first.org/cvss/v3-0/
+
+
+
+
+
+
+ The rating is based on CVSS v3.1 standard
+ https://www.first.org/cvss/v3-1/
+
+
+
+
+
+
+ The rating is based on OWASP Risk Rating
+ https://owasp.org/www-community/OWASP_Risk_Rating_Methodology
+
+
+
+
+
+
+ Use this if the risk scoring methodology is not based on any of the options above
+
+
+
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The vulnerability status of a given version or range of versions of a product. The statuses
+ 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability.
+ The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected.
+ There can be many reasons for an 'unknown' status, including that an investigation has not been
+ undertaken or that a vendor has not disclosed the status.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Provides additional information about a BOM.
+
+
+
+
+ A list of software and hardware components.
+
+
+
+
+ A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services.
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+ Provides the ability to document dependency relationships.
+
+
+
+
+ Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness.
+
+
+
+
+ Provides the ability to document properties in a key/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+ Vulnerabilities identified in components or services.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Whenever an existing BOM is modified, either manually or through automated
+ processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with
+ multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM.
+ The default version is '1'.
+
+
+
+
+ Every BOM generated SHOULD have a unique serial number, even if the contents of
+ the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122.
+ Use of serial numbers are RECOMMENDED.
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.5.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.5.SNAPSHOT.schema.json
new file mode 100644
index 00000000..72781e90
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.5.SNAPSHOT.schema.json
@@ -0,0 +1,3796 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/bom-1.5.schema.json",
+ "type": "object",
+ "title": "CycloneDX Software Bill of Materials Standard",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "$schema": {
+ "type": "string"
+ },
+ "bomFormat": {
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention nor does JSON schema support namespaces. This value MUST be \"CycloneDX\".",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification a BOM conforms to (starting at version 1.2).",
+ "examples": ["1.5"]
+ },
+ "serialNumber": {
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122. Use of serial numbers are RECOMMENDED.",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.",
+ "minimum": 1,
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components."
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services."
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "dependencies": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency relationships."
+ },
+ "compositions": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/compositions"},
+ "uniqueItems": true,
+ "title": "Compositions",
+ "description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described."
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/vulnerability"},
+ "uniqueItems": true,
+ "title": "Vulnerabilities",
+ "description": "Vulnerabilities identified in components or services."
+ },
+ "annotations": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/annotations"},
+ "uniqueItems": true,
+ "title": "Annotations",
+ "description": "Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinion or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link, and may optionally be signed."
+ },
+ "formulation": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/formula"},
+ "uniqueItems": true,
+ "title": "Formulation",
+ "description": "Describes how a component or service was manufactured or deployed. This is achieved through the use of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the observed formulas describing the steps which transpired in the manufacturing process."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "description": "Identifier for referable and therefore interlink-able elements.",
+ "type": "string",
+ "minLength": 1,
+ "$comment": "value SHOULD not start with the BOM-Link intro 'urn:cdx:'"
+ },
+ "refLinkType": {
+ "description": "Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\nIn contrast to `bomLinkElementType`.",
+ "allOf": [{"$ref": "#/definitions/refType"}]
+ },
+ "bomLinkDocumentType": {
+ "title": "BOM-Link Document",
+ "description": "Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/",
+ "type": "string",
+ "format": "iri-reference",
+ "pattern": "^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$",
+ "$comment": "part of the pattern is based on `bom.serialNumber`'s pattern"
+ },
+ "bomLinkElementType": {
+ "title": "BOM-Link Element",
+ "description": "Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/",
+ "type": "string",
+ "format": "iri-reference",
+ "pattern": "^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$",
+ "$comment": "part of the pattern is based on `bom.serialNumber`'s pattern"
+ },
+ "bomLink": {
+ "anyOf": [
+ {
+ "title": "BOM-Link Document",
+ "$ref": "#/definitions/bomLinkDocumentType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata Object",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the BOM was created."
+ },
+ "lifecycles": {
+ "type": "array",
+ "title": "Lifecycles",
+ "description": "",
+ "items": {
+ "type": "object",
+ "title": "Lifecycle",
+ "description": "The product lifecycle(s) that this BOM represents.",
+ "oneOf": [
+ {
+ "required": ["phase"],
+ "additionalProperties": false,
+ "properties": {
+ "phase": {
+ "type": "string",
+ "title": "Phase",
+ "description": "A pre-defined phase in the product lifecycle.\n\n* __design__ = BOM produced early in the development lifecycle containing inventory of components and services that are proposed or planned to be used. The inventory may need to be procured, retrieved, or resourced prior to use.\n* __pre-build__ = BOM consisting of information obtained prior to a build process and may contain source files and development artifacts and manifests. The inventory may need to be resolved and retrieved prior to use.\n* __build__ = BOM consisting of information obtained during a build process where component inventory is available for use. The precise versions of resolved components are usually available at this time as well as the provenance of where the components were retrieved from.\n* __post-build__ = BOM consisting of information obtained after a build process has completed and the resulting components(s) are available for further analysis. Built components may exist as the result of a CI/CD process, may have been installed or deployed to a system or device, and may need to be retrieved or extracted from the system or device.\n* __operations__ = BOM produced that represents inventory that is running and operational. This may include staging or production environments and will generally encompass multiple SBOMs describing the applications and operating system, along with HBOMs describing the hardware that makes up the system. Operations Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations, and additional dependencies.\n* __discovery__ = BOM consisting of information observed through network discovery providing point-in-time enumeration of embedded, on-premise, and cloud-native services such as server applications, connected devices, microservices, and serverless functions.\n* __decommission__ = BOM containing inventory that will be, or has been retired from operations.",
+ "enum": [
+ "design",
+ "pre-build",
+ "build",
+ "post-build",
+ "operations",
+ "discovery",
+ "decommission"
+ ]
+ }
+ }
+ },
+ {
+ "required": ["name"],
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the lifecycle phase"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "The description of the lifecycle phase"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "tools": {
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "Creation Tools",
+ "description": "The tool(s) used in the creation of the BOM.",
+ "additionalProperties": false,
+ "properties": {
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components used as tools"
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services."
+ }
+ }
+ },
+ {
+ "type": "array",
+ "title": "Creation Tools (legacy)",
+ "description": "[Deprecated] The tool(s) used in the creation of the BOM.",
+ "items": {"$ref": "#/definitions/tool"}
+ }
+ ]
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Authors",
+ "description": "The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may not have authors.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "title": "Manufacture",
+ "description": "The organization that manufactured the component that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "licenses": {
+ "title": "BOM License(s)",
+ "$ref": "#/definitions/licenseChoice"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "[Deprecated] - DO NOT USE. This will be removed in a future version. This will be removed in a future version. Use component or service instead. Information about the automated or manual tool used",
+ "additionalProperties": false,
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "title": "Tool Vendor",
+ "description": "The name of the vendor who created the tool"
+ },
+ "name": {
+ "type": "string",
+ "title": "Tool Name",
+ "description": "The name of the tool"
+ },
+ "version": {
+ "type": "string",
+ "title": "Tool Version",
+ "description": "The version of the tool"
+ },
+ "hashes": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the organization",
+ "examples": [
+ "Example Inc."
+ ]
+ },
+ "url": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "URL",
+ "description": "The URL of the organization. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ },
+ "contact": {
+ "type": "array",
+ "title": "Contact",
+ "description": "A contact at the organization. Multiple contacts are allowed.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "examples": ["Contact name"]
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "Email Address",
+ "description": "The email address of the contact.",
+ "examples": ["firstname.lastname@example.com"]
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact.",
+ "examples": ["800-555-1212"]
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component Object",
+ "required": [
+ "type",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "platform",
+ "operating-system",
+ "device",
+ "device-driver",
+ "firmware",
+ "file",
+ "machine-learning-model",
+ "data"
+ ],
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component. Types include:\n\n* __application__ = A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.\n* __framework__ = A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.\n* __library__ = A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing))\n for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is RECOMMENDED.\n* __container__ = A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization)\n* __platform__ = A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms.\n* __operating-system__ = A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system)\n* __device__ = A hardware device such as a processor, or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself, and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device.\n See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).\n* __device-driver__ = A special type of software that operates or controls a particular type of device. Refer to [https://en.wikipedia.org/wiki/Device_driver](https://en.wikipedia.org/wiki/Device_driver)\n* __firmware__ = A special type of software that provides low-level control over a devices hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware)\n* __file__ = A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.\n* __machine-learning-model__ = A model based on training data that can make predictions or decisions without being explicitly programmed to do so.\n* __data__ = A collection of discrete values that convey information.",
+ "examples": ["library"]
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "author": {
+ "type": "string",
+ "title": "Component Author",
+ "description": "The person(s) or organization(s) that authored the component",
+ "examples": ["Acme Inc"]
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the component",
+ "examples": ["Acme Inc"]
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "examples": ["tomcat-catalina"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.",
+ "examples": ["9.0.14"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.",
+ "default": "required"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "$ref": "#/definitions/licenseChoice",
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "A copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"]
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Component Common Platform Enumeration (CPE)",
+ "description": "Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See [https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe)",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]
+ },
+ "purl": {
+ "type": "string",
+ "title": "Component Package URL (purl)",
+ "description": "Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec)",
+ "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"]
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for [ISO-IEC 19770-2 Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html)."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "[Deprecated] - DO NOT USE. This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
+ "additionalProperties": false,
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the relationship between the components are not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured commentary describing the components pedigree."
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains."
+ },
+ "evidence": {
+ "$ref": "#/definitions/componentEvidence",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "modelCard": {
+ "$ref": "#/definitions/modelCard",
+ "title": "Machine Learning Model Card"
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/componentData"},
+ "title": "Data",
+ "description": "This object SHOULD be specified for any component of type `data` and MUST NOT be specified for other component types."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the SWID file.",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
+ "default": "text/plain"
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is represented in.",
+ "enum": [
+ "base64"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text."
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ],
+ "title": "Hash Algorithm"
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Content (value)",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License Object",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "id": {
+ "$ref": "spdx.SNAPSHOT.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license ID",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "If SPDX does not define the license used, this field may be used to provide the license name",
+ "examples": ["Acme Software License"]
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+ "format": "iri-reference"
+ },
+ "licensing": {
+ "type": "object",
+ "title": "Licensing information",
+ "description": "Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata",
+ "additionalProperties": false,
+ "properties": {
+ "altIds": {
+ "type": "array",
+ "title": "Alternate License Identifiers",
+ "description": "License identifiers that may be used to manage licenses and their lifecycle",
+ "items": {
+ "type": "string"
+ }
+ },
+ "licensor": {
+ "title": "Licensor",
+ "description": "The individual or organization that grants a license to another individual or organization",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Licensor (Organization)",
+ "description": "The organization that granted the license",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "title": "Licensor (Individual)",
+ "description": "The individual, not associated with an organization, that granted the license",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["individual"]
+ }
+ ]
+ },
+ "licensee": {
+ "title": "Licensee",
+ "description": "The individual or organization for which a license was granted to",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Licensee (Organization)",
+ "description": "The organization that was granted the license",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "title": "Licensee (Individual)",
+ "description": "The individual, not associated with an organization, that was granted the license",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["individual"]
+ }
+ ]
+ },
+ "purchaser": {
+ "title": "Purchaser",
+ "description": "The individual or organization that purchased the license",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Purchaser (Organization)",
+ "description": "The organization that purchased the license",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "title": "Purchaser (Individual)",
+ "description": "The individual, not associated with an organization, that purchased the license",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["individual"]
+ }
+ ]
+ },
+ "purchaseOrder": {
+ "type": "string",
+ "title": "Purchase Order",
+ "description": "The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase"
+ },
+ "licenseTypes": {
+ "type": "array",
+ "title": "License Type",
+ "description": "The type of license(s) that was granted to the licensee\n\n* __academic__ = A license that grants use of software solely for the purpose of education or research.\n* __appliance__ = A license covering use of software embedded in a specific piece of hardware.\n* __client-access__ = A Client Access License (CAL) allows client computers to access services provided by server software.\n* __concurrent-user__ = A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users.\n* __core-points__ = A license where the core of a computer's processor is assigned a specific number of points.\n* __custom-metric__ = A license for which consumption is measured by non-standard metrics.\n* __device__ = A license that covers a defined number of installations on computers and other types of devices.\n* __evaluation__ = A license that grants permission to install and use software for trial purposes.\n* __named-user__ = A license that grants access to the software to one or more pre-defined users.\n* __node-locked__ = A license that grants access to the software on one or more pre-defined computers or devices.\n* __oem__ = An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware.\n* __perpetual__ = A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely.\n* __processor-points__ = A license where each installation consumes points per processor.\n* __subscription__ = A license where the licensee pays a fee to use the software or service.\n* __user__ = A license that grants access to the software or service by a specified number of users.\n* __other__ = Another license type.\n",
+ "items": {
+ "type": "string",
+ "enum": [
+ "academic",
+ "appliance",
+ "client-access",
+ "concurrent-user",
+ "core-points",
+ "custom-metric",
+ "device",
+ "evaluation",
+ "named-user",
+ "node-locked",
+ "oem",
+ "perpetual",
+ "processor-points",
+ "subscription",
+ "user",
+ "other"
+ ]
+ }
+ },
+ "lastRenewal": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Last Renewal",
+ "description": "The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed."
+ },
+ "expiration": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Expiration",
+ "description": "The timestamp indicating when the current license expires (if applicable)."
+ }
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "licenseChoice": {
+ "title": "License Choice",
+ "description": "EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)",
+ "type": "array",
+ "oneOf": [
+ {
+ "title": "Multiple licenses",
+ "description": "A list of SPDX licenses and/or named licenses.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": ["license"],
+ "additionalProperties": false,
+ "properties": {
+ "license": {"$ref": "#/definitions/license"}
+ }
+ }
+ },
+ {
+ "title": "SPDX License Expression",
+ "description": "A tuple of exactly one SPDX License Expression.",
+ "type": "array",
+ "additionalItems": false,
+ "minItems": 1,
+ "maxItems": 1,
+ "items": [{
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["expression"],
+ "properties": {
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ]
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ }
+ }
+ }]
+ }
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "title": "Type",
+ "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.\n\n* __unofficial__ = A patch which is not developed by the creators or maintainers of the software being patched. Refer to [https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch)\n* __monkey__ = A patch which dynamically modifies runtime behavior. Refer to [https://en.wikipedia.org/wiki/Monkey_patch](https://en.wikipedia.org/wiki/Monkey_patch)\n* __backport__ = A patch which takes code from a newer version of software and applies it to older versions of the same software. Refer to [https://en.wikipedia.org/wiki/Backporting](https://en.wikipedia.org/wiki/Backporting)\n* __cherry-pick__ = A patch created by selectively applying commits from other versions or branches of the same software."
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to [https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Diff",
+ "description": "An individual issue that has been resolved.",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "title": "Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier of the issue assigned by the source of the issue"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the issue"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the issue"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source. For example 'National Vulnerability Database', 'NVD', and 'Apache'"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided by the source",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM.",
+ "required": [
+ "url",
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "anyOf": [
+ {
+ "title": "URL",
+ "type": "string",
+ "format": "iri-reference"
+ },
+ {
+ "title": "BOM-Link",
+ "$ref": "#/definitions/bomLink"
+ }
+ ],
+ "title": "URL",
+ "description": "The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https ([RFC-7230](https://www.ietf.org/rfc/rfc7230.txt)), mailto ([RFC-2368](https://www.ietf.org/rfc/rfc2368.txt)), tel ([RFC-3966](https://www.ietf.org/rfc/rfc3966.txt)), and dns ([RFC-4501](https://www.ietf.org/rfc/rfc4501.txt)). External references may also include formally registered URNs such as [CycloneDX BOM-Link](https://cyclonedx.org/capabilities/bomlink/) to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs."
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external reference"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference.\n\n* __vcs__ = Version Control System\n* __issue-tracker__ = Issue or defect tracking system, or an Application Lifecycle Management (ALM) system\n* __website__ = Website\n* __advisories__ = Security advisories\n* __bom__ = Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc)\n* __mailing-list__ = Mailing list or discussion group\n* __social__ = Social media account\n* __chat__ = Real-time chat platform\n* __documentation__ = Documentation, guides, or how-to instructions\n* __support__ = Community or commercial support\n* __distribution__ = Direct or repository download location\n* __distribution-intake__ = The location where a component was published to. This is often the same as \"distribution\" but may also include specialized publishing processes that act as an intermediary\n* __license__ = The URL to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness\n* __build-meta__ = Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)\n* __build-system__ = URL to an automated build system\n* __release-notes__ = URL to release notes\n* __security-contact__ = Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT\n* __model-card__ = A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency\n* __log__ = A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations\n* __configuration__ = Parameters or settings that may be used by other components or services\n* __evidence__ = Information used to substantiate a claim\n* __formulation__ = Describes how a component or service was manufactured or deployed\n* __attestation__ = Human or machine-readable statements containing facts, evidence, or testimony\n* __threat-model__ = An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format\n* __adversary-model__ = The defined assumptions, goals, and capabilities of an adversary.\n* __risk-assessment__ = Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.\n* __vulnerability-assertion__ = A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.\n* __exploitability-statement__ = A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.\n* __pentest-report__ = Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test\n* __static-analysis-report__ = SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code\n* __dynamic-analysis-report__ = Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations\n* __runtime-analysis-report__ = Report generated by analyzing the call stack of a running application\n* __component-analysis-report__ = Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis\n* __maturity-report__ = Report containing a formal assessment of an organization, business unit, or team against a maturity model\n* __certification-report__ = Industry, regulatory, or other certification from an accredited (if applicable) certification body\n* __quality-metrics__ = Report or system in which quality metrics can be obtained\n* __codified-infrastructure__ = Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)\n* __poam__ = Plans of Action and Milestones (POAM) compliment an \"attestation\" external reference. POAM is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".\n* __other__ = Use this if no other types accurately describe the purpose of the external reference",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "distribution",
+ "distribution-intake",
+ "license",
+ "build-meta",
+ "build-system",
+ "release-notes",
+ "security-contact",
+ "model-card",
+ "log",
+ "configuration",
+ "evidence",
+ "formulation",
+ "attestation",
+ "threat-model",
+ "adversary-model",
+ "risk-assessment",
+ "vulnerability-assertion",
+ "exploitability-statement",
+ "pentest-report",
+ "static-analysis-report",
+ "dynamic-analysis-report",
+ "runtime-analysis-report",
+ "component-analysis-report",
+ "maturity-report",
+ "certification-report",
+ "codified-infrastructure",
+ "quality-metrics",
+ "poam",
+ "other"
+ ]
+ },
+ "hashes": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the external reference (if applicable)."
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component or service. Components or services that do not have their own dependencies MUST be declared as empty elements within the graph. Components or services that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of a object being dependency-free. It is RECOMMENDED to leverage compositions to indicate unknown dependency graphs.",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refLinkType",
+ "title": "Reference",
+ "description": "References a component or service by its bom-ref attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/refLinkType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components or services that are dependencies of this dependency object."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service Object",
+ "required": [
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a shortened, single name of the service.",
+ "examples": ["ticker-service"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Service Version",
+ "description": "The service version.",
+ "examples": ["1.0.0"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service"
+ },
+ "endpoints": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
+ "examples": ["https://example.com/api/v1/ticker"]
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
+ },
+ "trustZone": {
+ "type": "string",
+ "title": "Trust Zone",
+ "description": "The name of the trust zone the service resides in."
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/serviceData"},
+ "title": "Data",
+ "description": "Specifies information about the data including the directional flow of data and the data classification."
+ },
+ "licenses": {
+ "$ref": "#/definitions/licenseChoice",
+ "title": "Component License(s)"
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services included or deployed behind the parent service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "serviceData": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlowDirection",
+ "title": "Directional Flow",
+ "description": "Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known."
+ },
+ "classification": {
+ "$ref": "#/definitions/dataClassification"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Name for the defined data",
+ "examples": [
+ "Credit card reporting"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "Short description of the data content and usage",
+ "examples": [
+ "Credit card information being exchanged in between the web app and the database"
+ ]
+ },
+ "governance": {
+ "type": "object",
+ "title": "Data Governance",
+ "$ref": "#/definitions/dataGovernance"
+ },
+ "source": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "title": "URL",
+ "type": "string",
+ "format": "iri-reference"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "Source",
+ "description": "The URI, URL, or BOM-Link of the components or services the data came in from"
+ },
+ "destination": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "title": "URL",
+ "type": "string",
+ "format": "iri-reference"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "Destination",
+ "description": "The URI, URL, or BOM-Link of the components or services the data is sent to"
+ }
+ }
+ },
+ "dataFlowDirection": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "title": "Data flow direction",
+ "description": "Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways, and unknown states that the direction is not known."
+ },
+
+ "copyright": {
+ "type": "object",
+ "title": "Copyright",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string",
+ "title": "Copyright Text"
+ }
+ }
+ },
+ "componentEvidence": {
+ "type": "object",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis.",
+ "additionalProperties": false,
+ "properties": {
+ "identity": {
+ "type": "object",
+ "description": "Evidence that substantiates the identity of a component.",
+ "required": [ "field" ],
+ "additionalProperties": false,
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": [
+ "group", "name", "version", "purl", "cpe", "swid", "hash"
+ ],
+ "title": "Field",
+ "description": "The identity field of the component which the evidence describes."
+ },
+ "confidence": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "title": "Confidence",
+ "description": "The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence."
+ },
+ "methods": {
+ "type": "array",
+ "title": "Methods",
+ "description": "The methods used to extract and/or analyze the evidence.",
+ "items": {
+ "type": "object",
+ "required": [
+ "technique" ,
+ "confidence"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "technique": {
+ "title": "Technique",
+ "description": "The technique used in this method of analysis.",
+ "type": "string",
+ "enum": [
+ "source-code-analysis",
+ "binary-analysis",
+ "manifest-analysis",
+ "ast-fingerprint",
+ "hash-comparison",
+ "instrumentation",
+ "dynamic-analysis",
+ "filename",
+ "attestation",
+ "other"
+ ]
+ },
+ "confidence": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "title": "Confidence",
+ "description": "The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value or contents of the evidence."
+ }
+ }
+ }
+ },
+ "tools": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "BOM References",
+ "description": "The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation."
+ }
+ }
+ },
+ "occurrences": {
+ "type": "array",
+ "title": "Occurrences",
+ "description": "Evidence of individual instances of a component spread across multiple locations.",
+ "items": {
+ "type": "object",
+ "required": [ "location" ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "location": {
+ "type": "string",
+ "title": "Location",
+ "description": "The location or path to where the component was found."
+ }
+ }
+ }
+ },
+ "callstack": {
+ "type": "object",
+ "description": "Evidence of the components use through the callstack.",
+ "additionalProperties": false,
+ "properties": {
+ "frames": {
+ "type": "array",
+ "title": "Methods",
+ "items": {
+ "type": "object",
+ "required": [
+ "module"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "package": {
+ "title": "Package",
+ "description": "A package organizes modules into namespaces, providing a unique namespace for each type it contains.",
+ "type": "string"
+ },
+ "module": {
+ "title": "Module",
+ "description": "A module or class that encloses functions/methods and other code.",
+ "type": "string"
+ },
+ "function": {
+ "title": "Function",
+ "description": "A block of code designed to perform a particular task.",
+ "type": "string"
+ },
+ "parameters": {
+ "title": "Parameters",
+ "description": "Optional arguments that are passed to the module or function.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "line": {
+ "title": "Line",
+ "description": "The line number the code that is called resides on.",
+ "type": "integer"
+ },
+ "column": {
+ "title": "Column",
+ "description": "The column the code that is called resides.",
+ "type": "integer"
+ },
+ "fullFilename": {
+ "title": "Full Filename",
+ "description": "The full path and filename of the module.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "licenses": {
+ "$ref": "#/definitions/licenseChoice",
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/copyright"},
+ "title": "Copyright"
+ }
+ }
+ },
+ "compositions": {
+ "type": "object",
+ "title": "Compositions",
+ "required": [
+ "aggregate"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "aggregate": {
+ "$ref": "#/definitions/aggregateType",
+ "title": "Aggregate",
+ "description": "Specifies an aggregate type that describe how complete a relationship is.\n\n* __complete__ = The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist.\n* __incomplete__ = The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.\n* __incomplete_first_party_only__ = The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.\n* __incomplete_first_party_proprietary_only__ = The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.\n* __incomplete_first_party_opensource_only__ = The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are opensource.\n* __incomplete_third_party_only__ = The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.\n* __incomplete_third_party_proprietary_only__ = The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.\n* __incomplete_third_party_opensource_only__ = The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.\n* __unknown__ = The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.\n* __not_specified__ = The relationship completeness is not specified.\n"
+ },
+ "assemblies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only."
+ },
+ "dependencies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only."
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the vulnerabilities being described."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "aggregateType": {
+ "type": "string",
+ "default": "not_specified",
+ "enum": [
+ "complete",
+ "incomplete",
+ "incomplete_first_party_only",
+ "incomplete_first_party_proprietary_only",
+ "incomplete_first_party_opensource_only",
+ "incomplete_third_party_only",
+ "incomplete_third_party_proprietary_only",
+ "incomplete_third_party_opensource_only",
+ "unknown",
+ "not_specified"
+ ]
+ },
+ "property": {
+ "type": "object",
+ "title": "Lightweight name-value pair",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the property. Duplicate names are allowed, each potentially having a different value."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value of the property."
+ }
+ }
+ },
+ "localeType": {
+ "type": "string",
+ "pattern": "^([a-z]{2})(-[A-Z]{2})?$",
+ "title": "Locale",
+ "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code MUST be lower case. If the country code is specified, the country code MUST be upper case. The language code and country code MUST be separated by a minus sign. Examples: en, en-US, fr, fr-CA"
+ },
+ "releaseType": {
+ "type": "string",
+ "examples": [
+ "major",
+ "minor",
+ "patch",
+ "pre-release",
+ "internal"
+ ],
+ "description": "The software versioning type. It is RECOMMENDED that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it."
+ },
+ "note": {
+ "type": "object",
+ "title": "Note",
+ "description": "A note containing the locale and content.",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "locale": {
+ "$ref": "#/definitions/localeType",
+ "title": "Locale",
+ "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: \"en\", \"en-US\", \"fr\" and \"fr-CA\""
+ },
+ "text": {
+ "title": "Release note content",
+ "description": "Specifies the full content of the release note.",
+ "$ref": "#/definitions/attachment"
+ }
+ }
+ },
+ "releaseNotes": {
+ "type": "object",
+ "title": "Release notes",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/releaseType",
+ "title": "Type",
+ "description": "The software versioning type the release note describes."
+ },
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "The title of the release."
+ },
+ "featuredImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Featured image",
+ "description": "The URL to an image that may be prominently displayed with the release note."
+ },
+ "socialImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Social image",
+ "description": "The URL to an image that may be used in messaging on social media platforms."
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A short description of the release."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the release note was created."
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Aliases",
+ "description": "One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names)."
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Tags",
+ "description": "One or more tags that may aid in search or retrieval of the release note."
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues that have been resolved."
+ },
+ "notes": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/note"},
+ "title": "Notes",
+ "description": "Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "advisory": {
+ "type": "object",
+ "title": "Advisory",
+ "description": "Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.",
+ "required": ["url"],
+ "additionalProperties": false,
+ "properties": {
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "An optional name of the advisory."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "format": "iri-reference",
+ "description": "Location where the advisory can be obtained."
+ }
+ }
+ },
+ "cwe": {
+ "type": "integer",
+ "minimum": 1,
+ "title": "CWE",
+ "description": "Integer representation of a Common Weaknesses Enumerations (CWE). For example 399 (of https://cwe.mitre.org/data/definitions/399.html)"
+ },
+ "severity": {
+ "type": "string",
+ "title": "Severity",
+ "description": "Textual representation of the severity of the vulnerability adopted by the analysis method. If the analysis method uses values other than what is provided, the user is expected to translate appropriately.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ "info",
+ "none",
+ "unknown"
+ ]
+ },
+ "scoreMethod": {
+ "type": "string",
+ "title": "Method",
+ "description": "Specifies the severity or risk scoring methodology or standard used.\n\n* CVSSv2 - [Common Vulnerability Scoring System v2](https://www.first.org/cvss/v2/)\n* CVSSv3 - [Common Vulnerability Scoring System v3](https://www.first.org/cvss/v3-0/)\n* CVSSv31 - [Common Vulnerability Scoring System v3.1](https://www.first.org/cvss/v3-1/)\n* CVSSv4 - [Common Vulnerability Scoring System v4](https://www.first.org/cvss/v4-0/)\n* OWASP - [OWASP Risk Rating Methodology](https://owasp.org/www-community/OWASP_Risk_Rating_Methodology)\n* SSVC - [Stakeholder Specific Vulnerability Categorization](https://github.com/CERTCC/SSVC) (all versions)",
+ "enum": [
+ "CVSSv2",
+ "CVSSv3",
+ "CVSSv31",
+ "CVSSv4",
+ "OWASP",
+ "SSVC",
+ "other"
+ ]
+ },
+ "impactAnalysisState": {
+ "type": "string",
+ "title": "Impact Analysis State",
+ "description": "Declares the current state of an occurrence of a vulnerability, after automated or manual analysis. \n\n* __resolved__ = the vulnerability has been remediated. \n* __resolved\\_with\\_pedigree__ = the vulnerability has been remediated and evidence of the changes are provided in the affected components pedigree containing verifiable commit history and/or diff(s). \n* __exploitable__ = the vulnerability may be directly or indirectly exploitable. \n* __in\\_triage__ = the vulnerability is being investigated. \n* __false\\_positive__ = the vulnerability is not specific to the component or service and was falsely identified or associated. \n* __not\\_affected__ = the component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases.",
+ "enum": [
+ "resolved",
+ "resolved_with_pedigree",
+ "exploitable",
+ "in_triage",
+ "false_positive",
+ "not_affected"
+ ]
+ },
+ "impactAnalysisJustification": {
+ "type": "string",
+ "title": "Impact Analysis Justification",
+ "description": "The rationale of why the impact analysis state was asserted. \n\n* __code\\_not\\_present__ = the code has been removed or tree-shaked. \n* __code\\_not\\_reachable__ = the vulnerable code is not invoked at runtime. \n* __requires\\_configuration__ = exploitability requires a configurable option to be set/unset. \n* __requires\\_dependency__ = exploitability requires a dependency that is not present. \n* __requires\\_environment__ = exploitability requires a certain environment which is not present. \n* __protected\\_by\\_compiler__ = exploitability requires a compiler flag to be set/unset. \n* __protected\\_at\\_runtime__ = exploits are prevented at runtime. \n* __protected\\_at\\_perimeter__ = attacks are blocked at physical, logical, or network perimeter. \n* __protected\\_by\\_mitigating\\_control__ = preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.",
+ "enum": [
+ "code_not_present",
+ "code_not_reachable",
+ "requires_configuration",
+ "requires_dependency",
+ "requires_environment",
+ "protected_by_compiler",
+ "protected_at_runtime",
+ "protected_at_perimeter",
+ "protected_by_mitigating_control"
+ ]
+ },
+ "rating": {
+ "type": "object",
+ "title": "Rating",
+ "description": "Defines the severity or risk ratings of a vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that calculated the severity or risk rating of the vulnerability."
+ },
+ "score": {
+ "type": "number",
+ "title": "Score",
+ "description": "The numerical score of the rating."
+ },
+ "severity": {
+ "$ref": "#/definitions/severity",
+ "description": "Textual representation of the severity that corresponds to the numerical score of the rating."
+ },
+ "method": {
+ "$ref": "#/definitions/scoreMethod"
+ },
+ "vector": {
+ "type": "string",
+ "title": "Vector",
+ "description": "Textual representation of the metric values used to score the vulnerability"
+ },
+ "justification": {
+ "type": "string",
+ "title": "Justification",
+ "description": "An optional reason for rating the vulnerability as it was"
+ }
+ }
+ },
+ "vulnerabilitySource": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of vulnerability information. This is often the organization that published the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the vulnerability documentation as provided by the source.",
+ "examples": [
+ "https://nvd.nist.gov/vuln/detail/CVE-2021-39182"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source.",
+ "examples": [
+ "NVD",
+ "National Vulnerability Database",
+ "OSS Index",
+ "VulnDB",
+ "GitHub Advisories"
+ ]
+ }
+ }
+ },
+ "vulnerability": {
+ "type": "object",
+ "title": "Vulnerability",
+ "description": "Defines a weakness in a component or service that could be exploited or triggered by a threat source.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier that uniquely identifies the vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ },
+ "references": {
+ "type": "array",
+ "title": "References",
+ "description": "Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "source"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "An identifier that uniquely identifies the vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ }
+ }
+ }
+ },
+ "ratings": {
+ "type": "array",
+ "title": "Ratings",
+ "description": "List of vulnerability ratings",
+ "items": {
+ "$ref": "#/definitions/rating"
+ }
+ },
+ "cwes": {
+ "type": "array",
+ "title": "CWEs",
+ "description": "List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability. For example 399 (of https://cwe.mitre.org/data/definitions/399.html)",
+ "examples": [399],
+ "items": {
+ "$ref": "#/definitions/cwe"
+ }
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the vulnerability as provided by the source."
+ },
+ "detail": {
+ "type": "string",
+ "title": "Details",
+ "description": "If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding root cause."
+ },
+ "recommendation": {
+ "type": "string",
+ "title": "Recommendation",
+ "description": "Recommendations of how the vulnerability can be remediated or mitigated."
+ },
+ "workaround": {
+ "type": "string",
+ "title": "Workarounds",
+ "description": "A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments."
+ },
+ "proofOfConcept": {
+ "type": "object",
+ "title": "Proof of Concept",
+ "description": "Evidence used to reproduce the vulnerability.",
+ "properties": {
+ "reproductionSteps": {
+ "type": "string",
+ "title": "Steps to Reproduce",
+ "description": "Precise steps to reproduce the vulnerability."
+ },
+ "environment": {
+ "type": "string",
+ "title": "Environment",
+ "description": "A description of the environment in which reproduction was possible."
+ },
+ "supportingMaterial": {
+ "type": "array",
+ "title": "Supporting Material",
+ "description": "Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code.",
+ "items": { "$ref": "#/definitions/attachment" }
+ }
+ }
+ },
+ "advisories": {
+ "type": "array",
+ "title": "Advisories",
+ "description": "Published advisories of the vulnerability if provided.",
+ "items": {
+ "$ref": "#/definitions/advisory"
+ }
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created",
+ "description": "The date and time (timestamp) when the vulnerability record was created in the vulnerability database."
+ },
+ "published": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Published",
+ "description": "The date and time (timestamp) when the vulnerability record was first published."
+ },
+ "updated": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Updated",
+ "description": "The date and time (timestamp) when the vulnerability record was last updated."
+ },
+ "rejected": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Rejected",
+ "description": "The date and time (timestamp) when the vulnerability record was rejected (if applicable)."
+ },
+ "credits": {
+ "type": "object",
+ "title": "Credits",
+ "description": "Individuals or organizations credited with the discovery of the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "organizations": {
+ "type": "array",
+ "title": "Organizations",
+ "description": "The organizations credited with vulnerability discovery.",
+ "items": {
+ "$ref": "#/definitions/organizationalEntity"
+ }
+ },
+ "individuals": {
+ "type": "array",
+ "title": "Individuals",
+ "description": "The individuals, not associated with organizations, that are credited with vulnerability discovery.",
+ "items": {
+ "$ref": "#/definitions/organizationalContact"
+ }
+ }
+ }
+ },
+ "tools": {
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "Tools",
+ "description": "The tool(s) used to identify, confirm, or score the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components used as tools"
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services."
+ }
+ }
+ },
+ {
+ "type": "array",
+ "title": "Tools (legacy)",
+ "description": "[Deprecated] The tool(s) used to identify, confirm, or score the vulnerability.",
+ "items": {"$ref": "#/definitions/tool"}
+ }
+ ]
+ },
+ "analysis": {
+ "type": "object",
+ "title": "Impact Analysis",
+ "description": "An assessment of the impact and exploitability of the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "state": {
+ "$ref": "#/definitions/impactAnalysisState"
+ },
+ "justification": {
+ "$ref": "#/definitions/impactAnalysisJustification"
+ },
+ "response": {
+ "type": "array",
+ "title": "Response",
+ "description": "A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "can_not_fix",
+ "will_not_fix",
+ "update",
+ "rollback",
+ "workaround_available"
+ ]
+ }
+ },
+ "detail": {
+ "type": "string",
+ "title": "Detail",
+ "description": "Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability."
+ },
+ "firstIssued": {
+ "type": "string",
+ "format": "date-time",
+ "title": "First Issued",
+ "description": "The date and time (timestamp) when the analysis was first issued."
+ },
+ "lastUpdated": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Last Updated",
+ "description": "The date and time (timestamp) when the analysis was last updated."
+ }
+ }
+ },
+ "affects": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "object",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ],
+ "title": "Reference",
+ "description": "References a component or service by the objects bom-ref"
+ },
+ "versions": {
+ "type": "array",
+ "title": "Versions",
+ "description": "Zero or more individual versions or range of versions.",
+ "items": {
+ "type": "object",
+ "oneOf": [
+ {
+ "required": ["version"]
+ },
+ {
+ "required": ["range"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "version": {
+ "description": "A single version of a component or service.",
+ "$ref": "#/definitions/version"
+ },
+ "range": {
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
+ "$ref": "#/definitions/range"
+ },
+ "status": {
+ "description": "The vulnerability status for the version or range of versions.",
+ "$ref": "#/definitions/affectedStatus",
+ "default": "affected"
+ }
+ }
+ }
+ }
+ }
+ },
+ "title": "Affects",
+ "description": "The components or services that are affected by the vulnerability."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "affectedStatus": {
+ "description": "The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.",
+ "type": "string",
+ "enum": [
+ "affected",
+ "unaffected",
+ "unknown"
+ ]
+ },
+ "version": {
+ "description": "A single version of a component or service.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "range": {
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "annotations": {
+ "type": "object",
+ "title": "Annotations",
+ "description": "A comment, note, explanation, or similar textual content which provides additional context to the object(s) being annotated.",
+ "required": [
+ "subjects",
+ "annotator",
+ "timestamp",
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "subjects": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "BOM References",
+ "description": "The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs."
+ },
+ "annotator": {
+ "type": "object",
+ "title": "Annotator",
+ "description": "The organization, person, component, or service which created the textual content of the annotation.",
+ "oneOf": [
+ {
+ "required": [
+ "organization"
+ ]
+ },
+ {
+ "required": [
+ "individual"
+ ]
+ },
+ {
+ "required": [
+ "component"
+ ]
+ },
+ {
+ "required": [
+ "service"
+ ]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "description": "The organization that created the annotation",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "description": "The person that created the annotation",
+ "$ref": "#/definitions/organizationalContact"
+ },
+ "component": {
+ "description": "The tool or component that created the annotation",
+ "$ref": "#/definitions/component"
+ },
+ "service": {
+ "description": "The service that created the annotation",
+ "$ref": "#/definitions/service"
+ }
+ }
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the annotation was created."
+ },
+ "text": {
+ "type": "string",
+ "title": "Text",
+ "description": "The textual content of the annotation."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "modelCard": {
+ "$comment": "Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.",
+ "type": "object",
+ "title": "Model Card",
+ "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and MUST NOT be specified for other component types.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "modelParameters": {
+ "type": "object",
+ "title": "Model Parameters",
+ "description": "Hyper-parameters for construction of the model.",
+ "additionalProperties": false,
+ "properties": {
+ "approach": {
+ "type": "object",
+ "title": "Approach",
+ "description": "The overall approach to learning used by the model for problem solving.",
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "title": "Learning Type",
+ "description": "Learning types describing the learning problem or hybrid learning problem.",
+ "enum": [
+ "supervised",
+ "unsupervised",
+ "reinforcement-learning",
+ "semi-supervised",
+ "self-supervised"
+ ]
+ }
+ }
+ },
+ "task": {
+ "type": "string",
+ "title": "Task",
+ "description": "Directly influences the input and/or output. Examples include classification, regression, clustering, etc."
+ },
+ "architectureFamily": {
+ "type": "string",
+ "title": "Architecture Family",
+ "description": "The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc."
+ },
+ "modelArchitecture": {
+ "type": "string",
+ "title": "Model Architecture",
+ "description": "The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc."
+ },
+ "datasets": {
+ "type": "array",
+ "title": "Datasets",
+ "description": "The datasets used to train and evaluate the model.",
+ "items" : {
+ "oneOf" : [
+ {
+ "title": "Inline Component Data",
+ "$ref": "#/definitions/componentData"
+ },
+ {
+ "type": "object",
+ "title": "Data Component Reference",
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ],
+ "title": "Reference",
+ "description": "References a data component by the components bom-ref attribute"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "inputs": {
+ "type": "array",
+ "title": "Inputs",
+ "description": "The input format(s) of the model",
+ "items": { "$ref": "#/definitions/inputOutputMLParameters" }
+ },
+ "outputs": {
+ "type": "array",
+ "title": "Outputs",
+ "description": "The output format(s) from the model",
+ "items": { "$ref": "#/definitions/inputOutputMLParameters" }
+ }
+ }
+ },
+ "quantitativeAnalysis": {
+ "type": "object",
+ "title": "Quantitative Analysis",
+ "description": "A quantitative analysis of the model",
+ "additionalProperties": false,
+ "properties": {
+ "performanceMetrics": {
+ "type": "array",
+ "title": "Performance Metrics",
+ "description": "The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.",
+ "items": { "$ref": "#/definitions/performanceMetric" }
+ },
+ "graphics": { "$ref": "#/definitions/graphicsCollection" }
+ }
+ },
+ "considerations": {
+ "type": "object",
+ "title": "Considerations",
+ "description": "What considerations should be taken into account regarding the model's construction, training, and application?",
+ "additionalProperties": false,
+ "properties": {
+ "users": {
+ "type": "array",
+ "title": "Users",
+ "description": "Who are the intended users of the model?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "useCases": {
+ "type": "array",
+ "title": "Use Cases",
+ "description": "What are the intended use cases of the model?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "technicalLimitations": {
+ "type": "array",
+ "title": "Technical Limitations",
+ "description": "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "performanceTradeoffs": {
+ "type": "array",
+ "title": "Performance Tradeoffs",
+ "description": "What are the known tradeoffs in accuracy/performance of the model?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ethicalConsiderations": {
+ "type": "array",
+ "title": "Ethical Considerations",
+ "description": "What are the ethical (or environmental) risks involved in the application of this model?",
+ "items": { "$ref": "#/definitions/risk" }
+ },
+ "fairnessAssessments": {
+ "type": "array",
+ "title": "Fairness Assessments",
+ "description": "How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?",
+ "items": {
+ "$ref": "#/definitions/fairnessAssessment"
+ }
+ }
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "inputOutputMLParameters": {
+ "type": "object",
+ "title": "Input and Output Parameters",
+ "additionalProperties": false,
+ "properties": {
+ "format": {
+ "description": "The data format for input/output to the model. Example formats include string, image, time-series",
+ "type": "string"
+ }
+ }
+ },
+ "componentData": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
+ },
+ "type": {
+ "type": "string",
+ "title": "Type of Data",
+ "description": "The general theme or subject matter of the data being specified.\n\n* __source-code__ = Any type of code, code snippet, or data-as-code.\n* __configuration__ = Parameters or settings that may be used by other components.\n* __dataset__ = A collection of data.\n* __definition__ = Data that can be used to create new instances of what the definition defines.\n* __other__ = Any other type of data that does not fit into existing definitions.",
+ "enum": [
+ "source-code",
+ "configuration",
+ "dataset",
+ "definition",
+ "other"
+ ]
+ },
+ "name": {
+ "description": "The name of the dataset.",
+ "type": "string"
+ },
+ "contents": {
+ "type": "object",
+ "title": "Data Contents",
+ "description": "The contents or references to the contents of the data being described.",
+ "additionalProperties": false,
+ "properties": {
+ "attachment": {
+ "title": "Data Attachment",
+ "description": "An optional way to include textual or encoded data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "Data URL",
+ "description": "The URL to where the data can be retrieved.",
+ "format": "iri-reference"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Configuration Properties",
+ "description": "Provides the ability to document name-value parameters used for configuration.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "classification": {
+ "$ref": "#/definitions/dataClassification"
+ },
+ "sensitiveData": {
+ "type": "array",
+ "description": "A description of any sensitive data in a dataset.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "graphics": { "$ref": "#/definitions/graphicsCollection" },
+ "description": {
+ "description": "A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.",
+ "type": "string"
+ },
+ "governance": {
+ "type": "object",
+ "title": "Data Governance",
+ "$ref": "#/definitions/dataGovernance"
+ }
+ }
+ },
+ "dataGovernance": {
+ "type": "object",
+ "title": "Data Governance",
+ "additionalProperties": false,
+ "properties": {
+ "custodians": {
+ "type": "array",
+ "title": "Data Custodians",
+ "description": "Data custodians are responsible for the safe custody, transport, and storage of data.",
+ "items": { "$ref": "#/definitions/dataGovernanceResponsibleParty" }
+ },
+ "stewards": {
+ "type": "array",
+ "title": "Data Stewards",
+ "description": "Data stewards are responsible for data content, context, and associated business rules.",
+ "items": { "$ref": "#/definitions/dataGovernanceResponsibleParty" }
+ },
+ "owners": {
+ "type": "array",
+ "title": "Data Owners",
+ "description": "Data owners are concerned with risk and appropriate access to data.",
+ "items": { "$ref": "#/definitions/dataGovernanceResponsibleParty" }
+ }
+ }
+ },
+ "dataGovernanceResponsibleParty": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Organization",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "contact": {
+ "title": "Individual",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["contact"]
+ }
+ ]
+ },
+ "graphicsCollection": {
+ "type": "object",
+ "title": "Graphics Collection",
+ "description": "A collection of graphics that represent various measurements.",
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "description": "A description of this collection of graphics.",
+ "type": "string"
+ },
+ "collection": {
+ "description": "A collection of graphics.",
+ "type": "array",
+ "items": { "$ref": "#/definitions/graphic" }
+ }
+ }
+ },
+ "graphic": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the graphic.",
+ "type": "string"
+ },
+ "image": {
+ "title": "Graphic Image",
+ "description": "The graphic (vector or raster). Base64 encoding MUST be specified for binary images.",
+ "$ref": "#/definitions/attachment"
+ }
+ }
+ },
+ "performanceMetric": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "description": "The type of performance metric.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the performance metric.",
+ "type": "string"
+ },
+ "slice": {
+ "description": "The name of the slice this metric was computed on. By default, assume this metric is not sliced.",
+ "type": "string"
+ },
+ "confidenceInterval": {
+ "description": "The confidence interval of the metric.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "lowerBound": {
+ "description": "The lower bound of the confidence interval.",
+ "type": "string"
+ },
+ "upperBound": {
+ "description": "The upper bound of the confidence interval.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "risk": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "description": "The name of the risk.",
+ "type": "string"
+ },
+ "mitigationStrategy": {
+ "description": "Strategy used to address this risk.",
+ "type": "string"
+ }
+ }
+ },
+ "fairnessAssessment": {
+ "type": "object",
+ "title": "Fairness Assessment",
+ "description": "Information about the benefits and harms of the model to an identified at risk group.",
+ "additionalProperties": false,
+ "properties": {
+ "groupAtRisk": {
+ "type": "string",
+ "description": "The groups or individuals at risk of being systematically disadvantaged by the model."
+ },
+ "benefits": {
+ "type": "string",
+ "description": "Expected benefits to the identified groups."
+ },
+ "harms": {
+ "type": "string",
+ "description": "Expected harms to the identified groups."
+ },
+ "mitigationStrategy": {
+ "type": "string",
+ "description": "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "string",
+ "title": "Data Classification",
+ "description": "Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed."
+ },
+ "formula": {
+ "title": "Formula",
+ "description": "Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.",
+ "$ref": "#/definitions/refType"
+ },
+ "components": {
+ "title": "Components",
+ "description": "Transient components that are used in tasks that constitute one or more of this formula's workflows",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/component"
+ },
+ "uniqueItems": true
+ },
+ "services": {
+ "title": "Services",
+ "description": "Transient services that are used in tasks that constitute one or more of this formula's workflows",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/service"
+ },
+ "uniqueItems": true
+ },
+ "workflows": {
+ "title": "Workflows",
+ "description": "List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered.",
+ "$comment": "Different workflows can be designed to work together to perform end-to-end CI/CD builds and deployments.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/workflow"
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "workflow": {
+ "title": "Workflow",
+ "description": "A specialized orchestration task.",
+ "$comment": "Workflow are as task themselves and can trigger other workflow tasks. These relationships can be modeled in the taskDependencies graph.",
+ "type": "object",
+ "required": [
+ "bom-ref",
+ "uid",
+ "taskTypes"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "tasks": {
+ "title": "Tasks",
+ "description": "The tasks that comprise the workflow.",
+ "$comment": "Note that tasks can appear more than once as different instances (by name or UID).",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/task"
+ }
+ },
+ "taskDependencies": {
+ "title": "Task dependency graph",
+ "description": "The graph of dependencies between tasks within the workflow.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/dependency"
+ }
+ },
+ "taskTypes": {
+ "title": "Task types",
+ "description": "Indicates the types of activities performed by the set of workflow tasks.",
+ "$comment": "Currently, these types reflect common CI/CD actions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/taskType"
+ }
+ },
+ "trigger": {
+ "title": "Trigger",
+ "description": "The trigger that initiated the task.",
+ "$ref": "#/definitions/trigger"
+ },
+ "steps": {
+ "title": "Steps",
+ "description": "The sequence of steps for the task.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/step"
+ },
+ "uniqueItems": true
+ },
+ "inputs": {
+ "title": "Inputs",
+ "description": "Represents resources and data brought into a task at runtime by executor or task commands",
+ "examples": ["a `configuration` file which was declared as a local `component` or `externalReference`"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/inputType"
+ },
+ "uniqueItems": true
+ },
+ "outputs": {
+ "title": "Outputs",
+ "description": "Represents resources and data output from a task at runtime by executor or task commands",
+ "examples": ["a log file or metrics data produced by the task"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/outputType"
+ },
+ "uniqueItems": true
+ },
+ "timeStart": {
+ "title": "Time start",
+ "description": "The date and time (timestamp) when the task started.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "timeEnd": {
+ "title": "Time end",
+ "description": "The date and time (timestamp) when the task ended.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "workspaces": {
+ "title": "Workspaces",
+ "description": "A set of named filesystem or data resource shareable by workflow tasks.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/workspace"
+ }
+ },
+ "runtimeTopology": {
+ "title": "Runtime topology",
+ "description": "A graph of the component runtime topology for workflow's instance.",
+ "$comment": "A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/dependency"
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "task": {
+ "title": "Task",
+ "description": "Describes the inputs, sequence of steps and resources used to accomplish a task and its output.",
+ "$comment": "Tasks are building blocks for constructing assemble CI/CD workflows or pipelines.",
+ "type": "object",
+ "required": [
+ "bom-ref",
+ "uid",
+ "taskTypes"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "taskTypes": {
+ "title": "Task types",
+ "description": "Indicates the types of activities performed by the set of workflow tasks.",
+ "$comment": "Currently, these types reflect common CI/CD actions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/taskType"
+ }
+ },
+ "trigger": {
+ "title": "Trigger",
+ "description": "The trigger that initiated the task.",
+ "$ref": "#/definitions/trigger"
+ },
+ "steps": {
+ "title": "Steps",
+ "description": "The sequence of steps for the task.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/step"
+ },
+ "uniqueItems": true
+ },
+ "inputs": {
+ "title": "Inputs",
+ "description": "Represents resources and data brought into a task at runtime by executor or task commands",
+ "examples": ["a `configuration` file which was declared as a local `component` or `externalReference`"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/inputType"
+ },
+ "uniqueItems": true
+ },
+ "outputs": {
+ "title": "Outputs",
+ "description": "Represents resources and data output from a task at runtime by executor or task commands",
+ "examples": ["a log file or metrics data produced by the task"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/outputType"
+ },
+ "uniqueItems": true
+ },
+ "timeStart": {
+ "title": "Time start",
+ "description": "The date and time (timestamp) when the task started.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "timeEnd": {
+ "title": "Time end",
+ "description": "The date and time (timestamp) when the task ended.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "workspaces": {
+ "title": "Workspaces",
+ "description": "A set of named filesystem or data resource shareable by workflow tasks.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/workspace"
+ },
+ "uniqueItems": true
+ },
+ "runtimeTopology": {
+ "title": "Runtime topology",
+ "description": "A graph of the component runtime topology for task's instance.",
+ "$comment": "A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/dependency"
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "step": {
+ "type": "object",
+ "description": "Executes specific commands or tools in order to accomplish its owning task as part of a sequence.",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "title": "Name",
+ "description": "A name for the step.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the step.",
+ "type": "string"
+ },
+ "commands": {
+ "title": "Commands",
+ "description": "Ordered list of commands or directives for the step",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/command"
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "command": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "executed": {
+ "title": "Executed",
+ "description": "A text representation of the executed command.",
+ "type": "string"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "workspace": {
+ "title": "Workspace",
+ "description": "A named filesystem or data resource shareable by workflow tasks.",
+ "type": "object",
+ "required": [
+ "bom-ref",
+ "uid"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "aliases": {
+ "title": "Aliases",
+ "description": "The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps.",
+ "type": "array",
+ "items": {"type": "string"}
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "accessMode": {
+ "title": "Access mode",
+ "description": "Describes the read-write access control for the workspace relative to the owning resource instance.",
+ "type": "string",
+ "enum": [
+ "read-only",
+ "read-write",
+ "read-write-once",
+ "write-once",
+ "write-only"
+ ]
+ },
+ "mountPath": {
+ "title": "Mount path",
+ "description": "A path to a location on disk where the workspace will be available to the associated task's steps.",
+ "type": "string"
+ },
+ "managedDataType": {
+ "title": "Managed data type",
+ "description": "The name of a domain-specific data type the workspace represents.",
+ "$comment": "This property is for CI/CD frameworks that are able to provide access to structured, managed data at a more granular level than a filesystem.",
+ "examples": ["ConfigMap","Secret"],
+ "type": "string"
+ },
+ "volumeRequest": {
+ "title": "Volume request",
+ "description": "Identifies the reference to the request for a specific volume type and parameters.",
+ "examples": ["a kubernetes Persistent Volume Claim (PVC) name"],
+ "type": "string"
+ },
+ "volume": {
+ "title": "Volume",
+ "description": "Information about the actual volume instance allocated to the workspace.",
+ "$comment": "The actual volume allocated may be different than the request.",
+ "examples": ["see https://kubernetes.io/docs/concepts/storage/persistent-volumes/"],
+ "$ref": "#/definitions/volume"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "volume": {
+ "title": "Volume",
+ "description": "An identifiable, logical unit of data storage tied to a physical device.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the volume instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the volume instance",
+ "type": "string"
+ },
+ "mode": {
+ "title": "Mode",
+ "description": "The mode for the volume instance.",
+ "type": "string",
+ "enum": [
+ "filesystem", "block"
+ ],
+ "default": "filesystem"
+ },
+ "path": {
+ "title": "Path",
+ "description": "The underlying path created from the actual volume.",
+ "type": "string"
+ },
+ "sizeAllocated": {
+ "title": "Size allocated",
+ "description": "The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form.",
+ "examples": ["10GB", "2Ti", "1Pi"],
+ "type": "string"
+ },
+ "persistent": {
+ "title": "Persistent",
+ "description": "Indicates if the volume persists beyond the life of the resource it is associated with.",
+ "type": "boolean"
+ },
+ "remote": {
+ "title": "Remote",
+ "description": "Indicates if the volume is remotely (i.e., network) attached.",
+ "type": "boolean"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "trigger": {
+ "title": "Trigger",
+ "description": "Represents a resource that can conditionally activate (or fire) tasks based upon associated events and their data.",
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "type",
+ "bom-ref",
+ "uid"
+ ],
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "type": {
+ "title": "Type",
+ "description": "The source type of event which caused the trigger to fire.",
+ "type": "string",
+ "enum": [
+ "manual",
+ "api",
+ "webhook",
+ "scheduled"
+ ]
+ },
+ "event": {
+ "title": "Event",
+ "description": "The event data that caused the associated trigger to activate.",
+ "$ref": "#/definitions/event"
+ },
+ "conditions": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/condition"
+ }
+ },
+ "timeActivated": {
+ "title": "Time activated",
+ "description": "The date and time (timestamp) when the trigger was activated.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "inputs": {
+ "title": "Inputs",
+ "description": "Represents resources and data brought into a task at runtime by executor or task commands",
+ "examples": ["a `configuration` file which was declared as a local `component` or `externalReference`"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/inputType"
+ },
+ "uniqueItems": true
+ },
+ "outputs": {
+ "title": "Outputs",
+ "description": "Represents resources and data output from a task at runtime by executor or task commands",
+ "examples": ["a log file or metrics data produced by the task"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/outputType"
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "event": {
+ "title": "Event",
+ "description": "Represents something that happened that may trigger a response.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier of the event.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the event.",
+ "type": "string"
+ },
+ "timeReceived": {
+ "title": "Time Received",
+ "description": "The date and time (timestamp) when the event was received.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "data": {
+ "title": "Data",
+ "description": "Encoding of the raw event data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "source": {
+ "title": "Source",
+ "description": "References the component or service that was the source of the event",
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "target": {
+ "title": "Target",
+ "description": "References the component or service that was the target of the event",
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "inputType": {
+ "title": "Input type",
+ "description": "Type that represents various input data types and formats.",
+ "type": "object",
+ "oneOf": [
+ {
+ "required": [
+ "resource"
+ ]
+ },
+ {
+ "required": [
+ "parameters"
+ ]
+ },
+ {
+ "required": [
+ "environmentVars"
+ ]
+ },
+ {
+ "required": [
+ "data"
+ ]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "title": "Source",
+ "description": "A references to the component or service that provided the input to the task (e.g., reference to a service with data flow value of `inbound`)",
+ "examples": [
+ "source code repository",
+ "database"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "target": {
+ "title": "Target",
+ "description": "A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)",
+ "examples": [
+ "workspace",
+ "directory"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "resource": {
+ "title": "Resource",
+ "description": "A reference to an independent resource provided as an input to a task by the workflow runtime.",
+ "examples": [
+ "reference to a configuration file in a repository (i.e., a bom-ref)",
+ "reference to a scanning service used in a task (i.e., a bom-ref)"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "parameters": {
+ "title": "Parameters",
+ "description": "Inputs that have the form of parameters with names and values.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/parameter"
+ }
+ },
+ "environmentVars": {
+ "title": "Environment variables",
+ "description": "Inputs that have the form of parameters with names and values.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/property"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "data": {
+ "title": "Data",
+ "description": "Inputs that have the form of data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "outputType": {
+ "type": "object",
+ "oneOf": [
+ {
+ "required": [
+ "resource"
+ ]
+ },
+ {
+ "required": [
+ "environmentVars"
+ ]
+ },
+ {
+ "required": [
+ "data"
+ ]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "title": "Type",
+ "description": "Describes the type of data output.",
+ "type": "string",
+ "enum": [
+ "artifact",
+ "attestation",
+ "log",
+ "evidence",
+ "metrics",
+ "other"
+ ]
+ },
+ "source": {
+ "title": "Source",
+ "description": "Component or service that generated or provided the output from the task (e.g., a build tool)",
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "target": {
+ "title": "Target",
+ "description": "Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`)",
+ "examples": ["a log file described as an `externalReference` within its target domain."],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "resource": {
+ "title": "Resource",
+ "description": "A reference to an independent resource generated as output by the task.",
+ "examples": [
+ "configuration file",
+ "source code",
+ "scanning service"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "data": {
+ "title": "Data",
+ "description": "Outputs that have the form of data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "environmentVars": {
+ "title": "Environment variables",
+ "description": "Outputs that have the form of environment variables.",
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/property"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "resourceReferenceChoice": {
+ "title": "Resource reference choice",
+ "description": "A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.",
+ "$comment": "Enables reference to a resource that participates in a workflow; using either internal (bom-ref) or external (externalReference) types.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "title": "BOM Reference",
+ "description": "References an object by its bom-ref attribute",
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "externalReference": {
+ "title": "External reference",
+ "description": "Reference to an externally accessible resource.",
+ "$ref": "#/definitions/externalReference"
+ }
+ },
+ "oneOf": [
+ {
+ "required": [
+ "ref"
+ ]
+ },
+ {
+ "required": [
+ "externalReference"
+ ]
+ }
+ ]
+ },
+ "condition": {
+ "title": "Condition",
+ "description": "A condition that was used to determine a trigger should be activated.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "title": "Description",
+ "description": "Describes the set of conditions which cause the trigger to activate.",
+ "type": "string"
+ },
+ "expression": {
+ "title": "Expression",
+ "description": "The logical expression that was evaluated that determined the trigger should be fired.",
+ "type": "string"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "taskType": {
+ "type": "string",
+ "enum": [
+ "copy",
+ "clone",
+ "lint",
+ "scan",
+ "merge",
+ "build",
+ "test",
+ "deliver",
+ "deploy",
+ "release",
+ "clean",
+ "other"
+ ]
+ },
+ "parameter": {
+ "title": "Parameter",
+ "description": "A representation of a functional parameter.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "title": "Name",
+ "description": "The name of the parameter.",
+ "type": "string"
+ },
+ "value": {
+ "title": "Value",
+ "description": "The value of the parameter.",
+ "type": "string"
+ },
+ "dataType": {
+ "title": "Data type",
+ "description": "The data type of the parameter.",
+ "type": "string"
+ }
+ }
+ },
+ "signature": {
+ "$ref": "jsf-0.82.SNAPSHOT.schema.json#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.5.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.5.SNAPSHOT.xsd
new file mode 100644
index 00000000..db6e1b0c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.5.SNAPSHOT.xsd
@@ -0,0 +1,5464 @@
+
+
+
+
+
+
+
+
+ CycloneDX Software Bill of Materials Standard
+ https://cyclonedx.org/
+ Apache License, Version 2.0
+
+
+
+
+
+ Identifier for referable and therefore interlink-able elements.
+
+
+
+
+
+
+
+
+
+ Descriptor for an element identified by the attribute "bom-ref" in the same BOM document.
+ In contrast to `bomLinkElementType`.
+
+
+
+
+
+
+
+
+ Descriptor for another BOM document.
+ See https://cyclonedx.org/capabilities/bomlink/
+
+
+
+
+
+
+
+
+
+
+ Descriptor for an element in another BOM document.
+ See https://cyclonedx.org/capabilities/bomlink/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the BOM was created.
+
+
+
+
+
+ The product lifecycle(s) that this BOM represents.
+
+
+
+
+
+
+
+
+
+
+
+ A pre-defined phase in the product lifecycle.
+
+
+
+
+
+
+
+
+ The name of the lifecycle phase
+
+
+
+
+
+
+ The description of the lifecycle phase
+
+
+
+
+
+
+
+
+
+
+
+
+ The tool(s) used in the creation of the BOM.
+
+
+
+
+
+
+ DEPRECATED. Use tools\components or tools\services instead.
+
+
+
+
+
+
+ A list of software and hardware components used as tools.
+
+
+
+
+ A list of services used as tools.
+
+
+
+
+
+
+
+
+ The person(s) who created the BOM. Authors are common in BOMs created through
+ manual processes. BOMs created through automated means may not have authors.
+
+
+
+
+
+
+
+
+
+ The component that the BOM describes.
+
+
+
+
+ The organization that manufactured the component that the BOM describes.
+
+
+
+
+ The organization that supplied the component that the BOM describes. The
+ supplier may often be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ BOM produced early in the development lifecycle containing inventory of components and services
+ that are proposed or planned to be used. The inventory may need to be procured, retrieved,
+ or resourced prior to use.
+
+
+
+
+
+
+ BOM consisting of information obtained prior to a build process and may contain source files
+ and development artifacts and manifests. The inventory may need to be resolved and retrieved
+ prior to use.
+
+
+
+
+
+
+ BOM consisting of information obtained during a build process where component inventory is
+ available for use. The precise versions of resolved components are usually available at this
+ time as well as the provenance of where the components were retrieved from.
+
+
+
+
+
+
+ BOM consisting of information obtained after a build process has completed and the resulting
+ components(s) are available for further analysis. Built components may exist as the result of a
+ CI/CD process, may have been installed or deployed to a system or device, and may need to be
+ retrieved or extracted from the system or device.
+
+
+
+
+
+
+ BOM produced that represents inventory that is running and operational. This may include staging
+ or production environments and will generally encompass multiple SBOMs describing the applications
+ and operating system, along with HBOMs describing the hardware that makes up the system. Operations
+ Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations,
+ and additional dependencies.
+
+
+
+
+
+
+ BOM consisting of information observed through network discovery providing point-in-time
+ enumeration of embedded, on-premise, and cloud-native services such as server applications,
+ connected devices, microservices, and serverless functions.
+
+
+
+
+
+
+ BOM containing inventory that will be, or has been retired from operations.
+
+
+
+
+
+
+
+
+
+
+ The name of the organization
+
+
+
+
+ The URL of the organization. Multiple URLs are allowed.
+
+
+
+
+ A contact person at the organization. Multiple contacts are allowed.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Information about the automated or manual tool used
+
+
+
+
+ The name of the vendor who created the tool
+
+
+
+
+ The name of the tool
+
+
+
+
+ The version of the tool
+
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the tool.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the contact
+
+
+
+
+ The email address of the contact.
+
+
+
+
+ The phone number of the contact.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that supplied the component. The supplier may often
+ be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+ The person(s) or organization(s) that authored the component
+
+
+
+
+ The person(s) or organization(s) that published the component
+
+
+
+
+ The grouping name or identifier. This will often be a shortened, single
+ name of the company or project that produced the component, or the source package or
+ domain name. Whitespace and special characters should be avoided. Examples include:
+ apache, org.apache.commons, and apache.org.
+
+
+
+
+ The name of the component. This will often be a shortened, single name
+ of the component. Examples: commons-lang3 and jquery
+
+
+
+
+ The component version. The version should ideally comply with semantic versioning
+ but is not enforced.
+
+
+
+
+ Specifies a description for the component
+
+
+
+
+ Specifies the scope of the component. If scope is not specified, 'required'
+ scope SHOULD be assumed by the consumer of the BOM.
+
+
+
+
+
+
+
+
+
+
+
+
+ A copyright notice informing users of the underlying claims to
+ copyright ownership in a published work.
+
+
+
+
+
+ Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe
+
+
+
+
+
+
+ Specifies the package-url (purl). The purl, if specified, MUST be valid and conform
+ to the specification defined at: https://github.com/package-url/purl-spec
+
+
+
+
+
+
+ Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree
+ element instead to supply information on exactly how the component was modified.
+ A boolean value indicating if the component has been modified from the original.
+ A value of true indicates the component is a derivative of the original.
+ A value of false indicates the component has not been modified from the original.
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are
+ created, distributed, modified, redistributed, combined with other components, etc.
+
+
+
+
+
+ Provides the ability to document external references related to the
+ component or to the project the component describes.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ A list of software and hardware components included in the parent component. This is not a
+ dependency tree. It provides a way to specify a hierarchical representation of component
+ assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Provides the ability to document evidence collected through various forms of extraction or analysis.
+
+
+
+
+ Specifies optional release notes.
+
+
+
+
+ A model card describes the intended uses of a machine learning model and potential
+ limitations, including biases and ethical considerations. Model cards typically contain the
+ training parameters, which datasets were used to train the model, performance metrics, and other
+ relevant data useful for ML transparency. This object SHOULD be specified for any component of
+ type `machine-learning-model` and MUST NOT be specified for other component types.
+
+
+
+
+ This object SHOULD be specified for any component of type `data` and MUST NOT be
+ specified for other component types.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ Specifies the type of component. For software components, classify as application if no more
+ specific appropriate classification is available or cannot be determined for the component.
+
+
+
+
+
+
+ The OPTIONAL mime-type of the component. When used on file components, the mime-type
+ can provide additional context about the kind of file being represented such as an image,
+ font, or executable. Some library or framework components may also have an associated mime-type.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the component elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ A valid SPDX license ID
+
+
+
+
+ If SPDX does not define the license used, this field may be used to provide the license name
+
+
+
+
+
+ Specifies the optional full text of the attachment
+
+
+
+
+ The URL to the attachment file. If the attachment is a license or BOM,
+ an externalReference should also be specified for completeness.
+
+
+
+
+ Licensing details describing the licensor/licensee, license type, renewal and
+ expiration dates, and other important metadata
+
+
+
+
+
+ License identifiers that may be used to manage licenses and
+ their lifecycle
+
+
+
+
+
+
+
+
+
+ The individual or organization that grants a license to another
+ individual or organization
+
+
+
+
+
+
+ The organization that granted the license
+
+
+
+
+ The individual, not associated with an organization,
+ that granted the license
+
+
+
+
+
+
+
+
+ The individual or organization for which a license was granted to
+
+
+
+
+
+
+ The organization that was granted the license
+
+
+
+
+ The individual, not associated with an organization,
+ that was granted the license
+
+
+
+
+
+
+
+
+ The individual or organization that purchased the license
+
+
+
+
+
+
+ The organization that purchased the license
+
+
+
+
+ The individual, not associated with an organization,
+ that purchased the license
+
+
+
+
+
+
+
+
+ The purchase order identifier the purchaser sent to a supplier or
+ vendor to authorize a purchase
+
+
+
+
+ The type of license(s) that was granted to the licensee
+
+
+
+
+
+
+
+
+
+ The timestamp indicating when the license was last
+ renewed. For new purchases, this is often the purchase or acquisition date.
+ For non-perpetual licenses or subscriptions, this is the timestamp of when the
+ license was last renewed.
+
+
+
+
+ The timestamp indicating when the current license
+ expires (if applicable).
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the license elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+ The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
+
+
+
+ Specifies the content type of the text. Defaults to text/plain
+ if not specified.
+
+
+
+
+
+ Specifies the optional encoding the text is represented in
+
+
+
+
+
+
+
+
+
+ Specifies the file hash of the component
+
+
+
+
+
+ Specifies the algorithm used to create the hash
+
+
+
+
+
+
+
+
+
+
+ The component is required for runtime
+
+
+
+
+ The component is optional at runtime. Optional components are components that
+ are not capable of being called due to them not be installed or otherwise accessible by any means.
+ Components that are installed but due to configuration or other restrictions are prohibited from
+ being called must be scoped as 'required'.
+
+
+
+
+ Components that are excluded provide the ability to document component usage
+ for test and other non-runtime purposes. Excluded components are not reachable within a call
+ graph at runtime.
+
+
+
+
+
+
+
+
+
+ A software application. Refer to https://en.wikipedia.org/wiki/Application_software
+ for information about applications.
+
+
+
+
+ A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework
+ for information on how frameworks vary slightly from libraries.
+
+
+
+
+ A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing)
+ for information about libraries. All third-party and open source reusable components will likely
+ be a library. If the library also has key features of a framework, then it should be classified
+ as a framework. If not, or is unknown, then specifying library is recommended.
+
+
+
+
+ A packaging and/or runtime format, not specific to any particular technology,
+ which isolates software inside the container from software outside of a container through
+ virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization
+
+
+
+
+ A runtime environment which interprets or executes software. This may include
+ runtimes such as those that execute bytecode or low-code/no-code application platforms.
+
+
+
+
+ A software operating system without regard to deployment model
+ (i.e. installed on physical hardware, virtual machine, image, etc) Refer to
+ https://en.wikipedia.org/wiki/Operating_system
+
+
+
+
+ A hardware device such as a processor, or chip-set. A hardware device
+ containing firmware SHOULD include a component for the physical hardware itself, and another
+ component of type 'firmware' or 'operating-system' (whichever is relevant), describing
+ information about the software running on the device.
+ See also the list of known device properties: https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md
+
+
+
+
+
+ A special type of software that operates or controls a particular type of device.
+ Refer to https://en.wikipedia.org/wiki/Device_driver
+
+
+
+
+ A special type of software that provides low-level control over a devices
+ hardware. Refer to https://en.wikipedia.org/wiki/Firmware
+
+
+
+
+ A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file
+ for information about files.
+
+
+
+
+ A model based on training data that can make predictions or decisions without
+ being explicitly programmed to do so.
+
+
+
+
+ A collection of discrete values that convey information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A license that grants use of software solely for the purpose
+ of education or research.
+
+
+
+
+ A license covering use of software embedded in a specific
+ piece of hardware.
+
+
+
+
+ A Client Access License (CAL) allows client computers to access
+ services provided by server software.
+
+
+
+
+ A Concurrent User license (aka floating license) limits the
+ number of licenses for a software application and licenses are shared among
+ a larger number of users.
+
+
+
+
+ A license where the core of a computer's processor is assigned
+ a specific number of points.
+
+
+
+
+ A license for which consumption is measured by non-standard
+ metrics.
+
+
+
+
+ A license that covers a defined number of installations on
+ computers and other types of devices.
+
+
+
+
+ A license that grants permission to install and use software
+ for trial purposes.
+
+
+
+
+ A license that grants access to the software to one or more
+ pre-defined users.
+
+
+
+
+ A license that grants access to the software on one or more
+ pre-defined computers or devices.
+
+
+
+
+ An Original Equipment Manufacturer license that is delivered
+ with hardware, cannot be transferred to other hardware, and is valid for the
+ life of the hardware.
+
+
+
+
+ A license where the software is sold on a one-time basis and
+ the licensee can use a copy of the software indefinitely.
+
+
+
+
+ A license where each installation consumes points per
+ processor.
+
+
+
+
+ A license where the licensee pays a fee to use the software
+ or service.
+
+
+
+
+ A license that grants access to the software or service by a
+ specified number of users.
+
+
+
+
+ Another license type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats.
+ Refer to https://nvd.nist.gov/products/cpe for official specification.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the full content of the SWID tag.
+
+
+
+
+ The URL to the SWID file.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Maps to the tagId of a SoftwareIdentity.
+
+
+
+
+ Maps to the name of a SoftwareIdentity.
+
+
+
+
+ Maps to the version of a SoftwareIdentity.
+
+
+
+
+ Maps to the tagVersion of a SoftwareIdentity.
+
+
+
+
+ Maps to the patch of a SoftwareIdentity.
+
+
+
+
+
+
+
+ Defines a string representation of a UUID conforming to RFC 4122.
+
+
+
+
+
+
+
+
+
+
+
+ Version Control System
+
+
+
+
+ Issue or defect tracking system, or an Application Lifecycle Management (ALM) system
+
+
+
+
+ Website
+
+
+
+
+ Security advisories
+
+
+
+
+ Bill-of-materials (SBOM, OBOM, HBOM, SaaSBOM, etc)
+
+
+
+
+ Mailing list or discussion group
+
+
+
+
+ Social media account
+
+
+
+
+ Real-time chat platform
+
+
+
+
+ Documentation, guides, or how-to instructions
+
+
+
+
+ Community or commercial support
+
+
+
+
+ Direct or repository download location
+
+
+
+
+ The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary
+
+
+
+
+ The URL to the license file. If a license URL has been defined in the license
+ node, it should also be defined as an external reference for completeness
+
+
+
+
+ Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)
+
+
+
+
+ URL to an automated build system
+
+
+
+
+ URL to release notes
+
+
+
+
+ Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501]) that specifies the records containing DNS Security TXT.
+
+
+
+
+ A model card describes the intended uses of a machine learning model, potential
+ limitations, biases, ethical considerations, training parameters, datasets used to train the
+ model, performance metrics, and other relevant data useful for ML transparency.
+
+
+
+
+ A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations.
+
+
+
+
+ Parameters or settings that may be used by other components or services.
+
+
+
+
+ Information used to substantiate a claim.
+
+
+
+
+ Describes how a component or service was manufactured or deployed.
+
+
+
+
+ Human or machine-readable statements containing facts, evidence, or testimony
+
+
+
+
+ An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format
+
+
+
+
+ The defined assumptions, goals, and capabilities of an adversary.
+
+
+
+
+ Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.
+
+
+
+
+ A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.
+
+
+
+
+ A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.
+
+
+
+
+ Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test
+
+
+
+
+ SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code
+
+
+
+
+ Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations
+
+
+
+
+ Report generated by analyzing the call stack of a running application
+
+
+
+
+ Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis
+
+
+
+
+ Report containing a formal assessment of an organization, business unit, or team against a maturity model
+
+
+
+
+ Industry, regulatory, or other certification from an accredited (if applicable) certification body
+
+
+
+
+ Report or system in which quality metrics can be obtained
+
+
+
+
+ Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)
+
+
+
+
+ Plans of Action and Milestones (POAM) compliment an "attestation" external reference. POAM is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".
+
+
+
+
+ Use this if no other types accurately describe the purpose of the external reference
+
+
+
+
+
+
+
+
+ External references provide a way to document systems, sites, and information that may be
+ relevant, but are not included with the BOM. They may also establish specific relationships
+ within or external to the BOM.
+
+
+
+
+
+ Zero or more external references can be defined
+
+
+
+
+
+
+
+
+
+ The URI (URL or URN) to the external reference. External references
+ are URIs and therefore can accept any URL scheme including https, mailto, tel, and dns.
+ External references may also include formally registered URNs such as CycloneDX BOM-Link to
+ reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external
+ references into relationships that can be expressed in a BOM or across BOMs. Refer to:
+ https://cyclonedx.org/capabilities/bomlink/
+
+
+
+
+
+
+
+ An optional comment describing the external reference
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the type of external reference. There are built-in types to describe common
+ references. If a type does not exist for the reference being referred to, use the "other" type.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Zero or more commits can be specified.
+
+
+
+
+ Specifies an individual commit.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of the commit. This may be version control
+ specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
+
+
+
+
+
+ The URL to the commit. This URL will typically point to a commit
+ in a version control system.
+
+
+
+
+
+ The author who created the changes in the commit
+
+
+
+
+ The person who committed or pushed the commit
+
+
+
+
+ The text description of the contents of the commit
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Zero or more patches can be specified.
+
+
+
+
+ Specifies an individual patch.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The patch file (or diff) that show changes.
+ Refer to https://en.wikipedia.org/wiki/Diff
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the purpose for the patch including the resolution of defects,
+ security issues, or new behavior or functionality
+
+
+
+
+
+
+
+
+ A patch which is not developed by the creators or maintainers of the software
+ being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch
+
+
+
+
+ A patch which dynamically modifies runtime behavior.
+ Refer to https://en.wikipedia.org/wiki/Monkey_patch
+
+
+
+
+ A patch which takes code from a newer version of software and applies
+ it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting
+
+
+
+
+ A patch created by selectively applying commits from other versions or
+ branches of the same software.
+
+
+
+
+
+
+
+
+
+ A fault, flaw, or bug in software
+
+
+
+
+ A new feature or behavior in software
+
+
+
+
+ A special type of defect which impacts security
+
+
+
+
+
+
+
+
+
+ Specifies the optional text of the diff
+
+
+
+
+ Specifies the URL to the diff
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ An individual issue that has been resolved.
+
+
+
+
+
+ The identifier of the issue assigned by the source of the issue
+
+
+
+
+ The name of the issue
+
+
+
+
+ A description of the issue
+
+
+
+
+
+
+ The source of the issue where it is documented.
+
+
+
+
+
+
+ The name of the source. For example "National Vulnerability Database",
+ "NVD", and "Apache"
+
+
+
+
+
+
+ The url of the issue documentation as provided by the source
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the type of issue
+
+
+
+
+
+
+
+
+ The timestamp in which the action occurred
+
+
+
+
+ The name of the individual who performed the action
+
+
+
+
+ The email address of the individual who performed the action
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are created,
+ distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing
+ this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to
+ document variants where the exact relation may not be known.
+
+
+
+
+
+ Describes zero or more components in which a component is derived
+ from. This is commonly used to describe forks from existing projects where the forked version
+ contains a ancestor node containing the original component it was forked from. For example,
+ Component A is the original component. Component B is the component being used and documented
+ in the BOM. However, Component B contains a pedigree node with a single ancestor documenting
+ Component A - the original component from which Component B is derived from.
+
+
+
+
+
+ Descendants are the exact opposite of ancestors. This provides a
+ way to document all forks (and their forks) of an original or root component.
+
+
+
+
+
+ Variants describe relations where the relationship between the
+ components are not known. For example, if Component A contains nearly identical code to
+ Component B. They are both related, but it is unclear if one is derived from the other,
+ or if they share a common ancestor.
+
+
+
+
+
+ A list of zero or more commits which provide a trail describing
+ how the component deviates from an ancestor, descendant, or variant.
+
+
+
+
+ A list of zero or more patches describing how the component
+ deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits
+ or may be used in place of commits.
+
+
+
+
+ Notes, observations, and other non-structured commentary
+ describing the components pedigree.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+ References a component or service by its bom-ref attribute
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Defines the direct dependencies of a component or service. Components or services
+ that do not have their own dependencies MUST be declared as empty elements within the graph.
+ Components or services that are not represented in the dependency graph MAY have unknown
+ dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an
+ indicator of a object being dependency-free. It is RECOMMENDED to leverage compositions to
+ indicate unknown dependency graphs.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that provides the service.
+
+
+
+
+ The grouping name, namespace, or identifier. This will often be a shortened,
+ single name of the company or project that produced the service or domain name.
+ Whitespace and special characters should be avoided.
+
+
+
+
+ The name of the service. This will often be a shortened, single name
+ of the service.
+
+
+
+
+ The service version.
+
+
+
+
+ Specifies a description for the service.
+
+
+
+
+
+
+
+ A service endpoint URI.
+
+
+
+
+
+
+
+ A boolean value indicating if the service requires authentication.
+ A value of true indicates the service requires authentication prior to use.
+ A value of false indicates the service does not require authentication.
+
+
+
+
+ A boolean value indicating if use of the service crosses a trust zone or boundary.
+ A value of true indicates that by using the service, a trust boundary is crossed.
+ A value of false indicates that by using the service, a trust boundary is not crossed.
+
+
+
+
+ The name of the trust zone the service resides in.
+
+
+
+
+
+
+
+
+ DEPRECATED: Specifies the data classification. THIS FIELD IS DEPRECATED AS OF v1.5. Use dataflow\classification instead
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ The URI, URL, or BOM-Link of the components or services the data came in from.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URI, URL, or BOM-Link of the components or services the data is sent to.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name for the defined data.
+
+
+
+
+
+
+ Short description of the data content and usage.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the service.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ A list of services included or deployed behind the parent service. This is not a dependency
+ tree. It provides a way to specify a hierarchical representation of service assemblies.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Specifies optional release notes.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the service elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ Specifies the flow direction of the data.
+
+
+
+
+
+
+
+
+ Specifies the flow direction of the data. Valid values are:
+ inbound, outbound, bi-directional, and unknown. Direction is relative to the service.
+ Inbound flow states that data enters the service. Outbound flow states that data
+ leaves the service. Bi-directional states that data flows both ways, and unknown
+ states that the direction is not known.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license expression.
+ Refer to https://spdx.org/specifications for syntax requirements
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the license elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Evidence that substantiates the identity of a component.
+
+
+
+
+
+ The identity field of the component which the evidence describes.
+
+
+
+
+ The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
+
+
+
+
+ The methods used to extract and/or analyze the evidence.
+
+
+
+
+
+
+
+
+ The technique used in this method of analysis.
+
+
+
+
+ The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
+
+
+
+
+ The value or contents of the evidence.
+
+
+
+
+
+
+
+
+
+
+
+ The object in the BOM identified by its bom-ref. This is often a component or service,
+ but may be any object type supporting bom-refs. Tools used for analysis should already
+ be defined in the BOM, either in the metadata/tools, components, or formulation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Evidence of individual instances of a component spread across multiple locations.
+
+
+
+
+
+
+
+
+ The location or path to where the component was found.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the occurrence elsewhere
+ in the BOM. Every bom-ref MUST be unique within the BOM.
+
+
+
+
+
+
+
+
+
+
+ Evidence of the components use through the callstack.
+
+
+
+
+
+
+
+
+
+
+
+ A package organizes modules into namespaces, providing a unique namespace for each type it contains.
+
+
+
+
+ A module or class that encloses functions/methods and other code.
+
+
+
+
+ A block of code designed to perform a particular task.
+
+
+
+
+ Optional arguments that are passed to the module or function.
+
+
+
+
+
+
+
+
+
+ The line number the code that is called resides on.
+
+
+
+
+ The column the code that is called resides.
+
+
+
+
+ The full path and filename of the module.
+
+
+
+
+
+
+
+
+
+
+
+ The object in the BOM identified by its bom-ref. This is often a component or service,
+ but may be any object type supporting bom-refs. Tools used for analysis should already
+ be defined in the BOM, either in the metadata/tools, components, or formulation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Specifies an aggregate type that describe how complete a relationship is.
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Assemblies refer to
+ nested relationships whereby a constituent part may include other constituent parts. References
+ do not cascade to child parts. References are explicit for the specified constituent part only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Dependencies refer to a
+ relationship whereby an independent constituent part requires another independent constituent
+ part. References do not cascade to transitive dependencies. References are explicit for the
+ specified dependency only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ The bom-ref identifiers of the vulnerabilities being described.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the composition elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+ The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist.
+
+
+
+
+ The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.
+
+
+
+
+ The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.
+
+
+
+
+ The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.
+
+
+
+
+ The relationship completeness is not specified.
+
+
+
+
+
+
+
+
+ Defines a syntax for representing two character language code (ISO-639) followed by an optional two
+ character country code. The language code MUST be lower case. If the country code is specified, the
+ country code MUST be upper case. The language code and country code MUST be separated by a minus sign.
+ Examples: en, en-US, fr, fr-CA
+
+
+
+
+
+
+
+
+
+
+
+ The software versioning type. It is RECOMMENDED that the release type use one
+ of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software
+ release types is not practical, so standardizing on the recommended values, whenever possible,
+ is strongly encouraged.
+ * major = A major release may contain significant changes or may introduce breaking changes.
+ * minor = A minor release, also known as an update, may contain a smaller number of changes than major releases.
+ * patch = Patch releases are typically unplanned and may resolve defects or important security issues.
+ * pre-release = A pre-release may include alpha, beta, or release candidates and typically have
+ limited support. They provide the ability to preview a release prior to its general availability.
+ * internal = Internal releases are not for public consumption and are intended to be used exclusively
+ by the project or manufacturer that produced it.
+
+
+
+
+
+ The title of the release.
+
+
+
+
+ The URL to an image that may be prominently displayed with the release note.
+
+
+
+
+ The URL to an image that may be used in messaging on social media platforms.
+
+
+
+
+ A short description of the release.
+
+
+
+
+ The date and time (timestamp) when the release note was created.
+
+
+
+
+
+
+
+ One or more alternate names the release may be referred to. This may
+ include unofficial terms used by development and marketing teams (e.g. code names).
+
+
+
+
+
+
+
+
+
+
+ One or more tags that may aid in search or retrieval of the release note.
+
+
+
+
+
+
+
+ A collection of issues that have been resolved.
+
+
+
+
+
+
+
+
+
+
+
+
+ Zero or more release notes containing the locale and content. Multiple
+ note elements may be specified to support release notes in a wide variety of languages.
+
+
+
+
+
+ The ISO-639 (or higher) language code and optional ISO-3166
+ (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA".
+
+
+
+
+ Specifies the full content of the release note.
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ A model card describes the intended uses of a machine learning model and potential limitations, including
+ biases and ethical considerations. Model cards typically contain the training parameters, which datasets
+ were used to train the model, performance metrics, and other relevant data useful for ML transparency.
+ This object SHOULD be specified for any component of type `machine-learning-model` and MUST NOT be specified
+ for other component types.
+
+
+
+
+
+
+ Hyper-parameters for construction of the model.
+
+
+
+
+
+
+
+ The overall approach to learning used by the model for problem solving.
+
+
+
+
+
+
+
+ Learning types describing the learning problem or hybrid learning problem.
+
+
+
+
+
+
+
+
+
+ Directly influences the input and/or output. Examples include classification,
+ regression, clustering, etc.
+
+
+
+
+
+
+ The model architecture family such as transformer network, convolutional neural
+ network, residual neural network, LSTM neural network, etc.
+
+
+
+
+
+
+ The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.
+
+
+
+
+
+
+ The datasets used to train and evaluate the model.
+
+
+
+
+
+
+ References a data component by the components bom-ref attribute
+
+
+
+
+
+
+
+
+
+
+
+
+ The input format(s) of the model
+
+
+
+
+
+
+
+
+
+
+ The data format for input to the model. Example formats include string, image, time-series
+
+
+
+
+
+
+
+
+
+
+
+
+ The output format(s) from the model
+
+
+
+
+
+
+
+
+
+
+ The data format for output from the model. Example formats include string, image, time-series
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A quantitative analysis of the model
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type of performance metric.
+
+
+
+
+
+
+ The value of the performance metric.
+
+
+
+
+
+
+ The name of the slice this metric was computed on. By default, assume
+ this metric is not sliced.
+
+
+
+
+
+
+ The confidence interval of the metric.
+
+
+
+
+
+
+
+ The lower bound of the confidence interval.
+
+
+
+
+
+
+ The upper bound of the confidence interval.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A collection of graphics that represent various measurements
+
+
+
+
+
+
+
+ A description of this collection of graphics.
+
+
+
+
+
+
+ A collection of graphics.
+
+
+
+
+
+
+
+
+
+
+ The name of the graphic.
+
+
+
+
+
+
+ The graphic (vector or raster). Base64 encoding MUST be specified for binary images.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ What considerations should be taken into account regarding the model's construction, training,
+ and application?
+
+
+
+
+
+
+
+ Who are the intended users of the model?
+
+
+
+
+
+
+
+
+
+
+
+ What are the intended use cases of the model?
+
+
+
+
+
+
+
+
+
+
+
+ What are the known technical limitations of the model? E.g. What kind(s) of data
+ should the model be expected not to perform well on? What are the factors that might
+ degrade model performance?
+
+
+
+
+
+
+
+
+
+
+
+ What are the known tradeoffs in accuracy/performance of the model?
+
+
+
+
+
+
+
+
+
+
+
+ What are the ethical (or environmental) risks involved in the application of this model?
+
+
+
+
+
+
+
+
+
+
+ The name of the risk
+
+
+
+
+
+
+ Strategy used to address this risk
+
+
+
+
+
+
+
+
+
+
+
+
+ How does the model affect groups at risk of being systematically disadvantaged?
+ What are the harms and benefits to the various affected groups?
+
+
+
+
+
+
+
+
+
+
+ The groups or individuals at risk of being systematically disadvantaged by the model.
+
+
+
+
+
+
+ Expected benefits to the identified groups.
+
+
+
+
+
+
+ Expected harms to the identified groups.
+
+
+
+
+
+
+ With respect to the benefits and harms outlined, please
+ describe any mitigation strategy implemented.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the model card elsewhere in the BOM.
+ Every bom-ref MUST be unique within the BOM.
+
+
+
+
+
+
+
+
+
+ TODO
+
+
+
+
+ TODO
+
+
+
+
+ TODO
+
+
+
+
+ TODO
+
+
+
+
+ TODO
+
+
+
+
+
+
+
+
+
+
+ The general theme or subject matter of the data being specified.
+
+
+
+
+
+
+ The name of the dataset.
+
+
+
+
+
+
+ The contents or references to the contents of the data being described.
+
+
+
+
+
+
+ An optional way to include textual or encoded data.
+
+
+
+
+ The URL to where the data can be retrieved.
+
+
+
+
+ Provides the ability to document name-value parameters used for configuration.
+
+
+
+
+
+
+
+
+ Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
+
+
+
+
+
+
+ A description of any sensitive data in a dataset.
+
+
+
+
+
+
+ A collection of graphics that represent various measurements.
+
+
+
+
+
+
+ A description of the dataset. Can describe size of dataset, whether it's used for source code,
+ training, testing, or validation, etc.
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the dataset elsewhere in the BOM.
+ Every bom-ref MUST be unique within the BOM.
+
+
+
+
+
+
+
+
+
+
+ Data custodians are responsible for the safe custody, transport, and storage of data.
+
+
+
+
+
+
+
+
+
+
+
+ Data stewards are responsible for data content, context, and associated business rules.
+
+
+
+
+
+
+
+
+
+
+
+ Data owners are concerned with risk and appropriate access to data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A collection of graphics that represent various measurements.
+
+
+
+
+
+
+ A description of this collection of graphics.
+
+
+
+
+
+
+ A collection of graphics.
+
+
+
+
+
+
+
+
+
+
+ The name of the graphic.
+
+
+
+
+
+
+ The graphic (vector or raster). Base64 encoding MUST be specified for binary images.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Any type of code, code snippet, or data-as-code.
+
+
+
+
+ Parameters or settings that may be used by other components.
+
+
+
+
+ A collection of data.
+
+
+
+
+ Data that can be used to create new instances of what the definition defines.
+
+
+
+
+ Any other type of data that does not fit into existing definitions.
+
+
+
+
+
+
+
+
+ References a component or service by its bom-ref attribute
+
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies an individual property with a name and value.
+
+
+
+
+
+ The name of the property. Duplicate names are allowed, each potentially having a different value.
+
+
+
+
+
+
+
+
+
+
+ Defines a weakness in a component or service that could be exploited or triggered by a threat source.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The identifier that uniquely identifies the vulnerability. For example:
+ CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876.
+
+
+
+
+ The source that published the vulnerability.
+
+
+
+
+ Zero or more pointers to vulnerabilities that are the equivalent of the
+ vulnerability specified. Often times, the same vulnerability may exist in multiple sources of
+ vulnerability intelligence, but have different identifiers. References provide a way to
+ correlate vulnerabilities across multiple sources of vulnerability intelligence.
+
+
+
+
+
+ A pointer to a vulnerability that is the equivalent of the
+ vulnerability specified.
+
+
+
+
+
+ The identifier that uniquely identifies the vulnerability. For example:
+ CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876.
+
+
+
+
+ The source that published the vulnerability.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ List of vulnerability ratings.
+
+
+
+
+
+
+
+
+
+
+
+ List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability.
+ For example 399 (of https://cwe.mitre.org/data/definitions/399.html)
+
+
+
+
+
+
+
+
+
+ A description of the vulnerability as provided by the source.
+
+
+
+
+ If available, an in-depth description of the vulnerability as provided by the
+ source organization. Details often include information useful in understanding root cause.
+
+
+
+
+ Recommendations of how the vulnerability can be remediated or mitigated.
+
+
+
+
+ A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments.
+
+
+
+
+
+
+ Evidence used to reproduce the vulnerability.
+
+
+
+
+
+ Precise steps to reproduce the vulnerability.
+
+
+
+
+ A description of the environment in which reproduction was possible.
+
+
+
+
+ Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Published advisories of the vulnerability if provided.
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was created in the vulnerability database.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was first published.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was last updated.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was rejected (if applicable).
+
+
+
+
+ Individuals or organizations credited with the discovery of the vulnerability.
+
+
+
+
+
+ The organizations credited with vulnerability discovery.
+
+
+
+
+
+
+
+
+
+ The individuals, not associated with organizations, that are credited with vulnerability discovery.
+
+
+
+
+
+
+
+
+
+
+
+
+ The tool(s) used to identify, confirm, or score the vulnerability.
+
+
+
+
+
+
+ DEPRECATED. Use tools\components or tools\services instead.
+
+
+
+
+
+
+ A list of software and hardware components used as tools.
+
+
+
+
+ A list of services used as tools.
+
+
+
+
+
+
+
+
+
+
+ An assessment of the impact and exploitability of the vulnerability.
+
+
+
+
+
+
+ Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+ A response to the vulnerability by the manufacturer, supplier, or
+ project responsible for the affected component or service. More than one response
+ is allowed. Responses are strongly encouraged for vulnerabilities where the analysis
+ state is exploitable.
+
+
+
+
+
+
+
+
+
+
+ Detailed description of the impact including methods used during assessment.
+ If a vulnerability is not exploitable, this field should include specific details
+ on why the component or service is not impacted by this vulnerability.
+
+
+
+
+
+
+ The date and time (timestamp) when the analysis was first issued.
+
+
+
+
+
+
+ The date and time (timestamp) when the analysis was last updated.
+
+
+
+
+
+
+
+
+ The components or services that are affected by the vulnerability.
+
+
+
+
+
+
+
+
+ References a component or service by the objects bom-ref.
+
+
+
+
+
+
+
+ Zero or more individual versions or range of versions.
+
+
+
+
+
+
+
+
+
+ A single version of a component or service.
+
+
+
+
+ A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst
+
+
+
+
+
+
+ The vulnerability status for the version or range of versions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the vulnerability elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+ The name of the source.
+ For example: NVD, National Vulnerability Database, OSS Index, VulnDB, and GitHub Advisories
+
+
+
+
+
+ The url of the vulnerability documentation as provided by the source.
+ For example: https://nvd.nist.gov/vuln/detail/CVE-2021-39182
+
+
+
+
+
+
+
+
+
+ The source that calculated the severity or risk rating of the vulnerability.
+
+
+
+
+ The numerical score of the rating.
+
+
+
+
+ Textual representation of the severity that corresponds to the numerical score of the rating.
+
+
+
+
+ The risk scoring methodology/standard used.
+
+
+
+
+ Textual representation of the metric values used to score the vulnerability.
+
+
+
+
+ An optional reason for rating the vulnerability as it was.
+
+
+
+
+
+
+
+
+
+ An optional name of the advisory.
+
+
+
+
+ Location where the advisory can be obtained.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that created the annotation
+
+
+
+
+ The person that created the annotation
+
+
+
+
+ The tool or component that created the annotation
+
+
+
+
+ The service that created the annotation
+
+
+
+
+
+
+
+
+
+
+ The objects in the BOM identified by their bom-ref's. This is often components or services, but may be any object type supporting bom-refs.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ The organization, individual, component, or service which created the textual content
+ of the annotation.
+
+
+
+
+ The date and time (timestamp) when the annotation was created.
+
+
+
+
+ The textual content of the annotation.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the annotation elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Textual representation of the severity of the vulnerability adopted by the analysis method. If the
+ analysis method uses values other than what is provided, the user is expected to translate appropriately.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.
+
+
+
+
+
+
+ The vulnerability has been remediated.
+
+
+
+
+
+
+ The vulnerability has been remediated and evidence of the changes are provided in the affected
+ components pedigree containing verifiable commit history and/or diff(s).
+
+
+
+
+
+
+ The vulnerability may be directly or indirectly exploitable.
+
+
+
+
+
+
+ The vulnerability is being investigated.
+
+
+
+
+
+
+ The vulnerability is not specific to the component or service and was falsely identified or associated.
+
+
+
+
+
+
+ The component or service is not affected by the vulnerability. Justification should be specified
+ for all not_affected cases.
+
+
+
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+
+ The code has been removed or tree-shaked.
+
+
+
+
+
+
+ The vulnerable code is not invoked at runtime.
+
+
+
+
+
+
+ Exploitability requires a configurable option to be set/unset.
+
+
+
+
+
+
+ Exploitability requires a dependency that is not present.
+
+
+
+
+
+
+ Exploitability requires a certain environment which is not present.
+
+
+
+
+
+
+ Exploitability requires a compiler flag to be set/unset.
+
+
+
+
+
+
+ Exploits are prevented at runtime.
+
+
+
+
+
+
+ Attacks are blocked at physical, logical, or network perimeter.
+
+
+
+
+
+
+ Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.
+
+
+
+
+
+
+
+
+
+ Specifies the severity or risk scoring methodology or standard used.
+
+
+
+
+
+
+ The rating is based on CVSS v2 standard
+ https://www.first.org/cvss/v2/
+
+
+
+
+
+
+ The rating is based on CVSS v3.0 standard
+ https://www.first.org/cvss/v3-0/
+
+
+
+
+
+
+ The rating is based on CVSS v3.1 standard
+ https://www.first.org/cvss/v3-1/
+
+
+
+
+
+
+ The rating is based on CVSS v4.0 standard
+ https://www.first.org/cvss/v4-0/
+
+
+
+
+
+
+ The rating is based on OWASP Risk Rating
+ https://owasp.org/www-community/OWASP_Risk_Rating_Methodology
+
+
+
+
+
+
+ The rating is based on Stakeholder Specific Vulnerability Categorization (all versions)
+ https://github.com/CERTCC/SSVC
+
+
+
+
+
+
+ Use this if the risk scoring methodology is not based on any of the options above
+
+
+
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The vulnerability status of a given version or range of versions of a product. The statuses
+ 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability.
+ The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected.
+ There can be many reasons for an 'unknown' status, including that an investigation has not been
+ undertaken or that a vendor has not disclosed the status.
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes how a component or service was manufactured or deployed. This is achieved through the use
+ of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the
+ observed formulas describing the steps which transpired in the manufacturing process.
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Describes workflows and resources that captures rules and other aspects of how the associated
+ BOM component or service was formed.
+
+
+
+
+
+ Transient components that are used in tasks that constitute one or more of
+ this formula's workflows
+
+
+
+
+ Transient services that are used in tasks that constitute one or more of
+ this formula's workflows
+
+
+
+
+ List of workflows that can be declared to accomplish specific orchestrated goals
+ and independently triggered.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the formula elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+ References to component or service resources that are used to realize
+ the resource instance.
+
+
+
+
+ The tasks that comprise the workflow.
+
+
+
+
+ The graph of dependencies between tasks within the workflow.
+
+
+
+
+ Indicates the types of activities performed by the set of workflow tasks.
+
+
+
+
+
+
+
+
+
+ The trigger that initiated the task.
+
+
+
+
+
+ The sequence of steps for the task.
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data brought into a task at runtime by executor
+ or task commands
+
+
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor
+ or task commands
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the task started.
+
+
+
+
+
+
+ The date and time (timestamp) when the task ended.
+
+
+
+
+
+ A set of named filesystem or data resource shareable by workflow tasks.
+
+
+
+
+ A graph of the component runtime topology for workflow's instance.
+ A description of the runtime component and service topology. This can describe a partial or
+ complete topology used to host and execute the task (e.g., hardware, operating systems,
+ configurations, etc.)
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the workflow elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ References an object by its bom-ref attribute
+
+
+
+
+
+
+
+
+
+ Reference to an externally accessible resource.
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+
+ References to component or service resources that are used to realize the resource instance.
+
+
+
+
+
+
+ Indicates the types of activities performed by the set of workflow tasks.
+
+
+
+
+
+
+
+
+
+
+
+ The trigger that initiated the task.
+
+
+
+
+
+
+ The sequence of steps for the task.
+
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data brought into a task at runtime by executor or task commands.
+
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor or task commands
+
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the task started.
+
+
+
+
+
+
+ The date and time (timestamp) when the task ended.
+
+
+
+
+
+
+ A set of named filesystem or data resource shareable by workflow tasks.
+
+
+
+
+
+
+ A graph of the component runtime topology for task's instance.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the task elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ A named filesystem or data resource shareable by workflow tasks.
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping
+ so other tasks can use their own local name in their steps.
+
+
+
+
+
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+
+ References to component or service resources that are used to realize the resource instance.
+
+
+
+
+
+
+ Describes the read-write access control for the workspace relative to the owning resource instance.
+
+
+
+
+
+
+ A path to a location on disk where the workspace will be available to the associated task's steps.
+
+
+
+
+
+
+ The name of a domain-specific data type the workspace represents. This property is for CI/CD
+ frameworks that are able to provide access to structured, managed data at a more granular level
+ than a filesystem.
+
+
+
+
+
+
+ Identifies the reference to the request for a specific volume type and parameters.
+
+
+
+
+
+
+ Information about the actual volume instance allocated to the workspace.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the workflow elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An identifiable, logical unit of data storage tied to a physical device.
+
+
+
+
+
+
+ The unique identifier for the volume instance within its deployment context.
+
+
+
+
+
+
+ The name of the volume instance
+
+
+
+
+
+
+ The mode for the volume instance.
+
+
+
+
+
+
+ The underlying path created from the actual volume.
+
+
+
+
+
+
+ The allocated size of the volume accessible to the associated workspace. This should include
+ the scalar size as well as IEC standard unit in either decimal or binary form.
+
+
+
+
+
+
+ Indicates if the volume persists beyond the life of the resource it is associated with.
+
+
+
+
+
+
+ Indicates if the volume is remotely (i.e., network) attached.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Executes specific commands or tools in order to accomplish its owning task as part of a sequence.
+
+
+
+
+
+
+ A name for the step.
+
+
+
+
+
+
+ A description of the step.
+
+
+
+
+
+
+ Ordered list of commands or directives for the step
+
+
+
+
+
+
+
+
+
+
+ A text representation of the executed command.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+
+ References to component or service resources that are used to realize the resource instance.
+
+
+
+
+
+
+ The source type of event which caused the trigger to fire.
+
+
+
+
+
+
+ The event data that caused the associated trigger to activate.
+
+
+
+
+
+
+
+
+
+ A condition that was used to determine a trigger should be activated.
+
+
+
+
+
+
+
+ Describes the set of conditions which cause the trigger to activate.
+
+
+
+
+
+
+ The logical expression that was evaluated that determined the trigger should be fired.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the trigger was activated.
+
+
+
+
+
+
+ Represents resources and data brought into a task at runtime by executor or task commands
+
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor or task commands
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the trigger elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The unique identifier of the event.
+
+
+
+
+
+
+ A description of the event.
+
+
+
+
+
+
+ The date and time (timestamp) when the event was received.
+
+
+
+
+
+
+ Encoding of the raw event data.
+
+
+
+
+
+
+ References the component or service that was the source of the event
+
+
+
+
+
+
+ References the component or service that was the target of the event
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Type that represents various input data types and formats.
+
+
+
+
+
+
+
+ A reference to an independent resource provided as an input to a task by the workflow runtime.
+
+
+
+
+
+
+ Inputs that have the form of parameters with names and values.
+
+
+
+
+
+
+ Inputs that have the form of parameters with names and values.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Inputs that have the form of data.
+
+
+
+
+
+
+
+ A references to the component or service that provided the input to the task
+ (e.g., reference to a service with data flow value of inbound)
+
+
+
+
+
+
+ A reference to the component or service that received or stored the input if not the task
+ itself (e.g., a local, named storage workspace)
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor or task commands
+
+
+
+
+
+
+
+ A reference to an independent resource generated as output by the task.
+
+
+
+
+
+
+ Outputs that have the form of environment variables.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Outputs that have the form of data.
+
+
+
+
+
+
+
+ Describes the type of data output.
+
+
+
+
+
+
+ Component or service that generated or provided the output from the task (e.g., a build tool)
+
+
+
+
+
+
+ Component or service that received the output from the task
+ (e.g., reference to an artifactory service with data flow value of outbound)
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A representation of a functional parameter.
+
+
+
+
+
+
+ The name of the parameter.
+
+
+
+
+
+
+ The value of the parameter.
+
+
+
+
+
+
+ The data type of the parameter.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ Provides additional information about a BOM.
+
+
+
+
+ A list of software and hardware components.
+
+
+
+
+ A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services.
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+ Provides the ability to document dependency relationships.
+
+
+
+
+ Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is OPTIONAL.
+
+
+
+
+ Vulnerabilities identified in components or services.
+
+
+
+
+ Comments made by people, organizations, or tools about any object with
+ a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike
+ inventory information, annotations may contain opinion or commentary from various
+ stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link,
+ and may optionally be signed.
+
+
+
+
+ Describes how a component or service was manufactured or deployed. This is
+ achieved through the use of formulas, workflows, tasks, and steps, which declare the precise
+ steps to reproduce along with the observed formulas describing the steps which transpired
+ in the manufacturing process.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Whenever an existing BOM is modified, either manually or through automated
+ processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with
+ multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM.
+ The default version is '1'.
+
+
+
+
+ Every BOM generated SHOULD have a unique serial number, even if the contents of
+ the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122.
+ Use of serial numbers are RECOMMENDED.
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.6.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.6.SNAPSHOT.schema.json
new file mode 100644
index 00000000..bc61ce44
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.6.SNAPSHOT.schema.json
@@ -0,0 +1,5699 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/bom-1.6.schema.json",
+ "type": "object",
+ "title": "CycloneDX Bill of Materials Standard",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "$schema": {
+ "type": "string"
+ },
+ "bomFormat": {
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention, nor does JSON schema support namespaces. This value must be \"CycloneDX\".",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification the BOM conforms to.",
+ "examples": ["1.6.1"]
+ },
+ "serialNumber": {
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number must conform to [RFC 4122](https://www.ietf.org/rfc/rfc4122.html). Use of serial numbers is recommended.",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.",
+ "minimum": 1,
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components."
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services."
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "dependencies": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency relationships including provided & implemented components."
+ },
+ "compositions": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/compositions"},
+ "uniqueItems": true,
+ "title": "Compositions",
+ "description": "Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described."
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/vulnerability"},
+ "uniqueItems": true,
+ "title": "Vulnerabilities",
+ "description": "Vulnerabilities identified in components or services."
+ },
+ "annotations": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/annotations"},
+ "uniqueItems": true,
+ "title": "Annotations",
+ "description": "Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinions or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link and may optionally be signed."
+ },
+ "formulation": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/formula"},
+ "uniqueItems": true,
+ "title": "Formulation",
+ "description": "Describes how a component or service was manufactured or deployed. This is achieved through the use of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the observed formulas describing the steps which transpired in the manufacturing process."
+ },
+ "declarations": {
+ "type": "object",
+ "title": "Declarations",
+ "description": "The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence.",
+ "additionalProperties": false,
+ "properties": {
+ "assessors": {
+ "type": "array",
+ "title": "Assessors",
+ "description": "The list of assessors evaluating claims and determining conformance to requirements and confidence in that assessment.",
+ "items": {
+ "type": "object",
+ "title": "Assessor",
+ "description": "The assessor who evaluates claims and determines conformance to requirements and confidence in that assessment.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
+ },
+ "thirdParty": {
+ "type": "boolean",
+ "title": "Third Party",
+ "description": "The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor."
+ },
+ "organization": {
+ "$ref": "#/definitions/organizationalEntity",
+ "title": "Organization",
+ "description": "The entity issuing the assessment."
+ }
+ }
+ }
+ },
+ "attestations": {
+ "type": "array",
+ "title": "Attestations",
+ "description": "The list of attestations asserted by an assessor that maps requirements to claims.",
+ "items": {
+ "type": "object",
+ "title": "Attestation",
+ "additionalProperties": false,
+ "properties": {
+ "summary": {
+ "type": "string",
+ "title": "Summary",
+ "description": "The short description explaining the main points of the attestation."
+ },
+ "assessor": {
+ "$ref": "#/definitions/refLinkType",
+ "title": "Assessor",
+ "description": "The `bom-ref` to the assessor asserting the attestation."
+ },
+ "map": {
+ "type": "array",
+ "title": "Map",
+ "description": "The grouping of requirements to claims and the attestors declared conformance and confidence thereof.",
+ "items": {
+ "type": "object",
+ "title": "Map",
+ "additionalProperties": false,
+ "properties": {
+ "requirement": {
+ "$ref": "#/definitions/refLinkType",
+ "title": "Requirement",
+ "description": "The `bom-ref` to the requirement being attested to."
+ },
+ "claims": {
+ "type": "array",
+ "title": "Claims",
+ "description": "The list of `bom-ref` to the claims being attested to.",
+ "items": { "$ref": "#/definitions/refLinkType" }
+ },
+ "counterClaims": {
+ "type": "array",
+ "title": "Counter Claims",
+ "description": "The list of `bom-ref` to the counter claims being attested to.",
+ "items": { "$ref": "#/definitions/refLinkType" }
+ },
+ "conformance": {
+ "type": "object",
+ "title": "Conformance",
+ "description": "The conformance of the claim meeting a requirement.",
+ "additionalProperties": false,
+ "properties": {
+ "score": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "title": "Score",
+ "description": "The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance."
+ },
+ "rationale": {
+ "type": "string",
+ "title": "Rationale",
+ "description": "The rationale for the conformance score."
+ },
+ "mitigationStrategies": {
+ "type": "array",
+ "title": "Mitigation Strategies",
+ "description": "The list of `bom-ref` to the evidence provided describing the mitigation strategies.",
+ "items": { "$ref": "#/definitions/refLinkType" }
+ }
+ }
+ },
+ "confidence": {
+ "type": "object",
+ "title": "Confidence",
+ "description": "The confidence of the claim meeting the requirement.",
+ "additionalProperties": false,
+ "properties": {
+ "score": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "title": "Score",
+ "description": "The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence."
+ },
+ "rationale": {
+ "type": "string",
+ "title": "Rationale",
+ "description": "The rationale for the confidence score."
+ }
+ }
+ }
+ }
+ }
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ }
+ },
+ "claims": {
+ "type": "array",
+ "title": "Claims",
+ "description": "The list of claims.",
+ "items": {
+ "type": "object",
+ "title": "Claim",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
+ },
+ "target": {
+ "$ref": "#/definitions/refLinkType",
+ "title": "Target",
+ "description": "The `bom-ref` to a target representing a specific system, application, API, module, team, person, process, business unit, company, etc... that this claim is being applied to."
+ },
+ "predicate": {
+ "type": "string",
+ "title": "Predicate",
+ "description": "The specific statement or assertion about the target."
+ },
+ "mitigationStrategies": {
+ "type": "array",
+ "title": "Mitigation Strategies",
+ "description": "The list of `bom-ref` to the evidence provided describing the mitigation strategies. Each mitigation strategy should include an explanation of how any weaknesses in the evidence will be mitigated.",
+ "items": { "$ref": "#/definitions/refLinkType" }
+ },
+ "reasoning": {
+ "type": "string",
+ "title": "Reasoning",
+ "description": "The written explanation of why the evidence provided substantiates the claim."
+ },
+ "evidence": {
+ "type": "array",
+ "title": "Evidence",
+ "description": "The list of `bom-ref` to evidence that supports this claim.",
+ "items": { "$ref": "#/definitions/refLinkType" }
+ },
+ "counterEvidence": {
+ "type": "array",
+ "title": "Counter Evidence",
+ "description": "The list of `bom-ref` to counterEvidence that supports this claim.",
+ "items": { "$ref": "#/definitions/refLinkType" }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ }
+ },
+ "evidence": {
+ "type": "array",
+ "title": "Evidence",
+ "description": "The list of evidence",
+ "items": {
+ "type": "object",
+ "title": "Evidence",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
+ },
+ "propertyName": {
+ "type": "string",
+ "title": "Property Name",
+ "description": "The reference to the property name as defined in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy/)."
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "The written description of what this evidence is and how it was created."
+ },
+ "data": {
+ "type": "array",
+ "title": "Data",
+ "description": "The output or analysis that supports claims.",
+ "items": {
+ "type": "object",
+ "title": "Data",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "title": "Data Name",
+ "description": "The name of the data.",
+ "type": "string"
+ },
+ "contents": {
+ "type": "object",
+ "title": "Data Contents",
+ "description": "The contents or references to the contents of the data being described.",
+ "additionalProperties": false,
+ "properties": {
+ "attachment": {
+ "title": "Data Attachment",
+ "description": "An optional way to include textual or encoded data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "Data URL",
+ "description": "The URL to where the data can be retrieved.",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "classification": {
+ "$ref": "#/definitions/dataClassification"
+ },
+ "sensitiveData": {
+ "type": "array",
+ "title": "Sensitive Data",
+ "description": "A description of any sensitive data included.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "governance": {
+ "title": "Data Governance",
+ "$ref": "#/definitions/dataGovernance"
+ }
+ }
+ }
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created",
+ "description": "The date and time (timestamp) when the evidence was created."
+ },
+ "expires": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Expires",
+ "description": "The optional date and time (timestamp) when the evidence is no longer valid."
+ },
+ "author": {
+ "$ref": "#/definitions/organizationalContact",
+ "title": "Author",
+ "description": "The author of the evidence."
+ },
+ "reviewer": {
+ "$ref": "#/definitions/organizationalContact",
+ "title": "Reviewer",
+ "description": "The reviewer of the evidence."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ }
+ },
+ "targets": {
+ "type": "object",
+ "title": "Targets",
+ "description": "The list of targets which claims are made against.",
+ "additionalProperties": false,
+ "properties": {
+ "organizations": {
+ "type": "array",
+ "title": "Organizations",
+ "description": "The list of organizations which claims are made against.",
+ "items": {"$ref": "#/definitions/organizationalEntity"}
+ },
+ "components": {
+ "type": "array",
+ "title": "Components",
+ "description": "The list of components which claims are made against.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "services": {
+ "type": "array",
+ "title": "Services",
+ "description": "The list of services which claims are made against.",
+ "items": {"$ref": "#/definitions/service"}
+ }
+ }
+ },
+ "affirmation": {
+ "type": "object",
+ "title": "Affirmation",
+ "description": "A concise statement affirmed by an individual regarding all declarations, often used for third-party auditor acceptance or recipient acknowledgment. It includes a list of authorized signatories who assert the validity of the document on behalf of the organization.",
+ "additionalProperties": false,
+ "properties": {
+ "statement": {
+ "type": "string",
+ "title": "Statement",
+ "description": "The brief statement affirmed by an individual regarding all declarations.\n*- Notes This could be an affirmation of acceptance by a third-party auditor or receiving individual of a file.",
+ "examples": [ "I certify, to the best of my knowledge, that all information is correct." ]
+ },
+ "signatories": {
+ "type": "array",
+ "title": "Signatories",
+ "description": "The list of signatories authorized on behalf of an organization to assert validity of this document.",
+ "items": {
+ "type": "object",
+ "title": "Signatory",
+ "additionalProperties": false,
+ "oneOf": [
+ {
+ "required": ["signature"]
+ },
+ {
+ "required": ["externalReference", "organization"]
+ }
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The signatory's name."
+ },
+ "role": {
+ "type": "string",
+ "title": "Role",
+ "description": "The signatory's role within an organization."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ },
+ "organization": {
+ "$ref": "#/definitions/organizationalEntity",
+ "title": "Organization",
+ "description": "The signatory's organization."
+ },
+ "externalReference": {
+ "$ref": "#/definitions/externalReference",
+ "title": "External Reference",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ }
+ }
+ }
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "definitions": {
+ "type": "object",
+ "title": "Definitions",
+ "description": "A collection of reusable objects that are defined and may be used elsewhere in the BOM.",
+ "additionalProperties": false,
+ "properties": {
+ "standards": {
+ "type": "array",
+ "title": "Standards",
+ "description": "The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.",
+ "items": {
+ "$ref": "#/definitions/standard"
+ }
+ }
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "description": "Identifier for referable and therefore interlinkable elements.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "type": "string",
+ "minLength": 1,
+ "$comment": "TODO (breaking change): add a format constraint that prevents the value from staring with 'urn:cdx:'"
+ },
+ "refLinkType": {
+ "description": "Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\nIn contrast to `bomLinkElementType`.",
+ "$ref": "#/definitions/refType"
+ },
+ "bomLinkDocumentType": {
+ "title": "BOM-Link Document",
+ "description": "Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/",
+ "type": "string",
+ "format": "iri-reference",
+ "pattern": "^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$",
+ "$comment": "part of the pattern is based on `bom.serialNumber`'s pattern"
+ },
+ "bomLinkElementType": {
+ "title": "BOM-Link Element",
+ "description": "Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/",
+ "type": "string",
+ "format": "iri-reference",
+ "pattern": "^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$",
+ "$comment": "part of the pattern is based on `bom.serialNumber`'s pattern"
+ },
+ "bomLink": {
+ "title": "BOM-Link",
+ "anyOf": [
+ {
+ "title": "BOM-Link Document",
+ "$ref": "#/definitions/bomLinkDocumentType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the BOM was created."
+ },
+ "lifecycles": {
+ "type": "array",
+ "title": "Lifecycles",
+ "description": "Lifecycles communicate the stage(s) in which data in the BOM was captured. Different types of data may be available at various phases of a lifecycle, such as the Software Development Lifecycle (SDLC), IT Asset Management (ITAM), and Software Asset Management (SAM). Thus, a BOM may include data specific to or only obtainable in a given lifecycle.",
+ "items": {
+ "type": "object",
+ "title": "Lifecycle",
+ "description": "The product lifecycle(s) that this BOM represents.",
+ "oneOf": [
+ {
+ "title": "Pre-Defined Phase",
+ "required": ["phase"],
+ "additionalProperties": false,
+ "properties": {
+ "phase": {
+ "type": "string",
+ "title": "Phase",
+ "description": "A pre-defined phase in the product lifecycle.",
+ "enum": [
+ "design",
+ "pre-build",
+ "build",
+ "post-build",
+ "operations",
+ "discovery",
+ "decommission"
+ ],
+ "meta:enum": {
+ "design": "BOM produced early in the development lifecycle containing an inventory of components and services that are proposed or planned to be used. The inventory may need to be procured, retrieved, or resourced prior to use.",
+ "pre-build": "BOM consisting of information obtained prior to a build process and may contain source files and development artifacts and manifests. The inventory may need to be resolved and retrieved prior to use.",
+ "build": "BOM consisting of information obtained during a build process where component inventory is available for use. The precise versions of resolved components are usually available at this time as well as the provenance of where the components were retrieved from.",
+ "post-build": "BOM consisting of information obtained after a build process has completed and the resulting components(s) are available for further analysis. Built components may exist as the result of a CI/CD process, may have been installed or deployed to a system or device, and may need to be retrieved or extracted from the system or device.",
+ "operations": "BOM produced that represents inventory that is running and operational. This may include staging or production environments and will generally encompass multiple SBOMs describing the applications and operating system, along with HBOMs describing the hardware that makes up the system. Operations Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations, and additional dependencies.",
+ "discovery": "BOM consisting of information observed through network discovery providing point-in-time enumeration of embedded, on-premise, and cloud-native services such as server applications, connected devices, microservices, and serverless functions.",
+ "decommission": "BOM containing inventory that will be, or has been retired from operations."
+ }
+ }
+ }
+ },
+ {
+ "title": "Custom Phase",
+ "required": ["name"],
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the lifecycle phase"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "The description of the lifecycle phase"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "tools": {
+ "title": "Tools",
+ "description": "The tool(s) used in the creation, enrichment, and validation of the BOM.",
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "Tools",
+ "description": "The tool(s) used in the creation, enrichment, and validation of the BOM.",
+ "additionalProperties": false,
+ "properties": {
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components used as tools."
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services."
+ }
+ }
+ },
+ {
+ "type": "array",
+ "title": "Tools (legacy)",
+ "description": "[Deprecated] The tool(s) used in the creation, enrichment, and validation of the BOM.",
+ "items": {"$ref": "#/definitions/tool"}
+ }
+ ]
+ },
+ "manufacturer": {
+ "title": "BOM Manufacturer",
+ "description": "The organization that created the BOM.\nManufacturer is common in BOMs created through automated processes. BOMs created through manual means may have `@.authors` instead.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "authors": {
+ "type": "array",
+ "title": "BOM Authors",
+ "description": "The person(s) who created the BOM.\nAuthors are common in BOMs created through manual processes. BOMs created through automated means may have `@.manufacturer` instead.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "deprecated": true,
+ "title": "Component Manufacture (legacy)",
+ "description": "[Deprecated] This will be removed in a future version. Use the `@.component.manufacturer` instead.\nThe organization that manufactured the component that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "licenses": {
+ "title": "BOM License(s)",
+ "description": "The license information for the BOM document.\nThis may be different from the license(s) of the component(s) that the BOM describes.",
+ "$ref": "#/definitions/licenseChoice"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "[Deprecated] This will be removed in a future version. Use component or service instead. Information about the automated or manual tool used",
+ "additionalProperties": false,
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "title": "Tool Vendor",
+ "description": "The name of the vendor who created the tool"
+ },
+ "name": {
+ "type": "string",
+ "title": "Tool Name",
+ "description": "The name of the tool"
+ },
+ "version": {
+ "$ref": "#/definitions/version",
+ "title": "Tool Version",
+ "description": "The version of the tool"
+ },
+ "hashes": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "name": {
+ "type": "string",
+ "title": "Organization Name",
+ "description": "The name of the organization",
+ "examples": [
+ "Example Inc."
+ ]
+ },
+ "address": {
+ "$ref": "#/definitions/postalAddress",
+ "title": "Organization Address",
+ "description": "The physical address (location) of the organization"
+ },
+ "url": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "Organization URL(s)",
+ "description": "The URL of the organization. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ },
+ "contact": {
+ "type": "array",
+ "title": "Organizational Contact",
+ "description": "A contact at the organization. Multiple contacts are allowed.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "examples": ["Contact name"]
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "Email Address",
+ "description": "The email address of the contact.",
+ "examples": ["firstname.lastname@example.com"]
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact.",
+ "examples": ["800-555-1212"]
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component",
+ "required": [
+ "type",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "platform",
+ "operating-system",
+ "device",
+ "device-driver",
+ "firmware",
+ "file",
+ "machine-learning-model",
+ "data",
+ "cryptographic-asset"
+ ],
+ "meta:enum": {
+ "application": "A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.",
+ "framework": "A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.",
+ "library": "A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing)) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended.",
+ "container": "A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization).",
+ "platform": "A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms.",
+ "operating-system": "A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system).",
+ "device": "A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).",
+ "device-driver": "A special type of software that operates or controls a particular type of device. Refer to [https://en.wikipedia.org/wiki/Device_driver](https://en.wikipedia.org/wiki/Device_driver).",
+ "firmware": "A special type of software that provides low-level control over a device's hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware).",
+ "file": "A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.",
+ "machine-learning-model": "A model based on training data that can make predictions or decisions without being explicitly programmed to do so.",
+ "data": "A collection of discrete values that convey information.",
+ "cryptographic-asset": "A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets."
+ },
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.",
+ "examples": ["library"]
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented, such as an image, font, or executable. Some library or framework components may also have an associated mime-type.",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "manufacturer": {
+ "title": "Component Manufacturer",
+ "description": "The organization that created the component.\nManufacturer is common in components created through automated processes. Components created through manual means may have `@.authors` instead.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Component Authors",
+ "description": "The person(s) who created the component.\nAuthors are common in components created through manual processes. Components created through automated means may have `@.manufacturer` instead.",
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "author": {
+ "deprecated": true,
+ "type": "string",
+ "title": "Component Author (legacy)",
+ "description": "[Deprecated] This will be removed in a future version. Use `@.authors` or `@.manufacturer` instead.\nThe person(s) or organization(s) that authored the component",
+ "examples": ["Acme Inc"]
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the component",
+ "examples": ["Acme Inc"]
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "examples": ["tomcat-catalina"]
+ },
+ "version": {
+ "$ref": "#/definitions/version",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally comply with semantic versioning but is not enforced."
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "meta:enum": {
+ "required": "The component is required for runtime",
+ "optional": "The component is optional at runtime. Optional components are components that are not capable of being called due to them not being installed or otherwise accessible by any means. Components that are installed but due to configuration or other restrictions are prohibited from being called must be scoped as 'required'.",
+ "excluded": "Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime."
+ },
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.",
+ "default": "required"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "description": "The hashes of the component.",
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "$ref": "#/definitions/licenseChoice",
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "A copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"]
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Common Platform Enumeration (CPE)",
+ "description": "Asserts the identity of the component using CPE. The CPE must conform to the CPE 2.2 or 2.3 specification. See [https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]
+ },
+ "purl": {
+ "type": "string",
+ "title": "Package URL (purl)",
+ "description": "Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
+ "examples": ["pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"]
+ },
+ "omniborId": {
+ "type": "array",
+ "title": "OmniBOR Artifact Identifier (gitoid)",
+ "description": "Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: [https://www.iana.org/assignments/uri-schemes/prov/gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
+ "items": { "type": "string" },
+ "examples": [
+ "gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
+ "gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
+ ]
+ },
+ "swhid": {
+ "type": "array",
+ "title": "Software Heritage Identifier",
+ "description": "Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html](https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
+ "items": { "type": "string" },
+ "examples": ["swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"]
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Asserts the identity of the component using [ISO-IEC 19770-2 Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "[Deprecated] This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.",
+ "additionalProperties": false,
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the relationship between the components is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.",
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.",
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits.",
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured commentary describing the components pedigree."
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains."
+ },
+ "evidence": {
+ "$ref": "#/definitions/componentEvidence",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "modelCard": {
+ "$ref": "#/definitions/modelCard",
+ "title": "AI/ML Model Card"
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/componentData"},
+ "title": "Data",
+ "description": "This object SHOULD be specified for any component of type `data` and must not be specified for other component types."
+ },
+ "cryptoProperties": {
+ "$ref": "#/definitions/cryptoProperties",
+ "title": "Cryptographic Properties"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "tags": {
+ "$ref": "#/definitions/tags",
+ "title": "Tags"
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the SWID file.",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plan text documents.\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).",
+ "default": "text/plain",
+ "examples": [
+ "text/plain",
+ "application/json",
+ "image/png"
+ ]
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is represented in.",
+ "enum": [
+ "base64"
+ ],
+ "meta:enum": {
+ "base64": "Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string."
+ }
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text."
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "title": "Hash Algorithm",
+ "description": "The algorithm that generated the hash value.",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ]
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Value",
+ "description": "The value of the hash.",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern": "^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License",
+ "description": "Specifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "id": {
+ "$ref": "spdx.SNAPSHOT.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.SNAPSHOT.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.",
+ "examples": ["Acme Software License"]
+ },
+ "acknowledgement": {
+ "$ref": "#/definitions/licenseAcknowledgementEnumeration"
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"],
+ "format": "iri-reference"
+ },
+ "licensing": {
+ "type": "object",
+ "title": "Licensing information",
+ "description": "Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata",
+ "additionalProperties": false,
+ "properties": {
+ "altIds": {
+ "type": "array",
+ "title": "Alternate License Identifiers",
+ "description": "License identifiers that may be used to manage licenses and their lifecycle",
+ "items": {
+ "type": "string"
+ }
+ },
+ "licensor": {
+ "title": "Licensor",
+ "description": "The individual or organization that grants a license to another individual or organization",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Licensor (Organization)",
+ "description": "The organization that granted the license",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "title": "Licensor (Individual)",
+ "description": "The individual, not associated with an organization, that granted the license",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["individual"]
+ }
+ ]
+ },
+ "licensee": {
+ "title": "Licensee",
+ "description": "The individual or organization for which a license was granted to",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Licensee (Organization)",
+ "description": "The organization that was granted the license",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "title": "Licensee (Individual)",
+ "description": "The individual, not associated with an organization, that was granted the license",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["individual"]
+ }
+ ]
+ },
+ "purchaser": {
+ "title": "Purchaser",
+ "description": "The individual or organization that purchased the license",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Purchaser (Organization)",
+ "description": "The organization that purchased the license",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "title": "Purchaser (Individual)",
+ "description": "The individual, not associated with an organization, that purchased the license",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["individual"]
+ }
+ ]
+ },
+ "purchaseOrder": {
+ "type": "string",
+ "title": "Purchase Order",
+ "description": "The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase"
+ },
+ "licenseTypes": {
+ "type": "array",
+ "title": "License Type",
+ "description": "The type of license(s) that was granted to the licensee.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "academic",
+ "appliance",
+ "client-access",
+ "concurrent-user",
+ "core-points",
+ "custom-metric",
+ "device",
+ "evaluation",
+ "named-user",
+ "node-locked",
+ "oem",
+ "perpetual",
+ "processor-points",
+ "subscription",
+ "user",
+ "other"
+ ],
+ "meta:enum": {
+ "academic": "A license that grants use of software solely for the purpose of education or research.",
+ "appliance": "A license covering use of software embedded in a specific piece of hardware.",
+ "client-access": "A Client Access License (CAL) allows client computers to access services provided by server software.",
+ "concurrent-user": "A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users.",
+ "core-points": "A license where the core of a computer's processor is assigned a specific number of points.",
+ "custom-metric": "A license for which consumption is measured by non-standard metrics.",
+ "device": "A license that covers a defined number of installations on computers and other types of devices.",
+ "evaluation": "A license that grants permission to install and use software for trial purposes.",
+ "named-user": "A license that grants access to the software to one or more pre-defined users.",
+ "node-locked": "A license that grants access to the software on one or more pre-defined computers or devices.",
+ "oem": "An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware.",
+ "perpetual": "A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely.",
+ "processor-points": "A license where each installation consumes points per processor.",
+ "subscription": "A license where the licensee pays a fee to use the software or service.",
+ "user": "A license that grants access to the software or service by a specified number of users.",
+ "other": "Another license type."
+ }
+ }
+ },
+ "lastRenewal": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Last Renewal",
+ "description": "The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed."
+ },
+ "expiration": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Expiration",
+ "description": "The timestamp indicating when the current license expires (if applicable)."
+ }
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "licenseAcknowledgementEnumeration": {
+ "title": "License Acknowledgement",
+ "description": "Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in `@.evidence.licenses`. Observed licenses form the evidence necessary to substantiate a concluded license.",
+ "type": "string",
+ "enum": [
+ "declared",
+ "concluded"
+ ],
+ "meta:enum": {
+ "declared": "Declared licenses represent the initial intentions of authors regarding the licensing terms of their code.",
+ "concluded": "Concluded licenses are verified and confirmed."
+ }
+ },
+ "licenseChoice": {
+ "title": "License Choice",
+ "description": "EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)",
+ "type": "array",
+ "oneOf": [
+ {
+ "title": "Multiple licenses",
+ "description": "A list of SPDX licenses and/or named licenses.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "title": "License",
+ "required": ["license"],
+ "additionalProperties": false,
+ "properties": {
+ "license": {"$ref": "#/definitions/license"}
+ }
+ }
+ },
+ {
+ "title": "SPDX License Expression",
+ "description": "A tuple of exactly one SPDX License Expression.",
+ "type": "array",
+ "additionalItems": false,
+ "minItems": 1,
+ "maxItems": 1,
+ "items": [{
+ "type": "object",
+ "additionalProperties": false,
+ "required": ["expression"],
+ "properties": {
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "description": "A valid SPDX license expression.\nRefer to https://spdx.org/specifications for syntax requirements",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ]
+ },
+ "acknowledgement": {
+ "$ref": "#/definitions/licenseAcknowledgementEnumeration"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ }
+ }
+ }]
+ }
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "meta:enum": {
+ "unofficial": "A patch which is not developed by the creators or maintainers of the software being patched. Refer to [https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch).",
+ "monkey": "A patch which dynamically modifies runtime behavior. Refer to [https://en.wikipedia.org/wiki/Monkey_patch](https://en.wikipedia.org/wiki/Monkey_patch).",
+ "backport": "A patch which takes code from a newer version of the software and applies it to older versions of the same software. Refer to [https://en.wikipedia.org/wiki/Backporting](https://en.wikipedia.org/wiki/Backporting).",
+ "cherry-pick": "A patch created by selectively applying commits from other versions or branches of the same software."
+ },
+ "title": "Patch Type",
+ "description": "Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality."
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that shows changes. Refer to [https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff",
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Issue",
+ "description": "An individual issue that has been resolved.",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "meta:enum": {
+ "defect": "A fault, flaw, or bug in software.",
+ "enhancement": "A new feature or behavior in software.",
+ "security": "A special type of defect which impacts security."
+ },
+ "title": "Issue Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "Issue ID",
+ "description": "The identifier of the issue assigned by the source of the issue"
+ },
+ "name": {
+ "type": "string",
+ "title": "Issue Name",
+ "description": "The name of the issue"
+ },
+ "description": {
+ "type": "string",
+ "title": "Issue Description",
+ "description": "A description of the issue"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source.",
+ "examples": [
+ "National Vulnerability Database",
+ "NVD",
+ "Apache"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided by the source",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs are allowed.",
+ "examples": ["https://example.com"]
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.",
+ "required": [
+ "url",
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "anyOf": [
+ {
+ "title": "URL",
+ "type": "string",
+ "format": "iri-reference"
+ },
+ {
+ "title": "BOM-Link",
+ "$ref": "#/definitions/bomLink"
+ }
+ ],
+ "title": "URL",
+ "description": "The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https ([RFC-7230](https://www.ietf.org/rfc/rfc7230.txt)), mailto ([RFC-2368](https://www.ietf.org/rfc/rfc2368.txt)), tel ([RFC-3966](https://www.ietf.org/rfc/rfc3966.txt)), and dns ([RFC-4501](https://www.ietf.org/rfc/rfc4501.txt)). External references may also include formally registered URNs such as [CycloneDX BOM-Link](https://cyclonedx.org/capabilities/bomlink/) to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs."
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external reference"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference.",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "source-distribution",
+ "distribution",
+ "distribution-intake",
+ "license",
+ "build-meta",
+ "build-system",
+ "release-notes",
+ "security-contact",
+ "model-card",
+ "log",
+ "configuration",
+ "evidence",
+ "formulation",
+ "attestation",
+ "threat-model",
+ "adversary-model",
+ "risk-assessment",
+ "vulnerability-assertion",
+ "exploitability-statement",
+ "pentest-report",
+ "static-analysis-report",
+ "dynamic-analysis-report",
+ "runtime-analysis-report",
+ "component-analysis-report",
+ "maturity-report",
+ "certification-report",
+ "codified-infrastructure",
+ "quality-metrics",
+ "poam",
+ "electronic-signature",
+ "digital-signature",
+ "rfc-9116",
+ "other"
+ ],
+ "meta:enum": {
+ "vcs": "Version Control System",
+ "issue-tracker": "Issue or defect tracking system, or an Application Lifecycle Management (ALM) system",
+ "website": "Website",
+ "advisories": "Security advisories",
+ "bom": "Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc)",
+ "mailing-list": "Mailing list or discussion group",
+ "social": "Social media account",
+ "chat": "Real-time chat platform",
+ "documentation": "Documentation, guides, or how-to instructions",
+ "support": "Community or commercial support",
+ "source-distribution": "The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type.",
+ "distribution": "Direct or repository download location",
+ "distribution-intake": "The location where a component was published to. This is often the same as \"distribution\" but may also include specialized publishing processes that act as an intermediary.",
+ "license": "The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness.",
+ "build-meta": "Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)",
+ "build-system": "Reference to an automated build system",
+ "release-notes": "Reference to release notes",
+ "security-contact": "Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT.",
+ "model-card": "A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency.",
+ "log": "A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations.",
+ "configuration": "Parameters or settings that may be used by other components or services.",
+ "evidence": "Information used to substantiate a claim.",
+ "formulation": "Describes how a component or service was manufactured or deployed.",
+ "attestation": "Human or machine-readable statements containing facts, evidence, or testimony.",
+ "threat-model": "An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format.",
+ "adversary-model": "The defined assumptions, goals, and capabilities of an adversary.",
+ "risk-assessment": "Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.",
+ "vulnerability-assertion": "A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.",
+ "exploitability-statement": "A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.",
+ "pentest-report": "Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test.",
+ "static-analysis-report": "SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code.",
+ "dynamic-analysis-report": "Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations.",
+ "runtime-analysis-report": "Report generated by analyzing the call stack of a running application.",
+ "component-analysis-report": "Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis.",
+ "maturity-report": "Report containing a formal assessment of an organization, business unit, or team against a maturity model.",
+ "certification-report": "Industry, regulatory, or other certification from an accredited (if applicable) certification body.",
+ "codified-infrastructure": "Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC).",
+ "quality-metrics": "Report or system in which quality metrics can be obtained.",
+ "poam": "Plans of Action and Milestones (POA&M) complement an \"attestation\" external reference. POA&M is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".",
+ "electronic-signature": "An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name.",
+ "digital-signature": "A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.",
+ "rfc-9116": "Document that complies with [RFC 9116](https://www.ietf.org/rfc/rfc9116.html) (A File Format to Aid in Security Vulnerability Disclosure)",
+ "other": "Use this if no other types accurately describe the purpose of the external reference."
+ }
+ },
+ "hashes": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the external reference (if applicable)."
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies must be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refLinkType",
+ "title": "Reference",
+ "description": "References a component or service by its bom-ref attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/refLinkType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components or services that are dependencies of this dependency object."
+ },
+ "provides": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/refLinkType"
+ },
+ "title": "Provides",
+ "description": "The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object.\nFor example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service",
+ "required": [
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a shortened, single name of the service.",
+ "examples": ["ticker-service"]
+ },
+ "version": {
+ "$ref": "#/definitions/version",
+ "title": "Service Version",
+ "description": "The service version."
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service"
+ },
+ "endpoints": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints are allowed.",
+ "examples": ["https://example.com/api/v1/ticker"]
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."
+ },
+ "trustZone": {
+ "type": "string",
+ "title": "Trust Zone",
+ "description": "The name of the trust zone the service resides in."
+ },
+ "data": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/serviceData"},
+ "title": "Data",
+ "description": "Specifies information about the data including the directional flow of data and the data classification."
+ },
+ "licenses": {
+ "$ref": "#/definitions/licenseChoice",
+ "title": "Service License(s)"
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services included or deployed behind the parent service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "tags": {
+ "$ref": "#/definitions/tags",
+ "title": "Tags"
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "serviceData": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlowDirection",
+ "title": "Directional Flow",
+ "description": "Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways and unknown states that the direction is not known."
+ },
+ "classification": {
+ "$ref": "#/definitions/dataClassification"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Name for the defined data",
+ "examples": [
+ "Credit card reporting"
+ ]
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "Short description of the data content and usage",
+ "examples": [
+ "Credit card information being exchanged in between the web app and the database"
+ ]
+ },
+ "governance": {
+ "title": "Data Governance",
+ "$ref": "#/definitions/dataGovernance"
+ },
+ "source": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "title": "URL",
+ "type": "string",
+ "format": "iri-reference"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "Source",
+ "description": "The URI, URL, or BOM-Link of the components or services the data came in from"
+ },
+ "destination": {
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "title": "URL",
+ "type": "string",
+ "format": "iri-reference"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "Destination",
+ "description": "The URI, URL, or BOM-Link of the components or services the data is sent to"
+ }
+ }
+ },
+ "dataFlowDirection": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "meta:enum": {
+ "inbound": "Data that enters a service.",
+ "outbound": "Data that exits a service.",
+ "bi-directional": "Data flows in and out of the service.",
+ "unknown": "The directional flow of data is not known."
+ },
+ "title": "Data flow direction",
+ "description": "Specifies the flow direction of the data. Direction is relative to the service."
+ },
+ "copyright": {
+ "type": "object",
+ "title": "Copyright",
+ "description": "A copyright notice informing users of the underlying claims to copyright ownership in a published work.",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string",
+ "title": "Copyright Text",
+ "description": "The textual content of the copyright."
+ }
+ }
+ },
+ "componentEvidence": {
+ "type": "object",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected through various forms of extraction or analysis.",
+ "additionalProperties": false,
+ "properties": {
+ "identity": {
+ "title": "Identity Evidence",
+ "description": "Evidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.",
+ "oneOf" : [
+ {
+ "type": "array",
+ "title": "Array of Identity Objects",
+ "items": { "$ref": "#/definitions/componentIdentityEvidence" }
+ },
+ {
+ "title": "A Single Identity Object",
+ "description": "[Deprecated]",
+ "$ref": "#/definitions/componentIdentityEvidence",
+ "deprecated": true
+ }
+ ]
+ },
+ "occurrences": {
+ "type": "array",
+ "title": "Occurrences",
+ "description": "Evidence of individual instances of a component spread across multiple locations.",
+ "items": {
+ "type": "object",
+ "required": [ "location" ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "location": {
+ "type": "string",
+ "title": "Location",
+ "description": "The location or path to where the component was found."
+ },
+ "line": {
+ "type": "integer",
+ "minimum": 0,
+ "title": "Line Number",
+ "description": "The line number where the component was found."
+ },
+ "offset": {
+ "type": "integer",
+ "minimum": 0,
+ "title": "Offset",
+ "description": "The offset where the component was found."
+ },
+ "symbol": {
+ "type": "string",
+ "title": "Symbol",
+ "description": "The symbol name that was found associated with the component."
+ },
+ "additionalContext": {
+ "type": "string",
+ "title": "Additional Context",
+ "description": "Any additional context of the detected component (e.g. a code snippet)."
+ }
+ }
+ }
+ },
+ "callstack": {
+ "type": "object",
+ "title": "Call Stack",
+ "description": "Evidence of the components use through the callstack.",
+ "additionalProperties": false,
+ "properties": {
+ "frames": {
+ "type": "array",
+ "title": "Frames",
+ "description": "Within a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.",
+ "items": {
+ "type": "object",
+ "required": [
+ "module"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "package": {
+ "title": "Package",
+ "description": "A package organizes modules into namespaces, providing a unique namespace for each type it contains.",
+ "type": "string"
+ },
+ "module": {
+ "title": "Module",
+ "description": "A module or class that encloses functions/methods and other code.",
+ "type": "string"
+ },
+ "function": {
+ "title": "Function",
+ "description": "A block of code designed to perform a particular task.",
+ "type": "string"
+ },
+ "parameters": {
+ "title": "Parameters",
+ "description": "Optional arguments that are passed to the module or function.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "line": {
+ "title": "Line",
+ "description": "The line number the code that is called resides on.",
+ "type": "integer"
+ },
+ "column": {
+ "title": "Column",
+ "description": "The column the code that is called resides.",
+ "type": "integer"
+ },
+ "fullFilename": {
+ "title": "Full Filename",
+ "description": "The full path and filename of the module.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "licenses": {
+ "$ref": "#/definitions/licenseChoice",
+ "title": "License Evidence"
+ },
+ "copyright": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/copyright"},
+ "title": "Copyright Evidence",
+ "description": "Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection."
+ }
+ }
+ },
+ "compositions": {
+ "type": "object",
+ "title": "Compositions",
+ "required": [
+ "aggregate"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "aggregate": {
+ "$ref": "#/definitions/aggregateType",
+ "title": "Aggregate",
+ "description": "Specifies an aggregate type that describe how complete a relationship is."
+ },
+ "assemblies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only."
+ },
+ "dependencies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only."
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the vulnerabilities being described."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "aggregateType": {
+ "type": "string",
+ "default": "not_specified",
+ "enum": [
+ "complete",
+ "incomplete",
+ "incomplete_first_party_only",
+ "incomplete_first_party_proprietary_only",
+ "incomplete_first_party_opensource_only",
+ "incomplete_third_party_only",
+ "incomplete_third_party_proprietary_only",
+ "incomplete_third_party_opensource_only",
+ "unknown",
+ "not_specified"
+ ],
+ "meta:enum": {
+ "complete": "The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist.",
+ "incomplete": "The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.",
+ "incomplete_first_party_only": "The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.",
+ "incomplete_first_party_proprietary_only": "The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.",
+ "incomplete_first_party_opensource_only": "The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are opensource.",
+ "incomplete_third_party_only": "The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.",
+ "incomplete_third_party_proprietary_only": "The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.",
+ "incomplete_third_party_opensource_only": "The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.",
+ "unknown": "The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.",
+ "not_specified": "The relationship completeness is not specified."
+ }
+ },
+ "property": {
+ "type": "object",
+ "title": "Lightweight name-value pair",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the property. Duplicate names are allowed, each potentially having a different value."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value of the property."
+ }
+ },
+ "additionalProperties": false
+ },
+ "localeType": {
+ "type": "string",
+ "pattern": "^([a-z]{2})(-[A-Z]{2})?$",
+ "title": "Locale",
+ "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code must be lower case. If the country code is specified, the country code must be upper case. The language code and country code must be separated by a minus sign. Examples: en, en-US, fr, fr-CA"
+ },
+ "releaseType": {
+ "type": "string",
+ "examples": [
+ "major",
+ "minor",
+ "patch",
+ "pre-release",
+ "internal"
+ ],
+ "description": "The software versioning type. It is recommended that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it."
+ },
+ "note": {
+ "type": "object",
+ "title": "Note",
+ "description": "A note containing the locale and content.",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "locale": {
+ "$ref": "#/definitions/localeType",
+ "title": "Locale",
+ "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: \"en\", \"en-US\", \"fr\" and \"fr-CA\""
+ },
+ "text": {
+ "title": "Release note content",
+ "description": "Specifies the full content of the release note.",
+ "$ref": "#/definitions/attachment"
+ }
+ }
+ },
+ "releaseNotes": {
+ "type": "object",
+ "title": "Release notes",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/releaseType",
+ "title": "Type",
+ "description": "The software versioning type the release note describes."
+ },
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "The title of the release."
+ },
+ "featuredImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Featured image",
+ "description": "The URL to an image that may be prominently displayed with the release note."
+ },
+ "socialImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Social image",
+ "description": "The URL to an image that may be used in messaging on social media platforms."
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A short description of the release."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the release note was created."
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Aliases",
+ "description": "One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names)."
+ },
+ "tags": {
+ "$ref": "#/definitions/tags",
+ "title": "Tags"
+ },
+ "resolves": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues that have been resolved."
+ },
+ "notes": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/note"},
+ "title": "Notes",
+ "description": "Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "advisory": {
+ "type": "object",
+ "title": "Advisory",
+ "description": "Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.",
+ "required": ["url"],
+ "additionalProperties": false,
+ "properties": {
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "An optional name of the advisory."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "format": "iri-reference",
+ "description": "Location where the advisory can be obtained."
+ }
+ }
+ },
+ "cwe": {
+ "type": "integer",
+ "minimum": 1,
+ "title": "CWE",
+ "description": "Integer representation of a Common Weaknesses Enumerations (CWE). For example 399 (of https://cwe.mitre.org/data/definitions/399.html)"
+ },
+ "severity": {
+ "type": "string",
+ "title": "Severity",
+ "description": "Textual representation of the severity of the vulnerability adopted by the analysis method. If the analysis method uses values other than what is provided, the user is expected to translate appropriately.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ "info",
+ "none",
+ "unknown"
+ ],
+ "meta:enum": {
+ "critical": "Critical severity",
+ "high": "High severity",
+ "medium": "Medium severity",
+ "low": "Low severity",
+ "info": "Informational warning.",
+ "none": "None",
+ "unknown": "The severity is not known"
+ }
+ },
+ "scoreMethod": {
+ "type": "string",
+ "title": "Method",
+ "description": "Specifies the severity or risk scoring methodology or standard used.",
+ "enum": [
+ "CVSSv2",
+ "CVSSv3",
+ "CVSSv31",
+ "CVSSv4",
+ "OWASP",
+ "SSVC",
+ "other"
+ ],
+ "meta:enum": {
+ "CVSSv2": "Common Vulnerability Scoring System v2.0",
+ "CVSSv3": "Common Vulnerability Scoring System v3.0",
+ "CVSSv31": "Common Vulnerability Scoring System v3.1",
+ "CVSSv4": "Common Vulnerability Scoring System v4.0",
+ "OWASP": "OWASP Risk Rating Methodology",
+ "SSVC": "Stakeholder Specific Vulnerability Categorization",
+ "other": "Another severity or risk scoring methodology"
+ }
+ },
+ "impactAnalysisState": {
+ "type": "string",
+ "title": "Impact Analysis State",
+ "description": "Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.",
+ "enum": [
+ "resolved",
+ "resolved_with_pedigree",
+ "exploitable",
+ "in_triage",
+ "false_positive",
+ "not_affected"
+ ],
+ "meta:enum": {
+ "resolved": "The vulnerability has been remediated.",
+ "resolved_with_pedigree": "The vulnerability has been remediated and evidence of the changes are provided in the affected components pedigree containing verifiable commit history and/or diff(s).",
+ "exploitable": "The vulnerability may be directly or indirectly exploitable.",
+ "in_triage": "The vulnerability is being investigated.",
+ "false_positive": "The vulnerability is not specific to the component or service and was falsely identified or associated.",
+ "not_affected": "The component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases."
+ }
+ },
+ "impactAnalysisJustification": {
+ "type": "string",
+ "title": "Impact Analysis Justification",
+ "description": "The rationale of why the impact analysis state was asserted.",
+ "enum": [
+ "code_not_present",
+ "code_not_reachable",
+ "requires_configuration",
+ "requires_dependency",
+ "requires_environment",
+ "protected_by_compiler",
+ "protected_at_runtime",
+ "protected_at_perimeter",
+ "protected_by_mitigating_control"
+ ],
+ "meta:enum": {
+ "code_not_present": "The code has been removed or tree-shaked.",
+ "code_not_reachable": "The vulnerable code is not invoked at runtime.",
+ "requires_configuration": "Exploitability requires a configurable option to be set/unset.",
+ "requires_dependency": "Exploitability requires a dependency that is not present.",
+ "requires_environment": "Exploitability requires a certain environment which is not present.",
+ "protected_by_compiler": "Exploitability requires a compiler flag to be set/unset.",
+ "protected_at_runtime": "Exploits are prevented at runtime.",
+ "protected_at_perimeter": "Attacks are blocked at physical, logical, or network perimeter.",
+ "protected_by_mitigating_control": "Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability."
+ }
+ },
+ "rating": {
+ "type": "object",
+ "title": "Rating",
+ "description": "Defines the severity or risk ratings of a vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that calculated the severity or risk rating of the vulnerability."
+ },
+ "score": {
+ "type": "number",
+ "title": "Score",
+ "description": "The numerical score of the rating."
+ },
+ "severity": {
+ "$ref": "#/definitions/severity",
+ "description": "Textual representation of the severity that corresponds to the numerical score of the rating."
+ },
+ "method": {
+ "$ref": "#/definitions/scoreMethod"
+ },
+ "vector": {
+ "type": "string",
+ "title": "Vector",
+ "description": "Textual representation of the metric values used to score the vulnerability"
+ },
+ "justification": {
+ "type": "string",
+ "title": "Justification",
+ "description": "An optional reason for rating the vulnerability as it was"
+ }
+ }
+ },
+ "vulnerabilitySource": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of vulnerability information. This is often the organization that published the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the vulnerability documentation as provided by the source.",
+ "examples": [
+ "https://nvd.nist.gov/vuln/detail/CVE-2021-39182"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source.",
+ "examples": [
+ "NVD",
+ "National Vulnerability Database",
+ "OSS Index",
+ "VulnDB",
+ "GitHub Advisories"
+ ]
+ }
+ }
+ },
+ "vulnerability": {
+ "type": "object",
+ "title": "Vulnerability",
+ "description": "Defines a weakness in a component or service that could be exploited or triggered by a threat source.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier that uniquely identifies the vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ },
+ "references": {
+ "type": "array",
+ "title": "References",
+ "description": "Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "source"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "An identifier that uniquely identifies the vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ }
+ }
+ }
+ },
+ "ratings": {
+ "type": "array",
+ "title": "Ratings",
+ "description": "List of vulnerability ratings",
+ "items": {
+ "$ref": "#/definitions/rating"
+ }
+ },
+ "cwes": {
+ "type": "array",
+ "title": "CWEs",
+ "description": "List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability.",
+ "examples": [399],
+ "items": {
+ "$ref": "#/definitions/cwe"
+ }
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the vulnerability as provided by the source."
+ },
+ "detail": {
+ "type": "string",
+ "title": "Details",
+ "description": "If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding root cause."
+ },
+ "recommendation": {
+ "type": "string",
+ "title": "Recommendation",
+ "description": "Recommendations of how the vulnerability can be remediated or mitigated."
+ },
+ "workaround": {
+ "type": "string",
+ "title": "Workarounds",
+ "description": "A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments."
+ },
+ "proofOfConcept": {
+ "type": "object",
+ "title": "Proof of Concept",
+ "description": "Evidence used to reproduce the vulnerability.",
+ "properties": {
+ "reproductionSteps": {
+ "type": "string",
+ "title": "Steps to Reproduce",
+ "description": "Precise steps to reproduce the vulnerability."
+ },
+ "environment": {
+ "type": "string",
+ "title": "Environment",
+ "description": "A description of the environment in which reproduction was possible."
+ },
+ "supportingMaterial": {
+ "type": "array",
+ "title": "Supporting Material",
+ "description": "Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code.",
+ "items": { "$ref": "#/definitions/attachment" }
+ }
+ }
+ },
+ "advisories": {
+ "type": "array",
+ "title": "Advisories",
+ "description": "Published advisories of the vulnerability if provided.",
+ "items": {
+ "$ref": "#/definitions/advisory"
+ }
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created",
+ "description": "The date and time (timestamp) when the vulnerability record was created in the vulnerability database."
+ },
+ "published": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Published",
+ "description": "The date and time (timestamp) when the vulnerability record was first published."
+ },
+ "updated": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Updated",
+ "description": "The date and time (timestamp) when the vulnerability record was last updated."
+ },
+ "rejected": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Rejected",
+ "description": "The date and time (timestamp) when the vulnerability record was rejected (if applicable)."
+ },
+ "credits": {
+ "type": "object",
+ "title": "Credits",
+ "description": "Individuals or organizations credited with the discovery of the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "organizations": {
+ "type": "array",
+ "title": "Organizations",
+ "description": "The organizations credited with vulnerability discovery.",
+ "items": {
+ "$ref": "#/definitions/organizationalEntity"
+ }
+ },
+ "individuals": {
+ "type": "array",
+ "title": "Individuals",
+ "description": "The individuals, not associated with organizations, that are credited with vulnerability discovery.",
+ "items": {
+ "$ref": "#/definitions/organizationalContact"
+ }
+ }
+ }
+ },
+ "tools": {
+ "title": "Tools",
+ "description": "The tool(s) used to identify, confirm, or score the vulnerability.",
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "Tools",
+ "description": "The tool(s) used to identify, confirm, or score the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "components": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components used as tools."
+ },
+ "services": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services."
+ }
+ }
+ },
+ {
+ "type": "array",
+ "title": "Tools (legacy)",
+ "description": "[Deprecated] The tool(s) used to identify, confirm, or score the vulnerability.",
+ "items": {"$ref": "#/definitions/tool"}
+ }
+ ]
+ },
+ "analysis": {
+ "type": "object",
+ "title": "Impact Analysis",
+ "description": "An assessment of the impact and exploitability of the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "state": {
+ "$ref": "#/definitions/impactAnalysisState"
+ },
+ "justification": {
+ "$ref": "#/definitions/impactAnalysisJustification"
+ },
+ "response": {
+ "type": "array",
+ "title": "Response",
+ "description": "A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "can_not_fix",
+ "will_not_fix",
+ "update",
+ "rollback",
+ "workaround_available"
+ ],
+ "meta:enum": {
+ "can_not_fix": "Can not fix",
+ "will_not_fix": "Will not fix",
+ "update": "Update to a different revision or release",
+ "rollback": "Revert to a previous revision or release",
+ "workaround_available": "There is a workaround available"
+ }
+ }
+ },
+ "detail": {
+ "type": "string",
+ "title": "Detail",
+ "description": "Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability."
+ },
+ "firstIssued": {
+ "type": "string",
+ "format": "date-time",
+ "title": "First Issued",
+ "description": "The date and time (timestamp) when the analysis was first issued."
+ },
+ "lastUpdated": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Last Updated",
+ "description": "The date and time (timestamp) when the analysis was last updated."
+ }
+ }
+ },
+ "affects": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "object",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ],
+ "title": "Reference",
+ "description": "References a component or service by the objects bom-ref"
+ },
+ "versions": {
+ "type": "array",
+ "title": "Versions",
+ "description": "Zero or more individual versions or range of versions.",
+ "items": {
+ "type": "object",
+ "oneOf": [
+ {
+ "required": ["version"]
+ },
+ {
+ "required": ["range"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "version": {
+ "title": "Version",
+ "description": "A single version of a component or service.",
+ "$ref": "#/definitions/version"
+ },
+ "range": {
+ "title": "Version Range",
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
+ "$ref": "#/definitions/versionRange"
+ },
+ "status": {
+ "title": "Status",
+ "description": "The vulnerability status for the version or range of versions.",
+ "$ref": "#/definitions/affectedStatus",
+ "default": "affected"
+ }
+ }
+ }
+ }
+ }
+ },
+ "title": "Affects",
+ "description": "The components or services that are affected by the vulnerability."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "affectedStatus": {
+ "description": "The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.",
+ "type": "string",
+ "enum": [
+ "affected",
+ "unaffected",
+ "unknown"
+ ],
+ "meta:enum": {
+ "affected": "The version is affected by the vulnerability.",
+ "unaffected": "The version is not affected by the vulnerability.",
+ "unknown": "It is unknown (or unspecified) whether the given version is affected."
+ }
+ },
+ "version": {
+ "description": "A single disjunctive version identifier, for a component or service.",
+ "type": "string",
+ "maxLength": 1024,
+ "examples": [
+ "9.0.14",
+ "v1.33.7",
+ "7.0.0-M1",
+ "2.0pre1",
+ "1.0.0-beta1",
+ "0.8.15"
+ ]
+ },
+ "versionRange": {
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 4096,
+ "examples": [
+ "vers:cargo/9.0.14",
+ "vers:npm/1.2.3|>=2.0.0|<5.0.0",
+ "vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1",
+ "vers:tomee/>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1|<=8.0.1",
+ "vers:gem/>=2.2.0|!= 2.2.1|<2.3.0"
+ ]
+ },
+ "range": {
+ "deprecated": true,
+ "description": "Deprecated definition. use definition `versionRange` instead.",
+ "$ref": "#/definitions/versionRange"
+ },
+ "annotations": {
+ "type": "object",
+ "title": "Annotations",
+ "description": "A comment, note, explanation, or similar textual content which provides additional context to the object(s) being annotated.",
+ "required": [
+ "subjects",
+ "annotator",
+ "timestamp",
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "subjects": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "Subjects",
+ "description": "The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs."
+ },
+ "annotator": {
+ "type": "object",
+ "title": "Annotator",
+ "description": "The organization, person, component, or service which created the textual content of the annotation.",
+ "oneOf": [
+ {
+ "required": [
+ "organization"
+ ]
+ },
+ {
+ "required": [
+ "individual"
+ ]
+ },
+ {
+ "required": [
+ "component"
+ ]
+ },
+ {
+ "required": [
+ "service"
+ ]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "description": "The organization that created the annotation",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "individual": {
+ "description": "The person that created the annotation",
+ "$ref": "#/definitions/organizationalContact"
+ },
+ "component": {
+ "description": "The tool or component that created the annotation",
+ "$ref": "#/definitions/component"
+ },
+ "service": {
+ "description": "The service that created the annotation",
+ "$ref": "#/definitions/service"
+ }
+ }
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the annotation was created."
+ },
+ "text": {
+ "type": "string",
+ "title": "Text",
+ "description": "The textual content of the annotation."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "modelCard": {
+ "$comment": "Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.",
+ "type": "object",
+ "title": "Model Card",
+ "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "modelParameters": {
+ "type": "object",
+ "title": "Model Parameters",
+ "description": "Hyper-parameters for construction of the model.",
+ "additionalProperties": false,
+ "properties": {
+ "approach": {
+ "type": "object",
+ "title": "Approach",
+ "description": "The overall approach to learning used by the model for problem solving.",
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "title": "Learning Type",
+ "description": "Learning types describing the learning problem or hybrid learning problem.",
+ "enum": [
+ "supervised",
+ "unsupervised",
+ "reinforcement-learning",
+ "semi-supervised",
+ "self-supervised"
+ ],
+ "meta:enum": {
+ "supervised": "Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples.",
+ "unsupervised": "Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data.",
+ "reinforcement-learning": "Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error.",
+ "semi-supervised": "Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques.",
+ "self-supervised": "Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data."
+ }
+ }
+ }
+ },
+ "task": {
+ "type": "string",
+ "title": "Task",
+ "description": "Directly influences the input and/or output. Examples include classification, regression, clustering, etc."
+ },
+ "architectureFamily": {
+ "type": "string",
+ "title": "Architecture Family",
+ "description": "The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc."
+ },
+ "modelArchitecture": {
+ "type": "string",
+ "title": "Model Architecture",
+ "description": "The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc."
+ },
+ "datasets": {
+ "type": "array",
+ "title": "Datasets",
+ "description": "The datasets used to train and evaluate the model.",
+ "items" : {
+ "oneOf" : [
+ {
+ "title": "Inline Data Information",
+ "$ref": "#/definitions/componentData"
+ },
+ {
+ "type": "object",
+ "title": "Data Reference",
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ],
+ "title": "Reference",
+ "type": "string",
+ "description": "References a data component by the components bom-ref attribute"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "inputs": {
+ "type": "array",
+ "title": "Inputs",
+ "description": "The input format(s) of the model",
+ "items": { "$ref": "#/definitions/inputOutputMLParameters" }
+ },
+ "outputs": {
+ "type": "array",
+ "title": "Outputs",
+ "description": "The output format(s) from the model",
+ "items": { "$ref": "#/definitions/inputOutputMLParameters" }
+ }
+ }
+ },
+ "quantitativeAnalysis": {
+ "type": "object",
+ "title": "Quantitative Analysis",
+ "description": "A quantitative analysis of the model",
+ "additionalProperties": false,
+ "properties": {
+ "performanceMetrics": {
+ "type": "array",
+ "title": "Performance Metrics",
+ "description": "The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.",
+ "items": { "$ref": "#/definitions/performanceMetric" }
+ },
+ "graphics": { "$ref": "#/definitions/graphicsCollection" }
+ }
+ },
+ "considerations": {
+ "type": "object",
+ "title": "Considerations",
+ "description": "What considerations should be taken into account regarding the model's construction, training, and application?",
+ "additionalProperties": false,
+ "properties": {
+ "users": {
+ "type": "array",
+ "title": "Users",
+ "description": "Who are the intended users of the model?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "useCases": {
+ "type": "array",
+ "title": "Use Cases",
+ "description": "What are the intended use cases of the model?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "technicalLimitations": {
+ "type": "array",
+ "title": "Technical Limitations",
+ "description": "What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "performanceTradeoffs": {
+ "type": "array",
+ "title": "Performance Tradeoffs",
+ "description": "What are the known tradeoffs in accuracy/performance of the model?",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ethicalConsiderations": {
+ "type": "array",
+ "title": "Ethical Considerations",
+ "description": "What are the ethical risks involved in the application of this model?",
+ "items": { "$ref": "#/definitions/risk" }
+ },
+ "environmentalConsiderations":{
+ "$ref": "#/definitions/environmentalConsiderations",
+ "title": "Environmental Considerations",
+ "description": "What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?"
+ },
+ "fairnessAssessments": {
+ "type": "array",
+ "title": "Fairness Assessments",
+ "description": "How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?",
+ "items": {
+ "$ref": "#/definitions/fairnessAssessment"
+ }
+ }
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "inputOutputMLParameters": {
+ "type": "object",
+ "title": "Input and Output Parameters",
+ "additionalProperties": false,
+ "properties": {
+ "format": {
+ "title": "Input/Output Format",
+ "description": "The data format for input/output to the model.",
+ "type": "string",
+ "examples": [ "string", "image", "time-series"]
+ }
+ }
+ },
+ "componentData": {
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
+ },
+ "type": {
+ "type": "string",
+ "title": "Type of Data",
+ "description": "The general theme or subject matter of the data being specified.",
+ "enum": [
+ "source-code",
+ "configuration",
+ "dataset",
+ "definition",
+ "other"
+ ],
+ "meta:enum": {
+ "source-code": "Any type of code, code snippet, or data-as-code.",
+ "configuration": "Parameters or settings that may be used by other components.",
+ "dataset": "A collection of data.",
+ "definition": "Data that can be used to create new instances of what the definition defines.",
+ "other": "Any other type of data that does not fit into existing definitions."
+ }
+ },
+ "name": {
+ "title": "Dataset Name",
+ "description": "The name of the dataset.",
+ "type": "string"
+ },
+ "contents": {
+ "type": "object",
+ "title": "Data Contents",
+ "description": "The contents or references to the contents of the data being described.",
+ "additionalProperties": false,
+ "properties": {
+ "attachment": {
+ "title": "Data Attachment",
+ "description": "An optional way to include textual or encoded data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "Data URL",
+ "description": "The URL to where the data can be retrieved.",
+ "format": "iri-reference"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Configuration Properties",
+ "description": "Provides the ability to document name-value parameters used for configuration.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "classification": {
+ "$ref": "#/definitions/dataClassification"
+ },
+ "sensitiveData": {
+ "type": "array",
+ "title": "Sensitive Data",
+ "description": "A description of any sensitive data in a dataset.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "graphics": { "$ref": "#/definitions/graphicsCollection" },
+ "description": {
+ "title": "Dataset Description",
+ "description": "A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.",
+ "type": "string"
+ },
+ "governance": {
+ "title": "Data Governance",
+ "$ref": "#/definitions/dataGovernance"
+ }
+ }
+ },
+ "dataGovernance": {
+ "type": "object",
+ "title": "Data Governance",
+ "description": "Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.",
+ "additionalProperties": false,
+ "properties": {
+ "custodians": {
+ "type": "array",
+ "title": "Data Custodians",
+ "description": "Data custodians are responsible for the safe custody, transport, and storage of data.",
+ "items": { "$ref": "#/definitions/dataGovernanceResponsibleParty" }
+ },
+ "stewards": {
+ "type": "array",
+ "title": "Data Stewards",
+ "description": "Data stewards are responsible for data content, context, and associated business rules.",
+ "items": { "$ref": "#/definitions/dataGovernanceResponsibleParty" }
+ },
+ "owners": {
+ "type": "array",
+ "title": "Data Owners",
+ "description": "Data owners are concerned with risk and appropriate access to data.",
+ "items": { "$ref": "#/definitions/dataGovernanceResponsibleParty" }
+ }
+ }
+ },
+ "dataGovernanceResponsibleParty": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "organization": {
+ "title": "Organization",
+ "description": "The organization that is responsible for specific data governance role(s).",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "contact": {
+ "title": "Individual",
+ "description": "The individual that is responsible for specific data governance role(s).",
+ "$ref": "#/definitions/organizationalContact"
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["organization"]
+ },
+ {
+ "required": ["contact"]
+ }
+ ]
+ },
+ "graphicsCollection": {
+ "type": "object",
+ "title": "Graphics Collection",
+ "description": "A collection of graphics that represent various measurements.",
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "title": "Description",
+ "description": "A description of this collection of graphics.",
+ "type": "string"
+ },
+ "collection": {
+ "title": "Collection",
+ "description": "A collection of graphics.",
+ "type": "array",
+ "items": { "$ref": "#/definitions/graphic" }
+ }
+ }
+ },
+ "graphic": {
+ "type": "object",
+ "title": "Graphic",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "title": "Name",
+ "description": "The name of the graphic.",
+ "type": "string"
+ },
+ "image": {
+ "title": "Graphic Image",
+ "description": "The graphic (vector or raster). Base64 encoding must be specified for binary images.",
+ "$ref": "#/definitions/attachment"
+ }
+ }
+ },
+ "performanceMetric": {
+ "type": "object",
+ "title": "Performance Metric",
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "title": "Type",
+ "description": "The type of performance metric.",
+ "type": "string"
+ },
+ "value": {
+ "title": "Value",
+ "description": "The value of the performance metric.",
+ "type": "string"
+ },
+ "slice": {
+ "title": "Slice",
+ "description": "The name of the slice this metric was computed on. By default, assume this metric is not sliced.",
+ "type": "string"
+ },
+ "confidenceInterval": {
+ "title": "Confidence Interval",
+ "description": "The confidence interval of the metric.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "lowerBound": {
+ "title": "Lower Bound",
+ "description": "The lower bound of the confidence interval.",
+ "type": "string"
+ },
+ "upperBound": {
+ "title": "Upper Bound",
+ "description": "The upper bound of the confidence interval.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "risk": {
+ "type": "object",
+ "title": "Risk",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "title": "Name",
+ "description": "The name of the risk.",
+ "type": "string"
+ },
+ "mitigationStrategy": {
+ "title": "Mitigation Strategy",
+ "description": "Strategy used to address this risk.",
+ "type": "string"
+ }
+ }
+ },
+ "fairnessAssessment": {
+ "type": "object",
+ "title": "Fairness Assessment",
+ "description": "Information about the benefits and harms of the model to an identified at risk group.",
+ "additionalProperties": false,
+ "properties": {
+ "groupAtRisk": {
+ "type": "string",
+ "title": "Group at Risk",
+ "description": "The groups or individuals at risk of being systematically disadvantaged by the model."
+ },
+ "benefits": {
+ "type": "string",
+ "title": "Benefits",
+ "description": "Expected benefits to the identified groups."
+ },
+ "harms": {
+ "type": "string",
+ "title": "Harms",
+ "description": "Expected harms to the identified groups."
+ },
+ "mitigationStrategy": {
+ "type": "string",
+ "title": "Mitigation Strategy",
+ "description": "With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "string",
+ "title": "Data Classification",
+ "description": "Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed."
+ },
+ "environmentalConsiderations": {
+ "type": "object",
+ "title": "Environmental Considerations",
+ "description": "Describes various environmental impact metrics.",
+ "additionalProperties": false,
+ "properties": {
+ "energyConsumptions": {
+ "title": "Energy Consumptions",
+ "description": "Describes energy consumption information incurred for one or more component lifecycle activities.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/energyConsumption"
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "energyConsumption": {
+ "title": "Energy consumption",
+ "description": "Describes energy consumption information incurred for the specified lifecycle activity.",
+ "type": "object",
+ "required": [
+ "activity",
+ "energyProviders",
+ "activityEnergyCost"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "activity": {
+ "type": "string",
+ "title": "Activity",
+ "description": "The type of activity that is part of a machine learning model development or operational lifecycle.",
+ "enum": [
+ "design",
+ "data-collection",
+ "data-preparation",
+ "training",
+ "fine-tuning",
+ "validation",
+ "deployment",
+ "inference",
+ "other"
+ ],
+ "meta:enum": {
+ "design": "A model design including problem framing, goal definition and algorithm selection.",
+ "data-collection": "Model data acquisition including search, selection and transfer.",
+ "data-preparation": "Model data preparation including data cleaning, labeling and conversion.",
+ "training": "Model building, training and generalized tuning.",
+ "fine-tuning": "Refining a trained model to produce desired outputs for a given problem space.",
+ "validation": "Model validation including model output evaluation and testing.",
+ "deployment": "Explicit model deployment to a target hosting infrastructure.",
+ "inference": "Generating an output response from a hosted model from a set of inputs.",
+ "other": "A lifecycle activity type whose description does not match currently defined values."
+ }
+ },
+ "energyProviders": {
+ "title": "Energy Providers",
+ "description": "The provider(s) of the energy consumed by the associated model development lifecycle activity.",
+ "type": "array",
+ "items": { "$ref": "#/definitions/energyProvider" }
+ },
+ "activityEnergyCost": {
+ "title": "Activity Energy Cost",
+ "description": "The total energy cost associated with the model lifecycle activity.",
+ "$ref": "#/definitions/energyMeasure"
+ },
+ "co2CostEquivalent": {
+ "title": "CO2 Equivalent Cost",
+ "description": "The CO2 cost (debit) equivalent to the total energy cost.",
+ "$ref": "#/definitions/co2Measure"
+ },
+ "co2CostOffset": {
+ "title": "CO2 Cost Offset",
+ "description": "The CO2 offset (credit) for the CO2 equivalent cost.",
+ "$ref": "#/definitions/co2Measure"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "energyMeasure": {
+ "type": "object",
+ "title": "Energy Measure",
+ "description": "A measure of energy.",
+ "required": [
+ "value",
+ "unit"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "value": {
+ "type": "number",
+ "title": "Value",
+ "description": "Quantity of energy."
+ },
+ "unit": {
+ "type": "string",
+ "enum": [ "kWh" ],
+ "title": "Unit",
+ "description": "Unit of energy.",
+ "meta:enum": {
+ "kWh": "Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h)."
+ }
+ }
+ }
+ },
+ "co2Measure": {
+ "type": "object",
+ "title": "CO2 Measure",
+ "description": "A measure of carbon dioxide (CO2).",
+ "required": [
+ "value",
+ "unit"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "value": {
+ "type": "number",
+ "title": "Value",
+ "description": "Quantity of carbon dioxide (CO2)."
+ },
+ "unit": {
+ "type": "string",
+ "enum": [ "tCO2eq" ],
+ "title": "Unit",
+ "description": "Unit of carbon dioxide (CO2).",
+ "meta:enum": {
+ "tCO2eq": "Tonnes (t) of carbon dioxide (CO2) equivalent (eq)."
+ }
+ }
+ }
+ },
+ "energyProvider": {
+ "type": "object",
+ "title": "Energy Provider",
+ "description": "Describes the physical provider of energy used for model development or operations.",
+ "required": [
+ "organization",
+ "energySource",
+ "energyProvided"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "$ref": "#/definitions/refType"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the energy provider."
+ },
+ "organization": {
+ "type": "object",
+ "title": "Organization",
+ "description": "The organization that provides energy.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "energySource": {
+ "type": "string",
+ "enum": [
+ "coal",
+ "oil",
+ "natural-gas",
+ "nuclear",
+ "wind",
+ "solar",
+ "geothermal",
+ "hydropower",
+ "biofuel",
+ "unknown",
+ "other"
+ ],
+ "meta:enum": {
+ "coal": "Energy produced by types of coal.",
+ "oil": "Petroleum products (primarily crude oil and its derivative fuel oils).",
+ "natural-gas": "Hydrocarbon gas liquids (HGL) that occur as gases at atmospheric pressure and as liquids under higher pressures including Natural gas (C5H12 and heavier), Ethane (C2H6), Propane (C3H8), etc.",
+ "nuclear": "Energy produced from the cores of atoms (i.e., through nuclear fission or fusion).",
+ "wind": "Energy produced from moving air.",
+ "solar": "Energy produced from the sun (i.e., solar radiation).",
+ "geothermal": "Energy produced from heat within the earth.",
+ "hydropower": "Energy produced from flowing water.",
+ "biofuel": "Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals).",
+ "unknown": "The energy source is unknown.",
+ "other": "An energy source that is not listed."
+ },
+ "title": "Energy Source",
+ "description": "The energy source for the energy provider."
+ },
+ "energyProvided": {
+ "$ref": "#/definitions/energyMeasure",
+ "title": "Energy Provided",
+ "description": "The energy provided by the energy source for an associated activity."
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ }
+ }
+ },
+ "postalAddress": {
+ "type": "object",
+ "title": "Postal address",
+ "description": "An address used to identify a contactable location.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "$ref": "#/definitions/refType"
+ },
+ "country": {
+ "type": "string",
+ "title": "Country",
+ "description": "The country name or the two-letter ISO 3166-1 country code."
+ },
+ "region": {
+ "type": "string",
+ "title": "Region",
+ "description": "The region or state in the country.",
+ "examples": [ "Texas" ]
+ },
+ "locality": {
+ "type": "string",
+ "title": "Locality",
+ "description": "The locality or city within the country.",
+ "examples": [ "Austin" ]
+ },
+ "postOfficeBoxNumber": {
+ "type": "string",
+ "title": "Post Office Box Number",
+ "description": "The post office box number.",
+ "examples": [ "901" ]
+ },
+ "postalCode": {
+ "type": "string",
+ "title": "Postal Code",
+ "description": "The postal code.",
+ "examples": [ "78758" ]
+ },
+ "streetAddress": {
+ "type": "string",
+ "title": "Street Address",
+ "description": "The street address.",
+ "examples": [ "100 Main Street" ]
+ }
+ }
+ },
+ "formula": {
+ "title": "Formula",
+ "description": "Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "$ref": "#/definitions/refType"
+ },
+ "components": {
+ "title": "Components",
+ "description": "Transient components that are used in tasks that constitute one or more of this formula's workflows",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/component"
+ },
+ "uniqueItems": true
+ },
+ "services": {
+ "title": "Services",
+ "description": "Transient services that are used in tasks that constitute one or more of this formula's workflows",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/service"
+ },
+ "uniqueItems": true
+ },
+ "workflows": {
+ "title": "Workflows",
+ "description": "List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered.",
+ "$comment": "Different workflows can be designed to work together to perform end-to-end CI/CD builds and deployments.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/workflow"
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "workflow": {
+ "title": "Workflow",
+ "description": "A specialized orchestration task.",
+ "$comment": "Workflow are as task themselves and can trigger other workflow tasks. These relationships can be modeled in the taskDependencies graph.",
+ "type": "object",
+ "required": [
+ "bom-ref",
+ "uid",
+ "taskTypes"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "tasks": {
+ "title": "Tasks",
+ "description": "The tasks that comprise the workflow.",
+ "$comment": "Note that tasks can appear more than once as different instances (by name or UID).",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/task"
+ }
+ },
+ "taskDependencies": {
+ "title": "Task dependency graph",
+ "description": "The graph of dependencies between tasks within the workflow.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/dependency"
+ }
+ },
+ "taskTypes": {
+ "title": "Task types",
+ "description": "Indicates the types of activities performed by the set of workflow tasks.",
+ "$comment": "Currently, these types reflect common CI/CD actions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/taskType"
+ }
+ },
+ "trigger": {
+ "title": "Trigger",
+ "description": "The trigger that initiated the task.",
+ "$ref": "#/definitions/trigger"
+ },
+ "steps": {
+ "title": "Steps",
+ "description": "The sequence of steps for the task.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/step"
+ },
+ "uniqueItems": true
+ },
+ "inputs": {
+ "title": "Inputs",
+ "description": "Represents resources and data brought into a task at runtime by executor or task commands",
+ "examples": ["a `configuration` file which was declared as a local `component` or `externalReference`"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/inputType"
+ },
+ "uniqueItems": true
+ },
+ "outputs": {
+ "title": "Outputs",
+ "description": "Represents resources and data output from a task at runtime by executor or task commands",
+ "examples": ["a log file or metrics data produced by the task"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/outputType"
+ },
+ "uniqueItems": true
+ },
+ "timeStart": {
+ "title": "Time start",
+ "description": "The date and time (timestamp) when the task started.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "timeEnd": {
+ "title": "Time end",
+ "description": "The date and time (timestamp) when the task ended.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "workspaces": {
+ "title": "Workspaces",
+ "description": "A set of named filesystem or data resource shareable by workflow tasks.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/workspace"
+ }
+ },
+ "runtimeTopology": {
+ "title": "Runtime topology",
+ "description": "A graph of the component runtime topology for workflow's instance.",
+ "$comment": "A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/dependency"
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "task": {
+ "title": "Task",
+ "description": "Describes the inputs, sequence of steps and resources used to accomplish a task and its output.",
+ "$comment": "Tasks are building blocks for constructing assemble CI/CD workflows or pipelines.",
+ "type": "object",
+ "required": [
+ "bom-ref",
+ "uid",
+ "taskTypes"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "taskTypes": {
+ "title": "Task types",
+ "description": "Indicates the types of activities performed by the set of workflow tasks.",
+ "$comment": "Currently, these types reflect common CI/CD actions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/taskType"
+ }
+ },
+ "trigger": {
+ "title": "Trigger",
+ "description": "The trigger that initiated the task.",
+ "$ref": "#/definitions/trigger"
+ },
+ "steps": {
+ "title": "Steps",
+ "description": "The sequence of steps for the task.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/step"
+ },
+ "uniqueItems": true
+ },
+ "inputs": {
+ "title": "Inputs",
+ "description": "Represents resources and data brought into a task at runtime by executor or task commands",
+ "examples": ["a `configuration` file which was declared as a local `component` or `externalReference`"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/inputType"
+ },
+ "uniqueItems": true
+ },
+ "outputs": {
+ "title": "Outputs",
+ "description": "Represents resources and data output from a task at runtime by executor or task commands",
+ "examples": ["a log file or metrics data produced by the task"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/outputType"
+ },
+ "uniqueItems": true
+ },
+ "timeStart": {
+ "title": "Time start",
+ "description": "The date and time (timestamp) when the task started.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "timeEnd": {
+ "title": "Time end",
+ "description": "The date and time (timestamp) when the task ended.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "workspaces": {
+ "title": "Workspaces",
+ "description": "A set of named filesystem or data resource shareable by workflow tasks.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/workspace"
+ },
+ "uniqueItems": true
+ },
+ "runtimeTopology": {
+ "title": "Runtime topology",
+ "description": "A graph of the component runtime topology for task's instance.",
+ "$comment": "A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/dependency"
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "step": {
+ "type": "object",
+ "description": "Executes specific commands or tools in order to accomplish its owning task as part of a sequence.",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "title": "Name",
+ "description": "A name for the step.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the step.",
+ "type": "string"
+ },
+ "commands": {
+ "title": "Commands",
+ "description": "Ordered list of commands or directives for the step",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/command"
+ }
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "command": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "executed": {
+ "title": "Executed",
+ "description": "A text representation of the executed command.",
+ "type": "string"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "workspace": {
+ "title": "Workspace",
+ "description": "A named filesystem or data resource shareable by workflow tasks.",
+ "type": "object",
+ "required": [
+ "bom-ref",
+ "uid"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "aliases": {
+ "title": "Aliases",
+ "description": "The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps.",
+ "type": "array",
+ "items": {"type": "string"}
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "accessMode": {
+ "title": "Access mode",
+ "description": "Describes the read-write access control for the workspace relative to the owning resource instance.",
+ "type": "string",
+ "enum": [
+ "read-only",
+ "read-write",
+ "read-write-once",
+ "write-once",
+ "write-only"
+ ]
+ },
+ "mountPath": {
+ "title": "Mount path",
+ "description": "A path to a location on disk where the workspace will be available to the associated task's steps.",
+ "type": "string"
+ },
+ "managedDataType": {
+ "title": "Managed data type",
+ "description": "The name of a domain-specific data type the workspace represents.",
+ "$comment": "This property is for CI/CD frameworks that are able to provide access to structured, managed data at a more granular level than a filesystem.",
+ "examples": ["ConfigMap","Secret"],
+ "type": "string"
+ },
+ "volumeRequest": {
+ "title": "Volume request",
+ "description": "Identifies the reference to the request for a specific volume type and parameters.",
+ "examples": ["a kubernetes Persistent Volume Claim (PVC) name"],
+ "type": "string"
+ },
+ "volume": {
+ "title": "Volume",
+ "description": "Information about the actual volume instance allocated to the workspace.",
+ "$comment": "The actual volume allocated may be different than the request.",
+ "examples": ["see https://kubernetes.io/docs/concepts/storage/persistent-volumes/"],
+ "$ref": "#/definitions/volume"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "volume": {
+ "title": "Volume",
+ "description": "An identifiable, logical unit of data storage tied to a physical device.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the volume instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the volume instance",
+ "type": "string"
+ },
+ "mode": {
+ "title": "Mode",
+ "description": "The mode for the volume instance.",
+ "type": "string",
+ "enum": [
+ "filesystem", "block"
+ ],
+ "default": "filesystem"
+ },
+ "path": {
+ "title": "Path",
+ "description": "The underlying path created from the actual volume.",
+ "type": "string"
+ },
+ "sizeAllocated": {
+ "title": "Size allocated",
+ "description": "The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form.",
+ "examples": ["10GB", "2Ti", "1Pi"],
+ "type": "string"
+ },
+ "persistent": {
+ "title": "Persistent",
+ "description": "Indicates if the volume persists beyond the life of the resource it is associated with.",
+ "type": "boolean"
+ },
+ "remote": {
+ "title": "Remote",
+ "description": "Indicates if the volume is remotely (i.e., network) attached.",
+ "type": "boolean"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "trigger": {
+ "title": "Trigger",
+ "description": "Represents a resource that can conditionally activate (or fire) tasks based upon associated events and their data.",
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "type",
+ "bom-ref",
+ "uid"
+ ],
+ "properties": {
+ "bom-ref": {
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
+ "$ref": "#/definitions/refType"
+ },
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier for the resource instance within its deployment context.",
+ "type": "string"
+ },
+ "name": {
+ "title": "Name",
+ "description": "The name of the resource instance.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the resource instance.",
+ "type": "string"
+ },
+ "resourceReferences": {
+ "title": "Resource references",
+ "description": "References to component or service resources that are used to realize the resource instance.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/resourceReferenceChoice"
+ }
+ },
+ "type": {
+ "title": "Type",
+ "description": "The source type of event which caused the trigger to fire.",
+ "type": "string",
+ "enum": [
+ "manual",
+ "api",
+ "webhook",
+ "scheduled"
+ ]
+ },
+ "event": {
+ "title": "Event",
+ "description": "The event data that caused the associated trigger to activate.",
+ "$ref": "#/definitions/event"
+ },
+ "conditions": {
+ "type": "array",
+ "title": "Conditions",
+ "description": "A list of conditions used to determine if a trigger should be activated.",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/condition"
+ }
+ },
+ "timeActivated": {
+ "title": "Time activated",
+ "description": "The date and time (timestamp) when the trigger was activated.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "inputs": {
+ "title": "Inputs",
+ "description": "Represents resources and data brought into a task at runtime by executor or task commands",
+ "examples": ["a `configuration` file which was declared as a local `component` or `externalReference`"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/inputType"
+ },
+ "uniqueItems": true
+ },
+ "outputs": {
+ "title": "Outputs",
+ "description": "Represents resources and data output from a task at runtime by executor or task commands",
+ "examples": ["a log file or metrics data produced by the task"],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/outputType"
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "event": {
+ "title": "Event",
+ "description": "Represents something that happened that may trigger a response.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "title": "Unique Identifier (UID)",
+ "description": "The unique identifier of the event.",
+ "type": "string"
+ },
+ "description": {
+ "title": "Description",
+ "description": "A description of the event.",
+ "type": "string"
+ },
+ "timeReceived": {
+ "title": "Time Received",
+ "description": "The date and time (timestamp) when the event was received.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "data": {
+ "title": "Data",
+ "description": "Encoding of the raw event data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "source": {
+ "title": "Source",
+ "description": "References the component or service that was the source of the event",
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "target": {
+ "title": "Target",
+ "description": "References the component or service that was the target of the event",
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "inputType": {
+ "title": "Input type",
+ "description": "Type that represents various input data types and formats.",
+ "type": "object",
+ "oneOf": [
+ {
+ "required": [
+ "resource"
+ ]
+ },
+ {
+ "required": [
+ "parameters"
+ ]
+ },
+ {
+ "required": [
+ "environmentVars"
+ ]
+ },
+ {
+ "required": [
+ "data"
+ ]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "title": "Source",
+ "description": "A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of `inbound`)",
+ "examples": [
+ "source code repository",
+ "database"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "target": {
+ "title": "Target",
+ "description": "A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)",
+ "examples": [
+ "workspace",
+ "directory"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "resource": {
+ "title": "Resource",
+ "description": "A reference to an independent resource provided as an input to a task by the workflow runtime.",
+ "examples": [
+ "a reference to a configuration file in a repository (i.e., a bom-ref)",
+ "a reference to a scanning service used in a task (i.e., a bom-ref)"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "parameters": {
+ "title": "Parameters",
+ "description": "Inputs that have the form of parameters with names and values.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/parameter"
+ }
+ },
+ "environmentVars": {
+ "title": "Environment variables",
+ "description": "Inputs that have the form of parameters with names and values.",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/property"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "data": {
+ "title": "Data",
+ "description": "Inputs that have the form of data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "outputType": {
+ "type": "object",
+ "oneOf": [
+ {
+ "required": [
+ "resource"
+ ]
+ },
+ {
+ "required": [
+ "environmentVars"
+ ]
+ },
+ {
+ "required": [
+ "data"
+ ]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "title": "Type",
+ "description": "Describes the type of data output.",
+ "type": "string",
+ "enum": [
+ "artifact",
+ "attestation",
+ "log",
+ "evidence",
+ "metrics",
+ "other"
+ ]
+ },
+ "source": {
+ "title": "Source",
+ "description": "Component or service that generated or provided the output from the task (e.g., a build tool)",
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "target": {
+ "title": "Target",
+ "description": "Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`)",
+ "examples": ["a log file described as an `externalReference` within its target domain."],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "resource": {
+ "title": "Resource",
+ "description": "A reference to an independent resource generated as output by the task.",
+ "examples": [
+ "configuration file",
+ "source code",
+ "scanning service"
+ ],
+ "$ref": "#/definitions/resourceReferenceChoice"
+ },
+ "data": {
+ "title": "Data",
+ "description": "Outputs that have the form of data.",
+ "$ref": "#/definitions/attachment"
+ },
+ "environmentVars": {
+ "title": "Environment variables",
+ "description": "Outputs that have the form of environment variables.",
+ "type": "array",
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/property"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "uniqueItems": true
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "resourceReferenceChoice": {
+ "title": "Resource reference choice",
+ "description": "A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.",
+ "$comment": "Enables reference to a resource that participates in a workflow; using either internal (bom-ref) or external (externalReference) types.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "title": "BOM Reference",
+ "description": "References an object by its bom-ref attribute",
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "externalReference": {
+ "title": "External reference",
+ "description": "Reference to an externally accessible resource.",
+ "$ref": "#/definitions/externalReference"
+ }
+ },
+ "oneOf": [
+ {
+ "required": [
+ "ref"
+ ]
+ },
+ {
+ "required": [
+ "externalReference"
+ ]
+ }
+ ]
+ },
+ "condition": {
+ "title": "Condition",
+ "description": "A condition that was used to determine a trigger should be activated.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "title": "Description",
+ "description": "Describes the set of conditions which cause the trigger to activate.",
+ "type": "string"
+ },
+ "expression": {
+ "title": "Expression",
+ "description": "The logical expression that was evaluated that determined the trigger should be fired.",
+ "type": "string"
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "taskType": {
+ "type": "string",
+ "enum": [
+ "copy",
+ "clone",
+ "lint",
+ "scan",
+ "merge",
+ "build",
+ "test",
+ "deliver",
+ "deploy",
+ "release",
+ "clean",
+ "other"
+ ],
+ "meta:enum": {
+ "copy": "A task that copies software or data used to accomplish other tasks in the workflow.",
+ "clone": "A task that clones a software repository into the workflow in order to retrieve its source code or data for use in a build step.",
+ "lint": "A task that checks source code for programmatic and stylistic errors.",
+ "scan": "A task that performs a scan against source code, or built or deployed components and services. Scans are typically run to gather or test for security vulnerabilities or policy compliance.",
+ "merge": "A task that merges changes or fixes into source code prior to a build step in the workflow.",
+ "build": "A task that builds the source code, dependencies and/or data into an artifact that can be deployed to and executed on target systems.",
+ "test": "A task that verifies the functionality of a component or service.",
+ "deliver": "A task that delivers a built artifact to one or more target repositories or storage systems.",
+ "deploy": "A task that deploys a built artifact for execution on one or more target systems.",
+ "release": "A task that releases a built, versioned artifact to a target repository or distribution system.",
+ "clean": "A task that cleans unnecessary tools, build artifacts and/or data from workflow storage.",
+ "other": "A workflow task that does not match current task type definitions."
+ }
+ },
+ "parameter": {
+ "title": "Parameter",
+ "description": "A representation of a functional parameter.",
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "title": "Name",
+ "description": "The name of the parameter.",
+ "type": "string"
+ },
+ "value": {
+ "title": "Value",
+ "description": "The value of the parameter.",
+ "type": "string"
+ },
+ "dataType": {
+ "title": "Data type",
+ "description": "The data type of the parameter.",
+ "type": "string"
+ }
+ }
+ },
+ "componentIdentityEvidence": {
+ "type": "object",
+ "title": "Identity Evidence",
+ "description": "Evidence that substantiates the identity of a component.",
+ "required": [ "field" ],
+ "additionalProperties": false,
+ "properties": {
+ "field": {
+ "type": "string",
+ "enum": [
+ "group", "name", "version", "purl", "cpe", "omniborId", "swhid", "swid", "hash"
+ ],
+ "title": "Field",
+ "description": "The identity field of the component which the evidence describes."
+ },
+ "confidence": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "title": "Confidence",
+ "description": "The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence."
+ },
+ "concludedValue": {
+ "type": "string",
+ "title": "Concluded Value",
+ "description": "The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available)."
+ },
+ "methods": {
+ "type": "array",
+ "title": "Methods",
+ "description": "The methods used to extract and/or analyze the evidence.",
+ "items": {
+ "type": "object",
+ "required": [
+ "technique" ,
+ "confidence"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "technique": {
+ "title": "Technique",
+ "description": "The technique used in this method of analysis.",
+ "type": "string",
+ "enum": [
+ "source-code-analysis",
+ "binary-analysis",
+ "manifest-analysis",
+ "ast-fingerprint",
+ "hash-comparison",
+ "instrumentation",
+ "dynamic-analysis",
+ "filename",
+ "attestation",
+ "other"
+ ]
+ },
+ "confidence": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "title": "Confidence",
+ "description": "The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value or contents of the evidence."
+ }
+ }
+ }
+ },
+ "tools": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "anyOf": [
+ {
+ "title": "Ref",
+ "$ref": "#/definitions/refLinkType"
+ },
+ {
+ "title": "BOM-Link Element",
+ "$ref": "#/definitions/bomLinkElementType"
+ }
+ ]
+ },
+ "title": "BOM References",
+ "description": "The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation."
+ }
+ }
+ },
+ "standard": {
+ "type": "object",
+ "title": "Standard",
+ "description": "A standard may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the standard. This will often be a shortened, single name of the standard."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "description": "The version of the standard."
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "The description of the standard."
+ },
+ "owner": {
+ "type": "string",
+ "title": "Owner",
+ "description": "The owner of the standard, often the entity responsible for its release."
+ },
+ "requirements": {
+ "type": "array",
+ "title": "Requirements",
+ "description": "The list of requirements comprising the standard.",
+ "items": {
+ "type": "object",
+ "title": "Requirement",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
+ },
+ "identifier": {
+ "type": "string",
+ "title": "Identifier",
+ "description": "The unique identifier used in the standard to identify a specific requirement. This should match what is in the standard and should not be the requirements bom-ref."
+ },
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "The title of the requirement."
+ },
+ "text": {
+ "type": "string",
+ "title": "Text",
+ "description": "The textual content of the requirement."
+ },
+ "descriptions": {
+ "type": "array",
+ "title": "Descriptions",
+ "description": "The supplemental text that provides additional guidance or context to the requirement, but is not directly part of the requirement.",
+ "items": { "type": "string" }
+ },
+ "openCre": {
+ "type": "array",
+ "title": "OWASP OpenCRE Identifier(s)",
+ "description": "The Common Requirements Enumeration (CRE) identifier(s). CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all resources map to each other. Use of CRE promotes clear and unambiguous communication among stakeholders.",
+ "items": {
+ "type": "string",
+ "pattern": "^CRE:[0-9]+-[0-9]+$",
+ "examples": [ "CRE:764-507" ]
+ }
+ },
+ "parent": {
+ "$ref": "#/definitions/refLinkType",
+ "title": "Parent BOM Reference",
+ "description": "The optional `bom-ref` to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements must not define a parent. Only child requirements should define parents."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ }
+ }
+ }
+ },
+ "levels": {
+ "type": "array",
+ "title": "Levels",
+ "description": "The list of levels associated with the standard. Some standards have different levels of compliance.",
+ "items": {
+ "type": "object",
+ "title": "Level",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
+ },
+ "identifier": {
+ "type": "string",
+ "title": "Identifier",
+ "description": "The identifier used in the standard to identify a specific level."
+ },
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "The title of the level."
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "The description of the level."
+ },
+ "requirements": {
+ "type": "array",
+ "title": "Requirements",
+ "description": "The list of requirement `bom-ref`s that comprise the level.",
+ "items": { "$ref": "#/definitions/refLinkType" }
+ }
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "signature": {
+ "$ref": "jsf-0.82.SNAPSHOT.schema.json#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ },
+ "cryptoProperties": {
+ "type": "object",
+ "title": "Cryptographic Properties",
+ "description": "Cryptographic assets have properties that uniquely define them and that make them actionable for further reasoning. As an example, it makes a difference if one knows the algorithm family (e.g. AES) or the specific variant or instantiation (e.g. AES-128-GCM). This is because the security level and the algorithm primitive (authenticated encryption) are only defined by the definition of the algorithm variant. The presence of a weak cryptographic algorithm like SHA1 vs. HMAC-SHA1 also makes a difference.",
+ "additionalProperties": false,
+ "required": [
+ "assetType"
+ ],
+ "properties": {
+ "assetType": {
+ "type": "string",
+ "title": "Asset Type",
+ "description": "Cryptographic assets occur in several forms. Algorithms and protocols are most commonly implemented in specialized cryptographic libraries. They may, however, also be 'hardcoded' in software components. Certificates and related cryptographic material like keys, tokens, secrets or passwords are other cryptographic assets to be modelled.",
+ "enum": [
+ "algorithm",
+ "certificate",
+ "protocol",
+ "related-crypto-material"
+ ],
+ "meta:enum": {
+ "algorithm": "Mathematical function commonly used for data encryption, authentication, and digital signatures.",
+ "certificate": "An electronic document that is used to provide the identity or validate a public key.",
+ "protocol": "A set of rules and guidelines that govern the behavior and communication with each other.",
+ "related-crypto-material": "Other cryptographic assets related to algorithms, certificates, and protocols such as keys and tokens."
+ }
+ },
+ "algorithmProperties": {
+ "type": "object",
+ "title": "Algorithm Properties",
+ "description": "Additional properties specific to a cryptographic algorithm.",
+ "additionalProperties": false,
+ "properties": {
+ "primitive": {
+ "type": "string",
+ "title": "primitive",
+ "description": "Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).",
+ "enum": [
+ "drbg",
+ "mac",
+ "block-cipher",
+ "stream-cipher",
+ "signature",
+ "hash",
+ "pke",
+ "xof",
+ "kdf",
+ "key-agree",
+ "kem",
+ "ae",
+ "combiner",
+ "other",
+ "unknown"
+ ],
+ "meta:enum": {
+ "drbg": "Deterministic Random Bit Generator (DRBG) is a type of pseudorandom number generator designed to produce a sequence of bits from an initial seed value. DRBGs are commonly used in cryptographic applications where reproducibility of random values is important.",
+ "mac": "In cryptography, a Message Authentication Code (MAC) is information used for authenticating and integrity-checking a message.",
+ "block-cipher": "A block cipher is a symmetric key algorithm that operates on fixed-size blocks of data. It encrypts or decrypts the data in block units, providing confidentiality. Block ciphers are widely used in various cryptographic modes and protocols for secure data transmission.",
+ "stream-cipher": "A stream cipher is a symmetric key cipher where plaintext digits are combined with a pseudorandom cipher digit stream (keystream).",
+ "signature": "In cryptography, a signature is a digital representation of a message or data that proves its origin, identity, and integrity. Digital signatures are generated using cryptographic algorithms and are widely used for authentication and verification in secure communication.",
+ "hash": "A hash function is a mathematical algorithm that takes an input (or 'message') and produces a fixed-size string of characters, which is typically a hash value. Hash functions are commonly used in various cryptographic applications, including data integrity verification and password hashing.",
+ "pke": "Public Key Encryption (PKE) is a type of encryption that uses a pair of public and private keys for secure communication. The public key is used for encryption, while the private key is used for decryption. PKE is a fundamental component of public-key cryptography.",
+ "xof": "An XOF is an extendable output function that can take arbitrary input and creates a stream of output, up to a limit determined by the size of the internal state of the hash function that underlies the XOF.",
+ "kdf": "A Key Derivation Function (KDF) derives key material from another source of entropy while preserving the entropy of the input.",
+ "key-agree": "In cryptography, a key-agreement is a protocol whereby two or more parties agree on a cryptographic key in such a way that both influence the outcome.",
+ "kem": "A Key Encapsulation Mechanism (KEM) algorithm is a mechanism for transporting random keying material to a recipient using the recipient's public key.",
+ "ae": "Authenticated Encryption (AE) is a cryptographic process that provides both confidentiality and data integrity. It ensures that the encrypted data has not been tampered with and comes from a legitimate source. AE is commonly used in secure communication protocols.",
+ "combiner": "A combiner aggregates many candidates for a cryptographic primitive and generates a new candidate for the same primitive.",
+ "other": "Another primitive type.",
+ "unknown": "The primitive is not known."
+ }
+ },
+ "parameterSetIdentifier": {
+ "type": "string",
+ "title": "Parameter Set Identifier",
+ "description": "An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205)."
+ },
+ "curve": {
+ "type": "string",
+ "title": "Elliptic Curve",
+ "description": "The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends using curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source of which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves)."
+ },
+ "executionEnvironment": {
+ "type": "string",
+ "title": "Execution Environment",
+ "description": "The target and execution environment in which the algorithm is implemented in.",
+ "enum": [
+ "software-plain-ram",
+ "software-encrypted-ram",
+ "software-tee",
+ "hardware",
+ "other",
+ "unknown"
+ ],
+ "meta:enum": {
+ "software-plain-ram": "A software implementation running in plain unencrypted RAM.",
+ "software-encrypted-ram": "A software implementation running in encrypted RAM.",
+ "software-tee": "A software implementation running in a trusted execution environment.",
+ "hardware": "A hardware implementation.",
+ "other": "Another implementation environment.",
+ "unknown": "The execution environment is not known."
+ }
+ },
+ "implementationPlatform": {
+ "type": "string",
+ "title": "Implementation platform",
+ "description": "The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.",
+ "enum": [
+ "generic",
+ "x86_32",
+ "x86_64",
+ "armv7-a",
+ "armv7-m",
+ "armv8-a",
+ "armv8-m",
+ "armv9-a",
+ "armv9-m",
+ "s390x",
+ "ppc64",
+ "ppc64le",
+ "other",
+ "unknown"
+ ]
+ },
+ "certificationLevel": {
+ "type": "array",
+ "title": "Certification Level",
+ "description": "The certification that the implementation of the cryptographic algorithm has received, if any. Certifications include revisions and levels of FIPS 140 or Common Criteria of different Extended Assurance Levels (CC-EAL).",
+ "items": {
+ "type": "string",
+ "enum": [
+ "none",
+ "fips140-1-l1",
+ "fips140-1-l2",
+ "fips140-1-l3",
+ "fips140-1-l4",
+ "fips140-2-l1",
+ "fips140-2-l2",
+ "fips140-2-l3",
+ "fips140-2-l4",
+ "fips140-3-l1",
+ "fips140-3-l2",
+ "fips140-3-l3",
+ "fips140-3-l4",
+ "cc-eal1",
+ "cc-eal1+",
+ "cc-eal2",
+ "cc-eal2+",
+ "cc-eal3",
+ "cc-eal3+",
+ "cc-eal4",
+ "cc-eal4+",
+ "cc-eal5",
+ "cc-eal5+",
+ "cc-eal6",
+ "cc-eal6+",
+ "cc-eal7",
+ "cc-eal7+",
+ "other",
+ "unknown"
+ ],
+ "meta:enum": {
+ "none": "No certification obtained",
+ "fips140-1-l1": "FIPS 140-1 Level 1",
+ "fips140-1-l2": "FIPS 140-1 Level 2",
+ "fips140-1-l3": "FIPS 140-1 Level 3",
+ "fips140-1-l4": "FIPS 140-1 Level 4",
+ "fips140-2-l1": "FIPS 140-2 Level 1",
+ "fips140-2-l2": "FIPS 140-2 Level 2",
+ "fips140-2-l3": "FIPS 140-2 Level 3",
+ "fips140-2-l4": "FIPS 140-2 Level 4",
+ "fips140-3-l1": "FIPS 140-3 Level 1",
+ "fips140-3-l2": "FIPS 140-3 Level 2",
+ "fips140-3-l3": "FIPS 140-3 Level 3",
+ "fips140-3-l4": "FIPS 140-3 Level 4",
+ "cc-eal1": "Common Criteria - Evaluation Assurance Level 1",
+ "cc-eal1+": "Common Criteria - Evaluation Assurance Level 1 (Augmented)",
+ "cc-eal2": "Common Criteria - Evaluation Assurance Level 2",
+ "cc-eal2+": "Common Criteria - Evaluation Assurance Level 2 (Augmented)",
+ "cc-eal3": "Common Criteria - Evaluation Assurance Level 3",
+ "cc-eal3+": "Common Criteria - Evaluation Assurance Level 3 (Augmented)",
+ "cc-eal4": "Common Criteria - Evaluation Assurance Level 4",
+ "cc-eal4+": "Common Criteria - Evaluation Assurance Level 4 (Augmented)",
+ "cc-eal5": "Common Criteria - Evaluation Assurance Level 5",
+ "cc-eal5+": "Common Criteria - Evaluation Assurance Level 5 (Augmented)",
+ "cc-eal6": "Common Criteria - Evaluation Assurance Level 6",
+ "cc-eal6+": "Common Criteria - Evaluation Assurance Level 6 (Augmented)",
+ "cc-eal7": "Common Criteria - Evaluation Assurance Level 7",
+ "cc-eal7+": "Common Criteria - Evaluation Assurance Level 7 (Augmented)",
+ "other": "Another certification",
+ "unknown": "The certification level is not known"
+ }
+ }
+ },
+ "mode": {
+ "type": "string",
+ "title": "Mode",
+ "description": "The mode of operation in which the cryptographic algorithm (block cipher) is used.",
+ "enum": [
+ "cbc",
+ "ecb",
+ "ccm",
+ "gcm",
+ "cfb",
+ "ofb",
+ "ctr",
+ "other",
+ "unknown"
+ ],
+ "meta:enum": {
+ "cbc": "Cipher block chaining",
+ "ecb": "Electronic codebook",
+ "ccm": "Counter with cipher block chaining message authentication code",
+ "gcm": "Galois/counter",
+ "cfb": "Cipher feedback",
+ "ofb": "Output feedback",
+ "ctr": "Counter",
+ "other": "Another mode of operation",
+ "unknown": "The mode of operation is not known"
+ }
+ },
+ "padding": {
+ "type": "string",
+ "title": "Padding",
+ "description": "The padding scheme that is used for the cryptographic algorithm.",
+ "enum": [
+ "pkcs5",
+ "pkcs7",
+ "pkcs1v15",
+ "oaep",
+ "raw",
+ "other",
+ "unknown"
+ ],
+ "meta:enum": {
+ "pkcs5": "Public Key Cryptography Standard: Password-Based Cryptography",
+ "pkcs7": "Public Key Cryptography Standard: Cryptographic Message Syntax",
+ "pkcs1v15": "Public Key Cryptography Standard: RSA Cryptography v1.5",
+ "oaep": "Optimal asymmetric encryption padding",
+ "raw": "Raw",
+ "other": "Another padding scheme",
+ "unknown": "The padding scheme is not known"
+ }
+ },
+ "cryptoFunctions": {
+ "type": "array",
+ "title": "Cryptographic functions",
+ "description": "The cryptographic functions implemented by the cryptographic algorithm.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "generate",
+ "keygen",
+ "encrypt",
+ "decrypt",
+ "digest",
+ "tag",
+ "keyderive",
+ "sign",
+ "verify",
+ "encapsulate",
+ "decapsulate",
+ "other",
+ "unknown"
+ ]
+ }
+ },
+ "classicalSecurityLevel": {
+ "type": "integer",
+ "title": "classical security level",
+ "description": "The classical security level that a cryptographic algorithm provides (in bits).",
+ "minimum": 0
+ },
+ "nistQuantumSecurityLevel": {
+ "type": "integer",
+ "title": "NIST security strength category",
+ "description": "The NIST security strength category as defined in https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria). A value of 0 indicates that none of the categories are met.",
+ "minimum": 0,
+ "maximum": 6
+ }
+ }
+ },
+ "certificateProperties": {
+ "type": "object",
+ "title": "Certificate Properties",
+ "description": "Properties for cryptographic assets of asset type 'certificate'",
+ "additionalProperties": false,
+ "properties": {
+ "subjectName": {
+ "type": "string",
+ "title": "Subject Name",
+ "description": "The subject name for the certificate"
+ },
+ "issuerName": {
+ "type": "string",
+ "title": "Issuer Name",
+ "description": "The issuer name for the certificate"
+ },
+ "notValidBefore": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Not Valid Before",
+ "description": "The date and time according to ISO-8601 standard from which the certificate is valid"
+ },
+ "notValidAfter": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Not Valid After",
+ "description": "The date and time according to ISO-8601 standard from which the certificate is not valid anymore"
+ },
+ "signatureAlgorithmRef": {
+ "$ref": "#/definitions/refType",
+ "title": "Algorithm Reference",
+ "description": "The bom-ref to signature algorithm used by the certificate"
+ },
+ "subjectPublicKeyRef": {
+ "$ref": "#/definitions/refType",
+ "title": "Key reference",
+ "description": "The bom-ref to the public key of the subject"
+ },
+ "certificateFormat": {
+ "type": "string",
+ "title": "Certificate Format",
+ "description": "The format of the certificate",
+ "examples": [
+ "X.509",
+ "PEM",
+ "DER",
+ "CVC"
+ ]
+ },
+ "certificateExtension": {
+ "type": "string",
+ "title": "Certificate File Extension",
+ "description": "The file extension of the certificate",
+ "examples": [
+ "crt",
+ "pem",
+ "cer",
+ "der",
+ "p12"
+ ]
+ }
+ }
+ },
+ "relatedCryptoMaterialProperties": {
+ "type": "object",
+ "title": "Related Cryptographic Material Properties",
+ "description": "Properties for cryptographic assets of asset type: `related-crypto-material`",
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "title": "relatedCryptoMaterialType",
+ "description": "The type for the related cryptographic material",
+ "enum": [
+ "private-key",
+ "public-key",
+ "secret-key",
+ "key",
+ "ciphertext",
+ "signature",
+ "digest",
+ "initialization-vector",
+ "nonce",
+ "seed",
+ "salt",
+ "shared-secret",
+ "tag",
+ "additional-data",
+ "password",
+ "credential",
+ "token",
+ "other",
+ "unknown"
+ ],
+ "meta:enum": {
+ "private-key": "The confidential key of a key pair used in asymmetric cryptography.",
+ "public-key": "The non-confidential key of a key pair used in asymmetric cryptography.",
+ "secret-key": "A key used to encrypt and decrypt messages in symmetric cryptography.",
+ "key": "A piece of information, usually an octet string, which, when processed through a cryptographic algorithm, processes cryptographic data.",
+ "ciphertext": "The result of encryption performed on plaintext using an algorithm (or cipher).",
+ "signature": "A cryptographic value that is calculated from the data and a key known only by the signer.",
+ "digest": "The output of the hash function.",
+ "initialization-vector": "A fixed-size random or pseudo-random value used as an input parameter for cryptographic algorithms.",
+ "nonce": "A random or pseudo-random number that can only be used once in a cryptographic communication.",
+ "seed": "The input to a pseudo-random number generator. Different seeds generate different pseudo-random sequences.",
+ "salt": "A value used in a cryptographic process, usually to ensure that the results of computations for one instance cannot be reused by an attacker.",
+ "shared-secret": "A piece of data known only to the parties involved, in a secure communication.",
+ "tag": "A message authentication code (MAC), sometimes known as an authentication tag, is a short piece of information used for authenticating and integrity-checking a message.",
+ "additional-data": "An unspecified collection of data with relevance to cryptographic activity.",
+ "password": "A secret word, phrase, or sequence of characters used during authentication or authorization.",
+ "credential": "Establishes the identity of a party to communication, usually in the form of cryptographic keys or passwords.",
+ "token": "An object encapsulating a security identity.",
+ "other": "Another type of cryptographic asset.",
+ "unknown": "The type of cryptographic asset is not known."
+ }
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The optional unique identifier for the related cryptographic material."
+ },
+ "state": {
+ "type": "string",
+ "title": "State",
+ "description": "The key state as defined by NIST SP 800-57.",
+ "enum": [
+ "pre-activation",
+ "active",
+ "suspended",
+ "deactivated",
+ "compromised",
+ "destroyed"
+ ]
+ },
+ "algorithmRef": {
+ "$ref": "#/definitions/refType",
+ "title": "Algorithm Reference",
+ "description": "The bom-ref to the algorithm used to generate the related cryptographic material."
+ },
+ "creationDate": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Creation Date",
+ "description": "The date and time (timestamp) when the related cryptographic material was created."
+ },
+ "activationDate": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Activation Date",
+ "description": "The date and time (timestamp) when the related cryptographic material was activated."
+ },
+ "updateDate": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Update Date",
+ "description": "The date and time (timestamp) when the related cryptographic material was updated."
+ },
+ "expirationDate": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Expiration Date",
+ "description": "The date and time (timestamp) when the related cryptographic material expires."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The associated value of the cryptographic material."
+ },
+ "size": {
+ "type": "integer",
+ "title": "Size",
+ "description": "The size of the cryptographic asset (in bits)."
+ },
+ "format": {
+ "type": "string",
+ "title": "Format",
+ "description": "The format of the related cryptographic material (e.g. P8, PEM, DER)."
+ },
+ "securedBy": {
+ "$ref": "#/definitions/securedBy",
+ "title": "Secured By",
+ "description": "The mechanism by which the cryptographic asset is secured by."
+ }
+ }
+ },
+ "protocolProperties": {
+ "type": "object",
+ "title": "Protocol Properties",
+ "description": "Properties specific to cryptographic assets of type: `protocol`.",
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "The concrete protocol type.",
+ "enum": [
+ "tls",
+ "ssh",
+ "ipsec",
+ "ike",
+ "sstp",
+ "wpa",
+ "other",
+ "unknown"
+ ],
+ "meta:enum": {
+ "tls": "Transport Layer Security",
+ "ssh": "Secure Shell",
+ "ipsec": "Internet Protocol Security",
+ "ike": "Internet Key Exchange",
+ "sstp": "Secure Socket Tunneling Protocol",
+ "wpa": "Wi-Fi Protected Access",
+ "other": "Another protocol type",
+ "unknown": "The protocol type is not known"
+ }
+ },
+ "version": {
+ "type": "string",
+ "title": "Protocol Version",
+ "description": "The version of the protocol.",
+ "examples": [
+ "1.0",
+ "1.2",
+ "1.99"
+ ]
+ },
+ "cipherSuites": {
+ "type": "array",
+ "title": "Cipher Suites",
+ "description": "A list of cipher suites related to the protocol.",
+ "items": {
+ "$ref": "#/definitions/cipherSuite",
+ "title": "Cipher Suite"
+ }
+ },
+ "ikev2TransformTypes": {
+ "type": "object",
+ "title": "IKEv2 Transform Types",
+ "description": "The IKEv2 transform types supported (types 1-4), defined in [RFC 7296 section 3.3.2](https://www.ietf.org/rfc/rfc7296.html#section-3.3.2), and additional properties.",
+ "additionalProperties": false,
+ "properties": {
+ "encr": {
+ "$ref": "#/definitions/cryptoRefArray",
+ "title": "Encryption Algorithm (ENCR)",
+ "description": "Transform Type 1: encryption algorithms"
+ },
+ "prf": {
+ "$ref": "#/definitions/cryptoRefArray",
+ "title": "Pseudorandom Function (PRF)",
+ "description": "Transform Type 2: pseudorandom functions"
+ },
+ "integ": {
+ "$ref": "#/definitions/cryptoRefArray",
+ "title": "Integrity Algorithm (INTEG)",
+ "description": "Transform Type 3: integrity algorithms"
+ },
+ "ke": {
+ "$ref": "#/definitions/cryptoRefArray",
+ "title": "Key Exchange Method (KE)",
+ "description": "Transform Type 4: Key Exchange Method (KE) per [RFC 9370](https://www.ietf.org/rfc/rfc9370.html), formerly called Diffie-Hellman Group (D-H)."
+ },
+ "esn": {
+ "type": "boolean",
+ "title": "Extended Sequence Numbers (ESN)",
+ "description": "Specifies if an Extended Sequence Number (ESN) is used."
+ },
+ "auth": {
+ "$ref": "#/definitions/cryptoRefArray",
+ "title": "IKEv2 Authentication method",
+ "description": "IKEv2 Authentication method"
+ }
+ }
+ },
+ "cryptoRefArray": {
+ "$ref": "#/definitions/cryptoRefArray",
+ "title": "Cryptographic References",
+ "description": "A list of protocol-related cryptographic assets"
+ }
+ }
+ },
+ "oid": {
+ "type": "string",
+ "title": "OID",
+ "description": "The object identifier (OID) of the cryptographic asset."
+ }
+ }
+ },
+ "cipherSuite": {
+ "type": "object",
+ "title": "Cipher Suite",
+ "description": "Object representing a cipher suite",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Common Name",
+ "description": "A common name for the cipher suite.",
+ "examples": [
+ "TLS_DHE_RSA_WITH_AES_128_CCM"
+ ]
+ },
+ "algorithms": {
+ "type": "array",
+ "title": "Related Algorithms",
+ "description": "A list of algorithms related to the cipher suite.",
+ "items": {
+ "$ref": "#/definitions/refType",
+ "title": "Algorithm reference",
+ "description": "The bom-ref to algorithm cryptographic asset."
+ }
+ },
+ "identifiers": {
+ "type": "array",
+ "title": "Cipher Suite Identifiers",
+ "description": "A list of common identifiers for the cipher suite.",
+ "items": {
+ "type": "string",
+ "title": "identifier",
+ "description": "Cipher suite identifier",
+ "examples": [
+ "0xC0",
+ "0x9E"
+ ]
+ }
+ }
+ }
+ },
+ "cryptoRefArray" : {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/refType"
+ }
+ },
+ "securedBy": {
+ "type": "object",
+ "title": "Secured By",
+ "description": "Specifies the mechanism by which the cryptographic asset is secured by",
+ "additionalProperties": false,
+ "properties": {
+ "mechanism": {
+ "type": "string",
+ "title": "Mechanism",
+ "description": "Specifies the mechanism by which the cryptographic asset is secured by.",
+ "examples": [
+ "HSM",
+ "TPM",
+ "SGX",
+ "Software",
+ "None"
+ ]
+ },
+ "algorithmRef": {
+ "$ref": "#/definitions/refType",
+ "title": "Algorithm Reference",
+ "description": "The bom-ref to the algorithm."
+ }
+ }
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Tags",
+ "description": "Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.",
+ "examples": [
+ "json-parser",
+ "object-persistence",
+ "text-to-image",
+ "translation",
+ "object-detection"
+ ]
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.6.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.6.SNAPSHOT.xsd
new file mode 100644
index 00000000..d6d57e31
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/bom-1.6.SNAPSHOT.xsd
@@ -0,0 +1,8432 @@
+
+
+
+
+
+
+
+
+ CycloneDX Bill of Materials Standard
+ https://cyclonedx.org/
+ Apache License, Version 2.0
+
+
+
+
+
+ Identifier for referable and therefore interlink-able elements.
+
+
+
+
+
+
+
+
+
+ Descriptor for an element identified by the attribute "bom-ref" in the same BOM document.
+ In contrast to `bomLinkElementType`.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ =2.0.0|<5.0.0"
+ - "vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1"
+ - "vers:tomee/>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1|<=8.0.1"
+ - "vers:gem/>=2.2.0|!= 2.2.1|<2.3.0"
+ ]]>
+
+
+
+
+
+
+
+
+
+
+
+ Descriptor for another BOM document.
+ See https://cyclonedx.org/capabilities/bomlink/
+
+
+
+
+
+
+
+
+
+
+ Descriptor for an element in another BOM document.
+ See https://cyclonedx.org/capabilities/bomlink/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the BOM was created.
+
+
+
+
+
+ Lifecycles communicate the stage(s) in which data in the BOM was captured. Different types of data may be available at various phases of a lifecycle, such as the Software Development Lifecycle (SDLC), IT Asset Management (ITAM), and Software Asset Management (SAM). Thus, a BOM may include data specific to or only obtainable in a given lifecycle.
+
+
+
+
+
+
+
+
+
+
+
+ A pre-defined phase in the product lifecycle.
+
+
+
+
+
+
+
+
+ The name of the lifecycle phase
+
+
+
+
+
+
+ The description of the lifecycle phase
+
+
+
+
+
+
+
+
+
+
+
+
+ The tool(s) used in the creation of the BOM.
+
+
+
+
+
+
+ DEPRECATED. Use tools\components or tools\services instead.
+
+
+
+
+
+
+ A list of software and hardware components used as tools.
+
+
+
+
+ A list of services used as tools.
+
+
+
+
+
+
+
+
+
+ The person(s) who created the BOM.
+ Authors are common in BOMs created through manual processes. BOMs created through automated means may have './manufacturer' instead.
+
+
+
+
+
+
+
+
+
+
+ The component that the BOM describes.
+
+
+
+
+
+ The organization that created the BOM.
+ Manufacturer is common in BOMs created through automated processes. BOMs created through manual means may have './authors' instead.
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use the `./component/manufacturer` instead.
+ The organization that manufactured the component that the BOM describes.
+
+
+
+
+
+ The organization that supplied the component that the BOM describes. The
+ supplier may often be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+
+ The license information for the BOM document.
+ This may be different from the license(s) of the component(s) that the BOM describes.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ BOM produced early in the development lifecycle containing inventory of components and services
+ that are proposed or planned to be used. The inventory may need to be procured, retrieved,
+ or resourced prior to use.
+
+
+
+
+
+
+ BOM consisting of information obtained prior to a build process and may contain source files
+ and development artifacts and manifests. The inventory may need to be resolved and retrieved
+ prior to use.
+
+
+
+
+
+
+ BOM consisting of information obtained during a build process where component inventory is
+ available for use. The precise versions of resolved components are usually available at this
+ time as well as the provenance of where the components were retrieved from.
+
+
+
+
+
+
+ BOM consisting of information obtained after a build process has completed and the resulting
+ components(s) are available for further analysis. Built components may exist as the result of a
+ CI/CD process, may have been installed or deployed to a system or device, and may need to be
+ retrieved or extracted from the system or device.
+
+
+
+
+
+
+ BOM produced that represents inventory that is running and operational. This may include staging
+ or production environments and will generally encompass multiple SBOMs describing the applications
+ and operating system, along with HBOMs describing the hardware that makes up the system. Operations
+ Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations,
+ and additional dependencies.
+
+
+
+
+
+
+ BOM consisting of information observed through network discovery providing point-in-time
+ enumeration of embedded, on-premise, and cloud-native services such as server applications,
+ connected devices, microservices, and serverless functions.
+
+
+
+
+
+
+ BOM containing inventory that will be, or has been retired from operations.
+
+
+
+
+
+
+
+
+
+
+ The name of the organization
+
+
+
+
+ The physical address (location) of the organization.
+
+
+
+
+
+ The URL of the organization. Multiple URLs are allowed.
+ Example: https://example.com
+
+
+
+
+
+ A contact person at the organization. Multiple contacts are allowed.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Information about the automated or manual tool used
+
+
+
+
+ The name of the vendor who created the tool
+
+
+
+
+ The name of the tool
+
+
+
+
+ The version of the tool
+
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the tool.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The name of the contact
+
+
+
+
+ The email address of the contact.
+
+
+
+
+ The phone number of the contact.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that supplied the component. The supplier may often
+ be the manufacturer, but may also be a distributor or repackager.
+
+
+
+
+
+ The organization that created the component.
+ Manufacturer is common in components created through automated processes. Components created through manual means may have './authors' instead.
+
+
+
+
+
+
+ The person(s) who created the component.
+ Authors are common in components created through manual processes. Components created through automated means may have `./manufacturer` instead.
+
+
+
+
+
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use `./authors` or `./manufacturer` instead.
+ The person(s) or organization(s) that authored the component.
+
+
+
+
+
+ The person(s) or organization(s) that published the component
+
+
+
+
+ The grouping name or identifier. This will often be a shortened, single
+ name of the company or project that produced the component, or the source package or
+ domain name. Whitespace and special characters should be avoided. Examples include:
+ apache, org.apache.commons, and apache.org.
+
+
+
+
+ The name of the component. This will often be a shortened, single name
+ of the component. Examples: commons-lang3 and jquery
+
+
+
+
+ The component version. The version should ideally comply with semantic versioning
+ but is not enforced.
+
+
+
+
+ Specifies a description for the component
+
+
+
+
+ Specifies the scope of the component. If scope is not specified, 'required'
+ scope SHOULD be assumed by the consumer of the BOM.
+
+
+
+
+ The hashes of the component.
+
+
+
+
+
+
+
+
+
+
+ A copyright notice informing users of the underlying claims to copyright ownership in a published work.
+
+
+
+
+
+ Specifies a well-formed CPE name that conforms to the CPE 2.2 or 2.3 specification. See https://nvd.nist.gov/products/cpe
+
+
+
+
+
+
+ Specifies the package-url (purl). The purl, if specified, must be valid and conform
+ to the specification defined at: https://github.com/package-url/purl-spec
+
+
+
+
+
+
+ Specifies the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform
+ to the specification defined at: https://www.iana.org/assignments/uri-schemes/prov/gitoid
+
+
+
+
+
+
+ Specifies the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must
+ be valid and conform to the specification defined at:
+ https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html
+
+
+
+
+
+
+ Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.
+
+
+
+
+
+
+ DEPRECATED - DO NOT USE. This will be removed in a future version. Use the pedigree
+ element instead to supply information on exactly how the component was modified.
+ A boolean value indicating if the component has been modified from the original.
+ A value of true indicates the component is a derivative of the original.
+ A value of false indicates the component has not been modified from the original.
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are
+ created, distributed, modified, redistributed, combined with other components, etc.
+
+
+
+
+
+ Provides the ability to document external references related to the
+ component or to the project the component describes.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ A list of software and hardware components included in the parent component. This is not a
+ dependency tree. It provides a way to specify a hierarchical representation of component
+ assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Provides the ability to document evidence collected through various forms of extraction or analysis.
+
+
+
+
+ Specifies optional release notes.
+
+
+
+
+ A model card describes the intended uses of a machine learning model and potential
+ limitations, including biases and ethical considerations. Model cards typically contain the
+ training parameters, which datasets were used to train the model, performance metrics, and other
+ relevant data useful for ML transparency. This object SHOULD be specified for any component of
+ type `machine-learning-model` and must not be specified for other component types.
+
+
+
+
+ This object SHOULD be specified for any component of type `data` and must not be
+ specified for other component types.
+
+
+
+
+
+ Cryptographic assets have properties that uniquely define them and that make them actionable
+ for further reasoning. As an example, it makes a difference if one knows the algorithm family
+ (e.g. AES) or the specific variant or instantiation (e.g. AES-128-GCM). This is because the
+ security level and the algorithm primitive (authenticated encryption) is only defined by the
+ definition of the algorithm variant. The presence of a weak cryptographic algorithm like SHA1
+ vs. HMAC-SHA1 also makes a difference.
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ Specifies the type of component. For software components, classify as application if no more
+ specific appropriate classification is available or cannot be determined for the component.
+
+
+
+
+
+
+ The optional mime-type of the component. When used on file components, the mime-type
+ can provide additional context about the kind of file being represented such as an image,
+ font, or executable. Some library or framework components may also have an associated mime-type.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the component elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies the details and attributes related to a software license.
+ It can either include a valid SPDX license identifier or a named license, along with additional
+ properties such as license acknowledgment, comprehensive commercial licensing information, and
+ the full text of the license.
+
+
+
+
+
+ A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.
+
+
+
+
+ The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.
+
+
+
+
+
+ Specifies the optional full text of the attachment
+
+
+
+
+ The URL to the attachment file. If the attachment is a license or BOM,
+ an externalReference should also be specified for completeness.
+
+
+
+
+ Licensing details describing the licensor/licensee, license type, renewal and
+ expiration dates, and other important metadata
+
+
+
+
+
+ License identifiers that may be used to manage licenses and
+ their lifecycle
+
+
+
+
+
+
+
+
+
+ The individual or organization that grants a license to another
+ individual or organization
+
+
+
+
+
+
+ The organization that granted the license
+
+
+
+
+ The individual, not associated with an organization,
+ that granted the license
+
+
+
+
+
+
+
+
+ The individual or organization for which a license was granted to
+
+
+
+
+
+
+ The organization that was granted the license
+
+
+
+
+ The individual, not associated with an organization,
+ that was granted the license
+
+
+
+
+
+
+
+
+ The individual or organization that purchased the license
+
+
+
+
+
+
+ The organization that purchased the license
+
+
+
+
+ The individual, not associated with an organization,
+ that purchased the license
+
+
+
+
+
+
+
+
+ The purchase order identifier the purchaser sent to a supplier or
+ vendor to authorize a purchase
+
+
+
+
+ The type of license(s) that was granted to the licensee
+
+
+
+
+
+
+
+
+
+ The timestamp indicating when the license was last
+ renewed. For new purchases, this is often the purchase or acquisition date.
+ For non-perpetual licenses or subscriptions, this is the timestamp of when the
+ license was last renewed.
+
+
+
+
+ The timestamp indicating when the current license
+ expires (if applicable).
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the license elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+ Declared licenses and concluded licenses represent two different stages in the
+ licensing process within software development. Declared licenses refer to the
+ initial intention of the software authors regarding the licensing terms under
+ which their code is released. On the other hand, concluded licenses are the
+ result of a comprehensive analysis of the project's codebase to identify and
+ confirm the actual licenses of the components used, which may differ from the
+ initially declared licenses. While declared licenses provide an upfront indication
+ of the licensing intentions, concluded licenses offer a more thorough understanding
+ of the actual licensing within a project, facilitating proper compliance and risk
+ management. Observed licenses are defined in `evidence.licenses`. Observed licenses
+ form the evidence necessary to substantiate a concluded license.
+
+
+
+
+
+
+
+
+
+ The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.
+
+
+
+
+ Specifies the format and nature of the data being attached, helping systems correctly
+ interpret and process the content. Common content type examples include `application/json`
+ for JSON data and `text/plain` for plan text documents.
+ RFC 2045 section 5.1 outlines the structure and use of content types. For a comprehensive
+ list of registered content types, refer to the IANA media types registry at
+ https://www.iana.org/assignments/media-types/media-types.xhtml.
+
+
+
+
+
+
+ Specifies the optional encoding the text is represented in
+
+
+
+
+
+
+
+
+
+ Specifies the file hash of the component
+
+
+
+
+
+ Specifies the algorithm used to create the hash
+
+
+
+
+
+
+
+
+
+
+ The component is required for runtime
+
+
+
+
+ The component is optional at runtime. Optional components are components that
+ are not capable of being called due to them not be installed or otherwise accessible by any means.
+ Components that are installed but due to configuration or other restrictions are prohibited from
+ being called must be scoped as 'required'.
+
+
+
+
+ Components that are excluded provide the ability to document component usage
+ for test and other non-runtime purposes. Excluded components are not reachable within a call
+ graph at runtime.
+
+
+
+
+
+
+
+
+
+ A software application. Refer to https://en.wikipedia.org/wiki/Application_software
+ for information about applications.
+
+
+
+
+ A software framework. Refer to https://en.wikipedia.org/wiki/Software_framework
+ for information on how frameworks vary slightly from libraries.
+
+
+
+
+ A software library. Refer to https://en.wikipedia.org/wiki/Library_(computing)
+ for information about libraries. All third-party and open source reusable components will likely
+ be a library. If the library also has key features of a framework, then it should be classified
+ as a framework. If not, or is unknown, then specifying library is recommended.
+
+
+
+
+ A packaging and/or runtime format, not specific to any particular technology,
+ which isolates software inside the container from software outside of a container through
+ virtualization technology. Refer to https://en.wikipedia.org/wiki/OS-level_virtualization
+
+
+
+
+ A runtime environment which interprets or executes software. This may include
+ runtimes such as those that execute bytecode or low-code/no-code application platforms.
+
+
+
+
+ A software operating system without regard to deployment model
+ (i.e. installed on physical hardware, virtual machine, image, etc) Refer to
+ https://en.wikipedia.org/wiki/Operating_system
+
+
+
+
+ A hardware device such as a processor, or chip-set. A hardware device
+ containing firmware SHOULD include a component for the physical hardware itself, and another
+ component of type 'firmware' or 'operating-system' (whichever is relevant), describing
+ information about the software running on the device.
+ See also the list of known device properties: https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md
+
+
+
+
+
+ A special type of software that operates or controls a particular type of device.
+ Refer to https://en.wikipedia.org/wiki/Device_driver
+
+
+
+
+ A special type of software that provides low-level control over a devices
+ hardware. Refer to https://en.wikipedia.org/wiki/Firmware
+
+
+
+
+ A computer file. Refer to https://en.wikipedia.org/wiki/Computer_file
+ for information about files.
+
+
+
+
+ A model based on training data that can make predictions or decisions without
+ being explicitly programmed to do so.
+
+
+
+
+ A collection of discrete values that convey information.
+
+
+
+
+ A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A license that grants use of software solely for the purpose
+ of education or research.
+
+
+
+
+ A license covering use of software embedded in a specific
+ piece of hardware.
+
+
+
+
+ A Client Access License (CAL) allows client computers to access
+ services provided by server software.
+
+
+
+
+ A Concurrent User license (aka floating license) limits the
+ number of licenses for a software application and licenses are shared among
+ a larger number of users.
+
+
+
+
+ A license where the core of a computer's processor is assigned
+ a specific number of points.
+
+
+
+
+ A license for which consumption is measured by non-standard
+ metrics.
+
+
+
+
+ A license that covers a defined number of installations on
+ computers and other types of devices.
+
+
+
+
+ A license that grants permission to install and use software
+ for trial purposes.
+
+
+
+
+ A license that grants access to the software to one or more
+ pre-defined users.
+
+
+
+
+ A license that grants access to the software on one or more
+ pre-defined computers or devices.
+
+
+
+
+ An Original Equipment Manufacturer license that is delivered
+ with hardware, cannot be transferred to other hardware, and is valid for the
+ life of the hardware.
+
+
+
+
+ A license where the software is sold on a one-time basis and
+ the licensee can use a copy of the software indefinitely.
+
+
+
+
+ A license where each installation consumes points per
+ processor.
+
+
+
+
+ A license where the licensee pays a fee to use the software
+ or service.
+
+
+
+
+ A license that grants access to the software or service by a
+ specified number of users.
+
+
+
+
+ Another license type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Define the format for acceptable CPE URIs. Supports CPE 2.2 and CPE 2.3 formats.
+ Refer to https://nvd.nist.gov/products/cpe for official specification.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the full content of the SWID tag.
+
+
+
+
+ The URL to the SWID file.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Maps to the tagId of a SoftwareIdentity.
+
+
+
+
+ Maps to the name of a SoftwareIdentity.
+
+
+
+
+ Maps to the version of a SoftwareIdentity.
+
+
+
+
+ Maps to the tagVersion of a SoftwareIdentity.
+
+
+
+
+ Maps to the patch of a SoftwareIdentity.
+
+
+
+
+
+
+
+ Defines a string representation of a UUID conforming to RFC 4122.
+
+
+
+
+
+
+
+
+
+
+
+ Version Control System
+
+
+
+
+ Issue or defect tracking system, or an Application Lifecycle Management (ALM) system
+
+
+
+
+ Website
+
+
+
+
+ Security advisories
+
+
+
+
+ Bill-of-materials (SBOM, OBOM, HBOM, SaaSBOM, etc)
+
+
+
+
+ Mailing list or discussion group
+
+
+
+
+ Social media account
+
+
+
+
+ Real-time chat platform
+
+
+
+
+ Documentation, guides, or how-to instructions
+
+
+
+
+ Community or commercial support
+
+
+
+
+ The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type.
+
+
+
+
+ Direct or repository download location
+
+
+
+
+ The location where a component was published to. This is often the same as "distribution" but may also include specialized publishing processes that act as an intermediary
+
+
+
+
+
+ The URL to the license file. If a license URL has been defined in the license
+ node, it should also be defined as an external reference for completeness.
+ Example: https://www.apache.org/licenses/LICENSE-2.0.txt
+
+
+
+
+
+ Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)
+
+
+
+
+ URL to an automated build system
+
+
+
+
+ URL to release notes
+
+
+
+
+ Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT.
+
+
+
+
+ A model card describes the intended uses of a machine learning model, potential
+ limitations, biases, ethical considerations, training parameters, datasets used to train the
+ model, performance metrics, and other relevant data useful for ML transparency.
+
+
+
+
+ A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations.
+
+
+
+
+ Parameters or settings that may be used by other components or services.
+
+
+
+
+ Information used to substantiate a claim.
+
+
+
+
+ Describes how a component or service was manufactured or deployed.
+
+
+
+
+ Human or machine-readable statements containing facts, evidence, or testimony
+
+
+
+
+ An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format
+
+
+
+
+ The defined assumptions, goals, and capabilities of an adversary.
+
+
+
+
+ Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.
+
+
+
+
+ A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.
+
+
+
+
+ A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.
+
+
+
+
+ Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test
+
+
+
+
+ SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code
+
+
+
+
+ Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations
+
+
+
+
+ Report generated by analyzing the call stack of a running application
+
+
+
+
+ Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis
+
+
+
+
+ Report containing a formal assessment of an organization, business unit, or team against a maturity model
+
+
+
+
+ Industry, regulatory, or other certification from an accredited (if applicable) certification body
+
+
+
+
+ Report or system in which quality metrics can be obtained
+
+
+
+
+ Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC)
+
+
+
+
+ Plans of Action and Milestones (POA&M) complement an "attestation" external reference. POA&M is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".
+
+
+
+
+ An e-signature is commonly a scanned representation of a written signature or a stylized script of the persons name.
+
+
+
+
+ A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.
+
+
+
+
+ Document that complies with RFC-9116 (A File Format to Aid in Security Vulnerability Disclosure)
+
+
+
+
+ Use this if no other types accurately describe the purpose of the external reference
+
+
+
+
+
+
+
+
+ External references provide a way to document systems, sites, and information that may be
+ relevant, but are not included with the BOM. They may also establish specific relationships
+ within or external to the BOM.
+
+
+
+
+
+ Zero or more external references can be defined
+
+
+
+
+
+
+
+
+
+ The URI (URL or URN) to the external reference. External references
+ are URIs and therefore can accept any URL scheme including https, mailto, tel, and dns.
+ External references may also include formally registered URNs such as CycloneDX BOM-Link to
+ reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external
+ references into relationships that can be expressed in a BOM or across BOMs. Refer to:
+ https://cyclonedx.org/capabilities/bomlink/
+
+
+
+
+
+
+
+ An optional comment describing the external reference
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the type of external reference. There are built-in types to describe common
+ references. If a type does not exist for the reference being referred to, use the "other" type.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Zero or more commits can be specified.
+
+
+
+
+ Specifies an individual commit.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of the commit. This may be version control
+ specific. For example, Subversion uses revision numbers whereas git uses commit hashes.
+
+
+
+
+
+ The URL to the commit. This URL will typically point to a commit
+ in a version control system.
+
+
+
+
+
+ The author who created the changes in the commit
+
+
+
+
+ The person who committed or pushed the commit
+
+
+
+
+ The text description of the contents of the commit
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Zero or more patches can be specified.
+
+
+
+
+ Specifies an individual patch.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The patch file (or diff) that show changes.
+ Refer to https://en.wikipedia.org/wiki/Diff
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the purpose for the patch including the resolution of defects,
+ security issues, or new behavior or functionality
+
+
+
+
+
+
+
+
+ A patch which is not developed by the creators or maintainers of the software
+ being patched. Refer to https://en.wikipedia.org/wiki/Unofficial_patch
+
+
+
+
+ A patch which dynamically modifies runtime behavior.
+ Refer to https://en.wikipedia.org/wiki/Monkey_patch
+
+
+
+
+ A patch which takes code from a newer version of software and applies
+ it to older versions of the same software. Refer to https://en.wikipedia.org/wiki/Backporting
+
+
+
+
+ A patch created by selectively applying commits from other versions or
+ branches of the same software.
+
+
+
+
+
+
+
+
+
+ A fault, flaw, or bug in software
+
+
+
+
+ A new feature or behavior in software
+
+
+
+
+ A special type of defect which impacts security
+
+
+
+
+
+
+
+
+
+ Specifies the optional text of the diff
+
+
+
+
+ Specifies the URL to the diff
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ An individual issue that has been resolved.
+
+
+
+
+
+ The identifier of the issue assigned by the source of the issue
+
+
+
+
+ The name of the issue
+
+
+
+
+ A description of the issue
+
+
+
+
+
+
+ The source of the issue where it is documented.
+
+
+
+
+
+
+ The name of the source. For example "National Vulnerability Database",
+ "NVD", and "Apache"
+
+
+
+
+
+
+ The url of the issue documentation as provided by the source
+
+
+
+
+
+
+
+
+
+ A collection of URL's for reference. Multiple URLs are allowed.
+ Example: "https://example.com"
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Specifies the type of issue
+
+
+
+
+
+
+
+
+ The timestamp in which the action occurred
+
+
+
+
+ The name of the individual who performed the action
+
+
+
+
+ The email address of the individual who performed the action
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Component pedigree is a way to document complex supply chain scenarios where components are created,
+ distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing
+ this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to
+ document variants where the exact relation may not be known.
+
+
+
+
+
+ Describes zero or more components in which a component is derived
+ from. This is commonly used to describe forks from existing projects where the forked version
+ contains a ancestor node containing the original component it was forked from. For example,
+ Component A is the original component. Component B is the component being used and documented
+ in the BOM. However, Component B contains a pedigree node with a single ancestor documenting
+ Component A - the original component from which Component B is derived from.
+
+
+
+
+
+ Descendants are the exact opposite of ancestors. This provides a
+ way to document all forks (and their forks) of an original or root component.
+
+
+
+
+
+ Variants describe relations where the relationship between the
+ components are not known. For example, if Component A contains nearly identical code to
+ Component B. They are both related, but it is unclear if one is derived from the other,
+ or if they share a common ancestor.
+
+
+
+
+
+ A list of zero or more commits which provide a trail describing
+ how the component deviates from an ancestor, descendant, or variant.
+
+
+
+
+ A list of zero or more patches describing how the component
+ deviates from an ancestor, descendant, or variant. Patches may be complementary to commits
+ or may be used in place of commits.
+
+
+
+
+ Notes, observations, and other non-structured commentary
+ describing the components pedigree.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ The component or service that is a dependency of this dependency object.
+
+
+
+
+
+ The component or service that define a given specification or standard, which is provided or implemented by this dependency object.
+ For example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use.
+
+
+
+
+
+ References a component or service by its bom-ref attribute
+
+
+
+
+
+
+
+ References a component or service by its bom-ref attribute
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Defines the direct dependencies of a component or service. Components or services
+ that do not have their own dependencies must be declared as empty elements within the graph.
+ Components or services that are not represented in the dependency graph may have unknown
+ dependencies. It is recommended that implementations assume this to be opaque and not an
+ indicator of a object being dependency-free. It is recommended to leverage compositions to
+ indicate unknown dependency graphs.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that provides the service.
+
+
+
+
+ The grouping name, namespace, or identifier. This will often be a shortened,
+ single name of the company or project that produced the service or domain name.
+ Whitespace and special characters should be avoided.
+
+
+
+
+ The name of the service. This will often be a shortened, single name
+ of the service.
+
+
+
+
+ The service version.
+
+
+
+
+ Specifies a description for the service.
+
+
+
+
+
+ The endpoint URIs of the service. Multiple endpoints are allowed.
+ Example: "https://example.com/api/v1/ticker"
+
+
+
+
+
+
+ A service endpoint URI.
+
+
+
+
+
+
+
+ A boolean value indicating if the service requires authentication.
+ A value of true indicates the service requires authentication prior to use.
+ A value of false indicates the service does not require authentication.
+
+
+
+
+ A boolean value indicating if use of the service crosses a trust zone or boundary.
+ A value of true indicates that by using the service, a trust boundary is crossed.
+ A value of false indicates that by using the service, a trust boundary is not crossed.
+
+
+
+
+ The name of the trust zone the service resides in.
+
+
+
+
+ Specifies information about the data including the directional flow of data and the data classification.
+
+
+
+
+
+
+ DEPRECATED: Specifies the data classification. THIS FIELD IS DEPRECATED AS OF v1.5. Use dataflow\classification instead
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ The URI, URL, or BOM-Link of the components or services the data came in from.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The URI, URL, or BOM-Link of the components or services the data is sent to.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Name for the defined data.
+
+
+
+
+
+
+ Short description of the data content and usage.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the service.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ A list of services included or deployed behind the parent service. This is not a dependency
+ tree. It provides a way to specify a hierarchical representation of service assemblies.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ Specifies optional release notes.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the service elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies the data classification.
+
+
+
+
+
+ Specifies the flow direction of the data.
+
+
+
+
+
+
+
+
+ Specifies the flow direction of the data. Valid values are:
+ inbound, outbound, bi-directional, and unknown. Direction is relative to the service.
+ Inbound flow states that data enters the service. Outbound flow states that data
+ leaves the service. Bi-directional states that data flows both ways, and unknown
+ states that the direction is not known.
+
+
+
+
+
+ Data that enters a service.
+
+
+
+
+
+ Data that exits a service.
+
+
+
+
+ Data flows in and out of the service.
+
+
+
+
+ The directional flow of data is not known.
+
+
+
+
+
+
+
+
+
+
+ A valid SPDX license expression.
+ Refer to https://spdx.org/specifications for syntax requirements
+
+ Example values:
+ - Apache-2.0 AND (MIT OR GPL-2.0-only)
+ - GPL-3.0-only WITH Classpath-exception-2.0
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the license elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+ Declared licenses and concluded licenses represent two different stages in the
+ licensing process within software development. Declared licenses refer to the
+ initial intention of the software authors regarding the licensing terms under
+ which their code is released. On the other hand, concluded licenses are the
+ result of a comprehensive analysis of the project's codebase to identify and
+ confirm the actual licenses of the components used, which may differ from the
+ initially declared licenses. While declared licenses provide an upfront indication
+ of the licensing intentions, concluded licenses offer a more thorough understanding
+ of the actual licensing within a project, facilitating proper compliance and risk
+ management. Observed licenses are defined in `evidence.licenses`. Observed licenses
+ form the evidence necessary to substantiate a concluded license.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Declared licenses represent the initial intentions of authors regarding
+ the licensing terms of their code.
+
+
+
+
+
+
+ Concluded licenses are verified and confirmed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Examines the source code without executing it.
+
+
+
+
+
+
+ Examines a compiled binary through reverse engineering, typically via disassembly or bytecode reversal.
+
+
+
+
+
+
+ Examines a package management system such as those used for building software or installing software.
+
+
+
+
+
+
+ Examines the Abstract Syntax Tree (AST) of source code or a compiled binary.
+
+
+
+
+
+
+ Evaluates the cryptographic hash of a component against a set of pre-computed hashes of identified software.
+
+
+
+
+
+
+ Examines the call stack of running applications by intercepting and monitoring application logic without the need to modify the application.
+
+
+
+
+
+
+ Evaluates a running application.
+
+
+
+
+
+
+ Evaluates file name of a component against a set of known file names of identified software.
+
+
+
+
+
+
+ A testimony to the accuracy of the identify of a component made by an individual or entity.
+
+
+
+
+
+
+ Any other technique.
+
+
+
+
+
+
+
+
+
+
+ Evidence that substantiates the identity of a component. The identify may be an
+ object or an array of identity objects. Support for specifying identity as a single object was
+ introduced in CycloneDX v1.5. "unbounded" was introduced in v1.6. It is recommended that all
+ implementations are aware of "unbounded".
+
+
+
+
+
+ The identity field of the component which the evidence describes.
+
+
+
+
+ The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.
+
+
+
+
+ The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).
+
+
+
+
+ The methods used to extract and/or analyze the evidence.
+
+
+
+
+
+
+
+
+ The technique used in this method of analysis.
+
+
+
+
+ The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.
+
+
+
+
+ The value or contents of the evidence.
+
+
+
+
+
+
+
+
+
+
+
+ The object in the BOM identified by its bom-ref. This is often a component or service,
+ but may be any object type supporting bom-refs. Tools used for analysis should already
+ be defined in the BOM, either in the metadata/tools, components, or formulation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Evidence of individual instances of a component spread across multiple locations.
+
+
+
+
+
+
+
+
+ The location or path to where the component was found.
+
+
+
+
+ The line number where the component was found.
+
+
+
+
+ The offset where the component was found.
+
+
+
+
+ The symbol name that was found associated with the component.
+
+
+
+
+ Any additional context of the detected component (e.g. a code snippet).
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the occurrence elsewhere
+ in the BOM. Every bom-ref must be unique within the BOM.
+
+
+
+
+
+
+
+
+
+
+ Evidence of the components use through the callstack.
+
+
+
+
+
+
+
+
+
+ Within a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.
+
+
+
+
+
+
+ A package organizes modules into namespaces, providing a unique namespace for each type it contains.
+
+
+
+
+ A module or class that encloses functions/methods and other code.
+
+
+
+
+ A block of code designed to perform a particular task.
+
+
+
+
+ Optional arguments that are passed to the module or function.
+
+
+
+
+
+
+
+
+
+ The line number the code that is called resides on.
+
+
+
+
+ The column the code that is called resides.
+
+
+
+
+ The full path and filename of the module.
+
+
+
+
+
+
+
+
+
+
+
+ The object in the BOM identified by its bom-ref. This is often a component or service,
+ but may be any object type supporting bom-refs. Tools used for analysis should already
+ be defined in the BOM, either in the metadata/tools, components, or formulation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ opyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Specifies an aggregate type that describe how complete a relationship is.
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Assemblies refer to
+ nested relationships whereby a constituent part may include other constituent parts. References
+ do not cascade to child parts. References are explicit for the specified constituent part only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ The bom-ref identifiers of the components or services being described. Dependencies refer to a
+ relationship whereby an independent constituent part requires another independent constituent
+ part. References do not cascade to transitive dependencies. References are explicit for the
+ specified dependency only.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ The bom-ref identifiers of the vulnerabilities being described.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the composition elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+ The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist.
+
+
+
+
+ The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.
+
+
+
+
+ The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.
+
+
+
+
+ The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.
+
+
+
+
+ The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.
+
+
+
+
+ The relationship completeness is not specified.
+
+
+
+
+
+
+
+
+ Defines a syntax for representing two character language code (ISO-639) followed by an optional two
+ character country code. The language code must be lower case. If the country code is specified, the
+ country code must be upper case. The language code and country code must be separated by a minus sign.
+ Examples: en, en-US, fr, fr-CA
+
+
+
+
+
+
+
+
+
+
+
+ The software versioning type. It is recommended that the release type use one
+ of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software
+ release types is not practical, so standardizing on the recommended values, whenever possible,
+ is strongly encouraged.
+ * major = A major release may contain significant changes or may introduce breaking changes.
+ * minor = A minor release, also known as an update, may contain a smaller number of changes than major releases.
+ * patch = Patch releases are typically unplanned and may resolve defects or important security issues.
+ * pre-release = A pre-release may include alpha, beta, or release candidates and typically have
+ limited support. They provide the ability to preview a release prior to its general availability.
+ * internal = Internal releases are not for public consumption and are intended to be used exclusively
+ by the project or manufacturer that produced it.
+
+
+
+
+
+ The title of the release.
+
+
+
+
+ The URL to an image that may be prominently displayed with the release note.
+
+
+
+
+ The URL to an image that may be used in messaging on social media platforms.
+
+
+
+
+ A short description of the release.
+
+
+
+
+ The date and time (timestamp) when the release note was created.
+
+
+
+
+
+
+
+ One or more alternate names the release may be referred to. This may
+ include unofficial terms used by development and marketing teams (e.g. code names).
+
+
+
+
+
+
+
+
+ A collection of issues that have been resolved.
+
+
+
+
+
+
+
+
+
+
+
+
+ Zero or more release notes containing the locale and content. Multiple
+ note elements may be specified to support release notes in a wide variety of languages.
+
+
+
+
+
+ The ISO-639 (or higher) language code and optional ISO-3166
+ (or higher) country code. Examples include: "en", "en-US", "fr" and "fr-CA".
+
+
+
+
+ Specifies the full content of the release note.
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ A model card describes the intended uses of a machine learning model and potential limitations, including
+ biases and ethical considerations. Model cards typically contain the training parameters, which datasets
+ were used to train the model, performance metrics, and other relevant data useful for ML transparency.
+ This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified
+ for other component types.
+
+
+
+
+
+
+ Hyper-parameters for construction of the model.
+
+
+
+
+
+
+
+ The overall approach to learning used by the model for problem solving.
+
+
+
+
+
+
+
+ Learning types describing the learning problem or hybrid learning problem.
+
+
+
+
+
+
+
+
+
+ Directly influences the input and/or output. Examples include classification,
+ regression, clustering, etc.
+
+
+
+
+
+
+ The model architecture family such as transformer network, convolutional neural
+ network, residual neural network, LSTM neural network, etc.
+
+
+
+
+
+
+ The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.
+
+
+
+
+
+
+ The datasets used to train and evaluate the model.
+
+
+
+
+
+
+ References a data component by the components bom-ref attribute
+
+
+
+
+
+
+
+ Inline Data Information
+
+
+
+
+
+
+
+
+ The input format(s) of the model
+
+
+
+
+
+
+
+
+
+
+ The data format for input to the model. Example formats include string, image, time-series
+
+
+
+
+
+
+
+
+
+
+
+
+ The output format(s) from the model
+
+
+
+
+
+
+
+
+
+
+ The data format for output from the model. Example formats include string, image, time-series
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A quantitative analysis of the model
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type of performance metric.
+
+
+
+
+
+
+ The value of the performance metric.
+
+
+
+
+
+
+ The name of the slice this metric was computed on. By default, assume
+ this metric is not sliced.
+
+
+
+
+
+
+ The confidence interval of the metric.
+
+
+
+
+
+
+
+ The lower bound of the confidence interval.
+
+
+
+
+
+
+ The upper bound of the confidence interval.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A collection of graphics that represent various measurements
+
+
+
+
+
+
+
+ A description of this collection of graphics.
+
+
+
+
+
+
+ A collection of graphics.
+
+
+
+
+
+
+
+
+
+
+ The name of the graphic.
+
+
+
+
+
+
+ The graphic (vector or raster). Base64 encoding must be specified for binary images.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ What considerations should be taken into account regarding the model's construction, training,
+ and application?
+
+
+
+
+
+
+
+ Who are the intended users of the model?
+
+
+
+
+
+
+
+
+
+
+
+ What are the intended use cases of the model?
+
+
+
+
+
+
+
+
+
+
+
+ What are the known technical limitations of the model? E.g. What kind(s) of data
+ should the model be expected not to perform well on? What are the factors that might
+ degrade model performance?
+
+
+
+
+
+
+
+
+
+
+
+ What are the known tradeoffs in accuracy/performance of the model?
+
+
+
+
+
+
+
+
+
+
+
+ What are the ethical risks involved in the application of this model?
+
+
+
+
+
+
+
+
+
+
+ The name of the risk
+
+
+
+
+
+
+ Strategy used to address this risk
+
+
+
+
+
+
+
+
+
+
+
+
+ What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?
+
+
+
+
+
+
+ How does the model affect groups at risk of being systematically disadvantaged?
+ What are the harms and benefits to the various affected groups?
+
+
+
+
+
+
+
+
+
+
+ The groups or individuals at risk of being systematically disadvantaged by the model.
+
+
+
+
+
+
+ Expected benefits to the identified groups.
+
+
+
+
+
+
+ Expected harms to the identified groups.
+
+
+
+
+
+
+ With respect to the benefits and harms outlined, please
+ describe any mitigation strategy implemented.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the model card elsewhere in the BOM.
+ Every bom-ref must be unique within the BOM.
+
+
+
+
+
+
+
+
+ Describes various environmental impact metrics.
+
+
+
+
+
+
+ Describes energy consumption information incurred for one or more component lifecycle activities.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Describes energy consumption information incurred for the specified lifecycle activity.
+
+
+
+
+
+
+ The type of activity that is part of a machine learning model development or operational lifecycle.
+
+
+
+
+
+
+
+ model design including problem framing, goal definition and algorithm selection.
+
+
+
+
+
+
+ model data acquisition including search, selection and transfer.
+
+
+
+
+
+
+ model data preparation including data cleaning, labeling and conversion.
+
+
+
+
+
+
+ model building, training and generalized tuning.
+
+
+
+
+
+
+ refining a trained model to produce desired outputs for a given problem space.
+
+
+
+
+
+
+ model validation including model output evaluation and testing.
+
+
+
+
+
+
+ explicit model deployment to a target hosting infrastructure.
+
+
+
+
+
+
+ generating an output response from a hosted model from a set of inputs.
+
+
+
+
+
+
+ a lifecycle activity type whose description does not match currently defined values.
+
+
+
+
+
+
+
+
+
+ The provider(s) of the energy consumed by the associated model development lifecycle activity.
+
+
+
+
+
+
+ The total energy cost associated with the model lifecycle activity.
+
+
+
+
+
+
+ The CO2 cost (debit) equivalent to the total energy cost.
+
+
+
+
+
+
+ The CO2 offset (credit) for the CO2 equivalent cost.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+
+
+
+
+ A measure of energy.
+
+
+
+
+
+
+ Quantity of energy.
+
+
+
+
+
+
+ Unit of energy.
+
+
+
+
+
+
+
+ kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h).
+
+
+
+
+
+
+
+
+
+
+
+
+ A measure of carbon dioxide (CO2).
+
+
+
+
+
+
+ Quantity of carbon dioxide (CO2).
+
+
+
+
+
+
+ Unit of carbon dioxide (CO2).
+
+
+
+
+
+
+
+ Tonnes (t) of carbon dioxide (CO2) equivalent (eq).
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes the physical provider of energy used for model development or operations.
+
+
+
+
+
+
+ A description of the energy provider.
+
+
+
+
+
+
+ The organization of the energy provider.
+
+
+
+
+
+
+ The energy source for the energy provider.
+
+
+
+
+
+
+
+ Energy produced by types of coal.
+
+
+
+
+
+
+ Petroleum products (primarily crude oil and its derivative fuel oils).
+
+
+
+
+
+
+ Hydrocarbon gas liquids (HGL) that occur as gases at atmospheric pressure and as liquids under higher pressures including Natural gas (C5H12 and heavier), Ethane (C2H6), Propane (C3H8), etc.
+
+
+
+
+
+
+ Energy produced from the cores of atoms (i.e., through nuclear fission or fusion).
+
+
+
+
+
+
+ Energy produced from moving air.
+
+
+
+
+
+
+ Energy produced from the sun (i.e., solar radiation).
+
+
+
+
+
+
+ Energy produced from heat within the earth.
+
+
+
+
+
+
+ Energy produced from flowing water.
+
+
+
+
+
+
+ Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals).
+
+
+
+
+
+
+ The energy source is unknown.
+
+
+
+
+
+
+ An energy source that is not listed.
+
+
+
+
+
+
+
+
+
+ The energy provided by the energy source for an associated activity.
+
+
+
+
+
+ External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the energy provider elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+ An address used to identify a contactable location.
+
+
+
+
+
+
+ The country name or the two-letter ISO 3166-1 country code.
+
+
+
+
+
+
+ The region or state in the country. For example, Texas.
+
+
+
+
+
+
+ The locality or city within the country. For example, Austin.
+
+
+
+
+
+
+ The post office box number. For example, 901.
+
+
+
+
+
+
+ The postal code. For example, 78758.
+
+
+
+
+
+
+ The street address. For example, 100 Main Street.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the address elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+
+ Supervised machine learning involves training an algorithm on labeled
+ data to predict or classify new data based on the patterns learned from
+ the labeled examples.
+
+
+
+
+
+
+ Unsupervised machine learning involves training algorithms on unlabeled
+ data to discover patterns, structures, or relationships without explicit
+ guidance, allowing the model to identify inherent structures or clusters
+ within the data.
+
+
+
+
+
+
+ Reinforcement learning is a type of machine learning where an agent learns
+ to make decisions by interacting with an environment to maximize cumulative
+ rewards, through trial and error.
+
+
+
+
+
+
+ Semi-supervised machine learning utilizes a combination of labeled and
+ unlabeled data during training to improve model performance, leveraging
+ the benefits of both supervised and unsupervised learning techniques.
+
+
+
+
+
+
+ Self-supervised machine learning involves training models to predict parts
+ of the input data from other parts of the same data, without requiring
+ external labels, enabling learning from large amounts of unlabeled data.
+
+
+
+
+
+
+
+
+
+
+
+ The general theme or subject matter of the data being specified.
+
+
+
+
+
+
+ The name of the dataset.
+
+
+
+
+
+
+ The contents or references to the contents of the data being described.
+
+
+
+
+
+
+ An optional way to include textual or encoded data.
+
+
+
+
+ The URL to where the data can be retrieved.
+
+
+
+
+ Provides the ability to document name-value parameters used for configuration.
+
+
+
+
+
+
+
+
+ Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
+
+
+
+
+
+
+ A description of any sensitive data in a dataset.
+
+
+
+
+
+
+ A collection of graphics that represent various measurements.
+
+
+
+
+
+
+ A description of the dataset. Can describe size of dataset, whether it's used for source code,
+ training, testing, or validation, etc.
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the dataset elsewhere in the BOM.
+ Every bom-ref must be unique within the BOM.
+
+
+
+
+
+
+
+
+
+
+ Data custodians are responsible for the safe custody, transport, and storage of data.
+
+
+
+
+
+
+
+
+
+
+
+ Data stewards are responsible for data content, context, and associated business rules.
+
+
+
+
+
+
+
+
+
+
+
+ Data owners are concerned with risk and appropriate access to data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A collection of graphics that represent various measurements.
+
+
+
+
+
+
+ A description of this collection of graphics.
+
+
+
+
+
+
+ A collection of graphics.
+
+
+
+
+
+
+
+
+
+
+ The name of the graphic.
+
+
+
+
+
+
+ The graphic (vector or raster). Base64 encoding must be specified for binary images.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Any type of code, code snippet, or data-as-code.
+
+
+
+
+ Parameters or settings that may be used by other components.
+
+
+
+
+ A collection of data.
+
+
+
+
+ Data that can be used to create new instances of what the definition defines.
+
+
+
+
+ Any other type of data that does not fit into existing definitions.
+
+
+
+
+
+
+
+
+ References a component or service by its bom-ref attribute
+
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+ Specifies an individual property with a name and value.
+
+
+
+
+
+ The name of the property. Duplicate names are allowed, each potentially having a different value.
+
+
+
+
+
+
+
+
+
+
+ Defines a weakness in a component or service that could be exploited or triggered by a threat source.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The identifier that uniquely identifies the vulnerability. For example:
+ CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876.
+
+
+
+
+ The source that published the vulnerability.
+
+
+
+
+ Zero or more pointers to vulnerabilities that are the equivalent of the
+ vulnerability specified. Often times, the same vulnerability may exist in multiple sources of
+ vulnerability intelligence, but have different identifiers. References provide a way to
+ correlate vulnerabilities across multiple sources of vulnerability intelligence.
+
+
+
+
+
+ A pointer to a vulnerability that is the equivalent of the
+ vulnerability specified.
+
+
+
+
+
+ The identifier that uniquely identifies the vulnerability. For example:
+ CVE-2021-39182, GHSA-35m5-8cvj-8783, and SNYK-PYTHON-ENROCRYPT-1912876.
+
+
+
+
+ The source that published the vulnerability.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ List of vulnerability ratings.
+
+
+
+
+
+
+
+
+
+
+
+ List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability.
+ For example 399 (of https://cwe.mitre.org/data/definitions/399.html)
+
+
+
+
+
+
+
+
+
+ A description of the vulnerability as provided by the source.
+
+
+
+
+ If available, an in-depth description of the vulnerability as provided by the
+ source organization. Details often include information useful in understanding root cause.
+
+
+
+
+ Recommendations of how the vulnerability can be remediated or mitigated.
+
+
+
+
+ A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments.
+
+
+
+
+
+
+ Evidence used to reproduce the vulnerability.
+
+
+
+
+
+ Precise steps to reproduce the vulnerability.
+
+
+
+
+ A description of the environment in which reproduction was possible.
+
+
+
+
+ Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Published advisories of the vulnerability if provided.
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was created in the vulnerability database.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was first published.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was last updated.
+
+
+
+
+ The date and time (timestamp) when the vulnerability record was rejected (if applicable).
+
+
+
+
+ Individuals or organizations credited with the discovery of the vulnerability.
+
+
+
+
+
+ The organizations credited with vulnerability discovery.
+
+
+
+
+
+
+
+
+
+ The individuals, not associated with organizations, that are credited with vulnerability discovery.
+
+
+
+
+
+
+
+
+
+
+
+
+ The tool(s) used to identify, confirm, or score the vulnerability.
+
+
+
+
+
+
+ DEPRECATED. Use tools\components or tools\services instead.
+
+
+
+
+
+
+ A list of software and hardware components used as tools.
+
+
+
+
+ A list of services used as tools.
+
+
+
+
+
+
+
+
+
+
+ An assessment of the impact and exploitability of the vulnerability.
+
+
+
+
+
+
+ Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+ A response to the vulnerability by the manufacturer, supplier, or
+ project responsible for the affected component or service. More than one response
+ is allowed. Responses are strongly encouraged for vulnerabilities where the analysis
+ state is exploitable.
+
+
+
+
+
+
+
+
+
+
+ Detailed description of the impact including methods used during assessment.
+ If a vulnerability is not exploitable, this field should include specific details
+ on why the component or service is not impacted by this vulnerability.
+
+
+
+
+
+
+ The date and time (timestamp) when the analysis was first issued.
+
+
+
+
+
+
+ The date and time (timestamp) when the analysis was last updated.
+
+
+
+
+
+
+
+
+ The components or services that are affected by the vulnerability.
+
+
+
+
+
+
+
+
+ References a component or service by the objects bom-ref.
+
+
+
+
+
+
+
+ Zero or more individual versions or range of versions.
+
+
+
+
+
+
+
+
+
+ A single version of a component or service.
+
+
+
+
+ A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst
+
+
+
+
+
+
+ The vulnerability status for the version or range of versions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the vulnerability elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+
+
+
+
+ The name of the source.
+ For example: NVD, National Vulnerability Database, OSS Index, VulnDB, and GitHub Advisories
+
+
+
+
+
+ The url of the vulnerability documentation as provided by the source.
+ For example: https://nvd.nist.gov/vuln/detail/CVE-2021-39182
+
+
+
+
+
+
+
+
+
+ The source that calculated the severity or risk rating of the vulnerability.
+
+
+
+
+ The numerical score of the rating.
+
+
+
+
+ Textual representation of the severity that corresponds to the numerical score of the rating.
+
+
+
+
+ The risk scoring methodology/standard used.
+
+
+
+
+ Textual representation of the metric values used to score the vulnerability.
+
+
+
+
+ An optional reason for rating the vulnerability as it was.
+
+
+
+
+
+
+
+
+
+ An optional name of the advisory.
+
+
+
+
+ Location where the advisory can be obtained.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ The organization that created the annotation
+
+
+
+
+ The person that created the annotation
+
+
+
+
+ The tool or component that created the annotation
+
+
+
+
+ The service that created the annotation
+
+
+
+
+
+
+
+
+
+
+ The objects in the BOM identified by their bom-ref's. This is often components or services, but may be any object type supporting bom-refs.
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+ The organization, individual, component, or service which created the textual content
+ of the annotation.
+
+
+
+
+ The date and time (timestamp) when the annotation was created.
+
+
+
+
+ The textual content of the annotation.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the annotation elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Textual representation of the severity of the vulnerability adopted by the analysis method. If the
+ analysis method uses values other than what is provided, the user is expected to translate appropriately.
+
+
+
+
+
+ Critical severity
+
+
+
+
+ High severity
+
+
+
+
+ Medium severity
+
+
+
+
+ Low severity
+
+
+
+
+ Informational warning.
+
+
+
+
+ None
+
+
+
+
+ The severity is not known
+
+
+
+
+
+
+
+
+ Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.
+
+
+
+
+
+
+ The vulnerability has been remediated.
+
+
+
+
+
+
+ The vulnerability has been remediated and evidence of the changes are provided in the affected
+ components pedigree containing verifiable commit history and/or diff(s).
+
+
+
+
+
+
+ The vulnerability may be directly or indirectly exploitable.
+
+
+
+
+
+
+ The vulnerability is being investigated.
+
+
+
+
+
+
+ The vulnerability is not specific to the component or service and was falsely identified or associated.
+
+
+
+
+
+
+ The component or service is not affected by the vulnerability. Justification should be specified
+ for all not_affected cases.
+
+
+
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+
+ The code has been removed or tree-shaked.
+
+
+
+
+
+
+ The vulnerable code is not invoked at runtime.
+
+
+
+
+
+
+ Exploitability requires a configurable option to be set/unset.
+
+
+
+
+
+
+ Exploitability requires a dependency that is not present.
+
+
+
+
+
+
+ Exploitability requires a certain environment which is not present.
+
+
+
+
+
+
+ Exploitability requires a compiler flag to be set/unset.
+
+
+
+
+
+
+ Exploits are prevented at runtime.
+
+
+
+
+
+
+ Attacks are blocked at physical, logical, or network perimeter.
+
+
+
+
+
+
+ Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.
+
+
+
+
+
+
+
+
+
+ Specifies the severity or risk scoring methodology or standard used.
+
+
+
+
+
+
+ Common Vulnerability Scoring System v2.0 standard as defined at https://www.first.org/cvss/v2/
+
+
+
+
+
+
+ Common Vulnerability Scoring System v3.0 standard as defined at https://www.first.org/cvss/v3-0/
+
+
+
+
+
+
+ Common Vulnerability Scoring System v3.1 standard as defined at https://www.first.org/cvss/v3-1/
+
+
+
+
+
+
+ Common Vulnerability Scoring System v4.0 standard as defined at https://www.first.org/cvss/v4-0/
+
+
+
+
+
+
+ OWASP Risk Rating as defined at https://owasp.org/www-community/OWASP_Risk_Rating_Methodology
+
+
+
+
+
+
+ Stakeholder Specific Vulnerability Categorization as defined at https://github.com/CERTCC/SSVC
+
+
+
+
+
+
+ Another severity or risk scoring methodology
+
+
+
+
+
+
+
+
+
+ The rationale of why the impact analysis state was asserted.
+
+
+
+
+
+ Can not fix
+
+
+
+
+ Will not fix
+
+
+
+
+ Update to a different revision or release
+
+
+
+
+ Revert to a previous revision or release
+
+
+
+
+ There is a workaround available
+
+
+
+
+
+
+
+
+ The vulnerability status of a given version or range of versions of a product. The statuses
+ 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability.
+ The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected.
+ There can be many reasons for an 'unknown' status, including that an investigation has not been
+ undertaken or that a vendor has not disclosed the status.
+
+
+
+
+
+ The version is affected by the vulnerability.
+
+
+
+
+ The version is not affected by the vulnerability.
+
+
+
+
+ It is unknown (or unspecified) whether the given version is affected.
+
+
+
+
+
+
+
+
+ Describes how a component or service was manufactured or deployed. This is achieved through the use
+ of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the
+ observed formulas describing the steps which transpired in the manufacturing process.
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Describes workflows and resources that captures rules and other aspects of how the associated
+ BOM component or service was formed.
+
+
+
+
+
+ Transient components that are used in tasks that constitute one or more of
+ this formula's workflows
+
+
+
+
+ Transient services that are used in tasks that constitute one or more of
+ this formula's workflows
+
+
+
+
+ List of workflows that can be declared to accomplish specific orchestrated goals
+ and independently triggered.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the formula elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+ References to component or service resources that are used to realize
+ the resource instance.
+
+
+
+
+ The tasks that comprise the workflow.
+
+
+
+
+ The graph of dependencies between tasks within the workflow.
+
+
+
+
+ Indicates the types of activities performed by the set of workflow tasks.
+
+
+
+
+
+
+
+
+
+ The trigger that initiated the task.
+
+
+
+
+
+ The sequence of steps for the task.
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data brought into a task at runtime by executor
+ or task commands
+
+
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor
+ or task commands
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the task started.
+
+
+
+
+
+
+ The date and time (timestamp) when the task ended.
+
+
+
+
+
+ A set of named filesystem or data resource shareable by workflow tasks.
+
+
+
+
+ A graph of the component runtime topology for workflow's instance.
+ A description of the runtime component and service topology. This can describe a partial or
+ complete topology used to host and execute the task (e.g., hardware, operating systems,
+ configurations, etc.)
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the workflow elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ References an object by its bom-ref attribute
+
+
+
+
+
+
+
+
+
+ Reference to an externally accessible resource.
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+
+ References to component or service resources that are used to realize the resource instance.
+
+
+
+
+
+
+ Indicates the types of activities performed by the set of workflow tasks.
+
+
+
+
+
+
+
+
+
+
+
+ The trigger that initiated the task.
+
+
+
+
+
+
+ The sequence of steps for the task.
+
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data brought into a task at runtime by executor or task commands.
+
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor or task commands
+
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the task started.
+
+
+
+
+
+
+ The date and time (timestamp) when the task ended.
+
+
+
+
+
+
+ A set of named filesystem or data resource shareable by workflow tasks.
+
+
+
+
+
+
+ A graph of the component runtime topology for task's instance.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the task elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ A task that copies software or data used to accomplish other tasks in the workflow.
+
+
+
+
+ A task that clones a software repository into the workflow in order to retrieve its source code or data for use in a build step.
+
+
+
+
+ A task that checks source code for programmatic and stylistic errors.
+
+
+
+
+ A task that performs a scan against source code, or built or deployed components and services. Scans are typically run to gather or test for security vulnerabilities or policy compliance.
+
+
+
+
+ A task that merges changes or fixes into source code prior to a build step in the workflow.
+
+
+
+
+ A task that builds the source code, dependencies and/or data into an artifact that can be deployed to and executed on target systems.
+
+
+
+
+ A task that verifies the functionality of a component or service.
+
+
+
+
+ A task that delivers a built artifact to one or more target repositories or storage systems.
+
+
+
+
+ A task that deploys a built artifact for execution on one or more target systems.
+
+
+
+
+ A task that releases a built, versioned artifact to a target repository or distribution system.
+
+
+
+
+ A task that cleans unnecessary tools, build artifacts and/or data from workflow storage.
+
+
+
+
+ A workflow task that does not match current task type definitions.
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ A named filesystem or data resource shareable by workflow tasks.
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping
+ so other tasks can use their own local name in their steps.
+
+
+
+
+
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+
+ References to component or service resources that are used to realize the resource instance.
+
+
+
+
+
+
+ Describes the read-write access control for the workspace relative to the owning resource instance.
+
+
+
+
+
+
+ A path to a location on disk where the workspace will be available to the associated task's steps.
+
+
+
+
+
+
+ The name of a domain-specific data type the workspace represents. This property is for CI/CD
+ frameworks that are able to provide access to structured, managed data at a more granular level
+ than a filesystem.
+
+
+
+
+
+
+ Identifies the reference to the request for a specific volume type and parameters.
+
+
+
+
+
+
+ Information about the actual volume instance allocated to the workspace.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the workflow elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An identifiable, logical unit of data storage tied to a physical device.
+
+
+
+
+
+
+ The unique identifier for the volume instance within its deployment context.
+
+
+
+
+
+
+ The name of the volume instance
+
+
+
+
+
+
+ The mode for the volume instance.
+
+
+
+
+
+
+ The underlying path created from the actual volume.
+
+
+
+
+
+
+ The allocated size of the volume accessible to the associated workspace. This should include
+ the scalar size as well as IEC standard unit in either decimal or binary form.
+
+
+
+
+
+
+ Indicates if the volume persists beyond the life of the resource it is associated with.
+
+
+
+
+
+
+ Indicates if the volume is remotely (i.e., network) attached.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Executes specific commands or tools in order to accomplish its owning task as part of a sequence.
+
+
+
+
+
+
+ A name for the step.
+
+
+
+
+
+
+ A description of the step.
+
+
+
+
+
+
+ Ordered list of commands or directives for the step
+
+
+
+
+
+
+
+
+
+
+ A text representation of the executed command.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ The unique identifier for the resource instance within its deployment context.
+
+
+
+
+
+
+ The name of the resource instance.
+
+
+
+
+
+
+ The description of the resource instance.
+
+
+
+
+
+
+ References to component or service resources that are used to realize the resource instance.
+
+
+
+
+
+
+ The source type of event which caused the trigger to fire.
+
+
+
+
+
+
+ The event data that caused the associated trigger to activate.
+
+
+
+
+
+ A list of conditions used to determine if a trigger should be activated.
+
+
+
+
+
+
+ A condition that was used to determine a trigger should be activated.
+
+
+
+
+
+
+
+ Describes the set of conditions which cause the trigger to activate.
+
+
+
+
+
+
+ The logical expression that was evaluated that determined the trigger should be fired.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the trigger was activated.
+
+
+
+
+
+
+ Represents resources and data brought into a task at runtime by executor or task commands
+
+
+
+
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor or task commands
+
+
+
+
+
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the trigger elsewhere in the BOM.
+ Uniqueness is enforced within all elements and children of the root-level bom element.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The unique identifier of the event.
+
+
+
+
+
+
+ A description of the event.
+
+
+
+
+
+
+ The date and time (timestamp) when the event was received.
+
+
+
+
+
+
+ Encoding of the raw event data.
+
+
+
+
+
+
+ References the component or service that was the source of the event
+
+
+
+
+
+
+ References the component or service that was the target of the event
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Type that represents various input data types and formats.
+
+
+
+
+
+
+
+ A reference to an independent resource provided as an input to a task by the workflow runtime.
+
+
+
+
+
+
+ Inputs that have the form of parameters with names and values.
+
+
+
+
+
+
+ Inputs that have the form of parameters with names and values.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Inputs that have the form of data.
+
+
+
+
+
+
+
+ A references to the component or service that provided the input to the task
+ (e.g., reference to a service with data flow value of inbound)
+
+
+
+
+
+
+ A reference to the component or service that received or stored the input if not the task
+ itself (e.g., a local, named storage workspace)
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Represents resources and data output from a task at runtime by executor or task commands
+
+
+
+
+
+
+
+ A reference to an independent resource generated as output by the task.
+
+
+
+
+
+
+ Outputs that have the form of environment variables.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Outputs that have the form of data.
+
+
+
+
+
+
+
+ Describes the type of data output.
+
+
+
+
+
+
+ Component or service that generated or provided the output from the task (e.g., a build tool)
+
+
+
+
+
+
+ Component or service that received the output from the task
+ (e.g., reference to an artifactory service with data flow value of outbound)
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A representation of a functional parameter.
+
+
+
+
+
+
+ The name of the parameter.
+
+
+
+
+
+
+ The value of the parameter.
+
+
+
+
+
+
+ The data type of the parameter.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ Cryptographic assets have properties that uniquely define them and that make them actionable for
+ further reasoning. As an example, it makes a difference if one knows the algorithm family (e.g. AES)
+ or the specific variant or instantiation (e.g. AES-128-GCM). This is because the security level and the
+ algorithm primitive (authenticated encryption) is only defined by the definition of the algorithm variant.
+ The presence of a weak cryptographic algorithm like SHA1 vs. HMAC-SHA1 also makes a difference.
+
+
+
+
+
+
+ Cryptographic assets occur in several forms. Algorithms and protocols are most commonly
+ implemented in specialized cryptographic libraries. They may however also be 'hardcoded'
+ in software components. Certificates and related cryptographic material like keys, tokens,
+ secrets or passwords are other cryptographic assets to be modelled.
+
+
+
+
+
+
+
+ Mathematical function commonly used for data encryption, authentication, and
+ digital signatures.
+
+
+
+
+
+
+ An electronic document that is used to provide the identity or validate a public key.
+
+
+
+
+
+
+ A set of rules and guidelines that govern the behavior and communication with each other.
+
+
+
+
+
+
+ Other cryptographic assets that are related to algorithms, certificate, and protocols
+ such as keys and tokens.
+
+
+
+
+
+
+
+
+
+ Additional properties specific to a cryptographic algorithm.
+
+
+
+
+
+
+
+ Cryptographic building blocks used in higher-level cryptographic systems and
+ protocols. Primitives represent different cryptographic routines: deterministic
+ random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message
+ authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES),
+ streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256),
+ public-key encryption schemes (pke, e.g. RSA), extended output functions
+ (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement
+ algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated
+ encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms
+ (combiner, e.g. SP800-56Cr2).
+
+
+
+
+
+
+
+ Deterministic Random Bit Generator (DRBG) is a type of pseudorandom
+ number generator designed to produce a sequence of bits from an initial
+ seed value. DRBGs are commonly used in cryptographic applications where
+ reproducibility of random values is important.
+
+
+
+
+
+
+ In cryptography, a Message Authentication Code (MAC) is information
+ used for authenticating and integrity-checking a message.
+
+
+
+
+
+
+ A block cipher is a symmetric key algorithm that operates on fixed-size
+ blocks of data. It encrypts or decrypts the data in block units,
+ providing confidentiality. Block ciphers are widely used in various
+ cryptographic modes and protocols for secure data transmission.
+
+
+
+
+
+
+ A stream cipher is a symmetric key cipher where plaintext digits are
+ combined with a pseudorandom cipher digit stream (keystream).
+
+
+
+
+
+
+ In cryptography, a signature is a digital representation of a message
+ or data that proves its origin, identity, and integrity. Digital
+ signatures are generated using cryptographic algorithms and are widely
+ used for authentication and verification in secure communication.
+
+
+
+
+
+
+ A hash function is a mathematical algorithm that takes an input
+ (or 'message') and produces a fixed-size string of characters, which is
+ typically a hash value. Hash functions are commonly used in various
+ cryptographic applications, including data integrity verification and
+ password hashing.
+
+
+
+
+
+
+ Public Key Encryption (PKE) is a type of encryption that uses a pair of
+ public and private keys for secure communication. The public key is used
+ for encryption, while the private key is used for decryption. PKE is a
+ fundamental component of public-key cryptography.
+
+
+
+
+
+
+ An XOF is an extendable output function that can take arbitrary input
+ and creates a stream of output, up to a limit determined by the size of
+ the internal state of the hash function that underlies the XOF.
+
+
+
+
+
+
+ A Key Derivation Function (KDF) derives key material from another source
+ of entropy while preserving the entropy of the input.
+
+
+
+
+
+
+ In cryptography, a key-agreement is a protocol whereby two or more
+ parties agree on a cryptographic key in such a way that both influence
+ the outcome.
+
+
+
+
+
+
+ A Key Encapsulation Mechanism (KEM) algorithm is a mechanism for
+ transporting random keying material to a recipient using the recipient's
+ public key.
+
+
+
+
+
+
+ Authenticated Encryption (AE) is a cryptographic process that provides
+ both confidentiality and data integrity. It ensures that the encrypted
+ data has not been tampered with and comes from a legitimate source.
+ AE is commonly used in secure communication protocols.
+
+
+
+
+
+
+ A combiner aggregates many candidates for a cryptographic primitive and
+ generates a new candidate for the same primitive.
+
+
+
+
+
+
+ Another primitive type.
+
+
+
+
+
+
+ The primitive is not known.
+
+
+
+
+
+
+
+
+
+ An identifier for the parameter set of the cryptographic algorithm. Examples: in
+ AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the
+ digest length, '128' in SHAKE128 identifies its maximum security level in bits, and
+ 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).
+
+
+
+
+
+
+ The specific underlying Elliptic Curve (EC) definition employed which is an indicator
+ of the level of security strength, performance and complexity. Absent an
+ authoritative source of curve names, CycloneDX recommends use of curve names as
+ defined at https://neuromancer.sk/std/, the source from which can be found at
+ https://github.com/J08nY/std-curves.
+
+
+
+
+
+
+ The target and execution environment in which the algorithm is implemented in.
+
+
+
+
+
+
+
+ A software implementation running in plain unencrypted RAM.
+
+
+
+
+
+
+ A software implementation running in encrypted RAM.
+
+
+
+
+
+ A software implementation running in a trusted execution environment.
+
+
+
+
+
+ A hardware implementation.
+
+
+
+
+
+ Another implementation environment.
+
+
+
+
+
+ The execution environment is not known.
+
+
+
+
+
+
+
+
+
+ The target platform for which the algorithm is implemented. The implementation can
+ be 'generic', running on any platform or for a specific platform.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The certification that the implementation of the cryptographic algorithm has
+ received, if any. Certifications include revisions and levels of FIPS 140 or
+ Common Criteria of different Extended Assurance Levels (CC-EAL).
+
+
+
+
+
+
+
+ No certification obtained
+
+
+
+
+
+
+ FIPS 140-1 Level 1
+
+
+
+
+
+
+ FIPS 140-1 Level 2
+
+
+
+
+
+
+ FIPS 140-1 Level 3
+
+
+
+
+
+
+ FIPS 140-1 Level 4
+
+
+
+
+
+
+ FIPS 140-2 Level 1
+
+
+
+
+
+
+ FIPS 140-2 Level 2
+
+
+
+
+
+
+ FIPS 140-2 Level 3
+
+
+
+
+
+
+ FIPS 140-2 Level 4
+
+
+
+
+
+
+ FIPS 140-3 Level 1
+
+
+
+
+
+
+ FIPS 140-3 Level 2
+
+
+
+
+
+
+ FIPS 140-3 Level 3
+
+
+
+
+
+
+ FIPS 140-3 Level 4
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 1
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 1 (Augmented)
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 2
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 2 (Augmented)
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 3
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 3 (Augmented)
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 4
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 4 (Augmented)
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 5
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 5 (Augmented)
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 6
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 6 (Augmented)
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 7
+
+
+
+
+
+
+ Common Criteria - Evaluation Assurance Level 7 (Augmented)
+
+
+
+
+
+
+ Another certification
+
+
+
+
+
+
+ The certification level is not known
+
+
+
+
+
+
+
+
+
+ The mode of operation in which the cryptographic algorithm (block cipher) is used.
+
+
+
+
+
+
+
+ Cipher block chaining
+
+
+
+
+
+
+ Electronic codebook
+
+
+
+
+
+
+ Counter with cipher block chaining message authentication code
+
+
+
+
+
+
+ Galois/counter
+
+
+
+
+
+
+ Cipher feedback
+
+
+
+
+
+
+ Output feedback
+
+
+
+
+
+
+ Counter
+
+
+
+
+
+
+ Another mode of operation
+
+
+
+
+
+
+ The mode of operation is not known
+
+
+
+
+
+
+
+
+
+ The padding scheme that is used for the cryptographic algorithm.
+
+
+
+
+
+
+
+ Password-Based Cryptography Specification #5
+
+
+
+
+
+
+ Public Key Cryptography Standard: Cryptographic Message Syntax
+
+
+
+
+
+
+ Public Key Cryptography Standard: RSA Cryptography v1.5
+
+
+
+
+
+
+ Optimal asymmetric encryption padding
+
+
+
+
+
+
+ Raw
+
+
+
+
+
+
+ Another padding scheme
+
+
+
+
+
+
+ The padding scheme is not known
+
+
+
+
+
+
+
+
+
+ The cryptographic functions implemented by the cryptographic algorithm.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The classical security level that a cryptographic algorithm provides (in bits).
+
+
+
+
+
+
+
+
+
+
+
+ The NIST security strength category as defined in
+ https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria).
+ A value of 0 indicates that none of the categories are met.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties for cryptographic assets of asset type 'certificate'
+
+
+
+
+
+
+
+ The subject name for the certificate
+
+
+
+
+
+
+ The issuer name for the certificate
+
+
+
+
+
+
+ The date and time according to ISO-8601 standard from which the certificate is valid
+
+
+
+
+
+
+ The date and time according to ISO-8601 standard from which the certificate is not valid anymore
+
+
+
+
+
+
+ The bom-ref to signature algorithm used by the certificate
+
+
+
+
+
+
+ The bom-ref to the public key of the subject
+
+
+
+
+
+
+ The format of the certificate. Examples include X.509, PEM, DER, and CVC
+
+
+
+
+
+
+ The file extension of the certificate. Examples include crt, pem, cer, der, and p12.
+
+
+
+
+
+
+
+
+
+ Properties for cryptographic assets of asset type 'relatedCryptoMaterial'
+
+
+
+
+
+
+
+ The type for the related cryptographic material
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The optional unique identifier for the related cryptographic material.
+
+
+
+
+
+
+ The key state as defined by NIST SP 800-57.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The bom-ref to the algorithm used to generate the related cryptographic material.
+
+
+
+
+
+
+ The date and time (timestamp) when the related cryptographic material was created.
+
+
+
+
+
+
+ The date and time (timestamp) when the related cryptographic material was activated.
+
+
+
+
+
+
+ The date and time (timestamp) when the related cryptographic material was updated.
+
+
+
+
+
+
+ The date and time (timestamp) when the related cryptographic material expires.
+
+
+
+
+
+
+ The associated value of the cryptographic material.
+
+
+
+
+
+
+ The size of the cryptographic asset (in bits).
+
+
+
+
+
+
+ The format of the related cryptographic material (e.g. P8, PEM, DER).
+
+
+
+
+
+
+ The mechanism by which the cryptographic asset is secured by.
+
+
+
+
+
+
+
+ Specifies the mechanism by which the cryptographic asset is secured by.
+ Examples include HSM, TPM, XGX, Software, and None.
+
+
+
+
+
+
+ The bom-ref to the algorithm.
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties specific to cryptographic assets of type: 'protocol'.
+
+
+
+
+
+
+
+ The concrete protocol type.
+
+
+
+
+
+
+
+ Transport Layer Security
+
+
+
+
+
+
+ Secure Shell
+
+
+
+
+
+
+ Internet Protocol Security
+
+
+
+
+
+
+ Internet Key Exchange
+
+
+
+
+
+
+ Secure Socket Tunneling Protocol
+
+
+
+
+
+
+ Wi-Fi Protected Access
+
+
+
+
+
+
+ Another protocol type
+
+
+
+
+
+
+ The protocol type is not known
+
+
+
+
+
+
+
+
+
+ The version of the protocol. Examples include 1.0, 1.2, and 1.99.
+
+
+
+
+
+
+ A list of cipher suites related to the protocol.
+
+
+
+
+
+
+
+
+
+
+ A common name for the cipher suite. For example: TLS_DHE_RSA_WITH_AES_128_CCM
+
+
+
+
+
+
+ A list of algorithms related to the cipher suite.
+
+
+
+
+
+
+
+ The bom-ref to algorithm cryptographic asset.
+
+
+
+
+
+
+
+
+
+ A list of common identifiers for the cipher suite.
+
+
+
+
+
+
+
+ Cipher suite identifier. Examples include 0xC0 and 0x9E.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The IKEv2 transform types supported (types 1-4), defined in RFC7296 section 3.3.2,
+ and additional properties.
+
+
+
+
+
+
+
+ Transform Type 1: encryption algorithms
+
+
+
+
+
+
+ Transform Type 2: pseudorandom functions
+
+
+
+
+
+
+ Transform Type 3: integrity algorithms
+
+
+
+
+
+
+ Transform Type 4: Key Exchange Method (KE) per RFC9370, formerly called Diffie-Hellman Group (D-H)
+
+
+
+
+
+
+ Specifies if an Extended Sequence Number (ESN) is used.
+
+
+
+
+
+
+ IKEv2 Authentication method
+
+
+
+
+
+
+
+
+ A protocol-related cryptographic assets
+
+
+
+
+
+
+
+
+ The object identifier (OID) of the cryptographic asset.
+
+
+
+
+
+
+
+
+
+
+
+ The list of assessors evaluating claims and determining conformance to requirements and confidence in that assessment.
+
+
+
+
+
+
+
+ The assessor who evaluates claims and determines conformance to requirements and confidence in that assessment.
+
+
+
+
+
+
+
+ The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor.
+
+
+
+
+
+
+ The entity issuing the assessment.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere in the BOM.
+ Every bom-ref must be unique within the BOM.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ The list of attestations asserted by an assessor that maps requirements to claims.
+
+
+
+
+
+
+
+ An attestation asserted by an assessor that maps requirements to claims.
+
+
+
+
+
+
+
+ The short description explaining the main points of the attestation.
+
+
+
+
+
+
+ The `bom-ref` to the assessor asserting the attestation.
+
+
+
+
+
+
+ The grouping of requirements to claims and the attestors declared conformance and confidence thereof.
+
+
+
+
+
+
+
+ The `bom-ref` to the requirement being attested to.
+
+
+
+
+
+
+ The list of `bom-ref` to the claims being attested to.
+
+
+
+
+
+
+
+ The `bom-ref` to the claim being attested to.
+
+
+
+
+
+
+
+
+
+ The list of `bom-ref` to the counter claims being attested to.
+
+
+
+
+
+
+
+ The `bom-ref` to the counter claim being attested to.
+
+
+
+
+
+
+
+
+
+ The conformance of the claim meeting a requirement.
+
+
+
+
+
+
+
+ The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance.
+
+
+
+
+
+
+
+
+
+
+
+
+ The rationale for the score of conformance.
+
+
+
+
+
+
+ The list of `bom-ref` to the evidence provided describing the
+ mitigation strategies. Each mitigation strategy should include an
+ explanation of how any weaknesses in the evidence will be mitigated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The confidence of the claim meeting the requirement.
+
+
+
+
+
+
+
+ The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence.
+
+
+
+
+
+
+
+
+
+
+
+
+ The rationale for the confidence score.
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+ The list of claims.
+
+
+
+
+
+
+
+
+
+
+ The `bom-ref` to a target representing a specific system, application,
+ API, module, team, person, process, business unit, company, etc...
+ that this claim is being applied to.
+
+
+
+
+
+
+ The specific statement or assertion about the target.
+
+
+
+
+
+
+ The list of `bom-ref` to the evidence provided describing the
+ mitigation strategies. Each mitigation strategy should include an
+ explanation of how any weaknesses in the evidence will be mitigated.
+
+
+
+
+
+
+
+
+
+
+
+ The written explanation of why the evidence provided substantiates the claim.
+
+
+
+
+
+
+ The list of `bom-ref` to evidence that supports this claim.
+
+
+
+
+
+
+ The list of `bom-ref` to counterEvidence that supports this claim.
+
+
+
+
+
+ Provides the ability to document external references related to the claim the BOM describes.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere
+ in the BOM. Every bom-ref must be unique within the BOM.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ The list of evidence
+
+
+
+
+
+
+
+ The list of evidence
+
+
+
+
+
+
+
+ The reference to the property name as defined in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy/).
+
+
+
+
+
+
+ The written description of what this evidence is and how it was created.
+
+
+
+
+
+
+ The output or analysis that supports claims.
+
+
+
+
+
+
+
+ The name of the data.
+
+
+
+
+
+
+ The contents or references to the contents of the data being described.
+
+
+
+
+
+
+ An optional way to include textual or encoded data.
+
+
+
+
+ The URL to where the data can be retrieved.
+
+
+
+
+
+
+
+
+ Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.
+
+
+
+
+
+
+ A description of any sensitive data.
+
+
+
+
+
+
+
+
+
+ The date and time (timestamp) when the evidence was created.
+
+
+
+
+ The optional date and time (timestamp) when the evidence is no longer valid.
+
+
+
+
+ The author of the evidence.
+
+
+
+
+ The reviewer of the evidence.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere
+ in the BOM. Every bom-ref must be unique within the BOM.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ The list of targets which claims are made against.
+
+
+
+
+
+
+
+ The list of organizations which claims are made against.
+
+
+
+
+
+
+
+
+
+
+
+ The list of components which claims are made against.
+
+
+
+
+
+
+
+
+
+
+
+ The list of services which claims are made against.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A concise statement affirmed by an individual regarding all declarations, often used for third-party auditor acceptance or recipient acknowledgment.
+ It includes a list of authorized signatories who assert the validity of the document on behalf of the organization.
+
+
+
+
+
+
+
+ The brief statement affirmed by an individual regarding all declarations.
+ This could be an affirmation of acceptance by a third-party auditor or receiving
+ individual of a file. For example: "I certify, to the best of my knowledge, that all information is correct."
+
+
+
+
+
+
+ The list of signatories authorized on behalf of an organization to assert validity of this document.
+
+
+
+
+
+
+
+
+
+
+ The signatory's name.
+
+
+
+
+
+
+ The signatory's role within an organization.
+
+
+
+
+
+
+ The signatory's organization.
+
+
+
+
+
+
+ An External reference provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+
+
+ A collection of reusable objects that are defined and may be used elsewhere in the BOM.
+
+
+
+
+
+
+
+
+
+
+ The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.
+
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+ A standard may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.
+
+
+
+
+
+
+ The name of the standard. This will often be a shortened, single name of the standard.
+
+
+
+
+
+
+ The version of the standard.
+
+
+
+
+
+
+ The description of the standard.
+
+
+
+
+
+
+ The owner of the standard, often the entity responsible for its release.
+
+
+
+
+
+
+ The list of requirements comprising the standard.
+
+
+
+
+
+
+
+
+
+
+ The unique identifier used in the standard to identify a specific requirement. This should match what is in the standard and should not be the requirements bom-ref.
+
+
+
+
+
+
+ The title of the requirement.
+
+
+
+
+
+
+ The textual content of the requirement.
+
+
+
+
+
+
+ The supplemental text that provides additional guidance or context to the requirement, but is not directly part of the requirement.
+
+
+
+
+
+
+
+
+
+
+
+ The Common Requirements Enumeration (CRE) identifier(s). CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all resources map to each other. Use of CRE promotes clear and unambiguous communication among stakeholders.
+
+
+
+
+
+
+
+
+
+
+
+ The optional `bom-ref` to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements must not define a parent. Only child requirements should define parents.
+
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere
+ in the BOM. Every bom-ref must be unique within the BOM.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+
+ The list of levels associated with the standard. Some standards have different levels of compliance.
+
+
+
+
+
+
+
+
+
+
+ The identifier used in the standard to identify a specific level.
+
+
+
+
+
+
+ The title of the level.
+
+
+
+
+
+
+ The description of the level.
+
+
+
+
+
+
+ The list of requirement `bom-ref`s that comprise the level.
+
+
+
+
+
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere
+ in the BOM. Every bom-ref must be unique within the BOM.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+
+ An optional identifier which can be used to reference the object elsewhere
+ in the BOM. Every bom-ref must be unique within the BOM.
+
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+ Textual strings that aid in discovery, search, and retrieval of the associated
+ object. Tags often serve as a way to group or categorize similar or related objects by various
+ attributes.
+
+ Examples include:
+ "json-parser", "object-persistence", "text-to-image", "translation", and "object-detection"
+
+
+
+
+
+
+
+
+
+
+
+ Provides additional information about a BOM.
+
+
+
+
+ A list of software and hardware components.
+
+
+
+
+ A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services.
+
+
+
+
+ Provides the ability to document external references related to the BOM or
+ to the project the BOM describes.
+
+
+
+
+ Provides the ability to document dependency relationships.
+
+
+
+
+ Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described.
+
+
+
+
+ Provides the ability to document properties in a name/value store.
+ This provides flexibility to include data not officially supported in the standard
+ without having to use additional namespaces or create extensions. Property names
+ of interest to the general public are encouraged to be registered in the
+ CycloneDX Property Taxonomy - https://github.com/CycloneDX/cyclonedx-property-taxonomy.
+ Formal registration is optional.
+
+
+
+
+ Vulnerabilities identified in components or services.
+
+
+
+
+ Comments made by people, organizations, or tools about any object with
+ a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike
+ inventory information, annotations may contain opinion or commentary from various
+ stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link,
+ and may optionally be signed.
+
+
+
+
+ Describes how a component or service was manufactured or deployed. This is
+ achieved through the use of formulas, workflows, tasks, and steps, which declare the precise
+ steps to reproduce along with the observed formulas describing the steps which transpired
+ in the manufacturing process.
+
+
+
+
+
+ The list of declarations which describe the conformance to standards. Each declaration may
+ include attestations, claims, and evidence.
+
+
+
+
+
+
+ A collection of reusable objects that are defined and may be used elsewhere in the BOM.
+
+
+
+
+
+
+ Allows any undeclared elements as long as the elements are placed in a different namespace.
+
+
+
+
+
+
+ Whenever an existing BOM is modified, either manually or through automated
+ processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with
+ multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM.
+ The default version is '1'.
+
+
+
+
+ Every BOM generated SHOULD have a unique serial number, even if the contents of
+ the BOM have not changed over time. If specified, the serial number must conform to RFC-4122.
+ Use of serial numbers are recommended.
+
+
+
+
+ User-defined attributes may be used on this element as long as they
+ do not have the same name as an existing attribute used by the schema.
+
+
+
+
+
+
+
+
+
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/jsf-0.82.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/jsf-0.82.SNAPSHOT.schema.json
new file mode 100644
index 00000000..f46bfb1e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/jsf-0.82.SNAPSHOT.schema.json
@@ -0,0 +1,240 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/jsf-0.82.schema.json",
+ "type": "object",
+ "title": "JSON Signature Format (JSF) standard",
+ "$comment" : "JSON Signature Format schema is published under the terms of the Apache License 2.0. JSF was developed by Anders Rundgren (anders.rundgren.net@gmail.com) as a part of the OpenKeyStore project. This schema supports the entirely of the JSF standard excluding 'extensions'.",
+ "definitions": {
+ "signature": {
+ "type": "object",
+ "title": "Signature",
+ "oneOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "signers": {
+ "type": "array",
+ "title": "Signature",
+ "description": "Unique top level property for Multiple Signatures. (multisignature)",
+ "items": {"$ref": "#/definitions/signer"}
+ }
+ }
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "chain": {
+ "type": "array",
+ "title": "Signature",
+ "description": "Unique top level property for Signature Chains. (signaturechain)",
+ "items": {"$ref": "#/definitions/signer"}
+ }
+ }
+ },
+ {
+ "title": "Signature",
+ "description": "Unique top level property for simple signatures. (signaturecore)",
+ "$ref": "#/definitions/signer"
+ }
+ ]
+ },
+ "signer": {
+ "type": "object",
+ "title": "Signature",
+ "required": [
+ "algorithm",
+ "value"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "algorithm": {
+ "oneOf": [
+ {
+ "type": "string",
+ "title": "Algorithm",
+ "description": "Signature algorithm. The currently recognized JWA [RFC7518] and RFC8037 [RFC8037] asymmetric key algorithms. Note: Unlike RFC8037 [RFC8037] JSF requires explicit Ed* algorithm names instead of \"EdDSA\".",
+ "enum": [
+ "RS256",
+ "RS384",
+ "RS512",
+ "PS256",
+ "PS384",
+ "PS512",
+ "ES256",
+ "ES384",
+ "ES512",
+ "Ed25519",
+ "Ed448",
+ "HS256",
+ "HS384",
+ "HS512"
+ ]
+ },
+ {
+ "type": "string",
+ "title": "Algorithm",
+ "description": "Signature algorithm. Note: If proprietary signature algorithms are added, they must be expressed as URIs.",
+ "format": "uri"
+ }
+ ]
+ },
+ "keyId": {
+ "type": "string",
+ "title": "Key ID",
+ "description": "Optional. Application specific string identifying the signature key."
+ },
+ "publicKey": {
+ "title": "Public key",
+ "description": "Optional. Public key object.",
+ "$ref": "#/definitions/publicKey"
+ },
+ "certificatePath": {
+ "type": "array",
+ "title": "Certificate path",
+ "description": "Optional. Sorted array of X.509 [RFC5280] certificates, where the first element must contain the signature certificate. The certificate path must be contiguous but is not required to be complete.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "excludes": {
+ "type": "array",
+ "title": "Excludes",
+ "description": "Optional. Array holding the names of one or more application level properties that must be excluded from the signature process. Note that the \"excludes\" property itself, must also be excluded from the signature process. Since both the \"excludes\" property and the associated data it points to are unsigned, a conforming JSF implementation must provide options for specifying which properties to accept.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "value": {
+ "type": "string",
+ "title": "Signature",
+ "description": "The signature data. Note that the binary representation must follow the JWA [RFC7518] specifications."
+ }
+ }
+ },
+ "keyType": {
+ "type": "string",
+ "title": "Key type",
+ "description": "Key type indicator.",
+ "enum": [
+ "EC",
+ "OKP",
+ "RSA"
+ ]
+ },
+ "publicKey": {
+ "title": "Public key",
+ "description": "Optional. Public key object.",
+ "type": "object",
+ "required": [
+ "kty"
+ ],
+ "additionalProperties": true,
+ "properties": {
+ "kty": {
+ "$ref": "#/definitions/keyType"
+ }
+ },
+ "allOf": [
+ {
+ "if": {
+ "properties": { "kty": { "const": "EC" } }
+ },
+ "then": {
+ "required": [
+ "kty",
+ "crv",
+ "x",
+ "y"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "kty": {
+ "$ref": "#/definitions/keyType"
+ },
+ "crv": {
+ "type": "string",
+ "title": "Curve name",
+ "description": "EC curve name.",
+ "enum": [
+ "P-256",
+ "P-384",
+ "P-521"
+ ]
+ },
+ "x": {
+ "type": "string",
+ "title": "Coordinate",
+ "description": "EC curve point X. The length of this field must be the full size of a coordinate for the curve specified in the \"crv\" parameter. For example, if the value of \"crv\" is \"P-521\", the decoded argument must be 66 bytes."
+ },
+ "y": {
+ "type": "string",
+ "title": "Coordinate",
+ "description": "EC curve point Y. The length of this field must be the full size of a coordinate for the curve specified in the \"crv\" parameter. For example, if the value of \"crv\" is \"P-256\", the decoded argument must be 32 bytes."
+ }
+ }
+ }
+ },
+ {
+ "if": {
+ "properties": { "kty": { "const": "OKP" } }
+ },
+ "then": {
+ "required": [
+ "kty",
+ "crv",
+ "x"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "kty": {
+ "$ref": "#/definitions/keyType"
+ },
+ "crv": {
+ "type": "string",
+ "title": "Curve name",
+ "description": "EdDSA curve name.",
+ "enum": [
+ "Ed25519",
+ "Ed448"
+ ]
+ },
+ "x": {
+ "type": "string",
+ "title": "Coordinate",
+ "description": "EdDSA curve point X. The length of this field must be the full size of a coordinate for the curve specified in the \"crv\" parameter. For example, if the value of \"crv\" is \"Ed25519\", the decoded argument must be 32 bytes."
+ }
+ }
+ }
+ },
+ {
+ "if": {
+ "properties": { "kty": { "const": "RSA" } }
+ },
+ "then": {
+ "required": [
+ "kty",
+ "n",
+ "e"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "kty": {
+ "$ref": "#/definitions/keyType"
+ },
+ "n": {
+ "type": "string",
+ "title": "Modulus",
+ "description": "RSA modulus."
+ },
+ "e": {
+ "type": "string",
+ "title": "Exponent",
+ "description": "RSA exponent."
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/spdx.SNAPSHOT.schema.json b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/spdx.SNAPSHOT.schema.json
new file mode 100644
index 00000000..3406c45c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/spdx.SNAPSHOT.schema.json
@@ -0,0 +1,737 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "http://cyclonedx.org/schema/spdx.schema.json",
+ "$comment": "v1.0-3.24.0",
+ "type": "string",
+ "enum": [
+ "0BSD",
+ "3D-Slicer-1.0",
+ "AAL",
+ "Abstyles",
+ "AdaCore-doc",
+ "Adobe-2006",
+ "Adobe-Display-PostScript",
+ "Adobe-Glyph",
+ "Adobe-Utopia",
+ "ADSL",
+ "AFL-1.1",
+ "AFL-1.2",
+ "AFL-2.0",
+ "AFL-2.1",
+ "AFL-3.0",
+ "Afmparse",
+ "AGPL-1.0",
+ "AGPL-1.0-only",
+ "AGPL-1.0-or-later",
+ "AGPL-3.0",
+ "AGPL-3.0-only",
+ "AGPL-3.0-or-later",
+ "Aladdin",
+ "AMD-newlib",
+ "AMDPLPA",
+ "AML",
+ "AML-glslang",
+ "AMPAS",
+ "ANTLR-PD",
+ "ANTLR-PD-fallback",
+ "any-OSI",
+ "Apache-1.0",
+ "Apache-1.1",
+ "Apache-2.0",
+ "APAFML",
+ "APL-1.0",
+ "App-s2p",
+ "APSL-1.0",
+ "APSL-1.1",
+ "APSL-1.2",
+ "APSL-2.0",
+ "Arphic-1999",
+ "Artistic-1.0",
+ "Artistic-1.0-cl8",
+ "Artistic-1.0-Perl",
+ "Artistic-2.0",
+ "ASWF-Digital-Assets-1.0",
+ "ASWF-Digital-Assets-1.1",
+ "Baekmuk",
+ "Bahyph",
+ "Barr",
+ "bcrypt-Solar-Designer",
+ "Beerware",
+ "Bitstream-Charter",
+ "Bitstream-Vera",
+ "BitTorrent-1.0",
+ "BitTorrent-1.1",
+ "blessing",
+ "BlueOak-1.0.0",
+ "Boehm-GC",
+ "Borceux",
+ "Brian-Gladman-2-Clause",
+ "Brian-Gladman-3-Clause",
+ "BSD-1-Clause",
+ "BSD-2-Clause",
+ "BSD-2-Clause-Darwin",
+ "BSD-2-Clause-first-lines",
+ "BSD-2-Clause-FreeBSD",
+ "BSD-2-Clause-NetBSD",
+ "BSD-2-Clause-Patent",
+ "BSD-2-Clause-Views",
+ "BSD-3-Clause",
+ "BSD-3-Clause-acpica",
+ "BSD-3-Clause-Attribution",
+ "BSD-3-Clause-Clear",
+ "BSD-3-Clause-flex",
+ "BSD-3-Clause-HP",
+ "BSD-3-Clause-LBNL",
+ "BSD-3-Clause-Modification",
+ "BSD-3-Clause-No-Military-License",
+ "BSD-3-Clause-No-Nuclear-License",
+ "BSD-3-Clause-No-Nuclear-License-2014",
+ "BSD-3-Clause-No-Nuclear-Warranty",
+ "BSD-3-Clause-Open-MPI",
+ "BSD-3-Clause-Sun",
+ "BSD-4-Clause",
+ "BSD-4-Clause-Shortened",
+ "BSD-4-Clause-UC",
+ "BSD-4.3RENO",
+ "BSD-4.3TAHOE",
+ "BSD-Advertising-Acknowledgement",
+ "BSD-Attribution-HPND-disclaimer",
+ "BSD-Inferno-Nettverk",
+ "BSD-Protection",
+ "BSD-Source-beginning-file",
+ "BSD-Source-Code",
+ "BSD-Systemics",
+ "BSD-Systemics-W3Works",
+ "BSL-1.0",
+ "BUSL-1.1",
+ "bzip2-1.0.5",
+ "bzip2-1.0.6",
+ "C-UDA-1.0",
+ "CAL-1.0",
+ "CAL-1.0-Combined-Work-Exception",
+ "Caldera",
+ "Caldera-no-preamble",
+ "Catharon",
+ "CATOSL-1.1",
+ "CC-BY-1.0",
+ "CC-BY-2.0",
+ "CC-BY-2.5",
+ "CC-BY-2.5-AU",
+ "CC-BY-3.0",
+ "CC-BY-3.0-AT",
+ "CC-BY-3.0-AU",
+ "CC-BY-3.0-DE",
+ "CC-BY-3.0-IGO",
+ "CC-BY-3.0-NL",
+ "CC-BY-3.0-US",
+ "CC-BY-4.0",
+ "CC-BY-NC-1.0",
+ "CC-BY-NC-2.0",
+ "CC-BY-NC-2.5",
+ "CC-BY-NC-3.0",
+ "CC-BY-NC-3.0-DE",
+ "CC-BY-NC-4.0",
+ "CC-BY-NC-ND-1.0",
+ "CC-BY-NC-ND-2.0",
+ "CC-BY-NC-ND-2.5",
+ "CC-BY-NC-ND-3.0",
+ "CC-BY-NC-ND-3.0-DE",
+ "CC-BY-NC-ND-3.0-IGO",
+ "CC-BY-NC-ND-4.0",
+ "CC-BY-NC-SA-1.0",
+ "CC-BY-NC-SA-2.0",
+ "CC-BY-NC-SA-2.0-DE",
+ "CC-BY-NC-SA-2.0-FR",
+ "CC-BY-NC-SA-2.0-UK",
+ "CC-BY-NC-SA-2.5",
+ "CC-BY-NC-SA-3.0",
+ "CC-BY-NC-SA-3.0-DE",
+ "CC-BY-NC-SA-3.0-IGO",
+ "CC-BY-NC-SA-4.0",
+ "CC-BY-ND-1.0",
+ "CC-BY-ND-2.0",
+ "CC-BY-ND-2.5",
+ "CC-BY-ND-3.0",
+ "CC-BY-ND-3.0-DE",
+ "CC-BY-ND-4.0",
+ "CC-BY-SA-1.0",
+ "CC-BY-SA-2.0",
+ "CC-BY-SA-2.0-UK",
+ "CC-BY-SA-2.1-JP",
+ "CC-BY-SA-2.5",
+ "CC-BY-SA-3.0",
+ "CC-BY-SA-3.0-AT",
+ "CC-BY-SA-3.0-DE",
+ "CC-BY-SA-3.0-IGO",
+ "CC-BY-SA-4.0",
+ "CC-PDDC",
+ "CC0-1.0",
+ "CDDL-1.0",
+ "CDDL-1.1",
+ "CDL-1.0",
+ "CDLA-Permissive-1.0",
+ "CDLA-Permissive-2.0",
+ "CDLA-Sharing-1.0",
+ "CECILL-1.0",
+ "CECILL-1.1",
+ "CECILL-2.0",
+ "CECILL-2.1",
+ "CECILL-B",
+ "CECILL-C",
+ "CERN-OHL-1.1",
+ "CERN-OHL-1.2",
+ "CERN-OHL-P-2.0",
+ "CERN-OHL-S-2.0",
+ "CERN-OHL-W-2.0",
+ "CFITSIO",
+ "check-cvs",
+ "checkmk",
+ "ClArtistic",
+ "Clips",
+ "CMU-Mach",
+ "CMU-Mach-nodoc",
+ "CNRI-Jython",
+ "CNRI-Python",
+ "CNRI-Python-GPL-Compatible",
+ "COIL-1.0",
+ "Community-Spec-1.0",
+ "Condor-1.1",
+ "copyleft-next-0.3.0",
+ "copyleft-next-0.3.1",
+ "Cornell-Lossless-JPEG",
+ "CPAL-1.0",
+ "CPL-1.0",
+ "CPOL-1.02",
+ "Cronyx",
+ "Crossword",
+ "CrystalStacker",
+ "CUA-OPL-1.0",
+ "Cube",
+ "curl",
+ "cve-tou",
+ "D-FSL-1.0",
+ "DEC-3-Clause",
+ "diffmark",
+ "DL-DE-BY-2.0",
+ "DL-DE-ZERO-2.0",
+ "DOC",
+ "Dotseqn",
+ "DRL-1.0",
+ "DRL-1.1",
+ "DSDP",
+ "dtoa",
+ "dvipdfm",
+ "ECL-1.0",
+ "ECL-2.0",
+ "eCos-2.0",
+ "EFL-1.0",
+ "EFL-2.0",
+ "eGenix",
+ "Elastic-2.0",
+ "Entessa",
+ "EPICS",
+ "EPL-1.0",
+ "EPL-2.0",
+ "ErlPL-1.1",
+ "etalab-2.0",
+ "EUDatagrid",
+ "EUPL-1.0",
+ "EUPL-1.1",
+ "EUPL-1.2",
+ "Eurosym",
+ "Fair",
+ "FBM",
+ "FDK-AAC",
+ "Ferguson-Twofish",
+ "Frameworx-1.0",
+ "FreeBSD-DOC",
+ "FreeImage",
+ "FSFAP",
+ "FSFAP-no-warranty-disclaimer",
+ "FSFUL",
+ "FSFULLR",
+ "FSFULLRWD",
+ "FTL",
+ "Furuseth",
+ "fwlw",
+ "GCR-docs",
+ "GD",
+ "GFDL-1.1",
+ "GFDL-1.1-invariants-only",
+ "GFDL-1.1-invariants-or-later",
+ "GFDL-1.1-no-invariants-only",
+ "GFDL-1.1-no-invariants-or-later",
+ "GFDL-1.1-only",
+ "GFDL-1.1-or-later",
+ "GFDL-1.2",
+ "GFDL-1.2-invariants-only",
+ "GFDL-1.2-invariants-or-later",
+ "GFDL-1.2-no-invariants-only",
+ "GFDL-1.2-no-invariants-or-later",
+ "GFDL-1.2-only",
+ "GFDL-1.2-or-later",
+ "GFDL-1.3",
+ "GFDL-1.3-invariants-only",
+ "GFDL-1.3-invariants-or-later",
+ "GFDL-1.3-no-invariants-only",
+ "GFDL-1.3-no-invariants-or-later",
+ "GFDL-1.3-only",
+ "GFDL-1.3-or-later",
+ "Giftware",
+ "GL2PS",
+ "Glide",
+ "Glulxe",
+ "GLWTPL",
+ "gnuplot",
+ "GPL-1.0",
+ "GPL-1.0+",
+ "GPL-1.0-only",
+ "GPL-1.0-or-later",
+ "GPL-2.0",
+ "GPL-2.0+",
+ "GPL-2.0-only",
+ "GPL-2.0-or-later",
+ "GPL-2.0-with-autoconf-exception",
+ "GPL-2.0-with-bison-exception",
+ "GPL-2.0-with-classpath-exception",
+ "GPL-2.0-with-font-exception",
+ "GPL-2.0-with-GCC-exception",
+ "GPL-3.0",
+ "GPL-3.0+",
+ "GPL-3.0-only",
+ "GPL-3.0-or-later",
+ "GPL-3.0-with-autoconf-exception",
+ "GPL-3.0-with-GCC-exception",
+ "Graphics-Gems",
+ "gSOAP-1.3b",
+ "gtkbook",
+ "Gutmann",
+ "HaskellReport",
+ "hdparm",
+ "Hippocratic-2.1",
+ "HP-1986",
+ "HP-1989",
+ "HPND",
+ "HPND-DEC",
+ "HPND-doc",
+ "HPND-doc-sell",
+ "HPND-export-US",
+ "HPND-export-US-acknowledgement",
+ "HPND-export-US-modify",
+ "HPND-export2-US",
+ "HPND-Fenneberg-Livingston",
+ "HPND-INRIA-IMAG",
+ "HPND-Intel",
+ "HPND-Kevlin-Henney",
+ "HPND-Markus-Kuhn",
+ "HPND-merchantability-variant",
+ "HPND-MIT-disclaimer",
+ "HPND-Pbmplus",
+ "HPND-sell-MIT-disclaimer-xserver",
+ "HPND-sell-regexpr",
+ "HPND-sell-variant",
+ "HPND-sell-variant-MIT-disclaimer",
+ "HPND-sell-variant-MIT-disclaimer-rev",
+ "HPND-UC",
+ "HPND-UC-export-US",
+ "HTMLTIDY",
+ "IBM-pibs",
+ "ICU",
+ "IEC-Code-Components-EULA",
+ "IJG",
+ "IJG-short",
+ "ImageMagick",
+ "iMatix",
+ "Imlib2",
+ "Info-ZIP",
+ "Inner-Net-2.0",
+ "Intel",
+ "Intel-ACPI",
+ "Interbase-1.0",
+ "IPA",
+ "IPL-1.0",
+ "ISC",
+ "ISC-Veillard",
+ "Jam",
+ "JasPer-2.0",
+ "JPL-image",
+ "JPNIC",
+ "JSON",
+ "Kastrup",
+ "Kazlib",
+ "Knuth-CTAN",
+ "LAL-1.2",
+ "LAL-1.3",
+ "Latex2e",
+ "Latex2e-translated-notice",
+ "Leptonica",
+ "LGPL-2.0",
+ "LGPL-2.0+",
+ "LGPL-2.0-only",
+ "LGPL-2.0-or-later",
+ "LGPL-2.1",
+ "LGPL-2.1+",
+ "LGPL-2.1-only",
+ "LGPL-2.1-or-later",
+ "LGPL-3.0",
+ "LGPL-3.0+",
+ "LGPL-3.0-only",
+ "LGPL-3.0-or-later",
+ "LGPLLR",
+ "Libpng",
+ "libpng-2.0",
+ "libselinux-1.0",
+ "libtiff",
+ "libutil-David-Nugent",
+ "LiLiQ-P-1.1",
+ "LiLiQ-R-1.1",
+ "LiLiQ-Rplus-1.1",
+ "Linux-man-pages-1-para",
+ "Linux-man-pages-copyleft",
+ "Linux-man-pages-copyleft-2-para",
+ "Linux-man-pages-copyleft-var",
+ "Linux-OpenIB",
+ "LOOP",
+ "LPD-document",
+ "LPL-1.0",
+ "LPL-1.02",
+ "LPPL-1.0",
+ "LPPL-1.1",
+ "LPPL-1.2",
+ "LPPL-1.3a",
+ "LPPL-1.3c",
+ "lsof",
+ "Lucida-Bitmap-Fonts",
+ "LZMA-SDK-9.11-to-9.20",
+ "LZMA-SDK-9.22",
+ "Mackerras-3-Clause",
+ "Mackerras-3-Clause-acknowledgment",
+ "magaz",
+ "mailprio",
+ "MakeIndex",
+ "Martin-Birgmeier",
+ "McPhee-slideshow",
+ "metamail",
+ "Minpack",
+ "MirOS",
+ "MIT",
+ "MIT-0",
+ "MIT-advertising",
+ "MIT-CMU",
+ "MIT-enna",
+ "MIT-feh",
+ "MIT-Festival",
+ "MIT-Khronos-old",
+ "MIT-Modern-Variant",
+ "MIT-open-group",
+ "MIT-testregex",
+ "MIT-Wu",
+ "MITNFA",
+ "MMIXware",
+ "Motosoto",
+ "MPEG-SSG",
+ "mpi-permissive",
+ "mpich2",
+ "MPL-1.0",
+ "MPL-1.1",
+ "MPL-2.0",
+ "MPL-2.0-no-copyleft-exception",
+ "mplus",
+ "MS-LPL",
+ "MS-PL",
+ "MS-RL",
+ "MTLL",
+ "MulanPSL-1.0",
+ "MulanPSL-2.0",
+ "Multics",
+ "Mup",
+ "NAIST-2003",
+ "NASA-1.3",
+ "Naumen",
+ "NBPL-1.0",
+ "NCBI-PD",
+ "NCGL-UK-2.0",
+ "NCL",
+ "NCSA",
+ "Net-SNMP",
+ "NetCDF",
+ "Newsletr",
+ "NGPL",
+ "NICTA-1.0",
+ "NIST-PD",
+ "NIST-PD-fallback",
+ "NIST-Software",
+ "NLOD-1.0",
+ "NLOD-2.0",
+ "NLPL",
+ "Nokia",
+ "NOSL",
+ "Noweb",
+ "NPL-1.0",
+ "NPL-1.1",
+ "NPOSL-3.0",
+ "NRL",
+ "NTP",
+ "NTP-0",
+ "Nunit",
+ "O-UDA-1.0",
+ "OAR",
+ "OCCT-PL",
+ "OCLC-2.0",
+ "ODbL-1.0",
+ "ODC-By-1.0",
+ "OFFIS",
+ "OFL-1.0",
+ "OFL-1.0-no-RFN",
+ "OFL-1.0-RFN",
+ "OFL-1.1",
+ "OFL-1.1-no-RFN",
+ "OFL-1.1-RFN",
+ "OGC-1.0",
+ "OGDL-Taiwan-1.0",
+ "OGL-Canada-2.0",
+ "OGL-UK-1.0",
+ "OGL-UK-2.0",
+ "OGL-UK-3.0",
+ "OGTSL",
+ "OLDAP-1.1",
+ "OLDAP-1.2",
+ "OLDAP-1.3",
+ "OLDAP-1.4",
+ "OLDAP-2.0",
+ "OLDAP-2.0.1",
+ "OLDAP-2.1",
+ "OLDAP-2.2",
+ "OLDAP-2.2.1",
+ "OLDAP-2.2.2",
+ "OLDAP-2.3",
+ "OLDAP-2.4",
+ "OLDAP-2.5",
+ "OLDAP-2.6",
+ "OLDAP-2.7",
+ "OLDAP-2.8",
+ "OLFL-1.3",
+ "OML",
+ "OpenPBS-2.3",
+ "OpenSSL",
+ "OpenSSL-standalone",
+ "OpenVision",
+ "OPL-1.0",
+ "OPL-UK-3.0",
+ "OPUBL-1.0",
+ "OSET-PL-2.1",
+ "OSL-1.0",
+ "OSL-1.1",
+ "OSL-2.0",
+ "OSL-2.1",
+ "OSL-3.0",
+ "PADL",
+ "Parity-6.0.0",
+ "Parity-7.0.0",
+ "PDDL-1.0",
+ "PHP-3.0",
+ "PHP-3.01",
+ "Pixar",
+ "pkgconf",
+ "Plexus",
+ "pnmstitch",
+ "PolyForm-Noncommercial-1.0.0",
+ "PolyForm-Small-Business-1.0.0",
+ "PostgreSQL",
+ "PPL",
+ "PSF-2.0",
+ "psfrag",
+ "psutils",
+ "Python-2.0",
+ "Python-2.0.1",
+ "python-ldap",
+ "Qhull",
+ "QPL-1.0",
+ "QPL-1.0-INRIA-2004",
+ "radvd",
+ "Rdisc",
+ "RHeCos-1.1",
+ "RPL-1.1",
+ "RPL-1.5",
+ "RPSL-1.0",
+ "RSA-MD",
+ "RSCPL",
+ "Ruby",
+ "SAX-PD",
+ "SAX-PD-2.0",
+ "Saxpath",
+ "SCEA",
+ "SchemeReport",
+ "Sendmail",
+ "Sendmail-8.23",
+ "SGI-B-1.0",
+ "SGI-B-1.1",
+ "SGI-B-2.0",
+ "SGI-OpenGL",
+ "SGP4",
+ "SHL-0.5",
+ "SHL-0.51",
+ "SimPL-2.0",
+ "SISSL",
+ "SISSL-1.2",
+ "SL",
+ "Sleepycat",
+ "SMLNJ",
+ "SMPPL",
+ "SNIA",
+ "snprintf",
+ "softSurfer",
+ "Soundex",
+ "Spencer-86",
+ "Spencer-94",
+ "Spencer-99",
+ "SPL-1.0",
+ "ssh-keyscan",
+ "SSH-OpenSSH",
+ "SSH-short",
+ "SSLeay-standalone",
+ "SSPL-1.0",
+ "StandardML-NJ",
+ "SugarCRM-1.1.3",
+ "Sun-PPP",
+ "Sun-PPP-2000",
+ "SunPro",
+ "SWL",
+ "swrule",
+ "Symlinks",
+ "TAPR-OHL-1.0",
+ "TCL",
+ "TCP-wrappers",
+ "TermReadKey",
+ "TGPPL-1.0",
+ "threeparttable",
+ "TMate",
+ "TORQUE-1.1",
+ "TOSL",
+ "TPDL",
+ "TPL-1.0",
+ "TTWL",
+ "TTYP0",
+ "TU-Berlin-1.0",
+ "TU-Berlin-2.0",
+ "UCAR",
+ "UCL-1.0",
+ "ulem",
+ "UMich-Merit",
+ "Unicode-3.0",
+ "Unicode-DFS-2015",
+ "Unicode-DFS-2016",
+ "Unicode-TOU",
+ "UnixCrypt",
+ "Unlicense",
+ "UPL-1.0",
+ "URT-RLE",
+ "Vim",
+ "VOSTROM",
+ "VSL-1.0",
+ "W3C",
+ "W3C-19980720",
+ "W3C-20150513",
+ "w3m",
+ "Watcom-1.0",
+ "Widget-Workshop",
+ "Wsuipa",
+ "WTFPL",
+ "wxWindows",
+ "X11",
+ "X11-distribute-modifications-variant",
+ "Xdebug-1.03",
+ "Xerox",
+ "Xfig",
+ "XFree86-1.1",
+ "xinetd",
+ "xkeyboard-config-Zinoviev",
+ "xlock",
+ "Xnet",
+ "xpp",
+ "XSkat",
+ "xzoom",
+ "YPL-1.0",
+ "YPL-1.1",
+ "Zed",
+ "Zeeff",
+ "Zend-2.0",
+ "Zimbra-1.3",
+ "Zimbra-1.4",
+ "Zlib",
+ "zlib-acknowledgement",
+ "ZPL-1.1",
+ "ZPL-2.0",
+ "ZPL-2.1",
+ "389-exception",
+ "Asterisk-exception",
+ "Asterisk-linking-protocols-exception",
+ "Autoconf-exception-2.0",
+ "Autoconf-exception-3.0",
+ "Autoconf-exception-generic",
+ "Autoconf-exception-generic-3.0",
+ "Autoconf-exception-macro",
+ "Bison-exception-1.24",
+ "Bison-exception-2.2",
+ "Bootloader-exception",
+ "Classpath-exception-2.0",
+ "CLISP-exception-2.0",
+ "cryptsetup-OpenSSL-exception",
+ "DigiRule-FOSS-exception",
+ "eCos-exception-2.0",
+ "Fawkes-Runtime-exception",
+ "FLTK-exception",
+ "fmt-exception",
+ "Font-exception-2.0",
+ "freertos-exception-2.0",
+ "GCC-exception-2.0",
+ "GCC-exception-2.0-note",
+ "GCC-exception-3.1",
+ "Gmsh-exception",
+ "GNAT-exception",
+ "GNOME-examples-exception",
+ "GNU-compiler-exception",
+ "gnu-javamail-exception",
+ "GPL-3.0-interface-exception",
+ "GPL-3.0-linking-exception",
+ "GPL-3.0-linking-source-exception",
+ "GPL-CC-1.0",
+ "GStreamer-exception-2005",
+ "GStreamer-exception-2008",
+ "i2p-gpl-java-exception",
+ "KiCad-libraries-exception",
+ "LGPL-3.0-linking-exception",
+ "libpri-OpenH323-exception",
+ "Libtool-exception",
+ "Linux-syscall-note",
+ "LLGPL",
+ "LLVM-exception",
+ "LZMA-exception",
+ "mif-exception",
+ "Nokia-Qt-exception-1.1",
+ "OCaml-LGPL-linking-exception",
+ "OCCT-exception-1.0",
+ "OpenJDK-assembly-exception-1.0",
+ "openvpn-openssl-exception",
+ "PCRE2-exception",
+ "PS-or-PDF-font-exception-20170817",
+ "QPL-1.0-INRIA-2004-exception",
+ "Qt-GPL-exception-1.0",
+ "Qt-LGPL-exception-1.1",
+ "Qwt-exception-1.0",
+ "RRDtool-FLOSS-exception-2.0",
+ "SANE-exception",
+ "SHL-2.0",
+ "SHL-2.1",
+ "stunnel-exception",
+ "SWI-exception",
+ "Swift-exception",
+ "Texinfo-exception",
+ "u-boot-exception-2.0",
+ "UBDL-exception",
+ "Universal-FOSS-exception-1.0",
+ "vsftpd-openssl-exception",
+ "WxWindows-exception-3.1",
+ "x11vnc-openssl-exception"
+ ]
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/spdx.SNAPSHOT.xsd b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/spdx.SNAPSHOT.xsd
new file mode 100644
index 00000000..a339a085
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/_res/spdx.SNAPSHOT.xsd
@@ -0,0 +1,3659 @@
+
+
+
+
+
+
+
+
+ BSD Zero Clause License
+
+
+
+
+ 3D Slicer License v1.0
+
+
+
+
+ Attribution Assurance License
+
+
+
+
+ Abstyles License
+
+
+
+
+ AdaCore Doc License
+
+
+
+
+ Adobe Systems Incorporated Source Code License Agreement
+
+
+
+
+ Adobe Display PostScript License
+
+
+
+
+ Adobe Glyph List License
+
+
+
+
+ Adobe Utopia Font License
+
+
+
+
+ Amazon Digital Services License
+
+
+
+
+ Academic Free License v1.1
+
+
+
+
+ Academic Free License v1.2
+
+
+
+
+ Academic Free License v2.0
+
+
+
+
+ Academic Free License v2.1
+
+
+
+
+ Academic Free License v3.0
+
+
+
+
+ Afmparse License
+
+
+
+
+ Affero General Public License v1.0
+
+
+
+
+ Affero General Public License v1.0 only
+
+
+
+
+ Affero General Public License v1.0 or later
+
+
+
+
+ GNU Affero General Public License v3.0
+
+
+
+
+ GNU Affero General Public License v3.0 only
+
+
+
+
+ GNU Affero General Public License v3.0 or later
+
+
+
+
+ Aladdin Free Public License
+
+
+
+
+ AMD newlib License
+
+
+
+
+ AMD's plpa_map.c License
+
+
+
+
+ Apple MIT License
+
+
+
+
+ AML glslang variant License
+
+
+
+
+ Academy of Motion Picture Arts and Sciences BSD
+
+
+
+
+ ANTLR Software Rights Notice
+
+
+
+
+ ANTLR Software Rights Notice with license fallback
+
+
+
+
+ Any OSI License
+
+
+
+
+ Apache License 1.0
+
+
+
+
+ Apache License 1.1
+
+
+
+
+ Apache License 2.0
+
+
+
+
+ Adobe Postscript AFM License
+
+
+
+
+ Adaptive Public License 1.0
+
+
+
+
+ App::s2p License
+
+
+
+
+ Apple Public Source License 1.0
+
+
+
+
+ Apple Public Source License 1.1
+
+
+
+
+ Apple Public Source License 1.2
+
+
+
+
+ Apple Public Source License 2.0
+
+
+
+
+ Arphic Public License
+
+
+
+
+ Artistic License 1.0
+
+
+
+
+ Artistic License 1.0 w/clause 8
+
+
+
+
+ Artistic License 1.0 (Perl)
+
+
+
+
+ Artistic License 2.0
+
+
+
+
+ ASWF Digital Assets License version 1.0
+
+
+
+
+ ASWF Digital Assets License 1.1
+
+
+
+
+ Baekmuk License
+
+
+
+
+ Bahyph License
+
+
+
+
+ Barr License
+
+
+
+
+ bcrypt Solar Designer License
+
+
+
+
+ Beerware License
+
+
+
+
+ Bitstream Charter Font License
+
+
+
+
+ Bitstream Vera Font License
+
+
+
+
+ BitTorrent Open Source License v1.0
+
+
+
+
+ BitTorrent Open Source License v1.1
+
+
+
+
+ SQLite Blessing
+
+
+
+
+ Blue Oak Model License 1.0.0
+
+
+
+
+ Boehm-Demers-Weiser GC License
+
+
+
+
+ Borceux license
+
+
+
+
+ Brian Gladman 2-Clause License
+
+
+
+
+ Brian Gladman 3-Clause License
+
+
+
+
+ BSD 1-Clause License
+
+
+
+
+ BSD 2-Clause "Simplified" License
+
+
+
+
+ BSD 2-Clause - Ian Darwin variant
+
+
+
+
+ BSD 2-Clause - first lines requirement
+
+
+
+
+ BSD 2-Clause FreeBSD License
+
+
+
+
+ BSD 2-Clause NetBSD License
+
+
+
+
+ BSD-2-Clause Plus Patent License
+
+
+
+
+ BSD 2-Clause with views sentence
+
+
+
+
+ BSD 3-Clause "New" or "Revised" License
+
+
+
+
+ BSD 3-Clause acpica variant
+
+
+
+
+ BSD with attribution
+
+
+
+
+ BSD 3-Clause Clear License
+
+
+
+
+ BSD 3-Clause Flex variant
+
+
+
+
+ Hewlett-Packard BSD variant license
+
+
+
+
+ Lawrence Berkeley National Labs BSD variant license
+
+
+
+
+ BSD 3-Clause Modification
+
+
+
+
+ BSD 3-Clause No Military License
+
+
+
+
+ BSD 3-Clause No Nuclear License
+
+
+
+
+ BSD 3-Clause No Nuclear License 2014
+
+
+
+
+ BSD 3-Clause No Nuclear Warranty
+
+
+
+
+ BSD 3-Clause Open MPI variant
+
+
+
+
+ BSD 3-Clause Sun Microsystems
+
+
+
+
+ BSD 4-Clause "Original" or "Old" License
+
+
+
+
+ BSD 4 Clause Shortened
+
+
+
+
+ BSD-4-Clause (University of California-Specific)
+
+
+
+
+ BSD 4.3 RENO License
+
+
+
+
+ BSD 4.3 TAHOE License
+
+
+
+
+ BSD Advertising Acknowledgement License
+
+
+
+
+ BSD with Attribution and HPND disclaimer
+
+
+
+
+ BSD-Inferno-Nettverk
+
+
+
+
+ BSD Protection License
+
+
+
+
+ BSD Source Code Attribution - beginning of file variant
+
+
+
+
+ BSD Source Code Attribution
+
+
+
+
+ Systemics BSD variant license
+
+
+
+
+ Systemics W3Works BSD variant license
+
+
+
+
+ Boost Software License 1.0
+
+
+
+
+ Business Source License 1.1
+
+
+
+
+ bzip2 and libbzip2 License v1.0.5
+
+
+
+
+ bzip2 and libbzip2 License v1.0.6
+
+
+
+
+ Computational Use of Data Agreement v1.0
+
+
+
+
+ Cryptographic Autonomy License 1.0
+
+
+
+
+ Cryptographic Autonomy License 1.0 (Combined Work Exception)
+
+
+
+
+ Caldera License
+
+
+
+
+ Caldera License (without preamble)
+
+
+
+
+ Catharon License
+
+
+
+
+ Computer Associates Trusted Open Source License 1.1
+
+
+
+
+ Creative Commons Attribution 1.0 Generic
+
+
+
+
+ Creative Commons Attribution 2.0 Generic
+
+
+
+
+ Creative Commons Attribution 2.5 Generic
+
+
+
+
+ Creative Commons Attribution 2.5 Australia
+
+
+
+
+ Creative Commons Attribution 3.0 Unported
+
+
+
+
+ Creative Commons Attribution 3.0 Austria
+
+
+
+
+ Creative Commons Attribution 3.0 Australia
+
+
+
+
+ Creative Commons Attribution 3.0 Germany
+
+
+
+
+ Creative Commons Attribution 3.0 IGO
+
+
+
+
+ Creative Commons Attribution 3.0 Netherlands
+
+
+
+
+ Creative Commons Attribution 3.0 United States
+
+
+
+
+ Creative Commons Attribution 4.0 International
+
+
+
+
+ Creative Commons Attribution Non Commercial 1.0 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial 2.0 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial 2.5 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial 3.0 Unported
+
+
+
+
+ Creative Commons Attribution Non Commercial 3.0 Germany
+
+
+
+
+ Creative Commons Attribution Non Commercial 4.0 International
+
+
+
+
+ Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported
+
+
+
+
+ Creative Commons Attribution Non Commercial No Derivatives 3.0 Germany
+
+
+
+
+ Creative Commons Attribution Non Commercial No Derivatives 3.0 IGO
+
+
+
+
+ Creative Commons Attribution Non Commercial No Derivatives 4.0 International
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 1.0 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 2.0 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 2.0 Germany
+
+
+
+
+ Creative Commons Attribution-NonCommercial-ShareAlike 2.0 France
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 2.0 England and Wales
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 2.5 Generic
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 3.0 Unported
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 3.0 Germany
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 3.0 IGO
+
+
+
+
+ Creative Commons Attribution Non Commercial Share Alike 4.0 International
+
+
+
+
+ Creative Commons Attribution No Derivatives 1.0 Generic
+
+
+
+
+ Creative Commons Attribution No Derivatives 2.0 Generic
+
+
+
+
+ Creative Commons Attribution No Derivatives 2.5 Generic
+
+
+
+
+ Creative Commons Attribution No Derivatives 3.0 Unported
+
+
+
+
+ Creative Commons Attribution No Derivatives 3.0 Germany
+
+
+
+
+ Creative Commons Attribution No Derivatives 4.0 International
+
+
+
+
+ Creative Commons Attribution Share Alike 1.0 Generic
+
+
+
+
+ Creative Commons Attribution Share Alike 2.0 Generic
+
+
+
+
+ Creative Commons Attribution Share Alike 2.0 England and Wales
+
+
+
+
+ Creative Commons Attribution Share Alike 2.1 Japan
+
+
+
+
+ Creative Commons Attribution Share Alike 2.5 Generic
+
+
+
+
+ Creative Commons Attribution Share Alike 3.0 Unported
+
+
+
+
+ Creative Commons Attribution Share Alike 3.0 Austria
+
+
+
+
+ Creative Commons Attribution Share Alike 3.0 Germany
+
+
+
+
+ Creative Commons Attribution-ShareAlike 3.0 IGO
+
+
+
+
+ Creative Commons Attribution Share Alike 4.0 International
+
+
+
+
+ Creative Commons Public Domain Dedication and Certification
+
+
+
+
+ Creative Commons Zero v1.0 Universal
+
+
+
+
+ Common Development and Distribution License 1.0
+
+
+
+
+ Common Development and Distribution License 1.1
+
+
+
+
+ Common Documentation License 1.0
+
+
+
+
+ Community Data License Agreement Permissive 1.0
+
+
+
+
+ Community Data License Agreement Permissive 2.0
+
+
+
+
+ Community Data License Agreement Sharing 1.0
+
+
+
+
+ CeCILL Free Software License Agreement v1.0
+
+
+
+
+ CeCILL Free Software License Agreement v1.1
+
+
+
+
+ CeCILL Free Software License Agreement v2.0
+
+
+
+
+ CeCILL Free Software License Agreement v2.1
+
+
+
+
+ CeCILL-B Free Software License Agreement
+
+
+
+
+ CeCILL-C Free Software License Agreement
+
+
+
+
+ CERN Open Hardware Licence v1.1
+
+
+
+
+ CERN Open Hardware Licence v1.2
+
+
+
+
+ CERN Open Hardware Licence Version 2 - Permissive
+
+
+
+
+ CERN Open Hardware Licence Version 2 - Strongly Reciprocal
+
+
+
+
+ CERN Open Hardware Licence Version 2 - Weakly Reciprocal
+
+
+
+
+ CFITSIO License
+
+
+
+
+ check-cvs License
+
+
+
+
+ Checkmk License
+
+
+
+
+ Clarified Artistic License
+
+
+
+
+ Clips License
+
+
+
+
+ CMU Mach License
+
+
+
+
+ CMU Mach - no notices-in-documentation variant
+
+
+
+
+ CNRI Jython License
+
+
+
+
+ CNRI Python License
+
+
+
+
+ CNRI Python Open Source GPL Compatible License Agreement
+
+
+
+
+ Copyfree Open Innovation License
+
+
+
+
+ Community Specification License 1.0
+
+
+
+
+ Condor Public License v1.1
+
+
+
+
+ copyleft-next 0.3.0
+
+
+
+
+ copyleft-next 0.3.1
+
+
+
+
+ Cornell Lossless JPEG License
+
+
+
+
+ Common Public Attribution License 1.0
+
+
+
+
+ Common Public License 1.0
+
+
+
+
+ Code Project Open License 1.02
+
+
+
+
+ Cronyx License
+
+
+
+
+ Crossword License
+
+
+
+
+ CrystalStacker License
+
+
+
+
+ CUA Office Public License v1.0
+
+
+
+
+ Cube License
+
+
+
+
+ curl License
+
+
+
+
+ Common Vulnerability Enumeration ToU License
+
+
+
+
+ Deutsche Freie Software Lizenz
+
+
+
+
+ DEC 3-Clause License
+
+
+
+
+ diffmark license
+
+
+
+
+ Data licence Germany – attribution – version 2.0
+
+
+
+
+ Data licence Germany – zero – version 2.0
+
+
+
+
+ DOC License
+
+
+
+
+ Dotseqn License
+
+
+
+
+ Detection Rule License 1.0
+
+
+
+
+ Detection Rule License 1.1
+
+
+
+
+ DSDP License
+
+
+
+
+ David M. Gay dtoa License
+
+
+
+
+ dvipdfm License
+
+
+
+
+ Educational Community License v1.0
+
+
+
+
+ Educational Community License v2.0
+
+
+
+
+ eCos license version 2.0
+
+
+
+
+ Eiffel Forum License v1.0
+
+
+
+
+ Eiffel Forum License v2.0
+
+
+
+
+ eGenix.com Public License 1.1.0
+
+
+
+
+ Elastic License 2.0
+
+
+
+
+ Entessa Public License v1.0
+
+
+
+
+ EPICS Open License
+
+
+
+
+ Eclipse Public License 1.0
+
+
+
+
+ Eclipse Public License 2.0
+
+
+
+
+ Erlang Public License v1.1
+
+
+
+
+ Etalab Open License 2.0
+
+
+
+
+ EU DataGrid Software License
+
+
+
+
+ European Union Public License 1.0
+
+
+
+
+ European Union Public License 1.1
+
+
+
+
+ European Union Public License 1.2
+
+
+
+
+ Eurosym License
+
+
+
+
+ Fair License
+
+
+
+
+ Fuzzy Bitmap License
+
+
+
+
+ Fraunhofer FDK AAC Codec Library
+
+
+
+
+ Ferguson Twofish License
+
+
+
+
+ Frameworx Open License 1.0
+
+
+
+
+ FreeBSD Documentation License
+
+
+
+
+ FreeImage Public License v1.0
+
+
+
+
+ FSF All Permissive License
+
+
+
+
+ FSF All Permissive License (without Warranty)
+
+
+
+
+ FSF Unlimited License
+
+
+
+
+ FSF Unlimited License (with License Retention)
+
+
+
+
+ FSF Unlimited License (With License Retention and Warranty Disclaimer)
+
+
+
+
+ Freetype Project License
+
+
+
+
+ Furuseth License
+
+
+
+
+ fwlw License
+
+
+
+
+ Gnome GCR Documentation License
+
+
+
+
+ GD License
+
+
+
+
+ GNU Free Documentation License v1.1
+
+
+
+
+ GNU Free Documentation License v1.1 only - invariants
+
+
+
+
+ GNU Free Documentation License v1.1 or later - invariants
+
+
+
+
+ GNU Free Documentation License v1.1 only - no invariants
+
+
+
+
+ GNU Free Documentation License v1.1 or later - no invariants
+
+
+
+
+ GNU Free Documentation License v1.1 only
+
+
+
+
+ GNU Free Documentation License v1.1 or later
+
+
+
+
+ GNU Free Documentation License v1.2
+
+
+
+
+ GNU Free Documentation License v1.2 only - invariants
+
+
+
+
+ GNU Free Documentation License v1.2 or later - invariants
+
+
+
+
+ GNU Free Documentation License v1.2 only - no invariants
+
+
+
+
+ GNU Free Documentation License v1.2 or later - no invariants
+
+
+
+
+ GNU Free Documentation License v1.2 only
+
+
+
+
+ GNU Free Documentation License v1.2 or later
+
+
+
+
+ GNU Free Documentation License v1.3
+
+
+
+
+ GNU Free Documentation License v1.3 only - invariants
+
+
+
+
+ GNU Free Documentation License v1.3 or later - invariants
+
+
+
+
+ GNU Free Documentation License v1.3 only - no invariants
+
+
+
+
+ GNU Free Documentation License v1.3 or later - no invariants
+
+
+
+
+ GNU Free Documentation License v1.3 only
+
+
+
+
+ GNU Free Documentation License v1.3 or later
+
+
+
+
+ Giftware License
+
+
+
+
+ GL2PS License
+
+
+
+
+ 3dfx Glide License
+
+
+
+
+ Glulxe License
+
+
+
+
+ Good Luck With That Public License
+
+
+
+
+ gnuplot License
+
+
+
+
+ GNU General Public License v1.0 only
+
+
+
+
+ GNU General Public License v1.0 or later
+
+
+
+
+ GNU General Public License v1.0 only
+
+
+
+
+ GNU General Public License v1.0 or later
+
+
+
+
+ GNU General Public License v2.0 only
+
+
+
+
+ GNU General Public License v2.0 or later
+
+
+
+
+ GNU General Public License v2.0 only
+
+
+
+
+ GNU General Public License v2.0 or later
+
+
+
+
+ GNU General Public License v2.0 w/Autoconf exception
+
+
+
+
+ GNU General Public License v2.0 w/Bison exception
+
+
+
+
+ GNU General Public License v2.0 w/Classpath exception
+
+
+
+
+ GNU General Public License v2.0 w/Font exception
+
+
+
+
+ GNU General Public License v2.0 w/GCC Runtime Library exception
+
+
+
+
+ GNU General Public License v3.0 only
+
+
+
+
+ GNU General Public License v3.0 or later
+
+
+
+
+ GNU General Public License v3.0 only
+
+
+
+
+ GNU General Public License v3.0 or later
+
+
+
+
+ GNU General Public License v3.0 w/Autoconf exception
+
+
+
+
+ GNU General Public License v3.0 w/GCC Runtime Library exception
+
+
+
+
+ Graphics Gems License
+
+
+
+
+ gSOAP Public License v1.3b
+
+
+
+
+ gtkbook License
+
+
+
+
+ Gutmann License
+
+
+
+
+ Haskell Language Report License
+
+
+
+
+ hdparm License
+
+
+
+
+ Hippocratic License 2.1
+
+
+
+
+ Hewlett-Packard 1986 License
+
+
+
+
+ Hewlett-Packard 1989 License
+
+
+
+
+ Historical Permission Notice and Disclaimer
+
+
+
+
+ Historical Permission Notice and Disclaimer - DEC variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - documentation variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - documentation sell variant
+
+
+
+
+ HPND with US Government export control warning
+
+
+
+
+ HPND with US Government export control warning and acknowledgment
+
+
+
+
+ HPND with US Government export control warning and modification rqmt
+
+
+
+
+ HPND with US Government export control and 2 disclaimers
+
+
+
+
+ Historical Permission Notice and Disclaimer - Fenneberg-Livingston variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - INRIA-IMAG variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - Intel variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - Kevlin Henney variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - Markus Kuhn variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - merchantability variant
+
+
+
+
+ Historical Permission Notice and Disclaimer with MIT disclaimer
+
+
+
+
+ Historical Permission Notice and Disclaimer - Pbmplus variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - sell xserver variant with MIT disclaimer
+
+
+
+
+ Historical Permission Notice and Disclaimer - sell regexpr variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - sell variant
+
+
+
+
+ HPND sell variant with MIT disclaimer
+
+
+
+
+ HPND sell variant with MIT disclaimer - reverse
+
+
+
+
+ Historical Permission Notice and Disclaimer - University of California variant
+
+
+
+
+ Historical Permission Notice and Disclaimer - University of California, US export warning
+
+
+
+
+ HTML Tidy License
+
+
+
+
+ IBM PowerPC Initialization and Boot Software
+
+
+
+
+ ICU License
+
+
+
+
+ IEC Code Components End-user licence agreement
+
+
+
+
+ Independent JPEG Group License
+
+
+
+
+ Independent JPEG Group License - short
+
+
+
+
+ ImageMagick License
+
+
+
+
+ iMatix Standard Function Library Agreement
+
+
+
+
+ Imlib2 License
+
+
+
+
+ Info-ZIP License
+
+
+
+
+ Inner Net License v2.0
+
+
+
+
+ Intel Open Source License
+
+
+
+
+ Intel ACPI Software License Agreement
+
+
+
+
+ Interbase Public License v1.0
+
+
+
+
+ IPA Font License
+
+
+
+
+ IBM Public License v1.0
+
+
+
+
+ ISC License
+
+
+
+
+ ISC Veillard variant
+
+
+
+
+ Jam License
+
+
+
+
+ JasPer License
+
+
+
+
+ JPL Image Use Policy
+
+
+
+
+ Japan Network Information Center License
+
+
+
+
+ JSON License
+
+
+
+
+ Kastrup License
+
+
+
+
+ Kazlib License
+
+
+
+
+ Knuth CTAN License
+
+
+
+
+ Licence Art Libre 1.2
+
+
+
+
+ Licence Art Libre 1.3
+
+
+
+
+ Latex2e License
+
+
+
+
+ Latex2e with translated notice permission
+
+
+
+
+ Leptonica License
+
+
+
+
+ GNU Library General Public License v2 only
+
+
+
+
+ GNU Library General Public License v2 or later
+
+
+
+
+ GNU Library General Public License v2 only
+
+
+
+
+ GNU Library General Public License v2 or later
+
+
+
+
+ GNU Lesser General Public License v2.1 only
+
+
+
+
+ GNU Lesser General Public License v2.1 or later
+
+
+
+
+ GNU Lesser General Public License v2.1 only
+
+
+
+
+ GNU Lesser General Public License v2.1 or later
+
+
+
+
+ GNU Lesser General Public License v3.0 only
+
+
+
+
+ GNU Lesser General Public License v3.0 or later
+
+
+
+
+ GNU Lesser General Public License v3.0 only
+
+
+
+
+ GNU Lesser General Public License v3.0 or later
+
+
+
+
+ Lesser General Public License For Linguistic Resources
+
+
+
+
+ libpng License
+
+
+
+
+ PNG Reference Library version 2
+
+
+
+
+ libselinux public domain notice
+
+
+
+
+ libtiff License
+
+
+
+
+ libutil David Nugent License
+
+
+
+
+ Licence Libre du Québec – Permissive version 1.1
+
+
+
+
+ Licence Libre du Québec – Réciprocité version 1.1
+
+
+
+
+ Licence Libre du Québec – Réciprocité forte version 1.1
+
+
+
+
+ Linux man-pages - 1 paragraph
+
+
+
+
+ Linux man-pages Copyleft
+
+
+
+
+ Linux man-pages Copyleft - 2 paragraphs
+
+
+
+
+ Linux man-pages Copyleft Variant
+
+
+
+
+ Linux Kernel Variant of OpenIB.org license
+
+
+
+
+ Common Lisp LOOP License
+
+
+
+
+ LPD Documentation License
+
+
+
+
+ Lucent Public License Version 1.0
+
+
+
+
+ Lucent Public License v1.02
+
+
+
+
+ LaTeX Project Public License v1.0
+
+
+
+
+ LaTeX Project Public License v1.1
+
+
+
+
+ LaTeX Project Public License v1.2
+
+
+
+
+ LaTeX Project Public License v1.3a
+
+
+
+
+ LaTeX Project Public License v1.3c
+
+
+
+
+ lsof License
+
+
+
+
+ Lucida Bitmap Fonts License
+
+
+
+
+ LZMA SDK License (versions 9.11 to 9.20)
+
+
+
+
+ LZMA SDK License (versions 9.22 and beyond)
+
+
+
+
+ Mackerras 3-Clause License
+
+
+
+
+ Mackerras 3-Clause - acknowledgment variant
+
+
+
+
+ magaz License
+
+
+
+
+ mailprio License
+
+
+
+
+ MakeIndex License
+
+
+
+
+ Martin Birgmeier License
+
+
+
+
+ McPhee Slideshow License
+
+
+
+
+ metamail License
+
+
+
+
+ Minpack License
+
+
+
+
+ The MirOS Licence
+
+
+
+
+ MIT License
+
+
+
+
+ MIT No Attribution
+
+
+
+
+ Enlightenment License (e16)
+
+
+
+
+ CMU License
+
+
+
+
+ enna License
+
+
+
+
+ feh License
+
+
+
+
+ MIT Festival Variant
+
+
+
+
+ MIT Khronos - old variant
+
+
+
+
+ MIT License Modern Variant
+
+
+
+
+ MIT Open Group variant
+
+
+
+
+ MIT testregex Variant
+
+
+
+
+ MIT Tom Wu Variant
+
+
+
+
+ MIT +no-false-attribs license
+
+
+
+
+ MMIXware License
+
+
+
+
+ Motosoto License
+
+
+
+
+ MPEG Software Simulation
+
+
+
+
+ mpi Permissive License
+
+
+
+
+ mpich2 License
+
+
+
+
+ Mozilla Public License 1.0
+
+
+
+
+ Mozilla Public License 1.1
+
+
+
+
+ Mozilla Public License 2.0
+
+
+
+
+ Mozilla Public License 2.0 (no copyleft exception)
+
+
+
+
+ mplus Font License
+
+
+
+
+ Microsoft Limited Public License
+
+
+
+
+ Microsoft Public License
+
+
+
+
+ Microsoft Reciprocal License
+
+
+
+
+ Matrix Template Library License
+
+
+
+
+ Mulan Permissive Software License, Version 1
+
+
+
+
+ Mulan Permissive Software License, Version 2
+
+
+
+
+ Multics License
+
+
+
+
+ Mup License
+
+
+
+
+ Nara Institute of Science and Technology License (2003)
+
+
+
+
+ NASA Open Source Agreement 1.3
+
+
+
+
+ Naumen Public License
+
+
+
+
+ Net Boolean Public License v1
+
+
+
+
+ NCBI Public Domain Notice
+
+
+
+
+ Non-Commercial Government Licence
+
+
+
+
+ NCL Source Code License
+
+
+
+
+ University of Illinois/NCSA Open Source License
+
+
+
+
+ Net-SNMP License
+
+
+
+
+ NetCDF license
+
+
+
+
+ Newsletr License
+
+
+
+
+ Nethack General Public License
+
+
+
+
+ NICTA Public Software License, Version 1.0
+
+
+
+
+ NIST Public Domain Notice
+
+
+
+
+ NIST Public Domain Notice with license fallback
+
+
+
+
+ NIST Software License
+
+
+
+
+ Norwegian Licence for Open Government Data (NLOD) 1.0
+
+
+
+
+ Norwegian Licence for Open Government Data (NLOD) 2.0
+
+
+
+
+ No Limit Public License
+
+
+
+
+ Nokia Open Source License
+
+
+
+
+ Netizen Open Source License
+
+
+
+
+ Noweb License
+
+
+
+
+ Netscape Public License v1.0
+
+
+
+
+ Netscape Public License v1.1
+
+
+
+
+ Non-Profit Open Software License 3.0
+
+
+
+
+ NRL License
+
+
+
+
+ NTP License
+
+
+
+
+ NTP No Attribution
+
+
+
+
+ Nunit License
+
+
+
+
+ Open Use of Data Agreement v1.0
+
+
+
+
+ OAR License
+
+
+
+
+ Open CASCADE Technology Public License
+
+
+
+
+ OCLC Research Public License 2.0
+
+
+
+
+ Open Data Commons Open Database License v1.0
+
+
+
+
+ Open Data Commons Attribution License v1.0
+
+
+
+
+ OFFIS License
+
+
+
+
+ SIL Open Font License 1.0
+
+
+
+
+ SIL Open Font License 1.0 with no Reserved Font Name
+
+
+
+
+ SIL Open Font License 1.0 with Reserved Font Name
+
+
+
+
+ SIL Open Font License 1.1
+
+
+
+
+ SIL Open Font License 1.1 with no Reserved Font Name
+
+
+
+
+ SIL Open Font License 1.1 with Reserved Font Name
+
+
+
+
+ OGC Software License, Version 1.0
+
+
+
+
+ Taiwan Open Government Data License, version 1.0
+
+
+
+
+ Open Government Licence - Canada
+
+
+
+
+ Open Government Licence v1.0
+
+
+
+
+ Open Government Licence v2.0
+
+
+
+
+ Open Government Licence v3.0
+
+
+
+
+ Open Group Test Suite License
+
+
+
+
+ Open LDAP Public License v1.1
+
+
+
+
+ Open LDAP Public License v1.2
+
+
+
+
+ Open LDAP Public License v1.3
+
+
+
+
+ Open LDAP Public License v1.4
+
+
+
+
+ Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B)
+
+
+
+
+ Open LDAP Public License v2.0.1
+
+
+
+
+ Open LDAP Public License v2.1
+
+
+
+
+ Open LDAP Public License v2.2
+
+
+
+
+ Open LDAP Public License v2.2.1
+
+
+
+
+ Open LDAP Public License 2.2.2
+
+
+
+
+ Open LDAP Public License v2.3
+
+
+
+
+ Open LDAP Public License v2.4
+
+
+
+
+ Open LDAP Public License v2.5
+
+
+
+
+ Open LDAP Public License v2.6
+
+
+
+
+ Open LDAP Public License v2.7
+
+
+
+
+ Open LDAP Public License v2.8
+
+
+
+
+ Open Logistics Foundation License Version 1.3
+
+
+
+
+ Open Market License
+
+
+
+
+ OpenPBS v2.3 Software License
+
+
+
+
+ OpenSSL License
+
+
+
+
+ OpenSSL License - standalone
+
+
+
+
+ OpenVision License
+
+
+
+
+ Open Public License v1.0
+
+
+
+
+ United Kingdom Open Parliament Licence v3.0
+
+
+
+
+ Open Publication License v1.0
+
+
+
+
+ OSET Public License version 2.1
+
+
+
+
+ Open Software License 1.0
+
+
+
+
+ Open Software License 1.1
+
+
+
+
+ Open Software License 2.0
+
+
+
+
+ Open Software License 2.1
+
+
+
+
+ Open Software License 3.0
+
+
+
+
+ PADL License
+
+
+
+
+ The Parity Public License 6.0.0
+
+
+
+
+ The Parity Public License 7.0.0
+
+
+
+
+ Open Data Commons Public Domain Dedication & License 1.0
+
+
+
+
+ PHP License v3.0
+
+
+
+
+ PHP License v3.01
+
+
+
+
+ Pixar License
+
+
+
+
+ pkgconf License
+
+
+
+
+ Plexus Classworlds License
+
+
+
+
+ pnmstitch License
+
+
+
+
+ PolyForm Noncommercial License 1.0.0
+
+
+
+
+ PolyForm Small Business License 1.0.0
+
+
+
+
+ PostgreSQL License
+
+
+
+
+ Peer Production License
+
+
+
+
+ Python Software Foundation License 2.0
+
+
+
+
+ psfrag License
+
+
+
+
+ psutils License
+
+
+
+
+ Python License 2.0
+
+
+
+
+ Python License 2.0.1
+
+
+
+
+ Python ldap License
+
+
+
+
+ Qhull License
+
+
+
+
+ Q Public License 1.0
+
+
+
+
+ Q Public License 1.0 - INRIA 2004 variant
+
+
+
+
+ radvd License
+
+
+
+
+ Rdisc License
+
+
+
+
+ Red Hat eCos Public License v1.1
+
+
+
+
+ Reciprocal Public License 1.1
+
+
+
+
+ Reciprocal Public License 1.5
+
+
+
+
+ RealNetworks Public Source License v1.0
+
+
+
+
+ RSA Message-Digest License
+
+
+
+
+ Ricoh Source Code Public License
+
+
+
+
+ Ruby License
+
+
+
+
+ Sax Public Domain Notice
+
+
+
+
+ Sax Public Domain Notice 2.0
+
+
+
+
+ Saxpath License
+
+
+
+
+ SCEA Shared Source License
+
+
+
+
+ Scheme Language Report License
+
+
+
+
+ Sendmail License
+
+
+
+
+ Sendmail License 8.23
+
+
+
+
+ SGI Free Software License B v1.0
+
+
+
+
+ SGI Free Software License B v1.1
+
+
+
+
+ SGI Free Software License B v2.0
+
+
+
+
+ SGI OpenGL License
+
+
+
+
+ SGP4 Permission Notice
+
+
+
+
+ Solderpad Hardware License v0.5
+
+
+
+
+ Solderpad Hardware License, Version 0.51
+
+
+
+
+ Simple Public License 2.0
+
+
+
+
+ Sun Industry Standards Source License v1.1
+
+
+
+
+ Sun Industry Standards Source License v1.2
+
+
+
+
+ SL License
+
+
+
+
+ Sleepycat License
+
+
+
+
+ Standard ML of New Jersey License
+
+
+
+
+ Secure Messaging Protocol Public License
+
+
+
+
+ SNIA Public License 1.1
+
+
+
+
+ snprintf License
+
+
+
+
+ softSurfer License
+
+
+
+
+ Soundex License
+
+
+
+
+ Spencer License 86
+
+
+
+
+ Spencer License 94
+
+
+
+
+ Spencer License 99
+
+
+
+
+ Sun Public License v1.0
+
+
+
+
+ ssh-keyscan License
+
+
+
+
+ SSH OpenSSH license
+
+
+
+
+ SSH short notice
+
+
+
+
+ SSLeay License - standalone
+
+
+
+
+ Server Side Public License, v 1
+
+
+
+
+ Standard ML of New Jersey License
+
+
+
+
+ SugarCRM Public License v1.1.3
+
+
+
+
+ Sun PPP License
+
+
+
+
+ Sun PPP License (2000)
+
+
+
+
+ SunPro License
+
+
+
+
+ Scheme Widget Library (SWL) Software License Agreement
+
+
+
+
+ swrule License
+
+
+
+
+ Symlinks License
+
+
+
+
+ TAPR Open Hardware License v1.0
+
+
+
+
+ TCL/TK License
+
+
+
+
+ TCP Wrappers License
+
+
+
+
+ TermReadKey License
+
+
+
+
+ Transitive Grace Period Public Licence 1.0
+
+
+
+
+ threeparttable License
+
+
+
+
+ TMate Open Source License
+
+
+
+
+ TORQUE v2.5+ Software License v1.1
+
+
+
+
+ Trusster Open Source License
+
+
+
+
+ Time::ParseDate License
+
+
+
+
+ THOR Public License 1.0
+
+
+
+
+ Text-Tabs+Wrap License
+
+
+
+
+ TTYP0 License
+
+
+
+
+ Technische Universitaet Berlin License 1.0
+
+
+
+
+ Technische Universitaet Berlin License 2.0
+
+
+
+
+ UCAR License
+
+
+
+
+ Upstream Compatibility License v1.0
+
+
+
+
+ ulem License
+
+
+
+
+ Michigan/Merit Networks License
+
+
+
+
+ Unicode License v3
+
+
+
+
+ Unicode License Agreement - Data Files and Software (2015)
+
+
+
+
+ Unicode License Agreement - Data Files and Software (2016)
+
+
+
+
+ Unicode Terms of Use
+
+
+
+
+ UnixCrypt License
+
+
+
+
+ The Unlicense
+
+
+
+
+ Universal Permissive License v1.0
+
+
+
+
+ Utah Raster Toolkit Run Length Encoded License
+
+
+
+
+ Vim License
+
+
+
+
+ VOSTROM Public License for Open Source
+
+
+
+
+ Vovida Software License v1.0
+
+
+
+
+ W3C Software Notice and License (2002-12-31)
+
+
+
+
+ W3C Software Notice and License (1998-07-20)
+
+
+
+
+ W3C Software Notice and Document License (2015-05-13)
+
+
+
+
+ w3m License
+
+
+
+
+ Sybase Open Watcom Public License 1.0
+
+
+
+
+ Widget Workshop License
+
+
+
+
+ Wsuipa License
+
+
+
+
+ Do What The F*ck You Want To Public License
+
+
+
+
+ wxWindows Library License
+
+
+
+
+ X11 License
+
+
+
+
+ X11 License Distribution Modification Variant
+
+
+
+
+ Xdebug License v 1.03
+
+
+
+
+ Xerox License
+
+
+
+
+ Xfig License
+
+
+
+
+ XFree86 License 1.1
+
+
+
+
+ xinetd License
+
+
+
+
+ xkeyboard-config Zinoviev License
+
+
+
+
+ xlock License
+
+
+
+
+ X.Net License
+
+
+
+
+ XPP License
+
+
+
+
+ XSkat License
+
+
+
+
+ xzoom License
+
+
+
+
+ Yahoo! Public License v1.0
+
+
+
+
+ Yahoo! Public License v1.1
+
+
+
+
+ Zed License
+
+
+
+
+ Zeeff License
+
+
+
+
+ Zend License v2.0
+
+
+
+
+ Zimbra Public License v1.3
+
+
+
+
+ Zimbra Public License v1.4
+
+
+
+
+ zlib License
+
+
+
+
+ zlib/libpng License with Acknowledgement
+
+
+
+
+ Zope Public License 1.1
+
+
+
+
+ Zope Public License 2.0
+
+
+
+
+ Zope Public License 2.1
+
+
+
+
+
+ 389 Directory Server Exception
+
+
+
+
+ Asterisk exception
+
+
+
+
+ Asterisk linking protocols exception
+
+
+
+
+ Autoconf exception 2.0
+
+
+
+
+ Autoconf exception 3.0
+
+
+
+
+ Autoconf generic exception
+
+
+
+
+ Autoconf generic exception for GPL-3.0
+
+
+
+
+ Autoconf macro exception
+
+
+
+
+ Bison exception 1.24
+
+
+
+
+ Bison exception 2.2
+
+
+
+
+ Bootloader Distribution Exception
+
+
+
+
+ Classpath exception 2.0
+
+
+
+
+ CLISP exception 2.0
+
+
+
+
+ cryptsetup OpenSSL exception
+
+
+
+
+ DigiRule FOSS License Exception
+
+
+
+
+ eCos exception 2.0
+
+
+
+
+ Fawkes Runtime Exception
+
+
+
+
+ FLTK exception
+
+
+
+
+ fmt exception
+
+
+
+
+ Font exception 2.0
+
+
+
+
+ FreeRTOS Exception 2.0
+
+
+
+
+ GCC Runtime Library exception 2.0
+
+
+
+
+ GCC Runtime Library exception 2.0 - note variant
+
+
+
+
+ GCC Runtime Library exception 3.1
+
+
+
+
+ Gmsh exception>
+
+
+
+
+ GNAT exception
+
+
+
+
+ GNOME examples exception
+
+
+
+
+ GNU Compiler Exception
+
+
+
+
+ GNU JavaMail exception
+
+
+
+
+ GPL-3.0 Interface Exception
+
+
+
+
+ GPL-3.0 Linking Exception
+
+
+
+
+ GPL-3.0 Linking Exception (with Corresponding Source)
+
+
+
+
+ GPL Cooperation Commitment 1.0
+
+
+
+
+ GStreamer Exception (2005)
+
+
+
+
+ GStreamer Exception (2008)
+
+
+
+
+ i2p GPL+Java Exception
+
+
+
+
+ KiCad Libraries Exception
+
+
+
+
+ LGPL-3.0 Linking Exception
+
+
+
+
+ libpri OpenH323 exception
+
+
+
+
+ Libtool Exception
+
+
+
+
+ Linux Syscall Note
+
+
+
+
+ LLGPL Preamble
+
+
+
+
+ LLVM Exception
+
+
+
+
+ LZMA exception
+
+
+
+
+ Macros and Inline Functions Exception
+
+
+
+
+ Nokia Qt LGPL exception 1.1
+
+
+
+
+ OCaml LGPL Linking Exception
+
+
+
+
+ Open CASCADE Exception 1.0
+
+
+
+
+ OpenJDK Assembly exception 1.0
+
+
+
+
+ OpenVPN OpenSSL Exception
+
+
+
+
+ PCRE2 exception
+
+
+
+
+ PS/PDF font exception (2017-08-17)
+
+
+
+
+ INRIA QPL 1.0 2004 variant exception
+
+
+
+
+ Qt GPL exception 1.0
+
+
+
+
+ Qt LGPL exception 1.1
+
+
+
+
+ Qwt exception 1.0
+
+
+
+
+ RRDtool FLOSS exception 2.0
+
+
+
+
+ SANE Exception
+
+
+
+
+ Solderpad Hardware License v2.0
+
+
+
+
+ Solderpad Hardware License v2.1
+
+
+
+
+ stunnel Exception
+
+
+
+
+ SWI exception
+
+
+
+
+ Swift Exception
+
+
+
+
+ Texinfo exception
+
+
+
+
+ U-Boot exception 2.0
+
+
+
+
+ Unmodified Binary Distribution exception
+
+
+
+
+ Universal FOSS Exception, Version 1.0
+
+
+
+
+ vsftpd OpenSSL exception
+
+
+
+
+ WxWindows Library Exception 3.1
+
+
+
+
+ x11vnc OpenSSL Exception
+
+
+
+
+
+
\ No newline at end of file
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/schema.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/schema.py
new file mode 100644
index 00000000..a51686e9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/schema/schema.py
@@ -0,0 +1,94 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+from abc import ABC, abstractmethod
+from typing import Dict, Literal, Type
+
+from py_serializable import ViewType
+
+from . import SchemaVersion
+
+
+class BaseSchemaVersion(ABC, ViewType):
+
+ @property
+ @abstractmethod
+ def schema_version_enum(self) -> SchemaVersion:
+ ... # pragma: no cover
+
+ def get_schema_version(self) -> str:
+ return self.schema_version_enum.to_version()
+
+
+class SchemaVersion1Dot6(BaseSchemaVersion):
+
+ @property
+ def schema_version_enum(self) -> Literal[SchemaVersion.V1_6]:
+ return SchemaVersion.V1_6
+
+
+class SchemaVersion1Dot5(BaseSchemaVersion):
+
+ @property
+ def schema_version_enum(self) -> Literal[SchemaVersion.V1_5]:
+ return SchemaVersion.V1_5
+
+
+class SchemaVersion1Dot4(BaseSchemaVersion):
+
+ @property
+ def schema_version_enum(self) -> Literal[SchemaVersion.V1_4]:
+ return SchemaVersion.V1_4
+
+
+class SchemaVersion1Dot3(BaseSchemaVersion):
+
+ @property
+ def schema_version_enum(self) -> Literal[SchemaVersion.V1_3]:
+ return SchemaVersion.V1_3
+
+
+class SchemaVersion1Dot2(BaseSchemaVersion):
+
+ @property
+ def schema_version_enum(self) -> Literal[SchemaVersion.V1_2]:
+ return SchemaVersion.V1_2
+
+
+class SchemaVersion1Dot1(BaseSchemaVersion):
+
+ @property
+ def schema_version_enum(self) -> Literal[SchemaVersion.V1_1]:
+ return SchemaVersion.V1_1
+
+
+class SchemaVersion1Dot0(BaseSchemaVersion):
+
+ @property
+ def schema_version_enum(self) -> Literal[SchemaVersion.V1_0]:
+ return SchemaVersion.V1_0
+
+
+SCHEMA_VERSIONS: Dict[SchemaVersion, Type[BaseSchemaVersion]] = {
+ SchemaVersion.V1_6: SchemaVersion1Dot6,
+ SchemaVersion.V1_5: SchemaVersion1Dot5,
+ SchemaVersion.V1_4: SchemaVersion1Dot4,
+ SchemaVersion.V1_3: SchemaVersion1Dot3,
+ SchemaVersion.V1_2: SchemaVersion1Dot2,
+ SchemaVersion.V1_1: SchemaVersion1Dot1,
+ SchemaVersion.V1_0: SchemaVersion1Dot0,
+}
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/serialization/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/serialization/__init__.py
new file mode 100644
index 00000000..aeab0364
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/serialization/__init__.py
@@ -0,0 +1,100 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+"""
+Set of helper classes for use with ``serializable`` when conducting (de-)serialization.
+"""
+
+from typing import Any, Optional
+from uuid import UUID
+
+# See https://github.com/package-url/packageurl-python/issues/65
+from packageurl import PackageURL
+from py_serializable.helpers import BaseHelper
+
+from ..exception.serialization import CycloneDxDeserializationException, SerializationOfUnexpectedValueException
+from ..model.bom_ref import BomRef
+from ..model.license import _LicenseRepositorySerializationHelper
+
+
+class BomRefHelper(BaseHelper):
+ """**DEPRECATED** in favour of :class:`BomRef`.
+
+ .. deprecated:: 8.6
+ Use :class:`BomRef` instead.
+ """
+
+ # TODO: remove, no longer needed
+
+ @classmethod
+ def serialize(cls, o: Any) -> Optional[str]:
+ return BomRef.serialize(o)
+
+ @classmethod
+ def deserialize(cls, o: Any) -> BomRef:
+ return BomRef.deserialize(o)
+
+
+class PackageUrl(BaseHelper):
+
+ @classmethod
+ def serialize(cls, o: Any, ) -> str:
+ if isinstance(o, PackageURL):
+ return str(o.to_string())
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-PackageURL: {o!r}')
+
+ @classmethod
+ def deserialize(cls, o: Any) -> PackageURL:
+ try:
+ return PackageURL.from_string(purl=str(o))
+ except ValueError as err:
+ raise CycloneDxDeserializationException(
+ f'PURL string supplied does not parse: {o!r}'
+ ) from err
+
+
+class UrnUuidHelper(BaseHelper):
+
+ @classmethod
+ def serialize(cls, o: Any) -> str:
+ if isinstance(o, UUID):
+ return o.urn
+ raise SerializationOfUnexpectedValueException(
+ f'Attempt to serialize a non-UUID: {o!r}')
+
+ @classmethod
+ def deserialize(cls, o: Any) -> UUID:
+ try:
+ return UUID(str(o))
+ except ValueError as err:
+ raise CycloneDxDeserializationException(
+ f'UUID string supplied does not parse: {o!r}'
+ ) from err
+
+
+class LicenseRepositoryHelper(_LicenseRepositorySerializationHelper):
+ """**DEPRECATED**
+
+ .. deprecated:: 8.6
+ No public API planned for replacing this,
+ """
+
+ # TODO: remove, no longer needed
+
+ pass
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/serialization/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/serialization/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..8fdeaafb
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/serialization/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/spdx.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/spdx.py
new file mode 100644
index 00000000..9781af54
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/spdx.py
@@ -0,0 +1,77 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+__all__ = [
+ 'is_supported_id', 'fixup_id',
+ 'is_expression'
+]
+
+from json import load as json_load
+from typing import TYPE_CHECKING, Dict, Optional, Set
+
+from license_expression import get_spdx_licensing # type:ignore[import-untyped]
+
+from .schema._res import SPDX_JSON as __SPDX_JSON_SCHEMA
+
+if TYPE_CHECKING: # pragma: no cover
+ from license_expression import Licensing
+
+# region init
+# python's internal module loader will assure that this init-part runs only once.
+
+# !!! this requires to ship the actual schema data with the package.
+with open(__SPDX_JSON_SCHEMA) as schema:
+ __IDS: Set[str] = set(json_load(schema).get('enum', []))
+assert len(__IDS) > 0, 'known SPDX-IDs should be non-empty set'
+
+__IDS_LOWER_MAP: Dict[str, str] = dict((id_.lower(), id_) for id_ in __IDS)
+
+__SPDX_EXPRESSION_LICENSING: 'Licensing' = get_spdx_licensing()
+
+# endregion
+
+
+def is_supported_id(value: str) -> bool:
+ """Validate SPDX-ID according to current spec."""
+ return value in __IDS
+
+
+def fixup_id(value: str) -> Optional[str]:
+ """Fixup SPDX-ID.
+
+ :returns: repaired value string, or `None` if fixup was unable to help.
+ """
+ return __IDS_LOWER_MAP.get(value.lower())
+
+
+def is_expression(value: str) -> bool:
+ """Validate SPDX license expression.
+
+ .. note::
+ Utilizes `license-expression library`_ to
+ validate SPDX compound expression according to `SPDX license expression spec`_.
+
+ .. _SPDX license expression spec: https://spdx.github.io/spdx-spec/v3.0.1/annexes/spdx-license-expressions/
+ .. _license-expression library: https://github.com/nexB/license-expression
+ """
+ try:
+ res = __SPDX_EXPRESSION_LICENSING.validate(value)
+ except Exception:
+ # the throw happens when internals crash due to unexpected input characters.
+ return False
+ return 0 == len(res.errors)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__init__.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__init__.py
new file mode 100644
index 00000000..b1e973c1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__init__.py
@@ -0,0 +1,121 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, Any, Literal, Optional, Protocol, Union, overload
+
+from ..schema import OutputFormat
+
+if TYPE_CHECKING: # pragma: no cover
+ from ..schema import SchemaVersion
+ from .json import JsonValidator
+ from .xml import XmlValidator
+
+
+class ValidationError:
+ """Validation failed with this specific error.
+
+ Use :attr:`~data` to access the content.
+ """
+
+ data: Any
+
+ def __init__(self, data: Any) -> None:
+ self.data = data
+
+ def __repr__(self) -> str:
+ return repr(self.data)
+
+ def __str__(self) -> str:
+ return str(self.data)
+
+
+class SchemabasedValidator(Protocol):
+ """Schema-based Validator protocol"""
+
+ def validate_str(self, data: str) -> Optional[ValidationError]:
+ """Validate a string
+
+ :param data: the data string to validate
+ :return: validation error
+ :retval None: if ``data`` is valid
+ :retval ValidationError: if ``data`` is invalid
+ """
+ ... # pragma: no cover
+
+
+class BaseSchemabasedValidator(ABC, SchemabasedValidator):
+ """Base Schema-based Validator"""
+
+ def __init__(self, schema_version: 'SchemaVersion') -> None:
+ self.__schema_version = schema_version
+ if not self._schema_file:
+ raise ValueError(f'Unsupported schema_version: {schema_version!r}')
+
+ @property
+ def schema_version(self) -> 'SchemaVersion':
+ """Get the schema version."""
+ return self.__schema_version
+
+ @property
+ @abstractmethod
+ def output_format(self) -> OutputFormat:
+ """Get the format."""
+ ... # pragma: no cover
+
+ @property
+ @abstractmethod
+ def _schema_file(self) -> Optional[str]:
+ """Get the schema file according to schema version."""
+ ... # pragma: no cover
+
+
+@overload
+def make_schemabased_validator(output_format: Literal[OutputFormat.JSON], schema_version: 'SchemaVersion'
+ ) -> 'JsonValidator':
+ ... # pragma: no cover
+
+
+@overload
+def make_schemabased_validator(output_format: Literal[OutputFormat.XML], schema_version: 'SchemaVersion'
+ ) -> 'XmlValidator':
+ ... # pragma: no cover
+
+
+@overload
+def make_schemabased_validator(output_format: OutputFormat, schema_version: 'SchemaVersion'
+ ) -> Union['JsonValidator', 'XmlValidator']:
+ ... # pragma: no cover
+
+
+def make_schemabased_validator(output_format: OutputFormat, schema_version: 'SchemaVersion'
+ ) -> 'BaseSchemabasedValidator':
+ """Get the default Schema-based Validator for a certain :class:`OutputFormat`.
+
+ Raises error when no instance could be made.
+ """
+ if TYPE_CHECKING: # pragma: no cover
+ from typing import Type
+ Validator: Type[BaseSchemabasedValidator] # noqa:N806
+ if OutputFormat.JSON is output_format:
+ from .json import JsonValidator as Validator
+ elif OutputFormat.XML is output_format:
+ from .xml import XmlValidator as Validator
+ else:
+ raise ValueError(f'Unexpected output_format: {output_format!r}')
+ return Validator(schema_version)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..20e11cf4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/json.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/json.cpython-312.pyc
new file mode 100644
index 00000000..17fd05ea
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/json.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/model.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/model.cpython-312.pyc
new file mode 100644
index 00000000..61550d5b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/model.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/xml.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/xml.cpython-312.pyc
new file mode 100644
index 00000000..c58d21c2
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/__pycache__/xml.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/json.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/json.py
new file mode 100644
index 00000000..ebdd01e0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/json.py
@@ -0,0 +1,119 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+__all__ = ['JsonValidator', 'JsonStrictValidator']
+
+from abc import ABC
+from json import loads as json_loads
+from typing import TYPE_CHECKING, Any, Literal, Optional, Tuple
+
+from ..schema import OutputFormat
+
+if TYPE_CHECKING: # pragma: no cover
+ from ..schema import SchemaVersion
+
+from ..exception import MissingOptionalDependencyException
+from ..schema._res import BOM_JSON as _S_BOM, BOM_JSON_STRICT as _S_BOM_STRICT, JSF as _S_JSF, SPDX_JSON as _S_SPDX
+from . import BaseSchemabasedValidator, SchemabasedValidator, ValidationError
+
+_missing_deps_error: Optional[Tuple[MissingOptionalDependencyException, ImportError]] = None
+try:
+ from jsonschema.exceptions import ValidationError as JsonValidationError # type:ignore[import-untyped]
+ from jsonschema.validators import Draft7Validator # type:ignore[import-untyped]
+ from referencing import Registry
+ from referencing.jsonschema import DRAFT7
+
+ if TYPE_CHECKING: # pragma: no cover
+ from jsonschema.protocols import Validator as JsonSchemaValidator # type:ignore[import-untyped]
+except ImportError as err:
+ _missing_deps_error = MissingOptionalDependencyException(
+ 'This functionality requires optional dependencies.\n'
+ 'Please install `cyclonedx-python-lib` with the extra "json-validation".\n'
+ ), err
+
+
+class _BaseJsonValidator(BaseSchemabasedValidator, ABC):
+ @property
+ def output_format(self) -> Literal[OutputFormat.JSON]:
+ return OutputFormat.JSON
+
+ def __init__(self, schema_version: 'SchemaVersion') -> None:
+ # this is the def that is used for generating the documentation
+ super().__init__(schema_version)
+
+ if _missing_deps_error: # noqa:C901
+ __MDERROR = _missing_deps_error
+
+ def validate_str(self, data: str) -> Optional[ValidationError]:
+ raise self.__MDERROR[0] from self.__MDERROR[1]
+
+ else:
+ def validate_str(self, data: str) -> Optional[ValidationError]:
+ return self._validata_data(
+ json_loads(data))
+
+ def _validata_data(self, data: Any) -> Optional[ValidationError]:
+ validator = self._validator # may throw on error that MUST NOT be caught
+ try:
+ validator.validate(data)
+ except JsonValidationError as error:
+ return ValidationError(error)
+ return None
+
+ __validator: Optional['JsonSchemaValidator'] = None
+
+ @property
+ def _validator(self) -> 'JsonSchemaValidator':
+ if not self.__validator:
+ schema_file = self._schema_file
+ if schema_file is None:
+ raise NotImplementedError('missing schema file')
+ with open(schema_file) as sf:
+ self.__validator = Draft7Validator(
+ json_loads(sf.read()),
+ registry=self.__make_validator_registry(),
+ format_checker=Draft7Validator.FORMAT_CHECKER)
+ return self.__validator
+
+ @staticmethod
+ def __make_validator_registry() -> Registry[Any]:
+ schema_prefix = 'http://cyclonedx.org/schema/'
+ with open(_S_SPDX) as spdx, open(_S_JSF) as jsf:
+ return Registry().with_resources([
+ (f'{schema_prefix}spdx.SNAPSHOT.schema.json', DRAFT7.create_resource(json_loads(spdx.read()))),
+ (f'{schema_prefix}jsf-0.82.SNAPSHOT.schema.json', DRAFT7.create_resource(json_loads(jsf.read()))),
+ ])
+
+
+class JsonValidator(_BaseJsonValidator, BaseSchemabasedValidator, SchemabasedValidator):
+ """Validator for CycloneDX documents in JSON format."""
+
+ @property
+ def _schema_file(self) -> Optional[str]:
+ return _S_BOM.get(self.schema_version)
+
+
+class JsonStrictValidator(_BaseJsonValidator, BaseSchemabasedValidator, SchemabasedValidator):
+ """Strict validator for CycloneDX documents in JSON format.
+
+ In contrast to :class:`~JsonValidator`,
+ the document must not have additional or unknown JSON properties.
+ """
+ @property
+ def _schema_file(self) -> Optional[str]:
+ return _S_BOM_STRICT.get(self.schema_version)
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/model.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/model.py
new file mode 100644
index 00000000..1f8b6061
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/model.py
@@ -0,0 +1,22 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+# nothing here, yet.
+# in the future this could be the place where model validation is done.
+# like the current `model.bom.Bom.validate()`
+# see also: https://github.com/CycloneDX/cyclonedx-python-lib/issues/455
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/xml.py b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/xml.py
new file mode 100644
index 00000000..2ba79890
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/xml.py
@@ -0,0 +1,102 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+__all__ = ['XmlValidator']
+
+from abc import ABC
+from typing import TYPE_CHECKING, Any, Literal, Optional, Tuple
+
+from ..exception import MissingOptionalDependencyException
+from ..schema import OutputFormat
+from ..schema._res import BOM_XML as _S_BOM
+from . import BaseSchemabasedValidator, SchemabasedValidator, ValidationError
+
+if TYPE_CHECKING: # pragma: no cover
+ from ..schema import SchemaVersion
+
+_missing_deps_error: Optional[Tuple[MissingOptionalDependencyException, ImportError]] = None
+try:
+ from lxml.etree import ( # type:ignore[import-untyped] # nosec B410
+ XMLParser,
+ XMLSchema,
+ fromstring as xml_fromstring,
+ )
+except ImportError as err:
+ _missing_deps_error = MissingOptionalDependencyException(
+ 'This functionality requires optional dependencies.\n'
+ 'Please install `cyclonedx-python-lib` with the extra "xml-validation".\n'
+ ), err
+
+
+class _BaseXmlValidator(BaseSchemabasedValidator, ABC):
+
+ @property
+ def output_format(self) -> Literal[OutputFormat.XML]:
+ return OutputFormat.XML
+
+ def __init__(self, schema_version: 'SchemaVersion') -> None:
+ # this is the def that is used for generating the documentation
+ super().__init__(schema_version)
+
+ if _missing_deps_error:
+ __MDERROR = _missing_deps_error
+
+ def validate_str(self, data: str) -> Optional[ValidationError]:
+ raise self.__MDERROR[0] from self.__MDERROR[1]
+ else:
+ def validate_str(self, data: str) -> Optional[ValidationError]:
+ return self._validata_data(
+ xml_fromstring( # nosec B320
+ bytes(data, encoding='utf8'),
+ parser=self.__xml_parser))
+
+ def _validata_data(self, data: Any) -> Optional[ValidationError]:
+ validator = self._validator # may throw on error that MUST NOT be caught
+ if not validator.validate(data):
+ return ValidationError(validator.error_log.last_error)
+ return None
+
+ __validator: Optional['XMLSchema'] = None
+
+ @property
+ def __xml_parser(self) -> XMLParser:
+ return XMLParser(
+ attribute_defaults=False, dtd_validation=False, load_dtd=False,
+ no_network=True,
+ resolve_entities=False,
+ huge_tree=True,
+ compact=True,
+ recover=False
+ )
+
+ @property
+ def _validator(self) -> 'XMLSchema':
+ if not self.__validator:
+ schema_file = self._schema_file
+ if schema_file is None:
+ raise NotImplementedError('missing schema file')
+ self.__validator = XMLSchema(file=schema_file)
+ return self.__validator
+
+
+class XmlValidator(_BaseXmlValidator, BaseSchemabasedValidator, SchemabasedValidator):
+ """Validator for CycloneDX documents in XML format."""
+
+ @property
+ def _schema_file(self) -> Optional[str]:
+ return _S_BOM.get(self.schema_version)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/LICENSE b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/LICENSE
new file mode 100644
index 00000000..261eeb9e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/METADATA
new file mode 100644
index 00000000..9b5e411c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/METADATA
@@ -0,0 +1,130 @@
+Metadata-Version: 2.3
+Name: cyclonedx-python-lib
+Version: 9.1.0
+Summary: Python library for CycloneDX
+License: Apache-2.0
+Keywords: CycloneDX,library,OWASP,SCA,Software Bill of Materials,Bill of Materials,BOM,SBOM,VEX,VDR,OBOM,MBOM,SaaSBOM,SPDX,PackageURL,PURL
+Author: Paul Horton
+Author-email: phorton@sonatype.com
+Maintainer: Jan Kowalleck
+Maintainer-email: jan.kowalleck@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Legal Industry
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Software Distribution
+Classifier: Typing :: Typed
+Provides-Extra: json-validation
+Provides-Extra: validation
+Provides-Extra: xml-validation
+Requires-Dist: jsonschema[format] (>=4.18,<5.0) ; extra == "validation" or extra == "json-validation"
+Requires-Dist: license-expression (>=30,<31)
+Requires-Dist: lxml (>=4,<6) ; extra == "validation" or extra == "xml-validation"
+Requires-Dist: packageurl-python (>=0.11,<2)
+Requires-Dist: py-serializable (>=2.0.0,<3.0.0)
+Requires-Dist: sortedcontainers (>=2.4.0,<3.0.0)
+Project-URL: Bug Tracker, https://github.com/CycloneDX/cyclonedx-python-lib/issues
+Project-URL: Documentation, https://cyclonedx-python-library.readthedocs.io/
+Project-URL: Funding, https://owasp.org/donate/?reponame=www-project-cyclonedx&title=OWASP+CycloneDX
+Project-URL: Homepage, https://github.com/CycloneDX/cyclonedx-python-lib/#readme
+Project-URL: Repository, https://github.com/CycloneDX/cyclonedx-python-lib
+Description-Content-Type: text/markdown
+
+# CycloneDX Python Library
+
+[![shield_pypi-version]][link_pypi]
+[![shield_conda-forge-version]][link_conda-forge]
+[![shield_rtfd]][link_rtfd]
+[![shield_gh-workflow-test]][link_gh-workflow-test]
+[![shield_coverage]][link_codacy]
+[![shield_ossf-best-practices]][link_ossf-best-practices]
+[![shield_license]][license_file]
+[![shield_website]][link_website]
+[![shield_slack]][link_slack]
+[![shield_groups]][link_discussion]
+[![shield_twitter-follow]][link_twitter]
+
+----
+
+OWASP [CycloneDX][link_website] is a full-stack Bill of Materials (BOM) standard
+that provides advanced supply chain capabilities for cyber risk reduction.
+
+This Python package provides data models, validators and more,
+to help you create/render/read CycloneDX documents.
+
+> [!NOTE]
+> This package is a software library not intended for standalone use.
+> For generating Software Bill of Materials (SBOM), check out [CycloneDX Python][cyclonedx-python] or [Jake][jake].
+
+## Documentation
+
+Complete documentation is available on [Read the Docs][link_rtfd]. This includes:
+- Responsibilities & Capabilities
+- Install Instructions
+- API Reference
+- Usage Examples
+- Integration Guides
+- Best Practices
+
+## Python Support
+
+We endeavour to support all functionality for all [current actively supported Python versions](https://www.python.org/downloads/).
+However, some features may not be possible/present in older Python versions due to their lack of support.
+
+## Changelog
+
+See our [CHANGELOG][chaneglog_file].
+
+## Contributing
+
+Feel free to open issues, bugreports or pull requests.
+See the [CONTRIBUTING][contributing_file] file for details.
+
+## Copyright & License
+
+CycloneDX Python Lib is Copyright (c) OWASP Foundation. All Rights Reserved.
+Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
+See the [LICENSE][license_file] file for the full license.
+
+[cyclonedx-python]: https://github.com/CycloneDX/cyclonedx-python
+[jake]: https://github.com/sonatype-nexus-community/jake
+
+[license_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/LICENSE
+[chaneglog_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CHANGELOG.md
+[contributing_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CONTRIBUTING.md
+
+[shield_gh-workflow-test]: https://img.shields.io/github/actions/workflow/status/CycloneDX/cyclonedx-python-lib/python.yml?branch=main&logo=GitHub&logoColor=white "build"
+[shield_coverage]: https://img.shields.io/codacy/coverage/1f9d451e9cdc49ce99c2a1247adab341?logo=Codacy&logoColor=white "test coverage"
+[shield_ossf-best-practices]: https://img.shields.io/cii/percentage/7956?label=OpenSSF%20best%20practices "OpenSSF best practices"
+[shield_pypi-version]: https://img.shields.io/pypi/v/cyclonedx-python-lib?logo=pypi&logoColor=white&label=PyPI "PyPI"
+[shield_conda-forge-version]: https://img.shields.io/conda/vn/conda-forge/cyclonedx-python-lib?logo=anaconda&logoColor=white&label=conda-forge "conda-forge"
+[shield_rtfd]: https://img.shields.io/readthedocs/cyclonedx-python-library?logo=readthedocs&logoColor=white "Read the Docs"
+[shield_license]: https://img.shields.io/github/license/CycloneDX/cyclonedx-python-lib?logo=open%20source%20initiative&logoColor=white "license"
+[shield_website]: https://img.shields.io/badge/https://-cyclonedx.org-blue.svg "homepage"
+[shield_slack]: https://img.shields.io/badge/slack-join-blue?logo=Slack&logoColor=white "slack join"
+[shield_groups]: https://img.shields.io/badge/discussion-groups.io-blue.svg "groups discussion"
+[shield_twitter-follow]: https://img.shields.io/badge/Twitter-follow-blue?logo=Twitter&logoColor=white "twitter follow"
+
+[link_gh-workflow-test]: https://github.com/CycloneDX/cyclonedx-python-lib/actions/workflows/python.yml?query=branch%3Amain
+[link_pypi]: https://pypi.org/project/cyclonedx-python-lib/
+[link_conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib
+[link_rtfd]: https://cyclonedx-python-library.readthedocs.io/en/latest/
+[link_codacy]: https://app.codacy.com/gh/CycloneDX/cyclonedx-python-lib
+[link_ossf-best-practices]: https://www.bestpractices.dev/projects/7956
+[link_website]: https://cyclonedx.org/
+[link_slack]: https://cyclonedx.org/slack/invite
+[link_discussion]: https://groups.io/g/CycloneDX
+[link_twitter]: https://twitter.com/CycloneDX_Spec
+
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/NOTICE b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/NOTICE
new file mode 100644
index 00000000..1fd04a73
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/NOTICE
@@ -0,0 +1,5 @@
+CycloneDX Python Lib
+Copyright (c) OWASP Foundation
+
+This product includes software developed by the
+CycloneDX community (https://cyclonedx.org/).
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/RECORD
new file mode 100644
index 00000000..abc013b7
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/RECORD
@@ -0,0 +1,111 @@
+cyclonedx/__init__.py,sha256=4JIP6tI4ritZHrEjiuKKb7kWVyOt41R7xL2FdHqC_ow,900
+cyclonedx/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/__pycache__/spdx.cpython-312.pyc,,
+cyclonedx/_internal/__init__.py,sha256=s_2teh0oLCY5Jbl9QTXTeQrkFzlwfUzdFjg2L69CEpY,876
+cyclonedx/_internal/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/_internal/__pycache__/bom_ref.cpython-312.pyc,,
+cyclonedx/_internal/__pycache__/compare.cpython-312.pyc,,
+cyclonedx/_internal/__pycache__/hash.cpython-312.pyc,,
+cyclonedx/_internal/__pycache__/time.cpython-312.pyc,,
+cyclonedx/_internal/bom_ref.py,sha256=HymUdXerTPSG5WywlwUvfR_BuoEavDG3-6q0k-hIfrQ,1536
+cyclonedx/_internal/compare.py,sha256=mtyjdnzjZkqcpGah7SyWwAHvti8IwBI_yHTWF_wkUN0,2570
+cyclonedx/_internal/hash.py,sha256=Z4s-JvyX40pxYKNKLJJ9kUQN6xKUygfsyOvkW7vaq_k,1214
+cyclonedx/_internal/time.py,sha256=oQJqk_k9ArC-c1sS_21oBmBuRWFjcOpx24JQ_bXtcRk,897
+cyclonedx/builder/__init__.py,sha256=diMPTuXwz8CwatRt2miqHvobVVGhbfdh7addojFeS4U,729
+cyclonedx/builder/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/builder/__pycache__/this.cpython-312.pyc,,
+cyclonedx/builder/this.py,sha256=dszoE9QuTszbDT64Mi4v9PfACag2iNXsGX8xtH0YzV0,3452
+cyclonedx/exception/__init__.py,sha256=4bjUJhtNyv9AQxmTQXTDf9D3guvOCo3OqBv48ZUiHJ0,1043
+cyclonedx/exception/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/exception/__pycache__/factory.cpython-312.pyc,,
+cyclonedx/exception/__pycache__/model.cpython-312.pyc,,
+cyclonedx/exception/__pycache__/output.cpython-312.pyc,,
+cyclonedx/exception/__pycache__/serialization.cpython-312.pyc,,
+cyclonedx/exception/factory.py,sha256=nIKot8luUQdb3MUwuLzBPOJ1zGbBS-QzlHuTAgzqHHA,1586
+cyclonedx/exception/model.py,sha256=hZ38cByriWonbeKg0HdfhwUDjNmYTrc5Q1RjQxNE7_s,3940
+cyclonedx/exception/output.py,sha256=oY1jVOAE7opkI87Y0OALLxfaiawJ8C8-0iRjjAxdBrI,1186
+cyclonedx/exception/serialization.py,sha256=8mWeir6zr4nzzl998IrP628OnxMfT6kd2c5LmS2obOs,1780
+cyclonedx/factory/__init__.py,sha256=Xf-RkULTAFd4T8C701YgCjWJz1QquEqWnyhTOKUCD-Q,730
+cyclonedx/factory/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/factory/__pycache__/license.cpython-312.pyc,,
+cyclonedx/factory/license.py,sha256=qqQkDtiouHZsR4lBaACE3U1c27l-u_anDpvrbDqzkLQ,4205
+cyclonedx/model/__init__.py,sha256=VlnCl7qf_XdlZRWYjwfHVRAlg-ogtQ8jooUIMT1YMJQ,41095
+cyclonedx/model/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/model/__pycache__/bom.cpython-312.pyc,,
+cyclonedx/model/__pycache__/bom_ref.cpython-312.pyc,,
+cyclonedx/model/__pycache__/component.cpython-312.pyc,,
+cyclonedx/model/__pycache__/contact.cpython-312.pyc,,
+cyclonedx/model/__pycache__/crypto.cpython-312.pyc,,
+cyclonedx/model/__pycache__/definition.cpython-312.pyc,,
+cyclonedx/model/__pycache__/dependency.cpython-312.pyc,,
+cyclonedx/model/__pycache__/impact_analysis.cpython-312.pyc,,
+cyclonedx/model/__pycache__/issue.cpython-312.pyc,,
+cyclonedx/model/__pycache__/license.cpython-312.pyc,,
+cyclonedx/model/__pycache__/lifecycle.cpython-312.pyc,,
+cyclonedx/model/__pycache__/release_note.cpython-312.pyc,,
+cyclonedx/model/__pycache__/service.cpython-312.pyc,,
+cyclonedx/model/__pycache__/tool.cpython-312.pyc,,
+cyclonedx/model/__pycache__/vulnerability.cpython-312.pyc,,
+cyclonedx/model/bom.py,sha256=il9Jf8SbkrcUm80p6aaHC-iZgGCJlJam4xkm22imQuw,27706
+cyclonedx/model/bom_ref.py,sha256=YRCIuPpo8tGYEfkfN376ygDz6ArR6iogUoADiuivHPk,3207
+cyclonedx/model/component.py,sha256=9Z3-s5_18nqpsJSo7OHGAyPrya84NWWhxVPcpC8wxfQ,58591
+cyclonedx/model/contact.py,sha256=lGlClttT0NqZHySkSNQHi9UvoElOlDE3ewmILC77Xe8,11807
+cyclonedx/model/crypto.py,sha256=ge0F5s4ldS26E9U2KY0LkpTb01dDTpvGGwj3FL3eiEQ,50722
+cyclonedx/model/definition.py,sha256=PETaGSACqblSOAI3Dwmyi6bHlqCllTKu7p7cCd99DZ4,20434
+cyclonedx/model/dependency.py,sha256=xMulaxyj8oIdUVXGKZ9E4a3OEuNNwFjUywhgVC2sbyQ,3798
+cyclonedx/model/impact_analysis.py,sha256=f3SX5o2njvWgnqv-VoBM2WI2ImHSR33OFkCqzo_sHB0,3591
+cyclonedx/model/issue.py,sha256=kwDDh55ZOFgH1YO3xT70GzaRywyFdXDkhXhl4D62pRg,7329
+cyclonedx/model/license.py,sha256=KHltYiCyMQj2xgkD9ITCr4bE8MchZnHQMbvT5iSnKkQ,17353
+cyclonedx/model/lifecycle.py,sha256=U_Viad4iok9cO0r5nzWcxynmunFrdbGdEIpSzwtOS-Y,8299
+cyclonedx/model/release_note.py,sha256=-DkXl3pjPQhuhvwBWyrJN0aiMC35N-rjoYGJaj2ZiPA,9252
+cyclonedx/model/service.py,sha256=r5pggK5XcbjxLhCFw3ZjjsAQa7KV8NF-lkXWnGu4P0M,13174
+cyclonedx/model/tool.py,sha256=kMFtcohwIrBDPnHtN_wD__76YNwSezBWs7VtAG-VWng,13332
+cyclonedx/model/vulnerability.py,sha256=2xj-vLnQ87S-i0hBeCcwVkc9cM_bmNGBpP7_rCiRA9E,45982
+cyclonedx/output/__init__.py,sha256=n_DUYNDrrBKd_Af9Ksr_2N1B63ZIIjxU4Zq9_7t7y9w,6062
+cyclonedx/output/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/output/__pycache__/json.cpython-312.pyc,,
+cyclonedx/output/__pycache__/xml.cpython-312.pyc,,
+cyclonedx/output/json.py,sha256=22kte_qd6MVvrzDOUQcldzyrI4rEA-xgOBtUVPcNwf0,4293
+cyclonedx/output/xml.py,sha256=7uZAUDdVfKj7riz-_VeappcZfiZSmdAp74lE_vbHBOo,4289
+cyclonedx/py.typed,sha256=EFHg9-wbl4yUKjj8V3gUwoBZQam2tFkzh9IuCnmNyew,153
+cyclonedx/schema/__init__.py,sha256=MjLy3ogQ6AAgK8ZFKPtEirgDq-SEBoeuFnVOlZJHD4U,3068
+cyclonedx/schema/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/schema/__pycache__/schema.cpython-312.pyc,,
+cyclonedx/schema/_res/README.md,sha256=4rohUz-PJXeAxkBdvBP4t1yfW85OVWBe_-F8Zgvl7Us,2114
+cyclonedx/schema/_res/__init__.py,sha256=C8hKd4dfsqknxdb_D6vCeEr9phs0yVTAzrAt4HtH9vM,2543
+cyclonedx/schema/_res/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/schema/_res/bom-1.0.SNAPSHOT.xsd,sha256=UdPuS4AcRn5DVvsTIjVRHHvwlV5W4R9SPyoh47hKScA,13604
+cyclonedx/schema/_res/bom-1.1.SNAPSHOT.xsd,sha256=7jZOnkecdBnpu-gVsOnkOUs6UO6aqp6jqY4km5Hd85Q,39716
+cyclonedx/schema/_res/bom-1.2-strict.SNAPSHOT.schema.json,sha256=QOmPiPjD34R9Q5UuSIzVraCZn4V0eIUzYFAppCh42Ag,37110
+cyclonedx/schema/_res/bom-1.2.SNAPSHOT.schema.json,sha256=YoPuwr15wghOggtK7PrB2M7UhRMinJ9s6Nq6Fd22HRg,36226
+cyclonedx/schema/_res/bom-1.2.SNAPSHOT.xsd,sha256=GeqcECVdgXuLnjQHgBOLY8YQ11tumCIlb_peCyyCWew,76383
+cyclonedx/schema/_res/bom-1.3-strict.SNAPSHOT.schema.json,sha256=R0plMCuFCFovegPjso9lx2XUWcXtg1OvHMnO0_zC7SI,40324
+cyclonedx/schema/_res/bom-1.3.SNAPSHOT.schema.json,sha256=6G84npP7t3CnASanYmgPjCGeF9Awuez4n1ZgYwqY-PM,39348
+cyclonedx/schema/_res/bom-1.3.SNAPSHOT.xsd,sha256=fldGgaJTHn3NKQ4o27_CuMcwF0ZnqTGic8Tv3VLFqzU,88794
+cyclonedx/schema/_res/bom-1.4.SNAPSHOT.schema.json,sha256=j3gBmKXPcQ_Kg9AMEvdA5kTFvQTLckC-JrDDbHX_CNw,72300
+cyclonedx/schema/_res/bom-1.4.SNAPSHOT.xsd,sha256=536GS70y7NM4tUHMOlWYubLcew64V_hJNwZslxiWve4,133792
+cyclonedx/schema/_res/bom-1.5.SNAPSHOT.schema.json,sha256=PvNaohNF5x0g6TTEfYrwufQxlBcaPW-ODjQTO_LxWQ4,164689
+cyclonedx/schema/_res/bom-1.5.SNAPSHOT.xsd,sha256=K5vuRgtTnz3xWmIlEvXywNUOUZK-dWdEE6gJmwURbJo,311805
+cyclonedx/schema/_res/bom-1.6.SNAPSHOT.schema.json,sha256=y4jIEhrmvm7A0vAZCbRFjhKFLyYLNy8Y0g49wu-Q6hU,262624
+cyclonedx/schema/_res/bom-1.6.SNAPSHOT.xsd,sha256=IIKnS5L9Ieb36nvyLnbn19xLg446SiCrX_3ja0XYORQ,501128
+cyclonedx/schema/_res/jsf-0.82.SNAPSHOT.schema.json,sha256=i64ALCXnI9t-4fJq_eaArhorGo9rS0sP1l3DvssJCq4,8058
+cyclonedx/schema/_res/spdx.SNAPSHOT.schema.json,sha256=xBkXGWY5BV6flnCBG6wj73d3MhRPP_Wi85aG9hWA2-Y,14830
+cyclonedx/schema/_res/spdx.SNAPSHOT.xsd,sha256=y8IhF1WvXs-bUt1RTBTkr290mFt2z3WHatJgh0HLWNw,171640
+cyclonedx/schema/schema.py,sha256=IrFOJRxIm0QKVhTWJ66YYIiUEWhdw2e6ow4jgINdeEQ,2600
+cyclonedx/serialization/__init__.py,sha256=aCSwHTvv3-BdjCa9P-n9vEMIwjMUkoPGy9ET_Br_QfE,2948
+cyclonedx/serialization/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/spdx.py,sha256=tqsqFPNS1wjTdsYBmZGa8rhFvqM1RKb2LZlajzv-zso,2545
+cyclonedx/validation/__init__.py,sha256=3pcKOCuVRtVGjEifqGcCt3vbKYiu7A2TP9AapuMJxdw,3873
+cyclonedx/validation/__pycache__/__init__.cpython-312.pyc,,
+cyclonedx/validation/__pycache__/json.cpython-312.pyc,,
+cyclonedx/validation/__pycache__/model.cpython-312.pyc,,
+cyclonedx/validation/__pycache__/xml.cpython-312.pyc,,
+cyclonedx/validation/json.py,sha256=W0evPvXLGSktihaErEf9lqibuLJNwl58UpJxB_bERAw,4867
+cyclonedx/validation/model.py,sha256=eMAyQngKFWZpwrWPA_VBYb_VAfJJZonzJH5_a4vjyu0,903
+cyclonedx/validation/xml.py,sha256=uYsHKq-incWjdxuhB9XzxcsfiPDEwK0nM6j9J_DaAV8,3722
+cyclonedx_python_lib-9.1.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+cyclonedx_python_lib-9.1.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+cyclonedx_python_lib-9.1.0.dist-info/METADATA,sha256=LF6_HMeMPpV4a537MmhdE5qE1jA2C5JcoiAyjXkjhYk,6484
+cyclonedx_python_lib-9.1.0.dist-info/NOTICE,sha256=HDvWe5aIikyiXzqUaD2Smz9m1-TN_mwE0k8WUBqTdcM,147
+cyclonedx_python_lib-9.1.0.dist-info/RECORD,,
+cyclonedx_python_lib-9.1.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
diff --git a/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/WHEEL
new file mode 100644
index 00000000..0582547b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/cyclonedx_python_lib-9.1.0.dist-info/WHEEL
@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.1.1
+Root-Is-Purelib: true
+Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/LICENSE b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/LICENSE
new file mode 100644
index 00000000..311690c6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/LICENSE
@@ -0,0 +1,49 @@
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+--------------------------------------------
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+("PSF"), and the Individual or Organization ("Licensee") accessing and
+otherwise using this software ("Python") in source or binary form and
+its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
+license to reproduce, analyze, test, perform and/or display publicly,
+prepare derivative works, distribute, and otherwise use Python
+alone or in any derivative version, provided, however, that PSF's
+License Agreement and PSF's notice of copyright, i.e., "Copyright (c)
+2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Python Software Foundation;
+All Rights Reserved" are retained in Python alone or in any derivative
+version prepared by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS"
+basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between PSF and
+Licensee. This License Agreement does not grant permission to use PSF
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.
+
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/METADATA
new file mode 100644
index 00000000..f916e891
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/METADATA
@@ -0,0 +1,978 @@
+Metadata-Version: 2.1
+Name: defusedxml
+Version: 0.7.1
+Summary: XML bomb protection for Python stdlib modules
+Home-page: https://github.com/tiran/defusedxml
+Author: Christian Heimes
+Author-email: christian@python.org
+Maintainer: Christian Heimes
+Maintainer-email: christian@python.org
+License: PSFL
+Download-URL: https://pypi.python.org/pypi/defusedxml
+Keywords: xml bomb DoS
+Platform: all
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Python Software Foundation License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+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: Programming Language :: Python :: 3.9
+Classifier: Topic :: Text Processing :: Markup :: XML
+Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
+
+===================================================
+defusedxml -- defusing XML bombs and other exploits
+===================================================
+
+.. image:: https://img.shields.io/pypi/v/defusedxml.svg
+ :target: https://pypi.org/project/defusedxml/
+ :alt: Latest Version
+
+.. image:: https://img.shields.io/pypi/pyversions/defusedxml.svg
+ :target: https://pypi.org/project/defusedxml/
+ :alt: Supported Python versions
+
+.. image:: https://travis-ci.org/tiran/defusedxml.svg?branch=master
+ :target: https://travis-ci.org/tiran/defusedxml
+ :alt: Travis CI
+
+.. image:: https://codecov.io/github/tiran/defusedxml/coverage.svg?branch=master
+ :target: https://codecov.io/github/tiran/defusedxml?branch=master
+ :alt: codecov
+
+.. image:: https://img.shields.io/pypi/dm/defusedxml.svg
+ :target: https://pypistats.org/packages/defusedxml
+ :alt: PyPI downloads
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+ :target: https://github.com/psf/black
+ :alt: Code style: black
+
+..
+
+ "It's just XML, what could probably go wrong?"
+
+Christian Heimes
+
+Synopsis
+========
+
+The results of an attack on a vulnerable XML library can be fairly dramatic.
+With just a few hundred **Bytes** of XML data an attacker can occupy several
+**Gigabytes** of memory within **seconds**. An attacker can also keep
+CPUs busy for a long time with a small to medium size request. Under some
+circumstances it is even possible to access local files on your
+server, to circumvent a firewall, or to abuse services to rebound attacks to
+third parties.
+
+The attacks use and abuse less common features of XML and its parsers. The
+majority of developers are unacquainted with features such as processing
+instructions and entity expansions that XML inherited from SGML. At best
+they know about ```` from experience with HTML but they are not
+aware that a document type definition (DTD) can generate an HTTP request
+or load a file from the file system.
+
+None of the issues is new. They have been known for a long time. Billion
+laughs was first reported in 2003. Nevertheless some XML libraries and
+applications are still vulnerable and even heavy users of XML are
+surprised by these features. It's hard to say whom to blame for the
+situation. It's too short sighted to shift all blame on XML parsers and
+XML libraries for using insecure default settings. After all they
+properly implement XML specifications. Application developers must not rely
+that a library is always configured for security and potential harmful data
+by default.
+
+
+.. contents:: Table of Contents
+ :depth: 2
+
+
+Attack vectors
+==============
+
+billion laughs / exponential entity expansion
+---------------------------------------------
+
+The `Billion Laughs`_ attack -- also known as exponential entity expansion --
+uses multiple levels of nested entities. The original example uses 9 levels
+of 10 expansions in each level to expand the string ``lol`` to a string of
+3 * 10 :sup:`9` bytes, hence the name "billion laughs". The resulting string
+occupies 3 GB (2.79 GiB) of memory; intermediate strings require additional
+memory. Because most parsers don't cache the intermediate step for every
+expansion it is repeated over and over again. It increases the CPU load even
+more.
+
+An XML document of just a few hundred bytes can disrupt all services on a
+machine within seconds.
+
+Example XML::
+
+
+
+
+
+ ]>
+ &d;
+
+
+quadratic blowup entity expansion
+---------------------------------
+
+A quadratic blowup attack is similar to a `Billion Laughs`_ attack; it abuses
+entity expansion, too. Instead of nested entities it repeats one large entity
+with a couple of thousand chars over and over again. The attack isn't as
+efficient as the exponential case but it avoids triggering countermeasures of
+parsers against heavily nested entities. Some parsers limit the depth and
+breadth of a single entity but not the total amount of expanded text
+throughout an entire XML document.
+
+A medium-sized XML document with a couple of hundred kilobytes can require a
+couple of hundred MB to several GB of memory. When the attack is combined
+with some level of nested expansion an attacker is able to achieve a higher
+ratio of success.
+
+::
+
+
+ ]>
+ &a;&a;&a;... repeat
+
+
+external entity expansion (remote)
+----------------------------------
+
+Entity declarations can contain more than just text for replacement. They can
+also point to external resources by public identifiers or system identifiers.
+System identifiers are standard URIs. When the URI is a URL (e.g. a
+``http://`` locator) some parsers download the resource from the remote
+location and embed them into the XML document verbatim.
+
+Simple example of a parsed external entity::
+
+
+ ]>
+ ⅇ
+
+The case of parsed external entities works only for valid XML content. The
+XML standard also supports unparsed external entities with a
+``NData declaration``.
+
+External entity expansion opens the door to plenty of exploits. An attacker
+can abuse a vulnerable XML library and application to rebound and forward
+network requests with the IP address of the server. It highly depends
+on the parser and the application what kind of exploit is possible. For
+example:
+
+* An attacker can circumvent firewalls and gain access to restricted
+ resources as all the requests are made from an internal and trustworthy
+ IP address, not from the outside.
+* An attacker can abuse a service to attack, spy on or DoS your servers but
+ also third party services. The attack is disguised with the IP address of
+ the server and the attacker is able to utilize the high bandwidth of a big
+ machine.
+* An attacker can exhaust additional resources on the machine, e.g. with
+ requests to a service that doesn't respond or responds with very large
+ files.
+* An attacker may gain knowledge, when, how often and from which IP address
+ an XML document is accessed.
+* An attacker could send mail from inside your network if the URL handler
+ supports ``smtp://`` URIs.
+
+
+external entity expansion (local file)
+--------------------------------------
+
+External entities with references to local files are a sub-case of external
+entity expansion. It's listed as an extra attack because it deserves extra
+attention. Some XML libraries such as lxml disable network access by default
+but still allow entity expansion with local file access by default. Local
+files are either referenced with a ``file://`` URL or by a file path (either
+relative or absolute).
+
+An attacker may be able to access and download all files that can be read by
+the application process. This may include critical configuration files, too.
+
+::
+
+
+ ]>
+ ⅇ
+
+
+DTD retrieval
+-------------
+
+This case is similar to external entity expansion, too. Some XML libraries
+like Python's xml.dom.pulldom retrieve document type definitions from remote
+or local locations. Several attack scenarios from the external entity case
+apply to this issue as well.
+
+::
+
+
+
+
+
+ text
+
+
+
+Python XML Libraries
+====================
+
+.. csv-table:: vulnerabilities and features
+ :header: "kind", "sax", "etree", "minidom", "pulldom", "xmlrpc", "lxml", "genshi"
+ :widths: 24, 7, 8, 8, 7, 8, 8, 8
+ :stub-columns: 0
+
+ "billion laughs", "**True**", "**True**", "**True**", "**True**", "**True**", "False (1)", "False (5)"
+ "quadratic blowup", "**True**", "**True**", "**True**", "**True**", "**True**", "**True**", "False (5)"
+ "external entity expansion (remote)", "**True**", "False (3)", "False (4)", "**True**", "false", "False (1)", "False (5)"
+ "external entity expansion (local file)", "**True**", "False (3)", "False (4)", "**True**", "false", "**True**", "False (5)"
+ "DTD retrieval", "**True**", "False", "False", "**True**", "false", "False (1)", "False"
+ "gzip bomb", "False", "False", "False", "False", "**True**", "**partly** (2)", "False"
+ "xpath support (7)", "False", "False", "False", "False", "False", "**True**", "False"
+ "xsl(t) support (7)", "False", "False", "False", "False", "False", "**True**", "False"
+ "xinclude support (7)", "False", "**True** (6)", "False", "False", "False", "**True** (6)", "**True**"
+ "C library", "expat", "expat", "expat", "expat", "expat", "libxml2", "expat"
+
+1. Lxml is protected against billion laughs attacks and doesn't do network
+ lookups by default.
+2. libxml2 and lxml are not directly vulnerable to gzip decompression bombs
+ but they don't protect you against them either.
+3. xml.etree doesn't expand entities and raises a ParserError when an entity
+ occurs.
+4. minidom doesn't expand entities and simply returns the unexpanded entity
+ verbatim.
+5. genshi.input of genshi 0.6 doesn't support entity expansion and raises a
+ ParserError when an entity occurs.
+6. Library has (limited) XInclude support but requires an additional step to
+ process inclusion.
+7. These are features but they may introduce exploitable holes, see
+ `Other things to consider`_
+
+
+Settings in standard library
+----------------------------
+
+
+xml.sax.handler Features
+........................
+
+feature_external_ges (http://xml.org/sax/features/external-general-entities)
+ disables external entity expansion
+
+feature_external_pes (http://xml.org/sax/features/external-parameter-entities)
+ the option is ignored and doesn't modify any functionality
+
+DOM xml.dom.xmlbuilder.Options
+..............................
+
+external_parameter_entities
+ ignored
+
+external_general_entities
+ ignored
+
+external_dtd_subset
+ ignored
+
+entities
+ unsure
+
+
+defusedxml
+==========
+
+The `defusedxml package`_ (`defusedxml on PyPI`_)
+contains several Python-only workarounds and fixes
+for denial of service and other vulnerabilities in Python's XML libraries.
+In order to benefit from the protection you just have to import and use the
+listed functions / classes from the right defusedxml module instead of the
+original module. Merely `defusedxml.xmlrpc`_ is implemented as monkey patch.
+
+Instead of::
+
+ >>> from xml.etree.ElementTree import parse
+ >>> et = parse(xmlfile)
+
+alter code to::
+
+ >>> from defusedxml.ElementTree import parse
+ >>> et = parse(xmlfile)
+
+Additionally the package has an **untested** function to monkey patch
+all stdlib modules with ``defusedxml.defuse_stdlib()``.
+
+All functions and parser classes accept three additional keyword arguments.
+They return either the same objects as the original functions or compatible
+subclasses.
+
+forbid_dtd (default: False)
+ disallow XML with a ```` processing instruction and raise a
+ *DTDForbidden* exception when a DTD processing instruction is found.
+
+forbid_entities (default: True)
+ disallow XML with ```` declarations inside the DTD and raise an
+ *EntitiesForbidden* exception when an entity is declared.
+
+forbid_external (default: True)
+ disallow any access to remote or local resources in external entities
+ or DTD and raising an *ExternalReferenceForbidden* exception when a DTD
+ or entity references an external resource.
+
+
+defusedxml (package)
+--------------------
+
+DefusedXmlException, DTDForbidden, EntitiesForbidden,
+ExternalReferenceForbidden, NotSupportedError
+
+defuse_stdlib() (*experimental*)
+
+
+defusedxml.cElementTree
+-----------------------
+
+**NOTE** ``defusedxml.cElementTree`` is deprecated and will be removed in a
+future release. Import from ``defusedxml.ElementTree`` instead.
+
+parse(), iterparse(), fromstring(), XMLParser
+
+
+defusedxml.ElementTree
+-----------------------
+
+parse(), iterparse(), fromstring(), XMLParser
+
+
+defusedxml.expatreader
+----------------------
+
+create_parser(), DefusedExpatParser
+
+
+defusedxml.sax
+--------------
+
+parse(), parseString(), make_parser()
+
+
+defusedxml.expatbuilder
+-----------------------
+
+parse(), parseString(), DefusedExpatBuilder, DefusedExpatBuilderNS
+
+
+defusedxml.minidom
+------------------
+
+parse(), parseString()
+
+
+defusedxml.pulldom
+------------------
+
+parse(), parseString()
+
+
+defusedxml.xmlrpc
+-----------------
+
+The fix is implemented as monkey patch for the stdlib's xmlrpc package (3.x)
+or xmlrpclib module (2.x). The function `monkey_patch()` enables the fixes,
+`unmonkey_patch()` removes the patch and puts the code in its former state.
+
+The monkey patch protects against XML related attacks as well as
+decompression bombs and excessively large requests or responses. The default
+setting is 30 MB for requests, responses and gzip decompression. You can
+modify the default by changing the module variable `MAX_DATA`. A value of
+`-1` disables the limit.
+
+
+defusedxml.lxml
+---------------
+
+**DEPRECATED** The module is deprecated and will be removed in a future
+release.
+
+The module acts as an *example* how you could protect code that uses
+lxml.etree. It implements a custom Element class that filters out
+Entity instances, a custom parser factory and a thread local storage for
+parser instances. It also has a check_docinfo() function which inspects
+a tree for internal or external DTDs and entity declarations. In order to
+check for entities lxml > 3.0 is required.
+
+parse(), fromstring()
+RestrictedElement, GlobalParserTLS, getDefaultParser(), check_docinfo()
+
+
+defusedexpat
+============
+
+The `defusedexpat package`_ (`defusedexpat on PyPI`_)
+comes with binary extensions and a
+`modified expat`_ library instead of the standard `expat parser`_. It's
+basically a stand-alone version of the patches for Python's standard
+library C extensions.
+
+Modifications in expat
+----------------------
+
+new definitions::
+
+ XML_BOMB_PROTECTION
+ XML_DEFAULT_MAX_ENTITY_INDIRECTIONS
+ XML_DEFAULT_MAX_ENTITY_EXPANSIONS
+ XML_DEFAULT_RESET_DTD
+
+new XML_FeatureEnum members::
+
+ XML_FEATURE_MAX_ENTITY_INDIRECTIONS
+ XML_FEATURE_MAX_ENTITY_EXPANSIONS
+ XML_FEATURE_IGNORE_DTD
+
+new XML_Error members::
+
+ XML_ERROR_ENTITY_INDIRECTIONS
+ XML_ERROR_ENTITY_EXPANSION
+
+new API functions::
+
+ int XML_GetFeature(XML_Parser parser,
+ enum XML_FeatureEnum feature,
+ long *value);
+ int XML_SetFeature(XML_Parser parser,
+ enum XML_FeatureEnum feature,
+ long value);
+ int XML_GetFeatureDefault(enum XML_FeatureEnum feature,
+ long *value);
+ int XML_SetFeatureDefault(enum XML_FeatureEnum feature,
+ long value);
+
+XML_FEATURE_MAX_ENTITY_INDIRECTIONS
+ Limit the amount of indirections that are allowed to occur during the
+ expansion of a nested entity. A counter starts when an entity reference
+ is encountered. It resets after the entity is fully expanded. The limit
+ protects the parser against exponential entity expansion attacks (aka
+ billion laughs attack). When the limit is exceeded the parser stops and
+ fails with `XML_ERROR_ENTITY_INDIRECTIONS`.
+ A value of 0 disables the protection.
+
+ Supported range
+ 0 .. UINT_MAX
+ Default
+ 40
+
+XML_FEATURE_MAX_ENTITY_EXPANSIONS
+ Limit the total length of all entity expansions throughout the entire
+ document. The lengths of all entities are accumulated in a parser variable.
+ The setting protects against quadratic blowup attacks (lots of expansions
+ of a large entity declaration). When the sum of all entities exceeds
+ the limit, the parser stops and fails with `XML_ERROR_ENTITY_EXPANSION`.
+ A value of 0 disables the protection.
+
+ Supported range
+ 0 .. UINT_MAX
+ Default
+ 8 MiB
+
+XML_FEATURE_RESET_DTD
+ Reset all DTD information after the block has been parsed. When
+ the flag is set (default: false) all DTD information after the
+ endDoctypeDeclHandler has been called. The flag can be set inside the
+ endDoctypeDeclHandler. Without DTD information any entity reference in
+ the document body leads to `XML_ERROR_UNDEFINED_ENTITY`.
+
+ Supported range
+ 0, 1
+ Default
+ 0
+
+
+How to avoid XML vulnerabilities
+================================
+
+Best practices
+--------------
+
+* Don't allow DTDs
+* Don't expand entities
+* Don't resolve externals
+* Limit parse depth
+* Limit total input size
+* Limit parse time
+* Favor a SAX or iterparse-like parser for potential large data
+* Validate and properly quote arguments to XSL transformations and
+ XPath queries
+* Don't use XPath expression from untrusted sources
+* Don't apply XSL transformations that come untrusted sources
+
+(based on Brad Hill's `Attacking XML Security`_)
+
+
+Other things to consider
+========================
+
+XML, XML parsers and processing libraries have more features and possible
+issue that could lead to DoS vulnerabilities or security exploits in
+applications. I have compiled an incomplete list of theoretical issues that
+need further research and more attention. The list is deliberately pessimistic
+and a bit paranoid, too. It contains things that might go wrong under daffy
+circumstances.
+
+
+attribute blowup / hash collision attack
+----------------------------------------
+
+XML parsers may use an algorithm with quadratic runtime O(n :sup:`2`) to
+handle attributes and namespaces. If it uses hash tables (dictionaries) to
+store attributes and namespaces the implementation may be vulnerable to
+hash collision attacks, thus reducing the performance to O(n :sup:`2`) again.
+In either case an attacker is able to forge a denial of service attack with
+an XML document that contains thousands upon thousands of attributes in
+a single node.
+
+I haven't researched yet if expat, pyexpat or libxml2 are vulnerable.
+
+
+decompression bomb
+------------------
+
+The issue of decompression bombs (aka `ZIP bomb`_) apply to all XML libraries
+that can parse compressed XML stream like gzipped HTTP streams or LZMA-ed
+files. For an attacker it can reduce the amount of transmitted data by three
+magnitudes or more. Gzip is able to compress 1 GiB zeros to roughly 1 MB,
+lzma is even better::
+
+ $ dd if=/dev/zero bs=1M count=1024 | gzip > zeros.gz
+ $ dd if=/dev/zero bs=1M count=1024 | lzma -z > zeros.xy
+ $ ls -sh zeros.*
+ 1020K zeros.gz
+ 148K zeros.xy
+
+None of Python's standard XML libraries decompress streams except for
+``xmlrpclib``. The module is vulnerable
+to decompression bombs.
+
+lxml can load and process compressed data through libxml2 transparently.
+libxml2 can handle even very large blobs of compressed data efficiently
+without using too much memory. But it doesn't protect applications from
+decompression bombs. A carefully written SAX or iterparse-like approach can
+be safe.
+
+
+Processing Instruction
+----------------------
+
+`PI`_'s like::
+
+
+
+may impose more threats for XML processing. It depends if and how a
+processor handles processing instructions. The issue of URL retrieval with
+network or local file access apply to processing instructions, too.
+
+
+Other DTD features
+------------------
+
+`DTD`_ has more features like ````. I haven't researched how
+these features may be a security threat.
+
+
+XPath
+-----
+
+XPath statements may introduce DoS vulnerabilities. Code should never execute
+queries from untrusted sources. An attacker may also be able to create an XML
+document that makes certain XPath queries costly or resource hungry.
+
+
+XPath injection attacks
+-----------------------
+
+XPath injeciton attacks pretty much work like SQL injection attacks.
+Arguments to XPath queries must be quoted and validated properly, especially
+when they are taken from the user. The page `Avoid the dangers of XPath injection`_
+list some ramifications of XPath injections.
+
+Python's standard library doesn't have XPath support. Lxml supports
+parameterized XPath queries which does proper quoting. You just have to use
+its xpath() method correctly::
+
+ # DON'T
+ >>> tree.xpath("/tag[@id='%s']" % value)
+
+ # instead do
+ >>> tree.xpath("/tag[@id=$tagid]", tagid=name)
+
+
+XInclude
+--------
+
+`XML Inclusion`_ is another way to load and include external files::
+
+
+
+
+
+This feature should be disabled when XML files from an untrusted source are
+processed. Some Python XML libraries and libxml2 support XInclude but don't
+have an option to sandbox inclusion and limit it to allowed directories.
+
+
+XMLSchema location
+------------------
+
+A validating XML parser may download schema files from the information in a
+``xsi:schemaLocation`` attribute.
+
+::
+
+
+
+
+
+XSL Transformation
+------------------
+
+You should keep in mind that XSLT is a Turing complete language. Never
+process XSLT code from unknown or untrusted source! XSLT processors may
+allow you to interact with external resources in ways you can't even imagine.
+Some processors even support extensions that allow read/write access to file
+system, access to JRE objects or scripting with Jython.
+
+Example from `Attacking XML Security`_ for Xalan-J::
+
+
+
+
+
+
+
+
+
+
+
+Related CVEs
+============
+
+CVE-2013-1664
+ Unrestricted entity expansion induces DoS vulnerabilities in Python XML
+ libraries (XML bomb)
+
+CVE-2013-1665
+ External entity expansion in Python XML libraries inflicts potential
+ security flaws and DoS vulnerabilities
+
+
+Other languages / frameworks
+=============================
+
+Several other programming languages and frameworks are vulnerable as well. A
+couple of them are affected by the fact that libxml2 up to 2.9.0 has no
+protection against quadratic blowup attacks. Most of them have potential
+dangerous default settings for entity expansion and external entities, too.
+
+Perl
+----
+
+Perl's XML::Simple is vulnerable to quadratic entity expansion and external
+entity expansion (both local and remote).
+
+
+Ruby
+----
+
+Ruby's REXML document parser is vulnerable to entity expansion attacks
+(both quadratic and exponential) but it doesn't do external entity
+expansion by default. In order to counteract entity expansion you have to
+disable the feature::
+
+ REXML::Document.entity_expansion_limit = 0
+
+libxml-ruby and hpricot don't expand entities in their default configuration.
+
+
+PHP
+---
+
+PHP's SimpleXML API is vulnerable to quadratic entity expansion and loads
+entities from local and remote resources. The option ``LIBXML_NONET`` disables
+network access but still allows local file access. ``LIBXML_NOENT`` seems to
+have no effect on entity expansion in PHP 5.4.6.
+
+
+C# / .NET / Mono
+----------------
+
+Information in `XML DoS and Defenses (MSDN)`_ suggest that .NET is
+vulnerable with its default settings. The article contains code snippets
+how to create a secure XML reader::
+
+ XmlReaderSettings settings = new XmlReaderSettings();
+ settings.ProhibitDtd = false;
+ settings.MaxCharactersFromEntities = 1024;
+ settings.XmlResolver = null;
+ XmlReader reader = XmlReader.Create(stream, settings);
+
+
+Java
+----
+
+Untested. The documentation of Xerces and its `Xerces SecurityMananger`_
+sounds like Xerces is also vulnerable to billion laugh attacks with its
+default settings. It also does entity resolving when an
+``org.xml.sax.EntityResolver`` is configured. I'm not yet sure about the
+default setting here.
+
+Java specialists suggest to have a custom builder factory::
+
+ DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
+ builderFactory.setXIncludeAware(False);
+ builderFactory.setExpandEntityReferences(False);
+ builderFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, True);
+ # either
+ builderFactory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", True);
+ # or if you need DTDs
+ builderFactory.setFeature("http://xml.org/sax/features/external-general-entities", False);
+ builderFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", False);
+ builderFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", False);
+ builderFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-dtd-grammar", False);
+
+
+TODO
+====
+
+* DOM: Use xml.dom.xmlbuilder options for entity handling
+* SAX: take feature_external_ges and feature_external_pes (?) into account
+* test experimental monkey patching of stdlib modules
+* improve documentation
+
+
+License
+=======
+
+Copyright (c) 2013-2017 by Christian Heimes
+
+Licensed to PSF under a Contributor Agreement.
+
+See https://www.python.org/psf/license for licensing details.
+
+
+Acknowledgements
+================
+
+Brett Cannon (Python Core developer)
+ review and code cleanup
+
+Antoine Pitrou (Python Core developer)
+ code review
+
+Aaron Patterson, Ben Murphy and Michael Koziarski (Ruby community)
+ Many thanks to Aaron, Ben and Michael from the Ruby community for their
+ report and assistance.
+
+Thierry Carrez (OpenStack)
+ Many thanks to Thierry for his report to the Python Security Response
+ Team on behalf of the OpenStack security team.
+
+Carl Meyer (Django)
+ Many thanks to Carl for his report to PSRT on behalf of the Django security
+ team.
+
+Daniel Veillard (libxml2)
+ Many thanks to Daniel for his insight and assistance with libxml2.
+
+semantics GmbH (https://www.semantics.de/)
+ Many thanks to my employer semantics for letting me work on the issue
+ during working hours as part of semantics's open source initiative.
+
+
+References
+==========
+
+* `XML DoS and Defenses (MSDN)`_
+* `Billion Laughs`_ on Wikipedia
+* `ZIP bomb`_ on Wikipedia
+* `Configure SAX parsers for secure processing`_
+* `Testing for XML Injection`_
+
+.. _defusedxml package: https://github.com/tiran/defusedxml
+.. _defusedxml on PyPI: https://pypi.python.org/pypi/defusedxml
+.. _defusedexpat package: https://github.com/tiran/defusedexpat
+.. _defusedexpat on PyPI: https://pypi.python.org/pypi/defusedexpat
+.. _modified expat: https://github.com/tiran/expat
+.. _expat parser: http://expat.sourceforge.net/
+.. _Attacking XML Security: https://www.isecpartners.com/media/12976/iSEC-HILL-Attacking-XML-Security-bh07.pdf
+.. _Billion Laughs: https://en.wikipedia.org/wiki/Billion_laughs
+.. _XML DoS and Defenses (MSDN): https://msdn.microsoft.com/en-us/magazine/ee335713.aspx
+.. _ZIP bomb: https://en.wikipedia.org/wiki/Zip_bomb
+.. _DTD: https://en.wikipedia.org/wiki/Document_Type_Definition
+.. _PI: https://en.wikipedia.org/wiki/Processing_Instruction
+.. _Avoid the dangers of XPath injection: http://www.ibm.com/developerworks/xml/library/x-xpathinjection/index.html
+.. _Configure SAX parsers for secure processing: http://www.ibm.com/developerworks/xml/library/x-tipcfsx/index.html
+.. _Testing for XML Injection: https://www.owasp.org/index.php/Testing_for_XML_Injection_(OWASP-DV-008)
+.. _Xerces SecurityMananger: https://xerces.apache.org/xerces2-j/javadocs/xerces2/org/apache/xerces/util/SecurityManager.html
+.. _XML Inclusion: https://www.w3.org/TR/xinclude/#include_element
+
+Changelog
+=========
+
+defusedxml 0.7.1
+---------------------
+
+*Release date: 08-Mar-2021*
+
+- Fix regression ``defusedxml.ElementTree.ParseError`` (#63)
+ The ``ParseError`` exception is now the same class object as
+ ``xml.etree.ElementTree.ParseError`` again.
+
+
+defusedxml 0.7.0
+----------------
+
+*Release date: 4-Mar-2021*
+
+- No changes
+
+
+defusedxml 0.7.0rc2
+-------------------
+
+*Release date: 12-Jan-2021*
+
+- Re-add and deprecate ``defusedxml.cElementTree``
+- Use GitHub Actions instead of TravisCI
+- Restore ``ElementTree`` attribute of ``xml.etree`` module after patching
+
+defusedxml 0.7.0rc1
+-------------------
+
+*Release date: 04-May-2020*
+
+- Add support for Python 3.9
+- ``defusedxml.cElementTree`` is not available with Python 3.9.
+- Python 2 is deprecate. Support for Python 2 will be removed in 0.8.0.
+
+
+defusedxml 0.6.0
+----------------
+
+*Release date: 17-Apr-2019*
+
+- Increase test coverage.
+- Add badges to README.
+
+
+defusedxml 0.6.0rc1
+-------------------
+
+*Release date: 14-Apr-2019*
+
+- Test on Python 3.7 stable and 3.8-dev
+- Drop support for Python 3.4
+- No longer pass *html* argument to XMLParse. It has been deprecated and
+ ignored for a long time. The DefusedXMLParser still takes a html argument.
+ A deprecation warning is issued when the argument is False and a TypeError
+ when it's True.
+- defusedxml now fails early when pyexpat stdlib module is not available or
+ broken.
+- defusedxml.ElementTree.__all__ now lists ParseError as public attribute.
+- The defusedxml.ElementTree and defusedxml.cElementTree modules had a typo
+ and used XMLParse instead of XMLParser as an alias for DefusedXMLParser.
+ Both the old and fixed name are now available.
+
+
+defusedxml 0.5.0
+----------------
+
+*Release date: 07-Feb-2017*
+
+- No changes
+
+
+defusedxml 0.5.0.rc1
+--------------------
+
+*Release date: 28-Jan-2017*
+
+- Add compatibility with Python 3.6
+- Drop support for Python 2.6, 3.1, 3.2, 3.3
+- Fix lxml tests (XMLSyntaxError: Detected an entity reference loop)
+
+
+defusedxml 0.4.1
+----------------
+
+*Release date: 28-Mar-2013*
+
+- Add more demo exploits, e.g. python_external.py and Xalan XSLT demos.
+- Improved documentation.
+
+
+defusedxml 0.4
+--------------
+
+*Release date: 25-Feb-2013*
+
+- As per http://seclists.org/oss-sec/2013/q1/340 please REJECT
+ CVE-2013-0278, CVE-2013-0279 and CVE-2013-0280 and use CVE-2013-1664,
+ CVE-2013-1665 for OpenStack/etc.
+- Add missing parser_list argument to sax.make_parser(). The argument is
+ ignored, though. (thanks to Florian Apolloner)
+- Add demo exploit for external entity attack on Python's SAX parser, XML-RPC
+ and WebDAV.
+
+
+defusedxml 0.3
+--------------
+
+*Release date: 19-Feb-2013*
+
+- Improve documentation
+
+
+defusedxml 0.2
+--------------
+
+*Release date: 15-Feb-2013*
+
+- Rename ExternalEntitiesForbidden to ExternalReferenceForbidden
+- Rename defusedxml.lxml.check_dtd() to check_docinfo()
+- Unify argument names in callbacks
+- Add arguments and formatted representation to exceptions
+- Add forbid_external argument to all functions and classes
+- More tests
+- LOTS of documentation
+- Add example code for other languages (Ruby, Perl, PHP) and parsers (Genshi)
+- Add protection against XML and gzip attacks to xmlrpclib
+
+defusedxml 0.1
+--------------
+
+*Release date: 08-Feb-2013*
+
+- Initial and internal release for PSRT review
+
+
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/RECORD
new file mode 100644
index 00000000..6d32da11
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/RECORD
@@ -0,0 +1,28 @@
+defusedxml-0.7.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+defusedxml-0.7.1.dist-info/LICENSE,sha256=uAzp2oxCofkQeWJ_u-K_JyEK4Qig_-Xwd9WwjgdsJMg,2409
+defusedxml-0.7.1.dist-info/METADATA,sha256=Np0872SHDa-En7pxHLjQWn7-PI2asPdjrcNAef43i7E,32518
+defusedxml-0.7.1.dist-info/RECORD,,
+defusedxml-0.7.1.dist-info/WHEEL,sha256=kGT74LWyRUZrL4VgLh6_g12IeVl_9u9ZVhadrgXZUEY,110
+defusedxml-0.7.1.dist-info/top_level.txt,sha256=QGHa90F50pVKhWSFlERI0jtSKtqDiGyfeZX7dQNZAAw,11
+defusedxml/ElementTree.py,sha256=GLSqpCz58oXGPGyzf_HylsPS9_dcGVP5SN4dK7yvyPw,4640
+defusedxml/__init__.py,sha256=RczeaVJG64p2Fgy1jlCzbuRdchEPnEaCBrxgk8JJ_pM,1444
+defusedxml/__pycache__/ElementTree.cpython-312.pyc,,
+defusedxml/__pycache__/__init__.cpython-312.pyc,,
+defusedxml/__pycache__/cElementTree.cpython-312.pyc,,
+defusedxml/__pycache__/common.cpython-312.pyc,,
+defusedxml/__pycache__/expatbuilder.cpython-312.pyc,,
+defusedxml/__pycache__/expatreader.cpython-312.pyc,,
+defusedxml/__pycache__/lxml.cpython-312.pyc,,
+defusedxml/__pycache__/minidom.cpython-312.pyc,,
+defusedxml/__pycache__/pulldom.cpython-312.pyc,,
+defusedxml/__pycache__/sax.cpython-312.pyc,,
+defusedxml/__pycache__/xmlrpc.cpython-312.pyc,,
+defusedxml/cElementTree.py,sha256=PpaKMh3rU29sY8amAK4fzHQKl8gcAYD0h1LCoW62Rtk,1449
+defusedxml/common.py,sha256=3d26jNW4fNXzgjWhvUfs83Afiz5EVxFDupQbugkSMZc,4036
+defusedxml/expatbuilder.py,sha256=b4Q05vsBMJ5StkiTFf4my2rGGo1gZyEl_hC5MeFTOAA,3732
+defusedxml/expatreader.py,sha256=KOpSrwkSvj5SGOY9pTXOM26Dnz00rsJt33WueVvzpvc,2196
+defusedxml/lxml.py,sha256=HW-LFKdrfMRzHdi0Vcucq4-n8yz7v_OQwEQWFg1JQYA,4940
+defusedxml/minidom.py,sha256=3QcgygVwJqcWDQ3IZ2iol8zsH4cx3BRX70SPcd0bG2g,1884
+defusedxml/pulldom.py,sha256=DYj2D2lc7xoxZ38gfzujXmdznd8ovzDqGFXqyXbtxjk,1170
+defusedxml/sax.py,sha256=-SF08Msc2mWEYAMw62pJ5FMwWccOctFSnQwDLYLLlVE,1477
+defusedxml/xmlrpc.py,sha256=7rZQey3tqXcc1hrrM3RprOICU6fiFny9B9l4nmTioxA,5364
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/WHEEL
new file mode 100644
index 00000000..ef99c6cf
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/WHEEL
@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.34.2)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/top_level.txt b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/top_level.txt
new file mode 100644
index 00000000..36969f2c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml-0.7.1.dist-info/top_level.txt
@@ -0,0 +1 @@
+defusedxml
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/ElementTree.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/ElementTree.py
new file mode 100644
index 00000000..5ba765f1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/ElementTree.py
@@ -0,0 +1,154 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xml.etree.ElementTree facade
+"""
+from __future__ import print_function, absolute_import
+
+import sys
+import warnings
+from xml.etree.ElementTree import ParseError
+from xml.etree.ElementTree import TreeBuilder as _TreeBuilder
+from xml.etree.ElementTree import parse as _parse
+from xml.etree.ElementTree import tostring
+
+from .common import PY3
+
+if PY3:
+ import importlib
+else:
+ from xml.etree.ElementTree import XMLParser as _XMLParser
+ from xml.etree.ElementTree import iterparse as _iterparse
+
+
+from .common import (
+ DTDForbidden,
+ EntitiesForbidden,
+ ExternalReferenceForbidden,
+ _generate_etree_functions,
+)
+
+__origin__ = "xml.etree.ElementTree"
+
+
+def _get_py3_cls():
+ """Python 3.3 hides the pure Python code but defusedxml requires it.
+
+ The code is based on test.support.import_fresh_module().
+ """
+ pymodname = "xml.etree.ElementTree"
+ cmodname = "_elementtree"
+
+ pymod = sys.modules.pop(pymodname, None)
+ cmod = sys.modules.pop(cmodname, None)
+
+ sys.modules[cmodname] = None
+ try:
+ pure_pymod = importlib.import_module(pymodname)
+ finally:
+ # restore module
+ sys.modules[pymodname] = pymod
+ if cmod is not None:
+ sys.modules[cmodname] = cmod
+ else:
+ sys.modules.pop(cmodname, None)
+ # restore attribute on original package
+ etree_pkg = sys.modules["xml.etree"]
+ if pymod is not None:
+ etree_pkg.ElementTree = pymod
+ elif hasattr(etree_pkg, "ElementTree"):
+ del etree_pkg.ElementTree
+
+ _XMLParser = pure_pymod.XMLParser
+ _iterparse = pure_pymod.iterparse
+ # patch pure module to use ParseError from C extension
+ pure_pymod.ParseError = ParseError
+
+ return _XMLParser, _iterparse
+
+
+if PY3:
+ _XMLParser, _iterparse = _get_py3_cls()
+
+
+_sentinel = object()
+
+
+class DefusedXMLParser(_XMLParser):
+ def __init__(
+ self,
+ html=_sentinel,
+ target=None,
+ encoding=None,
+ forbid_dtd=False,
+ forbid_entities=True,
+ forbid_external=True,
+ ):
+ # Python 2.x old style class
+ _XMLParser.__init__(self, target=target, encoding=encoding)
+ if html is not _sentinel:
+ # the 'html' argument has been deprecated and ignored in all
+ # supported versions of Python. Python 3.8 finally removed it.
+ if html:
+ raise TypeError("'html=True' is no longer supported.")
+ else:
+ warnings.warn(
+ "'html' keyword argument is no longer supported. Pass "
+ "in arguments as keyword arguments.",
+ category=DeprecationWarning,
+ )
+
+ self.forbid_dtd = forbid_dtd
+ self.forbid_entities = forbid_entities
+ self.forbid_external = forbid_external
+ if PY3:
+ parser = self.parser
+ else:
+ parser = self._parser
+ if self.forbid_dtd:
+ parser.StartDoctypeDeclHandler = self.defused_start_doctype_decl
+ if self.forbid_entities:
+ parser.EntityDeclHandler = self.defused_entity_decl
+ parser.UnparsedEntityDeclHandler = self.defused_unparsed_entity_decl
+ if self.forbid_external:
+ parser.ExternalEntityRefHandler = self.defused_external_entity_ref_handler
+
+ def defused_start_doctype_decl(self, name, sysid, pubid, has_internal_subset):
+ raise DTDForbidden(name, sysid, pubid)
+
+ def defused_entity_decl(
+ self, name, is_parameter_entity, value, base, sysid, pubid, notation_name
+ ):
+ raise EntitiesForbidden(name, value, base, sysid, pubid, notation_name)
+
+ def defused_unparsed_entity_decl(self, name, base, sysid, pubid, notation_name):
+ # expat 1.2
+ raise EntitiesForbidden(name, None, base, sysid, pubid, notation_name) # pragma: no cover
+
+ def defused_external_entity_ref_handler(self, context, base, sysid, pubid):
+ raise ExternalReferenceForbidden(context, base, sysid, pubid)
+
+
+# aliases
+# XMLParse is a typo, keep it for backwards compatibility
+XMLTreeBuilder = XMLParse = XMLParser = DefusedXMLParser
+
+parse, iterparse, fromstring = _generate_etree_functions(
+ DefusedXMLParser, _TreeBuilder, _parse, _iterparse
+)
+XML = fromstring
+
+
+__all__ = [
+ "ParseError",
+ "XML",
+ "XMLParse",
+ "XMLParser",
+ "XMLTreeBuilder",
+ "fromstring",
+ "iterparse",
+ "parse",
+ "tostring",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__init__.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/__init__.py
new file mode 100644
index 00000000..4b5a2300
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/__init__.py
@@ -0,0 +1,67 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defuse XML bomb denial of service vulnerabilities
+"""
+from __future__ import print_function, absolute_import
+
+import warnings
+
+from .common import (
+ DefusedXmlException,
+ DTDForbidden,
+ EntitiesForbidden,
+ ExternalReferenceForbidden,
+ NotSupportedError,
+ _apply_defusing,
+)
+
+
+def defuse_stdlib():
+ """Monkey patch and defuse all stdlib packages
+
+ :warning: The monkey patch is an EXPERIMETNAL feature.
+ """
+ defused = {}
+
+ with warnings.catch_warnings():
+ from . import cElementTree
+ from . import ElementTree
+ from . import minidom
+ from . import pulldom
+ from . import sax
+ from . import expatbuilder
+ from . import expatreader
+ from . import xmlrpc
+
+ xmlrpc.monkey_patch()
+ defused[xmlrpc] = None
+
+ defused_mods = [
+ cElementTree,
+ ElementTree,
+ minidom,
+ pulldom,
+ sax,
+ expatbuilder,
+ expatreader,
+ ]
+
+ for defused_mod in defused_mods:
+ stdlib_mod = _apply_defusing(defused_mod)
+ defused[defused_mod] = stdlib_mod
+
+ return defused
+
+
+__version__ = "0.7.1"
+
+__all__ = [
+ "DefusedXmlException",
+ "DTDForbidden",
+ "EntitiesForbidden",
+ "ExternalReferenceForbidden",
+ "NotSupportedError",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/ElementTree.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/ElementTree.cpython-312.pyc
new file mode 100644
index 00000000..23e1ba60
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/ElementTree.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..f219052c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/cElementTree.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/cElementTree.cpython-312.pyc
new file mode 100644
index 00000000..588aba6a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/cElementTree.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/common.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/common.cpython-312.pyc
new file mode 100644
index 00000000..6e7d110b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/common.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/expatbuilder.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/expatbuilder.cpython-312.pyc
new file mode 100644
index 00000000..2a1a89f8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/expatbuilder.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/expatreader.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/expatreader.cpython-312.pyc
new file mode 100644
index 00000000..98dc2cef
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/expatreader.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/lxml.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/lxml.cpython-312.pyc
new file mode 100644
index 00000000..f73a4f34
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/lxml.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/minidom.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/minidom.cpython-312.pyc
new file mode 100644
index 00000000..af44060a
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/minidom.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/pulldom.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/pulldom.cpython-312.pyc
new file mode 100644
index 00000000..33ff8fe9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/pulldom.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/sax.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/sax.cpython-312.pyc
new file mode 100644
index 00000000..ce1df6c9
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/sax.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/xmlrpc.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/xmlrpc.cpython-312.pyc
new file mode 100644
index 00000000..e004870b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/defusedxml/__pycache__/xmlrpc.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/cElementTree.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/cElementTree.py
new file mode 100644
index 00000000..84670c68
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/cElementTree.py
@@ -0,0 +1,62 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xml.etree.cElementTree
+"""
+from __future__ import absolute_import
+
+import warnings
+
+from .common import _generate_etree_functions
+
+from xml.etree.cElementTree import TreeBuilder as _TreeBuilder
+from xml.etree.cElementTree import parse as _parse
+from xml.etree.cElementTree import tostring
+
+# iterparse from ElementTree!
+from xml.etree.ElementTree import iterparse as _iterparse
+
+# This module is an alias for ElementTree just like xml.etree.cElementTree
+from .ElementTree import (
+ XML,
+ XMLParse,
+ XMLParser,
+ XMLTreeBuilder,
+ fromstring,
+ iterparse,
+ parse,
+ tostring,
+ DefusedXMLParser,
+ ParseError,
+)
+
+__origin__ = "xml.etree.cElementTree"
+
+
+warnings.warn(
+ "defusedxml.cElementTree is deprecated, import from defusedxml.ElementTree instead.",
+ category=DeprecationWarning,
+ stacklevel=2,
+)
+
+# XMLParse is a typo, keep it for backwards compatibility
+XMLTreeBuilder = XMLParse = XMLParser = DefusedXMLParser
+
+parse, iterparse, fromstring = _generate_etree_functions(
+ DefusedXMLParser, _TreeBuilder, _parse, _iterparse
+)
+XML = fromstring
+
+__all__ = [
+ "ParseError",
+ "XML",
+ "XMLParse",
+ "XMLParser",
+ "XMLTreeBuilder",
+ "fromstring",
+ "iterparse",
+ "parse",
+ "tostring",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/common.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/common.py
new file mode 100644
index 00000000..5ceda1fb
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/common.py
@@ -0,0 +1,129 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Common constants, exceptions and helpe functions
+"""
+import sys
+import xml.parsers.expat
+
+PY3 = sys.version_info[0] == 3
+
+# Fail early when pyexpat is not installed correctly
+if not hasattr(xml.parsers.expat, "ParserCreate"):
+ raise ImportError("pyexpat") # pragma: no cover
+
+
+class DefusedXmlException(ValueError):
+ """Base exception"""
+
+ def __repr__(self):
+ return str(self)
+
+
+class DTDForbidden(DefusedXmlException):
+ """Document type definition is forbidden"""
+
+ def __init__(self, name, sysid, pubid):
+ super(DTDForbidden, self).__init__()
+ self.name = name
+ self.sysid = sysid
+ self.pubid = pubid
+
+ def __str__(self):
+ tpl = "DTDForbidden(name='{}', system_id={!r}, public_id={!r})"
+ return tpl.format(self.name, self.sysid, self.pubid)
+
+
+class EntitiesForbidden(DefusedXmlException):
+ """Entity definition is forbidden"""
+
+ def __init__(self, name, value, base, sysid, pubid, notation_name):
+ super(EntitiesForbidden, self).__init__()
+ self.name = name
+ self.value = value
+ self.base = base
+ self.sysid = sysid
+ self.pubid = pubid
+ self.notation_name = notation_name
+
+ def __str__(self):
+ tpl = "EntitiesForbidden(name='{}', system_id={!r}, public_id={!r})"
+ return tpl.format(self.name, self.sysid, self.pubid)
+
+
+class ExternalReferenceForbidden(DefusedXmlException):
+ """Resolving an external reference is forbidden"""
+
+ def __init__(self, context, base, sysid, pubid):
+ super(ExternalReferenceForbidden, self).__init__()
+ self.context = context
+ self.base = base
+ self.sysid = sysid
+ self.pubid = pubid
+
+ def __str__(self):
+ tpl = "ExternalReferenceForbidden(system_id='{}', public_id={})"
+ return tpl.format(self.sysid, self.pubid)
+
+
+class NotSupportedError(DefusedXmlException):
+ """The operation is not supported"""
+
+
+def _apply_defusing(defused_mod):
+ assert defused_mod is sys.modules[defused_mod.__name__]
+ stdlib_name = defused_mod.__origin__
+ __import__(stdlib_name, {}, {}, ["*"])
+ stdlib_mod = sys.modules[stdlib_name]
+ stdlib_names = set(dir(stdlib_mod))
+ for name, obj in vars(defused_mod).items():
+ if name.startswith("_") or name not in stdlib_names:
+ continue
+ setattr(stdlib_mod, name, obj)
+ return stdlib_mod
+
+
+def _generate_etree_functions(DefusedXMLParser, _TreeBuilder, _parse, _iterparse):
+ """Factory for functions needed by etree, dependent on whether
+ cElementTree or ElementTree is used."""
+
+ def parse(source, parser=None, forbid_dtd=False, forbid_entities=True, forbid_external=True):
+ if parser is None:
+ parser = DefusedXMLParser(
+ target=_TreeBuilder(),
+ forbid_dtd=forbid_dtd,
+ forbid_entities=forbid_entities,
+ forbid_external=forbid_external,
+ )
+ return _parse(source, parser)
+
+ def iterparse(
+ source,
+ events=None,
+ parser=None,
+ forbid_dtd=False,
+ forbid_entities=True,
+ forbid_external=True,
+ ):
+ if parser is None:
+ parser = DefusedXMLParser(
+ target=_TreeBuilder(),
+ forbid_dtd=forbid_dtd,
+ forbid_entities=forbid_entities,
+ forbid_external=forbid_external,
+ )
+ return _iterparse(source, events, parser)
+
+ def fromstring(text, forbid_dtd=False, forbid_entities=True, forbid_external=True):
+ parser = DefusedXMLParser(
+ target=_TreeBuilder(),
+ forbid_dtd=forbid_dtd,
+ forbid_entities=forbid_entities,
+ forbid_external=forbid_external,
+ )
+ parser.feed(text)
+ return parser.close()
+
+ return parse, iterparse, fromstring
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/expatbuilder.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/expatbuilder.py
new file mode 100644
index 00000000..7bfc57e4
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/expatbuilder.py
@@ -0,0 +1,107 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xml.dom.expatbuilder
+"""
+from __future__ import print_function, absolute_import
+
+from xml.dom.expatbuilder import ExpatBuilder as _ExpatBuilder
+from xml.dom.expatbuilder import Namespaces as _Namespaces
+
+from .common import DTDForbidden, EntitiesForbidden, ExternalReferenceForbidden
+
+__origin__ = "xml.dom.expatbuilder"
+
+
+class DefusedExpatBuilder(_ExpatBuilder):
+ """Defused document builder"""
+
+ def __init__(
+ self, options=None, forbid_dtd=False, forbid_entities=True, forbid_external=True
+ ):
+ _ExpatBuilder.__init__(self, options)
+ self.forbid_dtd = forbid_dtd
+ self.forbid_entities = forbid_entities
+ self.forbid_external = forbid_external
+
+ def defused_start_doctype_decl(self, name, sysid, pubid, has_internal_subset):
+ raise DTDForbidden(name, sysid, pubid)
+
+ def defused_entity_decl(
+ self, name, is_parameter_entity, value, base, sysid, pubid, notation_name
+ ):
+ raise EntitiesForbidden(name, value, base, sysid, pubid, notation_name)
+
+ def defused_unparsed_entity_decl(self, name, base, sysid, pubid, notation_name):
+ # expat 1.2
+ raise EntitiesForbidden(name, None, base, sysid, pubid, notation_name) # pragma: no cover
+
+ def defused_external_entity_ref_handler(self, context, base, sysid, pubid):
+ raise ExternalReferenceForbidden(context, base, sysid, pubid)
+
+ def install(self, parser):
+ _ExpatBuilder.install(self, parser)
+
+ if self.forbid_dtd:
+ parser.StartDoctypeDeclHandler = self.defused_start_doctype_decl
+ if self.forbid_entities:
+ # if self._options.entities:
+ parser.EntityDeclHandler = self.defused_entity_decl
+ parser.UnparsedEntityDeclHandler = self.defused_unparsed_entity_decl
+ if self.forbid_external:
+ parser.ExternalEntityRefHandler = self.defused_external_entity_ref_handler
+
+
+class DefusedExpatBuilderNS(_Namespaces, DefusedExpatBuilder):
+ """Defused document builder that supports namespaces."""
+
+ def install(self, parser):
+ DefusedExpatBuilder.install(self, parser)
+ if self._options.namespace_declarations:
+ parser.StartNamespaceDeclHandler = self.start_namespace_decl_handler
+
+ def reset(self):
+ DefusedExpatBuilder.reset(self)
+ self._initNamespaces()
+
+
+def parse(file, namespaces=True, forbid_dtd=False, forbid_entities=True, forbid_external=True):
+ """Parse a document, returning the resulting Document node.
+
+ 'file' may be either a file name or an open file object.
+ """
+ if namespaces:
+ build_builder = DefusedExpatBuilderNS
+ else:
+ build_builder = DefusedExpatBuilder
+ builder = build_builder(
+ forbid_dtd=forbid_dtd, forbid_entities=forbid_entities, forbid_external=forbid_external
+ )
+
+ if isinstance(file, str):
+ fp = open(file, "rb")
+ try:
+ result = builder.parseFile(fp)
+ finally:
+ fp.close()
+ else:
+ result = builder.parseFile(file)
+ return result
+
+
+def parseString(
+ string, namespaces=True, forbid_dtd=False, forbid_entities=True, forbid_external=True
+):
+ """Parse a document from a string, returning the resulting
+ Document node.
+ """
+ if namespaces:
+ build_builder = DefusedExpatBuilderNS
+ else:
+ build_builder = DefusedExpatBuilder
+ builder = build_builder(
+ forbid_dtd=forbid_dtd, forbid_entities=forbid_entities, forbid_external=forbid_external
+ )
+ return builder.parseString(string)
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/expatreader.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/expatreader.py
new file mode 100644
index 00000000..890e1d16
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/expatreader.py
@@ -0,0 +1,61 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xml.sax.expatreader
+"""
+from __future__ import print_function, absolute_import
+
+from xml.sax.expatreader import ExpatParser as _ExpatParser
+
+from .common import DTDForbidden, EntitiesForbidden, ExternalReferenceForbidden
+
+__origin__ = "xml.sax.expatreader"
+
+
+class DefusedExpatParser(_ExpatParser):
+ """Defused SAX driver for the pyexpat C module."""
+
+ def __init__(
+ self,
+ namespaceHandling=0,
+ bufsize=2 ** 16 - 20,
+ forbid_dtd=False,
+ forbid_entities=True,
+ forbid_external=True,
+ ):
+ _ExpatParser.__init__(self, namespaceHandling, bufsize)
+ self.forbid_dtd = forbid_dtd
+ self.forbid_entities = forbid_entities
+ self.forbid_external = forbid_external
+
+ def defused_start_doctype_decl(self, name, sysid, pubid, has_internal_subset):
+ raise DTDForbidden(name, sysid, pubid)
+
+ def defused_entity_decl(
+ self, name, is_parameter_entity, value, base, sysid, pubid, notation_name
+ ):
+ raise EntitiesForbidden(name, value, base, sysid, pubid, notation_name)
+
+ def defused_unparsed_entity_decl(self, name, base, sysid, pubid, notation_name):
+ # expat 1.2
+ raise EntitiesForbidden(name, None, base, sysid, pubid, notation_name) # pragma: no cover
+
+ def defused_external_entity_ref_handler(self, context, base, sysid, pubid):
+ raise ExternalReferenceForbidden(context, base, sysid, pubid)
+
+ def reset(self):
+ _ExpatParser.reset(self)
+ parser = self._parser
+ if self.forbid_dtd:
+ parser.StartDoctypeDeclHandler = self.defused_start_doctype_decl
+ if self.forbid_entities:
+ parser.EntityDeclHandler = self.defused_entity_decl
+ parser.UnparsedEntityDeclHandler = self.defused_unparsed_entity_decl
+ if self.forbid_external:
+ parser.ExternalEntityRefHandler = self.defused_external_entity_ref_handler
+
+
+def create_parser(*args, **kwargs):
+ return DefusedExpatParser(*args, **kwargs)
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/lxml.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/lxml.py
new file mode 100644
index 00000000..99d5be93
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/lxml.py
@@ -0,0 +1,153 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""DEPRECATED Example code for lxml.etree protection
+
+The code has NO protection against decompression bombs.
+"""
+from __future__ import print_function, absolute_import
+
+import threading
+import warnings
+
+from lxml import etree as _etree
+
+from .common import DTDForbidden, EntitiesForbidden, NotSupportedError
+
+LXML3 = _etree.LXML_VERSION[0] >= 3
+
+__origin__ = "lxml.etree"
+
+tostring = _etree.tostring
+
+
+warnings.warn(
+ "defusedxml.lxml is no longer supported and will be removed in a future release.",
+ category=DeprecationWarning,
+ stacklevel=2,
+)
+
+
+class RestrictedElement(_etree.ElementBase):
+ """A restricted Element class that filters out instances of some classes"""
+
+ __slots__ = ()
+ # blacklist = (etree._Entity, etree._ProcessingInstruction, etree._Comment)
+ blacklist = _etree._Entity
+
+ def _filter(self, iterator):
+ blacklist = self.blacklist
+ for child in iterator:
+ if isinstance(child, blacklist):
+ continue
+ yield child
+
+ def __iter__(self):
+ iterator = super(RestrictedElement, self).__iter__()
+ return self._filter(iterator)
+
+ def iterchildren(self, tag=None, reversed=False):
+ iterator = super(RestrictedElement, self).iterchildren(tag=tag, reversed=reversed)
+ return self._filter(iterator)
+
+ def iter(self, tag=None, *tags):
+ iterator = super(RestrictedElement, self).iter(tag=tag, *tags)
+ return self._filter(iterator)
+
+ def iterdescendants(self, tag=None, *tags):
+ iterator = super(RestrictedElement, self).iterdescendants(tag=tag, *tags)
+ return self._filter(iterator)
+
+ def itersiblings(self, tag=None, preceding=False):
+ iterator = super(RestrictedElement, self).itersiblings(tag=tag, preceding=preceding)
+ return self._filter(iterator)
+
+ def getchildren(self):
+ iterator = super(RestrictedElement, self).__iter__()
+ return list(self._filter(iterator))
+
+ def getiterator(self, tag=None):
+ iterator = super(RestrictedElement, self).getiterator(tag)
+ return self._filter(iterator)
+
+
+class GlobalParserTLS(threading.local):
+ """Thread local context for custom parser instances"""
+
+ parser_config = {
+ "resolve_entities": False,
+ # 'remove_comments': True,
+ # 'remove_pis': True,
+ }
+
+ element_class = RestrictedElement
+
+ def createDefaultParser(self):
+ parser = _etree.XMLParser(**self.parser_config)
+ element_class = self.element_class
+ if self.element_class is not None:
+ lookup = _etree.ElementDefaultClassLookup(element=element_class)
+ parser.set_element_class_lookup(lookup)
+ return parser
+
+ def setDefaultParser(self, parser):
+ self._default_parser = parser
+
+ def getDefaultParser(self):
+ parser = getattr(self, "_default_parser", None)
+ if parser is None:
+ parser = self.createDefaultParser()
+ self.setDefaultParser(parser)
+ return parser
+
+
+_parser_tls = GlobalParserTLS()
+getDefaultParser = _parser_tls.getDefaultParser
+
+
+def check_docinfo(elementtree, forbid_dtd=False, forbid_entities=True):
+ """Check docinfo of an element tree for DTD and entity declarations
+
+ The check for entity declarations needs lxml 3 or newer. lxml 2.x does
+ not support dtd.iterentities().
+ """
+ docinfo = elementtree.docinfo
+ if docinfo.doctype:
+ if forbid_dtd:
+ raise DTDForbidden(docinfo.doctype, docinfo.system_url, docinfo.public_id)
+ if forbid_entities and not LXML3:
+ # lxml < 3 has no iterentities()
+ raise NotSupportedError("Unable to check for entity declarations " "in lxml 2.x")
+
+ if forbid_entities:
+ for dtd in docinfo.internalDTD, docinfo.externalDTD:
+ if dtd is None:
+ continue
+ for entity in dtd.iterentities():
+ raise EntitiesForbidden(entity.name, entity.content, None, None, None, None)
+
+
+def parse(source, parser=None, base_url=None, forbid_dtd=False, forbid_entities=True):
+ if parser is None:
+ parser = getDefaultParser()
+ elementtree = _etree.parse(source, parser, base_url=base_url)
+ check_docinfo(elementtree, forbid_dtd, forbid_entities)
+ return elementtree
+
+
+def fromstring(text, parser=None, base_url=None, forbid_dtd=False, forbid_entities=True):
+ if parser is None:
+ parser = getDefaultParser()
+ rootelement = _etree.fromstring(text, parser, base_url=base_url)
+ elementtree = rootelement.getroottree()
+ check_docinfo(elementtree, forbid_dtd, forbid_entities)
+ return rootelement
+
+
+XML = fromstring
+
+
+def iterparse(*args, **kwargs):
+ raise NotSupportedError("defused lxml.etree.iterparse not available")
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/minidom.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/minidom.py
new file mode 100644
index 00000000..78033b6c
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/minidom.py
@@ -0,0 +1,63 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xml.dom.minidom
+"""
+from __future__ import print_function, absolute_import
+
+from xml.dom.minidom import _do_pulldom_parse
+from . import expatbuilder as _expatbuilder
+from . import pulldom as _pulldom
+
+__origin__ = "xml.dom.minidom"
+
+
+def parse(
+ file, parser=None, bufsize=None, forbid_dtd=False, forbid_entities=True, forbid_external=True
+):
+ """Parse a file into a DOM by filename or file object."""
+ if parser is None and not bufsize:
+ return _expatbuilder.parse(
+ file,
+ forbid_dtd=forbid_dtd,
+ forbid_entities=forbid_entities,
+ forbid_external=forbid_external,
+ )
+ else:
+ return _do_pulldom_parse(
+ _pulldom.parse,
+ (file,),
+ {
+ "parser": parser,
+ "bufsize": bufsize,
+ "forbid_dtd": forbid_dtd,
+ "forbid_entities": forbid_entities,
+ "forbid_external": forbid_external,
+ },
+ )
+
+
+def parseString(
+ string, parser=None, forbid_dtd=False, forbid_entities=True, forbid_external=True
+):
+ """Parse a file into a DOM from a string."""
+ if parser is None:
+ return _expatbuilder.parseString(
+ string,
+ forbid_dtd=forbid_dtd,
+ forbid_entities=forbid_entities,
+ forbid_external=forbid_external,
+ )
+ else:
+ return _do_pulldom_parse(
+ _pulldom.parseString,
+ (string,),
+ {
+ "parser": parser,
+ "forbid_dtd": forbid_dtd,
+ "forbid_entities": forbid_entities,
+ "forbid_external": forbid_external,
+ },
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/pulldom.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/pulldom.py
new file mode 100644
index 00000000..e3b10a46
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/pulldom.py
@@ -0,0 +1,41 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xml.dom.pulldom
+"""
+from __future__ import print_function, absolute_import
+
+from xml.dom.pulldom import parse as _parse
+from xml.dom.pulldom import parseString as _parseString
+from .sax import make_parser
+
+__origin__ = "xml.dom.pulldom"
+
+
+def parse(
+ stream_or_string,
+ parser=None,
+ bufsize=None,
+ forbid_dtd=False,
+ forbid_entities=True,
+ forbid_external=True,
+):
+ if parser is None:
+ parser = make_parser()
+ parser.forbid_dtd = forbid_dtd
+ parser.forbid_entities = forbid_entities
+ parser.forbid_external = forbid_external
+ return _parse(stream_or_string, parser, bufsize)
+
+
+def parseString(
+ string, parser=None, forbid_dtd=False, forbid_entities=True, forbid_external=True
+):
+ if parser is None:
+ parser = make_parser()
+ parser.forbid_dtd = forbid_dtd
+ parser.forbid_entities = forbid_entities
+ parser.forbid_external = forbid_external
+ return _parseString(string, parser)
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/sax.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/sax.py
new file mode 100644
index 00000000..b2786f74
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/sax.py
@@ -0,0 +1,60 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xml.sax
+"""
+from __future__ import print_function, absolute_import
+
+from xml.sax import InputSource as _InputSource
+from xml.sax import ErrorHandler as _ErrorHandler
+
+from . import expatreader
+
+__origin__ = "xml.sax"
+
+
+def parse(
+ source,
+ handler,
+ errorHandler=_ErrorHandler(),
+ forbid_dtd=False,
+ forbid_entities=True,
+ forbid_external=True,
+):
+ parser = make_parser()
+ parser.setContentHandler(handler)
+ parser.setErrorHandler(errorHandler)
+ parser.forbid_dtd = forbid_dtd
+ parser.forbid_entities = forbid_entities
+ parser.forbid_external = forbid_external
+ parser.parse(source)
+
+
+def parseString(
+ string,
+ handler,
+ errorHandler=_ErrorHandler(),
+ forbid_dtd=False,
+ forbid_entities=True,
+ forbid_external=True,
+):
+ from io import BytesIO
+
+ if errorHandler is None:
+ errorHandler = _ErrorHandler()
+ parser = make_parser()
+ parser.setContentHandler(handler)
+ parser.setErrorHandler(errorHandler)
+ parser.forbid_dtd = forbid_dtd
+ parser.forbid_entities = forbid_entities
+ parser.forbid_external = forbid_external
+
+ inpsrc = _InputSource()
+ inpsrc.setByteStream(BytesIO(string))
+ parser.parse(inpsrc)
+
+
+def make_parser(parser_list=[]):
+ return expatreader.create_parser()
diff --git a/Backend/venv/lib/python3.12/site-packages/defusedxml/xmlrpc.py b/Backend/venv/lib/python3.12/site-packages/defusedxml/xmlrpc.py
new file mode 100644
index 00000000..fbc674da
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/defusedxml/xmlrpc.py
@@ -0,0 +1,153 @@
+# defusedxml
+#
+# Copyright (c) 2013 by Christian Heimes
+# Licensed to PSF under a Contributor Agreement.
+# See https://www.python.org/psf/license for licensing details.
+"""Defused xmlrpclib
+
+Also defuses gzip bomb
+"""
+from __future__ import print_function, absolute_import
+
+import io
+
+from .common import DTDForbidden, EntitiesForbidden, ExternalReferenceForbidden, PY3
+
+if PY3:
+ __origin__ = "xmlrpc.client"
+ from xmlrpc.client import ExpatParser
+ from xmlrpc import client as xmlrpc_client
+ from xmlrpc import server as xmlrpc_server
+ from xmlrpc.client import gzip_decode as _orig_gzip_decode
+ from xmlrpc.client import GzipDecodedResponse as _OrigGzipDecodedResponse
+else:
+ __origin__ = "xmlrpclib"
+ from xmlrpclib import ExpatParser
+ import xmlrpclib as xmlrpc_client
+
+ xmlrpc_server = None
+ from xmlrpclib import gzip_decode as _orig_gzip_decode
+ from xmlrpclib import GzipDecodedResponse as _OrigGzipDecodedResponse
+
+try:
+ import gzip
+except ImportError: # pragma: no cover
+ gzip = None
+
+
+# Limit maximum request size to prevent resource exhaustion DoS
+# Also used to limit maximum amount of gzip decoded data in order to prevent
+# decompression bombs
+# A value of -1 or smaller disables the limit
+MAX_DATA = 30 * 1024 * 1024 # 30 MB
+
+
+def defused_gzip_decode(data, limit=None):
+ """gzip encoded data -> unencoded data
+
+ Decode data using the gzip content encoding as described in RFC 1952
+ """
+ if not gzip: # pragma: no cover
+ raise NotImplementedError
+ if limit is None:
+ limit = MAX_DATA
+ f = io.BytesIO(data)
+ gzf = gzip.GzipFile(mode="rb", fileobj=f)
+ try:
+ if limit < 0: # no limit
+ decoded = gzf.read()
+ else:
+ decoded = gzf.read(limit + 1)
+ except IOError: # pragma: no cover
+ raise ValueError("invalid data")
+ f.close()
+ gzf.close()
+ if limit >= 0 and len(decoded) > limit:
+ raise ValueError("max gzipped payload length exceeded")
+ return decoded
+
+
+class DefusedGzipDecodedResponse(gzip.GzipFile if gzip else object):
+ """a file-like object to decode a response encoded with the gzip
+ method, as described in RFC 1952.
+ """
+
+ def __init__(self, response, limit=None):
+ # response doesn't support tell() and read(), required by
+ # GzipFile
+ if not gzip: # pragma: no cover
+ raise NotImplementedError
+ self.limit = limit = limit if limit is not None else MAX_DATA
+ if limit < 0: # no limit
+ data = response.read()
+ self.readlength = None
+ else:
+ data = response.read(limit + 1)
+ self.readlength = 0
+ if limit >= 0 and len(data) > limit:
+ raise ValueError("max payload length exceeded")
+ self.stringio = io.BytesIO(data)
+ gzip.GzipFile.__init__(self, mode="rb", fileobj=self.stringio)
+
+ def read(self, n):
+ if self.limit >= 0:
+ left = self.limit - self.readlength
+ n = min(n, left + 1)
+ data = gzip.GzipFile.read(self, n)
+ self.readlength += len(data)
+ if self.readlength > self.limit:
+ raise ValueError("max payload length exceeded")
+ return data
+ else:
+ return gzip.GzipFile.read(self, n)
+
+ def close(self):
+ gzip.GzipFile.close(self)
+ self.stringio.close()
+
+
+class DefusedExpatParser(ExpatParser):
+ def __init__(self, target, forbid_dtd=False, forbid_entities=True, forbid_external=True):
+ ExpatParser.__init__(self, target)
+ self.forbid_dtd = forbid_dtd
+ self.forbid_entities = forbid_entities
+ self.forbid_external = forbid_external
+ parser = self._parser
+ if self.forbid_dtd:
+ parser.StartDoctypeDeclHandler = self.defused_start_doctype_decl
+ if self.forbid_entities:
+ parser.EntityDeclHandler = self.defused_entity_decl
+ parser.UnparsedEntityDeclHandler = self.defused_unparsed_entity_decl
+ if self.forbid_external:
+ parser.ExternalEntityRefHandler = self.defused_external_entity_ref_handler
+
+ def defused_start_doctype_decl(self, name, sysid, pubid, has_internal_subset):
+ raise DTDForbidden(name, sysid, pubid)
+
+ def defused_entity_decl(
+ self, name, is_parameter_entity, value, base, sysid, pubid, notation_name
+ ):
+ raise EntitiesForbidden(name, value, base, sysid, pubid, notation_name)
+
+ def defused_unparsed_entity_decl(self, name, base, sysid, pubid, notation_name):
+ # expat 1.2
+ raise EntitiesForbidden(name, None, base, sysid, pubid, notation_name) # pragma: no cover
+
+ def defused_external_entity_ref_handler(self, context, base, sysid, pubid):
+ raise ExternalReferenceForbidden(context, base, sysid, pubid)
+
+
+def monkey_patch():
+ xmlrpc_client.FastParser = DefusedExpatParser
+ xmlrpc_client.GzipDecodedResponse = DefusedGzipDecodedResponse
+ xmlrpc_client.gzip_decode = defused_gzip_decode
+ if xmlrpc_server:
+ xmlrpc_server.gzip_decode = defused_gzip_decode
+
+
+def unmonkey_patch():
+ xmlrpc_client.FastParser = None
+ xmlrpc_client.GzipDecodedResponse = _OrigGzipDecodedResponse
+ xmlrpc_client.gzip_decode = _orig_gzip_decode
+ if xmlrpc_server:
+ xmlrpc_server.gzip_decode = _orig_gzip_decode
diff --git a/Backend/venv/lib/python3.12/site-packages/pydantic-2.5.0.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/pydantic-2.5.0.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/METADATA
new file mode 100644
index 00000000..3e7e05b9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/METADATA
@@ -0,0 +1,187 @@
+Metadata-Version: 2.3
+Name: dparse
+Version: 0.6.4
+Summary: A parser for Python dependency files
+Project-URL: Homepage, https://github.com/pyupio/dparse
+Author-email: Jannis Gebauer
+License: MIT license
+License-File: LICENSE
+Keywords: dparse
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.7
+Requires-Dist: packaging
+Requires-Dist: tomli; python_version < '3.11'
+Provides-Extra: all
+Requires-Dist: pipenv; extra == 'all'
+Requires-Dist: poetry; extra == 'all'
+Requires-Dist: pyyaml; extra == 'all'
+Provides-Extra: conda
+Requires-Dist: pyyaml; extra == 'conda'
+Provides-Extra: pipenv
+Requires-Dist: pipenv; extra == 'pipenv'
+Provides-Extra: poetry
+Requires-Dist: poetry; extra == 'poetry'
+Description-Content-Type: text/x-rst
+
+=================
+Dependency Parser
+=================
+
+
+.. image:: https://img.shields.io/pypi/v/dparse.svg
+ :target: https://pypi.python.org/pypi/dparse
+
+.. image:: https://img.shields.io/travis/pyupio/dparse.svg
+ :target: https://travis-ci.org/pyupio/dparse
+
+.. image:: https://codecov.io/gh/pyupio/dparse/branch/master/graph/badge.svg
+ :target: https://codecov.io/gh/pyupio/dparse
+
+
+A parser for Python dependency files
+
+
+Supported Files
+---------------
+
++------------------+------------+-----------+
+| File | parse | update |
++==================+============+===========+
+| requirements.txt | yes | yes |
++------------------+------------+-----------+
+| conda.yml | yes | yes |
++------------------+------------+-----------+
+| tox.ini | yes | yes |
++------------------+------------+-----------+
+| Pipfile | yes | yes |
++------------------+------------+-----------+
+| Pipfile.lock | yes | yes |
++------------------+------------+-----------+
+| poetry.lock | yes | no |
++------------------+------------+-----------+
+| setup.py | no (# 2_) | no (# 2_) |
++------------------+------------+-----------+
+| zc.buildout | no (# 3_) | no (# 3_) |
++------------------+------------+-----------+
+| setup.cfg | no (# 4_) | no (# 4_) |
++------------------+------------+-----------+
+| pyproject.toml | yes | no |
++------------------+------------+-----------+
+
+.. _2: https://github.com/pyupio/dparse/issues/2
+.. _3: https://github.com/pyupio/dparse/issues/3
+.. _4: https://github.com/pyupio/dparse/issues/8
+
+************
+Installation
+************
+
+To install dparse, run:
+
+.. code-block:: console
+
+ $ pip install dparse
+
+If you want to update Pipfiles, install the pipenv extra:
+
+.. code-block:: console
+
+ $ pip install dparse[pipenv]
+
+If you want to parse conda YML files, install the conda extra:
+
+.. code-block:: console
+
+ $ pip install dparse[conda]
+
+*****
+Usage
+*****
+
+To use dparse in a Python project::
+
+ from dparse import parse, filetypes
+
+ content = """
+ South==1.0.1 --hash=sha256:abcdefghijklmno
+ pycrypto>=2.6
+ """
+
+ df = parse(content, file_type=filetypes.requirements_txt)
+
+ print(df.json())
+
+
+
+
+ {
+ "file_type": "requirements.txt",
+ "content": "\nSouth==1.0.1 --hash=sha256:abcdefghijklmno\npycrypto>=2.6\n",
+ "path": null,
+ "sha": null,
+ "dependencies": [
+ {
+ "name": "South",
+ "specs": [
+ [
+ "==",
+ "1.0.1"
+ ]
+ ],
+ "line": "South==1.0.1 --hash=sha256:abcdefghijklmno",
+ "source": "pypi",
+ "meta": {},
+ "line_numbers": null,
+ "index_server": null,
+ "hashes": [
+ "--hash=sha256:abcdefghijklmno"
+ ],
+ "dependency_type": "requirements.txt",
+ "extras": []
+ },
+ {
+ "name": "pycrypto",
+ "specs": [
+ [
+ ">=",
+ "2.6"
+ ]
+ ],
+ "line": "pycrypto>=2.6",
+ "source": "pypi",
+ "meta": {},
+ "line_numbers": null,
+ "index_server": null,
+ "hashes": [],
+ "dependency_type": "requirements.txt",
+ "extras": []
+ }
+ ]
+ }
+
+**********
+Python 2.7
+**********
+
+This tool requires latest Python patch versions starting with version 3.5. We
+did support Python 2.7 in the past but, as for other Python 3.x minor versions,
+it reached its End-Of-Life and as such we are not able to support it anymore.
+
+We understand you might still have Python 2.7 projects running. At the same
+time, Safety itself has a commitment to encourage developers to keep their
+software up-to-date, and it would not make sense for us to work with officially
+unsupported Python versions, or even those that reached their end of life.
+
+If you still need to use Safety with Python 2.7, please use version 0.4.1 of
+Dparse available at PyPi. Alternatively, you can run Safety from a Python 3
+environment to check the requirements file for your Python 2.7 project.
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/RECORD
new file mode 100644
index 00000000..25beb2ed
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/RECORD
@@ -0,0 +1,19 @@
+dparse-0.6.4.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+dparse-0.6.4.dist-info/METADATA,sha256=4YyoNiV-BvH7TQxl2YuqkepPYU-DB8ascXElN7dy4ik,5456
+dparse-0.6.4.dist-info/RECORD,,
+dparse-0.6.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+dparse-0.6.4.dist-info/licenses/LICENSE,sha256=ar0PbA_0X4CQeStmtJmu5WMr9t8_geMafO3DNpZatu4,1074
+dparse/__init__.py,sha256=97ohr3g1hWbpFJ6gZjHDyIYFhWaloxrH1UzcCbNsE88,169
+dparse/__pycache__/__init__.cpython-312.pyc,,
+dparse/__pycache__/dependencies.cpython-312.pyc,,
+dparse/__pycache__/errors.cpython-312.pyc,,
+dparse/__pycache__/filetypes.cpython-312.pyc,,
+dparse/__pycache__/parser.cpython-312.pyc,,
+dparse/__pycache__/regex.cpython-312.pyc,,
+dparse/__pycache__/updater.cpython-312.pyc,,
+dparse/dependencies.py,sha256=g8gE1FfVignhXv16QckS1pr119smnknVAZ9gr1164Rg,6654
+dparse/errors.py,sha256=4EI-PEu0pe1I1_weZ6sZq8SPwR9uf1GKwMq6eFhV2hE,434
+dparse/filetypes.py,sha256=taMOUPtB-xp0z1e3NEvfaySfjHKTUKMP5lG6w7BMYEY,218
+dparse/parser.py,sha256=5Dwj4U3GgVLiit9_hrSgFs3KFI6JjJ3NMg79STrOB_k,17680
+dparse/regex.py,sha256=WXIxYG5cmO4ts2MuGDN9qUENtij4AXkmgpPsMmWXgag,35
+dparse/updater.py,sha256=nM0QtAPHqeLuoLpS6v6CdZOfxVQNYCIRXEWOsuWczVw,4699
diff --git a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/WHEEL
similarity index 67%
rename from Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/WHEEL
rename to Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/WHEEL
index 27627551..cdd68a49 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/WHEEL
+++ b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/WHEEL
@@ -1,4 +1,4 @@
Wheel-Version: 1.0
-Generator: hatchling 1.17.0
+Generator: hatchling 1.25.0
Root-Is-Purelib: true
Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/licenses/LICENSE b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/licenses/LICENSE
new file mode 100644
index 00000000..49d08568
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse-0.6.4.dist-info/licenses/LICENSE
@@ -0,0 +1,11 @@
+
+MIT License
+
+Copyright (c) 2017, Jannis Gebauer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__init__.py b/Backend/venv/lib/python3.12/site-packages/dparse/__init__.py
new file mode 100644
index 00000000..ee91a242
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse/__init__.py
@@ -0,0 +1,7 @@
+"""Top-level package for Dependency Parser."""
+
+__author__ = """Jannis Gebauer"""
+__email__ = 'support@pyup.io'
+__version__ = '0.6.3'
+
+from .parser import parse # noqa
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..90600226
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/dependencies.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/dependencies.cpython-312.pyc
new file mode 100644
index 00000000..f5150447
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/dependencies.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/errors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/errors.cpython-312.pyc
new file mode 100644
index 00000000..04dc2620
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/errors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/filetypes.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/filetypes.cpython-312.pyc
new file mode 100644
index 00000000..79534676
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/filetypes.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/parser.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/parser.cpython-312.pyc
new file mode 100644
index 00000000..083338d1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/parser.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/regex.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/regex.cpython-312.pyc
new file mode 100644
index 00000000..756d0fad
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/regex.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/updater.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/updater.cpython-312.pyc
new file mode 100644
index 00000000..3602bbbf
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/dparse/__pycache__/updater.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/dependencies.py b/Backend/venv/lib/python3.12/site-packages/dparse/dependencies.py
new file mode 100644
index 00000000..d8ed08b5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse/dependencies.py
@@ -0,0 +1,231 @@
+import json
+from json import JSONEncoder
+
+from . import filetypes, errors
+
+
+class Dependency:
+ """
+
+ """
+
+ def __init__(self, name, specs, line, source="pypi", meta={}, extras=[],
+ line_numbers=None, index_server=None, hashes=(),
+ dependency_type=None, sections=None):
+ """
+
+ :param name:
+ :param specs:
+ :param line:
+ :param source:
+ :param extras:
+ :param line_numbers:
+ :param index_server:
+ :param hashes:
+ :param dependency_type:
+ """
+ self.name = name
+ self.key = name.lower().replace("_", "-")
+ self.specs = specs
+ self.line = line
+ self.source = source
+ self.meta = meta
+ self.line_numbers = line_numbers
+ self.index_server = index_server
+ self.hashes = hashes
+ self.dependency_type = dependency_type
+ self.extras = extras
+ self.sections = sections
+
+ def __str__(self): # pragma: no cover
+ """
+
+ :return:
+ """
+ return "Dependency({name}, {specs}, {line})".format(
+ name=self.name,
+ specs=self.specs,
+ line=self.line
+ )
+
+ def serialize(self):
+ """
+
+ :return:
+ """
+ return {
+ "name": self.name,
+ "specs": self.specs,
+ "line": self.line,
+ "source": self.source,
+ "meta": self.meta,
+ "line_numbers": self.line_numbers,
+ "index_server": self.index_server,
+ "hashes": self.hashes,
+ "dependency_type": self.dependency_type,
+ "extras": self.extras,
+ "sections": self.sections
+ }
+
+ @classmethod
+ def deserialize(cls, d):
+ """
+
+ :param d:
+ :return:
+ """
+ return cls(**d)
+
+ @property
+ def full_name(self):
+ """
+
+ :return:
+ """
+ if self.extras:
+ return "{}[{}]".format(self.name, ",".join(self.extras))
+ return self.name
+
+
+class DparseJSONEncoder(JSONEncoder):
+ def default(self, o):
+ from packaging.specifiers import SpecifierSet
+
+ if isinstance(o, SpecifierSet):
+ return str(o)
+ if isinstance(o, set):
+ return list(o)
+
+ return JSONEncoder.default(self, o)
+
+
+class DependencyFile:
+ """
+
+ """
+
+ def __init__(self, content, path=None, sha=None, file_type=None,
+ marker=((), ()), parser=None, resolve=False):
+ """
+
+ :param content:
+ :param path:
+ :param sha:
+ :param marker:
+ :param file_type:
+ :param parser:
+ """
+ self.content = content
+ self.file_type = file_type
+ self.path = path
+ self.sha = sha
+ self.marker = marker
+
+ self.dependencies = []
+ self.resolved_files = []
+ self.is_valid = False
+ self.file_marker, self.line_marker = marker
+
+ if parser:
+ self.parser = parser
+ else:
+ from . import parser as parser_class
+ if file_type is not None:
+ if file_type == filetypes.requirements_txt:
+ self.parser = parser_class.RequirementsTXTParser
+ elif file_type == filetypes.tox_ini:
+ self.parser = parser_class.ToxINIParser
+ elif file_type == filetypes.conda_yml:
+ self.parser = parser_class.CondaYMLParser
+ elif file_type == filetypes.pipfile:
+ self.parser = parser_class.PipfileParser
+ elif file_type == filetypes.pipfile_lock:
+ self.parser = parser_class.PipfileLockParser
+ elif file_type == filetypes.setup_cfg:
+ self.parser = parser_class.SetupCfgParser
+ elif file_type == filetypes.poetry_lock:
+ self.parser = parser_class.PoetryLockParser
+ elif file_type == filetypes.pyproject_toml:
+ self.parser = parser_class.PyprojectTomlParser
+
+ elif path is not None:
+ if path.endswith((".txt", ".in")):
+ self.parser = parser_class.RequirementsTXTParser
+ elif path.endswith(".yml"):
+ self.parser = parser_class.CondaYMLParser
+ elif path.endswith(".ini"):
+ self.parser = parser_class.ToxINIParser
+ elif path.endswith("Pipfile"):
+ self.parser = parser_class.PipfileParser
+ elif path.endswith("Pipfile.lock"):
+ self.parser = parser_class.PipfileLockParser
+ elif path.endswith("setup.cfg"):
+ self.parser = parser_class.SetupCfgParser
+ elif path.endswith(filetypes.poetry_lock):
+ self.parser = parser_class.PoetryLockParser
+ elif path.endswith(filetypes.pyproject_toml):
+ self.parser = parser_class.PyprojectTomlParser
+
+ if not hasattr(self, "parser"):
+ raise errors.UnknownDependencyFileError
+
+ self.parser = self.parser(self, resolve=resolve)
+
+ @property
+ def resolved_dependencies(self):
+ deps = self.dependencies.copy()
+
+ for d in self.resolved_files:
+ if isinstance(d, DependencyFile):
+ deps.extend(d.resolved_dependencies)
+
+ return deps
+
+ def serialize(self):
+ """
+
+ :return:
+ """
+ return {
+ "file_type": self.file_type,
+ "content": self.content,
+ "path": self.path,
+ "sha": self.sha,
+ "dependencies": [dep.serialize() for dep in self.dependencies],
+ "resolved_dependencies": [dep.serialize() for dep in
+ self.resolved_dependencies]
+ }
+
+ @classmethod
+ def deserialize(cls, d):
+ """
+
+ :param d:
+ :return:
+ """
+ dependencies = [Dependency.deserialize(dep) for dep in
+ d.pop("dependencies", [])]
+ instance = cls(**d)
+ instance.dependencies = dependencies
+ return instance
+
+ def json(self): # pragma: no cover
+ """
+
+ :return:
+ """
+ return json.dumps(self.serialize(), indent=2, cls=DparseJSONEncoder)
+
+ def parse(self):
+ """
+
+ :return:
+ """
+ if self.parser.is_marked_file:
+ self.is_valid = False
+ return self
+ self.parser.parse()
+
+ self.is_valid = len(self.dependencies) > 0 or len(
+ self.resolved_files) > 0
+ return self
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/errors.py b/Backend/venv/lib/python3.12/site-packages/dparse/errors.py
new file mode 100644
index 00000000..e5a3f94b
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse/errors.py
@@ -0,0 +1,15 @@
+class UnknownDependencyFileError(Exception):
+ """
+
+ """
+ def __init__(self, message="Unknown File type to parse"):
+ self.message = message
+ super().__init__(self.message)
+
+
+class MalformedDependencyFileError(Exception):
+
+ def __init__(self, message="The dependency file is malformed. {info}",
+ info=""):
+ self.message = message.format(info=info)
+ super().__init__(self.message)
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/filetypes.py b/Backend/venv/lib/python3.12/site-packages/dparse/filetypes.py
new file mode 100644
index 00000000..49b88842
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse/filetypes.py
@@ -0,0 +1,8 @@
+requirements_txt = "requirements.txt"
+conda_yml = "conda.yml"
+setup_cfg = "setup.cfg"
+tox_ini = "tox.ini"
+pipfile = "Pipfile"
+pipfile_lock = "Pipfile.lock"
+poetry_lock = "poetry.lock"
+pyproject_toml = "pyproject.toml"
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/parser.py b/Backend/venv/lib/python3.12/site-packages/dparse/parser.py
new file mode 100644
index 00000000..ac4c481f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse/parser.py
@@ -0,0 +1,534 @@
+import os
+from collections import OrderedDict
+import re
+import sys
+
+from configparser import ConfigParser, NoOptionError
+from pathlib import PurePath
+
+from .errors import MalformedDependencyFileError
+from .regex import HASH_REGEX
+
+from .dependencies import DependencyFile, Dependency
+from packaging.requirements import Requirement as PackagingRequirement,\
+ InvalidRequirement
+from . import filetypes
+from packaging.specifiers import SpecifierSet
+from packaging.version import Version, InvalidVersion
+import json
+
+if sys.version_info >= (3, 11):
+ import tomllib
+else:
+ import tomli as tomllib
+
+
+# this is a backport from setuptools 26.1
+def setuptools_parse_requirements_backport(strs): # pragma: no cover
+ # Copyright (C) 2016 Jason R Coombs
+ #
+ # Permission is hereby granted, free of charge, to any person obtaining a
+ # copy of this software and associated documentation files
+ # (the "Software"), to deal in the Software without restriction, including
+ # without limitation the rights to use, copy, modify, merge, publish,
+ # distribute, sublicense, and/or sell copies of the Software, and to permit
+ # persons to whom the Software is furnished to do so, subject to the
+ # following conditions:
+ #
+ # The above copyright notice and this permission notice shall be included
+ # in all copies or substantial portions of the Software.
+ #
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ """Yield ``Requirement`` objects for each specification in `strs`
+
+ `strs` must be a string, or a (possibly-nested) iterable thereof.
+ """
+ # create a steppable iterator, so we can handle \-continuations
+ def yield_lines(strs):
+ """Yield non-empty/non-comment lines of a string or sequence"""
+ if isinstance(strs, str):
+ for s in strs.splitlines():
+ s = s.strip()
+ # skip blank lines/comments
+ if s and not s.startswith('#'):
+ yield s
+ else:
+ for ss in strs:
+ for s in yield_lines(ss):
+ yield s
+ lines = iter(yield_lines(strs))
+
+ for line in lines:
+ # Drop comments -- a hash without a space may be in a URL.
+ if ' #' in line:
+ line = line[:line.find(' #')]
+ # If there is a line continuation, drop it, and append the next line.
+ if line.endswith('\\'):
+ line = line[:-2].strip()
+ line += next(lines)
+ yield PackagingRequirement(line)
+
+
+class RequirementsTXTLineParser:
+ """
+
+ """
+
+ @classmethod
+ def parse(cls, line):
+ """
+
+ :param line:
+ :return:
+ """
+ try:
+ # setuptools requires a space before the comment.
+ # If this isn't the case, add it.
+ if "\t#" in line:
+ parsed, = setuptools_parse_requirements_backport(
+ line.replace("\t#", "\t #"))
+ else:
+ parsed, = setuptools_parse_requirements_backport(line)
+ except InvalidRequirement:
+ return None
+ dep = Dependency(
+ name=parsed.name,
+ specs=parsed.specifier,
+ line=line,
+ extras=parsed.extras,
+ dependency_type=filetypes.requirements_txt
+ )
+ return dep
+
+
+class Parser:
+ """
+
+ """
+
+ def __init__(self, obj, resolve=False):
+ """
+
+ :param obj:
+ """
+ self.obj = obj
+ self._lines = None
+ self.resolve = resolve
+
+ def iter_lines(self, lineno=0):
+ """
+
+ :param lineno:
+ :return:
+ """
+ yield from self.lines[lineno:]
+
+ @property
+ def lines(self):
+ """
+
+ :return:
+ """
+ if self._lines is None:
+ self._lines = self.obj.content.splitlines()
+ return self._lines
+
+ @property
+ def is_marked_file(self):
+ """
+
+ :return:
+ """
+ for n, line in enumerate(self.iter_lines()):
+ for marker in self.obj.file_marker:
+ if marker in line:
+ return True
+ if n >= 2:
+ break
+ return False
+
+ def is_marked_line(self, line):
+ """
+
+ :param line:
+ :return:
+ """
+ for marker in self.obj.line_marker:
+ if marker in line:
+ return True
+ return False
+
+ @classmethod
+ def parse_hashes(cls, line):
+ """
+
+ :param line:
+ :return:
+ """
+ hashes = []
+ for match in re.finditer(HASH_REGEX, line):
+ hashes.append(line[match.start():match.end()])
+ return re.sub(HASH_REGEX, "", line).strip(), hashes
+
+ @classmethod
+ def parse_index_server(cls, line):
+ """
+
+ :param line:
+ :return:
+ """
+ groups = re.split(pattern=r"[=\s]+", string=line.strip(), maxsplit=100)
+
+ if len(groups) >= 2:
+ return groups[1] if groups[1].endswith("/") else groups[1] + "/"
+
+ return None
+
+ @classmethod
+ def resolve_file(cls, file_path, line):
+ """
+
+ :param file_path:
+ :param line:
+ :return:
+ """
+ line = line.replace("-r ", "").replace("--requirement ", "")
+ normalized_path = PurePath(file_path)
+ if " #" in line:
+ line = line.split("#")[0].strip()
+ return str(normalized_path.parent.joinpath(line))
+
+
+class RequirementsTXTParser(Parser):
+ """
+
+ """
+
+ def parse(self):
+ """
+ Parses a requirements.txt-like file
+ """
+ index_server = None
+ for num, line in enumerate(self.iter_lines()):
+ line = line.rstrip()
+ if not line:
+ continue
+ if line.startswith('#'):
+ # comments are lines that start with # only
+ continue
+ if line.startswith('-i') or \
+ line.startswith('--index-url') or \
+ line.startswith('--extra-index-url'):
+ # this file is using a private index server, try to parse it
+ index_server = self.parse_index_server(line)
+ continue
+ elif self.obj.path and \
+ (line.startswith('-r') or
+ line.startswith('--requirement')):
+
+ req_file_path = self.resolve_file(self.obj.path, line)
+
+ if self.resolve and os.path.exists(req_file_path):
+ with open(req_file_path) as f:
+ content = f.read()
+
+ dep_file = DependencyFile(
+ content=content,
+ path=req_file_path,
+ resolve=True
+ )
+ dep_file.parse()
+ self.obj.resolved_files.append(dep_file)
+ else:
+ self.obj.resolved_files.append(req_file_path)
+
+ elif line.startswith('-f') or line.startswith('--find-links') or \
+ line.startswith('--no-index') or \
+ line.startswith('--allow-external') or \
+ line.startswith('--allow-unverified') or \
+ line.startswith('-Z') or \
+ line.startswith('--always-unzip'):
+ continue
+ elif self.is_marked_line(line):
+ continue
+ else:
+ try:
+
+ parseable_line = line
+
+ # multiline requirements are not parseable
+ if "\\" in line:
+ parseable_line = line.replace("\\", "")
+ for next_line in self.iter_lines(num + 1):
+ parseable_line += next_line.strip().replace("\\",
+ "")
+ line += "\n" + next_line
+ if "\\" in next_line:
+ continue
+ break
+ # ignore multiline requirements if they are marked
+ if self.is_marked_line(parseable_line):
+ continue
+
+ hashes = []
+ if "--hash" in parseable_line:
+ parseable_line, hashes = Parser.parse_hashes(
+ parseable_line)
+
+ req = RequirementsTXTLineParser.parse(parseable_line)
+ if req:
+ req.hashes = hashes
+ req.index_server = index_server
+ # replace the requirements line with the 'real' line
+ req.line = line
+ self.obj.dependencies.append(req)
+ except ValueError:
+ continue
+
+
+class ToxINIParser(Parser):
+ """
+
+ """
+
+ def parse(self):
+ """
+
+ :return:
+ """
+ parser = ConfigParser()
+ parser.read_string(self.obj.content)
+ for section in parser.sections():
+ try:
+ content = parser.get(section=section, option="deps")
+ for n, line in enumerate(content.splitlines()):
+ if self.is_marked_line(line):
+ continue
+ if line:
+ req = RequirementsTXTLineParser.parse(line)
+ if req:
+ req.dependency_type = self.obj.file_type
+ self.obj.dependencies.append(req)
+ except NoOptionError:
+ pass
+
+
+class CondaYMLParser(Parser):
+ """
+
+ """
+
+ def parse(self):
+ """
+
+ :return:
+ """
+ import yaml
+ try:
+ data = yaml.safe_load(self.obj.content)
+ if data and 'dependencies' in data and \
+ isinstance(data['dependencies'], list):
+ for dep in data['dependencies']:
+ if isinstance(dep, dict) and 'pip' in dep:
+ for n, line in enumerate(dep['pip']):
+ if self.is_marked_line(line):
+ continue
+ req = RequirementsTXTLineParser.parse(line)
+ if req:
+ req.dependency_type = self.obj.file_type
+ self.obj.dependencies.append(req)
+ except yaml.YAMLError:
+ pass
+
+
+class PipfileParser(Parser):
+
+ def parse(self):
+ """
+ Parse a Pipfile (as seen in pipenv)
+ :return:
+ """
+ try:
+ data = tomllib.loads(self.obj.content)
+ if data:
+ for package_type in ['packages', 'dev-packages']:
+ if package_type in data:
+ for name, specs in data[package_type].items():
+ # skip on VCS dependencies
+ if not isinstance(specs, str):
+ continue
+ if specs == '*':
+ specs = ''
+ self.obj.dependencies.append(
+ Dependency(
+ name=name, specs=SpecifierSet(specs),
+ dependency_type=filetypes.pipfile,
+ line=''.join([name, specs]),
+ sections=[package_type]
+ )
+ )
+ except (tomllib.TOMLDecodeError, IndexError):
+ pass
+
+
+class PipfileLockParser(Parser):
+
+ def parse(self):
+ """
+ Parse a Pipfile.lock (as seen in pipenv)
+ :return:
+ """
+ try:
+ data = json.loads(self.obj.content, object_pairs_hook=OrderedDict)
+ if data:
+ for package_type in ['default', 'develop']:
+ if package_type in data:
+ for name, meta in data[package_type].items():
+ # skip VCS dependencies
+ if 'version' not in meta:
+ continue
+ specs = meta['version']
+ hashes = meta['hashes']
+ self.obj.dependencies.append(
+ Dependency(
+ name=name, specs=SpecifierSet(specs),
+ dependency_type=filetypes.pipfile_lock,
+ hashes=hashes,
+ line=''.join([name, specs]),
+ sections=[package_type]
+ )
+ )
+ except ValueError as e:
+ raise MalformedDependencyFileError(info=str(e))
+
+
+class SetupCfgParser(Parser):
+ def parse(self):
+ parser = ConfigParser()
+ parser.read_string(self.obj.content)
+ for section in parser.sections():
+ if section.name == 'options':
+ options = 'install_requires', 'setup_requires', 'test_require'
+ for name in options:
+ if parser.has_option('options', name):
+ content = section.get('options', name)
+ self._parse_content(content)
+ elif section == 'options.extras_require':
+ for _, content in parser.items('options.extras_require'):
+ self._parse_content(content)
+
+ def _parse_content(self, content):
+ for n, line in enumerate(content.splitlines()):
+ if self.is_marked_line(line):
+ continue
+ if line:
+ req = RequirementsTXTLineParser.parse(line)
+ if req:
+ req.dependency_type = self.obj.file_type
+ self.obj.dependencies.append(req)
+
+
+class PoetryLockParser(Parser):
+
+ def parse(self):
+ """
+ Parse a poetry.lock
+ """
+ try:
+ from poetry.packages.locker import Locker
+ from pathlib import Path
+
+ lock_path = Path(self.obj.path)
+
+ repository = Locker(lock_path, {}).locked_repository()
+ for pkg in repository.packages:
+ self.obj.dependencies.append(
+ Dependency(
+ name=pkg.name, specs=SpecifierSet(f"=={pkg.version.text}"),
+ dependency_type=filetypes.poetry_lock,
+ line=pkg.to_dependency().to_pep_508(),
+ sections=list(pkg.dependency_group_names())
+ )
+ )
+ except Exception:
+ try:
+ data = tomllib.loads(self.obj.content)
+ pkg_key = 'package'
+ if data:
+ dependencies = data[pkg_key]
+ for dep in dependencies:
+ name = dep['name']
+ spec = "=={version}".format(
+ version=Version(dep['version']))
+ sections = [dep['category']] if "category" in dep else []
+ self.obj.dependencies.append(
+ Dependency(
+ name=name, specs=SpecifierSet(spec),
+ dependency_type=filetypes.poetry_lock,
+ line=''.join([name, spec]),
+ sections=sections
+ )
+ )
+ except Exception as e:
+ raise MalformedDependencyFileError(info=str(e))
+
+
+class PyprojectTomlParser(Parser):
+ def parse(self) -> None:
+ """Parse a pyproject.toml file.
+
+ Refer to https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
+ for configuration specification.
+ """
+ try:
+ cfg = tomllib.loads(self.obj.content)
+ except (tomllib.TOMLDecodeError, IndexError) as e:
+ raise MalformedDependencyFileError(info=str(e))
+
+ if not cfg or "project" not in cfg:
+ return
+
+ sections = {
+ "dependencies": cfg["project"].get("dependencies", []),
+ **cfg["project"].get("optional-dependencies", {}),
+ }
+
+ for section, lines in sections.items():
+ for line in lines:
+ req = RequirementsTXTLineParser.parse(line)
+ if req:
+ req.dependency_type = self.obj.file_type
+ req.section = section
+ self.obj.dependencies.append(req)
+
+
+def parse(content, file_type=None, path=None, sha=None, marker=((), ()),
+ parser=None, resolve=False):
+ """
+
+ :param content:
+ :param file_type:
+ :param path:
+ :param sha:
+ :param marker:
+ :param parser:
+ :return:
+ """
+
+ dep_file = DependencyFile(
+ content=content,
+ path=path,
+ sha=sha,
+ marker=marker,
+ file_type=file_type,
+ parser=parser,
+ resolve=resolve
+ )
+
+ return dep_file.parse()
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/regex.py b/Backend/venv/lib/python3.12/site-packages/dparse/regex.py
new file mode 100644
index 00000000..751a2541
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse/regex.py
@@ -0,0 +1 @@
+HASH_REGEX = r"--hash[=| ]\w+:\w+"
diff --git a/Backend/venv/lib/python3.12/site-packages/dparse/updater.py b/Backend/venv/lib/python3.12/site-packages/dparse/updater.py
new file mode 100644
index 00000000..02947c06
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/dparse/updater.py
@@ -0,0 +1,128 @@
+import re
+import json
+import tempfile
+import os
+import sys
+
+if sys.version_info >= (3, 11):
+ import tomllib
+else:
+ import tomli as tomllib
+
+
+class RequirementsTXTUpdater:
+ SUB_REGEX = r"^{}(?=\s*\r?\n?$)"
+
+ @classmethod
+ def update(cls, content, dependency, version, spec="==", hashes=()):
+ """
+ Updates the requirement to the latest version for the given content
+ and adds hashes if necessary.
+ :param content: str, content
+ :return: str, updated content
+ """
+ new_line = "{name}{spec}{version}".format(name=dependency.full_name,
+ spec=spec, version=version)
+ appendix = ''
+ # leave environment markers intact
+ if ";" in dependency.line:
+ # condense multiline, split out the env marker, strip comments
+ # and --hashes
+ new_line += ";" + \
+ dependency.line.splitlines()[0].split(";", 1)[1] \
+ .split("#")[0].split("--hash")[0].rstrip()
+ # add the comment
+ if "#" in dependency.line:
+ # split the line into parts: requirement and comment
+ parts = dependency.line.split("#")
+ requirement, comment = parts[0], "#".join(parts[1:])
+ # find all whitespaces between the requirement and the comment
+ whitespaces = (hex(ord('\t')), hex(ord(' ')))
+ trailing_whitespace = ''
+ for c in requirement[::-1]:
+ if hex(ord(c)) in whitespaces:
+ trailing_whitespace += c
+ else:
+ break
+ appendix += trailing_whitespace + "#" + comment
+ # if this is a hashed requirement, add a multiline break before the
+ # comment
+ if dependency.hashes and not new_line.endswith("\\"):
+ new_line += " \\"
+ # if this is a hashed requirement, add the hashes
+ if hashes:
+ for n, new_hash in enumerate(hashes):
+ new_line += "\n --hash={method}:{hash}".format(
+ method=new_hash['method'],
+ hash=new_hash['hash']
+ )
+ # append a new multiline break if this is not the last line
+ if len(hashes) > n + 1:
+ new_line += " \\"
+ new_line += appendix
+
+ regex = cls.SUB_REGEX.format(re.escape(dependency.line))
+
+ return re.sub(regex, new_line, content, flags=re.MULTILINE)
+
+
+class CondaYMLUpdater(RequirementsTXTUpdater):
+
+ SUB_REGEX = r"{}(?=\s*\r?\n?$)"
+
+
+class ToxINIUpdater(CondaYMLUpdater):
+ pass
+
+
+class SetupCFGUpdater(CondaYMLUpdater):
+ pass
+
+
+class PipfileUpdater:
+ @classmethod
+ def update(cls, content, dependency, version, spec="==", hashes=()):
+ data = tomllib.loads(content)
+ if data:
+ for package_type in ['packages', 'dev-packages']:
+ if package_type in data:
+ if dependency.full_name in data[package_type]:
+ data[package_type][
+ dependency.full_name] = "{spec}{version}".format(
+ spec=spec, version=version
+ )
+ try:
+ from pipenv.project import Project
+ except ImportError:
+ raise ImportError(
+ "Updating a Pipfile requires the pipenv extra to be installed."
+ " Install it with pip install dparse[pipenv]")
+ pipfile = tempfile.NamedTemporaryFile(delete=False)
+ pipfile.close()
+ p = Project(chdir=False)
+ p.write_toml(data=data, path=pipfile.name)
+ data = open(pipfile.name).read()
+ os.remove(pipfile.name)
+ return data
+
+
+class PipfileLockUpdater:
+ @classmethod
+ def update(cls, content, dependency, version, spec="==", hashes=()):
+ data = json.loads(content)
+ if data:
+ for package_type in ['default', 'develop']:
+ if package_type in data:
+ if dependency.full_name in data[package_type]:
+ data[package_type][dependency.full_name] = {
+ 'hashes': [
+ "{method}:{hash}".format(
+ hash=h['hash'],
+ method=h['method']
+ ) for h in hashes
+ ],
+ 'version': "{spec}{version}".format(
+ spec=spec, version=version
+ )
+ }
+ return json.dumps(data, indent=4, separators=(',', ': ')) + "\n"
diff --git a/Backend/venv/lib/python3.12/site-packages/pydantic_core-2.14.1.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/pydantic_core-2.14.1.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/METADATA
similarity index 58%
rename from Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/METADATA
rename to Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/METADATA
index 2fa535f4..6f591fb2 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/METADATA
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/METADATA
@@ -1,56 +1,76 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
Name: fastapi
-Version: 0.104.1
+Version: 0.123.0
Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
-Project-URL: Homepage, https://github.com/tiangolo/fastapi
-Project-URL: Documentation, https://fastapi.tiangolo.com/
-Project-URL: Repository, https://github.com/tiangolo/fastapi
-Author-email: Sebastián Ramírez
+Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?=
License-Expression: MIT
License-File: LICENSE
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Framework :: FastAPI
Classifier: Framework :: Pydantic
Classifier: Framework :: Pydantic :: 1
+Classifier: Framework :: Pydantic :: 2
Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Internet
-Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
-Classifier: Topic :: Software Development
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Typing :: Typed
+Classifier: Topic :: Internet :: WWW/HTTP
+Project-URL: Homepage, https://github.com/fastapi/fastapi
+Project-URL: Documentation, https://fastapi.tiangolo.com/
+Project-URL: Repository, https://github.com/fastapi/fastapi
+Project-URL: Issues, https://github.com/fastapi/fastapi/issues
+Project-URL: Changelog, https://fastapi.tiangolo.com/release-notes/
Requires-Python: >=3.8
-Requires-Dist: anyio<4.0.0,>=3.7.1
+Requires-Dist: starlette<0.51.0,>=0.40.0
Requires-Dist: pydantic!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.7.4
-Requires-Dist: starlette<0.28.0,>=0.27.0
Requires-Dist: typing-extensions>=4.8.0
+Requires-Dist: annotated-doc>=0.0.2
+Provides-Extra: standard
+Requires-Dist: fastapi-cli[standard]>=0.0.8; extra == "standard"
+Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "standard"
+Requires-Dist: jinja2>=3.1.5; extra == "standard"
+Requires-Dist: python-multipart>=0.0.18; extra == "standard"
+Requires-Dist: email-validator>=2.0.0; extra == "standard"
+Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"
+Provides-Extra: standard-no-fastapi-cloud-cli
+Requires-Dist: fastapi-cli[standard-no-fastapi-cloud-cli]>=0.0.8; extra == "standard-no-fastapi-cloud-cli"
+Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "standard-no-fastapi-cloud-cli"
+Requires-Dist: jinja2>=3.1.5; extra == "standard-no-fastapi-cloud-cli"
+Requires-Dist: python-multipart>=0.0.18; extra == "standard-no-fastapi-cloud-cli"
+Requires-Dist: email-validator>=2.0.0; extra == "standard-no-fastapi-cloud-cli"
+Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard-no-fastapi-cloud-cli"
Provides-Extra: all
-Requires-Dist: email-validator>=2.0.0; extra == 'all'
-Requires-Dist: httpx>=0.23.0; extra == 'all'
-Requires-Dist: itsdangerous>=1.1.0; extra == 'all'
-Requires-Dist: jinja2>=2.11.2; extra == 'all'
-Requires-Dist: orjson>=3.2.1; extra == 'all'
-Requires-Dist: pydantic-extra-types>=2.0.0; extra == 'all'
-Requires-Dist: pydantic-settings>=2.0.0; extra == 'all'
-Requires-Dist: python-multipart>=0.0.5; extra == 'all'
-Requires-Dist: pyyaml>=5.3.1; extra == 'all'
-Requires-Dist: ujson!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,>=4.0.1; extra == 'all'
-Requires-Dist: uvicorn[standard]>=0.12.0; extra == 'all'
+Requires-Dist: fastapi-cli[standard]>=0.0.8; extra == "all"
+Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "all"
+Requires-Dist: jinja2>=3.1.5; extra == "all"
+Requires-Dist: python-multipart>=0.0.18; extra == "all"
+Requires-Dist: itsdangerous>=1.1.0; extra == "all"
+Requires-Dist: pyyaml>=5.3.1; extra == "all"
+Requires-Dist: ujson!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,>=4.0.1; extra == "all"
+Requires-Dist: orjson>=3.2.1; extra == "all"
+Requires-Dist: email-validator>=2.0.0; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.12.0; extra == "all"
+Requires-Dist: pydantic-settings>=2.0.0; extra == "all"
+Requires-Dist: pydantic-extra-types>=2.0.0; extra == "all"
Description-Content-Type: text/markdown
@@ -60,11 +80,11 @@ Description-Content-Type: text/markdown
FastAPI framework, high performance, easy to learn, fast to code, ready for production
-
-
+
+
-
-
+
+
@@ -78,11 +98,11 @@ Description-Content-Type: text/markdown
**Documentation**: https://fastapi.tiangolo.com
-**Source Code**: https://github.com/tiangolo/fastapi
+**Source Code**: https://github.com/fastapi/fastapi
---
-FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.8+ based on standard Python type hints.
+FastAPI is a modern, fast (high-performance), web framework for building APIs with Python based on standard Python type hints.
The key features are:
@@ -100,20 +120,29 @@ The key features are:
## Sponsors
+### Keystone Sponsor
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+### Gold and Silver Sponsors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -123,7 +152,7 @@ The key features are:
"_[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products._"
-
---
"_Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that._"
-
---
@@ -175,42 +204,32 @@ If you are building a CLI app to be
## Requirements
-Python 3.8+
-
FastAPI stands on the shoulders of giants:
-* Starlette for the web parts.
-* Pydantic for the data parts.
+* Starlette for the web parts.
+* Pydantic for the data parts.
## Installation
+Create and activate a virtual environment and then install FastAPI:
+
+**Note**: Make sure you put `"fastapi[standard]"` in quotes to ensure it works in all terminals.
## Example
### Create it
-* Create a file `main.py` with:
+Create a file `main.py` with:
```Python
from typing import Union
@@ -266,11 +285,24 @@ Run the server with:
```console
-$ uvicorn main:app --reload
+$ fastapi dev main.py
+ ╭────────── FastAPI CLI - Development mode ───────────╮
+ │ │
+ │ Serving at: http://127.0.0.1:8000 │
+ │ │
+ │ API docs: http://127.0.0.1:8000/docs │
+ │ │
+ │ Running in development mode, for production use: │
+ │ │
+ │ fastapi run │
+ │ │
+ ╰─────────────────────────────────────────────────────╯
+
+INFO: Will watch for changes in these directories: ['/home/user/code/awesomeapp']
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
-INFO: Started reloader process [28720]
-INFO: Started server process [28722]
+INFO: Started reloader process [2248755] using WatchFiles
+INFO: Started server process [2248757]
INFO: Waiting for application startup.
INFO: Application startup complete.
```
@@ -278,13 +310,13 @@ INFO: Application startup complete.
-About the command uvicorn main:app --reload...
+About the command fastapi dev main.py...
-The command `uvicorn main:app` refers to:
+The command `fastapi dev` reads your `main.py` file, detects the **FastAPI** app in it, and starts a server using Uvicorn.
-* `main`: the file `main.py` (the Python "module").
-* `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
-* `--reload`: make the server restart after code changes. Only do this for development.
+By default, `fastapi dev` will start with auto-reload enabled for local development.
+
+You can read more about it in the FastAPI CLI docs.
@@ -357,7 +389,7 @@ def update_item(item_id: int, item: Item):
return {"item_name": item.name, "item_id": item_id}
```
-The server should reload automatically (because you added `--reload` to the `uvicorn` command above).
+The `fastapi dev` server should reload automatically.
### Interactive API docs upgrade
@@ -391,7 +423,7 @@ You do that with standard modern Python types.
You don't have to learn a new syntax, the methods or classes of a specific library, etc.
-Just standard **Python 3.8+**.
+Just standard **Python**.
For example, for an `int`:
@@ -441,7 +473,7 @@ Coming back to the previous code example, **FastAPI** will:
* Check if there is an optional query parameter named `q` (as in `http://127.0.0.1:8000/items/foo?q=somequery`) for `GET` requests.
* As the `q` parameter is declared with `= None`, it is optional.
* Without the `None` it would be required (as is the body in the case with `PUT`).
-* For `PUT` requests to `/items/{item_id}`, Read the body as JSON:
+* For `PUT` requests to `/items/{item_id}`, read the body as JSON:
* Check that it has a required attribute `name` that should be a `str`.
* Check that it has a required attribute `price` that has to be a `float`.
* Check that it has an optional attribute `is_offer`, that should be a `bool`, if present.
@@ -495,35 +527,109 @@ For a more complete example including more features, see the FastAPI Cloud, go and join the waiting list if you haven't. 🚀
+
+If you already have a **FastAPI Cloud** account (we invited you from the waiting list 😉), you can deploy your application with one command.
+
+Before deploying, make sure you are logged in:
+
+
+
+```console
+$ fastapi login
+
+You are logged in to FastAPI Cloud 🚀
+```
+
+
+
+Then deploy your app:
+
+
+
+```console
+$ fastapi deploy
+
+Deploying to FastAPI Cloud...
+
+✅ Deployment successful!
+
+🐔 Ready the chicken! Your app is ready at https://myapp.fastapicloud.dev
+```
+
+
+
+That's it! Now you can access your app at that URL. ✨
+
+#### About FastAPI Cloud
+
+**FastAPI Cloud** is built by the same author and team behind **FastAPI**.
+
+It streamlines the process of **building**, **deploying**, and **accessing** an API with minimal effort.
+
+It brings the same **developer experience** of building apps with FastAPI to **deploying** them to the cloud. 🎉
+
+FastAPI Cloud is the primary sponsor and funding provider for the *FastAPI and friends* open source projects. ✨
+
+#### Deploy to other cloud providers
+
+FastAPI is open source and based on standards. You can deploy FastAPI apps to any cloud provider you choose.
+
+Follow your cloud provider's guides to deploy FastAPI apps with them. 🤓
+
## Performance
Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as one of the fastest Python frameworks available, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
To understand more about it, see the section Benchmarks.
-## Optional Dependencies
+## Dependencies
+
+FastAPI depends on Pydantic and Starlette.
+
+### `standard` Dependencies
+
+When you install FastAPI with `pip install "fastapi[standard]"` it comes with the `standard` group of optional dependencies:
Used by Pydantic:
-* email_validator - for email validation.
-* pydantic-settings - for settings management.
-* pydantic-extra-types - for extra types to be used with Pydantic.
+* email-validator - for email validation.
Used by Starlette:
* httpx - Required if you want to use the `TestClient`.
* jinja2 - Required if you want to use the default template configuration.
-* python-multipart - Required if you want to support form "parsing", with `request.form()`.
-* itsdangerous - Required for `SessionMiddleware` support.
-* pyyaml - Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).
-* ujson - Required if you want to use `UJSONResponse`.
+* python-multipart - Required if you want to support form "parsing", with `request.form()`.
-Used by FastAPI / Starlette:
+Used by FastAPI:
+
+* uvicorn - for the server that loads and serves your application. This includes `uvicorn[standard]`, which includes some dependencies (e.g. `uvloop`) needed for high performance serving.
+* `fastapi-cli[standard]` - to provide the `fastapi` command.
+ * This includes `fastapi-cloud-cli`, which allows you to deploy your FastAPI application to FastAPI Cloud.
+
+### Without `standard` Dependencies
+
+If you don't want to include the `standard` optional dependencies, you can install with `pip install fastapi` instead of `pip install "fastapi[standard]"`.
+
+### Without `fastapi-cloud-cli`
+
+If you want to install FastAPI with the standard dependencies but without the `fastapi-cloud-cli`, you can install with `pip install "fastapi[standard-no-fastapi-cloud-cli]"`.
+
+### Additional Optional Dependencies
+
+There are some additional dependencies you might want to install.
+
+Additional optional Pydantic dependencies:
+
+* pydantic-settings - for settings management.
+* pydantic-extra-types - for extra types to be used with Pydantic.
+
+Additional optional FastAPI dependencies:
-* uvicorn - for the server that loads and serves your application.
* orjson - Required if you want to use `ORJSONResponse`.
-
-You can install all of these with `pip install "fastapi[all]"`.
+* ujson - Required if you want to use `UJSONResponse`.
## License
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/RECORD
similarity index 50%
rename from Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/RECORD
rename to Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/RECORD
index 4f293095..678d176f 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/RECORD
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/RECORD
@@ -1,14 +1,18 @@
-fastapi-0.104.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
-fastapi-0.104.1.dist-info/METADATA,sha256=Zgj7yzBMm50KgBZsq5R9A29zVk7LMUvkUC6oTWuR8J0,24298
-fastapi-0.104.1.dist-info/RECORD,,
-fastapi-0.104.1.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi-0.104.1.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
-fastapi-0.104.1.dist-info/licenses/LICENSE,sha256=Tsif_IFIW5f-xYSy1KlhAy7v_oNEU4lP2cEnSQbMdE4,1086
-fastapi/__init__.py,sha256=n8125d7_qIsNGVM_1QL7_LpYtGH8GYrkJjgSMjP31cE,1081
+../../../bin/fastapi,sha256=sXjOj5Xo758W5DbTDNtumhfzscPUGgV-ihOR8ZNWBMQ,222
+fastapi-0.123.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+fastapi-0.123.0.dist-info/METADATA,sha256=1Hj1CmjTjY0uwuk0c8s7Rh9WqOUMN8lDQ1nRyzrPY-o,30181
+fastapi-0.123.0.dist-info/RECORD,,
+fastapi-0.123.0.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi-0.123.0.dist-info/WHEEL,sha256=tsUv_t7BDeJeRHaSrczbGeuK-TtDpGsWi_JfpzD255I,90
+fastapi-0.123.0.dist-info/entry_points.txt,sha256=GCf-WbIZxyGT4MUmrPGj1cOHYZoGsNPHAvNkT6hnGeA,61
+fastapi-0.123.0.dist-info/licenses/LICENSE,sha256=Tsif_IFIW5f-xYSy1KlhAy7v_oNEU4lP2cEnSQbMdE4,1086
+fastapi/__init__.py,sha256=6F2JyMTTG79mqOftrzJjfp4u7DFLutAdTSvAsH1yAa0,1081
+fastapi/__main__.py,sha256=bKePXLdO4SsVSM6r9SVoLickJDcR2c0cTOxZRKq26YQ,37
fastapi/__pycache__/__init__.cpython-312.pyc,,
-fastapi/__pycache__/_compat.cpython-312.pyc,,
+fastapi/__pycache__/__main__.cpython-312.pyc,,
fastapi/__pycache__/applications.cpython-312.pyc,,
fastapi/__pycache__/background.cpython-312.pyc,,
+fastapi/__pycache__/cli.cpython-312.pyc,,
fastapi/__pycache__/concurrency.cpython-312.pyc,,
fastapi/__pycache__/datastructures.cpython-312.pyc,,
fastapi/__pycache__/encoders.cpython-312.pyc,,
@@ -21,25 +25,40 @@ fastapi/__pycache__/requests.cpython-312.pyc,,
fastapi/__pycache__/responses.cpython-312.pyc,,
fastapi/__pycache__/routing.cpython-312.pyc,,
fastapi/__pycache__/staticfiles.cpython-312.pyc,,
+fastapi/__pycache__/temp_pydantic_v1_params.cpython-312.pyc,,
fastapi/__pycache__/templating.cpython-312.pyc,,
fastapi/__pycache__/testclient.cpython-312.pyc,,
fastapi/__pycache__/types.cpython-312.pyc,,
fastapi/__pycache__/utils.cpython-312.pyc,,
fastapi/__pycache__/websockets.cpython-312.pyc,,
-fastapi/_compat.py,sha256=BlQp8ec0cFM6FLAEASdpYd7Ip9TY1FZr8PGiGRO4QLg,22798
-fastapi/applications.py,sha256=C7mT6eZh0XUO2HmLM43_gJMyqjoyy_SdgypDHRrLu34,179073
-fastapi/background.py,sha256=F1tsrJKfDZaRchNgF9ykB2PcRaPBJTbL4htN45TJAIc,1799
-fastapi/concurrency.py,sha256=NAK9SMlTCOALLjTAR6KzWUDEkVj7_EyNRz0-lDVW_W8,1467
-fastapi/datastructures.py,sha256=FF1s2g6cAQ5XxlNToB3scgV94Zf3DjdzcaI7ToaTrmg,5797
+fastapi/_compat/__init__.py,sha256=8fa5XmM6_whr6YWuCs7KDdKR_gZ_AMmaxYW7GDn0eng,2718
+fastapi/_compat/__pycache__/__init__.cpython-312.pyc,,
+fastapi/_compat/__pycache__/main.cpython-312.pyc,,
+fastapi/_compat/__pycache__/may_v1.cpython-312.pyc,,
+fastapi/_compat/__pycache__/model_field.cpython-312.pyc,,
+fastapi/_compat/__pycache__/shared.cpython-312.pyc,,
+fastapi/_compat/__pycache__/v1.cpython-312.pyc,,
+fastapi/_compat/__pycache__/v2.cpython-312.pyc,,
+fastapi/_compat/main.py,sha256=WDixlh9_5nfFuwWvbYQJNi8l5nDZdfbl2nMyTriG65c,10978
+fastapi/_compat/may_v1.py,sha256=uiZpZTEVHBlD_Q3WYUW_BNW24X3yk_OwvHhCgPwTUco,2979
+fastapi/_compat/model_field.py,sha256=SrSoXEcloGXKAqjR8UDW2869RPgLRFdWTuVgTBhX_Gw,1190
+fastapi/_compat/shared.py,sha256=KPOKDRBmM4mzGLdRZwDyrTIph6Eud9Vb2vil1dxNdV0,7030
+fastapi/_compat/v1.py,sha256=v_YLzo8uyr0HeA7QxNbgaSb332kCcBK9-9PZmOHGkq8,10325
+fastapi/_compat/v2.py,sha256=w9NLgyL3eF-7UKuFLGYfEkK6IUUAz3VkWe7cFgHwwns,16597
+fastapi/applications.py,sha256=LMSC56YSekA9_D8LwIkPSJxAEAqltWjTJg9PU0GO6fc,180303
+fastapi/background.py,sha256=YWxNdBckdgMLJlwJJT2sR5NJpkVXQVdbYuuyj8zUYsk,1793
+fastapi/cli.py,sha256=OYhZb0NR_deuT5ofyPF2NoNBzZDNOP8Salef2nk-HqA,418
+fastapi/concurrency.py,sha256=MirfowoSpkMQZ8j_g0ZxaQKpV6eB3G-dB5TgcXCrgEA,1424
+fastapi/datastructures.py,sha256=VnWKzzE1EW7KLOTRNWeEqlIoJQASCfgdKOOu5EM3H9A,5813
fastapi/dependencies/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
fastapi/dependencies/__pycache__/__init__.cpython-312.pyc,,
fastapi/dependencies/__pycache__/models.cpython-312.pyc,,
fastapi/dependencies/__pycache__/utils.cpython-312.pyc,,
-fastapi/dependencies/models.py,sha256=-n-YCxzgVBkurQi49qOTooT71v_oeAhHJ-qQFonxh5o,2494
-fastapi/dependencies/utils.py,sha256=DjRdd_NVdXh_jDYKTRjUIXkwkLD0WE4oFXQC4peMr2c,29915
-fastapi/encoders.py,sha256=90lbmIW8NZjpPVzbgKhpY49B7TFqa7hrdQDQa70SM9U,11024
-fastapi/exception_handlers.py,sha256=MBrIOA-ugjJDivIi4rSsUJBdTsjuzN76q4yh0q1COKw,1332
-fastapi/exceptions.py,sha256=SQsPxq-QYBZUhq6L4K3B3W7gaSD3Gub2f17erStRagY,5000
+fastapi/dependencies/models.py,sha256=Fhvjxgijgsk1hU9Yp2lJ_w4jD0xPELs5JxmYPKxILPE,3833
+fastapi/dependencies/utils.py,sha256=qsGUuL-iwGUfUU7L9sILr2NWa9NaXGlKe1VXzb8Upxk,38649
+fastapi/encoders.py,sha256=KAMFJ0sz0FFl0Pg4sUiXiuq94av3mLdLZnzeYp9f4wM,11343
+fastapi/exception_handlers.py,sha256=YVcT8Zy021VYYeecgdyh5YEUjEIHKcLspbkSf4OfbJI,1275
+fastapi/exceptions.py,sha256=JXhpWMMbNwcjQq3nVe3Czj-nOZU1Mcbu1EWpuK75lwA,5156
fastapi/logger.py,sha256=I9NNi3ov8AcqbsbC9wl1X-hdItKgYt2XTrx1f99Zpl4,54
fastapi/middleware/__init__.py,sha256=oQDxiFVcc1fYJUOIFvphnK7pTT5kktmfL32QXpBFvvo,58
fastapi/middleware/__pycache__/__init__.cpython-312.pyc,,
@@ -49,7 +68,7 @@ fastapi/middleware/__pycache__/gzip.cpython-312.pyc,,
fastapi/middleware/__pycache__/httpsredirect.cpython-312.pyc,,
fastapi/middleware/__pycache__/trustedhost.cpython-312.pyc,,
fastapi/middleware/__pycache__/wsgi.cpython-312.pyc,,
-fastapi/middleware/asyncexitstack.py,sha256=LvMyVI1QdmWNWYPZqx295VFavssUfVpUsonPOsMWz1E,1035
+fastapi/middleware/asyncexitstack.py,sha256=RKGlQpGzg3GLosqVhrxBy_NCZ9qJS7zQeNHt5Y3x-00,637
fastapi/middleware/cors.py,sha256=ynwjWQZoc_vbhzZ3_ZXceoaSrslHFHPdoM52rXr0WUU,79
fastapi/middleware/gzip.py,sha256=xM5PcsH8QlAimZw4VDvcmTnqQamslThsfe3CVN2voa0,79
fastapi/middleware/httpsredirect.py,sha256=rL8eXMnmLijwVkH7_400zHri1AekfeBd6D6qs8ix950,115
@@ -62,15 +81,15 @@ fastapi/openapi/__pycache__/docs.cpython-312.pyc,,
fastapi/openapi/__pycache__/models.cpython-312.pyc,,
fastapi/openapi/__pycache__/utils.cpython-312.pyc,,
fastapi/openapi/constants.py,sha256=adGzmis1L1HJRTE3kJ5fmHS_Noq6tIY6pWv_SFzoFDU,153
-fastapi/openapi/docs.py,sha256=Fo_SGB0eEfGvlNLqP-w_jgYifmHTe-3LbO_qC-ncFVY,10387
-fastapi/openapi/models.py,sha256=DEmsWA-9sNqv2H4YneZUW86r1nMwD920EiTvan5kndI,17763
-fastapi/openapi/utils.py,sha256=PUuz_ISarHVPBRyIgfyHz8uwH0eEsDY3rJUfW__I9GI,22303
-fastapi/param_functions.py,sha256=VWEsJbkH8lJZgcJ6fI6uzquui1kgHrDv1i_wXM7cW3M,63896
-fastapi/params.py,sha256=LzjihAvODd3w7-GddraUyVtH1xfwR9smIoQn-Z_g4mg,27807
+fastapi/openapi/docs.py,sha256=9Rypo8GU5gdp2S7SsoyIZSVGp5e3T2T1KTtJBYTCnRs,10370
+fastapi/openapi/models.py,sha256=m1BNHxf_RiDTK1uCfMre6XZN5y7krZNA62QEP_2EV9s,15625
+fastapi/openapi/utils.py,sha256=2DkhvMHoHLI58vK4vai_7v9WZ3R5RMB6dGDIAx3snGo,23255
+fastapi/param_functions.py,sha256=DxMaQdIlHOHM-zIyDPhcRvuBm1KLBjdU1IjrsOHG5Lc,65141
+fastapi/params.py,sha256=LVUbMaFoJPCsCtZvUkGsytFO1kMFQPF4_8g62p6p5v4,27974
fastapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
fastapi/requests.py,sha256=zayepKFcienBllv3snmWI20Gk0oHNVLU4DDhqXBb4LU,142
fastapi/responses.py,sha256=QNQQlwpKhQoIPZTTWkpc9d_QGeGZ_aVQPaDV3nQ8m7c,1761
-fastapi/routing.py,sha256=VADa3-b52ahpweFCcmAKXkVKldMrfF60N5gZWobI42M,172198
+fastapi/routing.py,sha256=d9h-Kk0iIqp4mhoFj1tw2LXGsaQ7BV5PtPTTq71w4rw,178778
fastapi/security/__init__.py,sha256=bO8pNmxqVRXUjfl2mOKiVZLn0FpBQ61VUYVjmppnbJw,881
fastapi/security/__pycache__/__init__.cpython-312.pyc,,
fastapi/security/__pycache__/api_key.cpython-312.pyc,,
@@ -79,15 +98,16 @@ fastapi/security/__pycache__/http.cpython-312.pyc,,
fastapi/security/__pycache__/oauth2.cpython-312.pyc,,
fastapi/security/__pycache__/open_id_connect_url.cpython-312.pyc,,
fastapi/security/__pycache__/utils.cpython-312.pyc,,
-fastapi/security/api_key.py,sha256=bcZbUzTqeR_CI_LXuJdDq1qL322kmhgy5ApOCqgGDi4,9399
+fastapi/security/api_key.py,sha256=A-iwJK1BA8_VxOFsrq5obI73PG9c7trgqbgSSzgUnFM,9828
fastapi/security/base.py,sha256=dl4pvbC-RxjfbWgPtCWd8MVU-7CB2SZ22rJDXVCXO6c,141
-fastapi/security/http.py,sha256=_YdhSRRUCGydVDUILygWg0VlkPA28t_gjcy_axD3eOk,13537
-fastapi/security/oauth2.py,sha256=QAUOE2f6KXbXjkrJIIYCOugI6-R0g9EECZ5t8eN9nA4,21612
-fastapi/security/open_id_connect_url.py,sha256=Mb8wFxrRh4CrsFW0RcjBEQLASPHGDtZRP6c2dCrspAg,2753
+fastapi/security/http.py,sha256=K0Uqs2m96uKYowIx8g0drxvcDOj16aF69ImfPs__Vo8,13553
+fastapi/security/oauth2.py,sha256=pjnH7oolLSYyZlyJ7lUXDXNQ4HPc61_yQA7-48qLnxY,22574
+fastapi/security/open_id_connect_url.py,sha256=sSxBRJZpDnjyGFnT4y1I7ZwtlQovpi2zHii80CvLEao,3187
fastapi/security/utils.py,sha256=bd8T0YM7UQD5ATKucr1bNtAvz_Y3__dVNAv5UebiPvc,293
fastapi/staticfiles.py,sha256=iirGIt3sdY2QZXd36ijs3Cj-T0FuGFda3cd90kM9Ikw,69
+fastapi/temp_pydantic_v1_params.py,sha256=c9uTBAryfdbgEmAiuJ9BmnmFzYiFZK52z3dDKX4PSRY,26530
fastapi/templating.py,sha256=4zsuTWgcjcEainMJFAlW6-gnslm6AgOS1SiiDWfmQxk,76
fastapi/testclient.py,sha256=nBvaAmX66YldReJNZXPOk1sfuo2Q6hs8bOvIaCep6LQ,66
-fastapi/types.py,sha256=WZJ1jvm1MCwIrxxRYxKwtXS9HqcGk0RnCbLzrMZh-lI,428
-fastapi/utils.py,sha256=rpSasHpgooPIfe67yU3HzOMDv7PtxiG9x6K-bhu6Z18,8193
+fastapi/types.py,sha256=Y-TgF0Sy5Q6A8q7Ywjts5sysyZrzuG8Ba5OyFCiY3zg,479
+fastapi/utils.py,sha256=Nedm_1OJnL12uHJ85HTPCO-AHfwxCtXObFpBi_0X4xQ,9010
fastapi/websockets.py,sha256=419uncYObEKZG0YcrXscfQQYLSWoE10jqxVMetGdR98,222
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/REQUESTED
new file mode 100644
index 00000000..e69de29b
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/WHEEL
new file mode 100644
index 00000000..2efd4ed2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/WHEEL
@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.4.6)
+Root-Is-Purelib: true
+Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/entry_points.txt b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/entry_points.txt
new file mode 100644
index 00000000..b81849e1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/entry_points.txt
@@ -0,0 +1,5 @@
+[console_scripts]
+fastapi = fastapi.cli:main
+
+[gui_scripts]
+
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/licenses/LICENSE b/Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/licenses/LICENSE
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/fastapi-0.104.1.dist-info/licenses/LICENSE
rename to Backend/venv/lib/python3.12/site-packages/fastapi-0.123.0.dist-info/licenses/LICENSE
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__init__.py b/Backend/venv/lib/python3.12/site-packages/fastapi/__init__.py
index c81f09b2..25ed2bbe 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/__init__.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/__init__.py
@@ -1,6 +1,6 @@
"""FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
-__version__ = "0.104.1"
+__version__ = "0.123.0"
from starlette import status as status
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__main__.py b/Backend/venv/lib/python3.12/site-packages/fastapi/__main__.py
new file mode 100644
index 00000000..fc36465f
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/__main__.py
@@ -0,0 +1,3 @@
+from fastapi.cli import main
+
+main()
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/__init__.cpython-312.pyc
index 19ac2e58..3092536b 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/__main__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/__main__.cpython-312.pyc
new file mode 100644
index 00000000..4a9f0c16
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/__main__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/_compat.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/_compat.cpython-312.pyc
deleted file mode 100644
index 13e79d4e..00000000
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/_compat.cpython-312.pyc and /dev/null differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/applications.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/applications.cpython-312.pyc
index 6d4fdfc1..39d1e3c8 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/applications.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/applications.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/background.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/background.cpython-312.pyc
index b710ff06..06c6c6fd 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/background.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/background.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/cli.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/cli.cpython-312.pyc
new file mode 100644
index 00000000..dc860d9f
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/cli.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/concurrency.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/concurrency.cpython-312.pyc
index 2c35c6ee..cd34b086 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/concurrency.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/concurrency.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/datastructures.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/datastructures.cpython-312.pyc
index 63d2983c..28ad4f3f 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/datastructures.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/datastructures.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/encoders.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/encoders.cpython-312.pyc
index 11d3c69d..9eb15469 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/encoders.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/encoders.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exception_handlers.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exception_handlers.cpython-312.pyc
index 7d9f1aa7..b39938e1 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exception_handlers.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exception_handlers.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exceptions.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exceptions.cpython-312.pyc
index c5b8da0f..806f0b59 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exceptions.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/exceptions.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/logger.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/logger.cpython-312.pyc
index 34e63c54..e06b1611 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/logger.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/logger.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/param_functions.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/param_functions.cpython-312.pyc
index b07cb7e3..5372428a 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/param_functions.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/param_functions.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/params.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/params.cpython-312.pyc
index 359df0f5..6ea4ad0e 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/params.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/params.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/requests.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/requests.cpython-312.pyc
index 466fd711..7b34323e 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/requests.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/requests.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/responses.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/responses.cpython-312.pyc
index 2a713d92..4c194a5a 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/responses.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/responses.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/routing.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/routing.cpython-312.pyc
index 1f04aa5b..6c9d2916 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/routing.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/routing.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/staticfiles.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/staticfiles.cpython-312.pyc
index 04e32a53..3dec0d96 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/staticfiles.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/staticfiles.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/temp_pydantic_v1_params.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/temp_pydantic_v1_params.cpython-312.pyc
new file mode 100644
index 00000000..3ee922ff
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/temp_pydantic_v1_params.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/templating.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/templating.cpython-312.pyc
new file mode 100644
index 00000000..6748f6fd
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/templating.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/testclient.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/testclient.cpython-312.pyc
new file mode 100644
index 00000000..915c046c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/testclient.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/types.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/types.cpython-312.pyc
index 1d3e0233..ed7d2462 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/types.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/types.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/utils.cpython-312.pyc
index 52a8a04c..8ecb0f41 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/utils.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/websockets.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/websockets.cpython-312.pyc
index 58b11da6..8fa57874 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/websockets.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/__pycache__/websockets.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat.py
deleted file mode 100644
index fc605d0e..00000000
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat.py
+++ /dev/null
@@ -1,629 +0,0 @@
-from collections import deque
-from copy import copy
-from dataclasses import dataclass, is_dataclass
-from enum import Enum
-from typing import (
- Any,
- Callable,
- Deque,
- Dict,
- FrozenSet,
- List,
- Mapping,
- Sequence,
- Set,
- Tuple,
- Type,
- Union,
-)
-
-from fastapi.exceptions import RequestErrorModel
-from fastapi.types import IncEx, ModelNameMap, UnionType
-from pydantic import BaseModel, create_model
-from pydantic.version import VERSION as PYDANTIC_VERSION
-from starlette.datastructures import UploadFile
-from typing_extensions import Annotated, Literal, get_args, get_origin
-
-PYDANTIC_V2 = PYDANTIC_VERSION.startswith("2.")
-
-
-sequence_annotation_to_type = {
- Sequence: list,
- List: list,
- list: list,
- Tuple: tuple,
- tuple: tuple,
- Set: set,
- set: set,
- FrozenSet: frozenset,
- frozenset: frozenset,
- Deque: deque,
- deque: deque,
-}
-
-sequence_types = tuple(sequence_annotation_to_type.keys())
-
-if PYDANTIC_V2:
- from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError
- from pydantic import TypeAdapter
- from pydantic import ValidationError as ValidationError
- from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]
- GetJsonSchemaHandler as GetJsonSchemaHandler,
- )
- from pydantic._internal._typing_extra import eval_type_lenient
- from pydantic._internal._utils import lenient_issubclass as lenient_issubclass
- from pydantic.fields import FieldInfo
- from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema
- from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue
- from pydantic_core import CoreSchema as CoreSchema
- from pydantic_core import PydanticUndefined, PydanticUndefinedType
- from pydantic_core import Url as Url
-
- try:
- from pydantic_core.core_schema import (
- with_info_plain_validator_function as with_info_plain_validator_function,
- )
- except ImportError: # pragma: no cover
- from pydantic_core.core_schema import (
- general_plain_validator_function as with_info_plain_validator_function, # noqa: F401
- )
-
- Required = PydanticUndefined
- Undefined = PydanticUndefined
- UndefinedType = PydanticUndefinedType
- evaluate_forwardref = eval_type_lenient
- Validator = Any
-
- class BaseConfig:
- pass
-
- class ErrorWrapper(Exception):
- pass
-
- @dataclass
- class ModelField:
- field_info: FieldInfo
- name: str
- mode: Literal["validation", "serialization"] = "validation"
-
- @property
- def alias(self) -> str:
- a = self.field_info.alias
- return a if a is not None else self.name
-
- @property
- def required(self) -> bool:
- return self.field_info.is_required()
-
- @property
- def default(self) -> Any:
- return self.get_default()
-
- @property
- def type_(self) -> Any:
- return self.field_info.annotation
-
- def __post_init__(self) -> None:
- self._type_adapter: TypeAdapter[Any] = TypeAdapter(
- Annotated[self.field_info.annotation, self.field_info]
- )
-
- def get_default(self) -> Any:
- if self.field_info.is_required():
- return Undefined
- return self.field_info.get_default(call_default_factory=True)
-
- def validate(
- self,
- value: Any,
- values: Dict[str, Any] = {}, # noqa: B006
- *,
- loc: Tuple[Union[int, str], ...] = (),
- ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:
- try:
- return (
- self._type_adapter.validate_python(value, from_attributes=True),
- None,
- )
- except ValidationError as exc:
- return None, _regenerate_error_with_loc(
- errors=exc.errors(), loc_prefix=loc
- )
-
- def serialize(
- self,
- value: Any,
- *,
- mode: Literal["json", "python"] = "json",
- include: Union[IncEx, None] = None,
- exclude: Union[IncEx, None] = None,
- by_alias: bool = True,
- exclude_unset: bool = False,
- exclude_defaults: bool = False,
- exclude_none: bool = False,
- ) -> Any:
- # What calls this code passes a value that already called
- # self._type_adapter.validate_python(value)
- return self._type_adapter.dump_python(
- value,
- mode=mode,
- include=include,
- exclude=exclude,
- by_alias=by_alias,
- exclude_unset=exclude_unset,
- exclude_defaults=exclude_defaults,
- exclude_none=exclude_none,
- )
-
- def __hash__(self) -> int:
- # Each ModelField is unique for our purposes, to allow making a dict from
- # ModelField to its JSON Schema.
- return id(self)
-
- def get_annotation_from_field_info(
- annotation: Any, field_info: FieldInfo, field_name: str
- ) -> Any:
- return annotation
-
- def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:
- return errors # type: ignore[return-value]
-
- def _model_rebuild(model: Type[BaseModel]) -> None:
- model.model_rebuild()
-
- def _model_dump(
- model: BaseModel, mode: Literal["json", "python"] = "json", **kwargs: Any
- ) -> Any:
- return model.model_dump(mode=mode, **kwargs)
-
- def _get_model_config(model: BaseModel) -> Any:
- return model.model_config
-
- def get_schema_from_model_field(
- *,
- field: ModelField,
- schema_generator: GenerateJsonSchema,
- model_name_map: ModelNameMap,
- field_mapping: Dict[
- Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
- ],
- separate_input_output_schemas: bool = True,
- ) -> Dict[str, Any]:
- override_mode: Union[Literal["validation"], None] = (
- None if separate_input_output_schemas else "validation"
- )
- # This expects that GenerateJsonSchema was already used to generate the definitions
- json_schema = field_mapping[(field, override_mode or field.mode)]
- if "$ref" not in json_schema:
- # TODO remove when deprecating Pydantic v1
- # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207
- json_schema["title"] = (
- field.field_info.title or field.alias.title().replace("_", " ")
- )
- return json_schema
-
- def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:
- return {}
-
- def get_definitions(
- *,
- fields: List[ModelField],
- schema_generator: GenerateJsonSchema,
- model_name_map: ModelNameMap,
- separate_input_output_schemas: bool = True,
- ) -> Tuple[
- Dict[
- Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
- ],
- Dict[str, Dict[str, Any]],
- ]:
- override_mode: Union[Literal["validation"], None] = (
- None if separate_input_output_schemas else "validation"
- )
- inputs = [
- (field, override_mode or field.mode, field._type_adapter.core_schema)
- for field in fields
- ]
- field_mapping, definitions = schema_generator.generate_definitions(
- inputs=inputs
- )
- return field_mapping, definitions # type: ignore[return-value]
-
- def is_scalar_field(field: ModelField) -> bool:
- from fastapi import params
-
- return field_annotation_is_scalar(
- field.field_info.annotation
- ) and not isinstance(field.field_info, params.Body)
-
- def is_sequence_field(field: ModelField) -> bool:
- return field_annotation_is_sequence(field.field_info.annotation)
-
- def is_scalar_sequence_field(field: ModelField) -> bool:
- return field_annotation_is_scalar_sequence(field.field_info.annotation)
-
- def is_bytes_field(field: ModelField) -> bool:
- return is_bytes_or_nonable_bytes_annotation(field.type_)
-
- def is_bytes_sequence_field(field: ModelField) -> bool:
- return is_bytes_sequence_annotation(field.type_)
-
- def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:
- return type(field_info).from_annotation(annotation)
-
- def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:
- origin_type = (
- get_origin(field.field_info.annotation) or field.field_info.annotation
- )
- assert issubclass(origin_type, sequence_types) # type: ignore[arg-type]
- return sequence_annotation_to_type[origin_type](value) # type: ignore[no-any-return]
-
- def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:
- error = ValidationError.from_exception_data(
- "Field required", [{"type": "missing", "loc": loc, "input": {}}]
- ).errors()[0]
- error["input"] = None
- return error # type: ignore[return-value]
-
- def create_body_model(
- *, fields: Sequence[ModelField], model_name: str
- ) -> Type[BaseModel]:
- field_params = {f.name: (f.field_info.annotation, f.field_info) for f in fields}
- BodyModel: Type[BaseModel] = create_model(model_name, **field_params) # type: ignore[call-overload]
- return BodyModel
-
-else:
- from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX
- from pydantic import AnyUrl as Url # noqa: F401
- from pydantic import ( # type: ignore[assignment]
- BaseConfig as BaseConfig, # noqa: F401
- )
- from pydantic import ValidationError as ValidationError # noqa: F401
- from pydantic.class_validators import ( # type: ignore[no-redef]
- Validator as Validator, # noqa: F401
- )
- from pydantic.error_wrappers import ( # type: ignore[no-redef]
- ErrorWrapper as ErrorWrapper, # noqa: F401
- )
- from pydantic.errors import MissingError
- from pydantic.fields import ( # type: ignore[attr-defined]
- SHAPE_FROZENSET,
- SHAPE_LIST,
- SHAPE_SEQUENCE,
- SHAPE_SET,
- SHAPE_SINGLETON,
- SHAPE_TUPLE,
- SHAPE_TUPLE_ELLIPSIS,
- )
- from pydantic.fields import FieldInfo as FieldInfo
- from pydantic.fields import ( # type: ignore[no-redef,attr-defined]
- ModelField as ModelField, # noqa: F401
- )
- from pydantic.fields import ( # type: ignore[no-redef,attr-defined]
- Required as Required, # noqa: F401
- )
- from pydantic.fields import ( # type: ignore[no-redef,attr-defined]
- Undefined as Undefined,
- )
- from pydantic.fields import ( # type: ignore[no-redef, attr-defined]
- UndefinedType as UndefinedType, # noqa: F401
- )
- from pydantic.schema import (
- field_schema,
- get_flat_models_from_fields,
- get_model_name_map,
- model_process_schema,
- )
- from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401
- get_annotation_from_field_info as get_annotation_from_field_info,
- )
- from pydantic.typing import ( # type: ignore[no-redef]
- evaluate_forwardref as evaluate_forwardref, # noqa: F401
- )
- from pydantic.utils import ( # type: ignore[no-redef]
- lenient_issubclass as lenient_issubclass, # noqa: F401
- )
-
- GetJsonSchemaHandler = Any # type: ignore[assignment,misc]
- JsonSchemaValue = Dict[str, Any] # type: ignore[misc]
- CoreSchema = Any # type: ignore[assignment,misc]
-
- sequence_shapes = {
- SHAPE_LIST,
- SHAPE_SET,
- SHAPE_FROZENSET,
- SHAPE_TUPLE,
- SHAPE_SEQUENCE,
- SHAPE_TUPLE_ELLIPSIS,
- }
- sequence_shape_to_type = {
- SHAPE_LIST: list,
- SHAPE_SET: set,
- SHAPE_TUPLE: tuple,
- SHAPE_SEQUENCE: list,
- SHAPE_TUPLE_ELLIPSIS: list,
- }
-
- @dataclass
- class GenerateJsonSchema: # type: ignore[no-redef]
- ref_template: str
-
- class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]
- pass
-
- def with_info_plain_validator_function( # type: ignore[misc]
- function: Callable[..., Any],
- *,
- ref: Union[str, None] = None,
- metadata: Any = None,
- serialization: Any = None,
- ) -> Any:
- return {}
-
- def get_model_definitions(
- *,
- flat_models: Set[Union[Type[BaseModel], Type[Enum]]],
- model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],
- ) -> Dict[str, Any]:
- definitions: Dict[str, Dict[str, Any]] = {}
- for model in flat_models:
- m_schema, m_definitions, m_nested_models = model_process_schema(
- model, model_name_map=model_name_map, ref_prefix=REF_PREFIX
- )
- definitions.update(m_definitions)
- model_name = model_name_map[model]
- if "description" in m_schema:
- m_schema["description"] = m_schema["description"].split("\f")[0]
- definitions[model_name] = m_schema
- return definitions
-
- def is_pv1_scalar_field(field: ModelField) -> bool:
- from fastapi import params
-
- field_info = field.field_info
- if not (
- field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]
- and not lenient_issubclass(field.type_, BaseModel)
- and not lenient_issubclass(field.type_, dict)
- and not field_annotation_is_sequence(field.type_)
- and not is_dataclass(field.type_)
- and not isinstance(field_info, params.Body)
- ):
- return False
- if field.sub_fields: # type: ignore[attr-defined]
- if not all(
- is_pv1_scalar_field(f)
- for f in field.sub_fields # type: ignore[attr-defined]
- ):
- return False
- return True
-
- def is_pv1_scalar_sequence_field(field: ModelField) -> bool:
- if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]
- field.type_, BaseModel
- ):
- if field.sub_fields is not None: # type: ignore[attr-defined]
- for sub_field in field.sub_fields: # type: ignore[attr-defined]
- if not is_pv1_scalar_field(sub_field):
- return False
- return True
- if _annotation_is_sequence(field.type_):
- return True
- return False
-
- def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:
- use_errors: List[Any] = []
- for error in errors:
- if isinstance(error, ErrorWrapper):
- new_errors = ValidationError( # type: ignore[call-arg]
- errors=[error], model=RequestErrorModel
- ).errors()
- use_errors.extend(new_errors)
- elif isinstance(error, list):
- use_errors.extend(_normalize_errors(error))
- else:
- use_errors.append(error)
- return use_errors
-
- def _model_rebuild(model: Type[BaseModel]) -> None:
- model.update_forward_refs()
-
- def _model_dump(
- model: BaseModel, mode: Literal["json", "python"] = "json", **kwargs: Any
- ) -> Any:
- return model.dict(**kwargs)
-
- def _get_model_config(model: BaseModel) -> Any:
- return model.__config__ # type: ignore[attr-defined]
-
- def get_schema_from_model_field(
- *,
- field: ModelField,
- schema_generator: GenerateJsonSchema,
- model_name_map: ModelNameMap,
- field_mapping: Dict[
- Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
- ],
- separate_input_output_schemas: bool = True,
- ) -> Dict[str, Any]:
- # This expects that GenerateJsonSchema was already used to generate the definitions
- return field_schema( # type: ignore[no-any-return]
- field, model_name_map=model_name_map, ref_prefix=REF_PREFIX
- )[0]
-
- def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:
- models = get_flat_models_from_fields(fields, known_models=set())
- return get_model_name_map(models) # type: ignore[no-any-return]
-
- def get_definitions(
- *,
- fields: List[ModelField],
- schema_generator: GenerateJsonSchema,
- model_name_map: ModelNameMap,
- separate_input_output_schemas: bool = True,
- ) -> Tuple[
- Dict[
- Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
- ],
- Dict[str, Dict[str, Any]],
- ]:
- models = get_flat_models_from_fields(fields, known_models=set())
- return {}, get_model_definitions(
- flat_models=models, model_name_map=model_name_map
- )
-
- def is_scalar_field(field: ModelField) -> bool:
- return is_pv1_scalar_field(field)
-
- def is_sequence_field(field: ModelField) -> bool:
- return field.shape in sequence_shapes or _annotation_is_sequence(field.type_) # type: ignore[attr-defined]
-
- def is_scalar_sequence_field(field: ModelField) -> bool:
- return is_pv1_scalar_sequence_field(field)
-
- def is_bytes_field(field: ModelField) -> bool:
- return lenient_issubclass(field.type_, bytes)
-
- def is_bytes_sequence_field(field: ModelField) -> bool:
- return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes) # type: ignore[attr-defined]
-
- def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:
- return copy(field_info)
-
- def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:
- return sequence_shape_to_type[field.shape](value) # type: ignore[no-any-return,attr-defined]
-
- def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:
- missing_field_error = ErrorWrapper(MissingError(), loc=loc) # type: ignore[call-arg]
- new_error = ValidationError([missing_field_error], RequestErrorModel)
- return new_error.errors()[0] # type: ignore[return-value]
-
- def create_body_model(
- *, fields: Sequence[ModelField], model_name: str
- ) -> Type[BaseModel]:
- BodyModel = create_model(model_name)
- for f in fields:
- BodyModel.__fields__[f.name] = f # type: ignore[index]
- return BodyModel
-
-
-def _regenerate_error_with_loc(
- *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]
-) -> List[Dict[str, Any]]:
- updated_loc_errors: List[Any] = [
- {**err, "loc": loc_prefix + err.get("loc", ())}
- for err in _normalize_errors(errors)
- ]
-
- return updated_loc_errors
-
-
-def _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:
- if lenient_issubclass(annotation, (str, bytes)):
- return False
- return lenient_issubclass(annotation, sequence_types)
-
-
-def field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:
- return _annotation_is_sequence(annotation) or _annotation_is_sequence(
- get_origin(annotation)
- )
-
-
-def value_is_sequence(value: Any) -> bool:
- return isinstance(value, sequence_types) and not isinstance(value, (str, bytes)) # type: ignore[arg-type]
-
-
-def _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:
- return (
- lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))
- or _annotation_is_sequence(annotation)
- or is_dataclass(annotation)
- )
-
-
-def field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:
- origin = get_origin(annotation)
- if origin is Union or origin is UnionType:
- return any(field_annotation_is_complex(arg) for arg in get_args(annotation))
-
- return (
- _annotation_is_complex(annotation)
- or _annotation_is_complex(origin)
- or hasattr(origin, "__pydantic_core_schema__")
- or hasattr(origin, "__get_pydantic_core_schema__")
- )
-
-
-def field_annotation_is_scalar(annotation: Any) -> bool:
- # handle Ellipsis here to make tuple[int, ...] work nicely
- return annotation is Ellipsis or not field_annotation_is_complex(annotation)
-
-
-def field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:
- origin = get_origin(annotation)
- if origin is Union or origin is UnionType:
- at_least_one_scalar_sequence = False
- for arg in get_args(annotation):
- if field_annotation_is_scalar_sequence(arg):
- at_least_one_scalar_sequence = True
- continue
- elif not field_annotation_is_scalar(arg):
- return False
- return at_least_one_scalar_sequence
- return field_annotation_is_sequence(annotation) and all(
- field_annotation_is_scalar(sub_annotation)
- for sub_annotation in get_args(annotation)
- )
-
-
-def is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:
- if lenient_issubclass(annotation, bytes):
- return True
- origin = get_origin(annotation)
- if origin is Union or origin is UnionType:
- for arg in get_args(annotation):
- if lenient_issubclass(arg, bytes):
- return True
- return False
-
-
-def is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:
- if lenient_issubclass(annotation, UploadFile):
- return True
- origin = get_origin(annotation)
- if origin is Union or origin is UnionType:
- for arg in get_args(annotation):
- if lenient_issubclass(arg, UploadFile):
- return True
- return False
-
-
-def is_bytes_sequence_annotation(annotation: Any) -> bool:
- origin = get_origin(annotation)
- if origin is Union or origin is UnionType:
- at_least_one = False
- for arg in get_args(annotation):
- if is_bytes_sequence_annotation(arg):
- at_least_one = True
- continue
- return at_least_one
- return field_annotation_is_sequence(annotation) and all(
- is_bytes_or_nonable_bytes_annotation(sub_annotation)
- for sub_annotation in get_args(annotation)
- )
-
-
-def is_uploadfile_sequence_annotation(annotation: Any) -> bool:
- origin = get_origin(annotation)
- if origin is Union or origin is UnionType:
- at_least_one = False
- for arg in get_args(annotation):
- if is_uploadfile_sequence_annotation(arg):
- at_least_one = True
- continue
- return at_least_one
- return field_annotation_is_sequence(annotation) and all(
- is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)
- for sub_annotation in get_args(annotation)
- )
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__init__.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__init__.py
new file mode 100644
index 00000000..0aadd68d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__init__.py
@@ -0,0 +1,50 @@
+from .main import BaseConfig as BaseConfig
+from .main import PydanticSchemaGenerationError as PydanticSchemaGenerationError
+from .main import RequiredParam as RequiredParam
+from .main import Undefined as Undefined
+from .main import UndefinedType as UndefinedType
+from .main import Url as Url
+from .main import Validator as Validator
+from .main import _get_model_config as _get_model_config
+from .main import _is_error_wrapper as _is_error_wrapper
+from .main import _is_model_class as _is_model_class
+from .main import _is_model_field as _is_model_field
+from .main import _is_undefined as _is_undefined
+from .main import _model_dump as _model_dump
+from .main import _model_rebuild as _model_rebuild
+from .main import copy_field_info as copy_field_info
+from .main import create_body_model as create_body_model
+from .main import evaluate_forwardref as evaluate_forwardref
+from .main import get_annotation_from_field_info as get_annotation_from_field_info
+from .main import get_cached_model_fields as get_cached_model_fields
+from .main import get_compat_model_name_map as get_compat_model_name_map
+from .main import get_definitions as get_definitions
+from .main import get_missing_field_error as get_missing_field_error
+from .main import get_schema_from_model_field as get_schema_from_model_field
+from .main import is_bytes_field as is_bytes_field
+from .main import is_bytes_sequence_field as is_bytes_sequence_field
+from .main import is_scalar_field as is_scalar_field
+from .main import is_scalar_sequence_field as is_scalar_sequence_field
+from .main import is_sequence_field as is_sequence_field
+from .main import serialize_sequence_value as serialize_sequence_value
+from .main import (
+ with_info_plain_validator_function as with_info_plain_validator_function,
+)
+from .may_v1 import CoreSchema as CoreSchema
+from .may_v1 import GetJsonSchemaHandler as GetJsonSchemaHandler
+from .may_v1 import JsonSchemaValue as JsonSchemaValue
+from .may_v1 import _normalize_errors as _normalize_errors
+from .model_field import ModelField as ModelField
+from .shared import PYDANTIC_V2 as PYDANTIC_V2
+from .shared import PYDANTIC_VERSION_MINOR_TUPLE as PYDANTIC_VERSION_MINOR_TUPLE
+from .shared import annotation_is_pydantic_v1 as annotation_is_pydantic_v1
+from .shared import field_annotation_is_scalar as field_annotation_is_scalar
+from .shared import (
+ is_uploadfile_or_nonable_uploadfile_annotation as is_uploadfile_or_nonable_uploadfile_annotation,
+)
+from .shared import (
+ is_uploadfile_sequence_annotation as is_uploadfile_sequence_annotation,
+)
+from .shared import lenient_issubclass as lenient_issubclass
+from .shared import sequence_types as sequence_types
+from .shared import value_is_sequence as value_is_sequence
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..975d1c59
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/main.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/main.cpython-312.pyc
new file mode 100644
index 00000000..25486383
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/main.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/may_v1.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/may_v1.cpython-312.pyc
new file mode 100644
index 00000000..dd224cdc
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/may_v1.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/model_field.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/model_field.cpython-312.pyc
new file mode 100644
index 00000000..0f2fc815
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/model_field.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/shared.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/shared.cpython-312.pyc
new file mode 100644
index 00000000..17f7dab6
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/shared.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/v1.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/v1.cpython-312.pyc
new file mode 100644
index 00000000..457fb722
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/v1.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/v2.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/v2.cpython-312.pyc
new file mode 100644
index 00000000..eeb60b29
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/__pycache__/v2.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/main.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/main.py
new file mode 100644
index 00000000..e5275950
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/main.py
@@ -0,0 +1,362 @@
+import sys
+from functools import lru_cache
+from typing import (
+ Any,
+ Dict,
+ List,
+ Sequence,
+ Tuple,
+ Type,
+)
+
+from fastapi._compat import may_v1
+from fastapi._compat.shared import PYDANTIC_V2, lenient_issubclass
+from fastapi.types import ModelNameMap
+from pydantic import BaseModel
+from typing_extensions import Literal
+
+from .model_field import ModelField
+
+if PYDANTIC_V2:
+ from .v2 import BaseConfig as BaseConfig
+ from .v2 import FieldInfo as FieldInfo
+ from .v2 import PydanticSchemaGenerationError as PydanticSchemaGenerationError
+ from .v2 import RequiredParam as RequiredParam
+ from .v2 import Undefined as Undefined
+ from .v2 import UndefinedType as UndefinedType
+ from .v2 import Url as Url
+ from .v2 import Validator as Validator
+ from .v2 import evaluate_forwardref as evaluate_forwardref
+ from .v2 import get_missing_field_error as get_missing_field_error
+ from .v2 import (
+ with_info_plain_validator_function as with_info_plain_validator_function,
+ )
+else:
+ from .v1 import BaseConfig as BaseConfig # type: ignore[assignment]
+ from .v1 import FieldInfo as FieldInfo
+ from .v1 import ( # type: ignore[assignment]
+ PydanticSchemaGenerationError as PydanticSchemaGenerationError,
+ )
+ from .v1 import RequiredParam as RequiredParam
+ from .v1 import Undefined as Undefined
+ from .v1 import UndefinedType as UndefinedType
+ from .v1 import Url as Url # type: ignore[assignment]
+ from .v1 import Validator as Validator
+ from .v1 import evaluate_forwardref as evaluate_forwardref
+ from .v1 import get_missing_field_error as get_missing_field_error
+ from .v1 import ( # type: ignore[assignment]
+ with_info_plain_validator_function as with_info_plain_validator_function,
+ )
+
+
+@lru_cache
+def get_cached_model_fields(model: Type[BaseModel]) -> List[ModelField]:
+ if lenient_issubclass(model, may_v1.BaseModel):
+ from fastapi._compat import v1
+
+ return v1.get_model_fields(model)
+ else:
+ from . import v2
+
+ return v2.get_model_fields(model) # type: ignore[return-value]
+
+
+def _is_undefined(value: object) -> bool:
+ if isinstance(value, may_v1.UndefinedType):
+ return True
+ elif PYDANTIC_V2:
+ from . import v2
+
+ return isinstance(value, v2.UndefinedType)
+ return False
+
+
+def _get_model_config(model: BaseModel) -> Any:
+ if isinstance(model, may_v1.BaseModel):
+ from fastapi._compat import v1
+
+ return v1._get_model_config(model)
+ elif PYDANTIC_V2:
+ from . import v2
+
+ return v2._get_model_config(model)
+
+
+def _model_dump(
+ model: BaseModel, mode: Literal["json", "python"] = "json", **kwargs: Any
+) -> Any:
+ if isinstance(model, may_v1.BaseModel):
+ from fastapi._compat import v1
+
+ return v1._model_dump(model, mode=mode, **kwargs)
+ elif PYDANTIC_V2:
+ from . import v2
+
+ return v2._model_dump(model, mode=mode, **kwargs)
+
+
+def _is_error_wrapper(exc: Exception) -> bool:
+ if isinstance(exc, may_v1.ErrorWrapper):
+ return True
+ elif PYDANTIC_V2:
+ from . import v2
+
+ return isinstance(exc, v2.ErrorWrapper)
+ return False
+
+
+def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:
+ if isinstance(field_info, may_v1.FieldInfo):
+ from fastapi._compat import v1
+
+ return v1.copy_field_info(field_info=field_info, annotation=annotation)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.copy_field_info(field_info=field_info, annotation=annotation)
+
+
+def create_body_model(
+ *, fields: Sequence[ModelField], model_name: str
+) -> Type[BaseModel]:
+ if fields and isinstance(fields[0], may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.create_body_model(fields=fields, model_name=model_name)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.create_body_model(fields=fields, model_name=model_name) # type: ignore[arg-type]
+
+
+def get_annotation_from_field_info(
+ annotation: Any, field_info: FieldInfo, field_name: str
+) -> Any:
+ if isinstance(field_info, may_v1.FieldInfo):
+ from fastapi._compat import v1
+
+ return v1.get_annotation_from_field_info(
+ annotation=annotation, field_info=field_info, field_name=field_name
+ )
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.get_annotation_from_field_info(
+ annotation=annotation, field_info=field_info, field_name=field_name
+ )
+
+
+def is_bytes_field(field: ModelField) -> bool:
+ if isinstance(field, may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.is_bytes_field(field)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.is_bytes_field(field) # type: ignore[arg-type]
+
+
+def is_bytes_sequence_field(field: ModelField) -> bool:
+ if isinstance(field, may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.is_bytes_sequence_field(field)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.is_bytes_sequence_field(field) # type: ignore[arg-type]
+
+
+def is_scalar_field(field: ModelField) -> bool:
+ if isinstance(field, may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.is_scalar_field(field)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.is_scalar_field(field) # type: ignore[arg-type]
+
+
+def is_scalar_sequence_field(field: ModelField) -> bool:
+ if isinstance(field, may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.is_scalar_sequence_field(field)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.is_scalar_sequence_field(field) # type: ignore[arg-type]
+
+
+def is_sequence_field(field: ModelField) -> bool:
+ if isinstance(field, may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.is_sequence_field(field)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.is_sequence_field(field) # type: ignore[arg-type]
+
+
+def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:
+ if isinstance(field, may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.serialize_sequence_value(field=field, value=value)
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.serialize_sequence_value(field=field, value=value) # type: ignore[arg-type]
+
+
+def _model_rebuild(model: Type[BaseModel]) -> None:
+ if lenient_issubclass(model, may_v1.BaseModel):
+ from fastapi._compat import v1
+
+ v1._model_rebuild(model)
+ elif PYDANTIC_V2:
+ from . import v2
+
+ v2._model_rebuild(model)
+
+
+def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:
+ v1_model_fields = [
+ field for field in fields if isinstance(field, may_v1.ModelField)
+ ]
+ if v1_model_fields:
+ from fastapi._compat import v1
+
+ v1_flat_models = v1.get_flat_models_from_fields(
+ v1_model_fields, known_models=set()
+ )
+ all_flat_models = v1_flat_models
+ else:
+ all_flat_models = set()
+ if PYDANTIC_V2:
+ from . import v2
+
+ v2_model_fields = [
+ field for field in fields if isinstance(field, v2.ModelField)
+ ]
+ v2_flat_models = v2.get_flat_models_from_fields(
+ v2_model_fields, known_models=set()
+ )
+ all_flat_models = all_flat_models.union(v2_flat_models)
+
+ model_name_map = v2.get_model_name_map(all_flat_models)
+ return model_name_map
+ from fastapi._compat import v1
+
+ model_name_map = v1.get_model_name_map(all_flat_models)
+ return model_name_map
+
+
+def get_definitions(
+ *,
+ fields: List[ModelField],
+ model_name_map: ModelNameMap,
+ separate_input_output_schemas: bool = True,
+) -> Tuple[
+ Dict[
+ Tuple[ModelField, Literal["validation", "serialization"]],
+ may_v1.JsonSchemaValue,
+ ],
+ Dict[str, Dict[str, Any]],
+]:
+ if sys.version_info < (3, 14):
+ v1_fields = [field for field in fields if isinstance(field, may_v1.ModelField)]
+ v1_field_maps, v1_definitions = may_v1.get_definitions(
+ fields=v1_fields,
+ model_name_map=model_name_map,
+ separate_input_output_schemas=separate_input_output_schemas,
+ )
+ if not PYDANTIC_V2:
+ return v1_field_maps, v1_definitions
+ else:
+ from . import v2
+
+ v2_fields = [field for field in fields if isinstance(field, v2.ModelField)]
+ v2_field_maps, v2_definitions = v2.get_definitions(
+ fields=v2_fields,
+ model_name_map=model_name_map,
+ separate_input_output_schemas=separate_input_output_schemas,
+ )
+ all_definitions = {**v1_definitions, **v2_definitions}
+ all_field_maps = {**v1_field_maps, **v2_field_maps}
+ return all_field_maps, all_definitions
+
+ # Pydantic v1 is not supported since Python 3.14
+ else:
+ from . import v2
+
+ v2_fields = [field for field in fields if isinstance(field, v2.ModelField)]
+ v2_field_maps, v2_definitions = v2.get_definitions(
+ fields=v2_fields,
+ model_name_map=model_name_map,
+ separate_input_output_schemas=separate_input_output_schemas,
+ )
+ return v2_field_maps, v2_definitions
+
+
+def get_schema_from_model_field(
+ *,
+ field: ModelField,
+ model_name_map: ModelNameMap,
+ field_mapping: Dict[
+ Tuple[ModelField, Literal["validation", "serialization"]],
+ may_v1.JsonSchemaValue,
+ ],
+ separate_input_output_schemas: bool = True,
+) -> Dict[str, Any]:
+ if isinstance(field, may_v1.ModelField):
+ from fastapi._compat import v1
+
+ return v1.get_schema_from_model_field(
+ field=field,
+ model_name_map=model_name_map,
+ field_mapping=field_mapping,
+ separate_input_output_schemas=separate_input_output_schemas,
+ )
+ else:
+ assert PYDANTIC_V2
+ from . import v2
+
+ return v2.get_schema_from_model_field(
+ field=field, # type: ignore[arg-type]
+ model_name_map=model_name_map,
+ field_mapping=field_mapping, # type: ignore[arg-type]
+ separate_input_output_schemas=separate_input_output_schemas,
+ )
+
+
+def _is_model_field(value: Any) -> bool:
+ if isinstance(value, may_v1.ModelField):
+ return True
+ elif PYDANTIC_V2:
+ from . import v2
+
+ return isinstance(value, v2.ModelField)
+ return False
+
+
+def _is_model_class(value: Any) -> bool:
+ if lenient_issubclass(value, may_v1.BaseModel):
+ return True
+ elif PYDANTIC_V2:
+ from . import v2
+
+ return lenient_issubclass(value, v2.BaseModel) # type: ignore[attr-defined]
+ return False
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/may_v1.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/may_v1.py
new file mode 100644
index 00000000..beea4d16
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/may_v1.py
@@ -0,0 +1,123 @@
+import sys
+from typing import Any, Dict, List, Literal, Sequence, Tuple, Type, Union
+
+from fastapi.types import ModelNameMap
+
+if sys.version_info >= (3, 14):
+
+ class AnyUrl:
+ pass
+
+ class BaseConfig:
+ pass
+
+ class BaseModel:
+ pass
+
+ class Color:
+ pass
+
+ class CoreSchema:
+ pass
+
+ class ErrorWrapper:
+ pass
+
+ class FieldInfo:
+ pass
+
+ class GetJsonSchemaHandler:
+ pass
+
+ class JsonSchemaValue:
+ pass
+
+ class ModelField:
+ pass
+
+ class NameEmail:
+ pass
+
+ class RequiredParam:
+ pass
+
+ class SecretBytes:
+ pass
+
+ class SecretStr:
+ pass
+
+ class Undefined:
+ pass
+
+ class UndefinedType:
+ pass
+
+ class Url:
+ pass
+
+ from .v2 import ValidationError, create_model
+
+ def get_definitions(
+ *,
+ fields: List[ModelField],
+ model_name_map: ModelNameMap,
+ separate_input_output_schemas: bool = True,
+ ) -> Tuple[
+ Dict[
+ Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+ ],
+ Dict[str, Dict[str, Any]],
+ ]:
+ return {}, {} # pragma: no cover
+
+
+else:
+ from .v1 import AnyUrl as AnyUrl
+ from .v1 import BaseConfig as BaseConfig
+ from .v1 import BaseModel as BaseModel
+ from .v1 import Color as Color
+ from .v1 import CoreSchema as CoreSchema
+ from .v1 import ErrorWrapper as ErrorWrapper
+ from .v1 import FieldInfo as FieldInfo
+ from .v1 import GetJsonSchemaHandler as GetJsonSchemaHandler
+ from .v1 import JsonSchemaValue as JsonSchemaValue
+ from .v1 import ModelField as ModelField
+ from .v1 import NameEmail as NameEmail
+ from .v1 import RequiredParam as RequiredParam
+ from .v1 import SecretBytes as SecretBytes
+ from .v1 import SecretStr as SecretStr
+ from .v1 import Undefined as Undefined
+ from .v1 import UndefinedType as UndefinedType
+ from .v1 import Url as Url
+ from .v1 import ValidationError, create_model
+ from .v1 import get_definitions as get_definitions
+
+
+RequestErrorModel: Type[BaseModel] = create_model("Request")
+
+
+def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:
+ use_errors: List[Any] = []
+ for error in errors:
+ if isinstance(error, ErrorWrapper):
+ new_errors = ValidationError( # type: ignore[call-arg]
+ errors=[error], model=RequestErrorModel
+ ).errors()
+ use_errors.extend(new_errors)
+ elif isinstance(error, list):
+ use_errors.extend(_normalize_errors(error))
+ else:
+ use_errors.append(error)
+ return use_errors
+
+
+def _regenerate_error_with_loc(
+ *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]
+) -> List[Dict[str, Any]]:
+ updated_loc_errors: List[Any] = [
+ {**err, "loc": loc_prefix + err.get("loc", ())}
+ for err in _normalize_errors(errors)
+ ]
+
+ return updated_loc_errors
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/model_field.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/model_field.py
new file mode 100644
index 00000000..fa2008c5
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/model_field.py
@@ -0,0 +1,53 @@
+from typing import (
+ Any,
+ Dict,
+ List,
+ Tuple,
+ Union,
+)
+
+from fastapi.types import IncEx
+from pydantic.fields import FieldInfo
+from typing_extensions import Literal, Protocol
+
+
+class ModelField(Protocol):
+ field_info: "FieldInfo"
+ name: str
+ mode: Literal["validation", "serialization"] = "validation"
+ _version: Literal["v1", "v2"] = "v1"
+
+ @property
+ def alias(self) -> str: ...
+
+ @property
+ def required(self) -> bool: ...
+
+ @property
+ def default(self) -> Any: ...
+
+ @property
+ def type_(self) -> Any: ...
+
+ def get_default(self) -> Any: ...
+
+ def validate(
+ self,
+ value: Any,
+ values: Dict[str, Any] = {}, # noqa: B006
+ *,
+ loc: Tuple[Union[int, str], ...] = (),
+ ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]: ...
+
+ def serialize(
+ self,
+ value: Any,
+ *,
+ mode: Literal["json", "python"] = "json",
+ include: Union[IncEx, None] = None,
+ exclude: Union[IncEx, None] = None,
+ by_alias: bool = True,
+ exclude_unset: bool = False,
+ exclude_defaults: bool = False,
+ exclude_none: bool = False,
+ ) -> Any: ...
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/shared.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/shared.py
new file mode 100644
index 00000000..cabf4822
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/shared.py
@@ -0,0 +1,211 @@
+import sys
+import types
+import typing
+from collections import deque
+from dataclasses import is_dataclass
+from typing import (
+ Any,
+ Deque,
+ FrozenSet,
+ List,
+ Mapping,
+ Sequence,
+ Set,
+ Tuple,
+ Type,
+ Union,
+)
+
+from fastapi._compat import may_v1
+from fastapi.types import UnionType
+from pydantic import BaseModel
+from pydantic.version import VERSION as PYDANTIC_VERSION
+from starlette.datastructures import UploadFile
+from typing_extensions import Annotated, get_args, get_origin
+
+# Copy from Pydantic v2, compatible with v1
+if sys.version_info < (3, 9):
+ # Pydantic no longer supports Python 3.8, this might be incorrect, but the code
+ # this is used for is also never reached in this codebase, as it's a copy of
+ # Pydantic's lenient_issubclass, just for compatibility with v1
+ # TODO: remove when dropping support for Python 3.8
+ WithArgsTypes: Tuple[Any, ...] = ()
+elif sys.version_info < (3, 10):
+ WithArgsTypes: tuple[Any, ...] = (typing._GenericAlias, types.GenericAlias) # type: ignore[attr-defined]
+else:
+ WithArgsTypes: tuple[Any, ...] = (
+ typing._GenericAlias, # type: ignore[attr-defined]
+ types.GenericAlias,
+ types.UnionType,
+ ) # pyright: ignore[reportAttributeAccessIssue]
+
+PYDANTIC_VERSION_MINOR_TUPLE = tuple(int(x) for x in PYDANTIC_VERSION.split(".")[:2])
+PYDANTIC_V2 = PYDANTIC_VERSION_MINOR_TUPLE[0] == 2
+
+
+sequence_annotation_to_type = {
+ Sequence: list,
+ List: list,
+ list: list,
+ Tuple: tuple,
+ tuple: tuple,
+ Set: set,
+ set: set,
+ FrozenSet: frozenset,
+ frozenset: frozenset,
+ Deque: deque,
+ deque: deque,
+}
+
+sequence_types = tuple(sequence_annotation_to_type.keys())
+
+Url: Type[Any]
+
+
+# Copy of Pydantic v2, compatible with v1
+def lenient_issubclass(
+ cls: Any, class_or_tuple: Union[Type[Any], Tuple[Type[Any], ...], None]
+) -> bool:
+ try:
+ return isinstance(cls, type) and issubclass(cls, class_or_tuple) # type: ignore[arg-type]
+ except TypeError: # pragma: no cover
+ if isinstance(cls, WithArgsTypes):
+ return False
+ raise # pragma: no cover
+
+
+def _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:
+ if lenient_issubclass(annotation, (str, bytes)):
+ return False
+ return lenient_issubclass(annotation, sequence_types) # type: ignore[arg-type]
+
+
+def field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ for arg in get_args(annotation):
+ if field_annotation_is_sequence(arg):
+ return True
+ return False
+ return _annotation_is_sequence(annotation) or _annotation_is_sequence(
+ get_origin(annotation)
+ )
+
+
+def value_is_sequence(value: Any) -> bool:
+ return isinstance(value, sequence_types) and not isinstance(value, (str, bytes)) # type: ignore[arg-type]
+
+
+def _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:
+ return (
+ lenient_issubclass(
+ annotation, (BaseModel, may_v1.BaseModel, Mapping, UploadFile)
+ )
+ or _annotation_is_sequence(annotation)
+ or is_dataclass(annotation)
+ )
+
+
+def field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ return any(field_annotation_is_complex(arg) for arg in get_args(annotation))
+
+ if origin is Annotated:
+ return field_annotation_is_complex(get_args(annotation)[0])
+
+ return (
+ _annotation_is_complex(annotation)
+ or _annotation_is_complex(origin)
+ or hasattr(origin, "__pydantic_core_schema__")
+ or hasattr(origin, "__get_pydantic_core_schema__")
+ )
+
+
+def field_annotation_is_scalar(annotation: Any) -> bool:
+ # handle Ellipsis here to make tuple[int, ...] work nicely
+ return annotation is Ellipsis or not field_annotation_is_complex(annotation)
+
+
+def field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ at_least_one_scalar_sequence = False
+ for arg in get_args(annotation):
+ if field_annotation_is_scalar_sequence(arg):
+ at_least_one_scalar_sequence = True
+ continue
+ elif not field_annotation_is_scalar(arg):
+ return False
+ return at_least_one_scalar_sequence
+ return field_annotation_is_sequence(annotation) and all(
+ field_annotation_is_scalar(sub_annotation)
+ for sub_annotation in get_args(annotation)
+ )
+
+
+def is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:
+ if lenient_issubclass(annotation, bytes):
+ return True
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ for arg in get_args(annotation):
+ if lenient_issubclass(arg, bytes):
+ return True
+ return False
+
+
+def is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:
+ if lenient_issubclass(annotation, UploadFile):
+ return True
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ for arg in get_args(annotation):
+ if lenient_issubclass(arg, UploadFile):
+ return True
+ return False
+
+
+def is_bytes_sequence_annotation(annotation: Any) -> bool:
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ at_least_one = False
+ for arg in get_args(annotation):
+ if is_bytes_sequence_annotation(arg):
+ at_least_one = True
+ continue
+ return at_least_one
+ return field_annotation_is_sequence(annotation) and all(
+ is_bytes_or_nonable_bytes_annotation(sub_annotation)
+ for sub_annotation in get_args(annotation)
+ )
+
+
+def is_uploadfile_sequence_annotation(annotation: Any) -> bool:
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ at_least_one = False
+ for arg in get_args(annotation):
+ if is_uploadfile_sequence_annotation(arg):
+ at_least_one = True
+ continue
+ return at_least_one
+ return field_annotation_is_sequence(annotation) and all(
+ is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)
+ for sub_annotation in get_args(annotation)
+ )
+
+
+def annotation_is_pydantic_v1(annotation: Any) -> bool:
+ if lenient_issubclass(annotation, may_v1.BaseModel):
+ return True
+ origin = get_origin(annotation)
+ if origin is Union or origin is UnionType:
+ for arg in get_args(annotation):
+ if lenient_issubclass(arg, may_v1.BaseModel):
+ return True
+ if field_annotation_is_sequence(annotation):
+ for sub_annotation in get_args(annotation):
+ if annotation_is_pydantic_v1(sub_annotation):
+ return True
+ return False
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/v1.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/v1.py
new file mode 100644
index 00000000..e17ce8be
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/v1.py
@@ -0,0 +1,312 @@
+from copy import copy
+from dataclasses import dataclass, is_dataclass
+from enum import Enum
+from typing import (
+ Any,
+ Callable,
+ Dict,
+ List,
+ Sequence,
+ Set,
+ Tuple,
+ Type,
+ Union,
+)
+
+from fastapi._compat import shared
+from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX
+from fastapi.types import ModelNameMap
+from pydantic.version import VERSION as PYDANTIC_VERSION
+from typing_extensions import Literal
+
+PYDANTIC_VERSION_MINOR_TUPLE = tuple(int(x) for x in PYDANTIC_VERSION.split(".")[:2])
+PYDANTIC_V2 = PYDANTIC_VERSION_MINOR_TUPLE[0] == 2
+# Keeping old "Required" functionality from Pydantic V1, without
+# shadowing typing.Required.
+RequiredParam: Any = Ellipsis
+
+if not PYDANTIC_V2:
+ from pydantic import BaseConfig as BaseConfig
+ from pydantic import BaseModel as BaseModel
+ from pydantic import ValidationError as ValidationError
+ from pydantic import create_model as create_model
+ from pydantic.class_validators import Validator as Validator
+ from pydantic.color import Color as Color
+ from pydantic.error_wrappers import ErrorWrapper as ErrorWrapper
+ from pydantic.errors import MissingError
+ from pydantic.fields import ( # type: ignore[attr-defined]
+ SHAPE_FROZENSET,
+ SHAPE_LIST,
+ SHAPE_SEQUENCE,
+ SHAPE_SET,
+ SHAPE_SINGLETON,
+ SHAPE_TUPLE,
+ SHAPE_TUPLE_ELLIPSIS,
+ )
+ from pydantic.fields import FieldInfo as FieldInfo
+ from pydantic.fields import ModelField as ModelField # type: ignore[attr-defined]
+ from pydantic.fields import Undefined as Undefined # type: ignore[attr-defined]
+ from pydantic.fields import ( # type: ignore[attr-defined]
+ UndefinedType as UndefinedType,
+ )
+ from pydantic.networks import AnyUrl as AnyUrl
+ from pydantic.networks import NameEmail as NameEmail
+ from pydantic.schema import TypeModelSet as TypeModelSet
+ from pydantic.schema import (
+ field_schema,
+ model_process_schema,
+ )
+ from pydantic.schema import (
+ get_annotation_from_field_info as get_annotation_from_field_info,
+ )
+ from pydantic.schema import get_flat_models_from_field as get_flat_models_from_field
+ from pydantic.schema import (
+ get_flat_models_from_fields as get_flat_models_from_fields,
+ )
+ from pydantic.schema import get_model_name_map as get_model_name_map
+ from pydantic.types import SecretBytes as SecretBytes
+ from pydantic.types import SecretStr as SecretStr
+ from pydantic.typing import evaluate_forwardref as evaluate_forwardref
+ from pydantic.utils import lenient_issubclass as lenient_issubclass
+
+
+else:
+ from pydantic.v1 import BaseConfig as BaseConfig # type: ignore[assignment]
+ from pydantic.v1 import BaseModel as BaseModel # type: ignore[assignment]
+ from pydantic.v1 import ( # type: ignore[assignment]
+ ValidationError as ValidationError,
+ )
+ from pydantic.v1 import create_model as create_model # type: ignore[no-redef]
+ from pydantic.v1.class_validators import Validator as Validator
+ from pydantic.v1.color import Color as Color # type: ignore[assignment]
+ from pydantic.v1.error_wrappers import ErrorWrapper as ErrorWrapper
+ from pydantic.v1.errors import MissingError
+ from pydantic.v1.fields import (
+ SHAPE_FROZENSET,
+ SHAPE_LIST,
+ SHAPE_SEQUENCE,
+ SHAPE_SET,
+ SHAPE_SINGLETON,
+ SHAPE_TUPLE,
+ SHAPE_TUPLE_ELLIPSIS,
+ )
+ from pydantic.v1.fields import FieldInfo as FieldInfo # type: ignore[assignment]
+ from pydantic.v1.fields import ModelField as ModelField
+ from pydantic.v1.fields import Undefined as Undefined
+ from pydantic.v1.fields import UndefinedType as UndefinedType
+ from pydantic.v1.networks import AnyUrl as AnyUrl
+ from pydantic.v1.networks import ( # type: ignore[assignment]
+ NameEmail as NameEmail,
+ )
+ from pydantic.v1.schema import TypeModelSet as TypeModelSet
+ from pydantic.v1.schema import (
+ field_schema,
+ model_process_schema,
+ )
+ from pydantic.v1.schema import (
+ get_annotation_from_field_info as get_annotation_from_field_info,
+ )
+ from pydantic.v1.schema import (
+ get_flat_models_from_field as get_flat_models_from_field,
+ )
+ from pydantic.v1.schema import (
+ get_flat_models_from_fields as get_flat_models_from_fields,
+ )
+ from pydantic.v1.schema import get_model_name_map as get_model_name_map
+ from pydantic.v1.types import ( # type: ignore[assignment]
+ SecretBytes as SecretBytes,
+ )
+ from pydantic.v1.types import ( # type: ignore[assignment]
+ SecretStr as SecretStr,
+ )
+ from pydantic.v1.typing import evaluate_forwardref as evaluate_forwardref
+ from pydantic.v1.utils import lenient_issubclass as lenient_issubclass
+
+
+GetJsonSchemaHandler = Any
+JsonSchemaValue = Dict[str, Any]
+CoreSchema = Any
+Url = AnyUrl
+
+sequence_shapes = {
+ SHAPE_LIST,
+ SHAPE_SET,
+ SHAPE_FROZENSET,
+ SHAPE_TUPLE,
+ SHAPE_SEQUENCE,
+ SHAPE_TUPLE_ELLIPSIS,
+}
+sequence_shape_to_type = {
+ SHAPE_LIST: list,
+ SHAPE_SET: set,
+ SHAPE_TUPLE: tuple,
+ SHAPE_SEQUENCE: list,
+ SHAPE_TUPLE_ELLIPSIS: list,
+}
+
+
+@dataclass
+class GenerateJsonSchema:
+ ref_template: str
+
+
+class PydanticSchemaGenerationError(Exception):
+ pass
+
+
+RequestErrorModel: Type[BaseModel] = create_model("Request")
+
+
+def with_info_plain_validator_function(
+ function: Callable[..., Any],
+ *,
+ ref: Union[str, None] = None,
+ metadata: Any = None,
+ serialization: Any = None,
+) -> Any:
+ return {}
+
+
+def get_model_definitions(
+ *,
+ flat_models: Set[Union[Type[BaseModel], Type[Enum]]],
+ model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],
+) -> Dict[str, Any]:
+ definitions: Dict[str, Dict[str, Any]] = {}
+ for model in flat_models:
+ m_schema, m_definitions, m_nested_models = model_process_schema(
+ model, model_name_map=model_name_map, ref_prefix=REF_PREFIX
+ )
+ definitions.update(m_definitions)
+ model_name = model_name_map[model]
+ definitions[model_name] = m_schema
+ for m_schema in definitions.values():
+ if "description" in m_schema:
+ m_schema["description"] = m_schema["description"].split("\f")[0]
+ return definitions
+
+
+def is_pv1_scalar_field(field: ModelField) -> bool:
+ from fastapi import params
+
+ field_info = field.field_info
+ if not (
+ field.shape == SHAPE_SINGLETON
+ and not lenient_issubclass(field.type_, BaseModel)
+ and not lenient_issubclass(field.type_, dict)
+ and not shared.field_annotation_is_sequence(field.type_)
+ and not is_dataclass(field.type_)
+ and not isinstance(field_info, params.Body)
+ ):
+ return False
+ if field.sub_fields:
+ if not all(is_pv1_scalar_field(f) for f in field.sub_fields):
+ return False
+ return True
+
+
+def is_pv1_scalar_sequence_field(field: ModelField) -> bool:
+ if (field.shape in sequence_shapes) and not lenient_issubclass(
+ field.type_, BaseModel
+ ):
+ if field.sub_fields is not None:
+ for sub_field in field.sub_fields:
+ if not is_pv1_scalar_field(sub_field):
+ return False
+ return True
+ if shared._annotation_is_sequence(field.type_):
+ return True
+ return False
+
+
+def _model_rebuild(model: Type[BaseModel]) -> None:
+ model.update_forward_refs()
+
+
+def _model_dump(
+ model: BaseModel, mode: Literal["json", "python"] = "json", **kwargs: Any
+) -> Any:
+ return model.dict(**kwargs)
+
+
+def _get_model_config(model: BaseModel) -> Any:
+ return model.__config__ # type: ignore[attr-defined]
+
+
+def get_schema_from_model_field(
+ *,
+ field: ModelField,
+ model_name_map: ModelNameMap,
+ field_mapping: Dict[
+ Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+ ],
+ separate_input_output_schemas: bool = True,
+) -> Dict[str, Any]:
+ return field_schema( # type: ignore[no-any-return]
+ field, model_name_map=model_name_map, ref_prefix=REF_PREFIX
+ )[0]
+
+
+# def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:
+# models = get_flat_models_from_fields(fields, known_models=set())
+# return get_model_name_map(models) # type: ignore[no-any-return]
+
+
+def get_definitions(
+ *,
+ fields: List[ModelField],
+ model_name_map: ModelNameMap,
+ separate_input_output_schemas: bool = True,
+) -> Tuple[
+ Dict[Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue],
+ Dict[str, Dict[str, Any]],
+]:
+ models = get_flat_models_from_fields(fields, known_models=set())
+ return {}, get_model_definitions(flat_models=models, model_name_map=model_name_map)
+
+
+def is_scalar_field(field: ModelField) -> bool:
+ return is_pv1_scalar_field(field)
+
+
+def is_sequence_field(field: ModelField) -> bool:
+ return field.shape in sequence_shapes or shared._annotation_is_sequence(field.type_)
+
+
+def is_scalar_sequence_field(field: ModelField) -> bool:
+ return is_pv1_scalar_sequence_field(field)
+
+
+def is_bytes_field(field: ModelField) -> bool:
+ return lenient_issubclass(field.type_, bytes) # type: ignore[no-any-return]
+
+
+def is_bytes_sequence_field(field: ModelField) -> bool:
+ return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes)
+
+
+def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:
+ return copy(field_info)
+
+
+def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:
+ return sequence_shape_to_type[field.shape](value) # type: ignore[no-any-return]
+
+
+def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:
+ missing_field_error = ErrorWrapper(MissingError(), loc=loc)
+ new_error = ValidationError([missing_field_error], RequestErrorModel)
+ return new_error.errors()[0] # type: ignore[return-value]
+
+
+def create_body_model(
+ *, fields: Sequence[ModelField], model_name: str
+) -> Type[BaseModel]:
+ BodyModel = create_model(model_name)
+ for f in fields:
+ BodyModel.__fields__[f.name] = f # type: ignore[index]
+ return BodyModel
+
+
+def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:
+ return list(model.__fields__.values()) # type: ignore[attr-defined]
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/v2.py b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/v2.py
new file mode 100644
index 00000000..5cd49343
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/_compat/v2.py
@@ -0,0 +1,479 @@
+import re
+import warnings
+from copy import copy, deepcopy
+from dataclasses import dataclass
+from enum import Enum
+from typing import (
+ Any,
+ Dict,
+ List,
+ Sequence,
+ Set,
+ Tuple,
+ Type,
+ Union,
+ cast,
+)
+
+from fastapi._compat import may_v1, shared
+from fastapi.openapi.constants import REF_TEMPLATE
+from fastapi.types import IncEx, ModelNameMap
+from pydantic import BaseModel, TypeAdapter, create_model
+from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError
+from pydantic import PydanticUndefinedAnnotation as PydanticUndefinedAnnotation
+from pydantic import ValidationError as ValidationError
+from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]
+ GetJsonSchemaHandler as GetJsonSchemaHandler,
+)
+from pydantic._internal._typing_extra import eval_type_lenient
+from pydantic._internal._utils import lenient_issubclass as lenient_issubclass
+from pydantic.fields import FieldInfo as FieldInfo
+from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema
+from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue
+from pydantic_core import CoreSchema as CoreSchema
+from pydantic_core import PydanticUndefined, PydanticUndefinedType
+from pydantic_core import Url as Url
+from typing_extensions import Annotated, Literal, get_args, get_origin
+
+try:
+ from pydantic_core.core_schema import (
+ with_info_plain_validator_function as with_info_plain_validator_function,
+ )
+except ImportError: # pragma: no cover
+ from pydantic_core.core_schema import (
+ general_plain_validator_function as with_info_plain_validator_function, # noqa: F401
+ )
+
+RequiredParam = PydanticUndefined
+Undefined = PydanticUndefined
+UndefinedType = PydanticUndefinedType
+evaluate_forwardref = eval_type_lenient
+Validator = Any
+
+
+class BaseConfig:
+ pass
+
+
+class ErrorWrapper(Exception):
+ pass
+
+
+@dataclass
+class ModelField:
+ field_info: FieldInfo
+ name: str
+ mode: Literal["validation", "serialization"] = "validation"
+
+ @property
+ def alias(self) -> str:
+ a = self.field_info.alias
+ return a if a is not None else self.name
+
+ @property
+ def required(self) -> bool:
+ return self.field_info.is_required()
+
+ @property
+ def default(self) -> Any:
+ return self.get_default()
+
+ @property
+ def type_(self) -> Any:
+ return self.field_info.annotation
+
+ def __post_init__(self) -> None:
+ with warnings.catch_warnings():
+ # Pydantic >= 2.12.0 warns about field specific metadata that is unused
+ # (e.g. `TypeAdapter(Annotated[int, Field(alias='b')])`). In some cases, we
+ # end up building the type adapter from a model field annotation so we
+ # need to ignore the warning:
+ if shared.PYDANTIC_VERSION_MINOR_TUPLE >= (2, 12):
+ from pydantic.warnings import UnsupportedFieldAttributeWarning
+
+ warnings.simplefilter(
+ "ignore", category=UnsupportedFieldAttributeWarning
+ )
+ self._type_adapter: TypeAdapter[Any] = TypeAdapter(
+ Annotated[self.field_info.annotation, self.field_info]
+ )
+
+ def get_default(self) -> Any:
+ if self.field_info.is_required():
+ return Undefined
+ return self.field_info.get_default(call_default_factory=True)
+
+ def validate(
+ self,
+ value: Any,
+ values: Dict[str, Any] = {}, # noqa: B006
+ *,
+ loc: Tuple[Union[int, str], ...] = (),
+ ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:
+ try:
+ return (
+ self._type_adapter.validate_python(value, from_attributes=True),
+ None,
+ )
+ except ValidationError as exc:
+ return None, may_v1._regenerate_error_with_loc(
+ errors=exc.errors(include_url=False), loc_prefix=loc
+ )
+
+ def serialize(
+ self,
+ value: Any,
+ *,
+ mode: Literal["json", "python"] = "json",
+ include: Union[IncEx, None] = None,
+ exclude: Union[IncEx, None] = None,
+ by_alias: bool = True,
+ exclude_unset: bool = False,
+ exclude_defaults: bool = False,
+ exclude_none: bool = False,
+ ) -> Any:
+ # What calls this code passes a value that already called
+ # self._type_adapter.validate_python(value)
+ return self._type_adapter.dump_python(
+ value,
+ mode=mode,
+ include=include,
+ exclude=exclude,
+ by_alias=by_alias,
+ exclude_unset=exclude_unset,
+ exclude_defaults=exclude_defaults,
+ exclude_none=exclude_none,
+ )
+
+ def __hash__(self) -> int:
+ # Each ModelField is unique for our purposes, to allow making a dict from
+ # ModelField to its JSON Schema.
+ return id(self)
+
+
+def get_annotation_from_field_info(
+ annotation: Any, field_info: FieldInfo, field_name: str
+) -> Any:
+ return annotation
+
+
+def _model_rebuild(model: Type[BaseModel]) -> None:
+ model.model_rebuild()
+
+
+def _model_dump(
+ model: BaseModel, mode: Literal["json", "python"] = "json", **kwargs: Any
+) -> Any:
+ return model.model_dump(mode=mode, **kwargs)
+
+
+def _get_model_config(model: BaseModel) -> Any:
+ return model.model_config
+
+
+def get_schema_from_model_field(
+ *,
+ field: ModelField,
+ model_name_map: ModelNameMap,
+ field_mapping: Dict[
+ Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+ ],
+ separate_input_output_schemas: bool = True,
+) -> Dict[str, Any]:
+ override_mode: Union[Literal["validation"], None] = (
+ None if separate_input_output_schemas else "validation"
+ )
+ # This expects that GenerateJsonSchema was already used to generate the definitions
+ json_schema = field_mapping[(field, override_mode or field.mode)]
+ if "$ref" not in json_schema:
+ # TODO remove when deprecating Pydantic v1
+ # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207
+ json_schema["title"] = field.field_info.title or field.alias.title().replace(
+ "_", " "
+ )
+ return json_schema
+
+
+def get_definitions(
+ *,
+ fields: Sequence[ModelField],
+ model_name_map: ModelNameMap,
+ separate_input_output_schemas: bool = True,
+) -> Tuple[
+ Dict[Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue],
+ Dict[str, Dict[str, Any]],
+]:
+ schema_generator = GenerateJsonSchema(ref_template=REF_TEMPLATE)
+ override_mode: Union[Literal["validation"], None] = (
+ None if separate_input_output_schemas else "validation"
+ )
+ validation_fields = [field for field in fields if field.mode == "validation"]
+ serialization_fields = [field for field in fields if field.mode == "serialization"]
+ flat_validation_models = get_flat_models_from_fields(
+ validation_fields, known_models=set()
+ )
+ flat_serialization_models = get_flat_models_from_fields(
+ serialization_fields, known_models=set()
+ )
+ flat_validation_model_fields = [
+ ModelField(
+ field_info=FieldInfo(annotation=model),
+ name=model.__name__,
+ mode="validation",
+ )
+ for model in flat_validation_models
+ ]
+ flat_serialization_model_fields = [
+ ModelField(
+ field_info=FieldInfo(annotation=model),
+ name=model.__name__,
+ mode="serialization",
+ )
+ for model in flat_serialization_models
+ ]
+ flat_model_fields = flat_validation_model_fields + flat_serialization_model_fields
+ input_types = {f.type_ for f in fields}
+ unique_flat_model_fields = {
+ f for f in flat_model_fields if f.type_ not in input_types
+ }
+
+ inputs = [
+ (field, override_mode or field.mode, field._type_adapter.core_schema)
+ for field in list(fields) + list(unique_flat_model_fields)
+ ]
+ field_mapping, definitions = schema_generator.generate_definitions(inputs=inputs)
+ for item_def in cast(Dict[str, Dict[str, Any]], definitions).values():
+ if "description" in item_def:
+ item_description = cast(str, item_def["description"]).split("\f")[0]
+ item_def["description"] = item_description
+ new_mapping, new_definitions = _remap_definitions_and_field_mappings(
+ model_name_map=model_name_map,
+ definitions=definitions, # type: ignore[arg-type]
+ field_mapping=field_mapping,
+ )
+ return new_mapping, new_definitions
+
+
+def _replace_refs(
+ *,
+ schema: Dict[str, Any],
+ old_name_to_new_name_map: Dict[str, str],
+) -> Dict[str, Any]:
+ new_schema = deepcopy(schema)
+ for key, value in new_schema.items():
+ if key == "$ref":
+ value = schema["$ref"]
+ if isinstance(value, str):
+ ref_name = schema["$ref"].split("/")[-1]
+ if ref_name in old_name_to_new_name_map:
+ new_name = old_name_to_new_name_map[ref_name]
+ new_schema["$ref"] = REF_TEMPLATE.format(model=new_name)
+ continue
+ if isinstance(value, dict):
+ new_schema[key] = _replace_refs(
+ schema=value,
+ old_name_to_new_name_map=old_name_to_new_name_map,
+ )
+ elif isinstance(value, list):
+ new_value = []
+ for item in value:
+ if isinstance(item, dict):
+ new_item = _replace_refs(
+ schema=item,
+ old_name_to_new_name_map=old_name_to_new_name_map,
+ )
+ new_value.append(new_item)
+
+ else:
+ new_value.append(item)
+ new_schema[key] = new_value
+ return new_schema
+
+
+def _remap_definitions_and_field_mappings(
+ *,
+ model_name_map: ModelNameMap,
+ definitions: Dict[str, Any],
+ field_mapping: Dict[
+ Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+ ],
+) -> Tuple[
+ Dict[Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue],
+ Dict[str, Any],
+]:
+ old_name_to_new_name_map = {}
+ for field_key, schema in field_mapping.items():
+ model = field_key[0].type_
+ if model not in model_name_map:
+ continue
+ new_name = model_name_map[model]
+ old_name = schema["$ref"].split("/")[-1]
+ if old_name in {f"{new_name}-Input", f"{new_name}-Output"}:
+ continue
+ old_name_to_new_name_map[old_name] = new_name
+
+ new_field_mapping: Dict[
+ Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+ ] = {}
+ for field_key, schema in field_mapping.items():
+ new_schema = _replace_refs(
+ schema=schema,
+ old_name_to_new_name_map=old_name_to_new_name_map,
+ )
+ new_field_mapping[field_key] = new_schema
+
+ new_definitions = {}
+ for key, value in definitions.items():
+ if key in old_name_to_new_name_map:
+ new_key = old_name_to_new_name_map[key]
+ else:
+ new_key = key
+ new_value = _replace_refs(
+ schema=value,
+ old_name_to_new_name_map=old_name_to_new_name_map,
+ )
+ new_definitions[new_key] = new_value
+ return new_field_mapping, new_definitions
+
+
+def is_scalar_field(field: ModelField) -> bool:
+ from fastapi import params
+
+ return shared.field_annotation_is_scalar(
+ field.field_info.annotation
+ ) and not isinstance(field.field_info, params.Body)
+
+
+def is_sequence_field(field: ModelField) -> bool:
+ return shared.field_annotation_is_sequence(field.field_info.annotation)
+
+
+def is_scalar_sequence_field(field: ModelField) -> bool:
+ return shared.field_annotation_is_scalar_sequence(field.field_info.annotation)
+
+
+def is_bytes_field(field: ModelField) -> bool:
+ return shared.is_bytes_or_nonable_bytes_annotation(field.type_)
+
+
+def is_bytes_sequence_field(field: ModelField) -> bool:
+ return shared.is_bytes_sequence_annotation(field.type_)
+
+
+def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:
+ cls = type(field_info)
+ merged_field_info = cls.from_annotation(annotation)
+ new_field_info = copy(field_info)
+ new_field_info.metadata = merged_field_info.metadata
+ new_field_info.annotation = merged_field_info.annotation
+ return new_field_info
+
+
+def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:
+ origin_type = get_origin(field.field_info.annotation) or field.field_info.annotation
+ assert issubclass(origin_type, shared.sequence_types) # type: ignore[arg-type]
+ return shared.sequence_annotation_to_type[origin_type](value) # type: ignore[no-any-return]
+
+
+def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:
+ error = ValidationError.from_exception_data(
+ "Field required", [{"type": "missing", "loc": loc, "input": {}}]
+ ).errors(include_url=False)[0]
+ error["input"] = None
+ return error # type: ignore[return-value]
+
+
+def create_body_model(
+ *, fields: Sequence[ModelField], model_name: str
+) -> Type[BaseModel]:
+ field_params = {f.name: (f.field_info.annotation, f.field_info) for f in fields}
+ BodyModel: Type[BaseModel] = create_model(model_name, **field_params) # type: ignore[call-overload]
+ return BodyModel
+
+
+def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:
+ return [
+ ModelField(field_info=field_info, name=name)
+ for name, field_info in model.model_fields.items()
+ ]
+
+
+# Duplicate of several schema functions from Pydantic v1 to make them compatible with
+# Pydantic v2 and allow mixing the models
+
+TypeModelOrEnum = Union[Type["BaseModel"], Type[Enum]]
+TypeModelSet = Set[TypeModelOrEnum]
+
+
+def normalize_name(name: str) -> str:
+ return re.sub(r"[^a-zA-Z0-9.\-_]", "_", name)
+
+
+def get_model_name_map(unique_models: TypeModelSet) -> Dict[TypeModelOrEnum, str]:
+ name_model_map = {}
+ conflicting_names: Set[str] = set()
+ for model in unique_models:
+ model_name = normalize_name(model.__name__)
+ if model_name in conflicting_names:
+ model_name = get_long_model_name(model)
+ name_model_map[model_name] = model
+ elif model_name in name_model_map:
+ conflicting_names.add(model_name)
+ conflicting_model = name_model_map.pop(model_name)
+ name_model_map[get_long_model_name(conflicting_model)] = conflicting_model
+ name_model_map[get_long_model_name(model)] = model
+ else:
+ name_model_map[model_name] = model
+ return {v: k for k, v in name_model_map.items()}
+
+
+def get_flat_models_from_model(
+ model: Type["BaseModel"], known_models: Union[TypeModelSet, None] = None
+) -> TypeModelSet:
+ known_models = known_models or set()
+ fields = get_model_fields(model)
+ get_flat_models_from_fields(fields, known_models=known_models)
+ return known_models
+
+
+def get_flat_models_from_annotation(
+ annotation: Any, known_models: TypeModelSet
+) -> TypeModelSet:
+ origin = get_origin(annotation)
+ if origin is not None:
+ for arg in get_args(annotation):
+ if lenient_issubclass(arg, (BaseModel, Enum)) and arg not in known_models:
+ known_models.add(arg)
+ if lenient_issubclass(arg, BaseModel):
+ get_flat_models_from_model(arg, known_models=known_models)
+ else:
+ get_flat_models_from_annotation(arg, known_models=known_models)
+ return known_models
+
+
+def get_flat_models_from_field(
+ field: ModelField, known_models: TypeModelSet
+) -> TypeModelSet:
+ field_type = field.type_
+ if lenient_issubclass(field_type, BaseModel):
+ if field_type in known_models:
+ return known_models
+ known_models.add(field_type)
+ get_flat_models_from_model(field_type, known_models=known_models)
+ elif lenient_issubclass(field_type, Enum):
+ known_models.add(field_type)
+ else:
+ get_flat_models_from_annotation(field_type, known_models=known_models)
+ return known_models
+
+
+def get_flat_models_from_fields(
+ fields: Sequence[ModelField], known_models: TypeModelSet
+) -> TypeModelSet:
+ for field in fields:
+ get_flat_models_from_field(field, known_models=known_models)
+ return known_models
+
+
+def get_long_model_name(model: TypeModelOrEnum) -> str:
+ return f"{model.__module__}__{model.__qualname__}".replace(".", "__")
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/applications.py b/Backend/venv/lib/python3.12/site-packages/fastapi/applications.py
index 3021d759..0a47699a 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/applications.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/applications.py
@@ -13,6 +13,7 @@ from typing import (
Union,
)
+from annotated_doc import Doc
from fastapi import routing
from fastapi.datastructures import Default, DefaultPlaceholder
from fastapi.exception_handlers import (
@@ -42,8 +43,8 @@ from starlette.middleware.exceptions import ExceptionMiddleware
from starlette.requests import Request
from starlette.responses import HTMLResponse, JSONResponse, Response
from starlette.routing import BaseRoute
-from starlette.types import ASGIApp, Lifespan, Receive, Scope, Send
-from typing_extensions import Annotated, Doc, deprecated # type: ignore [attr-defined]
+from starlette.types import ASGIApp, ExceptionHandler, Lifespan, Receive, Scope, Send
+from typing_extensions import Annotated, deprecated
AppType = TypeVar("AppType", bound="FastAPI")
@@ -75,7 +76,7 @@ class FastAPI(Starlette):
errors.
Read more in the
- [Starlette docs for Applications](https://www.starlette.io/applications/#instantiating-the-application).
+ [Starlette docs for Applications](https://www.starlette.dev/applications/#instantiating-the-application).
"""
),
] = False,
@@ -300,7 +301,7 @@ class FastAPI(Starlette):
browser tabs open). Or if you want to leave fixed the possible URLs.
If the servers `list` is not provided, or is an empty `list`, the
- default value would be a a `dict` with a `url` value of `/`.
+ default value would be a `dict` with a `url` value of `/`.
Each item in the `list` is a `dict` containing:
@@ -751,7 +752,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -813,6 +814,32 @@ class FastAPI(Starlette):
"""
),
] = True,
+ openapi_external_docs: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ This field allows you to provide additional external documentation links.
+ If provided, it must be a dictionary containing:
+
+ * `description`: A brief description of the external documentation.
+ * `url`: The URL pointing to the external documentation. The value **MUST**
+ be a valid URL format.
+
+ **Example**:
+
+ ```python
+ from fastapi import FastAPI
+
+ external_docs = {
+ "description": "Detailed API Reference",
+ "url": "https://example.com/api-docs",
+ }
+
+ app = FastAPI(openapi_external_docs=external_docs)
+ ```
+ """
+ ),
+ ] = None,
**extra: Annotated[
Any,
Doc(
@@ -841,6 +868,7 @@ class FastAPI(Starlette):
self.swagger_ui_parameters = swagger_ui_parameters
self.servers = servers or []
self.separate_input_output_schemas = separate_input_output_schemas
+ self.openapi_external_docs = openapi_external_docs
self.extra = extra
self.openapi_version: Annotated[
str,
@@ -905,13 +933,13 @@ class FastAPI(Starlette):
A state object for the application. This is the same object for the
entire application, it doesn't change from request to request.
- You normally woudln't use this in FastAPI, for most of the cases you
+ You normally wouldn't use this in FastAPI, for most of the cases you
would instead use FastAPI dependencies.
This is simply inherited from Starlette.
Read more about it in the
- [Starlette docs for Applications](https://www.starlette.io/applications/#storing-state-on-the-app-instance).
+ [Starlette docs for Applications](https://www.starlette.dev/applications/#storing-state-on-the-app-instance).
"""
),
] = State()
@@ -971,7 +999,7 @@ class FastAPI(Starlette):
# inside of ExceptionMiddleware, inside of custom user middlewares
debug = self.debug
error_handler = None
- exception_handlers = {}
+ exception_handlers: dict[Any, ExceptionHandler] = {}
for key, value in self.exception_handlers.items():
if key in (500, Exception):
@@ -986,33 +1014,32 @@ class FastAPI(Starlette):
Middleware(
ExceptionMiddleware, handlers=exception_handlers, debug=debug
),
- # Add FastAPI-specific AsyncExitStackMiddleware for dependencies with
- # contextvars.
+ # Add FastAPI-specific AsyncExitStackMiddleware for closing files.
+ # Before this was also used for closing dependencies with yield but
+ # those now have their own AsyncExitStack, to properly support
+ # streaming responses while keeping compatibility with the previous
+ # versions (as of writing 0.117.1) that allowed doing
+ # except HTTPException inside a dependency with yield.
# This needs to happen after user middlewares because those create a
# new contextvars context copy by using a new AnyIO task group.
- # The initial part of dependencies with 'yield' is executed in the
- # FastAPI code, inside all the middlewares. However, the teardown part
- # (after 'yield') is executed in the AsyncExitStack in this middleware.
+ # This AsyncExitStack preserves the context for contextvars, not
+ # strictly necessary for closing files but it was one of the original
+ # intentions.
# If the AsyncExitStack lived outside of the custom middlewares and
- # contextvars were set in a dependency with 'yield' in that internal
- # contextvars context, the values would not be available in the
- # outer context of the AsyncExitStack.
+ # contextvars were set, for example in a dependency with 'yield'
+ # in that internal contextvars context, the values would not be
+ # available in the outer context of the AsyncExitStack.
# By placing the middleware and the AsyncExitStack here, inside all
- # user middlewares, the code before and after 'yield' in dependencies
- # with 'yield' is executed in the same contextvars context. Thus, all values
- # set in contextvars before 'yield' are still available after 'yield,' as
- # expected.
- # Additionally, by having this AsyncExitStack here, after the
- # ExceptionMiddleware, dependencies can now catch handled exceptions,
- # e.g. HTTPException, to customize the teardown code (e.g. DB session
- # rollback).
+ # user middlewares, the same context is used.
+ # This is currently not needed, only for closing files, but used to be
+ # important when dependencies with yield were closed here.
Middleware(AsyncExitStackMiddleware),
]
)
app = self.router
- for cls, options in reversed(middleware):
- app = cls(app=app, **options)
+ for cls, args, kwargs in reversed(middleware):
+ app = cls(app, *args, **kwargs)
return app
def openapi(self) -> Dict[str, Any]:
@@ -1044,6 +1071,7 @@ class FastAPI(Starlette):
tags=self.openapi_tags,
servers=self.servers,
separate_input_output_schemas=self.separate_input_output_schemas,
+ external_docs=self.openapi_external_docs,
)
return self.openapi_schema
@@ -1071,7 +1099,7 @@ class FastAPI(Starlette):
oauth2_redirect_url = root_path + oauth2_redirect_url
return get_swagger_ui_html(
openapi_url=openapi_url,
- title=self.title + " - Swagger UI",
+ title=f"{self.title} - Swagger UI",
oauth2_redirect_url=oauth2_redirect_url,
init_oauth=self.swagger_ui_init_oauth,
swagger_ui_parameters=self.swagger_ui_parameters,
@@ -1095,7 +1123,7 @@ class FastAPI(Starlette):
root_path = req.scope.get("root_path", "").rstrip("/")
openapi_url = root_path + self.openapi_url
return get_redoc_html(
- openapi_url=openapi_url, title=self.title + " - ReDoc"
+ openapi_url=openapi_url, title=f"{self.title} - ReDoc"
)
self.add_route(self.redoc_url, redoc_html, include_in_schema=False)
@@ -1108,7 +1136,7 @@ class FastAPI(Starlette):
def add_api_route(
self,
path: str,
- endpoint: Callable[..., Coroutine[Any, Any, Response]],
+ endpoint: Callable[..., Any],
*,
response_model: Any = Default(None),
status_code: Optional[int] = None,
@@ -1772,7 +1800,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -2145,7 +2173,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -2523,7 +2551,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -2901,7 +2929,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -3274,7 +3302,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -3647,7 +3675,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -4020,7 +4048,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -4398,7 +4426,7 @@ class FastAPI(Starlette):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -4477,7 +4505,7 @@ class FastAPI(Starlette):
app = FastAPI()
- @app.put("/items/{item_id}")
+ @app.trace("/items/{item_id}")
def trace_item(item_id: str):
return None
```
@@ -4567,14 +4595,17 @@ class FastAPI(Starlette):
```python
import time
+ from typing import Awaitable, Callable
- from fastapi import FastAPI, Request
+ from fastapi import FastAPI, Request, Response
app = FastAPI()
@app.middleware("http")
- async def add_process_time_header(request: Request, call_next):
+ async def add_process_time_header(
+ request: Request, call_next: Callable[[Request], Awaitable[Response]]
+ ) -> Response:
start_time = time.time()
response = await call_next(request)
process_time = time.time() - start_time
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/background.py b/Backend/venv/lib/python3.12/site-packages/fastapi/background.py
index 35ab1b22..6d4a30d4 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/background.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/background.py
@@ -1,7 +1,8 @@
from typing import Any, Callable
+from annotated_doc import Doc
from starlette.background import BackgroundTasks as StarletteBackgroundTasks
-from typing_extensions import Annotated, Doc, ParamSpec # type: ignore [attr-defined]
+from typing_extensions import Annotated, ParamSpec
P = ParamSpec("P")
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/cli.py b/Backend/venv/lib/python3.12/site-packages/fastapi/cli.py
new file mode 100644
index 00000000..8d3301e9
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/cli.py
@@ -0,0 +1,13 @@
+try:
+ from fastapi_cli.cli import main as cli_main
+
+except ImportError: # pragma: no cover
+ cli_main = None # type: ignore
+
+
+def main() -> None:
+ if not cli_main: # type: ignore[truthy-function]
+ message = 'To use the fastapi command, please install "fastapi[standard]":\n\n\tpip install "fastapi[standard]"\n'
+ print(message)
+ raise RuntimeError(message) # noqa: B904
+ cli_main()
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/concurrency.py b/Backend/venv/lib/python3.12/site-packages/fastapi/concurrency.py
index 754061c8..3202c707 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/concurrency.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/concurrency.py
@@ -1,8 +1,7 @@
-from contextlib import AsyncExitStack as AsyncExitStack # noqa
from contextlib import asynccontextmanager as asynccontextmanager
from typing import AsyncGenerator, ContextManager, TypeVar
-import anyio
+import anyio.to_thread
from anyio import CapacityLimiter
from starlette.concurrency import iterate_in_threadpool as iterate_in_threadpool # noqa
from starlette.concurrency import run_in_threadpool as run_in_threadpool # noqa
@@ -29,7 +28,7 @@ async def contextmanager_in_threadpool(
except Exception as e:
ok = bool(
await anyio.to_thread.run_sync(
- cm.__exit__, type(e), e, None, limiter=exit_limiter
+ cm.__exit__, type(e), e, e.__traceback__, limiter=exit_limiter
)
)
if not ok:
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/datastructures.py b/Backend/venv/lib/python3.12/site-packages/fastapi/datastructures.py
index ce03e3ce..8ad9aa11 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/datastructures.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/datastructures.py
@@ -10,12 +10,11 @@ from typing import (
cast,
)
+from annotated_doc import Doc
from fastapi._compat import (
- PYDANTIC_V2,
CoreSchema,
GetJsonSchemaHandler,
JsonSchemaValue,
- with_info_plain_validator_function,
)
from starlette.datastructures import URL as URL # noqa: F401
from starlette.datastructures import Address as Address # noqa: F401
@@ -24,7 +23,7 @@ from starlette.datastructures import Headers as Headers # noqa: F401
from starlette.datastructures import QueryParams as QueryParams # noqa: F401
from starlette.datastructures import State as State # noqa: F401
from starlette.datastructures import UploadFile as StarletteUploadFile
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from typing_extensions import Annotated
class UploadFile(StarletteUploadFile):
@@ -154,11 +153,10 @@ class UploadFile(StarletteUploadFile):
raise ValueError(f"Expected UploadFile, received: {type(__input_value)}")
return cast(UploadFile, __input_value)
- if not PYDANTIC_V2:
-
- @classmethod
- def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None:
- field_schema.update({"type": "string", "format": "binary"})
+ # TODO: remove when deprecating Pydantic v1
+ @classmethod
+ def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None:
+ field_schema.update({"type": "string", "format": "binary"})
@classmethod
def __get_pydantic_json_schema__(
@@ -170,6 +168,8 @@ class UploadFile(StarletteUploadFile):
def __get_pydantic_core_schema__(
cls, source: Type[Any], handler: Callable[[Any], CoreSchema]
) -> CoreSchema:
+ from ._compat.v2 import with_info_plain_validator_function
+
return with_info_plain_validator_function(cls._validate)
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/__init__.cpython-312.pyc
index bc104ef2..7a348f65 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/models.cpython-312.pyc
index 3fcb7987..32296745 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/models.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/utils.cpython-312.pyc
index 6e113790..84ae066d 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/utils.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/models.py b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/models.py
index 61ef0063..fbb666a7 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/models.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/models.py
@@ -1,58 +1,107 @@
-from typing import Any, Callable, List, Optional, Sequence
+import inspect
+import sys
+from dataclasses import dataclass, field
+from functools import cached_property
+from typing import Any, Callable, List, Optional, Sequence, Union
from fastapi._compat import ModelField
from fastapi.security.base import SecurityBase
+from fastapi.types import DependencyCacheKey
+from typing_extensions import Literal
+
+if sys.version_info >= (3, 13): # pragma: no cover
+ from inspect import iscoroutinefunction
+else: # pragma: no cover
+ from asyncio import iscoroutinefunction
+@dataclass
class SecurityRequirement:
- def __init__(
- self, security_scheme: SecurityBase, scopes: Optional[Sequence[str]] = None
- ):
- self.security_scheme = security_scheme
- self.scopes = scopes
+ security_scheme: SecurityBase
+ scopes: Optional[Sequence[str]] = None
+@dataclass
class Dependant:
- def __init__(
- self,
- *,
- path_params: Optional[List[ModelField]] = None,
- query_params: Optional[List[ModelField]] = None,
- header_params: Optional[List[ModelField]] = None,
- cookie_params: Optional[List[ModelField]] = None,
- body_params: Optional[List[ModelField]] = None,
- dependencies: Optional[List["Dependant"]] = None,
- security_schemes: Optional[List[SecurityRequirement]] = None,
- name: Optional[str] = None,
- call: Optional[Callable[..., Any]] = None,
- request_param_name: Optional[str] = None,
- websocket_param_name: Optional[str] = None,
- http_connection_param_name: Optional[str] = None,
- response_param_name: Optional[str] = None,
- background_tasks_param_name: Optional[str] = None,
- security_scopes_param_name: Optional[str] = None,
- security_scopes: Optional[List[str]] = None,
- use_cache: bool = True,
- path: Optional[str] = None,
- ) -> None:
- self.path_params = path_params or []
- self.query_params = query_params or []
- self.header_params = header_params or []
- self.cookie_params = cookie_params or []
- self.body_params = body_params or []
- self.dependencies = dependencies or []
- self.security_requirements = security_schemes or []
- self.request_param_name = request_param_name
- self.websocket_param_name = websocket_param_name
- self.http_connection_param_name = http_connection_param_name
- self.response_param_name = response_param_name
- self.background_tasks_param_name = background_tasks_param_name
- self.security_scopes = security_scopes
- self.security_scopes_param_name = security_scopes_param_name
- self.name = name
- self.call = call
- self.use_cache = use_cache
- # Store the path to be able to re-generate a dependable from it in overrides
- self.path = path
- # Save the cache key at creation to optimize performance
- self.cache_key = (self.call, tuple(sorted(set(self.security_scopes or []))))
+ path_params: List[ModelField] = field(default_factory=list)
+ query_params: List[ModelField] = field(default_factory=list)
+ header_params: List[ModelField] = field(default_factory=list)
+ cookie_params: List[ModelField] = field(default_factory=list)
+ body_params: List[ModelField] = field(default_factory=list)
+ dependencies: List["Dependant"] = field(default_factory=list)
+ security_requirements: List[SecurityRequirement] = field(default_factory=list)
+ name: Optional[str] = None
+ call: Optional[Callable[..., Any]] = None
+ request_param_name: Optional[str] = None
+ websocket_param_name: Optional[str] = None
+ http_connection_param_name: Optional[str] = None
+ response_param_name: Optional[str] = None
+ background_tasks_param_name: Optional[str] = None
+ security_scopes_param_name: Optional[str] = None
+ own_oauth_scopes: Optional[List[str]] = None
+ parent_oauth_scopes: Optional[List[str]] = None
+ use_cache: bool = True
+ path: Optional[str] = None
+ scope: Union[Literal["function", "request"], None] = None
+
+ @cached_property
+ def oauth_scopes(self) -> List[str]:
+ scopes = self.parent_oauth_scopes.copy() if self.parent_oauth_scopes else []
+ # This doesn't use a set to preserve order, just in case
+ for scope in self.own_oauth_scopes or []:
+ if scope not in scopes:
+ scopes.append(scope)
+ return scopes
+
+ @cached_property
+ def cache_key(self) -> DependencyCacheKey:
+ scopes_for_cache = (
+ tuple(sorted(set(self.oauth_scopes or []))) if self._uses_scopes else ()
+ )
+ return (
+ self.call,
+ scopes_for_cache,
+ self.computed_scope or "",
+ )
+
+ @cached_property
+ def _uses_scopes(self) -> bool:
+ if self.own_oauth_scopes:
+ return True
+ if self.security_scopes_param_name is not None:
+ return True
+ for sub_dep in self.dependencies:
+ if sub_dep._uses_scopes:
+ return True
+ return False
+
+ @cached_property
+ def is_gen_callable(self) -> bool:
+ if inspect.isgeneratorfunction(self.call):
+ return True
+ dunder_call = getattr(self.call, "__call__", None) # noqa: B004
+ return inspect.isgeneratorfunction(dunder_call)
+
+ @cached_property
+ def is_async_gen_callable(self) -> bool:
+ if inspect.isasyncgenfunction(self.call):
+ return True
+ dunder_call = getattr(self.call, "__call__", None) # noqa: B004
+ return inspect.isasyncgenfunction(dunder_call)
+
+ @cached_property
+ def is_coroutine_callable(self) -> bool:
+ if inspect.isroutine(self.call):
+ return iscoroutinefunction(self.call)
+ if inspect.isclass(self.call):
+ return False
+ dunder_call = getattr(self.call, "__call__", None) # noqa: B004
+ return iscoroutinefunction(dunder_call)
+
+ @cached_property
+ def computed_scope(self) -> Union[str, None]:
+ if self.scope:
+ return self.scope
+ if self.is_gen_callable or self.is_async_gen_callable:
+ return "request"
+ return None
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/utils.py b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/utils.py
index 96e07a45..d43fa8a5 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/utils.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/dependencies/utils.py
@@ -1,6 +1,8 @@
+import dataclasses
import inspect
-from contextlib import contextmanager
-from copy import deepcopy
+from contextlib import AsyncExitStack, contextmanager
+from copy import copy, deepcopy
+from dataclasses import dataclass
from typing import (
Any,
Callable,
@@ -21,16 +23,17 @@ import anyio
from fastapi import params
from fastapi._compat import (
PYDANTIC_V2,
- ErrorWrapper,
ModelField,
- Required,
+ RequiredParam,
Undefined,
- _regenerate_error_with_loc,
+ _is_error_wrapper,
+ _is_model_class,
copy_field_info,
create_body_model,
evaluate_forwardref,
field_annotation_is_scalar,
get_annotation_from_field_info,
+ get_cached_model_fields,
get_missing_field_error,
is_bytes_field,
is_bytes_sequence_field,
@@ -40,30 +43,41 @@ from fastapi._compat import (
is_uploadfile_or_nonable_uploadfile_annotation,
is_uploadfile_sequence_annotation,
lenient_issubclass,
+ may_v1,
sequence_types,
serialize_sequence_value,
value_is_sequence,
)
+from fastapi._compat.shared import annotation_is_pydantic_v1
from fastapi.background import BackgroundTasks
from fastapi.concurrency import (
- AsyncExitStack,
asynccontextmanager,
contextmanager_in_threadpool,
)
from fastapi.dependencies.models import Dependant, SecurityRequirement
+from fastapi.exceptions import DependencyScopeError
from fastapi.logger import logger
from fastapi.security.base import SecurityBase
-from fastapi.security.oauth2 import OAuth2, SecurityScopes
-from fastapi.security.open_id_connect_url import OpenIdConnect
-from fastapi.utils import create_response_field, get_path_param_names
+from fastapi.security.oauth2 import SecurityScopes
+from fastapi.types import DependencyCacheKey
+from fastapi.utils import create_model_field, get_path_param_names
+from pydantic import BaseModel
from pydantic.fields import FieldInfo
from starlette.background import BackgroundTasks as StarletteBackgroundTasks
from starlette.concurrency import run_in_threadpool
-from starlette.datastructures import FormData, Headers, QueryParams, UploadFile
+from starlette.datastructures import (
+ FormData,
+ Headers,
+ ImmutableMultiDict,
+ QueryParams,
+ UploadFile,
+)
from starlette.requests import HTTPConnection, Request
from starlette.responses import Response
from starlette.websockets import WebSocket
-from typing_extensions import Annotated, get_args, get_origin
+from typing_extensions import Annotated, Literal, get_args, get_origin
+
+from .. import temp_pydantic_v1_params
multipart_not_installed_error = (
'Form data requires "python-multipart" to be installed. \n'
@@ -80,17 +94,23 @@ multipart_incorrect_install_error = (
)
-def check_file_field(field: ModelField) -> None:
- field_info = field.field_info
- if isinstance(field_info, params.Form):
+def ensure_multipart_is_installed() -> None:
+ try:
+ from python_multipart import __version__
+
+ # Import an attribute that can be mocked/deleted in testing
+ assert __version__ > "0.0.12"
+ except (ImportError, AssertionError):
try:
# __version__ is available in both multiparts, and can be mocked
- from multipart import __version__ # type: ignore
+ from multipart import __version__ # type: ignore[no-redef,import-untyped]
assert __version__
try:
# parse_options_header is only available in the right multipart
- from multipart.multipart import parse_options_header # type: ignore
+ from multipart.multipart import ( # type: ignore[import-untyped]
+ parse_options_header,
+ )
assert parse_options_header
except ImportError:
@@ -101,70 +121,26 @@ def check_file_field(field: ModelField) -> None:
raise RuntimeError(multipart_not_installed_error) from None
-def get_param_sub_dependant(
- *,
- param_name: str,
- depends: params.Depends,
- path: str,
- security_scopes: Optional[List[str]] = None,
-) -> Dependant:
- assert depends.dependency
- return get_sub_dependant(
- depends=depends,
- dependency=depends.dependency,
- path=path,
- name=param_name,
- security_scopes=security_scopes,
- )
-
-
def get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:
- assert callable(
- depends.dependency
- ), "A parameter-less dependency must have a callable dependency"
- return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)
-
-
-def get_sub_dependant(
- *,
- depends: params.Depends,
- dependency: Callable[..., Any],
- path: str,
- name: Optional[str] = None,
- security_scopes: Optional[List[str]] = None,
-) -> Dependant:
- security_requirement = None
- security_scopes = security_scopes or []
- if isinstance(depends, params.Security):
- dependency_scopes = depends.scopes
- security_scopes.extend(dependency_scopes)
- if isinstance(dependency, SecurityBase):
- use_scopes: List[str] = []
- if isinstance(dependency, (OAuth2, OpenIdConnect)):
- use_scopes = security_scopes
- security_requirement = SecurityRequirement(
- security_scheme=dependency, scopes=use_scopes
- )
- sub_dependant = get_dependant(
- path=path,
- call=dependency,
- name=name,
- security_scopes=security_scopes,
- use_cache=depends.use_cache,
+ assert callable(depends.dependency), (
+ "A parameter-less dependency must have a callable dependency"
+ )
+ own_oauth_scopes: List[str] = []
+ if isinstance(depends, params.Security) and depends.scopes:
+ own_oauth_scopes.extend(depends.scopes)
+ return get_dependant(
+ path=path,
+ call=depends.dependency,
+ scope=depends.scope,
+ own_oauth_scopes=own_oauth_scopes,
)
- if security_requirement:
- sub_dependant.security_requirements.append(security_requirement)
- return sub_dependant
-
-
-CacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]
def get_flat_dependant(
dependant: Dependant,
*,
skip_repeats: bool = False,
- visited: Optional[List[CacheKey]] = None,
+ visited: Optional[List[DependencyCacheKey]] = None,
) -> Dependant:
if visited is None:
visited = []
@@ -176,7 +152,7 @@ def get_flat_dependant(
header_params=dependant.header_params.copy(),
cookie_params=dependant.cookie_params.copy(),
body_params=dependant.body_params.copy(),
- security_schemes=dependant.security_requirements.copy(),
+ security_requirements=dependant.security_requirements.copy(),
use_cache=dependant.use_cache,
path=dependant.path,
)
@@ -195,14 +171,23 @@ def get_flat_dependant(
return flat_dependant
+def _get_flat_fields_from_params(fields: List[ModelField]) -> List[ModelField]:
+ if not fields:
+ return fields
+ first_field = fields[0]
+ if len(fields) == 1 and _is_model_class(first_field.type_):
+ fields_to_extract = get_cached_model_fields(first_field.type_)
+ return fields_to_extract
+ return fields
+
+
def get_flat_params(dependant: Dependant) -> List[ModelField]:
flat_dependant = get_flat_dependant(dependant, skip_repeats=True)
- return (
- flat_dependant.path_params
- + flat_dependant.query_params
- + flat_dependant.header_params
- + flat_dependant.cookie_params
- )
+ path_params = _get_flat_fields_from_params(flat_dependant.path_params)
+ query_params = _get_flat_fields_from_params(flat_dependant.query_params)
+ header_params = _get_flat_fields_from_params(flat_dependant.header_params)
+ cookie_params = _get_flat_fields_from_params(flat_dependant.cookie_params)
+ return path_params + query_params + header_params + cookie_params
def get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:
@@ -225,6 +210,8 @@ def get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:
if isinstance(annotation, str):
annotation = ForwardRef(annotation)
annotation = evaluate_forwardref(annotation, globalns, globalns)
+ if annotation is type(None):
+ return None
return annotation
@@ -244,50 +231,80 @@ def get_dependant(
path: str,
call: Callable[..., Any],
name: Optional[str] = None,
- security_scopes: Optional[List[str]] = None,
+ own_oauth_scopes: Optional[List[str]] = None,
+ parent_oauth_scopes: Optional[List[str]] = None,
use_cache: bool = True,
+ scope: Union[Literal["function", "request"], None] = None,
) -> Dependant:
- path_param_names = get_path_param_names(path)
- endpoint_signature = get_typed_signature(call)
- signature_params = endpoint_signature.parameters
dependant = Dependant(
call=call,
name=name,
path=path,
- security_scopes=security_scopes,
use_cache=use_cache,
+ scope=scope,
+ own_oauth_scopes=own_oauth_scopes,
+ parent_oauth_scopes=parent_oauth_scopes,
)
+ current_scopes = (parent_oauth_scopes or []) + (own_oauth_scopes or [])
+ path_param_names = get_path_param_names(path)
+ endpoint_signature = get_typed_signature(call)
+ signature_params = endpoint_signature.parameters
+ if isinstance(call, SecurityBase):
+ security_requirement = SecurityRequirement(
+ security_scheme=call, scopes=current_scopes
+ )
+ dependant.security_requirements.append(security_requirement)
for param_name, param in signature_params.items():
is_path_param = param_name in path_param_names
- type_annotation, depends, param_field = analyze_param(
+ param_details = analyze_param(
param_name=param_name,
annotation=param.annotation,
value=param.default,
is_path_param=is_path_param,
)
- if depends is not None:
- sub_dependant = get_param_sub_dependant(
- param_name=param_name,
- depends=depends,
+ if param_details.depends is not None:
+ assert param_details.depends.dependency
+ if (
+ (dependant.is_gen_callable or dependant.is_async_gen_callable)
+ and dependant.computed_scope == "request"
+ and param_details.depends.scope == "function"
+ ):
+ assert dependant.call
+ raise DependencyScopeError(
+ f'The dependency "{dependant.call.__name__}" has a scope of '
+ '"request", it cannot depend on dependencies with scope "function".'
+ )
+ sub_own_oauth_scopes: List[str] = []
+ if isinstance(param_details.depends, params.Security):
+ if param_details.depends.scopes:
+ sub_own_oauth_scopes = list(param_details.depends.scopes)
+ sub_dependant = get_dependant(
path=path,
- security_scopes=security_scopes,
+ call=param_details.depends.dependency,
+ name=param_name,
+ own_oauth_scopes=sub_own_oauth_scopes,
+ parent_oauth_scopes=current_scopes,
+ use_cache=param_details.depends.use_cache,
+ scope=param_details.depends.scope,
)
dependant.dependencies.append(sub_dependant)
continue
if add_non_field_param_to_dependency(
param_name=param_name,
- type_annotation=type_annotation,
+ type_annotation=param_details.type_annotation,
dependant=dependant,
):
- assert (
- param_field is None
- ), f"Cannot specify multiple FastAPI annotations for {param_name!r}"
+ assert param_details.field is None, (
+ f"Cannot specify multiple FastAPI annotations for {param_name!r}"
+ )
continue
- assert param_field is not None
- if is_body_param(param_field=param_field, is_path_param=is_path_param):
- dependant.body_params.append(param_field)
+ assert param_details.field is not None
+ if isinstance(
+ param_details.field.field_info, (params.Body, temp_pydantic_v1_params.Body)
+ ):
+ dependant.body_params.append(param_details.field)
else:
- add_param_to_fields(field=param_field, dependant=dependant)
+ add_param_to_fields(field=param_details.field, dependant=dependant)
return dependant
@@ -315,37 +332,66 @@ def add_non_field_param_to_dependency(
return None
+@dataclass
+class ParamDetails:
+ type_annotation: Any
+ depends: Optional[params.Depends]
+ field: Optional[ModelField]
+
+
def analyze_param(
*,
param_name: str,
annotation: Any,
value: Any,
is_path_param: bool,
-) -> Tuple[Any, Optional[params.Depends], Optional[ModelField]]:
+) -> ParamDetails:
field_info = None
depends = None
type_annotation: Any = Any
- if (
- annotation is not inspect.Signature.empty
- and get_origin(annotation) is Annotated
- ):
+ use_annotation: Any = Any
+ if annotation is not inspect.Signature.empty:
+ use_annotation = annotation
+ type_annotation = annotation
+ # Extract Annotated info
+ if get_origin(use_annotation) is Annotated:
annotated_args = get_args(annotation)
type_annotation = annotated_args[0]
fastapi_annotations = [
arg
for arg in annotated_args[1:]
- if isinstance(arg, (FieldInfo, params.Depends))
+ if isinstance(arg, (FieldInfo, may_v1.FieldInfo, params.Depends))
]
- assert (
- len(fastapi_annotations) <= 1
- ), f"Cannot specify multiple `Annotated` FastAPI arguments for {param_name!r}"
- fastapi_annotation = next(iter(fastapi_annotations), None)
- if isinstance(fastapi_annotation, FieldInfo):
+ fastapi_specific_annotations = [
+ arg
+ for arg in fastapi_annotations
+ if isinstance(
+ arg,
+ (
+ params.Param,
+ temp_pydantic_v1_params.Param,
+ params.Body,
+ temp_pydantic_v1_params.Body,
+ params.Depends,
+ ),
+ )
+ ]
+ if fastapi_specific_annotations:
+ fastapi_annotation: Union[
+ FieldInfo, may_v1.FieldInfo, params.Depends, None
+ ] = fastapi_specific_annotations[-1]
+ else:
+ fastapi_annotation = None
+ # Set default for Annotated FieldInfo
+ if isinstance(fastapi_annotation, (FieldInfo, may_v1.FieldInfo)):
# Copy `field_info` because we mutate `field_info.default` below.
field_info = copy_field_info(
- field_info=fastapi_annotation, annotation=annotation
+ field_info=fastapi_annotation, annotation=use_annotation
)
- assert field_info.default is Undefined or field_info.default is Required, (
+ assert field_info.default in {
+ Undefined,
+ may_v1.Undefined,
+ } or field_info.default in {RequiredParam, may_v1.RequiredParam}, (
f"`{field_info.__class__.__name__}` default value cannot be set in"
f" `Annotated` for {param_name!r}. Set the default value with `=` instead."
)
@@ -353,12 +399,11 @@ def analyze_param(
assert not is_path_param, "Path parameters cannot have default values"
field_info.default = value
else:
- field_info.default = Required
+ field_info.default = RequiredParam
+ # Get Annotated Depends
elif isinstance(fastapi_annotation, params.Depends):
depends = fastapi_annotation
- elif annotation is not inspect.Signature.empty:
- type_annotation = annotation
-
+ # Get Depends from default value
if isinstance(value, params.Depends):
assert depends is None, (
"Cannot specify `Depends` in `Annotated` and default value"
@@ -369,18 +414,24 @@ def analyze_param(
f" default value together for {param_name!r}"
)
depends = value
- elif isinstance(value, FieldInfo):
+ # Get FieldInfo from default value
+ elif isinstance(value, (FieldInfo, may_v1.FieldInfo)):
assert field_info is None, (
"Cannot specify FastAPI annotations in `Annotated` and default value"
f" together for {param_name!r}"
)
field_info = value
if PYDANTIC_V2:
- field_info.annotation = type_annotation
+ if isinstance(field_info, FieldInfo):
+ field_info.annotation = type_annotation
+ # Get Depends from type annotation
if depends is not None and depends.dependency is None:
- depends.dependency = type_annotation
+ # Copy `depends` before mutating it
+ depends = copy(depends)
+ depends = dataclasses.replace(depends, dependency=type_annotation)
+ # Handle non-param type annotations like Request
if lenient_issubclass(
type_annotation,
(
@@ -393,126 +444,124 @@ def analyze_param(
),
):
assert depends is None, f"Cannot specify `Depends` for type {type_annotation!r}"
- assert (
- field_info is None
- ), f"Cannot specify FastAPI annotation for type {type_annotation!r}"
+ assert field_info is None, (
+ f"Cannot specify FastAPI annotation for type {type_annotation!r}"
+ )
+ # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value
elif field_info is None and depends is None:
- default_value = value if value is not inspect.Signature.empty else Required
+ default_value = value if value is not inspect.Signature.empty else RequiredParam
if is_path_param:
- # We might check here that `default_value is Required`, but the fact is that the same
+ # We might check here that `default_value is RequiredParam`, but the fact is that the same
# parameter might sometimes be a path parameter and sometimes not. See
# `tests/test_infer_param_optionality.py` for an example.
- field_info = params.Path(annotation=type_annotation)
+ field_info = params.Path(annotation=use_annotation)
elif is_uploadfile_or_nonable_uploadfile_annotation(
type_annotation
) or is_uploadfile_sequence_annotation(type_annotation):
- field_info = params.File(annotation=type_annotation, default=default_value)
+ field_info = params.File(annotation=use_annotation, default=default_value)
elif not field_annotation_is_scalar(annotation=type_annotation):
- field_info = params.Body(annotation=type_annotation, default=default_value)
+ if annotation_is_pydantic_v1(use_annotation):
+ field_info = temp_pydantic_v1_params.Body(
+ annotation=use_annotation, default=default_value
+ )
+ else:
+ field_info = params.Body(
+ annotation=use_annotation, default=default_value
+ )
else:
- field_info = params.Query(annotation=type_annotation, default=default_value)
+ field_info = params.Query(annotation=use_annotation, default=default_value)
field = None
+ # It's a field_info, not a dependency
if field_info is not None:
+ # Handle field_info.in_
if is_path_param:
- assert isinstance(field_info, params.Path), (
+ assert isinstance(
+ field_info, (params.Path, temp_pydantic_v1_params.Path)
+ ), (
f"Cannot use `{field_info.__class__.__name__}` for path param"
f" {param_name!r}"
)
elif (
- isinstance(field_info, params.Param)
+ isinstance(field_info, (params.Param, temp_pydantic_v1_params.Param))
and getattr(field_info, "in_", None) is None
):
field_info.in_ = params.ParamTypes.query
- use_annotation = get_annotation_from_field_info(
- type_annotation,
+ use_annotation_from_field_info = get_annotation_from_field_info(
+ use_annotation,
field_info,
param_name,
)
+ if isinstance(field_info, (params.Form, temp_pydantic_v1_params.Form)):
+ ensure_multipart_is_installed()
if not field_info.alias and getattr(field_info, "convert_underscores", None):
alias = param_name.replace("_", "-")
else:
alias = field_info.alias or param_name
field_info.alias = alias
- field = create_response_field(
+ field = create_model_field(
name=param_name,
- type_=use_annotation,
+ type_=use_annotation_from_field_info,
default=field_info.default,
alias=alias,
- required=field_info.default in (Required, Undefined),
+ required=field_info.default
+ in (RequiredParam, may_v1.RequiredParam, Undefined),
field_info=field_info,
)
+ if is_path_param:
+ assert is_scalar_field(field=field), (
+ "Path params must be of one of the supported types"
+ )
+ elif isinstance(field_info, (params.Query, temp_pydantic_v1_params.Query)):
+ assert (
+ is_scalar_field(field)
+ or is_scalar_sequence_field(field)
+ or (
+ _is_model_class(field.type_)
+ # For Pydantic v1
+ and getattr(field, "shape", 1) == 1
+ )
+ )
- return type_annotation, depends, field
-
-
-def is_body_param(*, param_field: ModelField, is_path_param: bool) -> bool:
- if is_path_param:
- assert is_scalar_field(
- field=param_field
- ), "Path params must be of one of the supported types"
- return False
- elif is_scalar_field(field=param_field):
- return False
- elif isinstance(
- param_field.field_info, (params.Query, params.Header)
- ) and is_scalar_sequence_field(param_field):
- return False
- else:
- assert isinstance(
- param_field.field_info, params.Body
- ), f"Param: {param_field.name} can only be a request body, using Body()"
- return True
+ return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)
def add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:
- field_info = cast(params.Param, field.field_info)
- if field_info.in_ == params.ParamTypes.path:
+ field_info = field.field_info
+ field_info_in = getattr(field_info, "in_", None)
+ if field_info_in == params.ParamTypes.path:
dependant.path_params.append(field)
- elif field_info.in_ == params.ParamTypes.query:
+ elif field_info_in == params.ParamTypes.query:
dependant.query_params.append(field)
- elif field_info.in_ == params.ParamTypes.header:
+ elif field_info_in == params.ParamTypes.header:
dependant.header_params.append(field)
else:
- assert (
- field_info.in_ == params.ParamTypes.cookie
- ), f"non-body parameters must be in path, query, header or cookie: {field.name}"
+ assert field_info_in == params.ParamTypes.cookie, (
+ f"non-body parameters must be in path, query, header or cookie: {field.name}"
+ )
dependant.cookie_params.append(field)
-def is_coroutine_callable(call: Callable[..., Any]) -> bool:
- if inspect.isroutine(call):
- return inspect.iscoroutinefunction(call)
- if inspect.isclass(call):
- return False
- dunder_call = getattr(call, "__call__", None) # noqa: B004
- return inspect.iscoroutinefunction(dunder_call)
-
-
-def is_async_gen_callable(call: Callable[..., Any]) -> bool:
- if inspect.isasyncgenfunction(call):
- return True
- dunder_call = getattr(call, "__call__", None) # noqa: B004
- return inspect.isasyncgenfunction(dunder_call)
-
-
-def is_gen_callable(call: Callable[..., Any]) -> bool:
- if inspect.isgeneratorfunction(call):
- return True
- dunder_call = getattr(call, "__call__", None) # noqa: B004
- return inspect.isgeneratorfunction(dunder_call)
-
-
-async def solve_generator(
- *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]
+async def _solve_generator(
+ *, dependant: Dependant, stack: AsyncExitStack, sub_values: Dict[str, Any]
) -> Any:
- if is_gen_callable(call):
- cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))
- elif is_async_gen_callable(call):
- cm = asynccontextmanager(call)(**sub_values)
+ assert dependant.call
+ if dependant.is_gen_callable:
+ cm = contextmanager_in_threadpool(contextmanager(dependant.call)(**sub_values))
+ elif dependant.is_async_gen_callable:
+ cm = asynccontextmanager(dependant.call)(**sub_values)
return await stack.enter_async_context(cm)
+@dataclass
+class SolvedDependency:
+ values: Dict[str, Any]
+ errors: List[Any]
+ background_tasks: Optional[StarletteBackgroundTasks]
+ response: Response
+ dependency_cache: Dict[DependencyCacheKey, Any]
+
+
async def solve_dependencies(
*,
request: Union[Request, WebSocket],
@@ -521,27 +570,30 @@ async def solve_dependencies(
background_tasks: Optional[StarletteBackgroundTasks] = None,
response: Optional[Response] = None,
dependency_overrides_provider: Optional[Any] = None,
- dependency_cache: Optional[Dict[Tuple[Callable[..., Any], Tuple[str]], Any]] = None,
-) -> Tuple[
- Dict[str, Any],
- List[Any],
- Optional[StarletteBackgroundTasks],
- Response,
- Dict[Tuple[Callable[..., Any], Tuple[str]], Any],
-]:
+ dependency_cache: Optional[Dict[DependencyCacheKey, Any]] = None,
+ # TODO: remove this parameter later, no longer used, not removing it yet as some
+ # people might be monkey patching this function (although that's not supported)
+ async_exit_stack: AsyncExitStack,
+ embed_body_fields: bool,
+) -> SolvedDependency:
+ request_astack = request.scope.get("fastapi_inner_astack")
+ assert isinstance(request_astack, AsyncExitStack), (
+ "fastapi_inner_astack not found in request scope"
+ )
+ function_astack = request.scope.get("fastapi_function_astack")
+ assert isinstance(function_astack, AsyncExitStack), (
+ "fastapi_function_astack not found in request scope"
+ )
values: Dict[str, Any] = {}
errors: List[Any] = []
if response is None:
response = Response()
del response.headers["content-length"]
response.status_code = None # type: ignore
- dependency_cache = dependency_cache or {}
- sub_dependant: Dependant
+ if dependency_cache is None:
+ dependency_cache = {}
for sub_dependant in dependant.dependencies:
sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)
- sub_dependant.cache_key = cast(
- Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key
- )
call = sub_dependant.call
use_sub_dependant = sub_dependant
if (
@@ -557,7 +609,8 @@ async def solve_dependencies(
path=use_path,
call=call,
name=sub_dependant.name,
- security_scopes=sub_dependant.security_scopes,
+ parent_oauth_scopes=sub_dependant.oauth_scopes,
+ scope=sub_dependant.scope,
)
solved_result = await solve_dependencies(
@@ -568,30 +621,30 @@ async def solve_dependencies(
response=response,
dependency_overrides_provider=dependency_overrides_provider,
dependency_cache=dependency_cache,
+ async_exit_stack=async_exit_stack,
+ embed_body_fields=embed_body_fields,
)
- (
- sub_values,
- sub_errors,
- background_tasks,
- _, # the subdependency returns the same response we have
- sub_dependency_cache,
- ) = solved_result
- dependency_cache.update(sub_dependency_cache)
- if sub_errors:
- errors.extend(sub_errors)
+ background_tasks = solved_result.background_tasks
+ if solved_result.errors:
+ errors.extend(solved_result.errors)
continue
if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:
solved = dependency_cache[sub_dependant.cache_key]
- elif is_gen_callable(call) or is_async_gen_callable(call):
- stack = request.scope.get("fastapi_astack")
- assert isinstance(stack, AsyncExitStack)
- solved = await solve_generator(
- call=call, stack=stack, sub_values=sub_values
+ elif (
+ use_sub_dependant.is_gen_callable or use_sub_dependant.is_async_gen_callable
+ ):
+ use_astack = request_astack
+ if sub_dependant.scope == "function":
+ use_astack = function_astack
+ solved = await _solve_generator(
+ dependant=use_sub_dependant,
+ stack=use_astack,
+ sub_values=solved_result.values,
)
- elif is_coroutine_callable(call):
- solved = await call(**sub_values)
+ elif use_sub_dependant.is_coroutine_callable:
+ solved = await call(**solved_result.values)
else:
- solved = await run_in_threadpool(call, **sub_values)
+ solved = await run_in_threadpool(call, **solved_result.values)
if sub_dependant.name is not None:
values[sub_dependant.name] = solved
if sub_dependant.cache_key not in dependency_cache:
@@ -618,7 +671,9 @@ async def solve_dependencies(
body_values,
body_errors,
) = await request_body_to_args( # body_params checked above
- required_params=dependant.body_params, received_body=body
+ body_fields=dependant.body_params,
+ received_body=body,
+ embed_body_fields=embed_body_fields,
)
values.update(body_values)
errors.extend(body_errors)
@@ -636,144 +691,291 @@ async def solve_dependencies(
values[dependant.response_param_name] = response
if dependant.security_scopes_param_name:
values[dependant.security_scopes_param_name] = SecurityScopes(
- scopes=dependant.security_scopes
+ scopes=dependant.oauth_scopes
)
- return values, errors, background_tasks, response, dependency_cache
+ return SolvedDependency(
+ values=values,
+ errors=errors,
+ background_tasks=background_tasks,
+ response=response,
+ dependency_cache=dependency_cache,
+ )
+
+
+def _validate_value_with_model_field(
+ *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]
+) -> Tuple[Any, List[Any]]:
+ if value is None:
+ if field.required:
+ return None, [get_missing_field_error(loc=loc)]
+ else:
+ return deepcopy(field.default), []
+ v_, errors_ = field.validate(value, values, loc=loc)
+ if _is_error_wrapper(errors_): # type: ignore[arg-type]
+ return None, [errors_]
+ elif isinstance(errors_, list):
+ new_errors = may_v1._regenerate_error_with_loc(errors=errors_, loc_prefix=())
+ return None, new_errors
+ else:
+ return v_, []
+
+
+def _get_multidict_value(
+ field: ModelField, values: Mapping[str, Any], alias: Union[str, None] = None
+) -> Any:
+ alias = alias or field.alias
+ if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):
+ value = values.getlist(alias)
+ else:
+ value = values.get(alias, None)
+ if (
+ value is None
+ or (
+ isinstance(field.field_info, (params.Form, temp_pydantic_v1_params.Form))
+ and isinstance(value, str) # For type checks
+ and value == ""
+ )
+ or (is_sequence_field(field) and len(value) == 0)
+ ):
+ if field.required:
+ return
+ else:
+ return deepcopy(field.default)
+ return value
def request_params_to_args(
- required_params: Sequence[ModelField],
+ fields: Sequence[ModelField],
received_params: Union[Mapping[str, Any], QueryParams, Headers],
) -> Tuple[Dict[str, Any], List[Any]]:
- values = {}
- errors = []
- for field in required_params:
- if is_scalar_sequence_field(field) and isinstance(
- received_params, (QueryParams, Headers)
- ):
- value = received_params.getlist(field.alias) or field.default
- else:
- value = received_params.get(field.alias)
+ values: Dict[str, Any] = {}
+ errors: List[Dict[str, Any]] = []
+
+ if not fields:
+ return values, errors
+
+ first_field = fields[0]
+ fields_to_extract = fields
+ single_not_embedded_field = False
+ default_convert_underscores = True
+ if len(fields) == 1 and lenient_issubclass(first_field.type_, BaseModel):
+ fields_to_extract = get_cached_model_fields(first_field.type_)
+ single_not_embedded_field = True
+ # If headers are in a Pydantic model, the way to disable convert_underscores
+ # would be with Header(convert_underscores=False) at the Pydantic model level
+ default_convert_underscores = getattr(
+ first_field.field_info, "convert_underscores", True
+ )
+
+ params_to_process: Dict[str, Any] = {}
+
+ processed_keys = set()
+
+ for field in fields_to_extract:
+ alias = None
+ if isinstance(received_params, Headers):
+ # Handle fields extracted from a Pydantic Model for a header, each field
+ # doesn't have a FieldInfo of type Header with the default convert_underscores=True
+ convert_underscores = getattr(
+ field.field_info, "convert_underscores", default_convert_underscores
+ )
+ if convert_underscores:
+ alias = (
+ field.alias
+ if field.alias != field.name
+ else field.name.replace("_", "-")
+ )
+ value = _get_multidict_value(field, received_params, alias=alias)
+ if value is not None:
+ params_to_process[field.name] = value
+ processed_keys.add(alias or field.alias)
+ processed_keys.add(field.name)
+
+ for key, value in received_params.items():
+ if key not in processed_keys:
+ params_to_process[key] = value
+
+ if single_not_embedded_field:
+ field_info = first_field.field_info
+ assert isinstance(field_info, (params.Param, temp_pydantic_v1_params.Param)), (
+ "Params must be subclasses of Param"
+ )
+ loc: Tuple[str, ...] = (field_info.in_.value,)
+ v_, errors_ = _validate_value_with_model_field(
+ field=first_field, value=params_to_process, values=values, loc=loc
+ )
+ return {first_field.name: v_}, errors_
+
+ for field in fields:
+ value = _get_multidict_value(field, received_params)
field_info = field.field_info
- assert isinstance(
- field_info, params.Param
- ), "Params must be subclasses of Param"
+ assert isinstance(field_info, (params.Param, temp_pydantic_v1_params.Param)), (
+ "Params must be subclasses of Param"
+ )
loc = (field_info.in_.value, field.alias)
- if value is None:
- if field.required:
- errors.append(get_missing_field_error(loc=loc))
- else:
- values[field.name] = deepcopy(field.default)
- continue
- v_, errors_ = field.validate(value, values, loc=loc)
- if isinstance(errors_, ErrorWrapper):
- errors.append(errors_)
- elif isinstance(errors_, list):
- new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())
- errors.extend(new_errors)
+ v_, errors_ = _validate_value_with_model_field(
+ field=field, value=value, values=values, loc=loc
+ )
+ if errors_:
+ errors.extend(errors_)
else:
values[field.name] = v_
return values, errors
-async def request_body_to_args(
- required_params: List[ModelField],
- received_body: Optional[Union[Dict[str, Any], FormData]],
-) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:
+def is_union_of_base_models(field_type: Any) -> bool:
+ """Check if field type is a Union where all members are BaseModel subclasses."""
+ from fastapi.types import UnionType
+
+ origin = get_origin(field_type)
+
+ # Check if it's a Union type (covers both typing.Union and types.UnionType in Python 3.10+)
+ if origin is not Union and origin is not UnionType:
+ return False
+
+ union_args = get_args(field_type)
+
+ for arg in union_args:
+ if not _is_model_class(arg):
+ return False
+
+ return True
+
+
+def _should_embed_body_fields(fields: List[ModelField]) -> bool:
+ if not fields:
+ return False
+ # More than one dependency could have the same field, it would show up as multiple
+ # fields but it's the same one, so count them by name
+ body_param_names_set = {field.name for field in fields}
+ # A top level field has to be a single field, not multiple
+ if len(body_param_names_set) > 1:
+ return True
+ first_field = fields[0]
+ # If it explicitly specifies it is embedded, it has to be embedded
+ if getattr(first_field.field_info, "embed", None):
+ return True
+ # If it's a Form (or File) field, it has to be a BaseModel (or a union of BaseModels) to be top level
+ # otherwise it has to be embedded, so that the key value pair can be extracted
+ if (
+ isinstance(first_field.field_info, (params.Form, temp_pydantic_v1_params.Form))
+ and not _is_model_class(first_field.type_)
+ and not is_union_of_base_models(first_field.type_)
+ ):
+ return True
+ return False
+
+
+async def _extract_form_body(
+ body_fields: List[ModelField],
+ received_body: FormData,
+) -> Dict[str, Any]:
values = {}
- errors: List[Dict[str, Any]] = []
- if required_params:
- field = required_params[0]
+
+ for field in body_fields:
+ value = _get_multidict_value(field, received_body)
field_info = field.field_info
- embed = getattr(field_info, "embed", None)
- field_alias_omitted = len(required_params) == 1 and not embed
- if field_alias_omitted:
- received_body = {field.alias: received_body}
+ if (
+ isinstance(field_info, (params.File, temp_pydantic_v1_params.File))
+ and is_bytes_field(field)
+ and isinstance(value, UploadFile)
+ ):
+ value = await value.read()
+ elif (
+ is_bytes_sequence_field(field)
+ and isinstance(field_info, (params.File, temp_pydantic_v1_params.File))
+ and value_is_sequence(value)
+ ):
+ # For types
+ assert isinstance(value, sequence_types) # type: ignore[arg-type]
+ results: List[Union[bytes, str]] = []
- for field in required_params:
- loc: Tuple[str, ...]
- if field_alias_omitted:
- loc = ("body",)
- else:
- loc = ("body", field.alias)
+ async def process_fn(
+ fn: Callable[[], Coroutine[Any, Any, Any]],
+ ) -> None:
+ result = await fn()
+ results.append(result) # noqa: B023
- value: Optional[Any] = None
- if received_body is not None:
- if (is_sequence_field(field)) and isinstance(received_body, FormData):
- value = received_body.getlist(field.alias)
- else:
- try:
- value = received_body.get(field.alias)
- except AttributeError:
- errors.append(get_missing_field_error(loc))
- continue
- if (
- value is None
- or (isinstance(field_info, params.Form) and value == "")
- or (
- isinstance(field_info, params.Form)
- and is_sequence_field(field)
- and len(value) == 0
- )
- ):
- if field.required:
- errors.append(get_missing_field_error(loc))
- else:
- values[field.name] = deepcopy(field.default)
+ async with anyio.create_task_group() as tg:
+ for sub_value in value:
+ tg.start_soon(process_fn, sub_value.read)
+ value = serialize_sequence_value(field=field, value=results)
+ if value is not None:
+ values[field.alias] = value
+ for key, value in received_body.items():
+ if key not in values:
+ values[key] = value
+ return values
+
+
+async def request_body_to_args(
+ body_fields: List[ModelField],
+ received_body: Optional[Union[Dict[str, Any], FormData]],
+ embed_body_fields: bool,
+) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:
+ values: Dict[str, Any] = {}
+ errors: List[Dict[str, Any]] = []
+ assert body_fields, "request_body_to_args() should be called with fields"
+ single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields
+ first_field = body_fields[0]
+ body_to_process = received_body
+
+ fields_to_extract: List[ModelField] = body_fields
+
+ if (
+ single_not_embedded_field
+ and _is_model_class(first_field.type_)
+ and isinstance(received_body, FormData)
+ ):
+ fields_to_extract = get_cached_model_fields(first_field.type_)
+
+ if isinstance(received_body, FormData):
+ body_to_process = await _extract_form_body(fields_to_extract, received_body)
+
+ if single_not_embedded_field:
+ loc: Tuple[str, ...] = ("body",)
+ v_, errors_ = _validate_value_with_model_field(
+ field=first_field, value=body_to_process, values=values, loc=loc
+ )
+ return {first_field.name: v_}, errors_
+ for field in body_fields:
+ loc = ("body", field.alias)
+ value: Optional[Any] = None
+ if body_to_process is not None:
+ try:
+ value = body_to_process.get(field.alias)
+ # If the received body is a list, not a dict
+ except AttributeError:
+ errors.append(get_missing_field_error(loc))
continue
- if (
- isinstance(field_info, params.File)
- and is_bytes_field(field)
- and isinstance(value, UploadFile)
- ):
- value = await value.read()
- elif (
- is_bytes_sequence_field(field)
- and isinstance(field_info, params.File)
- and value_is_sequence(value)
- ):
- # For types
- assert isinstance(value, sequence_types) # type: ignore[arg-type]
- results: List[Union[bytes, str]] = []
-
- async def process_fn(
- fn: Callable[[], Coroutine[Any, Any, Any]]
- ) -> None:
- result = await fn()
- results.append(result) # noqa: B023
-
- async with anyio.create_task_group() as tg:
- for sub_value in value:
- tg.start_soon(process_fn, sub_value.read)
- value = serialize_sequence_value(field=field, value=results)
-
- v_, errors_ = field.validate(value, values, loc=loc)
-
- if isinstance(errors_, list):
- errors.extend(errors_)
- elif errors_:
- errors.append(errors_)
- else:
- values[field.name] = v_
+ v_, errors_ = _validate_value_with_model_field(
+ field=field, value=value, values=values, loc=loc
+ )
+ if errors_:
+ errors.extend(errors_)
+ else:
+ values[field.name] = v_
return values, errors
-def get_body_field(*, dependant: Dependant, name: str) -> Optional[ModelField]:
- flat_dependant = get_flat_dependant(dependant)
+def get_body_field(
+ *, flat_dependant: Dependant, name: str, embed_body_fields: bool
+) -> Optional[ModelField]:
+ """
+ Get a ModelField representing the request body for a path operation, combining
+ all body parameters into a single field if necessary.
+
+ Used to check if it's form data (with `isinstance(body_field, params.Form)`)
+ or JSON and to generate the JSON Schema for a request body.
+
+ This is **not** used to validate/parse the request body, that's done with each
+ individual body parameter.
+ """
if not flat_dependant.body_params:
return None
first_param = flat_dependant.body_params[0]
- field_info = first_param.field_info
- embed = getattr(field_info, "embed", None)
- body_param_names_set = {param.name for param in flat_dependant.body_params}
- if len(body_param_names_set) == 1 and not embed:
- check_file_field(first_param)
+ if not embed_body_fields:
return first_param
- # If one field requires to embed, all have to be embedded
- # in case a sub-dependency is evaluated with a single unique body field
- # That is combined (embedded) with other body fields
- for param in flat_dependant.body_params:
- setattr(param.field_info, "embed", True) # noqa: B010
model_name = "Body_" + name
BodyModel = create_body_model(
fields=flat_dependant.body_params, model_name=model_name
@@ -787,24 +989,36 @@ def get_body_field(*, dependant: Dependant, name: str) -> Optional[ModelField]:
BodyFieldInfo_kwargs["default"] = None
if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):
BodyFieldInfo: Type[params.Body] = params.File
+ elif any(
+ isinstance(f.field_info, temp_pydantic_v1_params.File)
+ for f in flat_dependant.body_params
+ ):
+ BodyFieldInfo: Type[temp_pydantic_v1_params.Body] = temp_pydantic_v1_params.File # type: ignore[no-redef]
elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):
BodyFieldInfo = params.Form
+ elif any(
+ isinstance(f.field_info, temp_pydantic_v1_params.Form)
+ for f in flat_dependant.body_params
+ ):
+ BodyFieldInfo = temp_pydantic_v1_params.Form # type: ignore[assignment]
else:
- BodyFieldInfo = params.Body
+ if annotation_is_pydantic_v1(BodyModel):
+ BodyFieldInfo = temp_pydantic_v1_params.Body # type: ignore[assignment]
+ else:
+ BodyFieldInfo = params.Body
body_param_media_types = [
f.field_info.media_type
for f in flat_dependant.body_params
- if isinstance(f.field_info, params.Body)
+ if isinstance(f.field_info, (params.Body, temp_pydantic_v1_params.Body))
]
if len(set(body_param_media_types)) == 1:
BodyFieldInfo_kwargs["media_type"] = body_param_media_types[0]
- final_field = create_response_field(
+ final_field = create_model_field(
name="body",
type_=BodyModel,
required=required,
alias="body",
field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),
)
- check_file_field(final_field)
return final_field
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/encoders.py b/Backend/venv/lib/python3.12/site-packages/fastapi/encoders.py
index e5017139..6fc6228e 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/encoders.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/encoders.py
@@ -17,14 +17,16 @@ from types import GeneratorType
from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
from uuid import UUID
+from annotated_doc import Doc
+from fastapi._compat import may_v1
from fastapi.types import IncEx
from pydantic import BaseModel
from pydantic.color import Color
from pydantic.networks import AnyUrl, NameEmail
from pydantic.types import SecretBytes, SecretStr
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from typing_extensions import Annotated
-from ._compat import PYDANTIC_V2, Url, _model_dump
+from ._compat import Url, _is_undefined, _model_dump
# Taken from Pydantic v1 as is
@@ -58,6 +60,7 @@ def decimal_encoder(dec_value: Decimal) -> Union[int, float]:
ENCODERS_BY_TYPE: Dict[Type[Any], Callable[[Any], Any]] = {
bytes: lambda o: o.decode(),
Color: str,
+ may_v1.Color: str,
datetime.date: isoformat,
datetime.datetime: isoformat,
datetime.time: isoformat,
@@ -74,19 +77,24 @@ ENCODERS_BY_TYPE: Dict[Type[Any], Callable[[Any], Any]] = {
IPv6Interface: str,
IPv6Network: str,
NameEmail: str,
+ may_v1.NameEmail: str,
Path: str,
Pattern: lambda o: o.pattern,
SecretBytes: str,
+ may_v1.SecretBytes: str,
SecretStr: str,
+ may_v1.SecretStr: str,
set: list,
UUID: str,
Url: str,
+ may_v1.Url: str,
AnyUrl: str,
+ may_v1.AnyUrl: str,
}
def generate_encoders_by_class_tuples(
- type_encoder_map: Dict[Any, Callable[[Any], Any]]
+ type_encoder_map: Dict[Any, Callable[[Any], Any]],
) -> Dict[Callable[[Any], Any], Tuple[Any, ...]]:
encoders_by_class_tuples: Dict[Callable[[Any], Any], Tuple[Any, ...]] = defaultdict(
tuple
@@ -213,13 +221,13 @@ def jsonable_encoder(
include = set(include)
if exclude is not None and not isinstance(exclude, (set, dict)):
exclude = set(exclude)
- if isinstance(obj, BaseModel):
+ if isinstance(obj, (BaseModel, may_v1.BaseModel)):
# TODO: remove when deprecating Pydantic v1
encoders: Dict[Any, Any] = {}
- if not PYDANTIC_V2:
+ if isinstance(obj, may_v1.BaseModel):
encoders = getattr(obj.__config__, "json_encoders", {}) # type: ignore[attr-defined]
if custom_encoder:
- encoders.update(custom_encoder)
+ encoders = {**encoders, **custom_encoder}
obj_dict = _model_dump(
obj,
mode="json",
@@ -241,6 +249,7 @@ def jsonable_encoder(
sqlalchemy_safe=sqlalchemy_safe,
)
if dataclasses.is_dataclass(obj):
+ assert not isinstance(obj, type)
obj_dict = dataclasses.asdict(obj)
return jsonable_encoder(
obj_dict,
@@ -259,6 +268,8 @@ def jsonable_encoder(
return str(obj)
if isinstance(obj, (str, int, float, type(None))):
return obj
+ if _is_undefined(obj):
+ return None
if isinstance(obj, dict):
encoded_dict = {}
allowed_keys = set(obj.keys())
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/exception_handlers.py b/Backend/venv/lib/python3.12/site-packages/fastapi/exception_handlers.py
index 6c2ba7fe..475dd7bd 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/exception_handlers.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/exception_handlers.py
@@ -5,7 +5,7 @@ from fastapi.websockets import WebSocket
from starlette.exceptions import HTTPException
from starlette.requests import Request
from starlette.responses import JSONResponse, Response
-from starlette.status import HTTP_422_UNPROCESSABLE_ENTITY, WS_1008_POLICY_VIOLATION
+from starlette.status import WS_1008_POLICY_VIOLATION
async def http_exception_handler(request: Request, exc: HTTPException) -> Response:
@@ -21,7 +21,7 @@ async def request_validation_exception_handler(
request: Request, exc: RequestValidationError
) -> JSONResponse:
return JSONResponse(
- status_code=HTTP_422_UNPROCESSABLE_ENTITY,
+ status_code=422,
content={"detail": jsonable_encoder(exc.errors())},
)
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/exceptions.py b/Backend/venv/lib/python3.12/site-packages/fastapi/exceptions.py
index 680d288e..0620428b 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/exceptions.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/exceptions.py
@@ -1,9 +1,10 @@
from typing import Any, Dict, Optional, Sequence, Type, Union
+from annotated_doc import Doc
from pydantic import BaseModel, create_model
from starlette.exceptions import HTTPException as StarletteHTTPException
from starlette.exceptions import WebSocketException as StarletteWebSocketException
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from typing_extensions import Annotated
class HTTPException(StarletteHTTPException):
@@ -146,6 +147,13 @@ class FastAPIError(RuntimeError):
"""
+class DependencyScopeError(FastAPIError):
+ """
+ A dependency declared that it depends on another dependency with an invalid
+ (narrower) scope.
+ """
+
+
class ValidationException(Exception):
def __init__(self, errors: Sequence[Any]) -> None:
self._errors = errors
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/__init__.cpython-312.pyc
index a71e4fa0..a9b29fce 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/asyncexitstack.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/asyncexitstack.cpython-312.pyc
index 3e8a80f8..24086257 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/asyncexitstack.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/asyncexitstack.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/cors.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/cors.cpython-312.pyc
index a0e03f94..57b18ced 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/cors.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/cors.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/gzip.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/gzip.cpython-312.pyc
new file mode 100644
index 00000000..a0f506b8
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/gzip.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/httpsredirect.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/httpsredirect.cpython-312.pyc
new file mode 100644
index 00000000..5e123ef1
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/httpsredirect.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/trustedhost.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/trustedhost.cpython-312.pyc
new file mode 100644
index 00000000..b824a788
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/trustedhost.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/wsgi.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/wsgi.cpython-312.pyc
new file mode 100644
index 00000000..4b0f2014
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/__pycache__/wsgi.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/asyncexitstack.py b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/asyncexitstack.py
index 30a0ae62..4ce3f5a6 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/asyncexitstack.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/middleware/asyncexitstack.py
@@ -1,25 +1,18 @@
-from typing import Optional
+from contextlib import AsyncExitStack
-from fastapi.concurrency import AsyncExitStack
from starlette.types import ASGIApp, Receive, Scope, Send
+# Used mainly to close files after the request is done, dependencies are closed
+# in their own AsyncExitStack
class AsyncExitStackMiddleware:
- def __init__(self, app: ASGIApp, context_name: str = "fastapi_astack") -> None:
+ def __init__(
+ self, app: ASGIApp, context_name: str = "fastapi_middleware_astack"
+ ) -> None:
self.app = app
self.context_name = context_name
async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
- dependency_exception: Optional[Exception] = None
async with AsyncExitStack() as stack:
scope[self.context_name] = stack
- try:
- await self.app(scope, receive, send)
- except Exception as e:
- dependency_exception = e
- raise e
- if dependency_exception:
- # This exception was possibly handled by the dependency but it should
- # still bubble up so that the ServerErrorMiddleware can return a 500
- # or the ExceptionMiddleware can catch and handle any other exceptions
- raise dependency_exception
+ await self.app(scope, receive, send)
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/__init__.cpython-312.pyc
index 82fee2c4..526bd858 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/constants.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/constants.cpython-312.pyc
index 5d18a877..3d4fd6b2 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/constants.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/constants.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/docs.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/docs.cpython-312.pyc
index ae5473b2..e5f103d4 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/docs.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/docs.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/models.cpython-312.pyc
index f8fc42b3..b60c3823 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/models.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/utils.cpython-312.pyc
index 5a614694..51eada15 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/utils.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/docs.py b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/docs.py
index 69473d19..74b23a37 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/docs.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/docs.py
@@ -1,9 +1,10 @@
import json
from typing import Any, Dict, Optional
+from annotated_doc import Doc
from fastapi.encoders import jsonable_encoder
from starlette.responses import HTMLResponse
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from typing_extensions import Annotated
swagger_ui_default_parameters: Annotated[
Dict[str, Any],
@@ -53,7 +54,7 @@ def get_swagger_ui_html(
It is normally set to a CDN URL.
"""
),
- ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui-bundle.js",
+ ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js",
swagger_css_url: Annotated[
str,
Doc(
@@ -63,7 +64,7 @@ def get_swagger_ui_html(
It is normally set to a CDN URL.
"""
),
- ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui.css",
+ ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css",
swagger_favicon_url: Annotated[
str,
Doc(
@@ -188,7 +189,7 @@ def get_redoc_html(
It is normally set to a CDN URL.
"""
),
- ] = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js",
+ ] = "https://cdn.jsdelivr.net/npm/redoc@2/bundles/redoc.standalone.js",
redoc_favicon_url: Annotated[
str,
Doc(
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/models.py b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/models.py
index 5f3bdbb2..81d276ae 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/models.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/models.py
@@ -55,35 +55,29 @@ except ImportError: # pragma: no cover
return with_info_plain_validator_function(cls._validate)
-class Contact(BaseModel):
+class BaseModelWithConfig(BaseModel):
+ if PYDANTIC_V2:
+ model_config = {"extra": "allow"}
+
+ else:
+
+ class Config:
+ extra = "allow"
+
+
+class Contact(BaseModelWithConfig):
name: Optional[str] = None
url: Optional[AnyUrl] = None
email: Optional[EmailStr] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class License(BaseModel):
+class License(BaseModelWithConfig):
name: str
identifier: Optional[str] = None
url: Optional[AnyUrl] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class Info(BaseModel):
+class Info(BaseModelWithConfig):
title: str
summary: Optional[str] = None
description: Optional[str] = None
@@ -92,42 +86,18 @@ class Info(BaseModel):
license: Optional[License] = None
version: str
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class ServerVariable(BaseModel):
+class ServerVariable(BaseModelWithConfig):
enum: Annotated[Optional[List[str]], Field(min_length=1)] = None
default: str
description: Optional[str] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class Server(BaseModel):
+class Server(BaseModelWithConfig):
url: Union[AnyUrl, str]
description: Optional[str] = None
variables: Optional[Dict[str, ServerVariable]] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
class Reference(BaseModel):
ref: str = Field(alias="$ref")
@@ -138,36 +108,26 @@ class Discriminator(BaseModel):
mapping: Optional[Dict[str, str]] = None
-class XML(BaseModel):
+class XML(BaseModelWithConfig):
name: Optional[str] = None
namespace: Optional[str] = None
prefix: Optional[str] = None
attribute: Optional[bool] = None
wrapped: Optional[bool] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class ExternalDocumentation(BaseModel):
+class ExternalDocumentation(BaseModelWithConfig):
description: Optional[str] = None
url: AnyUrl
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
+# Ref JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation#name-type
+SchemaType = Literal[
+ "array", "boolean", "integer", "null", "number", "object", "string"
+]
-class Schema(BaseModel):
+class Schema(BaseModelWithConfig):
# Ref: JSON Schema 2020-12: https://json-schema.org/draft/2020-12/json-schema-core.html#name-the-json-schema-core-vocabu
# Core Vocabulary
schema_: Optional[str] = Field(default=None, alias="$schema")
@@ -191,7 +151,7 @@ class Schema(BaseModel):
dependentSchemas: Optional[Dict[str, "SchemaOrBool"]] = None
prefixItems: Optional[List["SchemaOrBool"]] = None
# TODO: uncomment and remove below when deprecating Pydantic v1
- # It generales a list of schemas for tuples, before prefixItems was available
+ # It generates a list of schemas for tuples, before prefixItems was available
# items: Optional["SchemaOrBool"] = None
items: Optional[Union["SchemaOrBool", List["SchemaOrBool"]]] = None
contains: Optional["SchemaOrBool"] = None
@@ -203,7 +163,7 @@ class Schema(BaseModel):
unevaluatedProperties: Optional["SchemaOrBool"] = None
# Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-structural
# A Vocabulary for Structural Validation
- type: Optional[str] = None
+ type: Optional[Union[SchemaType, List[SchemaType]]] = None
enum: Optional[List[Any]] = None
const: Optional[Any] = None
multipleOf: Optional[float] = Field(default=None, gt=0)
@@ -253,14 +213,6 @@ class Schema(BaseModel):
),
] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
# Ref: https://json-schema.org/draft/2020-12/json-schema-core.html#name-json-schema-documents
# A JSON Schema MUST be an object or a boolean.
@@ -289,38 +241,22 @@ class ParameterInType(Enum):
cookie = "cookie"
-class Encoding(BaseModel):
+class Encoding(BaseModelWithConfig):
contentType: Optional[str] = None
headers: Optional[Dict[str, Union["Header", Reference]]] = None
style: Optional[str] = None
explode: Optional[bool] = None
allowReserved: Optional[bool] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class MediaType(BaseModel):
+class MediaType(BaseModelWithConfig):
schema_: Optional[Union[Schema, Reference]] = Field(default=None, alias="schema")
example: Optional[Any] = None
examples: Optional[Dict[str, Union[Example, Reference]]] = None
encoding: Optional[Dict[str, Encoding]] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class ParameterBase(BaseModel):
+class ParameterBase(BaseModelWithConfig):
description: Optional[str] = None
required: Optional[bool] = None
deprecated: Optional[bool] = None
@@ -334,14 +270,6 @@ class ParameterBase(BaseModel):
# Serialization rules for more complex scenarios
content: Optional[Dict[str, MediaType]] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
class Parameter(ParameterBase):
name: str
@@ -352,21 +280,13 @@ class Header(ParameterBase):
pass
-class RequestBody(BaseModel):
+class RequestBody(BaseModelWithConfig):
description: Optional[str] = None
content: Dict[str, MediaType]
required: Optional[bool] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class Link(BaseModel):
+class Link(BaseModelWithConfig):
operationRef: Optional[str] = None
operationId: Optional[str] = None
parameters: Optional[Dict[str, Union[Any, str]]] = None
@@ -374,31 +294,15 @@ class Link(BaseModel):
description: Optional[str] = None
server: Optional[Server] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class Response(BaseModel):
+class Response(BaseModelWithConfig):
description: str
headers: Optional[Dict[str, Union[Header, Reference]]] = None
content: Optional[Dict[str, MediaType]] = None
links: Optional[Dict[str, Union[Link, Reference]]] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class Operation(BaseModel):
+class Operation(BaseModelWithConfig):
tags: Optional[List[str]] = None
summary: Optional[str] = None
description: Optional[str] = None
@@ -413,16 +317,8 @@ class Operation(BaseModel):
security: Optional[List[Dict[str, List[str]]]] = None
servers: Optional[List[Server]] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class PathItem(BaseModel):
+class PathItem(BaseModelWithConfig):
ref: Optional[str] = Field(default=None, alias="$ref")
summary: Optional[str] = None
description: Optional[str] = None
@@ -437,14 +333,6 @@ class PathItem(BaseModel):
servers: Optional[List[Server]] = None
parameters: Optional[List[Union[Parameter, Reference]]] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
class SecuritySchemeType(Enum):
apiKey = "apiKey"
@@ -453,18 +341,10 @@ class SecuritySchemeType(Enum):
openIdConnect = "openIdConnect"
-class SecurityBase(BaseModel):
+class SecurityBase(BaseModelWithConfig):
type_: SecuritySchemeType = Field(alias="type")
description: Optional[str] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
class APIKeyIn(Enum):
query = "query"
@@ -488,18 +368,10 @@ class HTTPBearer(HTTPBase):
bearerFormat: Optional[str] = None
-class OAuthFlow(BaseModel):
+class OAuthFlow(BaseModelWithConfig):
refreshUrl: Optional[str] = None
scopes: Dict[str, str] = {}
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
class OAuthFlowImplicit(OAuthFlow):
authorizationUrl: str
@@ -518,20 +390,12 @@ class OAuthFlowAuthorizationCode(OAuthFlow):
tokenUrl: str
-class OAuthFlows(BaseModel):
+class OAuthFlows(BaseModelWithConfig):
implicit: Optional[OAuthFlowImplicit] = None
password: Optional[OAuthFlowPassword] = None
clientCredentials: Optional[OAuthFlowClientCredentials] = None
authorizationCode: Optional[OAuthFlowAuthorizationCode] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
class OAuth2(SecurityBase):
type_: SecuritySchemeType = Field(default=SecuritySchemeType.oauth2, alias="type")
@@ -548,7 +412,7 @@ class OpenIdConnect(SecurityBase):
SecurityScheme = Union[APIKey, HTTPBase, OAuth2, OpenIdConnect, HTTPBearer]
-class Components(BaseModel):
+class Components(BaseModelWithConfig):
schemas: Optional[Dict[str, Union[Schema, Reference]]] = None
responses: Optional[Dict[str, Union[Response, Reference]]] = None
parameters: Optional[Dict[str, Union[Parameter, Reference]]] = None
@@ -561,30 +425,14 @@ class Components(BaseModel):
callbacks: Optional[Dict[str, Union[Dict[str, PathItem], Reference, Any]]] = None
pathItems: Optional[Dict[str, Union[PathItem, Reference]]] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class Tag(BaseModel):
+class Tag(BaseModelWithConfig):
name: str
description: Optional[str] = None
externalDocs: Optional[ExternalDocumentation] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
- else:
-
- class Config:
- extra = "allow"
-
-
-class OpenAPI(BaseModel):
+class OpenAPI(BaseModelWithConfig):
openapi: str
info: Info
jsonSchemaDialect: Optional[str] = None
@@ -597,14 +445,6 @@ class OpenAPI(BaseModel):
tags: Optional[List[Tag]] = None
externalDocs: Optional[ExternalDocumentation] = None
- if PYDANTIC_V2:
- model_config = {"extra": "allow"}
-
- else:
-
- class Config:
- extra = "allow"
-
_model_rebuild(Schema)
_model_rebuild(Operation)
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/utils.py b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/utils.py
index 5bfb5ace..dbc93d28 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/utils.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/openapi/utils.py
@@ -5,7 +5,6 @@ from typing import Any, Dict, List, Optional, Sequence, Set, Tuple, Type, Union,
from fastapi import routing
from fastapi._compat import (
- GenerateJsonSchema,
JsonSchemaValue,
ModelField,
Undefined,
@@ -16,11 +15,15 @@ from fastapi._compat import (
)
from fastapi.datastructures import DefaultPlaceholder
from fastapi.dependencies.models import Dependant
-from fastapi.dependencies.utils import get_flat_dependant, get_flat_params
+from fastapi.dependencies.utils import (
+ _get_flat_fields_from_params,
+ get_flat_dependant,
+ get_flat_params,
+)
from fastapi.encoders import jsonable_encoder
-from fastapi.openapi.constants import METHODS_WITH_BODY, REF_PREFIX, REF_TEMPLATE
+from fastapi.openapi.constants import METHODS_WITH_BODY, REF_PREFIX
from fastapi.openapi.models import OpenAPI
-from fastapi.params import Body, Param
+from fastapi.params import Body, ParamTypes
from fastapi.responses import Response
from fastapi.types import ModelNameMap
from fastapi.utils import (
@@ -28,11 +31,13 @@ from fastapi.utils import (
generate_operation_id_for_path,
is_body_allowed_for_status_code,
)
+from pydantic import BaseModel
from starlette.responses import JSONResponse
from starlette.routing import BaseRoute
-from starlette.status import HTTP_422_UNPROCESSABLE_ENTITY
from typing_extensions import Literal
+from .._compat import _is_model_field
+
validation_error_definition = {
"title": "ValidationError",
"type": "object",
@@ -87,10 +92,9 @@ def get_openapi_security_definitions(
return security_definitions, operation_security
-def get_openapi_operation_parameters(
+def _get_openapi_operation_parameters(
*,
- all_route_params: Sequence[ModelField],
- schema_generator: GenerateJsonSchema,
+ dependant: Dependant,
model_name_map: ModelNameMap,
field_mapping: Dict[
Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
@@ -98,40 +102,72 @@ def get_openapi_operation_parameters(
separate_input_output_schemas: bool = True,
) -> List[Dict[str, Any]]:
parameters = []
- for param in all_route_params:
- field_info = param.field_info
- field_info = cast(Param, field_info)
- if not field_info.include_in_schema:
- continue
- param_schema = get_schema_from_model_field(
- field=param,
- schema_generator=schema_generator,
- model_name_map=model_name_map,
- field_mapping=field_mapping,
- separate_input_output_schemas=separate_input_output_schemas,
- )
- parameter = {
- "name": param.alias,
- "in": field_info.in_.value,
- "required": param.required,
- "schema": param_schema,
- }
- if field_info.description:
- parameter["description"] = field_info.description
- if field_info.openapi_examples:
- parameter["examples"] = jsonable_encoder(field_info.openapi_examples)
- elif field_info.example != Undefined:
- parameter["example"] = jsonable_encoder(field_info.example)
- if field_info.deprecated:
- parameter["deprecated"] = field_info.deprecated
- parameters.append(parameter)
+ flat_dependant = get_flat_dependant(dependant, skip_repeats=True)
+ path_params = _get_flat_fields_from_params(flat_dependant.path_params)
+ query_params = _get_flat_fields_from_params(flat_dependant.query_params)
+ header_params = _get_flat_fields_from_params(flat_dependant.header_params)
+ cookie_params = _get_flat_fields_from_params(flat_dependant.cookie_params)
+ parameter_groups = [
+ (ParamTypes.path, path_params),
+ (ParamTypes.query, query_params),
+ (ParamTypes.header, header_params),
+ (ParamTypes.cookie, cookie_params),
+ ]
+ default_convert_underscores = True
+ if len(flat_dependant.header_params) == 1:
+ first_field = flat_dependant.header_params[0]
+ if lenient_issubclass(first_field.type_, BaseModel):
+ default_convert_underscores = getattr(
+ first_field.field_info, "convert_underscores", True
+ )
+ for param_type, param_group in parameter_groups:
+ for param in param_group:
+ field_info = param.field_info
+ # field_info = cast(Param, field_info)
+ if not getattr(field_info, "include_in_schema", True):
+ continue
+ param_schema = get_schema_from_model_field(
+ field=param,
+ model_name_map=model_name_map,
+ field_mapping=field_mapping,
+ separate_input_output_schemas=separate_input_output_schemas,
+ )
+ name = param.alias
+ convert_underscores = getattr(
+ param.field_info,
+ "convert_underscores",
+ default_convert_underscores,
+ )
+ if (
+ param_type == ParamTypes.header
+ and param.alias == param.name
+ and convert_underscores
+ ):
+ name = param.name.replace("_", "-")
+
+ parameter = {
+ "name": name,
+ "in": param_type.value,
+ "required": param.required,
+ "schema": param_schema,
+ }
+ if field_info.description:
+ parameter["description"] = field_info.description
+ openapi_examples = getattr(field_info, "openapi_examples", None)
+ example = getattr(field_info, "example", None)
+ if openapi_examples:
+ parameter["examples"] = jsonable_encoder(openapi_examples)
+ elif example != Undefined:
+ parameter["example"] = jsonable_encoder(example)
+ if getattr(field_info, "deprecated", None):
+ parameter["deprecated"] = True
+ parameters.append(parameter)
return parameters
def get_openapi_operation_request_body(
*,
body_field: Optional[ModelField],
- schema_generator: GenerateJsonSchema,
model_name_map: ModelNameMap,
field_mapping: Dict[
Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
@@ -140,10 +176,9 @@ def get_openapi_operation_request_body(
) -> Optional[Dict[str, Any]]:
if not body_field:
return None
- assert isinstance(body_field, ModelField)
+ assert _is_model_field(body_field)
body_schema = get_schema_from_model_field(
field=body_field,
- schema_generator=schema_generator,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -216,7 +251,6 @@ def get_openapi_path(
*,
route: routing.APIRoute,
operation_ids: Set[str],
- schema_generator: GenerateJsonSchema,
model_name_map: ModelNameMap,
field_mapping: Dict[
Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
@@ -247,10 +281,8 @@ def get_openapi_path(
operation.setdefault("security", []).extend(operation_security)
if security_definitions:
security_schemes.update(security_definitions)
- all_route_params = get_flat_params(route.dependant)
- operation_parameters = get_openapi_operation_parameters(
- all_route_params=all_route_params,
- schema_generator=schema_generator,
+ operation_parameters = _get_openapi_operation_parameters(
+ dependant=route.dependant,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -272,7 +304,6 @@ def get_openapi_path(
if method in METHODS_WITH_BODY:
request_body_oai = get_openapi_operation_request_body(
body_field=route.body_field,
- schema_generator=schema_generator,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -290,7 +321,6 @@ def get_openapi_path(
) = get_openapi_path(
route=callback,
operation_ids=operation_ids,
- schema_generator=schema_generator,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -321,7 +351,6 @@ def get_openapi_path(
if route.response_field:
response_schema = get_schema_from_model_field(
field=route.response_field,
- schema_generator=schema_generator,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -347,15 +376,14 @@ def get_openapi_path(
openapi_response = operation_responses.setdefault(
status_code_key, {}
)
- assert isinstance(
- process_response, dict
- ), "An additional response must be a dict"
+ assert isinstance(process_response, dict), (
+ "An additional response must be a dict"
+ )
field = route.response_fields.get(additional_status_code)
additional_field_schema: Optional[Dict[str, Any]] = None
if field:
additional_field_schema = get_schema_from_model_field(
field=field,
- schema_generator=schema_generator,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -378,7 +406,8 @@ def get_openapi_path(
)
deep_dict_update(openapi_response, process_response)
openapi_response["description"] = description
- http422 = str(HTTP_422_UNPROCESSABLE_ENTITY)
+ http422 = "422"
+ all_route_params = get_flat_params(route.dependant)
if (all_route_params or route.body_field) and not any(
status in operation["responses"]
for status in [http422, "4XX", "default"]
@@ -416,9 +445,9 @@ def get_fields_from_routes(
route, routing.APIRoute
):
if route.body_field:
- assert isinstance(
- route.body_field, ModelField
- ), "A request body must be a Pydantic Field"
+ assert _is_model_field(route.body_field), (
+ "A request body must be a Pydantic Field"
+ )
body_fields_from_routes.append(route.body_field)
if route.response_field:
responses_from_routes.append(route.response_field)
@@ -450,6 +479,7 @@ def get_openapi(
contact: Optional[Dict[str, Union[str, Any]]] = None,
license_info: Optional[Dict[str, Union[str, Any]]] = None,
separate_input_output_schemas: bool = True,
+ external_docs: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
info: Dict[str, Any] = {"title": title, "version": version}
if summary:
@@ -471,10 +501,8 @@ def get_openapi(
operation_ids: Set[str] = set()
all_fields = get_fields_from_routes(list(routes or []) + list(webhooks or []))
model_name_map = get_compat_model_name_map(all_fields)
- schema_generator = GenerateJsonSchema(ref_template=REF_TEMPLATE)
field_mapping, definitions = get_definitions(
fields=all_fields,
- schema_generator=schema_generator,
model_name_map=model_name_map,
separate_input_output_schemas=separate_input_output_schemas,
)
@@ -483,7 +511,6 @@ def get_openapi(
result = get_openapi_path(
route=route,
operation_ids=operation_ids,
- schema_generator=schema_generator,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -503,7 +530,6 @@ def get_openapi(
result = get_openapi_path(
route=webhook,
operation_ids=operation_ids,
- schema_generator=schema_generator,
model_name_map=model_name_map,
field_mapping=field_mapping,
separate_input_output_schemas=separate_input_output_schemas,
@@ -527,4 +553,6 @@ def get_openapi(
output["webhooks"] = webhook_paths
if tags:
output["tags"] = tags
+ if external_docs:
+ output["externalDocs"] = external_docs
return jsonable_encoder(OpenAPI(**output), by_alias=True, exclude_none=True) # type: ignore
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/param_functions.py b/Backend/venv/lib/python3.12/site-packages/fastapi/param_functions.py
index 3f6dbc95..e32f7559 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/param_functions.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/param_functions.py
@@ -1,9 +1,10 @@
from typing import Any, Callable, Dict, List, Optional, Sequence, Union
+from annotated_doc import Doc
from fastapi import params
from fastapi._compat import Undefined
from fastapi.openapi.models import Example
-from typing_extensions import Annotated, Doc, deprecated # type: ignore [attr-defined]
+from typing_extensions import Annotated, Literal, deprecated
_Unset: Any = Undefined
@@ -240,7 +241,7 @@ def Path( # noqa: N802
),
] = None,
deprecated: Annotated[
- Optional[bool],
+ Union[deprecated, str, bool, None],
Doc(
"""
Mark this parameter field as deprecated.
@@ -565,7 +566,7 @@ def Query( # noqa: N802
),
] = None,
deprecated: Annotated[
- Optional[bool],
+ Union[deprecated, str, bool, None],
Doc(
"""
Mark this parameter field as deprecated.
@@ -880,7 +881,7 @@ def Header( # noqa: N802
),
] = None,
deprecated: Annotated[
- Optional[bool],
+ Union[deprecated, str, bool, None],
Doc(
"""
Mark this parameter field as deprecated.
@@ -1185,7 +1186,7 @@ def Cookie( # noqa: N802
),
] = None,
deprecated: Annotated[
- Optional[bool],
+ Union[deprecated, str, bool, None],
Doc(
"""
Mark this parameter field as deprecated.
@@ -1282,7 +1283,7 @@ def Body( # noqa: N802
),
] = _Unset,
embed: Annotated[
- bool,
+ Union[bool, None],
Doc(
"""
When `embed` is `True`, the parameter will be expected in a JSON body as a
@@ -1294,7 +1295,7 @@ def Body( # noqa: N802
[FastAPI docs for Body - Multiple Parameters](https://fastapi.tiangolo.com/tutorial/body-multiple-params/#embed-a-single-body-parameter).
"""
),
- ] = False,
+ ] = None,
media_type: Annotated[
str,
Doc(
@@ -1512,7 +1513,7 @@ def Body( # noqa: N802
),
] = None,
deprecated: Annotated[
- Optional[bool],
+ Union[deprecated, str, bool, None],
Doc(
"""
Mark this parameter field as deprecated.
@@ -1827,7 +1828,7 @@ def Form( # noqa: N802
),
] = None,
deprecated: Annotated[
- Optional[bool],
+ Union[deprecated, str, bool, None],
Doc(
"""
Mark this parameter field as deprecated.
@@ -2141,7 +2142,7 @@ def File( # noqa: N802
),
] = None,
deprecated: Annotated[
- Optional[bool],
+ Union[deprecated, str, bool, None],
Doc(
"""
Mark this parameter field as deprecated.
@@ -2244,6 +2245,26 @@ def Depends( # noqa: N802
"""
),
] = True,
+ scope: Annotated[
+ Union[Literal["function", "request"], None],
+ Doc(
+ """
+ Mainly for dependencies with `yield`, define when the dependency function
+ should start (the code before `yield`) and when it should end (the code
+ after `yield`).
+
+ * `"function"`: start the dependency before the *path operation function*
+ that handles the request, end the dependency after the *path operation
+ function* ends, but **before** the response is sent back to the client.
+ So, the dependency function will be executed **around** the *path operation
+ **function***.
+ * `"request"`: start the dependency before the *path operation function*
+ that handles the request (similar to when using `"function"`), but end
+ **after** the response is sent back to the client. So, the dependency
+ function will be executed **around** the **request** and response cycle.
+ """
+ ),
+ ] = None,
) -> Any:
"""
Declare a FastAPI dependency.
@@ -2274,7 +2295,7 @@ def Depends( # noqa: N802
return commons
```
"""
- return params.Depends(dependency=dependency, use_cache=use_cache)
+ return params.Depends(dependency=dependency, use_cache=use_cache, scope=scope)
def Security( # noqa: N802
@@ -2298,7 +2319,7 @@ def Security( # noqa: N802
dependency.
The term "scope" comes from the OAuth2 specification, it seems to be
- intentionaly vague and interpretable. It normally refers to permissions,
+ intentionally vague and interpretable. It normally refers to permissions,
in cases to roles.
These scopes are integrated with OpenAPI (and the API docs at `/docs`).
@@ -2343,7 +2364,7 @@ def Security( # noqa: N802
```python
from typing import Annotated
- from fastapi import Depends, FastAPI
+ from fastapi import Security, FastAPI
from .db import User
from .security import get_current_active_user
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/params.py b/Backend/venv/lib/python3.12/site-packages/fastapi/params.py
index b40944db..6d07df35 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/params.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/params.py
@@ -1,12 +1,17 @@
import warnings
+from dataclasses import dataclass
from enum import Enum
from typing import Any, Callable, Dict, List, Optional, Sequence, Union
from fastapi.openapi.models import Example
from pydantic.fields import FieldInfo
-from typing_extensions import Annotated, deprecated
+from typing_extensions import Annotated, Literal, deprecated
-from ._compat import PYDANTIC_V2, Undefined
+from ._compat import (
+ PYDANTIC_V2,
+ PYDANTIC_VERSION_MINOR_TUPLE,
+ Undefined,
+)
_Unset: Any = Undefined
@@ -18,7 +23,7 @@ class ParamTypes(Enum):
cookie = "cookie"
-class Param(FieldInfo):
+class Param(FieldInfo): # type: ignore[misc]
in_: ParamTypes
def __init__(
@@ -63,12 +68,11 @@ class Param(FieldInfo):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
):
- self.deprecated = deprecated
if example is not _Unset:
warnings.warn(
"`example` has been deprecated, please use `examples` instead",
@@ -92,7 +96,7 @@ class Param(FieldInfo):
max_length=max_length,
discriminator=discriminator,
multiple_of=multiple_of,
- allow_nan=allow_inf_nan,
+ allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
**extra,
@@ -106,6 +110,10 @@ class Param(FieldInfo):
stacklevel=4,
)
current_json_schema_extra = json_schema_extra or extra
+ if PYDANTIC_VERSION_MINOR_TUPLE < (2, 7):
+ self.deprecated = deprecated
+ else:
+ kwargs["deprecated"] = deprecated
if PYDANTIC_V2:
kwargs.update(
{
@@ -129,7 +137,7 @@ class Param(FieldInfo):
return f"{self.__class__.__name__}({self.default})"
-class Path(Param):
+class Path(Param): # type: ignore[misc]
in_ = ParamTypes.path
def __init__(
@@ -174,7 +182,7 @@ class Path(Param):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
@@ -215,7 +223,7 @@ class Path(Param):
)
-class Query(Param):
+class Query(Param): # type: ignore[misc]
in_ = ParamTypes.query
def __init__(
@@ -260,7 +268,7 @@ class Query(Param):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
@@ -299,7 +307,7 @@ class Query(Param):
)
-class Header(Param):
+class Header(Param): # type: ignore[misc]
in_ = ParamTypes.header
def __init__(
@@ -345,7 +353,7 @@ class Header(Param):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
@@ -385,7 +393,7 @@ class Header(Param):
)
-class Cookie(Param):
+class Cookie(Param): # type: ignore[misc]
in_ = ParamTypes.cookie
def __init__(
@@ -430,7 +438,7 @@ class Cookie(Param):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
@@ -469,14 +477,14 @@ class Cookie(Param):
)
-class Body(FieldInfo):
+class Body(FieldInfo): # type: ignore[misc]
def __init__(
self,
default: Any = Undefined,
*,
default_factory: Union[Callable[[], Any], None] = _Unset,
annotation: Optional[Any] = None,
- embed: bool = False,
+ embed: Union[bool, None] = None,
media_type: str = "application/json",
alias: Optional[str] = None,
alias_priority: Union[int, None] = _Unset,
@@ -514,14 +522,13 @@ class Body(FieldInfo):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
):
self.embed = embed
self.media_type = media_type
- self.deprecated = deprecated
if example is not _Unset:
warnings.warn(
"`example` has been deprecated, please use `examples` instead",
@@ -545,7 +552,7 @@ class Body(FieldInfo):
max_length=max_length,
discriminator=discriminator,
multiple_of=multiple_of,
- allow_nan=allow_inf_nan,
+ allow_inf_nan=allow_inf_nan,
max_digits=max_digits,
decimal_places=decimal_places,
**extra,
@@ -554,11 +561,15 @@ class Body(FieldInfo):
kwargs["examples"] = examples
if regex is not None:
warnings.warn(
- "`regex` has been depreacated, please use `pattern` instead",
+ "`regex` has been deprecated, please use `pattern` instead",
category=DeprecationWarning,
stacklevel=4,
)
current_json_schema_extra = json_schema_extra or extra
+ if PYDANTIC_VERSION_MINOR_TUPLE < (2, 7):
+ self.deprecated = deprecated
+ else:
+ kwargs["deprecated"] = deprecated
if PYDANTIC_V2:
kwargs.update(
{
@@ -583,7 +594,7 @@ class Body(FieldInfo):
return f"{self.__class__.__name__}({self.default})"
-class Form(Body):
+class Form(Body): # type: ignore[misc]
def __init__(
self,
default: Any = Undefined,
@@ -627,7 +638,7 @@ class Form(Body):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
@@ -636,7 +647,6 @@ class Form(Body):
default=default,
default_factory=default_factory,
annotation=annotation,
- embed=True,
media_type=media_type,
alias=alias,
alias_priority=alias_priority,
@@ -668,7 +678,7 @@ class Form(Body):
)
-class File(Form):
+class File(Form): # type: ignore[misc]
def __init__(
self,
default: Any = Undefined,
@@ -712,7 +722,7 @@ class File(Form):
),
] = _Unset,
openapi_examples: Optional[Dict[str, Example]] = None,
- deprecated: Optional[bool] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
include_in_schema: bool = True,
json_schema_extra: Union[Dict[str, Any], None] = None,
**extra: Any,
@@ -752,26 +762,13 @@ class File(Form):
)
+@dataclass(frozen=True)
class Depends:
- def __init__(
- self, dependency: Optional[Callable[..., Any]] = None, *, use_cache: bool = True
- ):
- self.dependency = dependency
- self.use_cache = use_cache
-
- def __repr__(self) -> str:
- attr = getattr(self.dependency, "__name__", type(self.dependency).__name__)
- cache = "" if self.use_cache else ", use_cache=False"
- return f"{self.__class__.__name__}({attr}{cache})"
+ dependency: Optional[Callable[..., Any]] = None
+ use_cache: bool = True
+ scope: Union[Literal["function", "request"], None] = None
+@dataclass(frozen=True)
class Security(Depends):
- def __init__(
- self,
- dependency: Optional[Callable[..., Any]] = None,
- *,
- scopes: Optional[Sequence[str]] = None,
- use_cache: bool = True,
- ):
- super().__init__(dependency=dependency, use_cache=use_cache)
- self.scopes = scopes or []
+ scopes: Optional[Sequence[str]] = None
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/routing.py b/Backend/venv/lib/python3.12/site-packages/fastapi/routing.py
index 54d53bbb..a8e12eb6 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/routing.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/routing.py
@@ -1,16 +1,21 @@
-import asyncio
import dataclasses
import email.message
+import functools
import inspect
import json
-from contextlib import AsyncExitStack
+import sys
+from contextlib import AsyncExitStack, asynccontextmanager
from enum import Enum, IntEnum
from typing import (
Any,
+ AsyncIterator,
+ Awaitable,
Callable,
+ Collection,
Coroutine,
Dict,
List,
+ Mapping,
Optional,
Sequence,
Set,
@@ -19,7 +24,8 @@ from typing import (
Union,
)
-from fastapi import params
+from annotated_doc import Doc
+from fastapi import params, temp_pydantic_v1_params
from fastapi._compat import (
ModelField,
Undefined,
@@ -31,8 +37,10 @@ from fastapi._compat import (
from fastapi.datastructures import Default, DefaultPlaceholder
from fastapi.dependencies.models import Dependant
from fastapi.dependencies.utils import (
+ _should_embed_body_fields,
get_body_field,
get_dependant,
+ get_flat_dependant,
get_parameterless_sub_dependant,
get_typed_return_annotation,
solve_dependencies,
@@ -47,13 +55,15 @@ from fastapi.exceptions import (
from fastapi.types import DecoratedCallable, IncEx
from fastapi.utils import (
create_cloned_field,
- create_response_field,
+ create_model_field,
generate_unique_id,
get_value_or_default,
is_body_allowed_for_status_code,
)
from pydantic import BaseModel
from starlette import routing
+from starlette._exception_handler import wrap_app_handling_exceptions
+from starlette._utils import is_async_callable
from starlette.concurrency import run_in_threadpool
from starlette.exceptions import HTTPException
from starlette.requests import Request
@@ -63,13 +73,84 @@ from starlette.routing import (
Match,
compile_path,
get_name,
- request_response,
- websocket_session,
)
from starlette.routing import Mount as Mount # noqa
-from starlette.types import ASGIApp, Lifespan, Scope
+from starlette.types import AppType, ASGIApp, Lifespan, Receive, Scope, Send
from starlette.websockets import WebSocket
-from typing_extensions import Annotated, Doc, deprecated # type: ignore [attr-defined]
+from typing_extensions import Annotated, deprecated
+
+if sys.version_info >= (3, 13): # pragma: no cover
+ from inspect import iscoroutinefunction
+else: # pragma: no cover
+ from asyncio import iscoroutinefunction
+
+
+# Copy of starlette.routing.request_response modified to include the
+# dependencies' AsyncExitStack
+def request_response(
+ func: Callable[[Request], Union[Awaitable[Response], Response]],
+) -> ASGIApp:
+ """
+ Takes a function or coroutine `func(request) -> response`,
+ and returns an ASGI application.
+ """
+ f: Callable[[Request], Awaitable[Response]] = (
+ func if is_async_callable(func) else functools.partial(run_in_threadpool, func) # type:ignore
+ )
+
+ async def app(scope: Scope, receive: Receive, send: Send) -> None:
+ request = Request(scope, receive, send)
+
+ async def app(scope: Scope, receive: Receive, send: Send) -> None:
+ # Starts customization
+ response_awaited = False
+ async with AsyncExitStack() as request_stack:
+ scope["fastapi_inner_astack"] = request_stack
+ async with AsyncExitStack() as function_stack:
+ scope["fastapi_function_astack"] = function_stack
+ response = await f(request)
+ await response(scope, receive, send)
+ # Continues customization
+ response_awaited = True
+ if not response_awaited:
+ raise FastAPIError(
+ "Response not awaited. There's a high chance that the "
+ "application code is raising an exception and a dependency with yield "
+ "has a block with a bare except, or a block with except Exception, "
+ "and is not raising the exception again. Read more about it in the "
+ "docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except"
+ )
+
+ # Same as in Starlette
+ await wrap_app_handling_exceptions(app, request)(scope, receive, send)
+
+ return app
+
+
+# Copy of starlette.routing.websocket_session modified to include the
+# dependencies' AsyncExitStack
+def websocket_session(
+ func: Callable[[WebSocket], Awaitable[None]],
+) -> ASGIApp:
+ """
+ Takes a coroutine `func(session)`, and returns an ASGI application.
+ """
+ # assert asyncio.iscoroutinefunction(func), "WebSocket endpoints must be async"
+
+ async def app(scope: Scope, receive: Receive, send: Send) -> None:
+ session = WebSocket(scope, receive=receive, send=send)
+
+ async def app(scope: Scope, receive: Receive, send: Send) -> None:
+ async with AsyncExitStack() as request_stack:
+ scope["fastapi_inner_astack"] = request_stack
+ async with AsyncExitStack() as function_stack:
+ scope["fastapi_function_astack"] = function_stack
+ await func(session)
+
+ # Same as in Starlette
+ await wrap_app_handling_exceptions(app, session)(scope, receive, send)
+
+ return app
def _prepare_response_content(
@@ -115,10 +196,28 @@ def _prepare_response_content(
for k, v in res.items()
}
elif dataclasses.is_dataclass(res):
+ assert not isinstance(res, type)
return dataclasses.asdict(res)
return res
+def _merge_lifespan_context(
+ original_context: Lifespan[Any], nested_context: Lifespan[Any]
+) -> Lifespan[Any]:
+ @asynccontextmanager
+ async def merged_lifespan(
+ app: AppType,
+ ) -> AsyncIterator[Optional[Mapping[str, Any]]]:
+ async with original_context(app) as maybe_original_state:
+ async with nested_context(app) as maybe_nested_state:
+ if maybe_nested_state is None and maybe_original_state is None:
+ yield None # old ASGI compatibility
+ else:
+ yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}
+
+ return merged_lifespan # type: ignore[return-value]
+
+
async def serialize_response(
*,
field: Optional[ModelField] = None,
@@ -206,24 +305,32 @@ def get_request_handler(
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
dependency_overrides_provider: Optional[Any] = None,
+ embed_body_fields: bool = False,
) -> Callable[[Request], Coroutine[Any, Any, Response]]:
assert dependant.call is not None, "dependant.call must be a function"
- is_coroutine = asyncio.iscoroutinefunction(dependant.call)
- is_body_form = body_field and isinstance(body_field.field_info, params.Form)
+ is_coroutine = iscoroutinefunction(dependant.call)
+ is_body_form = body_field and isinstance(
+ body_field.field_info, (params.Form, temp_pydantic_v1_params.Form)
+ )
if isinstance(response_class, DefaultPlaceholder):
actual_response_class: Type[Response] = response_class.value
else:
actual_response_class = response_class
async def app(request: Request) -> Response:
+ response: Union[Response, None] = None
+ file_stack = request.scope.get("fastapi_middleware_astack")
+ assert isinstance(file_stack, AsyncExitStack), (
+ "fastapi_middleware_astack not found in request scope"
+ )
+
+ # Read body and auto-close files
try:
body: Any = None
if body_field:
if is_body_form:
body = await request.form()
- stack = request.scope.get("fastapi_astack")
- assert isinstance(stack, AsyncExitStack)
- stack.push_async_callback(body.close)
+ file_stack.push_async_callback(body.close)
else:
body_bytes = await request.body()
if body_bytes:
@@ -243,7 +350,7 @@ def get_request_handler(
else:
body = body_bytes
except json.JSONDecodeError as e:
- raise RequestValidationError(
+ validation_error = RequestValidationError(
[
{
"type": "json_invalid",
@@ -254,75 +361,106 @@ def get_request_handler(
}
],
body=e.doc,
- ) from e
+ )
+ raise validation_error from e
except HTTPException:
+ # If a middleware raises an HTTPException, it should be raised again
raise
except Exception as e:
- raise HTTPException(
+ http_error = HTTPException(
status_code=400, detail="There was an error parsing the body"
- ) from e
+ )
+ raise http_error from e
+
+ # Solve dependencies and run path operation function, auto-closing dependencies
+ errors: List[Any] = []
+ async_exit_stack = request.scope.get("fastapi_inner_astack")
+ assert isinstance(async_exit_stack, AsyncExitStack), (
+ "fastapi_inner_astack not found in request scope"
+ )
solved_result = await solve_dependencies(
request=request,
dependant=dependant,
body=body,
dependency_overrides_provider=dependency_overrides_provider,
+ async_exit_stack=async_exit_stack,
+ embed_body_fields=embed_body_fields,
)
- values, errors, background_tasks, sub_response, _ = solved_result
- if errors:
- raise RequestValidationError(_normalize_errors(errors), body=body)
- else:
+ errors = solved_result.errors
+ if not errors:
raw_response = await run_endpoint_function(
- dependant=dependant, values=values, is_coroutine=is_coroutine
- )
-
- if isinstance(raw_response, Response):
- if raw_response.background is None:
- raw_response.background = background_tasks
- return raw_response
- response_args: Dict[str, Any] = {"background": background_tasks}
- # If status_code was set, use it, otherwise use the default from the
- # response class, in the case of redirect it's 307
- current_status_code = (
- status_code if status_code else sub_response.status_code
- )
- if current_status_code is not None:
- response_args["status_code"] = current_status_code
- if sub_response.status_code:
- response_args["status_code"] = sub_response.status_code
- content = await serialize_response(
- field=response_field,
- response_content=raw_response,
- include=response_model_include,
- exclude=response_model_exclude,
- by_alias=response_model_by_alias,
- exclude_unset=response_model_exclude_unset,
- exclude_defaults=response_model_exclude_defaults,
- exclude_none=response_model_exclude_none,
+ dependant=dependant,
+ values=solved_result.values,
is_coroutine=is_coroutine,
)
- response = actual_response_class(content, **response_args)
- if not is_body_allowed_for_status_code(response.status_code):
- response.body = b""
- response.headers.raw.extend(sub_response.headers.raw)
- return response
+ if isinstance(raw_response, Response):
+ if raw_response.background is None:
+ raw_response.background = solved_result.background_tasks
+ response = raw_response
+ else:
+ response_args: Dict[str, Any] = {
+ "background": solved_result.background_tasks
+ }
+ # If status_code was set, use it, otherwise use the default from the
+ # response class, in the case of redirect it's 307
+ current_status_code = (
+ status_code if status_code else solved_result.response.status_code
+ )
+ if current_status_code is not None:
+ response_args["status_code"] = current_status_code
+ if solved_result.response.status_code:
+ response_args["status_code"] = solved_result.response.status_code
+ content = await serialize_response(
+ field=response_field,
+ response_content=raw_response,
+ include=response_model_include,
+ exclude=response_model_exclude,
+ by_alias=response_model_by_alias,
+ exclude_unset=response_model_exclude_unset,
+ exclude_defaults=response_model_exclude_defaults,
+ exclude_none=response_model_exclude_none,
+ is_coroutine=is_coroutine,
+ )
+ response = actual_response_class(content, **response_args)
+ if not is_body_allowed_for_status_code(response.status_code):
+ response.body = b""
+ response.headers.raw.extend(solved_result.response.headers.raw)
+ if errors:
+ validation_error = RequestValidationError(
+ _normalize_errors(errors), body=body
+ )
+ raise validation_error
+
+ # Return response
+ assert response
+ return response
return app
def get_websocket_app(
- dependant: Dependant, dependency_overrides_provider: Optional[Any] = None
+ dependant: Dependant,
+ dependency_overrides_provider: Optional[Any] = None,
+ embed_body_fields: bool = False,
) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:
async def app(websocket: WebSocket) -> None:
+ async_exit_stack = websocket.scope.get("fastapi_inner_astack")
+ assert isinstance(async_exit_stack, AsyncExitStack), (
+ "fastapi_inner_astack not found in request scope"
+ )
solved_result = await solve_dependencies(
request=websocket,
dependant=dependant,
dependency_overrides_provider=dependency_overrides_provider,
+ async_exit_stack=async_exit_stack,
+ embed_body_fields=embed_body_fields,
)
- values, errors, _, _2, _3 = solved_result
- if errors:
- raise WebSocketRequestValidationError(_normalize_errors(errors))
+ if solved_result.errors:
+ raise WebSocketRequestValidationError(
+ _normalize_errors(solved_result.errors)
+ )
assert dependant.call is not None, "dependant.call must be a function"
- await dependant.call(**values)
+ await dependant.call(**solved_result.values)
return app
@@ -342,17 +480,23 @@ class APIWebSocketRoute(routing.WebSocketRoute):
self.name = get_name(endpoint) if name is None else name
self.dependencies = list(dependencies or [])
self.path_regex, self.path_format, self.param_convertors = compile_path(path)
- self.dependant = get_dependant(path=self.path_format, call=self.endpoint)
+ self.dependant = get_dependant(
+ path=self.path_format, call=self.endpoint, scope="function"
+ )
for depends in self.dependencies[::-1]:
self.dependant.dependencies.insert(
0,
get_parameterless_sub_dependant(depends=depends, path=self.path_format),
)
-
+ self._flat_dependant = get_flat_dependant(self.dependant)
+ self._embed_body_fields = _should_embed_body_fields(
+ self._flat_dependant.body_params
+ )
self.app = websocket_session(
get_websocket_app(
dependant=self.dependant,
dependency_overrides_provider=dependency_overrides_provider,
+ embed_body_fields=self._embed_body_fields,
)
)
@@ -431,9 +575,9 @@ class APIRoute(routing.Route):
methods = ["GET"]
self.methods: Set[str] = {method.upper() for method in methods}
if isinstance(generate_unique_id_function, DefaultPlaceholder):
- current_generate_unique_id: Callable[
- ["APIRoute"], str
- ] = generate_unique_id_function.value
+ current_generate_unique_id: Callable[[APIRoute], str] = (
+ generate_unique_id_function.value
+ )
else:
current_generate_unique_id = generate_unique_id_function
self.unique_id = self.operation_id or current_generate_unique_id(self)
@@ -442,11 +586,11 @@ class APIRoute(routing.Route):
status_code = int(status_code)
self.status_code = status_code
if self.response_model:
- assert is_body_allowed_for_status_code(
- status_code
- ), f"Status code {status_code} must not have a response body"
+ assert is_body_allowed_for_status_code(status_code), (
+ f"Status code {status_code} must not have a response body"
+ )
response_name = "Response_" + self.unique_id
- self.response_field = create_response_field(
+ self.response_field = create_model_field(
name=response_name,
type_=self.response_model,
mode="serialization",
@@ -459,9 +603,9 @@ class APIRoute(routing.Route):
# By being a new field, no inheritance will be passed as is. A new model
# will always be created.
# TODO: remove when deprecating Pydantic v1
- self.secure_cloned_response_field: Optional[
- ModelField
- ] = create_cloned_field(self.response_field)
+ self.secure_cloned_response_field: Optional[ModelField] = (
+ create_cloned_field(self.response_field)
+ )
else:
self.response_field = None # type: ignore
self.secure_cloned_response_field = None
@@ -475,11 +619,13 @@ class APIRoute(routing.Route):
assert isinstance(response, dict), "An additional response must be a dict"
model = response.get("model")
if model:
- assert is_body_allowed_for_status_code(
- additional_status_code
- ), f"Status code {additional_status_code} must not have a response body"
+ assert is_body_allowed_for_status_code(additional_status_code), (
+ f"Status code {additional_status_code} must not have a response body"
+ )
response_name = f"Response_{additional_status_code}_{self.unique_id}"
- response_field = create_response_field(name=response_name, type_=model)
+ response_field = create_model_field(
+ name=response_name, type_=model, mode="serialization"
+ )
response_fields[additional_status_code] = response_field
if response_fields:
self.response_fields: Dict[Union[int, str], ModelField] = response_fields
@@ -487,13 +633,23 @@ class APIRoute(routing.Route):
self.response_fields = {}
assert callable(endpoint), "An endpoint must be a callable"
- self.dependant = get_dependant(path=self.path_format, call=self.endpoint)
+ self.dependant = get_dependant(
+ path=self.path_format, call=self.endpoint, scope="function"
+ )
for depends in self.dependencies[::-1]:
self.dependant.dependencies.insert(
0,
get_parameterless_sub_dependant(depends=depends, path=self.path_format),
)
- self.body_field = get_body_field(dependant=self.dependant, name=self.unique_id)
+ self._flat_dependant = get_flat_dependant(self.dependant)
+ self._embed_body_fields = _should_embed_body_fields(
+ self._flat_dependant.body_params
+ )
+ self.body_field = get_body_field(
+ flat_dependant=self._flat_dependant,
+ name=self.unique_id,
+ embed_body_fields=self._embed_body_fields,
+ )
self.app = request_response(self.get_route_handler())
def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:
@@ -510,6 +666,7 @@ class APIRoute(routing.Route):
response_model_exclude_defaults=self.response_model_exclude_defaults,
response_model_exclude_none=self.response_model_exclude_none,
dependency_overrides_provider=self.dependency_overrides_provider,
+ embed_body_fields=self._embed_body_fields,
)
def matches(self, scope: Scope) -> Tuple[Match, Scope]:
@@ -741,7 +898,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -771,9 +928,9 @@ class APIRouter(routing.Router):
)
if prefix:
assert prefix.startswith("/"), "A path prefix must start with '/'"
- assert not prefix.endswith(
- "/"
- ), "A path prefix must not end with '/', as the routes will start with '/'"
+ assert not prefix.endswith("/"), (
+ "A path prefix must not end with '/', as the routes will start with '/'"
+ )
self.prefix = prefix
self.tags: List[Union[str, Enum]] = tags or []
self.dependencies = list(dependencies or [])
@@ -789,7 +946,7 @@ class APIRouter(routing.Router):
def route(
self,
path: str,
- methods: Optional[List[str]] = None,
+ methods: Optional[Collection[str]] = None,
name: Optional[str] = None,
include_in_schema: bool = True,
) -> Callable[[DecoratedCallable], DecoratedCallable]:
@@ -1183,9 +1340,9 @@ class APIRouter(routing.Router):
"""
if prefix:
assert prefix.startswith("/"), "A path prefix must start with '/'"
- assert not prefix.endswith(
- "/"
- ), "A path prefix must not end with '/', as the routes will start with '/'"
+ assert not prefix.endswith("/"), (
+ "A path prefix must not end with '/', as the routes will start with '/'"
+ )
else:
for r in router.routes:
path = getattr(r, "path") # noqa: B009
@@ -1285,6 +1442,10 @@ class APIRouter(routing.Router):
self.add_event_handler("startup", handler)
for handler in router.on_shutdown:
self.add_event_handler("shutdown", handler)
+ self.lifespan_context = _merge_lifespan_context(
+ self.lifespan_context,
+ router.lifespan_context,
+ )
def get(
self,
@@ -1549,7 +1710,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -1926,7 +2087,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -2308,7 +2469,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -2690,7 +2851,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -3067,7 +3228,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -3444,7 +3605,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -3826,7 +3987,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -4208,7 +4369,7 @@ class APIRouter(routing.Router):
This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
- [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).
"""
),
] = True,
@@ -4293,7 +4454,7 @@ class APIRouter(routing.Router):
app = FastAPI()
router = APIRouter()
- @router.put("/items/{item_id}")
+ @router.trace("/items/{item_id}")
def trace_item(item_id: str):
return None
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/__init__.cpython-312.pyc
index 57a09b74..9565cd3f 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/api_key.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/api_key.cpython-312.pyc
index f4717924..6b9226cf 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/api_key.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/api_key.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/base.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/base.cpython-312.pyc
index 484fa801..794b94bf 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/base.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/base.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/http.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/http.cpython-312.pyc
index f2c35eb3..d07cc9a8 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/http.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/http.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/oauth2.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/oauth2.cpython-312.pyc
index d6a02e4c..8594d7c5 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/oauth2.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/oauth2.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/open_id_connect_url.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/open_id_connect_url.cpython-312.pyc
index e8de984c..def1976c 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/open_id_connect_url.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/open_id_connect_url.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/utils.cpython-312.pyc
index ba1b8f93..99a6ecb1 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/utils.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/fastapi/security/__pycache__/utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/api_key.py b/Backend/venv/lib/python3.12/site-packages/fastapi/security/api_key.py
index b1a6b4f9..81c7be10 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/security/api_key.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/security/api_key.py
@@ -1,15 +1,54 @@
-from typing import Optional
+from typing import Optional, Union
+from annotated_doc import Doc
from fastapi.openapi.models import APIKey, APIKeyIn
from fastapi.security.base import SecurityBase
from starlette.exceptions import HTTPException
from starlette.requests import Request
-from starlette.status import HTTP_403_FORBIDDEN
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from starlette.status import HTTP_401_UNAUTHORIZED
+from typing_extensions import Annotated
class APIKeyBase(SecurityBase):
- pass
+ def __init__(
+ self,
+ location: APIKeyIn,
+ name: str,
+ description: Union[str, None],
+ scheme_name: Union[str, None],
+ auto_error: bool,
+ ):
+ self.auto_error = auto_error
+
+ self.model: APIKey = APIKey(
+ **{"in": location},
+ name=name,
+ description=description,
+ )
+ self.scheme_name = scheme_name or self.__class__.__name__
+
+ def make_not_authenticated_error(self) -> HTTPException:
+ """
+ The WWW-Authenticate header is not standardized for API Key authentication but
+ the HTTP specification requires that an error of 401 "Unauthorized" must
+ include a WWW-Authenticate header.
+
+ Ref: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+
+ For this, this method sends a custom challenge `APIKey`.
+ """
+ return HTTPException(
+ status_code=HTTP_401_UNAUTHORIZED,
+ detail="Not authenticated",
+ headers={"WWW-Authenticate": "APIKey"},
+ )
+
+ def check_api_key(self, api_key: Optional[str]) -> Optional[str]:
+ if not api_key:
+ if self.auto_error:
+ raise self.make_not_authenticated_error()
+ return None
+ return api_key
class APIKeyQuery(APIKeyBase):
@@ -76,7 +115,7 @@ class APIKeyQuery(APIKeyBase):
Doc(
"""
By default, if the query parameter is not provided, `APIKeyQuery` will
- automatically cancel the request and sebd the client an error.
+ automatically cancel the request and send the client an error.
If `auto_error` is set to `False`, when the query parameter is not
available, instead of erroring out, the dependency result will be
@@ -91,24 +130,17 @@ class APIKeyQuery(APIKeyBase):
),
] = True,
):
- self.model: APIKey = APIKey(
- **{"in": APIKeyIn.query}, # type: ignore[arg-type]
+ super().__init__(
+ location=APIKeyIn.query,
name=name,
+ scheme_name=scheme_name,
description=description,
+ auto_error=auto_error,
)
- self.scheme_name = scheme_name or self.__class__.__name__
- self.auto_error = auto_error
async def __call__(self, request: Request) -> Optional[str]:
api_key = request.query_params.get(self.model.name)
- if not api_key:
- if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
- else:
- return None
- return api_key
+ return self.check_api_key(api_key)
class APIKeyHeader(APIKeyBase):
@@ -186,24 +218,17 @@ class APIKeyHeader(APIKeyBase):
),
] = True,
):
- self.model: APIKey = APIKey(
- **{"in": APIKeyIn.header}, # type: ignore[arg-type]
+ super().__init__(
+ location=APIKeyIn.header,
name=name,
+ scheme_name=scheme_name,
description=description,
+ auto_error=auto_error,
)
- self.scheme_name = scheme_name or self.__class__.__name__
- self.auto_error = auto_error
async def __call__(self, request: Request) -> Optional[str]:
api_key = request.headers.get(self.model.name)
- if not api_key:
- if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
- else:
- return None
- return api_key
+ return self.check_api_key(api_key)
class APIKeyCookie(APIKeyBase):
@@ -281,21 +306,14 @@ class APIKeyCookie(APIKeyBase):
),
] = True,
):
- self.model: APIKey = APIKey(
- **{"in": APIKeyIn.cookie}, # type: ignore[arg-type]
+ super().__init__(
+ location=APIKeyIn.cookie,
name=name,
+ scheme_name=scheme_name,
description=description,
+ auto_error=auto_error,
)
- self.scheme_name = scheme_name or self.__class__.__name__
- self.auto_error = auto_error
async def __call__(self, request: Request) -> Optional[str]:
api_key = request.cookies.get(self.model.name)
- if not api_key:
- if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
- else:
- return None
- return api_key
+ return self.check_api_key(api_key)
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/http.py b/Backend/venv/lib/python3.12/site-packages/fastapi/security/http.py
index 738455de..0d1bbba3 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/security/http.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/security/http.py
@@ -1,7 +1,8 @@
import binascii
from base64 import b64decode
-from typing import Optional
+from typing import Dict, Optional
+from annotated_doc import Doc
from fastapi.exceptions import HTTPException
from fastapi.openapi.models import HTTPBase as HTTPBaseModel
from fastapi.openapi.models import HTTPBearer as HTTPBearerModel
@@ -9,13 +10,13 @@ from fastapi.security.base import SecurityBase
from fastapi.security.utils import get_authorization_scheme_param
from pydantic import BaseModel
from starlette.requests import Request
-from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from starlette.status import HTTP_401_UNAUTHORIZED
+from typing_extensions import Annotated
class HTTPBasicCredentials(BaseModel):
"""
- The HTTP Basic credendials given as the result of using `HTTPBasic` in a
+ The HTTP Basic credentials given as the result of using `HTTPBasic` in a
dependency.
Read more about it in the
@@ -75,10 +76,22 @@ class HTTPBase(SecurityBase):
description: Optional[str] = None,
auto_error: bool = True,
):
- self.model = HTTPBaseModel(scheme=scheme, description=description)
+ self.model: HTTPBaseModel = HTTPBaseModel(
+ scheme=scheme, description=description
+ )
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
+ def make_authenticate_headers(self) -> Dict[str, str]:
+ return {"WWW-Authenticate": f"{self.model.scheme.title()}"}
+
+ def make_not_authenticated_error(self) -> HTTPException:
+ return HTTPException(
+ status_code=HTTP_401_UNAUTHORIZED,
+ detail="Not authenticated",
+ headers=self.make_authenticate_headers(),
+ )
+
async def __call__(
self, request: Request
) -> Optional[HTTPAuthorizationCredentials]:
@@ -86,9 +99,7 @@ class HTTPBase(SecurityBase):
scheme, credentials = get_authorization_scheme_param(authorization)
if not (authorization and scheme and credentials):
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
+ raise self.make_not_authenticated_error()
else:
return None
return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)
@@ -98,6 +109,8 @@ class HTTPBasic(HTTPBase):
"""
HTTP Basic authentication.
+ Ref: https://datatracker.ietf.org/doc/html/rfc7617
+
## Usage
Create an instance object and use that object as the dependency in `Depends()`.
@@ -184,36 +197,28 @@ class HTTPBasic(HTTPBase):
self.realm = realm
self.auto_error = auto_error
+ def make_authenticate_headers(self) -> Dict[str, str]:
+ if self.realm:
+ return {"WWW-Authenticate": f'Basic realm="{self.realm}"'}
+ return {"WWW-Authenticate": "Basic"}
+
async def __call__( # type: ignore
self, request: Request
) -> Optional[HTTPBasicCredentials]:
authorization = request.headers.get("Authorization")
scheme, param = get_authorization_scheme_param(authorization)
- if self.realm:
- unauthorized_headers = {"WWW-Authenticate": f'Basic realm="{self.realm}"'}
- else:
- unauthorized_headers = {"WWW-Authenticate": "Basic"}
if not authorization or scheme.lower() != "basic":
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_401_UNAUTHORIZED,
- detail="Not authenticated",
- headers=unauthorized_headers,
- )
+ raise self.make_not_authenticated_error()
else:
return None
- invalid_user_credentials_exc = HTTPException(
- status_code=HTTP_401_UNAUTHORIZED,
- detail="Invalid authentication credentials",
- headers=unauthorized_headers,
- )
try:
data = b64decode(param).decode("ascii")
- except (ValueError, UnicodeDecodeError, binascii.Error):
- raise invalid_user_credentials_exc # noqa: B904
+ except (ValueError, UnicodeDecodeError, binascii.Error) as e:
+ raise self.make_not_authenticated_error() from e
username, separator, password = data.partition(":")
if not separator:
- raise invalid_user_credentials_exc
+ raise self.make_not_authenticated_error()
return HTTPBasicCredentials(username=username, password=password)
@@ -277,7 +282,7 @@ class HTTPBearer(HTTPBase):
bool,
Doc(
"""
- By default, if the HTTP Bearer token not provided (in an
+ By default, if the HTTP Bearer token is not provided (in an
`Authorization` header), `HTTPBearer` will automatically cancel the
request and send the client an error.
@@ -305,17 +310,12 @@ class HTTPBearer(HTTPBase):
scheme, credentials = get_authorization_scheme_param(authorization)
if not (authorization and scheme and credentials):
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
+ raise self.make_not_authenticated_error()
else:
return None
if scheme.lower() != "bearer":
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN,
- detail="Invalid authentication credentials",
- )
+ raise self.make_not_authenticated_error()
else:
return None
return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)
@@ -325,6 +325,12 @@ class HTTPDigest(HTTPBase):
"""
HTTP Digest authentication.
+ **Warning**: this is only a stub to connect the components with OpenAPI in FastAPI,
+ but it doesn't implement the full Digest scheme, you would need to to subclass it
+ and implement it in your code.
+
+ Ref: https://datatracker.ietf.org/doc/html/rfc7616
+
## Usage
Create an instance object and use that object as the dependency in `Depends()`.
@@ -380,7 +386,7 @@ class HTTPDigest(HTTPBase):
bool,
Doc(
"""
- By default, if the HTTP Digest not provided, `HTTPDigest` will
+ By default, if the HTTP Digest is not provided, `HTTPDigest` will
automatically cancel the request and send the client an error.
If `auto_error` is set to `False`, when the HTTP Digest is not
@@ -407,14 +413,12 @@ class HTTPDigest(HTTPBase):
scheme, credentials = get_authorization_scheme_param(authorization)
if not (authorization and scheme and credentials):
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
+ raise self.make_not_authenticated_error()
else:
return None
if scheme.lower() != "digest":
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN,
- detail="Invalid authentication credentials",
- )
+ if self.auto_error:
+ raise self.make_not_authenticated_error()
+ else:
+ return None
return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/oauth2.py b/Backend/venv/lib/python3.12/site-packages/fastapi/security/oauth2.py
index 9281dfb6..b41b0f87 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/security/oauth2.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/security/oauth2.py
@@ -1,5 +1,6 @@
from typing import Any, Dict, List, Optional, Union, cast
+from annotated_doc import Doc
from fastapi.exceptions import HTTPException
from fastapi.openapi.models import OAuth2 as OAuth2Model
from fastapi.openapi.models import OAuthFlows as OAuthFlowsModel
@@ -7,10 +8,10 @@ from fastapi.param_functions import Form
from fastapi.security.base import SecurityBase
from fastapi.security.utils import get_authorization_scheme_param
from starlette.requests import Request
-from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN
+from starlette.status import HTTP_401_UNAUTHORIZED
# TODO: import from typing when deprecating Python 3.9
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from typing_extensions import Annotated
class OAuth2PasswordRequestForm:
@@ -52,9 +53,9 @@ class OAuth2PasswordRequestForm:
```
Note that for OAuth2 the scope `items:read` is a single scope in an opaque string.
- You could have custom internal logic to separate it by colon caracters (`:`) or
+ You could have custom internal logic to separate it by colon characters (`:`) or
similar, and get the two parts `items` and `read`. Many applications do that to
- group and organize permisions, you could do it as well in your application, just
+ group and organize permissions, you could do it as well in your application, just
know that that it is application specific, it's not part of the specification.
"""
@@ -63,7 +64,7 @@ class OAuth2PasswordRequestForm:
*,
grant_type: Annotated[
Union[str, None],
- Form(pattern="password"),
+ Form(pattern="^password$"),
Doc(
"""
The OAuth2 spec says it is required and MUST be the fixed string
@@ -85,11 +86,11 @@ class OAuth2PasswordRequestForm:
],
password: Annotated[
str,
- Form(),
+ Form(json_schema_extra={"format": "password"}),
Doc(
"""
`password` string. The OAuth2 spec requires the exact field name
- `password".
+ `password`.
"""
),
],
@@ -130,7 +131,7 @@ class OAuth2PasswordRequestForm:
] = None,
client_secret: Annotated[
Union[str, None],
- Form(),
+ Form(json_schema_extra={"format": "password"}),
Doc(
"""
If there's a `client_password` (and a `client_id`), they can be sent
@@ -194,9 +195,9 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
```
Note that for OAuth2 the scope `items:read` is a single scope in an opaque string.
- You could have custom internal logic to separate it by colon caracters (`:`) or
+ You could have custom internal logic to separate it by colon characters (`:`) or
similar, and get the two parts `items` and `read`. Many applications do that to
- group and organize permisions, you could do it as well in your application, just
+ group and organize permissions, you could do it as well in your application, just
know that that it is application specific, it's not part of the specification.
@@ -217,7 +218,7 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
self,
grant_type: Annotated[
str,
- Form(pattern="password"),
+ Form(pattern="^password$"),
Doc(
"""
The OAuth2 spec says it is required and MUST be the fixed string
@@ -243,7 +244,7 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
Doc(
"""
`password` string. The OAuth2 spec requires the exact field name
- `password".
+ `password`.
"""
),
],
@@ -353,7 +354,7 @@ class OAuth2(SecurityBase):
bool,
Doc(
"""
- By default, if no HTTP Auhtorization header is provided, required for
+ By default, if no HTTP Authorization header is provided, required for
OAuth2 authentication, it will automatically cancel the request and
send the client an error.
@@ -376,13 +377,33 @@ class OAuth2(SecurityBase):
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
+ def make_not_authenticated_error(self) -> HTTPException:
+ """
+ The OAuth 2 specification doesn't define the challenge that should be used,
+ because a `Bearer` token is not really the only option to authenticate.
+
+ But declaring any other authentication challenge would be application-specific
+ as it's not defined in the specification.
+
+ For practical reasons, this method uses the `Bearer` challenge by default, as
+ it's probably the most common one.
+
+ If you are implementing an OAuth2 authentication scheme other than the provided
+ ones in FastAPI (based on bearer tokens), you might want to override this.
+
+ Ref: https://datatracker.ietf.org/doc/html/rfc6749
+ """
+ return HTTPException(
+ status_code=HTTP_401_UNAUTHORIZED,
+ detail="Not authenticated",
+ headers={"WWW-Authenticate": "Bearer"},
+ )
+
async def __call__(self, request: Request) -> Optional[str]:
authorization = request.headers.get("Authorization")
if not authorization:
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
+ raise self.make_not_authenticated_error()
else:
return None
return authorization
@@ -441,7 +462,7 @@ class OAuth2PasswordBearer(OAuth2):
bool,
Doc(
"""
- By default, if no HTTP Auhtorization header is provided, required for
+ By default, if no HTTP Authorization header is provided, required for
OAuth2 authentication, it will automatically cancel the request and
send the client an error.
@@ -457,11 +478,26 @@ class OAuth2PasswordBearer(OAuth2):
"""
),
] = True,
+ refreshUrl: Annotated[
+ Optional[str],
+ Doc(
+ """
+ The URL to refresh the token and obtain a new one.
+ """
+ ),
+ ] = None,
):
if not scopes:
scopes = {}
flows = OAuthFlowsModel(
- password=cast(Any, {"tokenUrl": tokenUrl, "scopes": scopes})
+ password=cast(
+ Any,
+ {
+ "tokenUrl": tokenUrl,
+ "refreshUrl": refreshUrl,
+ "scopes": scopes,
+ },
+ )
)
super().__init__(
flows=flows,
@@ -475,11 +511,7 @@ class OAuth2PasswordBearer(OAuth2):
scheme, param = get_authorization_scheme_param(authorization)
if not authorization or scheme.lower() != "bearer":
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_401_UNAUTHORIZED,
- detail="Not authenticated",
- headers={"WWW-Authenticate": "Bearer"},
- )
+ raise self.make_not_authenticated_error()
else:
return None
return param
@@ -543,7 +575,7 @@ class OAuth2AuthorizationCodeBearer(OAuth2):
bool,
Doc(
"""
- By default, if no HTTP Auhtorization header is provided, required for
+ By default, if no HTTP Authorization header is provided, required for
OAuth2 authentication, it will automatically cancel the request and
send the client an error.
@@ -585,11 +617,7 @@ class OAuth2AuthorizationCodeBearer(OAuth2):
scheme, param = get_authorization_scheme_param(authorization)
if not authorization or scheme.lower() != "bearer":
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_401_UNAUTHORIZED,
- detail="Not authenticated",
- headers={"WWW-Authenticate": "Bearer"},
- )
+ raise self.make_not_authenticated_error()
else:
return None # pragma: nocover
return param
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/security/open_id_connect_url.py b/Backend/venv/lib/python3.12/site-packages/fastapi/security/open_id_connect_url.py
index c612b475..e574a56a 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/security/open_id_connect_url.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/security/open_id_connect_url.py
@@ -1,17 +1,23 @@
from typing import Optional
+from annotated_doc import Doc
from fastapi.openapi.models import OpenIdConnect as OpenIdConnectModel
from fastapi.security.base import SecurityBase
from starlette.exceptions import HTTPException
from starlette.requests import Request
-from starlette.status import HTTP_403_FORBIDDEN
-from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
+from starlette.status import HTTP_401_UNAUTHORIZED
+from typing_extensions import Annotated
class OpenIdConnect(SecurityBase):
"""
OpenID Connect authentication class. An instance of it would be used as a
dependency.
+
+ **Warning**: this is only a stub to connect the components with OpenAPI in FastAPI,
+ but it doesn't implement the full OpenIdConnect scheme, for example, it doesn't use
+ the OpenIDConnect URL. You would need to to subclass it and implement it in your
+ code.
"""
def __init__(
@@ -49,7 +55,7 @@ class OpenIdConnect(SecurityBase):
bool,
Doc(
"""
- By default, if no HTTP Auhtorization header is provided, required for
+ By default, if no HTTP Authorization header is provided, required for
OpenID Connect authentication, it will automatically cancel the request
and send the client an error.
@@ -72,13 +78,18 @@ class OpenIdConnect(SecurityBase):
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
+ def make_not_authenticated_error(self) -> HTTPException:
+ return HTTPException(
+ status_code=HTTP_401_UNAUTHORIZED,
+ detail="Not authenticated",
+ headers={"WWW-Authenticate": "Bearer"},
+ )
+
async def __call__(self, request: Request) -> Optional[str]:
authorization = request.headers.get("Authorization")
if not authorization:
if self.auto_error:
- raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
- )
+ raise self.make_not_authenticated_error()
else:
return None
return authorization
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/temp_pydantic_v1_params.py b/Backend/venv/lib/python3.12/site-packages/fastapi/temp_pydantic_v1_params.py
new file mode 100644
index 00000000..e41d7123
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/temp_pydantic_v1_params.py
@@ -0,0 +1,724 @@
+import warnings
+from typing import Any, Callable, Dict, List, Optional, Union
+
+from fastapi.openapi.models import Example
+from fastapi.params import ParamTypes
+from typing_extensions import Annotated, deprecated
+
+from ._compat.may_v1 import FieldInfo, Undefined
+from ._compat.shared import PYDANTIC_VERSION_MINOR_TUPLE
+
+_Unset: Any = Undefined
+
+
+class Param(FieldInfo): # type: ignore[misc]
+ in_: ParamTypes
+
+ def __init__(
+ self,
+ default: Any = Undefined,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ if example is not _Unset:
+ warnings.warn(
+ "`example` has been deprecated, please use `examples` instead",
+ category=DeprecationWarning,
+ stacklevel=4,
+ )
+ self.example = example
+ self.include_in_schema = include_in_schema
+ self.openapi_examples = openapi_examples
+ kwargs = dict(
+ default=default,
+ default_factory=default_factory,
+ alias=alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ discriminator=discriminator,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ **extra,
+ )
+ if examples is not None:
+ kwargs["examples"] = examples
+ if regex is not None:
+ warnings.warn(
+ "`regex` has been deprecated, please use `pattern` instead",
+ category=DeprecationWarning,
+ stacklevel=4,
+ )
+ current_json_schema_extra = json_schema_extra or extra
+ if PYDANTIC_VERSION_MINOR_TUPLE < (2, 7):
+ self.deprecated = deprecated
+ else:
+ kwargs["deprecated"] = deprecated
+ kwargs["regex"] = pattern or regex
+ kwargs.update(**current_json_schema_extra)
+ use_kwargs = {k: v for k, v in kwargs.items() if v is not _Unset}
+
+ super().__init__(**use_kwargs)
+
+ def __repr__(self) -> str:
+ return f"{self.__class__.__name__}({self.default})"
+
+
+class Path(Param): # type: ignore[misc]
+ in_ = ParamTypes.path
+
+ def __init__(
+ self,
+ default: Any = ...,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ assert default is ..., "Path parameters cannot have a default value"
+ self.in_ = self.in_
+ super().__init__(
+ default=default,
+ default_factory=default_factory,
+ annotation=annotation,
+ alias=alias,
+ alias_priority=alias_priority,
+ validation_alias=validation_alias,
+ serialization_alias=serialization_alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ pattern=pattern,
+ regex=regex,
+ discriminator=discriminator,
+ strict=strict,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ deprecated=deprecated,
+ example=example,
+ examples=examples,
+ openapi_examples=openapi_examples,
+ include_in_schema=include_in_schema,
+ json_schema_extra=json_schema_extra,
+ **extra,
+ )
+
+
+class Query(Param): # type: ignore[misc]
+ in_ = ParamTypes.query
+
+ def __init__(
+ self,
+ default: Any = Undefined,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ super().__init__(
+ default=default,
+ default_factory=default_factory,
+ annotation=annotation,
+ alias=alias,
+ alias_priority=alias_priority,
+ validation_alias=validation_alias,
+ serialization_alias=serialization_alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ pattern=pattern,
+ regex=regex,
+ discriminator=discriminator,
+ strict=strict,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ deprecated=deprecated,
+ example=example,
+ examples=examples,
+ openapi_examples=openapi_examples,
+ include_in_schema=include_in_schema,
+ json_schema_extra=json_schema_extra,
+ **extra,
+ )
+
+
+class Header(Param): # type: ignore[misc]
+ in_ = ParamTypes.header
+
+ def __init__(
+ self,
+ default: Any = Undefined,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ convert_underscores: bool = True,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ self.convert_underscores = convert_underscores
+ super().__init__(
+ default=default,
+ default_factory=default_factory,
+ annotation=annotation,
+ alias=alias,
+ alias_priority=alias_priority,
+ validation_alias=validation_alias,
+ serialization_alias=serialization_alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ pattern=pattern,
+ regex=regex,
+ discriminator=discriminator,
+ strict=strict,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ deprecated=deprecated,
+ example=example,
+ examples=examples,
+ openapi_examples=openapi_examples,
+ include_in_schema=include_in_schema,
+ json_schema_extra=json_schema_extra,
+ **extra,
+ )
+
+
+class Cookie(Param): # type: ignore[misc]
+ in_ = ParamTypes.cookie
+
+ def __init__(
+ self,
+ default: Any = Undefined,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ super().__init__(
+ default=default,
+ default_factory=default_factory,
+ annotation=annotation,
+ alias=alias,
+ alias_priority=alias_priority,
+ validation_alias=validation_alias,
+ serialization_alias=serialization_alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ pattern=pattern,
+ regex=regex,
+ discriminator=discriminator,
+ strict=strict,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ deprecated=deprecated,
+ example=example,
+ examples=examples,
+ openapi_examples=openapi_examples,
+ include_in_schema=include_in_schema,
+ json_schema_extra=json_schema_extra,
+ **extra,
+ )
+
+
+class Body(FieldInfo): # type: ignore[misc]
+ def __init__(
+ self,
+ default: Any = Undefined,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ embed: Union[bool, None] = None,
+ media_type: str = "application/json",
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ self.embed = embed
+ self.media_type = media_type
+ if example is not _Unset:
+ warnings.warn(
+ "`example` has been deprecated, please use `examples` instead",
+ category=DeprecationWarning,
+ stacklevel=4,
+ )
+ self.example = example
+ self.include_in_schema = include_in_schema
+ self.openapi_examples = openapi_examples
+ kwargs = dict(
+ default=default,
+ default_factory=default_factory,
+ alias=alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ discriminator=discriminator,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ **extra,
+ )
+ if examples is not None:
+ kwargs["examples"] = examples
+ if regex is not None:
+ warnings.warn(
+ "`regex` has been deprecated, please use `pattern` instead",
+ category=DeprecationWarning,
+ stacklevel=4,
+ )
+ current_json_schema_extra = json_schema_extra or extra
+ if PYDANTIC_VERSION_MINOR_TUPLE < (2, 7):
+ self.deprecated = deprecated
+ else:
+ kwargs["deprecated"] = deprecated
+ kwargs["regex"] = pattern or regex
+ kwargs.update(**current_json_schema_extra)
+
+ use_kwargs = {k: v for k, v in kwargs.items() if v is not _Unset}
+
+ super().__init__(**use_kwargs)
+
+ def __repr__(self) -> str:
+ return f"{self.__class__.__name__}({self.default})"
+
+
+class Form(Body): # type: ignore[misc]
+ def __init__(
+ self,
+ default: Any = Undefined,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ media_type: str = "application/x-www-form-urlencoded",
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ super().__init__(
+ default=default,
+ default_factory=default_factory,
+ annotation=annotation,
+ media_type=media_type,
+ alias=alias,
+ alias_priority=alias_priority,
+ validation_alias=validation_alias,
+ serialization_alias=serialization_alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ pattern=pattern,
+ regex=regex,
+ discriminator=discriminator,
+ strict=strict,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ deprecated=deprecated,
+ example=example,
+ examples=examples,
+ openapi_examples=openapi_examples,
+ include_in_schema=include_in_schema,
+ json_schema_extra=json_schema_extra,
+ **extra,
+ )
+
+
+class File(Form): # type: ignore[misc]
+ def __init__(
+ self,
+ default: Any = Undefined,
+ *,
+ default_factory: Union[Callable[[], Any], None] = _Unset,
+ annotation: Optional[Any] = None,
+ media_type: str = "multipart/form-data",
+ alias: Optional[str] = None,
+ alias_priority: Union[int, None] = _Unset,
+ # TODO: update when deprecating Pydantic v1, import these types
+ # validation_alias: str | AliasPath | AliasChoices | None
+ validation_alias: Union[str, None] = None,
+ serialization_alias: Union[str, None] = None,
+ title: Optional[str] = None,
+ description: Optional[str] = None,
+ gt: Optional[float] = None,
+ ge: Optional[float] = None,
+ lt: Optional[float] = None,
+ le: Optional[float] = None,
+ min_length: Optional[int] = None,
+ max_length: Optional[int] = None,
+ pattern: Optional[str] = None,
+ regex: Annotated[
+ Optional[str],
+ deprecated(
+ "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
+ ),
+ ] = None,
+ discriminator: Union[str, None] = None,
+ strict: Union[bool, None] = _Unset,
+ multiple_of: Union[float, None] = _Unset,
+ allow_inf_nan: Union[bool, None] = _Unset,
+ max_digits: Union[int, None] = _Unset,
+ decimal_places: Union[int, None] = _Unset,
+ examples: Optional[List[Any]] = None,
+ example: Annotated[
+ Optional[Any],
+ deprecated(
+ "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
+ "although still supported. Use examples instead."
+ ),
+ ] = _Unset,
+ openapi_examples: Optional[Dict[str, Example]] = None,
+ deprecated: Union[deprecated, str, bool, None] = None,
+ include_in_schema: bool = True,
+ json_schema_extra: Union[Dict[str, Any], None] = None,
+ **extra: Any,
+ ):
+ super().__init__(
+ default=default,
+ default_factory=default_factory,
+ annotation=annotation,
+ media_type=media_type,
+ alias=alias,
+ alias_priority=alias_priority,
+ validation_alias=validation_alias,
+ serialization_alias=serialization_alias,
+ title=title,
+ description=description,
+ gt=gt,
+ ge=ge,
+ lt=lt,
+ le=le,
+ min_length=min_length,
+ max_length=max_length,
+ pattern=pattern,
+ regex=regex,
+ discriminator=discriminator,
+ strict=strict,
+ multiple_of=multiple_of,
+ allow_inf_nan=allow_inf_nan,
+ max_digits=max_digits,
+ decimal_places=decimal_places,
+ deprecated=deprecated,
+ example=example,
+ examples=examples,
+ openapi_examples=openapi_examples,
+ include_in_schema=include_in_schema,
+ json_schema_extra=json_schema_extra,
+ **extra,
+ )
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/types.py b/Backend/venv/lib/python3.12/site-packages/fastapi/types.py
index 7adf565a..3f4e81a7 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/types.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/types.py
@@ -1,11 +1,11 @@
import types
from enum import Enum
-from typing import Any, Callable, Dict, Set, Type, TypeVar, Union
+from typing import Any, Callable, Dict, Optional, Set, Tuple, Type, TypeVar, Union
from pydantic import BaseModel
DecoratedCallable = TypeVar("DecoratedCallable", bound=Callable[..., Any])
UnionType = getattr(types, "UnionType", Union)
-NoneType = getattr(types, "UnionType", None)
ModelNameMap = Dict[Union[Type[BaseModel], Type[Enum]], str]
IncEx = Union[Set[int], Set[str], Dict[int, Any], Dict[str, Any]]
+DependencyCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...], str]
diff --git a/Backend/venv/lib/python3.12/site-packages/fastapi/utils.py b/Backend/venv/lib/python3.12/site-packages/fastapi/utils.py
index f8463dda..2e79ee6b 100644
--- a/Backend/venv/lib/python3.12/site-packages/fastapi/utils.py
+++ b/Backend/venv/lib/python3.12/site-packages/fastapi/utils.py
@@ -23,10 +23,12 @@ from fastapi._compat import (
Undefined,
UndefinedType,
Validator,
+ annotation_is_pydantic_v1,
lenient_issubclass,
+ may_v1,
)
from fastapi.datastructures import DefaultPlaceholder, DefaultType
-from pydantic import BaseModel, create_model
+from pydantic import BaseModel
from pydantic.fields import FieldInfo
from typing_extensions import Literal
@@ -34,9 +36,9 @@ if TYPE_CHECKING: # pragma: nocover
from .routing import APIRoute
# Cache for `create_cloned_field`
-_CLONED_TYPES_CACHE: MutableMapping[
- Type[BaseModel], Type[BaseModel]
-] = WeakKeyDictionary()
+_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (
+ WeakKeyDictionary()
+)
def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:
@@ -53,60 +55,81 @@ def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:
}:
return True
current_status_code = int(status_code)
- return not (current_status_code < 200 or current_status_code in {204, 304})
+ return not (current_status_code < 200 or current_status_code in {204, 205, 304})
def get_path_param_names(path: str) -> Set[str]:
return set(re.findall("{(.*?)}", path))
-def create_response_field(
+_invalid_args_message = (
+ "Invalid args for response field! Hint: "
+ "check that {type_} is a valid Pydantic field type. "
+ "If you are using a return type annotation that is not a valid Pydantic "
+ "field (e.g. Union[Response, dict, None]) you can disable generating the "
+ "response model from the type annotation with the path operation decorator "
+ "parameter response_model=None. Read more: "
+ "https://fastapi.tiangolo.com/tutorial/response-model/"
+)
+
+
+def create_model_field(
name: str,
- type_: Type[Any],
+ type_: Any,
class_validators: Optional[Dict[str, Validator]] = None,
default: Optional[Any] = Undefined,
required: Union[bool, UndefinedType] = Undefined,
- model_config: Type[BaseConfig] = BaseConfig,
+ model_config: Union[Type[BaseConfig], None] = None,
field_info: Optional[FieldInfo] = None,
alias: Optional[str] = None,
mode: Literal["validation", "serialization"] = "validation",
+ version: Literal["1", "auto"] = "auto",
) -> ModelField:
- """
- Create a new response field. Raises if type_ is invalid.
- """
class_validators = class_validators or {}
- if PYDANTIC_V2:
+
+ v1_model_config = may_v1.BaseConfig
+ v1_field_info = field_info or may_v1.FieldInfo()
+ v1_kwargs = {
+ "name": name,
+ "field_info": v1_field_info,
+ "type_": type_,
+ "class_validators": class_validators,
+ "default": default,
+ "required": required,
+ "model_config": v1_model_config,
+ "alias": alias,
+ }
+
+ if (
+ annotation_is_pydantic_v1(type_)
+ or isinstance(field_info, may_v1.FieldInfo)
+ or version == "1"
+ ):
+ from fastapi._compat import v1
+
+ try:
+ return v1.ModelField(**v1_kwargs) # type: ignore[no-any-return]
+ except RuntimeError:
+ raise fastapi.exceptions.FastAPIError(_invalid_args_message) from None
+ elif PYDANTIC_V2:
+ from ._compat import v2
+
field_info = field_info or FieldInfo(
annotation=type_, default=default, alias=alias
)
- else:
- field_info = field_info or FieldInfo()
- kwargs = {"name": name, "field_info": field_info}
- if PYDANTIC_V2:
- kwargs.update({"mode": mode})
- else:
- kwargs.update(
- {
- "type_": type_,
- "class_validators": class_validators,
- "default": default,
- "required": required,
- "model_config": model_config,
- "alias": alias,
- }
- )
+ kwargs = {"mode": mode, "name": name, "field_info": field_info}
+ try:
+ return v2.ModelField(**kwargs) # type: ignore[return-value,arg-type]
+ except PydanticSchemaGenerationError:
+ raise fastapi.exceptions.FastAPIError(_invalid_args_message) from None
+ # Pydantic v2 is not installed, but it's not a Pydantic v1 ModelField, it could be
+ # a Pydantic v1 type, like a constrained int
+ from fastapi._compat import v1
+
try:
- return ModelField(**kwargs) # type: ignore[arg-type]
- except (RuntimeError, PydanticSchemaGenerationError):
- raise fastapi.exceptions.FastAPIError(
- "Invalid args for response field! Hint: "
- f"check that {type_} is a valid Pydantic field type. "
- "If you are using a return type annotation that is not a valid Pydantic "
- "field (e.g. Union[Response, dict, None]) you can disable generating the "
- "response model from the type annotation with the path operation decorator "
- "parameter response_model=None. Read more: "
- "https://fastapi.tiangolo.com/tutorial/response-model/"
- ) from None
+ return v1.ModelField(**v1_kwargs) # type: ignore[no-any-return]
+ except RuntimeError:
+ raise fastapi.exceptions.FastAPIError(_invalid_args_message) from None
def create_cloned_field(
@@ -115,7 +138,13 @@ def create_cloned_field(
cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,
) -> ModelField:
if PYDANTIC_V2:
- return field
+ from ._compat import v2
+
+ if isinstance(field, v2.ModelField):
+ return field
+
+ from fastapi._compat import v1
+
# cloned_types caches already cloned types to support recursive models and improve
# performance by avoiding unnecessary cloning
if cloned_types is None:
@@ -125,21 +154,23 @@ def create_cloned_field(
if is_dataclass(original_type) and hasattr(original_type, "__pydantic_model__"):
original_type = original_type.__pydantic_model__
use_type = original_type
- if lenient_issubclass(original_type, BaseModel):
- original_type = cast(Type[BaseModel], original_type)
+ if lenient_issubclass(original_type, v1.BaseModel):
+ original_type = cast(Type[v1.BaseModel], original_type)
use_type = cloned_types.get(original_type)
if use_type is None:
- use_type = create_model(original_type.__name__, __base__=original_type)
+ use_type = v1.create_model(original_type.__name__, __base__=original_type)
cloned_types[original_type] = use_type
for f in original_type.__fields__.values():
use_type.__fields__[f.name] = create_cloned_field(
- f, cloned_types=cloned_types
+ f,
+ cloned_types=cloned_types,
)
- new_field = create_response_field(name=field.name, type_=use_type)
+ new_field = create_model_field(name=field.name, type_=use_type, version="1")
new_field.has_alias = field.has_alias # type: ignore[attr-defined]
new_field.alias = field.alias # type: ignore[misc]
new_field.class_validators = field.class_validators # type: ignore[attr-defined]
new_field.default = field.default # type: ignore[misc]
+ new_field.default_factory = field.default_factory # type: ignore[attr-defined]
new_field.required = field.required # type: ignore[misc]
new_field.model_config = field.model_config # type: ignore[attr-defined]
new_field.field_info = field.field_info
@@ -173,17 +204,17 @@ def generate_operation_id_for_path(
DeprecationWarning,
stacklevel=2,
)
- operation_id = name + path
+ operation_id = f"{name}{path}"
operation_id = re.sub(r"\W", "_", operation_id)
- operation_id = operation_id + "_" + method.lower()
+ operation_id = f"{operation_id}_{method.lower()}"
return operation_id
def generate_unique_id(route: "APIRoute") -> str:
- operation_id = route.name + route.path_format
+ operation_id = f"{route.name}{route.path_format}"
operation_id = re.sub(r"\W", "_", operation_id)
assert route.methods
- operation_id = operation_id + "_" + list(route.methods)[0].lower()
+ operation_id = f"{operation_id}_{list(route.methods)[0].lower()}"
return operation_id
@@ -221,9 +252,3 @@ def get_value_or_default(
if not isinstance(item, DefaultPlaceholder):
return item
return first_item
-
-
-def match_pydantic_error_url(error_type: str) -> Any:
- from dirty_equals import IsStr
-
- return IsStr(regex=rf"^https://errors\.pydantic\.dev/.*/v/{error_type}")
diff --git a/Backend/venv/lib/python3.12/site-packages/python_jose-3.3.0.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/python_jose-3.3.0.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/METADATA
new file mode 100644
index 00000000..bef50192
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/METADATA
@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: filelock
+Version: 3.20.0
+Summary: A platform independent file lock.
+Project-URL: Documentation, https://py-filelock.readthedocs.io
+Project-URL: Homepage, https://github.com/tox-dev/py-filelock
+Project-URL: Source, https://github.com/tox-dev/py-filelock
+Project-URL: Tracker, https://github.com/tox-dev/py-filelock/issues
+Maintainer-email: Bernát Gábor
+License-Expression: Unlicense
+License-File: LICENSE
+Keywords: application,cache,directory,log,user
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# filelock
+
+[](https://pypi.org/project/filelock/)
+[](https://pypi.org/project/filelock/)
+[](https://py-filelock.readthedocs.io/en/latest/?badge=latest)
+[](https://github.com/psf/black)
+[](https://pepy.tech/project/filelock)
+[](https://github.com/tox-dev/py-filelock/actions/workflows/check.yaml)
+
+For more information checkout the [official documentation](https://py-filelock.readthedocs.io/en/latest/index.html).
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/RECORD
new file mode 100644
index 00000000..1c1ecbe3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/RECORD
@@ -0,0 +1,24 @@
+filelock-3.20.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+filelock-3.20.0.dist-info/METADATA,sha256=gIghqdcbGNywxw52pN02_a9OxFqzhjA8v-9GsDWtNog,2110
+filelock-3.20.0.dist-info/RECORD,,
+filelock-3.20.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+filelock-3.20.0.dist-info/licenses/LICENSE,sha256=iNm062BXnBkew5HKBMFhMFctfu3EqG2qWL8oxuFMm80,1210
+filelock/__init__.py,sha256=_t_-OAGXo_qyPa9lNQ1YnzVYEvSW3I0onPqzpomsVVg,1769
+filelock/__pycache__/__init__.cpython-312.pyc,,
+filelock/__pycache__/_api.cpython-312.pyc,,
+filelock/__pycache__/_error.cpython-312.pyc,,
+filelock/__pycache__/_soft.cpython-312.pyc,,
+filelock/__pycache__/_unix.cpython-312.pyc,,
+filelock/__pycache__/_util.cpython-312.pyc,,
+filelock/__pycache__/_windows.cpython-312.pyc,,
+filelock/__pycache__/asyncio.cpython-312.pyc,,
+filelock/__pycache__/version.cpython-312.pyc,,
+filelock/_api.py,sha256=2aATBeJ3-jtMj5OSm7EE539iNaTBsf13KXtcBMoi8oM,14545
+filelock/_error.py,sha256=-5jMcjTu60YAvAO1UbqDD1GIEjVkwr8xCFwDBtMeYDg,787
+filelock/_soft.py,sha256=haqtc_TB_KJbYv2a8iuEAclKuM4fMG1vTcp28sK919c,1711
+filelock/_unix.py,sha256=eGOs4gDgZ-5fGnJUz-OkJDeZkAMzgvYcD8hVD6XH7e4,2351
+filelock/_util.py,sha256=QHBoNFIYfbAThhotH3Q8E2acFc84wpG49-T-uu017ZE,1715
+filelock/_windows.py,sha256=8k4XIBl_zZVfGC2gz0kEr8DZBvpNa8wdU9qeM1YrBb8,2179
+filelock/asyncio.py,sha256=dSLe6XZSECFOgsVpcQUSh5Y5zAHxHGPu_tfpPX9I45k,12514
+filelock/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+filelock/version.py,sha256=AW5MeEjK4TaQWWJrGb_AlBw8PlmFoIcn7GodG_AVSOM,706
diff --git a/Backend/venv/lib/python3.12/site-packages/pydantic-2.5.0.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/WHEEL
similarity index 67%
rename from Backend/venv/lib/python3.12/site-packages/pydantic-2.5.0.dist-info/WHEEL
rename to Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/WHEEL
index ba1a8af2..12228d41 100644
--- a/Backend/venv/lib/python3.12/site-packages/pydantic-2.5.0.dist-info/WHEEL
+++ b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/WHEEL
@@ -1,4 +1,4 @@
Wheel-Version: 1.0
-Generator: hatchling 1.18.0
+Generator: hatchling 1.27.0
Root-Is-Purelib: true
Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/licenses/LICENSE b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/licenses/LICENSE
new file mode 100644
index 00000000..cf1ab25d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock-3.20.0.dist-info/licenses/LICENSE
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__init__.py b/Backend/venv/lib/python3.12/site-packages/filelock/__init__.py
new file mode 100644
index 00000000..c9d8c5b8
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/__init__.py
@@ -0,0 +1,70 @@
+"""
+A platform independent file lock that supports the with-statement.
+
+.. autodata:: filelock.__version__
+ :no-value:
+
+"""
+
+from __future__ import annotations
+
+import sys
+import warnings
+from typing import TYPE_CHECKING
+
+from ._api import AcquireReturnProxy, BaseFileLock
+from ._error import Timeout
+from ._soft import SoftFileLock
+from ._unix import UnixFileLock, has_fcntl
+from ._windows import WindowsFileLock
+from .asyncio import (
+ AsyncAcquireReturnProxy,
+ AsyncSoftFileLock,
+ AsyncUnixFileLock,
+ AsyncWindowsFileLock,
+ BaseAsyncFileLock,
+)
+from .version import version
+
+#: version of the project as a string
+__version__: str = version
+
+
+if sys.platform == "win32": # pragma: win32 cover
+ _FileLock: type[BaseFileLock] = WindowsFileLock
+ _AsyncFileLock: type[BaseAsyncFileLock] = AsyncWindowsFileLock
+else: # pragma: win32 no cover # noqa: PLR5501
+ if has_fcntl:
+ _FileLock: type[BaseFileLock] = UnixFileLock
+ _AsyncFileLock: type[BaseAsyncFileLock] = AsyncUnixFileLock
+ else:
+ _FileLock = SoftFileLock
+ _AsyncFileLock = AsyncSoftFileLock
+ if warnings is not None:
+ warnings.warn("only soft file lock is available", stacklevel=2)
+
+if TYPE_CHECKING:
+ FileLock = SoftFileLock
+ AsyncFileLock = AsyncSoftFileLock
+else:
+ #: Alias for the lock, which should be used for the current platform.
+ FileLock = _FileLock
+ AsyncFileLock = _AsyncFileLock
+
+
+__all__ = [
+ "AcquireReturnProxy",
+ "AsyncAcquireReturnProxy",
+ "AsyncFileLock",
+ "AsyncSoftFileLock",
+ "AsyncUnixFileLock",
+ "AsyncWindowsFileLock",
+ "BaseAsyncFileLock",
+ "BaseFileLock",
+ "FileLock",
+ "SoftFileLock",
+ "Timeout",
+ "UnixFileLock",
+ "WindowsFileLock",
+ "__version__",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..f68cef8b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_api.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_api.cpython-312.pyc
new file mode 100644
index 00000000..b1e7092b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_api.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_error.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_error.cpython-312.pyc
new file mode 100644
index 00000000..f63b0401
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_error.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_soft.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_soft.cpython-312.pyc
new file mode 100644
index 00000000..1748114b
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_soft.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_unix.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_unix.cpython-312.pyc
new file mode 100644
index 00000000..792ac21c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_unix.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_util.cpython-312.pyc
new file mode 100644
index 00000000..cde70fe4
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_windows.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_windows.cpython-312.pyc
new file mode 100644
index 00000000..23111dc3
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/_windows.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/asyncio.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/asyncio.cpython-312.pyc
new file mode 100644
index 00000000..55eb6bbc
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/asyncio.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/version.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/version.cpython-312.pyc
new file mode 100644
index 00000000..60dc02f0
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/filelock/__pycache__/version.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/_api.py b/Backend/venv/lib/python3.12/site-packages/filelock/_api.py
new file mode 100644
index 00000000..8fde69a0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/_api.py
@@ -0,0 +1,403 @@
+from __future__ import annotations
+
+import contextlib
+import inspect
+import logging
+import os
+import time
+import warnings
+from abc import ABCMeta, abstractmethod
+from dataclasses import dataclass
+from threading import local
+from typing import TYPE_CHECKING, Any, cast
+from weakref import WeakValueDictionary
+
+from ._error import Timeout
+
+if TYPE_CHECKING:
+ import sys
+ from types import TracebackType
+
+ if sys.version_info >= (3, 11): # pragma: no cover (py311+)
+ from typing import Self
+ else: # pragma: no cover ( None:
+ self.lock = lock
+
+ def __enter__(self) -> BaseFileLock:
+ return self.lock
+
+ def __exit__(
+ self,
+ exc_type: type[BaseException] | None,
+ exc_value: BaseException | None,
+ traceback: TracebackType | None,
+ ) -> None:
+ self.lock.release()
+
+
+@dataclass
+class FileLockContext:
+ """A dataclass which holds the context for a ``BaseFileLock`` object."""
+
+ # The context is held in a separate class to allow optional use of thread local storage via the
+ # ThreadLocalFileContext class.
+
+ #: The path to the lock file.
+ lock_file: str
+
+ #: The default timeout value.
+ timeout: float
+
+ #: The mode for the lock files
+ mode: int
+
+ #: Whether the lock should be blocking or not
+ blocking: bool
+
+ #: The file descriptor for the *_lock_file* as it is returned by the os.open() function, not None when lock held
+ lock_file_fd: int | None = None
+
+ #: The lock counter is used for implementing the nested locking mechanism.
+ lock_counter: int = 0 # When the lock is acquired is increased and the lock is only released, when this value is 0
+
+
+class ThreadLocalFileContext(FileLockContext, local):
+ """A thread local version of the ``FileLockContext`` class."""
+
+
+class FileLockMeta(ABCMeta):
+ def __call__( # noqa: PLR0913
+ cls,
+ lock_file: str | os.PathLike[str],
+ timeout: float = -1,
+ mode: int = 0o644,
+ thread_local: bool = True, # noqa: FBT001, FBT002
+ *,
+ blocking: bool = True,
+ is_singleton: bool = False,
+ **kwargs: Any, # capture remaining kwargs for subclasses # noqa: ANN401
+ ) -> BaseFileLock:
+ if is_singleton:
+ instance = cls._instances.get(str(lock_file)) # type: ignore[attr-defined]
+ if instance:
+ params_to_check = {
+ "thread_local": (thread_local, instance.is_thread_local()),
+ "timeout": (timeout, instance.timeout),
+ "mode": (mode, instance.mode),
+ "blocking": (blocking, instance.blocking),
+ }
+
+ non_matching_params = {
+ name: (passed_param, set_param)
+ for name, (passed_param, set_param) in params_to_check.items()
+ if passed_param != set_param
+ }
+ if not non_matching_params:
+ return cast("BaseFileLock", instance)
+
+ # parameters do not match; raise error
+ msg = "Singleton lock instances cannot be initialized with differing arguments"
+ msg += "\nNon-matching arguments: "
+ for param_name, (passed_param, set_param) in non_matching_params.items():
+ msg += f"\n\t{param_name} (existing lock has {set_param} but {passed_param} was passed)"
+ raise ValueError(msg)
+
+ # Workaround to make `__init__`'s params optional in subclasses
+ # E.g. virtualenv changes the signature of the `__init__` method in the `BaseFileLock` class descendant
+ # (https://github.com/tox-dev/filelock/pull/340)
+
+ all_params = {
+ "timeout": timeout,
+ "mode": mode,
+ "thread_local": thread_local,
+ "blocking": blocking,
+ "is_singleton": is_singleton,
+ **kwargs,
+ }
+
+ present_params = inspect.signature(cls.__init__).parameters # type: ignore[misc]
+ init_params = {key: value for key, value in all_params.items() if key in present_params}
+
+ instance = super().__call__(lock_file, **init_params)
+
+ if is_singleton:
+ cls._instances[str(lock_file)] = instance # type: ignore[attr-defined]
+
+ return cast("BaseFileLock", instance)
+
+
+class BaseFileLock(contextlib.ContextDecorator, metaclass=FileLockMeta):
+ """Abstract base class for a file lock object."""
+
+ _instances: WeakValueDictionary[str, BaseFileLock]
+
+ def __init_subclass__(cls, **kwargs: dict[str, Any]) -> None:
+ """Setup unique state for lock subclasses."""
+ super().__init_subclass__(**kwargs)
+ cls._instances = WeakValueDictionary()
+
+ def __init__( # noqa: PLR0913
+ self,
+ lock_file: str | os.PathLike[str],
+ timeout: float = -1,
+ mode: int = 0o644,
+ thread_local: bool = True, # noqa: FBT001, FBT002
+ *,
+ blocking: bool = True,
+ is_singleton: bool = False,
+ ) -> None:
+ """
+ Create a new lock object.
+
+ :param lock_file: path to the file
+ :param timeout: default timeout when acquiring the lock, in seconds. It will be used as fallback value in \
+ the acquire method, if no timeout value (``None``) is given. If you want to disable the timeout, set it \
+ to a negative value. A timeout of 0 means that there is exactly one attempt to acquire the file lock.
+ :param mode: file permissions for the lockfile
+ :param thread_local: Whether this object's internal context should be thread local or not. If this is set to \
+ ``False`` then the lock will be reentrant across threads.
+ :param blocking: whether the lock should be blocking or not
+ :param is_singleton: If this is set to ``True`` then only one instance of this class will be created \
+ per lock file. This is useful if you want to use the lock object for reentrant locking without needing \
+ to pass the same object around.
+
+ """
+ self._is_thread_local = thread_local
+ self._is_singleton = is_singleton
+
+ # Create the context. Note that external code should not work with the context directly and should instead use
+ # properties of this class.
+ kwargs: dict[str, Any] = {
+ "lock_file": os.fspath(lock_file),
+ "timeout": timeout,
+ "mode": mode,
+ "blocking": blocking,
+ }
+ self._context: FileLockContext = (ThreadLocalFileContext if thread_local else FileLockContext)(**kwargs)
+
+ def is_thread_local(self) -> bool:
+ """:return: a flag indicating if this lock is thread local or not"""
+ return self._is_thread_local
+
+ @property
+ def is_singleton(self) -> bool:
+ """:return: a flag indicating if this lock is singleton or not"""
+ return self._is_singleton
+
+ @property
+ def lock_file(self) -> str:
+ """:return: path to the lock file"""
+ return self._context.lock_file
+
+ @property
+ def timeout(self) -> float:
+ """
+ :return: the default timeout value, in seconds
+
+ .. versionadded:: 2.0.0
+ """
+ return self._context.timeout
+
+ @timeout.setter
+ def timeout(self, value: float | str) -> None:
+ """
+ Change the default timeout value.
+
+ :param value: the new value, in seconds
+
+ """
+ self._context.timeout = float(value)
+
+ @property
+ def blocking(self) -> bool:
+ """:return: whether the locking is blocking or not"""
+ return self._context.blocking
+
+ @blocking.setter
+ def blocking(self, value: bool) -> None:
+ """
+ Change the default blocking value.
+
+ :param value: the new value as bool
+
+ """
+ self._context.blocking = value
+
+ @property
+ def mode(self) -> int:
+ """:return: the file permissions for the lockfile"""
+ return self._context.mode
+
+ @abstractmethod
+ def _acquire(self) -> None:
+ """If the file lock could be acquired, self._context.lock_file_fd holds the file descriptor of the lock file."""
+ raise NotImplementedError
+
+ @abstractmethod
+ def _release(self) -> None:
+ """Releases the lock and sets self._context.lock_file_fd to None."""
+ raise NotImplementedError
+
+ @property
+ def is_locked(self) -> bool:
+ """
+
+ :return: A boolean indicating if the lock file is holding the lock currently.
+
+ .. versionchanged:: 2.0.0
+
+ This was previously a method and is now a property.
+ """
+ return self._context.lock_file_fd is not None
+
+ @property
+ def lock_counter(self) -> int:
+ """:return: The number of times this lock has been acquired (but not yet released)."""
+ return self._context.lock_counter
+
+ def acquire(
+ self,
+ timeout: float | None = None,
+ poll_interval: float = 0.05,
+ *,
+ poll_intervall: float | None = None,
+ blocking: bool | None = None,
+ ) -> AcquireReturnProxy:
+ """
+ Try to acquire the file lock.
+
+ :param timeout: maximum wait time for acquiring the lock, ``None`` means use the default :attr:`~timeout` is and
+ if ``timeout < 0``, there is no timeout and this method will block until the lock could be acquired
+ :param poll_interval: interval of trying to acquire the lock file
+ :param poll_intervall: deprecated, kept for backwards compatibility, use ``poll_interval`` instead
+ :param blocking: defaults to True. If False, function will return immediately if it cannot obtain a lock on the
+ first attempt. Otherwise, this method will block until the timeout expires or the lock is acquired.
+ :raises Timeout: if fails to acquire lock within the timeout period
+ :return: a context object that will unlock the file when the context is exited
+
+ .. code-block:: python
+
+ # You can use this method in the context manager (recommended)
+ with lock.acquire():
+ pass
+
+ # Or use an equivalent try-finally construct:
+ lock.acquire()
+ try:
+ pass
+ finally:
+ lock.release()
+
+ .. versionchanged:: 2.0.0
+
+ This method returns now a *proxy* object instead of *self*,
+ so that it can be used in a with statement without side effects.
+
+ """
+ # Use the default timeout, if no timeout is provided.
+ if timeout is None:
+ timeout = self._context.timeout
+
+ if blocking is None:
+ blocking = self._context.blocking
+
+ if poll_intervall is not None:
+ msg = "use poll_interval instead of poll_intervall"
+ warnings.warn(msg, DeprecationWarning, stacklevel=2)
+ poll_interval = poll_intervall
+
+ # Increment the number right at the beginning. We can still undo it, if something fails.
+ self._context.lock_counter += 1
+
+ lock_id = id(self)
+ lock_filename = self.lock_file
+ start_time = time.perf_counter()
+ try:
+ while True:
+ if not self.is_locked:
+ _LOGGER.debug("Attempting to acquire lock %s on %s", lock_id, lock_filename)
+ self._acquire()
+ if self.is_locked:
+ _LOGGER.debug("Lock %s acquired on %s", lock_id, lock_filename)
+ break
+ if blocking is False:
+ _LOGGER.debug("Failed to immediately acquire lock %s on %s", lock_id, lock_filename)
+ raise Timeout(lock_filename) # noqa: TRY301
+ if 0 <= timeout < time.perf_counter() - start_time:
+ _LOGGER.debug("Timeout on acquiring lock %s on %s", lock_id, lock_filename)
+ raise Timeout(lock_filename) # noqa: TRY301
+ msg = "Lock %s not acquired on %s, waiting %s seconds ..."
+ _LOGGER.debug(msg, lock_id, lock_filename, poll_interval)
+ time.sleep(poll_interval)
+ except BaseException: # Something did go wrong, so decrement the counter.
+ self._context.lock_counter = max(0, self._context.lock_counter - 1)
+ raise
+ return AcquireReturnProxy(lock=self)
+
+ def release(self, force: bool = False) -> None: # noqa: FBT001, FBT002
+ """
+ Releases the file lock. Please note, that the lock is only completely released, if the lock counter is 0.
+ Also note, that the lock file itself is not automatically deleted.
+
+ :param force: If true, the lock counter is ignored and the lock is released in every case/
+
+ """
+ if self.is_locked:
+ self._context.lock_counter -= 1
+
+ if self._context.lock_counter == 0 or force:
+ lock_id, lock_filename = id(self), self.lock_file
+
+ _LOGGER.debug("Attempting to release lock %s on %s", lock_id, lock_filename)
+ self._release()
+ self._context.lock_counter = 0
+ _LOGGER.debug("Lock %s released on %s", lock_id, lock_filename)
+
+ def __enter__(self) -> Self:
+ """
+ Acquire the lock.
+
+ :return: the lock object
+
+ """
+ self.acquire()
+ return self
+
+ def __exit__(
+ self,
+ exc_type: type[BaseException] | None,
+ exc_value: BaseException | None,
+ traceback: TracebackType | None,
+ ) -> None:
+ """
+ Release the lock.
+
+ :param exc_type: the exception type if raised
+ :param exc_value: the exception value if raised
+ :param traceback: the exception traceback if raised
+
+ """
+ self.release()
+
+ def __del__(self) -> None:
+ """Called when the lock object is deleted."""
+ self.release(force=True)
+
+
+__all__ = [
+ "AcquireReturnProxy",
+ "BaseFileLock",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/_error.py b/Backend/venv/lib/python3.12/site-packages/filelock/_error.py
new file mode 100644
index 00000000..f7ff08c0
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/_error.py
@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from typing import Any
+
+
+class Timeout(TimeoutError): # noqa: N818
+ """Raised when the lock could not be acquired in *timeout* seconds."""
+
+ def __init__(self, lock_file: str) -> None:
+ super().__init__()
+ self._lock_file = lock_file
+
+ def __reduce__(self) -> str | tuple[Any, ...]:
+ return self.__class__, (self._lock_file,) # Properly pickle the exception
+
+ def __str__(self) -> str:
+ return f"The file lock '{self._lock_file}' could not be acquired."
+
+ def __repr__(self) -> str:
+ return f"{self.__class__.__name__}({self.lock_file!r})"
+
+ @property
+ def lock_file(self) -> str:
+ """:return: The path of the file lock."""
+ return self._lock_file
+
+
+__all__ = [
+ "Timeout",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/_soft.py b/Backend/venv/lib/python3.12/site-packages/filelock/_soft.py
new file mode 100644
index 00000000..28c67f74
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/_soft.py
@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+import os
+import sys
+from contextlib import suppress
+from errno import EACCES, EEXIST
+from pathlib import Path
+
+from ._api import BaseFileLock
+from ._util import ensure_directory_exists, raise_on_not_writable_file
+
+
+class SoftFileLock(BaseFileLock):
+ """Simply watches the existence of the lock file."""
+
+ def _acquire(self) -> None:
+ raise_on_not_writable_file(self.lock_file)
+ ensure_directory_exists(self.lock_file)
+ # first check for exists and read-only mode as the open will mask this case as EEXIST
+ flags = (
+ os.O_WRONLY # open for writing only
+ | os.O_CREAT
+ | os.O_EXCL # together with above raise EEXIST if the file specified by filename exists
+ | os.O_TRUNC # truncate the file to zero byte
+ )
+ try:
+ file_handler = os.open(self.lock_file, flags, self._context.mode)
+ except OSError as exception: # re-raise unless expected exception
+ if not (
+ exception.errno == EEXIST # lock already exist
+ or (exception.errno == EACCES and sys.platform == "win32") # has no access to this lock
+ ): # pragma: win32 no cover
+ raise
+ else:
+ self._context.lock_file_fd = file_handler
+
+ def _release(self) -> None:
+ assert self._context.lock_file_fd is not None # noqa: S101
+ os.close(self._context.lock_file_fd) # the lock file is definitely not None
+ self._context.lock_file_fd = None
+ with suppress(OSError): # the file is already deleted and that's what we want
+ Path(self.lock_file).unlink()
+
+
+__all__ = [
+ "SoftFileLock",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/_unix.py b/Backend/venv/lib/python3.12/site-packages/filelock/_unix.py
new file mode 100644
index 00000000..b2fd0f33
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/_unix.py
@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+import os
+import sys
+from contextlib import suppress
+from errno import ENOSYS
+from pathlib import Path
+from typing import cast
+
+from ._api import BaseFileLock
+from ._util import ensure_directory_exists
+
+#: a flag to indicate if the fcntl API is available
+has_fcntl = False
+if sys.platform == "win32": # pragma: win32 cover
+
+ class UnixFileLock(BaseFileLock):
+ """Uses the :func:`fcntl.flock` to hard lock the lock file on unix systems."""
+
+ def _acquire(self) -> None:
+ raise NotImplementedError
+
+ def _release(self) -> None:
+ raise NotImplementedError
+
+else: # pragma: win32 no cover
+ try:
+ import fcntl
+
+ _ = (fcntl.flock, fcntl.LOCK_EX, fcntl.LOCK_NB, fcntl.LOCK_UN)
+ except (ImportError, AttributeError):
+ pass
+ else:
+ has_fcntl = True
+
+ class UnixFileLock(BaseFileLock):
+ """Uses the :func:`fcntl.flock` to hard lock the lock file on unix systems."""
+
+ def _acquire(self) -> None:
+ ensure_directory_exists(self.lock_file)
+ open_flags = os.O_RDWR | os.O_TRUNC
+ if not Path(self.lock_file).exists():
+ open_flags |= os.O_CREAT
+ fd = os.open(self.lock_file, open_flags, self._context.mode)
+ with suppress(PermissionError): # This locked is not owned by this UID
+ os.fchmod(fd, self._context.mode)
+ try:
+ fcntl.flock(fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
+ except OSError as exception:
+ os.close(fd)
+ if exception.errno == ENOSYS: # NotImplemented error
+ msg = "FileSystem does not appear to support flock; use SoftFileLock instead"
+ raise NotImplementedError(msg) from exception
+ else:
+ self._context.lock_file_fd = fd
+
+ def _release(self) -> None:
+ # Do not remove the lockfile:
+ # https://github.com/tox-dev/py-filelock/issues/31
+ # https://stackoverflow.com/questions/17708885/flock-removing-locked-file-without-race-condition
+ fd = cast("int", self._context.lock_file_fd)
+ self._context.lock_file_fd = None
+ fcntl.flock(fd, fcntl.LOCK_UN)
+ os.close(fd)
+
+
+__all__ = [
+ "UnixFileLock",
+ "has_fcntl",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/_util.py b/Backend/venv/lib/python3.12/site-packages/filelock/_util.py
new file mode 100644
index 00000000..c671e853
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/_util.py
@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+import os
+import stat
+import sys
+from errno import EACCES, EISDIR
+from pathlib import Path
+
+
+def raise_on_not_writable_file(filename: str) -> None:
+ """
+ Raise an exception if attempting to open the file for writing would fail.
+
+ This is done so files that will never be writable can be separated from files that are writable but currently
+ locked.
+
+ :param filename: file to check
+ :raises OSError: as if the file was opened for writing.
+
+ """
+ try: # use stat to do exists + can write to check without race condition
+ file_stat = os.stat(filename) # noqa: PTH116
+ except OSError:
+ return # swallow does not exist or other errors
+
+ if file_stat.st_mtime != 0: # if os.stat returns but modification is zero that's an invalid os.stat - ignore it
+ if not (file_stat.st_mode & stat.S_IWUSR):
+ raise PermissionError(EACCES, "Permission denied", filename)
+
+ if stat.S_ISDIR(file_stat.st_mode):
+ if sys.platform == "win32": # pragma: win32 cover
+ # On Windows, this is PermissionError
+ raise PermissionError(EACCES, "Permission denied", filename)
+ else: # pragma: win32 no cover # noqa: RET506
+ # On linux / macOS, this is IsADirectoryError
+ raise IsADirectoryError(EISDIR, "Is a directory", filename)
+
+
+def ensure_directory_exists(filename: Path | str) -> None:
+ """
+ Ensure the directory containing the file exists (create it if necessary).
+
+ :param filename: file.
+
+ """
+ Path(filename).parent.mkdir(parents=True, exist_ok=True)
+
+
+__all__ = [
+ "ensure_directory_exists",
+ "raise_on_not_writable_file",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/_windows.py b/Backend/venv/lib/python3.12/site-packages/filelock/_windows.py
new file mode 100644
index 00000000..348251d1
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/_windows.py
@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+import os
+import sys
+from contextlib import suppress
+from errno import EACCES
+from pathlib import Path
+from typing import cast
+
+from ._api import BaseFileLock
+from ._util import ensure_directory_exists, raise_on_not_writable_file
+
+if sys.platform == "win32": # pragma: win32 cover
+ import msvcrt
+
+ class WindowsFileLock(BaseFileLock):
+ """Uses the :func:`msvcrt.locking` function to hard lock the lock file on Windows systems."""
+
+ def _acquire(self) -> None:
+ raise_on_not_writable_file(self.lock_file)
+ ensure_directory_exists(self.lock_file)
+ flags = (
+ os.O_RDWR # open for read and write
+ | os.O_CREAT # create file if not exists
+ | os.O_TRUNC # truncate file if not empty
+ )
+ try:
+ fd = os.open(self.lock_file, flags, self._context.mode)
+ except OSError as exception:
+ if exception.errno != EACCES: # has no access to this lock
+ raise
+ else:
+ try:
+ msvcrt.locking(fd, msvcrt.LK_NBLCK, 1)
+ except OSError as exception:
+ os.close(fd) # close file first
+ if exception.errno != EACCES: # file is already locked
+ raise
+ else:
+ self._context.lock_file_fd = fd
+
+ def _release(self) -> None:
+ fd = cast("int", self._context.lock_file_fd)
+ self._context.lock_file_fd = None
+ msvcrt.locking(fd, msvcrt.LK_UNLCK, 1)
+ os.close(fd)
+
+ with suppress(OSError): # Probably another instance of the application hat acquired the file lock.
+ Path(self.lock_file).unlink()
+
+else: # pragma: win32 no cover
+
+ class WindowsFileLock(BaseFileLock):
+ """Uses the :func:`msvcrt.locking` function to hard lock the lock file on Windows systems."""
+
+ def _acquire(self) -> None:
+ raise NotImplementedError
+
+ def _release(self) -> None:
+ raise NotImplementedError
+
+
+__all__ = [
+ "WindowsFileLock",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/asyncio.py b/Backend/venv/lib/python3.12/site-packages/filelock/asyncio.py
new file mode 100644
index 00000000..022d0ef6
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/asyncio.py
@@ -0,0 +1,344 @@
+"""An asyncio-based implementation of the file lock."""
+
+from __future__ import annotations
+
+import asyncio
+import contextlib
+import logging
+import os
+import time
+from dataclasses import dataclass
+from inspect import iscoroutinefunction
+from threading import local
+from typing import TYPE_CHECKING, Any, NoReturn, cast
+
+from ._api import BaseFileLock, FileLockContext, FileLockMeta
+from ._error import Timeout
+from ._soft import SoftFileLock
+from ._unix import UnixFileLock
+from ._windows import WindowsFileLock
+
+if TYPE_CHECKING:
+ import sys
+ from collections.abc import Callable
+ from concurrent import futures
+ from types import TracebackType
+
+ if sys.version_info >= (3, 11): # pragma: no cover (py311+)
+ from typing import Self
+ else: # pragma: no cover ( None: # noqa: D107
+ self.lock = lock
+
+ async def __aenter__(self) -> BaseAsyncFileLock: # noqa: D105
+ return self.lock
+
+ async def __aexit__( # noqa: D105
+ self,
+ exc_type: type[BaseException] | None,
+ exc_value: BaseException | None,
+ traceback: TracebackType | None,
+ ) -> None:
+ await self.lock.release()
+
+
+class AsyncFileLockMeta(FileLockMeta):
+ def __call__( # type: ignore[override] # noqa: PLR0913
+ cls, # noqa: N805
+ lock_file: str | os.PathLike[str],
+ timeout: float = -1,
+ mode: int = 0o644,
+ thread_local: bool = False, # noqa: FBT001, FBT002
+ *,
+ blocking: bool = True,
+ is_singleton: bool = False,
+ loop: asyncio.AbstractEventLoop | None = None,
+ run_in_executor: bool = True,
+ executor: futures.Executor | None = None,
+ ) -> BaseAsyncFileLock:
+ if thread_local and run_in_executor:
+ msg = "run_in_executor is not supported when thread_local is True"
+ raise ValueError(msg)
+ instance = super().__call__(
+ lock_file=lock_file,
+ timeout=timeout,
+ mode=mode,
+ thread_local=thread_local,
+ blocking=blocking,
+ is_singleton=is_singleton,
+ loop=loop,
+ run_in_executor=run_in_executor,
+ executor=executor,
+ )
+ return cast("BaseAsyncFileLock", instance)
+
+
+class BaseAsyncFileLock(BaseFileLock, metaclass=AsyncFileLockMeta):
+ """Base class for asynchronous file locks."""
+
+ def __init__( # noqa: PLR0913
+ self,
+ lock_file: str | os.PathLike[str],
+ timeout: float = -1,
+ mode: int = 0o644,
+ thread_local: bool = False, # noqa: FBT001, FBT002
+ *,
+ blocking: bool = True,
+ is_singleton: bool = False,
+ loop: asyncio.AbstractEventLoop | None = None,
+ run_in_executor: bool = True,
+ executor: futures.Executor | None = None,
+ ) -> None:
+ """
+ Create a new lock object.
+
+ :param lock_file: path to the file
+ :param timeout: default timeout when acquiring the lock, in seconds. It will be used as fallback value in \
+ the acquire method, if no timeout value (``None``) is given. If you want to disable the timeout, set it \
+ to a negative value. A timeout of 0 means that there is exactly one attempt to acquire the file lock.
+ :param mode: file permissions for the lockfile
+ :param thread_local: Whether this object's internal context should be thread local or not. If this is set to \
+ ``False`` then the lock will be reentrant across threads.
+ :param blocking: whether the lock should be blocking or not
+ :param is_singleton: If this is set to ``True`` then only one instance of this class will be created \
+ per lock file. This is useful if you want to use the lock object for reentrant locking without needing \
+ to pass the same object around.
+ :param loop: The event loop to use. If not specified, the running event loop will be used.
+ :param run_in_executor: If this is set to ``True`` then the lock will be acquired in an executor.
+ :param executor: The executor to use. If not specified, the default executor will be used.
+
+ """
+ self._is_thread_local = thread_local
+ self._is_singleton = is_singleton
+
+ # Create the context. Note that external code should not work with the context directly and should instead use
+ # properties of this class.
+ kwargs: dict[str, Any] = {
+ "lock_file": os.fspath(lock_file),
+ "timeout": timeout,
+ "mode": mode,
+ "blocking": blocking,
+ "loop": loop,
+ "run_in_executor": run_in_executor,
+ "executor": executor,
+ }
+ self._context: AsyncFileLockContext = (AsyncThreadLocalFileContext if thread_local else AsyncFileLockContext)(
+ **kwargs
+ )
+
+ @property
+ def run_in_executor(self) -> bool:
+ """::return: whether run in executor."""
+ return self._context.run_in_executor
+
+ @property
+ def executor(self) -> futures.Executor | None:
+ """::return: the executor."""
+ return self._context.executor
+
+ @executor.setter
+ def executor(self, value: futures.Executor | None) -> None: # pragma: no cover
+ """
+ Change the executor.
+
+ :param value: the new executor or ``None``
+ :type value: futures.Executor | None
+
+ """
+ self._context.executor = value
+
+ @property
+ def loop(self) -> asyncio.AbstractEventLoop | None:
+ """::return: the event loop."""
+ return self._context.loop
+
+ async def acquire( # type: ignore[override]
+ self,
+ timeout: float | None = None,
+ poll_interval: float = 0.05,
+ *,
+ blocking: bool | None = None,
+ ) -> AsyncAcquireReturnProxy:
+ """
+ Try to acquire the file lock.
+
+ :param timeout: maximum wait time for acquiring the lock, ``None`` means use the default
+ :attr:`~BaseFileLock.timeout` is and if ``timeout < 0``, there is no timeout and
+ this method will block until the lock could be acquired
+ :param poll_interval: interval of trying to acquire the lock file
+ :param blocking: defaults to True. If False, function will return immediately if it cannot obtain a lock on the
+ first attempt. Otherwise, this method will block until the timeout expires or the lock is acquired.
+ :raises Timeout: if fails to acquire lock within the timeout period
+ :return: a context object that will unlock the file when the context is exited
+
+ .. code-block:: python
+
+ # You can use this method in the context manager (recommended)
+ with lock.acquire():
+ pass
+
+ # Or use an equivalent try-finally construct:
+ lock.acquire()
+ try:
+ pass
+ finally:
+ lock.release()
+
+ """
+ # Use the default timeout, if no timeout is provided.
+ if timeout is None:
+ timeout = self._context.timeout
+
+ if blocking is None:
+ blocking = self._context.blocking
+
+ # Increment the number right at the beginning. We can still undo it, if something fails.
+ self._context.lock_counter += 1
+
+ lock_id = id(self)
+ lock_filename = self.lock_file
+ start_time = time.perf_counter()
+ try:
+ while True:
+ if not self.is_locked:
+ _LOGGER.debug("Attempting to acquire lock %s on %s", lock_id, lock_filename)
+ await self._run_internal_method(self._acquire)
+ if self.is_locked:
+ _LOGGER.debug("Lock %s acquired on %s", lock_id, lock_filename)
+ break
+ if blocking is False:
+ _LOGGER.debug("Failed to immediately acquire lock %s on %s", lock_id, lock_filename)
+ raise Timeout(lock_filename) # noqa: TRY301
+ if 0 <= timeout < time.perf_counter() - start_time:
+ _LOGGER.debug("Timeout on acquiring lock %s on %s", lock_id, lock_filename)
+ raise Timeout(lock_filename) # noqa: TRY301
+ msg = "Lock %s not acquired on %s, waiting %s seconds ..."
+ _LOGGER.debug(msg, lock_id, lock_filename, poll_interval)
+ await asyncio.sleep(poll_interval)
+ except BaseException: # Something did go wrong, so decrement the counter.
+ self._context.lock_counter = max(0, self._context.lock_counter - 1)
+ raise
+ return AsyncAcquireReturnProxy(lock=self)
+
+ async def release(self, force: bool = False) -> None: # type: ignore[override] # noqa: FBT001, FBT002
+ """
+ Releases the file lock. Please note, that the lock is only completely released, if the lock counter is 0.
+ Also note, that the lock file itself is not automatically deleted.
+
+ :param force: If true, the lock counter is ignored and the lock is released in every case/
+
+ """
+ if self.is_locked:
+ self._context.lock_counter -= 1
+
+ if self._context.lock_counter == 0 or force:
+ lock_id, lock_filename = id(self), self.lock_file
+
+ _LOGGER.debug("Attempting to release lock %s on %s", lock_id, lock_filename)
+ await self._run_internal_method(self._release)
+ self._context.lock_counter = 0
+ _LOGGER.debug("Lock %s released on %s", lock_id, lock_filename)
+
+ async def _run_internal_method(self, method: Callable[[], Any]) -> None:
+ if iscoroutinefunction(method):
+ await method()
+ elif self.run_in_executor:
+ loop = self.loop or asyncio.get_running_loop()
+ await loop.run_in_executor(self.executor, method)
+ else:
+ method()
+
+ def __enter__(self) -> NoReturn:
+ """
+ Replace old __enter__ method to avoid using it.
+
+ NOTE: DO NOT USE `with` FOR ASYNCIO LOCKS, USE `async with` INSTEAD.
+
+ :return: none
+ :rtype: NoReturn
+ """
+ msg = "Do not use `with` for asyncio locks, use `async with` instead."
+ raise NotImplementedError(msg)
+
+ async def __aenter__(self) -> Self:
+ """
+ Acquire the lock.
+
+ :return: the lock object
+
+ """
+ await self.acquire()
+ return self
+
+ async def __aexit__(
+ self,
+ exc_type: type[BaseException] | None,
+ exc_value: BaseException | None,
+ traceback: TracebackType | None,
+ ) -> None:
+ """
+ Release the lock.
+
+ :param exc_type: the exception type if raised
+ :param exc_value: the exception value if raised
+ :param traceback: the exception traceback if raised
+
+ """
+ await self.release()
+
+ def __del__(self) -> None:
+ """Called when the lock object is deleted."""
+ with contextlib.suppress(RuntimeError):
+ loop = self.loop or asyncio.get_running_loop()
+ if not loop.is_running(): # pragma: no cover
+ loop.run_until_complete(self.release(force=True))
+ else:
+ loop.create_task(self.release(force=True))
+
+
+class AsyncSoftFileLock(SoftFileLock, BaseAsyncFileLock):
+ """Simply watches the existence of the lock file."""
+
+
+class AsyncUnixFileLock(UnixFileLock, BaseAsyncFileLock):
+ """Uses the :func:`fcntl.flock` to hard lock the lock file on unix systems."""
+
+
+class AsyncWindowsFileLock(WindowsFileLock, BaseAsyncFileLock):
+ """Uses the :func:`msvcrt.locking` to hard lock the lock file on windows systems."""
+
+
+__all__ = [
+ "AsyncAcquireReturnProxy",
+ "AsyncSoftFileLock",
+ "AsyncUnixFileLock",
+ "AsyncWindowsFileLock",
+ "BaseAsyncFileLock",
+]
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/py.typed b/Backend/venv/lib/python3.12/site-packages/filelock/py.typed
new file mode 100644
index 00000000..e69de29b
diff --git a/Backend/venv/lib/python3.12/site-packages/filelock/version.py b/Backend/venv/lib/python3.12/site-packages/filelock/version.py
new file mode 100644
index 00000000..093125cd
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/filelock/version.py
@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+ "__version__",
+ "__version_tuple__",
+ "version",
+ "version_tuple",
+ "__commit_id__",
+ "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+ from typing import Tuple
+ from typing import Union
+
+ VERSION_TUPLE = Tuple[Union[int, str], ...]
+ COMMIT_ID = Union[str, None]
+else:
+ VERSION_TUPLE = object
+ COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '3.20.0'
+__version_tuple__ = version_tuple = (3, 20, 0)
+
+__commit_id__ = commit_id = None
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/RECORD
deleted file mode 100644
index a63f6ccf..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/RECORD
+++ /dev/null
@@ -1,52 +0,0 @@
-h11-0.14.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
-h11-0.14.0.dist-info/LICENSE.txt,sha256=N9tbuFkm2yikJ6JYZ_ELEjIAOuob5pzLhRE4rbjm82E,1124
-h11-0.14.0.dist-info/METADATA,sha256=B7pZ0m7WBXNs17vl6hUH9bJTL9s37DaGvY31w7jNxSg,8175
-h11-0.14.0.dist-info/RECORD,,
-h11-0.14.0.dist-info/WHEEL,sha256=ewwEueio1C2XeHTvT17n8dZUJgOvyCWCt0WVNLClP9o,92
-h11-0.14.0.dist-info/top_level.txt,sha256=F7dC4jl3zeh8TGHEPaWJrMbeuoWbS379Gwdi-Yvdcis,4
-h11/__init__.py,sha256=iO1KzkSO42yZ6ffg-VMgbx_ZVTWGUY00nRYEWn-s3kY,1507
-h11/__pycache__/__init__.cpython-312.pyc,,
-h11/__pycache__/_abnf.cpython-312.pyc,,
-h11/__pycache__/_connection.cpython-312.pyc,,
-h11/__pycache__/_events.cpython-312.pyc,,
-h11/__pycache__/_headers.cpython-312.pyc,,
-h11/__pycache__/_readers.cpython-312.pyc,,
-h11/__pycache__/_receivebuffer.cpython-312.pyc,,
-h11/__pycache__/_state.cpython-312.pyc,,
-h11/__pycache__/_util.cpython-312.pyc,,
-h11/__pycache__/_version.cpython-312.pyc,,
-h11/__pycache__/_writers.cpython-312.pyc,,
-h11/_abnf.py,sha256=ybixr0xsupnkA6GFAyMubuXF6Tc1lb_hF890NgCsfNc,4815
-h11/_connection.py,sha256=eS2sorMD0zKLCFiB9lW9W9F_Nzny2tjHa4e6s1ujr1c,26539
-h11/_events.py,sha256=LEfuvg1AbhHaVRwxCd0I-pFn9-ezUOaoL8o2Kvy1PBA,11816
-h11/_headers.py,sha256=RqB8cd8CN0blYPzcLe5qeCh-phv6D1U_CHj4hs67lgQ,10230
-h11/_readers.py,sha256=EbSed0jzwVUiD1nOPAeUcVE4Flf3wXkxfb8c06-OTBM,8383
-h11/_receivebuffer.py,sha256=xrspsdsNgWFxRfQcTXxR8RrdjRXXTK0Io5cQYWpJ1Ws,5252
-h11/_state.py,sha256=k1VL6SDbaPkSrZ-49ewCXDpuiUS69_46YhbWjuV1qEY,13300
-h11/_util.py,sha256=LWkkjXyJaFlAy6Lt39w73UStklFT5ovcvo0TkY7RYuk,4888
-h11/_version.py,sha256=LVyTdiZRzIIEv79UyOgbM5iUrJUllEzlCWaJEYBY1zc,686
-h11/_writers.py,sha256=oFKm6PtjeHfbj4RLX7VB7KDc1gIY53gXG3_HR9ltmTA,5081
-h11/py.typed,sha256=sow9soTwP9T_gEAQSVh7Gb8855h04Nwmhs2We-JRgZM,7
-h11/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-h11/tests/__pycache__/__init__.cpython-312.pyc,,
-h11/tests/__pycache__/helpers.cpython-312.pyc,,
-h11/tests/__pycache__/test_against_stdlib_http.cpython-312.pyc,,
-h11/tests/__pycache__/test_connection.cpython-312.pyc,,
-h11/tests/__pycache__/test_events.cpython-312.pyc,,
-h11/tests/__pycache__/test_headers.cpython-312.pyc,,
-h11/tests/__pycache__/test_helpers.cpython-312.pyc,,
-h11/tests/__pycache__/test_io.cpython-312.pyc,,
-h11/tests/__pycache__/test_receivebuffer.cpython-312.pyc,,
-h11/tests/__pycache__/test_state.cpython-312.pyc,,
-h11/tests/__pycache__/test_util.cpython-312.pyc,,
-h11/tests/data/test-file,sha256=ZJ03Rqs98oJw29OHzJg7LlMzyGQaRAY0r3AqBeM2wVU,65
-h11/tests/helpers.py,sha256=a1EVG_p7xU4wRsa3tMPTRxuaKCmretok9sxXWvqfmQA,3355
-h11/tests/test_against_stdlib_http.py,sha256=cojCHgHXFQ8gWhNlEEwl3trmOpN-5uDukRoHnElqo3A,3995
-h11/tests/test_connection.py,sha256=ZbPLDPclKvjgjAhgk-WlCPBaf17c4XUIV2tpaW08jOI,38720
-h11/tests/test_events.py,sha256=LPVLbcV-NvPNK9fW3rraR6Bdpz1hAlsWubMtNaJ5gHg,4657
-h11/tests/test_headers.py,sha256=qd8T1Zenuz5GbD6wklSJ5G8VS7trrYgMV0jT-SMvqg8,5612
-h11/tests/test_helpers.py,sha256=kAo0CEM4LGqmyyP2ZFmhsyq3UFJqoFfAbzu3hbWreRM,794
-h11/tests/test_io.py,sha256=uCZVnjarkRBkudfC1ij-KSCQ71XWJhnkgkgWWkKgYPQ,16386
-h11/tests/test_receivebuffer.py,sha256=3jGbeJM36Akqg_pAhPb7XzIn2NS6RhPg-Ryg8Eu6ytk,3454
-h11/tests/test_state.py,sha256=rqll9WqFsJPE0zSrtCn9LH659mPKsDeXZ-DwXwleuBQ,8928
-h11/tests/test_util.py,sha256=VO5L4nSFe4pgtSwKuv6u_6l0H7UeizF5WKuHTWreg70,2970
diff --git a/Backend/venv/lib/python3.12/site-packages/python_multipart-0.0.6.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/python_multipart-0.0.6.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/METADATA
similarity index 95%
rename from Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/METADATA
rename to Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/METADATA
index cf12a82f..8a2f6390 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/METADATA
+++ b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/METADATA
@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
Name: h11
-Version: 0.14.0
+Version: 0.16.0
Summary: A pure-Python, bring-your-own-I/O implementation of HTTP/1.1
Home-page: https://github.com/python-hyper/h11
Author: Nathaniel J. Smith
@@ -13,15 +13,24 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: System :: Networking
-Requires-Python: >=3.7
+Requires-Python: >=3.8
License-File: LICENSE.txt
-Requires-Dist: typing-extensions ; python_version < "3.8"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
h11
===
@@ -137,7 +146,7 @@ library.
It has a test suite with 100.0% coverage for both statements and
branches.
-Currently it supports Python 3 (testing on 3.7-3.10) and PyPy 3.
+Currently it supports Python 3 (testing on 3.8-3.12) and PyPy 3.
The last Python 2-compatible version was h11 0.11.x.
(Originally it had a Cython wrapper for `http-parser
`_ and a beautiful nested state
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/RECORD
new file mode 100644
index 00000000..9193534d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/RECORD
@@ -0,0 +1,30 @@
+h11-0.16.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+h11-0.16.0.dist-info/METADATA,sha256=KPMmCYrAn8unm48YD5YIfIQf4kViFct7hyqcfVzRnWQ,8348
+h11-0.16.0.dist-info/RECORD,,
+h11-0.16.0.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+h11-0.16.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+h11-0.16.0.dist-info/licenses/LICENSE.txt,sha256=N9tbuFkm2yikJ6JYZ_ELEjIAOuob5pzLhRE4rbjm82E,1124
+h11-0.16.0.dist-info/top_level.txt,sha256=F7dC4jl3zeh8TGHEPaWJrMbeuoWbS379Gwdi-Yvdcis,4
+h11/__init__.py,sha256=iO1KzkSO42yZ6ffg-VMgbx_ZVTWGUY00nRYEWn-s3kY,1507
+h11/__pycache__/__init__.cpython-312.pyc,,
+h11/__pycache__/_abnf.cpython-312.pyc,,
+h11/__pycache__/_connection.cpython-312.pyc,,
+h11/__pycache__/_events.cpython-312.pyc,,
+h11/__pycache__/_headers.cpython-312.pyc,,
+h11/__pycache__/_readers.cpython-312.pyc,,
+h11/__pycache__/_receivebuffer.cpython-312.pyc,,
+h11/__pycache__/_state.cpython-312.pyc,,
+h11/__pycache__/_util.cpython-312.pyc,,
+h11/__pycache__/_version.cpython-312.pyc,,
+h11/__pycache__/_writers.cpython-312.pyc,,
+h11/_abnf.py,sha256=ybixr0xsupnkA6GFAyMubuXF6Tc1lb_hF890NgCsfNc,4815
+h11/_connection.py,sha256=k9YRVf6koZqbttBW36xSWaJpWdZwa-xQVU9AHEo9DuI,26863
+h11/_events.py,sha256=I97aXoal1Wu7dkL548BANBUCkOIbe-x5CioYA9IBY14,11792
+h11/_headers.py,sha256=P7D-lBNxHwdLZPLimmYwrPG-9ZkjElvvJZJdZAgSP-4,10412
+h11/_readers.py,sha256=a4RypORUCC3d0q_kxPuBIM7jTD8iLt5X91TH0FsduN4,8590
+h11/_receivebuffer.py,sha256=xrspsdsNgWFxRfQcTXxR8RrdjRXXTK0Io5cQYWpJ1Ws,5252
+h11/_state.py,sha256=_5LG_BGR8FCcFQeBPH-TMHgm_-B-EUcWCnQof_9XjFE,13231
+h11/_util.py,sha256=LWkkjXyJaFlAy6Lt39w73UStklFT5ovcvo0TkY7RYuk,4888
+h11/_version.py,sha256=GVSsbPSPDcOuF6ptfIiXnVJoaEm3ygXbMnqlr_Giahw,686
+h11/_writers.py,sha256=oFKm6PtjeHfbj4RLX7VB7KDc1gIY53gXG3_HR9ltmTA,5081
+h11/py.typed,sha256=sow9soTwP9T_gEAQSVh7Gb8855h04Nwmhs2We-JRgZM,7
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/REQUESTED
new file mode 100644
index 00000000..e69de29b
diff --git a/Backend/venv/lib/python3.12/site-packages/Jinja2-3.1.2.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/WHEEL
similarity index 65%
rename from Backend/venv/lib/python3.12/site-packages/Jinja2-3.1.2.dist-info/WHEEL
rename to Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/WHEEL
index becc9a66..1eb3c49d 100644
--- a/Backend/venv/lib/python3.12/site-packages/Jinja2-3.1.2.dist-info/WHEEL
+++ b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/WHEEL
@@ -1,5 +1,5 @@
Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: setuptools (78.1.0)
Root-Is-Purelib: true
Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/LICENSE.txt b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/licenses/LICENSE.txt
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/LICENSE.txt
rename to Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/licenses/LICENSE.txt
diff --git a/Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/top_level.txt b/Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/top_level.txt
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/h11-0.14.0.dist-info/top_level.txt
rename to Backend/venv/lib/python3.12/site-packages/h11-0.16.0.dist-info/top_level.txt
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/__init__.cpython-312.pyc
index 4a3f03b2..0247928a 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_abnf.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_abnf.cpython-312.pyc
index 307efa92..9dcae32d 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_abnf.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_abnf.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_connection.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_connection.cpython-312.pyc
index 98a0b898..ea591968 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_connection.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_connection.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_events.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_events.cpython-312.pyc
index ed8b0b5f..4fcde37e 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_events.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_events.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_headers.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_headers.cpython-312.pyc
index 9bf9871b..b11289dd 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_headers.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_headers.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_readers.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_readers.cpython-312.pyc
index 749eb35d..93326e0d 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_readers.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_readers.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_receivebuffer.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_receivebuffer.cpython-312.pyc
index 212f53a1..806049b9 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_receivebuffer.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_receivebuffer.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_state.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_state.cpython-312.pyc
index 6e8e60f3..1d6a43b5 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_state.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_state.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_util.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_util.cpython-312.pyc
index 409a1fc9..a7989872 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_util.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_util.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_version.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_version.cpython-312.pyc
index e18a8f40..9da6d269 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_version.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_version.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_writers.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_writers.cpython-312.pyc
index f4ca341c..d36f906e 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_writers.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/h11/__pycache__/_writers.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/_connection.py b/Backend/venv/lib/python3.12/site-packages/h11/_connection.py
index d1752707..e37d82a8 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11/_connection.py
+++ b/Backend/venv/lib/python3.12/site-packages/h11/_connection.py
@@ -1,6 +1,17 @@
# This contains the main Connection class. Everything in h11 revolves around
# this.
-from typing import Any, Callable, cast, Dict, List, Optional, Tuple, Type, Union
+from typing import (
+ Any,
+ Callable,
+ cast,
+ Dict,
+ List,
+ Optional,
+ overload,
+ Tuple,
+ Type,
+ Union,
+)
from ._events import (
ConnectionClosed,
@@ -57,6 +68,7 @@ class PAUSED(Sentinel, metaclass=Sentinel):
# - Apache: <8 KiB per line>
DEFAULT_MAX_INCOMPLETE_EVENT_SIZE = 16 * 1024
+
# RFC 7230's rules for connection lifecycles:
# - If either side says they want to close the connection, then the connection
# must close.
@@ -160,7 +172,7 @@ class Connection:
self._max_incomplete_event_size = max_incomplete_event_size
# State and role tracking
if our_role not in (CLIENT, SERVER):
- raise ValueError("expected CLIENT or SERVER, not {!r}".format(our_role))
+ raise ValueError(f"expected CLIENT or SERVER, not {our_role!r}")
self.our_role = our_role
self.their_role: Type[Sentinel]
if our_role is CLIENT:
@@ -416,7 +428,7 @@ class Connection:
# return that event, and then the state will change and we'll
# get called again to generate the actual ConnectionClosed().
if hasattr(self._reader, "read_eof"):
- event = self._reader.read_eof() # type: ignore[attr-defined]
+ event = self._reader.read_eof()
else:
event = ConnectionClosed()
if event is None:
@@ -488,6 +500,20 @@ class Connection:
else:
raise
+ @overload
+ def send(self, event: ConnectionClosed) -> None:
+ ...
+
+ @overload
+ def send(
+ self, event: Union[Request, InformationalResponse, Response, Data, EndOfMessage]
+ ) -> bytes:
+ ...
+
+ @overload
+ def send(self, event: Event) -> Optional[bytes]:
+ ...
+
def send(self, event: Event) -> Optional[bytes]:
"""Convert a high-level event into bytes that can be sent to the peer,
while updating our internal state machine.
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/_events.py b/Backend/venv/lib/python3.12/site-packages/h11/_events.py
index 075bf8a4..ca1c3adb 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11/_events.py
+++ b/Backend/venv/lib/python3.12/site-packages/h11/_events.py
@@ -7,8 +7,8 @@
import re
from abc import ABC
-from dataclasses import dataclass, field
-from typing import Any, cast, Dict, List, Tuple, Union
+from dataclasses import dataclass
+from typing import List, Tuple, Union
from ._abnf import method, request_target
from ._headers import Headers, normalize_and_validate
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/_headers.py b/Backend/venv/lib/python3.12/site-packages/h11/_headers.py
index b97d020b..31da3e2b 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11/_headers.py
+++ b/Backend/venv/lib/python3.12/site-packages/h11/_headers.py
@@ -12,6 +12,8 @@ try:
except ImportError:
from typing_extensions import Literal # type: ignore
+CONTENT_LENGTH_MAX_DIGITS = 20 # allow up to 1 billion TB - 1
+
# Facts
# -----
@@ -173,6 +175,8 @@ def normalize_and_validate(
raise LocalProtocolError("conflicting Content-Length headers")
value = lengths.pop()
validate(_content_length_re, value, "bad Content-Length")
+ if len(value) > CONTENT_LENGTH_MAX_DIGITS:
+ raise LocalProtocolError("bad Content-Length")
if seen_content_length is None:
seen_content_length = value
new_headers.append((raw_name, name, value))
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/_readers.py b/Backend/venv/lib/python3.12/site-packages/h11/_readers.py
index 08a9574d..576804cc 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11/_readers.py
+++ b/Backend/venv/lib/python3.12/site-packages/h11/_readers.py
@@ -148,10 +148,9 @@ chunk_header_re = re.compile(chunk_header.encode("ascii"))
class ChunkedReader:
def __init__(self) -> None:
self._bytes_in_chunk = 0
- # After reading a chunk, we have to throw away the trailing \r\n; if
- # this is >0 then we discard that many bytes before resuming regular
- # de-chunkification.
- self._bytes_to_discard = 0
+ # After reading a chunk, we have to throw away the trailing \r\n.
+ # This tracks the bytes that we need to match and throw away.
+ self._bytes_to_discard = b""
self._reading_trailer = False
def __call__(self, buf: ReceiveBuffer) -> Union[Data, EndOfMessage, None]:
@@ -160,15 +159,19 @@ class ChunkedReader:
if lines is None:
return None
return EndOfMessage(headers=list(_decode_header_lines(lines)))
- if self._bytes_to_discard > 0:
- data = buf.maybe_extract_at_most(self._bytes_to_discard)
+ if self._bytes_to_discard:
+ data = buf.maybe_extract_at_most(len(self._bytes_to_discard))
if data is None:
return None
- self._bytes_to_discard -= len(data)
- if self._bytes_to_discard > 0:
+ if data != self._bytes_to_discard[: len(data)]:
+ raise LocalProtocolError(
+ f"malformed chunk footer: {data!r} (expected {self._bytes_to_discard!r})"
+ )
+ self._bytes_to_discard = self._bytes_to_discard[len(data) :]
+ if self._bytes_to_discard:
return None
# else, fall through and read some more
- assert self._bytes_to_discard == 0
+ assert self._bytes_to_discard == b""
if self._bytes_in_chunk == 0:
# We need to refill our chunk count
chunk_header = buf.maybe_extract_next_line()
@@ -194,7 +197,7 @@ class ChunkedReader:
return None
self._bytes_in_chunk -= len(data)
if self._bytes_in_chunk == 0:
- self._bytes_to_discard = 2
+ self._bytes_to_discard = b"\r\n"
chunk_end = True
else:
chunk_end = False
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/_state.py b/Backend/venv/lib/python3.12/site-packages/h11/_state.py
index 3593430a..3ad444b0 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11/_state.py
+++ b/Backend/venv/lib/python3.12/site-packages/h11/_state.py
@@ -283,9 +283,7 @@ class ConnectionState:
assert role is SERVER
if server_switch_event not in self.pending_switch_proposals:
raise LocalProtocolError(
- "Received server {} event without a pending proposal".format(
- server_switch_event
- )
+ "Received server _SWITCH_UPGRADE event without a pending proposal"
)
_event_type = (event_type, server_switch_event)
if server_switch_event is None and _event_type is Response:
@@ -358,7 +356,7 @@ class ConnectionState:
def start_next_cycle(self) -> None:
if self.states != {CLIENT: DONE, SERVER: DONE}:
raise LocalProtocolError(
- "not in a reusable state. self.states={}".format(self.states)
+ f"not in a reusable state. self.states={self.states}"
)
# Can't reach DONE/DONE with any of these active, but still, let's be
# sure.
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/_version.py b/Backend/venv/lib/python3.12/site-packages/h11/_version.py
index 4c891130..76e7327b 100644
--- a/Backend/venv/lib/python3.12/site-packages/h11/_version.py
+++ b/Backend/venv/lib/python3.12/site-packages/h11/_version.py
@@ -13,4 +13,4 @@
# want. (Contrast with the special suffix 1.0.0.dev, which sorts *before*
# 1.0.0.)
-__version__ = "0.14.0"
+__version__ = "0.16.0"
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/data/test-file b/Backend/venv/lib/python3.12/site-packages/h11/tests/data/test-file
deleted file mode 100644
index d0be0a6c..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/data/test-file
+++ /dev/null
@@ -1 +0,0 @@
-92b12bc045050b55b848d37167a1a63947c364579889ce1d39788e45e9fac9e5
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/helpers.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/helpers.py
deleted file mode 100644
index 571be444..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/helpers.py
+++ /dev/null
@@ -1,101 +0,0 @@
-from typing import cast, List, Type, Union, ValuesView
-
-from .._connection import Connection, NEED_DATA, PAUSED
-from .._events import (
- ConnectionClosed,
- Data,
- EndOfMessage,
- Event,
- InformationalResponse,
- Request,
- Response,
-)
-from .._state import CLIENT, CLOSED, DONE, MUST_CLOSE, SERVER
-from .._util import Sentinel
-
-try:
- from typing import Literal
-except ImportError:
- from typing_extensions import Literal # type: ignore
-
-
-def get_all_events(conn: Connection) -> List[Event]:
- got_events = []
- while True:
- event = conn.next_event()
- if event in (NEED_DATA, PAUSED):
- break
- event = cast(Event, event)
- got_events.append(event)
- if type(event) is ConnectionClosed:
- break
- return got_events
-
-
-def receive_and_get(conn: Connection, data: bytes) -> List[Event]:
- conn.receive_data(data)
- return get_all_events(conn)
-
-
-# Merges adjacent Data events, converts payloads to bytestrings, and removes
-# chunk boundaries.
-def normalize_data_events(in_events: List[Event]) -> List[Event]:
- out_events: List[Event] = []
- for event in in_events:
- if type(event) is Data:
- event = Data(data=bytes(event.data), chunk_start=False, chunk_end=False)
- if out_events and type(out_events[-1]) is type(event) is Data:
- out_events[-1] = Data(
- data=out_events[-1].data + event.data,
- chunk_start=out_events[-1].chunk_start,
- chunk_end=out_events[-1].chunk_end,
- )
- else:
- out_events.append(event)
- return out_events
-
-
-# Given that we want to write tests that push some events through a Connection
-# and check that its state updates appropriately... we might as make a habit
-# of pushing them through two Connections with a fake network link in
-# between.
-class ConnectionPair:
- def __init__(self) -> None:
- self.conn = {CLIENT: Connection(CLIENT), SERVER: Connection(SERVER)}
- self.other = {CLIENT: SERVER, SERVER: CLIENT}
-
- @property
- def conns(self) -> ValuesView[Connection]:
- return self.conn.values()
-
- # expect="match" if expect=send_events; expect=[...] to say what expected
- def send(
- self,
- role: Type[Sentinel],
- send_events: Union[List[Event], Event],
- expect: Union[List[Event], Event, Literal["match"]] = "match",
- ) -> bytes:
- if not isinstance(send_events, list):
- send_events = [send_events]
- data = b""
- closed = False
- for send_event in send_events:
- new_data = self.conn[role].send(send_event)
- if new_data is None:
- closed = True
- else:
- data += new_data
- # send uses b"" to mean b"", and None to mean closed
- # receive uses b"" to mean closed, and None to mean "try again"
- # so we have to translate between the two conventions
- if data:
- self.conn[self.other[role]].receive_data(data)
- if closed:
- self.conn[self.other[role]].receive_data(b"")
- got_events = get_all_events(self.conn[self.other[role]])
- if expect == "match":
- expect = send_events
- if not isinstance(expect, list):
- expect = [expect]
- assert got_events == expect
- return data
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_against_stdlib_http.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_against_stdlib_http.py
deleted file mode 100644
index d2ee1314..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_against_stdlib_http.py
+++ /dev/null
@@ -1,115 +0,0 @@
-import json
-import os.path
-import socket
-import socketserver
-import threading
-from contextlib import closing, contextmanager
-from http.server import SimpleHTTPRequestHandler
-from typing import Callable, Generator
-from urllib.request import urlopen
-
-import h11
-
-
-@contextmanager
-def socket_server(
- handler: Callable[..., socketserver.BaseRequestHandler]
-) -> Generator[socketserver.TCPServer, None, None]:
- httpd = socketserver.TCPServer(("127.0.0.1", 0), handler)
- thread = threading.Thread(
- target=httpd.serve_forever, kwargs={"poll_interval": 0.01}
- )
- thread.daemon = True
- try:
- thread.start()
- yield httpd
- finally:
- httpd.shutdown()
-
-
-test_file_path = os.path.join(os.path.dirname(__file__), "data/test-file")
-with open(test_file_path, "rb") as f:
- test_file_data = f.read()
-
-
-class SingleMindedRequestHandler(SimpleHTTPRequestHandler):
- def translate_path(self, path: str) -> str:
- return test_file_path
-
-
-def test_h11_as_client() -> None:
- with socket_server(SingleMindedRequestHandler) as httpd:
- with closing(socket.create_connection(httpd.server_address)) as s:
- c = h11.Connection(h11.CLIENT)
-
- s.sendall(
- c.send( # type: ignore[arg-type]
- h11.Request(
- method="GET", target="/foo", headers=[("Host", "localhost")]
- )
- )
- )
- s.sendall(c.send(h11.EndOfMessage())) # type: ignore[arg-type]
-
- data = bytearray()
- while True:
- event = c.next_event()
- print(event)
- if event is h11.NEED_DATA:
- # Use a small read buffer to make things more challenging
- # and exercise more paths :-)
- c.receive_data(s.recv(10))
- continue
- if type(event) is h11.Response:
- assert event.status_code == 200
- if type(event) is h11.Data:
- data += event.data
- if type(event) is h11.EndOfMessage:
- break
- assert bytes(data) == test_file_data
-
-
-class H11RequestHandler(socketserver.BaseRequestHandler):
- def handle(self) -> None:
- with closing(self.request) as s:
- c = h11.Connection(h11.SERVER)
- request = None
- while True:
- event = c.next_event()
- if event is h11.NEED_DATA:
- # Use a small read buffer to make things more challenging
- # and exercise more paths :-)
- c.receive_data(s.recv(10))
- continue
- if type(event) is h11.Request:
- request = event
- if type(event) is h11.EndOfMessage:
- break
- assert request is not None
- info = json.dumps(
- {
- "method": request.method.decode("ascii"),
- "target": request.target.decode("ascii"),
- "headers": {
- name.decode("ascii"): value.decode("ascii")
- for (name, value) in request.headers
- },
- }
- )
- s.sendall(c.send(h11.Response(status_code=200, headers=[]))) # type: ignore[arg-type]
- s.sendall(c.send(h11.Data(data=info.encode("ascii"))))
- s.sendall(c.send(h11.EndOfMessage()))
-
-
-def test_h11_as_server() -> None:
- with socket_server(H11RequestHandler) as httpd:
- host, port = httpd.server_address
- url = "http://{}:{}/some-path".format(host, port)
- with closing(urlopen(url)) as f:
- assert f.getcode() == 200
- data = f.read()
- info = json.loads(data.decode("ascii"))
- print(info)
- assert info["method"] == "GET"
- assert info["target"] == "/some-path"
- assert "urllib" in info["headers"]["user-agent"]
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_connection.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_connection.py
deleted file mode 100644
index 73a27b98..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_connection.py
+++ /dev/null
@@ -1,1122 +0,0 @@
-from typing import Any, cast, Dict, List, Optional, Tuple, Type
-
-import pytest
-
-from .._connection import _body_framing, _keep_alive, Connection, NEED_DATA, PAUSED
-from .._events import (
- ConnectionClosed,
- Data,
- EndOfMessage,
- Event,
- InformationalResponse,
- Request,
- Response,
-)
-from .._state import (
- CLIENT,
- CLOSED,
- DONE,
- ERROR,
- IDLE,
- MIGHT_SWITCH_PROTOCOL,
- MUST_CLOSE,
- SEND_BODY,
- SEND_RESPONSE,
- SERVER,
- SWITCHED_PROTOCOL,
-)
-from .._util import LocalProtocolError, RemoteProtocolError, Sentinel
-from .helpers import ConnectionPair, get_all_events, receive_and_get
-
-
-def test__keep_alive() -> None:
- assert _keep_alive(
- Request(method="GET", target="/", headers=[("Host", "Example.com")])
- )
- assert not _keep_alive(
- Request(
- method="GET",
- target="/",
- headers=[("Host", "Example.com"), ("Connection", "close")],
- )
- )
- assert not _keep_alive(
- Request(
- method="GET",
- target="/",
- headers=[("Host", "Example.com"), ("Connection", "a, b, cLOse, foo")],
- )
- )
- assert not _keep_alive(
- Request(method="GET", target="/", headers=[], http_version="1.0") # type: ignore[arg-type]
- )
-
- assert _keep_alive(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- assert not _keep_alive(Response(status_code=200, headers=[("Connection", "close")]))
- assert not _keep_alive(
- Response(status_code=200, headers=[("Connection", "a, b, cLOse, foo")])
- )
- assert not _keep_alive(Response(status_code=200, headers=[], http_version="1.0")) # type: ignore[arg-type]
-
-
-def test__body_framing() -> None:
- def headers(cl: Optional[int], te: bool) -> List[Tuple[str, str]]:
- headers = []
- if cl is not None:
- headers.append(("Content-Length", str(cl)))
- if te:
- headers.append(("Transfer-Encoding", "chunked"))
- return headers
-
- def resp(
- status_code: int = 200, cl: Optional[int] = None, te: bool = False
- ) -> Response:
- return Response(status_code=status_code, headers=headers(cl, te))
-
- def req(cl: Optional[int] = None, te: bool = False) -> Request:
- h = headers(cl, te)
- h += [("Host", "example.com")]
- return Request(method="GET", target="/", headers=h)
-
- # Special cases where the headers are ignored:
- for kwargs in [{}, {"cl": 100}, {"te": True}, {"cl": 100, "te": True}]:
- kwargs = cast(Dict[str, Any], kwargs)
- for meth, r in [
- (b"HEAD", resp(**kwargs)),
- (b"GET", resp(status_code=204, **kwargs)),
- (b"GET", resp(status_code=304, **kwargs)),
- ]:
- assert _body_framing(meth, r) == ("content-length", (0,))
-
- # Transfer-encoding
- for kwargs in [{"te": True}, {"cl": 100, "te": True}]:
- kwargs = cast(Dict[str, Any], kwargs)
- for meth, r in [(None, req(**kwargs)), (b"GET", resp(**kwargs))]: # type: ignore
- assert _body_framing(meth, r) == ("chunked", ())
-
- # Content-Length
- for meth, r in [(None, req(cl=100)), (b"GET", resp(cl=100))]: # type: ignore
- assert _body_framing(meth, r) == ("content-length", (100,))
-
- # No headers
- assert _body_framing(None, req()) == ("content-length", (0,)) # type: ignore
- assert _body_framing(b"GET", resp()) == ("http/1.0", ())
-
-
-def test_Connection_basics_and_content_length() -> None:
- with pytest.raises(ValueError):
- Connection("CLIENT") # type: ignore
-
- p = ConnectionPair()
- assert p.conn[CLIENT].our_role is CLIENT
- assert p.conn[CLIENT].their_role is SERVER
- assert p.conn[SERVER].our_role is SERVER
- assert p.conn[SERVER].their_role is CLIENT
-
- data = p.send(
- CLIENT,
- Request(
- method="GET",
- target="/",
- headers=[("Host", "example.com"), ("Content-Length", "10")],
- ),
- )
- assert data == (
- b"GET / HTTP/1.1\r\n" b"Host: example.com\r\n" b"Content-Length: 10\r\n\r\n"
- )
-
- for conn in p.conns:
- assert conn.states == {CLIENT: SEND_BODY, SERVER: SEND_RESPONSE}
- assert p.conn[CLIENT].our_state is SEND_BODY
- assert p.conn[CLIENT].their_state is SEND_RESPONSE
- assert p.conn[SERVER].our_state is SEND_RESPONSE
- assert p.conn[SERVER].their_state is SEND_BODY
-
- assert p.conn[CLIENT].their_http_version is None
- assert p.conn[SERVER].their_http_version == b"1.1"
-
- data = p.send(SERVER, InformationalResponse(status_code=100, headers=[])) # type: ignore[arg-type]
- assert data == b"HTTP/1.1 100 \r\n\r\n"
-
- data = p.send(SERVER, Response(status_code=200, headers=[("Content-Length", "11")]))
- assert data == b"HTTP/1.1 200 \r\nContent-Length: 11\r\n\r\n"
-
- for conn in p.conns:
- assert conn.states == {CLIENT: SEND_BODY, SERVER: SEND_BODY}
-
- assert p.conn[CLIENT].their_http_version == b"1.1"
- assert p.conn[SERVER].their_http_version == b"1.1"
-
- data = p.send(CLIENT, Data(data=b"12345"))
- assert data == b"12345"
- data = p.send(
- CLIENT, Data(data=b"67890"), expect=[Data(data=b"67890"), EndOfMessage()]
- )
- assert data == b"67890"
- data = p.send(CLIENT, EndOfMessage(), expect=[])
- assert data == b""
-
- for conn in p.conns:
- assert conn.states == {CLIENT: DONE, SERVER: SEND_BODY}
-
- data = p.send(SERVER, Data(data=b"1234567890"))
- assert data == b"1234567890"
- data = p.send(SERVER, Data(data=b"1"), expect=[Data(data=b"1"), EndOfMessage()])
- assert data == b"1"
- data = p.send(SERVER, EndOfMessage(), expect=[])
- assert data == b""
-
- for conn in p.conns:
- assert conn.states == {CLIENT: DONE, SERVER: DONE}
-
-
-def test_chunked() -> None:
- p = ConnectionPair()
-
- p.send(
- CLIENT,
- Request(
- method="GET",
- target="/",
- headers=[("Host", "example.com"), ("Transfer-Encoding", "chunked")],
- ),
- )
- data = p.send(CLIENT, Data(data=b"1234567890", chunk_start=True, chunk_end=True))
- assert data == b"a\r\n1234567890\r\n"
- data = p.send(CLIENT, Data(data=b"abcde", chunk_start=True, chunk_end=True))
- assert data == b"5\r\nabcde\r\n"
- data = p.send(CLIENT, Data(data=b""), expect=[])
- assert data == b""
- data = p.send(CLIENT, EndOfMessage(headers=[("hello", "there")]))
- assert data == b"0\r\nhello: there\r\n\r\n"
-
- p.send(
- SERVER, Response(status_code=200, headers=[("Transfer-Encoding", "chunked")])
- )
- p.send(SERVER, Data(data=b"54321", chunk_start=True, chunk_end=True))
- p.send(SERVER, Data(data=b"12345", chunk_start=True, chunk_end=True))
- p.send(SERVER, EndOfMessage())
-
- for conn in p.conns:
- assert conn.states == {CLIENT: DONE, SERVER: DONE}
-
-
-def test_chunk_boundaries() -> None:
- conn = Connection(our_role=SERVER)
-
- request = (
- b"POST / HTTP/1.1\r\n"
- b"Host: example.com\r\n"
- b"Transfer-Encoding: chunked\r\n"
- b"\r\n"
- )
- conn.receive_data(request)
- assert conn.next_event() == Request(
- method="POST",
- target="/",
- headers=[("Host", "example.com"), ("Transfer-Encoding", "chunked")],
- )
- assert conn.next_event() is NEED_DATA
-
- conn.receive_data(b"5\r\nhello\r\n")
- assert conn.next_event() == Data(data=b"hello", chunk_start=True, chunk_end=True)
-
- conn.receive_data(b"5\r\nhel")
- assert conn.next_event() == Data(data=b"hel", chunk_start=True, chunk_end=False)
-
- conn.receive_data(b"l")
- assert conn.next_event() == Data(data=b"l", chunk_start=False, chunk_end=False)
-
- conn.receive_data(b"o\r\n")
- assert conn.next_event() == Data(data=b"o", chunk_start=False, chunk_end=True)
-
- conn.receive_data(b"5\r\nhello")
- assert conn.next_event() == Data(data=b"hello", chunk_start=True, chunk_end=True)
-
- conn.receive_data(b"\r\n")
- assert conn.next_event() == NEED_DATA
-
- conn.receive_data(b"0\r\n\r\n")
- assert conn.next_event() == EndOfMessage()
-
-
-def test_client_talking_to_http10_server() -> None:
- c = Connection(CLIENT)
- c.send(Request(method="GET", target="/", headers=[("Host", "example.com")]))
- c.send(EndOfMessage())
- assert c.our_state is DONE
- # No content-length, so Http10 framing for body
- assert receive_and_get(c, b"HTTP/1.0 200 OK\r\n\r\n") == [
- Response(status_code=200, headers=[], http_version="1.0", reason=b"OK") # type: ignore[arg-type]
- ]
- assert c.our_state is MUST_CLOSE
- assert receive_and_get(c, b"12345") == [Data(data=b"12345")]
- assert receive_and_get(c, b"67890") == [Data(data=b"67890")]
- assert receive_and_get(c, b"") == [EndOfMessage(), ConnectionClosed()]
- assert c.their_state is CLOSED
-
-
-def test_server_talking_to_http10_client() -> None:
- c = Connection(SERVER)
- # No content-length, so no body
- # NB: no host header
- assert receive_and_get(c, b"GET / HTTP/1.0\r\n\r\n") == [
- Request(method="GET", target="/", headers=[], http_version="1.0"), # type: ignore[arg-type]
- EndOfMessage(),
- ]
- assert c.their_state is MUST_CLOSE
-
- # We automatically Connection: close back at them
- assert (
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- == b"HTTP/1.1 200 \r\nConnection: close\r\n\r\n"
- )
-
- assert c.send(Data(data=b"12345")) == b"12345"
- assert c.send(EndOfMessage()) == b""
- assert c.our_state is MUST_CLOSE
-
- # Check that it works if they do send Content-Length
- c = Connection(SERVER)
- # NB: no host header
- assert receive_and_get(c, b"POST / HTTP/1.0\r\nContent-Length: 10\r\n\r\n1") == [
- Request(
- method="POST",
- target="/",
- headers=[("Content-Length", "10")],
- http_version="1.0",
- ),
- Data(data=b"1"),
- ]
- assert receive_and_get(c, b"234567890") == [Data(data=b"234567890"), EndOfMessage()]
- assert c.their_state is MUST_CLOSE
- assert receive_and_get(c, b"") == [ConnectionClosed()]
-
-
-def test_automatic_transfer_encoding_in_response() -> None:
- # Check that in responses, the user can specify either Transfer-Encoding:
- # chunked or no framing at all, and in both cases we automatically select
- # the right option depending on whether the peer speaks HTTP/1.0 or
- # HTTP/1.1
- for user_headers in [
- [("Transfer-Encoding", "chunked")],
- [],
- # In fact, this even works if Content-Length is set,
- # because if both are set then Transfer-Encoding wins
- [("Transfer-Encoding", "chunked"), ("Content-Length", "100")],
- ]:
- user_headers = cast(List[Tuple[str, str]], user_headers)
- p = ConnectionPair()
- p.send(
- CLIENT,
- [
- Request(method="GET", target="/", headers=[("Host", "example.com")]),
- EndOfMessage(),
- ],
- )
- # When speaking to HTTP/1.1 client, all of the above cases get
- # normalized to Transfer-Encoding: chunked
- p.send(
- SERVER,
- Response(status_code=200, headers=user_headers),
- expect=Response(
- status_code=200, headers=[("Transfer-Encoding", "chunked")]
- ),
- )
-
- # When speaking to HTTP/1.0 client, all of the above cases get
- # normalized to no-framing-headers
- c = Connection(SERVER)
- receive_and_get(c, b"GET / HTTP/1.0\r\n\r\n")
- assert (
- c.send(Response(status_code=200, headers=user_headers))
- == b"HTTP/1.1 200 \r\nConnection: close\r\n\r\n"
- )
- assert c.send(Data(data=b"12345")) == b"12345"
-
-
-def test_automagic_connection_close_handling() -> None:
- p = ConnectionPair()
- # If the user explicitly sets Connection: close, then we notice and
- # respect it
- p.send(
- CLIENT,
- [
- Request(
- method="GET",
- target="/",
- headers=[("Host", "example.com"), ("Connection", "close")],
- ),
- EndOfMessage(),
- ],
- )
- for conn in p.conns:
- assert conn.states[CLIENT] is MUST_CLOSE
- # And if the client sets it, the server automatically echoes it back
- p.send(
- SERVER,
- # no header here...
- [Response(status_code=204, headers=[]), EndOfMessage()], # type: ignore[arg-type]
- # ...but oh look, it arrived anyway
- expect=[
- Response(status_code=204, headers=[("connection", "close")]),
- EndOfMessage(),
- ],
- )
- for conn in p.conns:
- assert conn.states == {CLIENT: MUST_CLOSE, SERVER: MUST_CLOSE}
-
-
-def test_100_continue() -> None:
- def setup() -> ConnectionPair:
- p = ConnectionPair()
- p.send(
- CLIENT,
- Request(
- method="GET",
- target="/",
- headers=[
- ("Host", "example.com"),
- ("Content-Length", "100"),
- ("Expect", "100-continue"),
- ],
- ),
- )
- for conn in p.conns:
- assert conn.client_is_waiting_for_100_continue
- assert not p.conn[CLIENT].they_are_waiting_for_100_continue
- assert p.conn[SERVER].they_are_waiting_for_100_continue
- return p
-
- # Disabled by 100 Continue
- p = setup()
- p.send(SERVER, InformationalResponse(status_code=100, headers=[])) # type: ignore[arg-type]
- for conn in p.conns:
- assert not conn.client_is_waiting_for_100_continue
- assert not conn.they_are_waiting_for_100_continue
-
- # Disabled by a real response
- p = setup()
- p.send(
- SERVER, Response(status_code=200, headers=[("Transfer-Encoding", "chunked")])
- )
- for conn in p.conns:
- assert not conn.client_is_waiting_for_100_continue
- assert not conn.they_are_waiting_for_100_continue
-
- # Disabled by the client going ahead and sending stuff anyway
- p = setup()
- p.send(CLIENT, Data(data=b"12345"))
- for conn in p.conns:
- assert not conn.client_is_waiting_for_100_continue
- assert not conn.they_are_waiting_for_100_continue
-
-
-def test_max_incomplete_event_size_countermeasure() -> None:
- # Infinitely long headers are definitely not okay
- c = Connection(SERVER)
- c.receive_data(b"GET / HTTP/1.0\r\nEndless: ")
- assert c.next_event() is NEED_DATA
- with pytest.raises(RemoteProtocolError):
- while True:
- c.receive_data(b"a" * 1024)
- c.next_event()
-
- # Checking that the same header is accepted / rejected depending on the
- # max_incomplete_event_size setting:
- c = Connection(SERVER, max_incomplete_event_size=5000)
- c.receive_data(b"GET / HTTP/1.0\r\nBig: ")
- c.receive_data(b"a" * 4000)
- c.receive_data(b"\r\n\r\n")
- assert get_all_events(c) == [
- Request(
- method="GET", target="/", http_version="1.0", headers=[("big", "a" * 4000)]
- ),
- EndOfMessage(),
- ]
-
- c = Connection(SERVER, max_incomplete_event_size=4000)
- c.receive_data(b"GET / HTTP/1.0\r\nBig: ")
- c.receive_data(b"a" * 4000)
- with pytest.raises(RemoteProtocolError):
- c.next_event()
-
- # Temporarily exceeding the size limit is fine, as long as its done with
- # complete events:
- c = Connection(SERVER, max_incomplete_event_size=5000)
- c.receive_data(b"GET / HTTP/1.0\r\nContent-Length: 10000")
- c.receive_data(b"\r\n\r\n" + b"a" * 10000)
- assert get_all_events(c) == [
- Request(
- method="GET",
- target="/",
- http_version="1.0",
- headers=[("Content-Length", "10000")],
- ),
- Data(data=b"a" * 10000),
- EndOfMessage(),
- ]
-
- c = Connection(SERVER, max_incomplete_event_size=100)
- # Two pipelined requests to create a way-too-big receive buffer... but
- # it's fine because we're not checking
- c.receive_data(
- b"GET /1 HTTP/1.1\r\nHost: a\r\n\r\n"
- b"GET /2 HTTP/1.1\r\nHost: b\r\n\r\n" + b"X" * 1000
- )
- assert get_all_events(c) == [
- Request(method="GET", target="/1", headers=[("host", "a")]),
- EndOfMessage(),
- ]
- # Even more data comes in, still no problem
- c.receive_data(b"X" * 1000)
- # We can respond and reuse to get the second pipelined request
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- c.send(EndOfMessage())
- c.start_next_cycle()
- assert get_all_events(c) == [
- Request(method="GET", target="/2", headers=[("host", "b")]),
- EndOfMessage(),
- ]
- # But once we unpause and try to read the next message, and find that it's
- # incomplete and the buffer is *still* way too large, then *that's* a
- # problem:
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- c.send(EndOfMessage())
- c.start_next_cycle()
- with pytest.raises(RemoteProtocolError):
- c.next_event()
-
-
-def test_reuse_simple() -> None:
- p = ConnectionPair()
- p.send(
- CLIENT,
- [Request(method="GET", target="/", headers=[("Host", "a")]), EndOfMessage()],
- )
- p.send(
- SERVER,
- [
- Response(status_code=200, headers=[(b"transfer-encoding", b"chunked")]),
- EndOfMessage(),
- ],
- )
- for conn in p.conns:
- assert conn.states == {CLIENT: DONE, SERVER: DONE}
- conn.start_next_cycle()
-
- p.send(
- CLIENT,
- [
- Request(method="DELETE", target="/foo", headers=[("Host", "a")]),
- EndOfMessage(),
- ],
- )
- p.send(
- SERVER,
- [
- Response(status_code=404, headers=[(b"transfer-encoding", b"chunked")]),
- EndOfMessage(),
- ],
- )
-
-
-def test_pipelining() -> None:
- # Client doesn't support pipelining, so we have to do this by hand
- c = Connection(SERVER)
- assert c.next_event() is NEED_DATA
- # 3 requests all bunched up
- c.receive_data(
- b"GET /1 HTTP/1.1\r\nHost: a.com\r\nContent-Length: 5\r\n\r\n"
- b"12345"
- b"GET /2 HTTP/1.1\r\nHost: a.com\r\nContent-Length: 5\r\n\r\n"
- b"67890"
- b"GET /3 HTTP/1.1\r\nHost: a.com\r\n\r\n"
- )
- assert get_all_events(c) == [
- Request(
- method="GET",
- target="/1",
- headers=[("Host", "a.com"), ("Content-Length", "5")],
- ),
- Data(data=b"12345"),
- EndOfMessage(),
- ]
- assert c.their_state is DONE
- assert c.our_state is SEND_RESPONSE
-
- assert c.next_event() is PAUSED
-
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- c.send(EndOfMessage())
- assert c.their_state is DONE
- assert c.our_state is DONE
-
- c.start_next_cycle()
-
- assert get_all_events(c) == [
- Request(
- method="GET",
- target="/2",
- headers=[("Host", "a.com"), ("Content-Length", "5")],
- ),
- Data(data=b"67890"),
- EndOfMessage(),
- ]
- assert c.next_event() is PAUSED
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- c.send(EndOfMessage())
- c.start_next_cycle()
-
- assert get_all_events(c) == [
- Request(method="GET", target="/3", headers=[("Host", "a.com")]),
- EndOfMessage(),
- ]
- # Doesn't pause this time, no trailing data
- assert c.next_event() is NEED_DATA
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- c.send(EndOfMessage())
-
- # Arrival of more data triggers pause
- assert c.next_event() is NEED_DATA
- c.receive_data(b"SADF")
- assert c.next_event() is PAUSED
- assert c.trailing_data == (b"SADF", False)
- # If EOF arrives while paused, we don't see that either:
- c.receive_data(b"")
- assert c.trailing_data == (b"SADF", True)
- assert c.next_event() is PAUSED
- c.receive_data(b"")
- assert c.next_event() is PAUSED
- # Can't call receive_data with non-empty buf after closing it
- with pytest.raises(RuntimeError):
- c.receive_data(b"FDSA")
-
-
-def test_protocol_switch() -> None:
- for (req, deny, accept) in [
- (
- Request(
- method="CONNECT",
- target="example.com:443",
- headers=[("Host", "foo"), ("Content-Length", "1")],
- ),
- Response(status_code=404, headers=[(b"transfer-encoding", b"chunked")]),
- Response(status_code=200, headers=[(b"transfer-encoding", b"chunked")]),
- ),
- (
- Request(
- method="GET",
- target="/",
- headers=[("Host", "foo"), ("Content-Length", "1"), ("Upgrade", "a, b")],
- ),
- Response(status_code=200, headers=[(b"transfer-encoding", b"chunked")]),
- InformationalResponse(status_code=101, headers=[("Upgrade", "a")]),
- ),
- (
- Request(
- method="CONNECT",
- target="example.com:443",
- headers=[("Host", "foo"), ("Content-Length", "1"), ("Upgrade", "a, b")],
- ),
- Response(status_code=404, headers=[(b"transfer-encoding", b"chunked")]),
- # Accept CONNECT, not upgrade
- Response(status_code=200, headers=[(b"transfer-encoding", b"chunked")]),
- ),
- (
- Request(
- method="CONNECT",
- target="example.com:443",
- headers=[("Host", "foo"), ("Content-Length", "1"), ("Upgrade", "a, b")],
- ),
- Response(status_code=404, headers=[(b"transfer-encoding", b"chunked")]),
- # Accept Upgrade, not CONNECT
- InformationalResponse(status_code=101, headers=[("Upgrade", "b")]),
- ),
- ]:
-
- def setup() -> ConnectionPair:
- p = ConnectionPair()
- p.send(CLIENT, req)
- # No switch-related state change stuff yet; the client has to
- # finish the request before that kicks in
- for conn in p.conns:
- assert conn.states[CLIENT] is SEND_BODY
- p.send(CLIENT, [Data(data=b"1"), EndOfMessage()])
- for conn in p.conns:
- assert conn.states[CLIENT] is MIGHT_SWITCH_PROTOCOL
- assert p.conn[SERVER].next_event() is PAUSED
- return p
-
- # Test deny case
- p = setup()
- p.send(SERVER, deny)
- for conn in p.conns:
- assert conn.states == {CLIENT: DONE, SERVER: SEND_BODY}
- p.send(SERVER, EndOfMessage())
- # Check that re-use is still allowed after a denial
- for conn in p.conns:
- conn.start_next_cycle()
-
- # Test accept case
- p = setup()
- p.send(SERVER, accept)
- for conn in p.conns:
- assert conn.states == {CLIENT: SWITCHED_PROTOCOL, SERVER: SWITCHED_PROTOCOL}
- conn.receive_data(b"123")
- assert conn.next_event() is PAUSED
- conn.receive_data(b"456")
- assert conn.next_event() is PAUSED
- assert conn.trailing_data == (b"123456", False)
-
- # Pausing in might-switch, then recovery
- # (weird artificial case where the trailing data actually is valid
- # HTTP for some reason, because this makes it easier to test the state
- # logic)
- p = setup()
- sc = p.conn[SERVER]
- sc.receive_data(b"GET / HTTP/1.0\r\n\r\n")
- assert sc.next_event() is PAUSED
- assert sc.trailing_data == (b"GET / HTTP/1.0\r\n\r\n", False)
- sc.send(deny)
- assert sc.next_event() is PAUSED
- sc.send(EndOfMessage())
- sc.start_next_cycle()
- assert get_all_events(sc) == [
- Request(method="GET", target="/", headers=[], http_version="1.0"), # type: ignore[arg-type]
- EndOfMessage(),
- ]
-
- # When we're DONE, have no trailing data, and the connection gets
- # closed, we report ConnectionClosed(). When we're in might-switch or
- # switched, we don't.
- p = setup()
- sc = p.conn[SERVER]
- sc.receive_data(b"")
- assert sc.next_event() is PAUSED
- assert sc.trailing_data == (b"", True)
- p.send(SERVER, accept)
- assert sc.next_event() is PAUSED
-
- p = setup()
- sc = p.conn[SERVER]
- sc.receive_data(b"")
- assert sc.next_event() is PAUSED
- sc.send(deny)
- assert sc.next_event() == ConnectionClosed()
-
- # You can't send after switching protocols, or while waiting for a
- # protocol switch
- p = setup()
- with pytest.raises(LocalProtocolError):
- p.conn[CLIENT].send(
- Request(method="GET", target="/", headers=[("Host", "a")])
- )
- p = setup()
- p.send(SERVER, accept)
- with pytest.raises(LocalProtocolError):
- p.conn[SERVER].send(Data(data=b"123"))
-
-
-def test_close_simple() -> None:
- # Just immediately closing a new connection without anything having
- # happened yet.
- for (who_shot_first, who_shot_second) in [(CLIENT, SERVER), (SERVER, CLIENT)]:
-
- def setup() -> ConnectionPair:
- p = ConnectionPair()
- p.send(who_shot_first, ConnectionClosed())
- for conn in p.conns:
- assert conn.states == {
- who_shot_first: CLOSED,
- who_shot_second: MUST_CLOSE,
- }
- return p
-
- # You can keep putting b"" into a closed connection, and you keep
- # getting ConnectionClosed() out:
- p = setup()
- assert p.conn[who_shot_second].next_event() == ConnectionClosed()
- assert p.conn[who_shot_second].next_event() == ConnectionClosed()
- p.conn[who_shot_second].receive_data(b"")
- assert p.conn[who_shot_second].next_event() == ConnectionClosed()
- # Second party can close...
- p = setup()
- p.send(who_shot_second, ConnectionClosed())
- for conn in p.conns:
- assert conn.our_state is CLOSED
- assert conn.their_state is CLOSED
- # But trying to receive new data on a closed connection is a
- # RuntimeError (not ProtocolError, because the problem here isn't
- # violation of HTTP, it's violation of physics)
- p = setup()
- with pytest.raises(RuntimeError):
- p.conn[who_shot_second].receive_data(b"123")
- # And receiving new data on a MUST_CLOSE connection is a ProtocolError
- p = setup()
- p.conn[who_shot_first].receive_data(b"GET")
- with pytest.raises(RemoteProtocolError):
- p.conn[who_shot_first].next_event()
-
-
-def test_close_different_states() -> None:
- req = [
- Request(method="GET", target="/foo", headers=[("Host", "a")]),
- EndOfMessage(),
- ]
- resp = [
- Response(status_code=200, headers=[(b"transfer-encoding", b"chunked")]),
- EndOfMessage(),
- ]
-
- # Client before request
- p = ConnectionPair()
- p.send(CLIENT, ConnectionClosed())
- for conn in p.conns:
- assert conn.states == {CLIENT: CLOSED, SERVER: MUST_CLOSE}
-
- # Client after request
- p = ConnectionPair()
- p.send(CLIENT, req)
- p.send(CLIENT, ConnectionClosed())
- for conn in p.conns:
- assert conn.states == {CLIENT: CLOSED, SERVER: SEND_RESPONSE}
-
- # Server after request -> not allowed
- p = ConnectionPair()
- p.send(CLIENT, req)
- with pytest.raises(LocalProtocolError):
- p.conn[SERVER].send(ConnectionClosed())
- p.conn[CLIENT].receive_data(b"")
- with pytest.raises(RemoteProtocolError):
- p.conn[CLIENT].next_event()
-
- # Server after response
- p = ConnectionPair()
- p.send(CLIENT, req)
- p.send(SERVER, resp)
- p.send(SERVER, ConnectionClosed())
- for conn in p.conns:
- assert conn.states == {CLIENT: MUST_CLOSE, SERVER: CLOSED}
-
- # Both after closing (ConnectionClosed() is idempotent)
- p = ConnectionPair()
- p.send(CLIENT, req)
- p.send(SERVER, resp)
- p.send(CLIENT, ConnectionClosed())
- p.send(SERVER, ConnectionClosed())
- p.send(CLIENT, ConnectionClosed())
- p.send(SERVER, ConnectionClosed())
-
- # In the middle of sending -> not allowed
- p = ConnectionPair()
- p.send(
- CLIENT,
- Request(
- method="GET", target="/", headers=[("Host", "a"), ("Content-Length", "10")]
- ),
- )
- with pytest.raises(LocalProtocolError):
- p.conn[CLIENT].send(ConnectionClosed())
- p.conn[SERVER].receive_data(b"")
- with pytest.raises(RemoteProtocolError):
- p.conn[SERVER].next_event()
-
-
-# Receive several requests and then client shuts down their side of the
-# connection; we can respond to each
-def test_pipelined_close() -> None:
- c = Connection(SERVER)
- # 2 requests then a close
- c.receive_data(
- b"GET /1 HTTP/1.1\r\nHost: a.com\r\nContent-Length: 5\r\n\r\n"
- b"12345"
- b"GET /2 HTTP/1.1\r\nHost: a.com\r\nContent-Length: 5\r\n\r\n"
- b"67890"
- )
- c.receive_data(b"")
- assert get_all_events(c) == [
- Request(
- method="GET",
- target="/1",
- headers=[("host", "a.com"), ("content-length", "5")],
- ),
- Data(data=b"12345"),
- EndOfMessage(),
- ]
- assert c.states[CLIENT] is DONE
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- c.send(EndOfMessage())
- assert c.states[SERVER] is DONE
- c.start_next_cycle()
- assert get_all_events(c) == [
- Request(
- method="GET",
- target="/2",
- headers=[("host", "a.com"), ("content-length", "5")],
- ),
- Data(data=b"67890"),
- EndOfMessage(),
- ConnectionClosed(),
- ]
- assert c.states == {CLIENT: CLOSED, SERVER: SEND_RESPONSE}
- c.send(Response(status_code=200, headers=[])) # type: ignore[arg-type]
- c.send(EndOfMessage())
- assert c.states == {CLIENT: CLOSED, SERVER: MUST_CLOSE}
- c.send(ConnectionClosed())
- assert c.states == {CLIENT: CLOSED, SERVER: CLOSED}
-
-
-def test_sendfile() -> None:
- class SendfilePlaceholder:
- def __len__(self) -> int:
- return 10
-
- placeholder = SendfilePlaceholder()
-
- def setup(
- header: Tuple[str, str], http_version: str
- ) -> Tuple[Connection, Optional[List[bytes]]]:
- c = Connection(SERVER)
- receive_and_get(
- c, "GET / HTTP/{}\r\nHost: a\r\n\r\n".format(http_version).encode("ascii")
- )
- headers = []
- if header:
- headers.append(header)
- c.send(Response(status_code=200, headers=headers))
- return c, c.send_with_data_passthrough(Data(data=placeholder)) # type: ignore
-
- c, data = setup(("Content-Length", "10"), "1.1")
- assert data == [placeholder] # type: ignore
- # Raises an error if the connection object doesn't think we've sent
- # exactly 10 bytes
- c.send(EndOfMessage())
-
- _, data = setup(("Transfer-Encoding", "chunked"), "1.1")
- assert placeholder in data # type: ignore
- data[data.index(placeholder)] = b"x" * 10 # type: ignore
- assert b"".join(data) == b"a\r\nxxxxxxxxxx\r\n" # type: ignore
-
- c, data = setup(None, "1.0") # type: ignore
- assert data == [placeholder] # type: ignore
- assert c.our_state is SEND_BODY
-
-
-def test_errors() -> None:
- # After a receive error, you can't receive
- for role in [CLIENT, SERVER]:
- c = Connection(our_role=role)
- c.receive_data(b"gibberish\r\n\r\n")
- with pytest.raises(RemoteProtocolError):
- c.next_event()
- # Now any attempt to receive continues to raise
- assert c.their_state is ERROR
- assert c.our_state is not ERROR
- print(c._cstate.states)
- with pytest.raises(RemoteProtocolError):
- c.next_event()
- # But we can still yell at the client for sending us gibberish
- if role is SERVER:
- assert (
- c.send(Response(status_code=400, headers=[])) # type: ignore[arg-type]
- == b"HTTP/1.1 400 \r\nConnection: close\r\n\r\n"
- )
-
- # After an error sending, you can no longer send
- # (This is especially important for things like content-length errors,
- # where there's complex internal state being modified)
- def conn(role: Type[Sentinel]) -> Connection:
- c = Connection(our_role=role)
- if role is SERVER:
- # Put it into the state where it *could* send a response...
- receive_and_get(c, b"GET / HTTP/1.0\r\n\r\n")
- assert c.our_state is SEND_RESPONSE
- return c
-
- for role in [CLIENT, SERVER]:
- if role is CLIENT:
- # This HTTP/1.0 request won't be detected as bad until after we go
- # through the state machine and hit the writing code
- good = Request(method="GET", target="/", headers=[("Host", "example.com")])
- bad = Request(
- method="GET",
- target="/",
- headers=[("Host", "example.com")],
- http_version="1.0",
- )
- elif role is SERVER:
- good = Response(status_code=200, headers=[]) # type: ignore[arg-type,assignment]
- bad = Response(status_code=200, headers=[], http_version="1.0") # type: ignore[arg-type,assignment]
- # Make sure 'good' actually is good
- c = conn(role)
- c.send(good)
- assert c.our_state is not ERROR
- # Do that again, but this time sending 'bad' first
- c = conn(role)
- with pytest.raises(LocalProtocolError):
- c.send(bad)
- assert c.our_state is ERROR
- assert c.their_state is not ERROR
- # Now 'good' is not so good
- with pytest.raises(LocalProtocolError):
- c.send(good)
-
- # And check send_failed() too
- c = conn(role)
- c.send_failed()
- assert c.our_state is ERROR
- assert c.their_state is not ERROR
- # This is idempotent
- c.send_failed()
- assert c.our_state is ERROR
- assert c.their_state is not ERROR
-
-
-def test_idle_receive_nothing() -> None:
- # At one point this incorrectly raised an error
- for role in [CLIENT, SERVER]:
- c = Connection(role)
- assert c.next_event() is NEED_DATA
-
-
-def test_connection_drop() -> None:
- c = Connection(SERVER)
- c.receive_data(b"GET /")
- assert c.next_event() is NEED_DATA
- c.receive_data(b"")
- with pytest.raises(RemoteProtocolError):
- c.next_event()
-
-
-def test_408_request_timeout() -> None:
- # Should be able to send this spontaneously as a server without seeing
- # anything from client
- p = ConnectionPair()
- p.send(SERVER, Response(status_code=408, headers=[(b"connection", b"close")]))
-
-
-# This used to raise IndexError
-def test_empty_request() -> None:
- c = Connection(SERVER)
- c.receive_data(b"\r\n")
- with pytest.raises(RemoteProtocolError):
- c.next_event()
-
-
-# This used to raise IndexError
-def test_empty_response() -> None:
- c = Connection(CLIENT)
- c.send(Request(method="GET", target="/", headers=[("Host", "a")]))
- c.receive_data(b"\r\n")
- with pytest.raises(RemoteProtocolError):
- c.next_event()
-
-
-@pytest.mark.parametrize(
- "data",
- [
- b"\x00",
- b"\x20",
- b"\x16\x03\x01\x00\xa5", # Typical start of a TLS Client Hello
- ],
-)
-def test_early_detection_of_invalid_request(data: bytes) -> None:
- c = Connection(SERVER)
- # Early detection should occur before even receiving a `\r\n`
- c.receive_data(data)
- with pytest.raises(RemoteProtocolError):
- c.next_event()
-
-
-@pytest.mark.parametrize(
- "data",
- [
- b"\x00",
- b"\x20",
- b"\x16\x03\x03\x00\x31", # Typical start of a TLS Server Hello
- ],
-)
-def test_early_detection_of_invalid_response(data: bytes) -> None:
- c = Connection(CLIENT)
- # Early detection should occur before even receiving a `\r\n`
- c.receive_data(data)
- with pytest.raises(RemoteProtocolError):
- c.next_event()
-
-
-# This used to give different headers for HEAD and GET.
-# The correct way to handle HEAD is to put whatever headers we *would* have
-# put if it were a GET -- even though we know that for HEAD, those headers
-# will be ignored.
-def test_HEAD_framing_headers() -> None:
- def setup(method: bytes, http_version: bytes) -> Connection:
- c = Connection(SERVER)
- c.receive_data(
- method + b" / HTTP/" + http_version + b"\r\n" + b"Host: example.com\r\n\r\n"
- )
- assert type(c.next_event()) is Request
- assert type(c.next_event()) is EndOfMessage
- return c
-
- for method in [b"GET", b"HEAD"]:
- # No Content-Length, HTTP/1.1 peer, should use chunked
- c = setup(method, b"1.1")
- assert (
- c.send(Response(status_code=200, headers=[])) == b"HTTP/1.1 200 \r\n" # type: ignore[arg-type]
- b"Transfer-Encoding: chunked\r\n\r\n"
- )
-
- # No Content-Length, HTTP/1.0 peer, frame with connection: close
- c = setup(method, b"1.0")
- assert (
- c.send(Response(status_code=200, headers=[])) == b"HTTP/1.1 200 \r\n" # type: ignore[arg-type]
- b"Connection: close\r\n\r\n"
- )
-
- # Content-Length + Transfer-Encoding, TE wins
- c = setup(method, b"1.1")
- assert (
- c.send(
- Response(
- status_code=200,
- headers=[
- ("Content-Length", "100"),
- ("Transfer-Encoding", "chunked"),
- ],
- )
- )
- == b"HTTP/1.1 200 \r\n"
- b"Transfer-Encoding: chunked\r\n\r\n"
- )
-
-
-def test_special_exceptions_for_lost_connection_in_message_body() -> None:
- c = Connection(SERVER)
- c.receive_data(
- b"POST / HTTP/1.1\r\n" b"Host: example.com\r\n" b"Content-Length: 100\r\n\r\n"
- )
- assert type(c.next_event()) is Request
- assert c.next_event() is NEED_DATA
- c.receive_data(b"12345")
- assert c.next_event() == Data(data=b"12345")
- c.receive_data(b"")
- with pytest.raises(RemoteProtocolError) as excinfo:
- c.next_event()
- assert "received 5 bytes" in str(excinfo.value)
- assert "expected 100" in str(excinfo.value)
-
- c = Connection(SERVER)
- c.receive_data(
- b"POST / HTTP/1.1\r\n"
- b"Host: example.com\r\n"
- b"Transfer-Encoding: chunked\r\n\r\n"
- )
- assert type(c.next_event()) is Request
- assert c.next_event() is NEED_DATA
- c.receive_data(b"8\r\n012345")
- assert c.next_event().data == b"012345" # type: ignore
- c.receive_data(b"")
- with pytest.raises(RemoteProtocolError) as excinfo:
- c.next_event()
- assert "incomplete chunked read" in str(excinfo.value)
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_events.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_events.py
deleted file mode 100644
index bc6c3137..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_events.py
+++ /dev/null
@@ -1,150 +0,0 @@
-from http import HTTPStatus
-
-import pytest
-
-from .. import _events
-from .._events import (
- ConnectionClosed,
- Data,
- EndOfMessage,
- Event,
- InformationalResponse,
- Request,
- Response,
-)
-from .._util import LocalProtocolError
-
-
-def test_events() -> None:
- with pytest.raises(LocalProtocolError):
- # Missing Host:
- req = Request(
- method="GET", target="/", headers=[("a", "b")], http_version="1.1"
- )
- # But this is okay (HTTP/1.0)
- req = Request(method="GET", target="/", headers=[("a", "b")], http_version="1.0")
- # fields are normalized
- assert req.method == b"GET"
- assert req.target == b"/"
- assert req.headers == [(b"a", b"b")]
- assert req.http_version == b"1.0"
-
- # This is also okay -- has a Host (with weird capitalization, which is ok)
- req = Request(
- method="GET",
- target="/",
- headers=[("a", "b"), ("hOSt", "example.com")],
- http_version="1.1",
- )
- # we normalize header capitalization
- assert req.headers == [(b"a", b"b"), (b"host", b"example.com")]
-
- # Multiple host is bad too
- with pytest.raises(LocalProtocolError):
- req = Request(
- method="GET",
- target="/",
- headers=[("Host", "a"), ("Host", "a")],
- http_version="1.1",
- )
- # Even for HTTP/1.0
- with pytest.raises(LocalProtocolError):
- req = Request(
- method="GET",
- target="/",
- headers=[("Host", "a"), ("Host", "a")],
- http_version="1.0",
- )
-
- # Header values are validated
- for bad_char in "\x00\r\n\f\v":
- with pytest.raises(LocalProtocolError):
- req = Request(
- method="GET",
- target="/",
- headers=[("Host", "a"), ("Foo", "asd" + bad_char)],
- http_version="1.0",
- )
-
- # But for compatibility we allow non-whitespace control characters, even
- # though they're forbidden by the spec.
- Request(
- method="GET",
- target="/",
- headers=[("Host", "a"), ("Foo", "asd\x01\x02\x7f")],
- http_version="1.0",
- )
-
- # Request target is validated
- for bad_byte in b"\x00\x20\x7f\xee":
- target = bytearray(b"/")
- target.append(bad_byte)
- with pytest.raises(LocalProtocolError):
- Request(
- method="GET", target=target, headers=[("Host", "a")], http_version="1.1"
- )
-
- # Request method is validated
- with pytest.raises(LocalProtocolError):
- Request(
- method="GET / HTTP/1.1",
- target=target,
- headers=[("Host", "a")],
- http_version="1.1",
- )
-
- ir = InformationalResponse(status_code=100, headers=[("Host", "a")])
- assert ir.status_code == 100
- assert ir.headers == [(b"host", b"a")]
- assert ir.http_version == b"1.1"
-
- with pytest.raises(LocalProtocolError):
- InformationalResponse(status_code=200, headers=[("Host", "a")])
-
- resp = Response(status_code=204, headers=[], http_version="1.0") # type: ignore[arg-type]
- assert resp.status_code == 204
- assert resp.headers == []
- assert resp.http_version == b"1.0"
-
- with pytest.raises(LocalProtocolError):
- resp = Response(status_code=100, headers=[], http_version="1.0") # type: ignore[arg-type]
-
- with pytest.raises(LocalProtocolError):
- Response(status_code="100", headers=[], http_version="1.0") # type: ignore[arg-type]
-
- with pytest.raises(LocalProtocolError):
- InformationalResponse(status_code=b"100", headers=[], http_version="1.0") # type: ignore[arg-type]
-
- d = Data(data=b"asdf")
- assert d.data == b"asdf"
-
- eom = EndOfMessage()
- assert eom.headers == []
-
- cc = ConnectionClosed()
- assert repr(cc) == "ConnectionClosed()"
-
-
-def test_intenum_status_code() -> None:
- # https://github.com/python-hyper/h11/issues/72
-
- r = Response(status_code=HTTPStatus.OK, headers=[], http_version="1.0") # type: ignore[arg-type]
- assert r.status_code == HTTPStatus.OK
- assert type(r.status_code) is not type(HTTPStatus.OK)
- assert type(r.status_code) is int
-
-
-def test_header_casing() -> None:
- r = Request(
- method="GET",
- target="/",
- headers=[("Host", "example.org"), ("Connection", "keep-alive")],
- http_version="1.1",
- )
- assert len(r.headers) == 2
- assert r.headers[0] == (b"host", b"example.org")
- assert r.headers == [(b"host", b"example.org"), (b"connection", b"keep-alive")]
- assert r.headers.raw_items() == [
- (b"Host", b"example.org"),
- (b"Connection", b"keep-alive"),
- ]
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_headers.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_headers.py
deleted file mode 100644
index ba53d088..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_headers.py
+++ /dev/null
@@ -1,157 +0,0 @@
-import pytest
-
-from .._events import Request
-from .._headers import (
- get_comma_header,
- has_expect_100_continue,
- Headers,
- normalize_and_validate,
- set_comma_header,
-)
-from .._util import LocalProtocolError
-
-
-def test_normalize_and_validate() -> None:
- assert normalize_and_validate([("foo", "bar")]) == [(b"foo", b"bar")]
- assert normalize_and_validate([(b"foo", b"bar")]) == [(b"foo", b"bar")]
-
- # no leading/trailing whitespace in names
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([(b"foo ", "bar")])
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([(b" foo", "bar")])
-
- # no weird characters in names
- with pytest.raises(LocalProtocolError) as excinfo:
- normalize_and_validate([(b"foo bar", b"baz")])
- assert "foo bar" in str(excinfo.value)
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([(b"foo\x00bar", b"baz")])
- # Not even 8-bit characters:
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([(b"foo\xffbar", b"baz")])
- # And not even the control characters we allow in values:
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([(b"foo\x01bar", b"baz")])
-
- # no return or NUL characters in values
- with pytest.raises(LocalProtocolError) as excinfo:
- normalize_and_validate([("foo", "bar\rbaz")])
- assert "bar\\rbaz" in str(excinfo.value)
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("foo", "bar\nbaz")])
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("foo", "bar\x00baz")])
- # no leading/trailing whitespace
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("foo", "barbaz ")])
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("foo", " barbaz")])
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("foo", "barbaz\t")])
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("foo", "\tbarbaz")])
-
- # content-length
- assert normalize_and_validate([("Content-Length", "1")]) == [
- (b"content-length", b"1")
- ]
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("Content-Length", "asdf")])
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("Content-Length", "1x")])
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("Content-Length", "1"), ("Content-Length", "2")])
- assert normalize_and_validate(
- [("Content-Length", "0"), ("Content-Length", "0")]
- ) == [(b"content-length", b"0")]
- assert normalize_and_validate([("Content-Length", "0 , 0")]) == [
- (b"content-length", b"0")
- ]
- with pytest.raises(LocalProtocolError):
- normalize_and_validate(
- [("Content-Length", "1"), ("Content-Length", "1"), ("Content-Length", "2")]
- )
- with pytest.raises(LocalProtocolError):
- normalize_and_validate([("Content-Length", "1 , 1,2")])
-
- # transfer-encoding
- assert normalize_and_validate([("Transfer-Encoding", "chunked")]) == [
- (b"transfer-encoding", b"chunked")
- ]
- assert normalize_and_validate([("Transfer-Encoding", "cHuNkEd")]) == [
- (b"transfer-encoding", b"chunked")
- ]
- with pytest.raises(LocalProtocolError) as excinfo:
- normalize_and_validate([("Transfer-Encoding", "gzip")])
- assert excinfo.value.error_status_hint == 501 # Not Implemented
- with pytest.raises(LocalProtocolError) as excinfo:
- normalize_and_validate(
- [("Transfer-Encoding", "chunked"), ("Transfer-Encoding", "gzip")]
- )
- assert excinfo.value.error_status_hint == 501 # Not Implemented
-
-
-def test_get_set_comma_header() -> None:
- headers = normalize_and_validate(
- [
- ("Connection", "close"),
- ("whatever", "something"),
- ("connectiON", "fOo,, , BAR"),
- ]
- )
-
- assert get_comma_header(headers, b"connection") == [b"close", b"foo", b"bar"]
-
- headers = set_comma_header(headers, b"newthing", ["a", "b"]) # type: ignore
-
- with pytest.raises(LocalProtocolError):
- set_comma_header(headers, b"newthing", [" a", "b"]) # type: ignore
-
- assert headers == [
- (b"connection", b"close"),
- (b"whatever", b"something"),
- (b"connection", b"fOo,, , BAR"),
- (b"newthing", b"a"),
- (b"newthing", b"b"),
- ]
-
- headers = set_comma_header(headers, b"whatever", ["different thing"]) # type: ignore
-
- assert headers == [
- (b"connection", b"close"),
- (b"connection", b"fOo,, , BAR"),
- (b"newthing", b"a"),
- (b"newthing", b"b"),
- (b"whatever", b"different thing"),
- ]
-
-
-def test_has_100_continue() -> None:
- assert has_expect_100_continue(
- Request(
- method="GET",
- target="/",
- headers=[("Host", "example.com"), ("Expect", "100-continue")],
- )
- )
- assert not has_expect_100_continue(
- Request(method="GET", target="/", headers=[("Host", "example.com")])
- )
- # Case insensitive
- assert has_expect_100_continue(
- Request(
- method="GET",
- target="/",
- headers=[("Host", "example.com"), ("Expect", "100-Continue")],
- )
- )
- # Doesn't work in HTTP/1.0
- assert not has_expect_100_continue(
- Request(
- method="GET",
- target="/",
- headers=[("Host", "example.com"), ("Expect", "100-continue")],
- http_version="1.0",
- )
- )
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_helpers.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_helpers.py
deleted file mode 100644
index c329c767..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_helpers.py
+++ /dev/null
@@ -1,32 +0,0 @@
-from .._events import (
- ConnectionClosed,
- Data,
- EndOfMessage,
- Event,
- InformationalResponse,
- Request,
- Response,
-)
-from .helpers import normalize_data_events
-
-
-def test_normalize_data_events() -> None:
- assert normalize_data_events(
- [
- Data(data=bytearray(b"1")),
- Data(data=b"2"),
- Response(status_code=200, headers=[]), # type: ignore[arg-type]
- Data(data=b"3"),
- Data(data=b"4"),
- EndOfMessage(),
- Data(data=b"5"),
- Data(data=b"6"),
- Data(data=b"7"),
- ]
- ) == [
- Data(data=b"12"),
- Response(status_code=200, headers=[]), # type: ignore[arg-type]
- Data(data=b"34"),
- EndOfMessage(),
- Data(data=b"567"),
- ]
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_io.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_io.py
deleted file mode 100644
index 2b47c0ea..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_io.py
+++ /dev/null
@@ -1,572 +0,0 @@
-from typing import Any, Callable, Generator, List
-
-import pytest
-
-from .._events import (
- ConnectionClosed,
- Data,
- EndOfMessage,
- Event,
- InformationalResponse,
- Request,
- Response,
-)
-from .._headers import Headers, normalize_and_validate
-from .._readers import (
- _obsolete_line_fold,
- ChunkedReader,
- ContentLengthReader,
- Http10Reader,
- READERS,
-)
-from .._receivebuffer import ReceiveBuffer
-from .._state import (
- CLIENT,
- CLOSED,
- DONE,
- IDLE,
- MIGHT_SWITCH_PROTOCOL,
- MUST_CLOSE,
- SEND_BODY,
- SEND_RESPONSE,
- SERVER,
- SWITCHED_PROTOCOL,
-)
-from .._util import LocalProtocolError
-from .._writers import (
- ChunkedWriter,
- ContentLengthWriter,
- Http10Writer,
- write_any_response,
- write_headers,
- write_request,
- WRITERS,
-)
-from .helpers import normalize_data_events
-
-SIMPLE_CASES = [
- (
- (CLIENT, IDLE),
- Request(
- method="GET",
- target="/a",
- headers=[("Host", "foo"), ("Connection", "close")],
- ),
- b"GET /a HTTP/1.1\r\nHost: foo\r\nConnection: close\r\n\r\n",
- ),
- (
- (SERVER, SEND_RESPONSE),
- Response(status_code=200, headers=[("Connection", "close")], reason=b"OK"),
- b"HTTP/1.1 200 OK\r\nConnection: close\r\n\r\n",
- ),
- (
- (SERVER, SEND_RESPONSE),
- Response(status_code=200, headers=[], reason=b"OK"), # type: ignore[arg-type]
- b"HTTP/1.1 200 OK\r\n\r\n",
- ),
- (
- (SERVER, SEND_RESPONSE),
- InformationalResponse(
- status_code=101, headers=[("Upgrade", "websocket")], reason=b"Upgrade"
- ),
- b"HTTP/1.1 101 Upgrade\r\nUpgrade: websocket\r\n\r\n",
- ),
- (
- (SERVER, SEND_RESPONSE),
- InformationalResponse(status_code=101, headers=[], reason=b"Upgrade"), # type: ignore[arg-type]
- b"HTTP/1.1 101 Upgrade\r\n\r\n",
- ),
-]
-
-
-def dowrite(writer: Callable[..., None], obj: Any) -> bytes:
- got_list: List[bytes] = []
- writer(obj, got_list.append)
- return b"".join(got_list)
-
-
-def tw(writer: Any, obj: Any, expected: Any) -> None:
- got = dowrite(writer, obj)
- assert got == expected
-
-
-def makebuf(data: bytes) -> ReceiveBuffer:
- buf = ReceiveBuffer()
- buf += data
- return buf
-
-
-def tr(reader: Any, data: bytes, expected: Any) -> None:
- def check(got: Any) -> None:
- assert got == expected
- # Headers should always be returned as bytes, not e.g. bytearray
- # https://github.com/python-hyper/wsproto/pull/54#issuecomment-377709478
- for name, value in getattr(got, "headers", []):
- assert type(name) is bytes
- assert type(value) is bytes
-
- # Simple: consume whole thing
- buf = makebuf(data)
- check(reader(buf))
- assert not buf
-
- # Incrementally growing buffer
- buf = ReceiveBuffer()
- for i in range(len(data)):
- assert reader(buf) is None
- buf += data[i : i + 1]
- check(reader(buf))
-
- # Trailing data
- buf = makebuf(data)
- buf += b"trailing"
- check(reader(buf))
- assert bytes(buf) == b"trailing"
-
-
-def test_writers_simple() -> None:
- for ((role, state), event, binary) in SIMPLE_CASES:
- tw(WRITERS[role, state], event, binary)
-
-
-def test_readers_simple() -> None:
- for ((role, state), event, binary) in SIMPLE_CASES:
- tr(READERS[role, state], binary, event)
-
-
-def test_writers_unusual() -> None:
- # Simple test of the write_headers utility routine
- tw(
- write_headers,
- normalize_and_validate([("foo", "bar"), ("baz", "quux")]),
- b"foo: bar\r\nbaz: quux\r\n\r\n",
- )
- tw(write_headers, Headers([]), b"\r\n")
-
- # We understand HTTP/1.0, but we don't speak it
- with pytest.raises(LocalProtocolError):
- tw(
- write_request,
- Request(
- method="GET",
- target="/",
- headers=[("Host", "foo"), ("Connection", "close")],
- http_version="1.0",
- ),
- None,
- )
- with pytest.raises(LocalProtocolError):
- tw(
- write_any_response,
- Response(
- status_code=200, headers=[("Connection", "close")], http_version="1.0"
- ),
- None,
- )
-
-
-def test_readers_unusual() -> None:
- # Reading HTTP/1.0
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.0\r\nSome: header\r\n\r\n",
- Request(
- method="HEAD",
- target="/foo",
- headers=[("Some", "header")],
- http_version="1.0",
- ),
- )
-
- # check no-headers, since it's only legal with HTTP/1.0
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.0\r\n\r\n",
- Request(method="HEAD", target="/foo", headers=[], http_version="1.0"), # type: ignore[arg-type]
- )
-
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.0 200 OK\r\nSome: header\r\n\r\n",
- Response(
- status_code=200,
- headers=[("Some", "header")],
- http_version="1.0",
- reason=b"OK",
- ),
- )
-
- # single-character header values (actually disallowed by the ABNF in RFC
- # 7230 -- this is a bug in the standard that we originally copied...)
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.0 200 OK\r\n" b"Foo: a a a a a \r\n\r\n",
- Response(
- status_code=200,
- headers=[("Foo", "a a a a a")],
- http_version="1.0",
- reason=b"OK",
- ),
- )
-
- # Empty headers -- also legal
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.0 200 OK\r\n" b"Foo:\r\n\r\n",
- Response(
- status_code=200, headers=[("Foo", "")], http_version="1.0", reason=b"OK"
- ),
- )
-
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.0 200 OK\r\n" b"Foo: \t \t \r\n\r\n",
- Response(
- status_code=200, headers=[("Foo", "")], http_version="1.0", reason=b"OK"
- ),
- )
-
- # Tolerate broken servers that leave off the response code
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.0 200\r\n" b"Foo: bar\r\n\r\n",
- Response(
- status_code=200, headers=[("Foo", "bar")], http_version="1.0", reason=b""
- ),
- )
-
- # Tolerate headers line endings (\r\n and \n)
- # \n\r\b between headers and body
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.1 200 OK\r\nSomeHeader: val\n\r\n",
- Response(
- status_code=200,
- headers=[("SomeHeader", "val")],
- http_version="1.1",
- reason="OK",
- ),
- )
-
- # delimited only with \n
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.1 200 OK\nSomeHeader1: val1\nSomeHeader2: val2\n\n",
- Response(
- status_code=200,
- headers=[("SomeHeader1", "val1"), ("SomeHeader2", "val2")],
- http_version="1.1",
- reason="OK",
- ),
- )
-
- # mixed \r\n and \n
- tr(
- READERS[SERVER, SEND_RESPONSE],
- b"HTTP/1.1 200 OK\r\nSomeHeader1: val1\nSomeHeader2: val2\n\r\n",
- Response(
- status_code=200,
- headers=[("SomeHeader1", "val1"), ("SomeHeader2", "val2")],
- http_version="1.1",
- reason="OK",
- ),
- )
-
- # obsolete line folding
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1\r\n"
- b"Host: example.com\r\n"
- b"Some: multi-line\r\n"
- b" header\r\n"
- b"\tnonsense\r\n"
- b" \t \t\tI guess\r\n"
- b"Connection: close\r\n"
- b"More-nonsense: in the\r\n"
- b" last header \r\n\r\n",
- Request(
- method="HEAD",
- target="/foo",
- headers=[
- ("Host", "example.com"),
- ("Some", "multi-line header nonsense I guess"),
- ("Connection", "close"),
- ("More-nonsense", "in the last header"),
- ],
- ),
- )
-
- with pytest.raises(LocalProtocolError):
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1\r\n" b" folded: line\r\n\r\n",
- None,
- )
-
- with pytest.raises(LocalProtocolError):
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1\r\n" b"foo : line\r\n\r\n",
- None,
- )
- with pytest.raises(LocalProtocolError):
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1\r\n" b"foo\t: line\r\n\r\n",
- None,
- )
- with pytest.raises(LocalProtocolError):
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1\r\n" b"foo\t: line\r\n\r\n",
- None,
- )
- with pytest.raises(LocalProtocolError):
- tr(READERS[CLIENT, IDLE], b"HEAD /foo HTTP/1.1\r\n" b": line\r\n\r\n", None)
-
-
-def test__obsolete_line_fold_bytes() -> None:
- # _obsolete_line_fold has a defensive cast to bytearray, which is
- # necessary to protect against O(n^2) behavior in case anyone ever passes
- # in regular bytestrings... but right now we never pass in regular
- # bytestrings. so this test just exists to get some coverage on that
- # defensive cast.
- assert list(_obsolete_line_fold([b"aaa", b"bbb", b" ccc", b"ddd"])) == [
- b"aaa",
- bytearray(b"bbb ccc"),
- b"ddd",
- ]
-
-
-def _run_reader_iter(
- reader: Any, buf: bytes, do_eof: bool
-) -> Generator[Any, None, None]:
- while True:
- event = reader(buf)
- if event is None:
- break
- yield event
- # body readers have undefined behavior after returning EndOfMessage,
- # because this changes the state so they don't get called again
- if type(event) is EndOfMessage:
- break
- if do_eof:
- assert not buf
- yield reader.read_eof()
-
-
-def _run_reader(*args: Any) -> List[Event]:
- events = list(_run_reader_iter(*args))
- return normalize_data_events(events)
-
-
-def t_body_reader(thunk: Any, data: bytes, expected: Any, do_eof: bool = False) -> None:
- # Simple: consume whole thing
- print("Test 1")
- buf = makebuf(data)
- assert _run_reader(thunk(), buf, do_eof) == expected
-
- # Incrementally growing buffer
- print("Test 2")
- reader = thunk()
- buf = ReceiveBuffer()
- events = []
- for i in range(len(data)):
- events += _run_reader(reader, buf, False)
- buf += data[i : i + 1]
- events += _run_reader(reader, buf, do_eof)
- assert normalize_data_events(events) == expected
-
- is_complete = any(type(event) is EndOfMessage for event in expected)
- if is_complete and not do_eof:
- buf = makebuf(data + b"trailing")
- assert _run_reader(thunk(), buf, False) == expected
-
-
-def test_ContentLengthReader() -> None:
- t_body_reader(lambda: ContentLengthReader(0), b"", [EndOfMessage()])
-
- t_body_reader(
- lambda: ContentLengthReader(10),
- b"0123456789",
- [Data(data=b"0123456789"), EndOfMessage()],
- )
-
-
-def test_Http10Reader() -> None:
- t_body_reader(Http10Reader, b"", [EndOfMessage()], do_eof=True)
- t_body_reader(Http10Reader, b"asdf", [Data(data=b"asdf")], do_eof=False)
- t_body_reader(
- Http10Reader, b"asdf", [Data(data=b"asdf"), EndOfMessage()], do_eof=True
- )
-
-
-def test_ChunkedReader() -> None:
- t_body_reader(ChunkedReader, b"0\r\n\r\n", [EndOfMessage()])
-
- t_body_reader(
- ChunkedReader,
- b"0\r\nSome: header\r\n\r\n",
- [EndOfMessage(headers=[("Some", "header")])],
- )
-
- t_body_reader(
- ChunkedReader,
- b"5\r\n01234\r\n"
- + b"10\r\n0123456789abcdef\r\n"
- + b"0\r\n"
- + b"Some: header\r\n\r\n",
- [
- Data(data=b"012340123456789abcdef"),
- EndOfMessage(headers=[("Some", "header")]),
- ],
- )
-
- t_body_reader(
- ChunkedReader,
- b"5\r\n01234\r\n" + b"10\r\n0123456789abcdef\r\n" + b"0\r\n\r\n",
- [Data(data=b"012340123456789abcdef"), EndOfMessage()],
- )
-
- # handles upper and lowercase hex
- t_body_reader(
- ChunkedReader,
- b"aA\r\n" + b"x" * 0xAA + b"\r\n" + b"0\r\n\r\n",
- [Data(data=b"x" * 0xAA), EndOfMessage()],
- )
-
- # refuses arbitrarily long chunk integers
- with pytest.raises(LocalProtocolError):
- # Technically this is legal HTTP/1.1, but we refuse to process chunk
- # sizes that don't fit into 20 characters of hex
- t_body_reader(ChunkedReader, b"9" * 100 + b"\r\nxxx", [Data(data=b"xxx")])
-
- # refuses garbage in the chunk count
- with pytest.raises(LocalProtocolError):
- t_body_reader(ChunkedReader, b"10\x00\r\nxxx", None)
-
- # handles (and discards) "chunk extensions" omg wtf
- t_body_reader(
- ChunkedReader,
- b"5; hello=there\r\n"
- + b"xxxxx"
- + b"\r\n"
- + b'0; random="junk"; some=more; canbe=lonnnnngg\r\n\r\n',
- [Data(data=b"xxxxx"), EndOfMessage()],
- )
-
- t_body_reader(
- ChunkedReader,
- b"5 \r\n01234\r\n" + b"0\r\n\r\n",
- [Data(data=b"01234"), EndOfMessage()],
- )
-
-
-def test_ContentLengthWriter() -> None:
- w = ContentLengthWriter(5)
- assert dowrite(w, Data(data=b"123")) == b"123"
- assert dowrite(w, Data(data=b"45")) == b"45"
- assert dowrite(w, EndOfMessage()) == b""
-
- w = ContentLengthWriter(5)
- with pytest.raises(LocalProtocolError):
- dowrite(w, Data(data=b"123456"))
-
- w = ContentLengthWriter(5)
- dowrite(w, Data(data=b"123"))
- with pytest.raises(LocalProtocolError):
- dowrite(w, Data(data=b"456"))
-
- w = ContentLengthWriter(5)
- dowrite(w, Data(data=b"123"))
- with pytest.raises(LocalProtocolError):
- dowrite(w, EndOfMessage())
-
- w = ContentLengthWriter(5)
- dowrite(w, Data(data=b"123")) == b"123"
- dowrite(w, Data(data=b"45")) == b"45"
- with pytest.raises(LocalProtocolError):
- dowrite(w, EndOfMessage(headers=[("Etag", "asdf")]))
-
-
-def test_ChunkedWriter() -> None:
- w = ChunkedWriter()
- assert dowrite(w, Data(data=b"aaa")) == b"3\r\naaa\r\n"
- assert dowrite(w, Data(data=b"a" * 20)) == b"14\r\n" + b"a" * 20 + b"\r\n"
-
- assert dowrite(w, Data(data=b"")) == b""
-
- assert dowrite(w, EndOfMessage()) == b"0\r\n\r\n"
-
- assert (
- dowrite(w, EndOfMessage(headers=[("Etag", "asdf"), ("a", "b")]))
- == b"0\r\nEtag: asdf\r\na: b\r\n\r\n"
- )
-
-
-def test_Http10Writer() -> None:
- w = Http10Writer()
- assert dowrite(w, Data(data=b"1234")) == b"1234"
- assert dowrite(w, EndOfMessage()) == b""
-
- with pytest.raises(LocalProtocolError):
- dowrite(w, EndOfMessage(headers=[("Etag", "asdf")]))
-
-
-def test_reject_garbage_after_request_line() -> None:
- with pytest.raises(LocalProtocolError):
- tr(READERS[SERVER, SEND_RESPONSE], b"HTTP/1.0 200 OK\x00xxxx\r\n\r\n", None)
-
-
-def test_reject_garbage_after_response_line() -> None:
- with pytest.raises(LocalProtocolError):
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1 xxxxxx\r\n" b"Host: a\r\n\r\n",
- None,
- )
-
-
-def test_reject_garbage_in_header_line() -> None:
- with pytest.raises(LocalProtocolError):
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1\r\n" b"Host: foo\x00bar\r\n\r\n",
- None,
- )
-
-
-def test_reject_non_vchar_in_path() -> None:
- for bad_char in b"\x00\x20\x7f\xee":
- message = bytearray(b"HEAD /")
- message.append(bad_char)
- message.extend(b" HTTP/1.1\r\nHost: foobar\r\n\r\n")
- with pytest.raises(LocalProtocolError):
- tr(READERS[CLIENT, IDLE], message, None)
-
-
-# https://github.com/python-hyper/h11/issues/57
-def test_allow_some_garbage_in_cookies() -> None:
- tr(
- READERS[CLIENT, IDLE],
- b"HEAD /foo HTTP/1.1\r\n"
- b"Host: foo\r\n"
- b"Set-Cookie: ___utmvafIumyLc=kUd\x01UpAt; path=/; Max-Age=900\r\n"
- b"\r\n",
- Request(
- method="HEAD",
- target="/foo",
- headers=[
- ("Host", "foo"),
- ("Set-Cookie", "___utmvafIumyLc=kUd\x01UpAt; path=/; Max-Age=900"),
- ],
- ),
- )
-
-
-def test_host_comes_first() -> None:
- tw(
- write_headers,
- normalize_and_validate([("foo", "bar"), ("Host", "example.com")]),
- b"Host: example.com\r\nfoo: bar\r\n\r\n",
- )
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_receivebuffer.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_receivebuffer.py
deleted file mode 100644
index 21a3870b..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_receivebuffer.py
+++ /dev/null
@@ -1,135 +0,0 @@
-import re
-from typing import Tuple
-
-import pytest
-
-from .._receivebuffer import ReceiveBuffer
-
-
-def test_receivebuffer() -> None:
- b = ReceiveBuffer()
- assert not b
- assert len(b) == 0
- assert bytes(b) == b""
-
- b += b"123"
- assert b
- assert len(b) == 3
- assert bytes(b) == b"123"
-
- assert bytes(b) == b"123"
-
- assert b.maybe_extract_at_most(2) == b"12"
- assert b
- assert len(b) == 1
- assert bytes(b) == b"3"
-
- assert bytes(b) == b"3"
-
- assert b.maybe_extract_at_most(10) == b"3"
- assert bytes(b) == b""
-
- assert b.maybe_extract_at_most(10) is None
- assert not b
-
- ################################################################
- # maybe_extract_until_next
- ################################################################
-
- b += b"123\n456\r\n789\r\n"
-
- assert b.maybe_extract_next_line() == b"123\n456\r\n"
- assert bytes(b) == b"789\r\n"
-
- assert b.maybe_extract_next_line() == b"789\r\n"
- assert bytes(b) == b""
-
- b += b"12\r"
- assert b.maybe_extract_next_line() is None
- assert bytes(b) == b"12\r"
-
- b += b"345\n\r"
- assert b.maybe_extract_next_line() is None
- assert bytes(b) == b"12\r345\n\r"
-
- # here we stopped at the middle of b"\r\n" delimiter
-
- b += b"\n6789aaa123\r\n"
- assert b.maybe_extract_next_line() == b"12\r345\n\r\n"
- assert b.maybe_extract_next_line() == b"6789aaa123\r\n"
- assert b.maybe_extract_next_line() is None
- assert bytes(b) == b""
-
- ################################################################
- # maybe_extract_lines
- ################################################################
-
- b += b"123\r\na: b\r\nfoo:bar\r\n\r\ntrailing"
- lines = b.maybe_extract_lines()
- assert lines == [b"123", b"a: b", b"foo:bar"]
- assert bytes(b) == b"trailing"
-
- assert b.maybe_extract_lines() is None
-
- b += b"\r\n\r"
- assert b.maybe_extract_lines() is None
-
- assert b.maybe_extract_at_most(100) == b"trailing\r\n\r"
- assert not b
-
- # Empty body case (as happens at the end of chunked encoding if there are
- # no trailing headers, e.g.)
- b += b"\r\ntrailing"
- assert b.maybe_extract_lines() == []
- assert bytes(b) == b"trailing"
-
-
-@pytest.mark.parametrize(
- "data",
- [
- pytest.param(
- (
- b"HTTP/1.1 200 OK\r\n",
- b"Content-type: text/plain\r\n",
- b"Connection: close\r\n",
- b"\r\n",
- b"Some body",
- ),
- id="with_crlf_delimiter",
- ),
- pytest.param(
- (
- b"HTTP/1.1 200 OK\n",
- b"Content-type: text/plain\n",
- b"Connection: close\n",
- b"\n",
- b"Some body",
- ),
- id="with_lf_only_delimiter",
- ),
- pytest.param(
- (
- b"HTTP/1.1 200 OK\n",
- b"Content-type: text/plain\r\n",
- b"Connection: close\n",
- b"\n",
- b"Some body",
- ),
- id="with_mixed_crlf_and_lf",
- ),
- ],
-)
-def test_receivebuffer_for_invalid_delimiter(data: Tuple[bytes]) -> None:
- b = ReceiveBuffer()
-
- for line in data:
- b += line
-
- lines = b.maybe_extract_lines()
-
- assert lines == [
- b"HTTP/1.1 200 OK",
- b"Content-type: text/plain",
- b"Connection: close",
- ]
- assert bytes(b) == b"Some body"
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_state.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_state.py
deleted file mode 100644
index bc974e63..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_state.py
+++ /dev/null
@@ -1,271 +0,0 @@
-import pytest
-
-from .._events import (
- ConnectionClosed,
- Data,
- EndOfMessage,
- Event,
- InformationalResponse,
- Request,
- Response,
-)
-from .._state import (
- _SWITCH_CONNECT,
- _SWITCH_UPGRADE,
- CLIENT,
- CLOSED,
- ConnectionState,
- DONE,
- IDLE,
- MIGHT_SWITCH_PROTOCOL,
- MUST_CLOSE,
- SEND_BODY,
- SEND_RESPONSE,
- SERVER,
- SWITCHED_PROTOCOL,
-)
-from .._util import LocalProtocolError
-
-
-def test_ConnectionState() -> None:
- cs = ConnectionState()
-
- # Basic event-triggered transitions
-
- assert cs.states == {CLIENT: IDLE, SERVER: IDLE}
-
- cs.process_event(CLIENT, Request)
- # The SERVER-Request special case:
- assert cs.states == {CLIENT: SEND_BODY, SERVER: SEND_RESPONSE}
-
- # Illegal transitions raise an error and nothing happens
- with pytest.raises(LocalProtocolError):
- cs.process_event(CLIENT, Request)
- assert cs.states == {CLIENT: SEND_BODY, SERVER: SEND_RESPONSE}
-
- cs.process_event(SERVER, InformationalResponse)
- assert cs.states == {CLIENT: SEND_BODY, SERVER: SEND_RESPONSE}
-
- cs.process_event(SERVER, Response)
- assert cs.states == {CLIENT: SEND_BODY, SERVER: SEND_BODY}
-
- cs.process_event(CLIENT, EndOfMessage)
- cs.process_event(SERVER, EndOfMessage)
- assert cs.states == {CLIENT: DONE, SERVER: DONE}
-
- # State-triggered transition
-
- cs.process_event(SERVER, ConnectionClosed)
- assert cs.states == {CLIENT: MUST_CLOSE, SERVER: CLOSED}
-
-
-def test_ConnectionState_keep_alive() -> None:
- # keep_alive = False
- cs = ConnectionState()
- cs.process_event(CLIENT, Request)
- cs.process_keep_alive_disabled()
- cs.process_event(CLIENT, EndOfMessage)
- assert cs.states == {CLIENT: MUST_CLOSE, SERVER: SEND_RESPONSE}
-
- cs.process_event(SERVER, Response)
- cs.process_event(SERVER, EndOfMessage)
- assert cs.states == {CLIENT: MUST_CLOSE, SERVER: MUST_CLOSE}
-
-
-def test_ConnectionState_keep_alive_in_DONE() -> None:
- # Check that if keep_alive is disabled when the CLIENT is already in DONE,
- # then this is sufficient to immediately trigger the DONE -> MUST_CLOSE
- # transition
- cs = ConnectionState()
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, EndOfMessage)
- assert cs.states[CLIENT] is DONE
- cs.process_keep_alive_disabled()
- assert cs.states[CLIENT] is MUST_CLOSE
-
-
-def test_ConnectionState_switch_denied() -> None:
- for switch_type in (_SWITCH_CONNECT, _SWITCH_UPGRADE):
- for deny_early in (True, False):
- cs = ConnectionState()
- cs.process_client_switch_proposal(switch_type)
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, Data)
- assert cs.states == {CLIENT: SEND_BODY, SERVER: SEND_RESPONSE}
-
- assert switch_type in cs.pending_switch_proposals
-
- if deny_early:
- # before client reaches DONE
- cs.process_event(SERVER, Response)
- assert not cs.pending_switch_proposals
-
- cs.process_event(CLIENT, EndOfMessage)
-
- if deny_early:
- assert cs.states == {CLIENT: DONE, SERVER: SEND_BODY}
- else:
- assert cs.states == {
- CLIENT: MIGHT_SWITCH_PROTOCOL,
- SERVER: SEND_RESPONSE,
- }
-
- cs.process_event(SERVER, InformationalResponse)
- assert cs.states == {
- CLIENT: MIGHT_SWITCH_PROTOCOL,
- SERVER: SEND_RESPONSE,
- }
-
- cs.process_event(SERVER, Response)
- assert cs.states == {CLIENT: DONE, SERVER: SEND_BODY}
- assert not cs.pending_switch_proposals
-
-
-_response_type_for_switch = {
- _SWITCH_UPGRADE: InformationalResponse,
- _SWITCH_CONNECT: Response,
- None: Response,
-}
-
-
-def test_ConnectionState_protocol_switch_accepted() -> None:
- for switch_event in [_SWITCH_UPGRADE, _SWITCH_CONNECT]:
- cs = ConnectionState()
- cs.process_client_switch_proposal(switch_event)
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, Data)
- assert cs.states == {CLIENT: SEND_BODY, SERVER: SEND_RESPONSE}
-
- cs.process_event(CLIENT, EndOfMessage)
- assert cs.states == {CLIENT: MIGHT_SWITCH_PROTOCOL, SERVER: SEND_RESPONSE}
-
- cs.process_event(SERVER, InformationalResponse)
- assert cs.states == {CLIENT: MIGHT_SWITCH_PROTOCOL, SERVER: SEND_RESPONSE}
-
- cs.process_event(SERVER, _response_type_for_switch[switch_event], switch_event)
- assert cs.states == {CLIENT: SWITCHED_PROTOCOL, SERVER: SWITCHED_PROTOCOL}
-
-
-def test_ConnectionState_double_protocol_switch() -> None:
- # CONNECT + Upgrade is legal! Very silly, but legal. So we support
- # it. Because sometimes doing the silly thing is easier than not.
- for server_switch in [None, _SWITCH_UPGRADE, _SWITCH_CONNECT]:
- cs = ConnectionState()
- cs.process_client_switch_proposal(_SWITCH_UPGRADE)
- cs.process_client_switch_proposal(_SWITCH_CONNECT)
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, EndOfMessage)
- assert cs.states == {CLIENT: MIGHT_SWITCH_PROTOCOL, SERVER: SEND_RESPONSE}
- cs.process_event(
- SERVER, _response_type_for_switch[server_switch], server_switch
- )
- if server_switch is None:
- assert cs.states == {CLIENT: DONE, SERVER: SEND_BODY}
- else:
- assert cs.states == {CLIENT: SWITCHED_PROTOCOL, SERVER: SWITCHED_PROTOCOL}
-
-
-def test_ConnectionState_inconsistent_protocol_switch() -> None:
- for client_switches, server_switch in [
- ([], _SWITCH_CONNECT),
- ([], _SWITCH_UPGRADE),
- ([_SWITCH_UPGRADE], _SWITCH_CONNECT),
- ([_SWITCH_CONNECT], _SWITCH_UPGRADE),
- ]:
- cs = ConnectionState()
- for client_switch in client_switches: # type: ignore[attr-defined]
- cs.process_client_switch_proposal(client_switch)
- cs.process_event(CLIENT, Request)
- with pytest.raises(LocalProtocolError):
- cs.process_event(SERVER, Response, server_switch)
-
-
-def test_ConnectionState_keepalive_protocol_switch_interaction() -> None:
- # keep_alive=False + pending_switch_proposals
- cs = ConnectionState()
- cs.process_client_switch_proposal(_SWITCH_UPGRADE)
- cs.process_event(CLIENT, Request)
- cs.process_keep_alive_disabled()
- cs.process_event(CLIENT, Data)
- assert cs.states == {CLIENT: SEND_BODY, SERVER: SEND_RESPONSE}
-
- # the protocol switch "wins"
- cs.process_event(CLIENT, EndOfMessage)
- assert cs.states == {CLIENT: MIGHT_SWITCH_PROTOCOL, SERVER: SEND_RESPONSE}
-
- # but when the server denies the request, keep_alive comes back into play
- cs.process_event(SERVER, Response)
- assert cs.states == {CLIENT: MUST_CLOSE, SERVER: SEND_BODY}
-
-
-def test_ConnectionState_reuse() -> None:
- cs = ConnectionState()
-
- with pytest.raises(LocalProtocolError):
- cs.start_next_cycle()
-
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, EndOfMessage)
-
- with pytest.raises(LocalProtocolError):
- cs.start_next_cycle()
-
- cs.process_event(SERVER, Response)
- cs.process_event(SERVER, EndOfMessage)
-
- cs.start_next_cycle()
- assert cs.states == {CLIENT: IDLE, SERVER: IDLE}
-
- # No keepalive
-
- cs.process_event(CLIENT, Request)
- cs.process_keep_alive_disabled()
- cs.process_event(CLIENT, EndOfMessage)
- cs.process_event(SERVER, Response)
- cs.process_event(SERVER, EndOfMessage)
-
- with pytest.raises(LocalProtocolError):
- cs.start_next_cycle()
-
- # One side closed
-
- cs = ConnectionState()
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, EndOfMessage)
- cs.process_event(CLIENT, ConnectionClosed)
- cs.process_event(SERVER, Response)
- cs.process_event(SERVER, EndOfMessage)
-
- with pytest.raises(LocalProtocolError):
- cs.start_next_cycle()
-
- # Succesful protocol switch
-
- cs = ConnectionState()
- cs.process_client_switch_proposal(_SWITCH_UPGRADE)
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, EndOfMessage)
- cs.process_event(SERVER, InformationalResponse, _SWITCH_UPGRADE)
-
- with pytest.raises(LocalProtocolError):
- cs.start_next_cycle()
-
- # Failed protocol switch
-
- cs = ConnectionState()
- cs.process_client_switch_proposal(_SWITCH_UPGRADE)
- cs.process_event(CLIENT, Request)
- cs.process_event(CLIENT, EndOfMessage)
- cs.process_event(SERVER, Response)
- cs.process_event(SERVER, EndOfMessage)
-
- cs.start_next_cycle()
- assert cs.states == {CLIENT: IDLE, SERVER: IDLE}
-
-
-def test_server_request_is_illegal() -> None:
- # There used to be a bug in how we handled the Request special case that
- # made this allowed...
- cs = ConnectionState()
- with pytest.raises(LocalProtocolError):
- cs.process_event(SERVER, Request)
diff --git a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_util.py b/Backend/venv/lib/python3.12/site-packages/h11/tests/test_util.py
deleted file mode 100644
index 79bc0951..00000000
--- a/Backend/venv/lib/python3.12/site-packages/h11/tests/test_util.py
+++ /dev/null
@@ -1,112 +0,0 @@
-import re
-import sys
-import traceback
-from typing import NoReturn
-
-import pytest
-
-from .._util import (
- bytesify,
- LocalProtocolError,
- ProtocolError,
- RemoteProtocolError,
- Sentinel,
- validate,
-)
-
-
-def test_ProtocolError() -> None:
- with pytest.raises(TypeError):
- ProtocolError("abstract base class")
-
-
-def test_LocalProtocolError() -> None:
- try:
- raise LocalProtocolError("foo")
- except LocalProtocolError as e:
- assert str(e) == "foo"
- assert e.error_status_hint == 400
-
- try:
- raise LocalProtocolError("foo", error_status_hint=418)
- except LocalProtocolError as e:
- assert str(e) == "foo"
- assert e.error_status_hint == 418
-
- def thunk() -> NoReturn:
- raise LocalProtocolError("a", error_status_hint=420)
-
- try:
- try:
- thunk()
- except LocalProtocolError as exc1:
- orig_traceback = "".join(traceback.format_tb(sys.exc_info()[2]))
- exc1._reraise_as_remote_protocol_error()
- except RemoteProtocolError as exc2:
- assert type(exc2) is RemoteProtocolError
- assert exc2.args == ("a",)
- assert exc2.error_status_hint == 420
- new_traceback = "".join(traceback.format_tb(sys.exc_info()[2]))
- assert new_traceback.endswith(orig_traceback)
-
-
-def test_validate() -> None:
- my_re = re.compile(rb"(?P[0-9]+)\.(?P[0-9]+)")
- with pytest.raises(LocalProtocolError):
- validate(my_re, b"0.")
-
- groups = validate(my_re, b"0.1")
- assert groups == {"group1": b"0", "group2": b"1"}
-
- # successful partial matches are an error - must match whole string
- with pytest.raises(LocalProtocolError):
- validate(my_re, b"0.1xx")
- with pytest.raises(LocalProtocolError):
- validate(my_re, b"0.1\n")
-
-
-def test_validate_formatting() -> None:
- my_re = re.compile(rb"foo")
-
- with pytest.raises(LocalProtocolError) as excinfo:
- validate(my_re, b"", "oops")
- assert "oops" in str(excinfo.value)
-
- with pytest.raises(LocalProtocolError) as excinfo:
- validate(my_re, b"", "oops {}")
- assert "oops {}" in str(excinfo.value)
-
- with pytest.raises(LocalProtocolError) as excinfo:
- validate(my_re, b"", "oops {} xx", 10)
- assert "oops 10 xx" in str(excinfo.value)
-
-
-def test_make_sentinel() -> None:
- class S(Sentinel, metaclass=Sentinel):
- pass
-
- assert repr(S) == "S"
- assert S == S
- assert type(S).__name__ == "S"
- assert S in {S}
- assert type(S) is S
-
- class S2(Sentinel, metaclass=Sentinel):
- pass
-
- assert repr(S2) == "S2"
- assert S != S2
- assert S not in {S2}
- assert type(S) is not type(S2)
-
-
-def test_bytesify() -> None:
- assert bytesify(b"123") == b"123"
- assert bytesify(bytearray(b"123")) == b"123"
- assert bytesify("123") == b"123"
-
- with pytest.raises(UnicodeEncodeError):
- bytesify("\u1234")
-
- with pytest.raises(TypeError):
- bytesify(10)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/RECORD
deleted file mode 100644
index 8f8da5d5..00000000
--- a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/RECORD
+++ /dev/null
@@ -1,69 +0,0 @@
-httpcore-0.17.3.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
-httpcore-0.17.3.dist-info/LICENSE.md,sha256=_ctZFUx0y6uhahEkL3dAvqnyPW_rVUeRfYxflKgDkqU,1518
-httpcore-0.17.3.dist-info/METADATA,sha256=FXYdgFJ2kxh_T0yVw4qIdD031yF4wtYjTlU0TLrNjIk,18594
-httpcore-0.17.3.dist-info/RECORD,,
-httpcore-0.17.3.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-httpcore-0.17.3.dist-info/top_level.txt,sha256=kYeSB6l1hBNp7JwgSwLajcsxRlrSCVKOhYKSkdgx798,59
-httpcore/__init__.py,sha256=Dza2gJlD90bgsFlu61Fo9RpTqTj7-mxGdJVA1X-MG_U,3338
-httpcore/__pycache__/__init__.cpython-312.pyc,,
-httpcore/__pycache__/_api.cpython-312.pyc,,
-httpcore/__pycache__/_exceptions.cpython-312.pyc,,
-httpcore/__pycache__/_models.cpython-312.pyc,,
-httpcore/__pycache__/_ssl.cpython-312.pyc,,
-httpcore/__pycache__/_synchronization.cpython-312.pyc,,
-httpcore/__pycache__/_trace.cpython-312.pyc,,
-httpcore/__pycache__/_utils.cpython-312.pyc,,
-httpcore/_api.py,sha256=IBR18qZQ8ETcghJXC1Gd-30WuKYRS0EyF2eC80_OBQ8,3167
-httpcore/_async/__init__.py,sha256=EWdl2v4thnAHzJpqjU4h2a8DUiGAvNiWrkii9pfhTf0,1221
-httpcore/_async/__pycache__/__init__.cpython-312.pyc,,
-httpcore/_async/__pycache__/connection.cpython-312.pyc,,
-httpcore/_async/__pycache__/connection_pool.cpython-312.pyc,,
-httpcore/_async/__pycache__/http11.cpython-312.pyc,,
-httpcore/_async/__pycache__/http2.cpython-312.pyc,,
-httpcore/_async/__pycache__/http_proxy.cpython-312.pyc,,
-httpcore/_async/__pycache__/interfaces.cpython-312.pyc,,
-httpcore/_async/__pycache__/socks_proxy.cpython-312.pyc,,
-httpcore/_async/connection.py,sha256=0LKFUXPkxusvJAUyHSJpy4mMkgf71BtOjtlaMBL4sUs,8420
-httpcore/_async/connection_pool.py,sha256=hj1viqcWZivNmoRu-QZjyuOvAFx3-Ae2rMpuK6OZhEM,14305
-httpcore/_async/http11.py,sha256=z58glbEF4YrDM03KVHkuNXNRpAQaJQ4qyblapA-mk4o,11968
-httpcore/_async/http2.py,sha256=KXwWZxZ-43vxIWzr1aTLErhaCodDzFr-XAvzc4fUb10,23879
-httpcore/_async/http_proxy.py,sha256=6jdp87k6_iNCAaM7bJF8wOw_4mX_xrXGU_c4qDjJxLk,13999
-httpcore/_async/interfaces.py,sha256=J2iq9rs7x3nKS6iCfntjHY0Woast6V_HuXuE8rs3HmA,4486
-httpcore/_async/socks_proxy.py,sha256=7tFg_GuAL6WoV5-emaBaiDEmZBHdVODaQXd7nkOoGC8,13810
-httpcore/_backends/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-httpcore/_backends/__pycache__/__init__.cpython-312.pyc,,
-httpcore/_backends/__pycache__/anyio.cpython-312.pyc,,
-httpcore/_backends/__pycache__/auto.cpython-312.pyc,,
-httpcore/_backends/__pycache__/base.cpython-312.pyc,,
-httpcore/_backends/__pycache__/mock.cpython-312.pyc,,
-httpcore/_backends/__pycache__/sync.cpython-312.pyc,,
-httpcore/_backends/__pycache__/trio.cpython-312.pyc,,
-httpcore/_backends/anyio.py,sha256=mU8gtunBSLxESGkU0Iy1ZMgumDlAeMkwBjFE3kZiCnc,5208
-httpcore/_backends/auto.py,sha256=8r0ipGxSwXoCb_xKQAyRwL1UzfXVbO4Ee2y8vYQv3Ic,1654
-httpcore/_backends/base.py,sha256=Qsb8b_PSiVP1ldHHGXHxQzJ1Qlzj2r8KR9KQeANkSbE,3218
-httpcore/_backends/mock.py,sha256=S4IADhC6kE22ge_jR_WHlEUkD6QAsXnwz26DSWZLcG4,4179
-httpcore/_backends/sync.py,sha256=Q2skeGyuAt6ETqPjZkiw-iUU0zh_nFXvCFkrsT-Y9GI,4444
-httpcore/_backends/trio.py,sha256=INOeHEkA8pO6AsSqjColWcayM0FQSyGi1hpaQghjrCs,6078
-httpcore/_exceptions.py,sha256=7zb3KNiG0qmfUNIdFgdaUSbn2Pu3oztghi6Vg7i-LJU,1185
-httpcore/_models.py,sha256=1aM8l5D3CbP5QKXCBsdzAWVCHSm0t7UVrCNVTaXUPI8,16343
-httpcore/_ssl.py,sha256=srqmSNU4iOUvWF-SrJvb8G_YEbHFELOXQOwdDIBTS9c,187
-httpcore/_sync/__init__.py,sha256=JBDIgXt5la1LCJ1sLQeKhjKFpLnpNr8Svs6z2ni3fgg,1141
-httpcore/_sync/__pycache__/__init__.cpython-312.pyc,,
-httpcore/_sync/__pycache__/connection.cpython-312.pyc,,
-httpcore/_sync/__pycache__/connection_pool.cpython-312.pyc,,
-httpcore/_sync/__pycache__/http11.cpython-312.pyc,,
-httpcore/_sync/__pycache__/http2.cpython-312.pyc,,
-httpcore/_sync/__pycache__/http_proxy.cpython-312.pyc,,
-httpcore/_sync/__pycache__/interfaces.cpython-312.pyc,,
-httpcore/_sync/__pycache__/socks_proxy.cpython-312.pyc,,
-httpcore/_sync/connection.py,sha256=8IOzYLwK8_GuUPz9fF3z0EARb-ueGeKW6ZDXRPdNluQ,8209
-httpcore/_sync/connection_pool.py,sha256=1iwYLdiq3pi9LBvpMZ8O8gWdb56qqPlm6rp35zeORBQ,13928
-httpcore/_sync/http11.py,sha256=FTg8wAzMu1kSDjCQqQUXIslJ90aFrWnO6eL459K8SYs,11629
-httpcore/_sync/http2.py,sha256=lkpHesGkrwzIA4oHLyClJf5IAwRLcaAFMnmffAahAK4,23343
-httpcore/_sync/http_proxy.py,sha256=PcTIz3XuYT3rKvdaruAtH5W7EQvjofOcUHTv9YXiOc0,13761
-httpcore/_sync/interfaces.py,sha256=EM4PTf-rgkclzisFcrTyx1G8FwraoffE8rbckOznX_o,4365
-httpcore/_sync/socks_proxy.py,sha256=BLRF27DHvsfpdZ7WVzK3Ba3vxN6zk0iD_3xRCzDt-2Q,13595
-httpcore/_synchronization.py,sha256=_d_vHqylvzm1Jh58_0G7i-1VwCg3Gu39Cgd4nWASvP0,8751
-httpcore/_trace.py,sha256=akf5PsWVq3rZjqmXniomU59OY37K7JHoeNDCQ4GU84E,3954
-httpcore/_utils.py,sha256=9QPh5ib4JilWX4dBCC_XO6wdBY4b0kbUGgfV3QfBANc,1525
-httpcore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/top_level.txt b/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/top_level.txt
deleted file mode 100644
index 613e4350..00000000
--- a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/top_level.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-httpcore
-httpcore/_async
-httpcore/_backends
-httpcore/_sync
diff --git a/Backend/venv/lib/python3.12/site-packages/starlette-0.27.0.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/starlette-0.27.0.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/METADATA
similarity index 83%
rename from Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/METADATA
rename to Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/METADATA
index 3bcd8aee..8056834e 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/METADATA
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/METADATA
@@ -1,39 +1,40 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
Name: httpcore
-Version: 0.17.3
+Version: 1.0.9
Summary: A minimal low-level HTTP client.
-Home-page: https://github.com/encode/httpcore
-Author: Tom Christie
-Author-email: tom@tomchristie.com
-License: BSD
Project-URL: Documentation, https://www.encode.io/httpcore
+Project-URL: Homepage, https://www.encode.io/httpcore/
Project-URL: Source, https://github.com/encode/httpcore
+Author-email: Tom Christie
+License-Expression: BSD-3-Clause
+License-File: LICENSE.md
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Trio
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: Trio
Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE.md
-Requires-Dist: h11 (<0.15,>=0.13)
-Requires-Dist: sniffio (==1.*)
-Requires-Dist: anyio (<5.0,>=3.0)
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.8
Requires-Dist: certifi
+Requires-Dist: h11>=0.16
+Provides-Extra: asyncio
+Requires-Dist: anyio<5.0,>=4.0; extra == 'asyncio'
Provides-Extra: http2
-Requires-Dist: h2 (<5,>=3) ; extra == 'http2'
+Requires-Dist: h2<5,>=3; extra == 'http2'
Provides-Extra: socks
-Requires-Dist: socksio (==1.*) ; extra == 'socks'
+Requires-Dist: socksio==1.*; extra == 'socks'
+Provides-Extra: trio
+Requires-Dist: trio<1.0,>=0.22.0; extra == 'trio'
+Description-Content-Type: text/markdown
# HTTP Core
@@ -62,7 +63,7 @@ Some things HTTP Core does do:
## Requirements
-Python 3.7+
+Python 3.8+
## Installation
@@ -72,19 +73,13 @@ For HTTP/1.1 only support, install with:
$ pip install httpcore
```
-For HTTP/1.1 and HTTP/2 support, install with:
+There are also a number of optional extras available...
```shell
-$ pip install httpcore[http2]
+$ pip install httpcore['asyncio,trio,http2,socks']
```
-For SOCKS proxy support, install with:
-
-```shell
-$ pip install httpcore[socks]
-```
-
-# Sending requests
+## Sending requests
Send an HTTP request:
@@ -127,19 +122,107 @@ The motivation for `httpcore` is:
* To provide a *really clear interface split* between the networking code and client logic,
so that each is easier to understand and reason about in isolation.
+## Dependencies
+The `httpcore` package has the following dependencies...
+
+* `h11`
+* `certifi`
+
+And the following optional extras...
+
+* `anyio` - Required by `pip install httpcore['asyncio']`.
+* `trio` - Required by `pip install httpcore['trio']`.
+* `h2` - Required by `pip install httpcore['http2']`.
+* `socksio` - Required by `pip install httpcore['socks']`.
+
+## Versioning
+
+We use [SEMVER for our versioning policy](https://semver.org/).
+
+For changes between package versions please see our [project changelog](CHANGELOG.md).
+
+We recommend pinning your requirements either the most current major version, or a more specific version range:
+
+```python
+pip install 'httpcore==1.*'
+```
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
-## 0.17.3 (5th July 2023)
+## Version 1.0.9 (April 24th, 2025)
+
+- Resolve https://github.com/advisories/GHSA-vqfr-h8mv-ghfj with h11 dependency update. (#1008)
+
+## Version 1.0.8 (April 11th, 2025)
+
+- Fix `AttributeError` when importing on Python 3.14. (#1005)
+
+## Version 1.0.7 (November 15th, 2024)
+
+- Support `proxy=…` configuration on `ConnectionPool()`. (#974)
+
+## Version 1.0.6 (October 1st, 2024)
+
+- Relax `trio` dependency pinning. (#956)
+- Handle `trio` raising `NotImplementedError` on unsupported platforms. (#955)
+- Handle mapping `ssl.SSLError` to `httpcore.ConnectError`. (#918)
+
+## 1.0.5 (March 27th, 2024)
+
+- Handle `EndOfStream` exception for anyio backend. (#899)
+- Allow trio `0.25.*` series in package dependancies. (#903)
+
+## 1.0.4 (February 21st, 2024)
+
+- Add `target` request extension. (#888)
+- Fix support for connection `Upgrade` and `CONNECT` when some data in the stream has been read. (#882)
+
+## 1.0.3 (February 13th, 2024)
+
+- Fix support for async cancellations. (#880)
+- Fix trace extension when used with socks proxy. (#849)
+- Fix SSL context for connections using the "wss" scheme (#869)
+
+## 1.0.2 (November 10th, 2023)
+
+- Fix `float("inf")` timeouts in `Event.wait` function. (#846)
+
+## 1.0.1 (November 3rd, 2023)
+
+- Fix pool timeout to account for the total time spent retrying. (#823)
+- Raise a neater RuntimeError when the correct async deps are not installed. (#826)
+- Add support for synchronous TLS-in-TLS streams. (#840)
+
+## 1.0.0 (October 6th, 2023)
+
+From version 1.0 our async support is now optional, as the package has minimal dependencies by default.
+
+For async support use either `pip install 'httpcore[asyncio]'` or `pip install 'httpcore[trio]'`.
+
+The project versioning policy is now explicitly governed by SEMVER. See https://semver.org/.
+
+- Async support becomes fully optional. (#809)
+- Add support for Python 3.12. (#807)
+
+## 0.18.0 (September 8th, 2023)
+
+- Add support for HTTPS proxies. (#745, #786)
+- Drop Python 3.7 support. (#727)
+- Handle `sni_hostname` extension with SOCKS proxy. (#774)
+- Handle HTTP/1.1 half-closed connections gracefully. (#641)
+- Change the type of `Extensions` from `Mapping[Str, Any]` to `MutableMapping[Str, Any]`. (#762)
+
+## 0.17.3 (July 5th, 2023)
- Support async cancellations, ensuring that the connection pool is left in a clean state when cancellations occur. (#726)
- The networking backend interface has [been added to the public API](https://www.encode.io/httpcore/network-backends). Some classes which were previously private implementation detail are now part of the top-level public API. (#699)
- Graceful handling of HTTP/2 GoAway frames, with requests being transparently retried on a new connection. (#730)
- Add exceptions when a synchronous `trace callback` is passed to an asynchronous request or an asynchronous `trace callback` is passed to a synchronous request. (#717)
+- Drop Python 3.7 support. (#727)
## 0.17.2 (May 23th, 2023)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/RECORD
new file mode 100644
index 00000000..0aa3a2f2
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/RECORD
@@ -0,0 +1,69 @@
+httpcore-1.0.9.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+httpcore-1.0.9.dist-info/METADATA,sha256=_i1P2mGZEol4d54M8n88BFxTGGP83Zh-rMdPOhjUHCE,21529
+httpcore-1.0.9.dist-info/RECORD,,
+httpcore-1.0.9.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+httpcore-1.0.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+httpcore-1.0.9.dist-info/licenses/LICENSE.md,sha256=_ctZFUx0y6uhahEkL3dAvqnyPW_rVUeRfYxflKgDkqU,1518
+httpcore/__init__.py,sha256=9kT_kqChCCJUTHww24ZmR_ezcdbpRYWksD-gYNzkZP8,3445
+httpcore/__pycache__/__init__.cpython-312.pyc,,
+httpcore/__pycache__/_api.cpython-312.pyc,,
+httpcore/__pycache__/_exceptions.cpython-312.pyc,,
+httpcore/__pycache__/_models.cpython-312.pyc,,
+httpcore/__pycache__/_ssl.cpython-312.pyc,,
+httpcore/__pycache__/_synchronization.cpython-312.pyc,,
+httpcore/__pycache__/_trace.cpython-312.pyc,,
+httpcore/__pycache__/_utils.cpython-312.pyc,,
+httpcore/_api.py,sha256=unZmeDschBWCGCPCwkS3Wot9euK6bg_kKxLtGTxw214,3146
+httpcore/_async/__init__.py,sha256=EWdl2v4thnAHzJpqjU4h2a8DUiGAvNiWrkii9pfhTf0,1221
+httpcore/_async/__pycache__/__init__.cpython-312.pyc,,
+httpcore/_async/__pycache__/connection.cpython-312.pyc,,
+httpcore/_async/__pycache__/connection_pool.cpython-312.pyc,,
+httpcore/_async/__pycache__/http11.cpython-312.pyc,,
+httpcore/_async/__pycache__/http2.cpython-312.pyc,,
+httpcore/_async/__pycache__/http_proxy.cpython-312.pyc,,
+httpcore/_async/__pycache__/interfaces.cpython-312.pyc,,
+httpcore/_async/__pycache__/socks_proxy.cpython-312.pyc,,
+httpcore/_async/connection.py,sha256=6OcPXqMEfc0BU38_-iHUNDd1vKSTc2UVT09XqNb_BOk,8449
+httpcore/_async/connection_pool.py,sha256=DOIQ2s2ZCf9qfwxhzMprTPLqCL8OxGXiKF6qRHxvVyY,17307
+httpcore/_async/http11.py,sha256=-qM9bV7PjSQF5vxs37-eUXOIFwbIjPcZbNliuX9TtBw,13880
+httpcore/_async/http2.py,sha256=azX1fcmtXaIwjputFlZ4vd92J8xwjGOa9ax9QIv4394,23936
+httpcore/_async/http_proxy.py,sha256=2zVkrlv-Ds-rWGaqaXlrhEJiAQFPo23BT3Gq_sWoBXU,14701
+httpcore/_async/interfaces.py,sha256=jTiaWL83pgpGC9ziv90ZfwaKNMmHwmOalzaKiuTxATo,4455
+httpcore/_async/socks_proxy.py,sha256=lLKgLlggPfhFlqi0ODeBkOWvt9CghBBUyqsnsU1tx6Q,13841
+httpcore/_backends/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+httpcore/_backends/__pycache__/__init__.cpython-312.pyc,,
+httpcore/_backends/__pycache__/anyio.cpython-312.pyc,,
+httpcore/_backends/__pycache__/auto.cpython-312.pyc,,
+httpcore/_backends/__pycache__/base.cpython-312.pyc,,
+httpcore/_backends/__pycache__/mock.cpython-312.pyc,,
+httpcore/_backends/__pycache__/sync.cpython-312.pyc,,
+httpcore/_backends/__pycache__/trio.cpython-312.pyc,,
+httpcore/_backends/anyio.py,sha256=x8PgEhXRC8bVqsdzk_YJx8Y6d9Tub06CuUSwnbmtqoY,5252
+httpcore/_backends/auto.py,sha256=zO136PKZmsaTDK-HRk84eA-MUg8_2wJf4NvmK432Aio,1662
+httpcore/_backends/base.py,sha256=aShgRdZnMmRhFWHetjumlM73f8Kz1YOAyCUP_4kHslA,3042
+httpcore/_backends/mock.py,sha256=er9T436uSe7NLrfiLa4x6Nuqg5ivQ693CxWYCWsgbH4,4077
+httpcore/_backends/sync.py,sha256=bhE4d9iK9Umxdsdsgm2EfKnXaBms2WggGYU-7jmUujU,7977
+httpcore/_backends/trio.py,sha256=LHu4_Mr5MswQmmT3yE4oLgf9b_JJfeVS4BjDxeJc7Ro,5996
+httpcore/_exceptions.py,sha256=looCKga3_YVYu3s-d3L9RMPRJyhsY7fiuuGxvkOD0c0,1184
+httpcore/_models.py,sha256=IO2CcXcdpovRcLTdGFGB6RyBZdEm2h_TOmoCc4rEKho,17623
+httpcore/_ssl.py,sha256=srqmSNU4iOUvWF-SrJvb8G_YEbHFELOXQOwdDIBTS9c,187
+httpcore/_sync/__init__.py,sha256=JBDIgXt5la1LCJ1sLQeKhjKFpLnpNr8Svs6z2ni3fgg,1141
+httpcore/_sync/__pycache__/__init__.cpython-312.pyc,,
+httpcore/_sync/__pycache__/connection.cpython-312.pyc,,
+httpcore/_sync/__pycache__/connection_pool.cpython-312.pyc,,
+httpcore/_sync/__pycache__/http11.cpython-312.pyc,,
+httpcore/_sync/__pycache__/http2.cpython-312.pyc,,
+httpcore/_sync/__pycache__/http_proxy.cpython-312.pyc,,
+httpcore/_sync/__pycache__/interfaces.cpython-312.pyc,,
+httpcore/_sync/__pycache__/socks_proxy.cpython-312.pyc,,
+httpcore/_sync/connection.py,sha256=9exGOb3PB-Mp2T1-sckSeL2t-tJ_9-NXomV8ihmWCgU,8238
+httpcore/_sync/connection_pool.py,sha256=a-T8LTsUxc7r0Ww1atfHSDoWPjQ0fA8Ul7S3-F0Mj70,16955
+httpcore/_sync/http11.py,sha256=IFobD1Md5JFlJGKWnh1_Q3epikUryI8qo09v8MiJIEA,13476
+httpcore/_sync/http2.py,sha256=AxU4yhcq68Bn5vqdJYtiXKYUj7nvhYbxz3v4rT4xnvA,23400
+httpcore/_sync/http_proxy.py,sha256=_al_6crKuEZu2wyvu493RZImJdBJnj5oGKNjLOJL2Zo,14463
+httpcore/_sync/interfaces.py,sha256=snXON42vUDHO5JBJvo8D4VWk2Wat44z2OXXHDrjbl94,4344
+httpcore/_sync/socks_proxy.py,sha256=zegZW9Snqj2_992DFJa8_CppOVBkVL4AgwduRkStakQ,13614
+httpcore/_synchronization.py,sha256=zSi13mAColBnknjZBknUC6hKNDQT4C6ijnezZ-r0T2s,9434
+httpcore/_trace.py,sha256=ck6ZoIzYTkdNAIfq5MGeKqBXDtqjOX-qfYwmZFbrGco,3952
+httpcore/_utils.py,sha256=_RLgXYOAYC350ikALV59GZ68IJrdocRZxPs9PjmzdFY,1537
+httpcore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/REQUESTED
new file mode 100644
index 00000000..e69de29b
diff --git a/Backend/venv/lib/python3.12/site-packages/python_multipart-0.0.6.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/WHEEL
similarity index 67%
rename from Backend/venv/lib/python3.12/site-packages/python_multipart-0.0.6.dist-info/WHEEL
rename to Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/WHEEL
index 9d727675..12228d41 100644
--- a/Backend/venv/lib/python3.12/site-packages/python_multipart-0.0.6.dist-info/WHEEL
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/WHEEL
@@ -1,4 +1,4 @@
Wheel-Version: 1.0
-Generator: hatchling 1.13.0
+Generator: hatchling 1.27.0
Root-Is-Purelib: true
Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/LICENSE.md b/Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/licenses/LICENSE.md
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/httpcore-0.17.3.dist-info/LICENSE.md
rename to Backend/venv/lib/python3.12/site-packages/httpcore-1.0.9.dist-info/licenses/LICENSE.md
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__init__.py b/Backend/venv/lib/python3.12/site-packages/httpcore/__init__.py
index da95f8d0..9a92dc4a 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/__init__.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/__init__.py
@@ -34,7 +34,7 @@ from ._exceptions import (
WriteError,
WriteTimeout,
)
-from ._models import URL, Origin, Request, Response
+from ._models import URL, Origin, Proxy, Request, Response
from ._ssl import default_ssl_context
from ._sync import (
ConnectionInterface,
@@ -79,6 +79,7 @@ __all__ = [
"URL",
"Request",
"Response",
+ "Proxy",
# async
"AsyncHTTPConnection",
"AsyncConnectionPool",
@@ -130,10 +131,11 @@ __all__ = [
"WriteError",
]
-__version__ = "0.17.3"
+__version__ = "1.0.9"
__locals = locals()
for __name in __all__:
- if not __name.startswith("__"):
+ # Exclude SOCKET_OPTION, it causes AttributeError on Python 3.14
+ if not __name.startswith(("__", "SOCKET_OPTION")):
setattr(__locals[__name], "__module__", "httpcore") # noqa
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/__init__.cpython-312.pyc
index 41b78124..ba9ba59f 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_api.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_api.cpython-312.pyc
index ce707b9e..912cd3b9 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_api.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_api.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_exceptions.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_exceptions.cpython-312.pyc
index 220706e0..9a086d3b 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_exceptions.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_exceptions.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_models.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_models.cpython-312.pyc
index 5901eeef..c9afd99b 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_models.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_models.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_ssl.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_ssl.cpython-312.pyc
index 990abe20..6c6116b8 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_ssl.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_ssl.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_synchronization.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_synchronization.cpython-312.pyc
index 344ea370..30384823 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_synchronization.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_synchronization.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_trace.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_trace.cpython-312.pyc
index 6f287881..76c6f91b 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_trace.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_trace.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_utils.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_utils.cpython-312.pyc
index fb5150d8..e5263d7b 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_utils.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/__pycache__/_utils.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_api.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_api.py
index 854235f5..38b961d1 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_api.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_api.py
@@ -1,17 +1,19 @@
-from contextlib import contextmanager
-from typing import Iterator, Optional, Union
+from __future__ import annotations
+
+import contextlib
+import typing
from ._models import URL, Extensions, HeaderTypes, Response
from ._sync.connection_pool import ConnectionPool
def request(
- method: Union[bytes, str],
- url: Union[URL, bytes, str],
+ method: bytes | str,
+ url: URL | bytes | str,
*,
headers: HeaderTypes = None,
- content: Union[bytes, Iterator[bytes], None] = None,
- extensions: Optional[Extensions] = None,
+ content: bytes | typing.Iterator[bytes] | None = None,
+ extensions: Extensions | None = None,
) -> Response:
"""
Sends an HTTP request, returning the response.
@@ -45,15 +47,15 @@ def request(
)
-@contextmanager
+@contextlib.contextmanager
def stream(
- method: Union[bytes, str],
- url: Union[URL, bytes, str],
+ method: bytes | str,
+ url: URL | bytes | str,
*,
headers: HeaderTypes = None,
- content: Union[bytes, Iterator[bytes], None] = None,
- extensions: Optional[Extensions] = None,
-) -> Iterator[Response]:
+ content: bytes | typing.Iterator[bytes] | None = None,
+ extensions: Extensions | None = None,
+) -> typing.Iterator[Response]:
"""
Sends an HTTP request, returning the response within a content manager.
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/__init__.cpython-312.pyc
index 56197452..225aea1c 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection.cpython-312.pyc
index ea6d8c90..7d1b0e5c 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection_pool.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection_pool.cpython-312.pyc
index cf79b745..90940467 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection_pool.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/connection_pool.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http11.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http11.cpython-312.pyc
index fcee7ab6..3ff50d2d 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http11.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http11.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http2.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http2.cpython-312.pyc
index 930bd1f1..8faf6409 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http2.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http2.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http_proxy.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http_proxy.cpython-312.pyc
index b11a20c1..e0f406b9 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http_proxy.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/http_proxy.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/interfaces.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/interfaces.cpython-312.pyc
index d508b399..b5e17fd1 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/interfaces.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/interfaces.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/socks_proxy.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/socks_proxy.cpython-312.pyc
index 93ab0b1f..a01c1609 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/socks_proxy.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/__pycache__/socks_proxy.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection.py
index 9014ab95..b42581df 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection.py
@@ -1,12 +1,14 @@
+from __future__ import annotations
+
import itertools
import logging
import ssl
-from types import TracebackType
-from typing import Iterable, Iterator, Optional, Type
+import types
+import typing
from .._backends.auto import AutoBackend
from .._backends.base import SOCKET_OPTION, AsyncNetworkBackend, AsyncNetworkStream
-from .._exceptions import ConnectError, ConnectionNotAvailable, ConnectTimeout
+from .._exceptions import ConnectError, ConnectTimeout
from .._models import Origin, Request, Response
from .._ssl import default_ssl_context
from .._synchronization import AsyncLock
@@ -20,25 +22,32 @@ RETRIES_BACKOFF_FACTOR = 0.5 # 0s, 0.5s, 1s, 2s, 4s, etc.
logger = logging.getLogger("httpcore.connection")
-def exponential_backoff(factor: float) -> Iterator[float]:
+def exponential_backoff(factor: float) -> typing.Iterator[float]:
+ """
+ Generate a geometric sequence that has a ratio of 2 and starts with 0.
+
+ For example:
+ - `factor = 2`: `0, 2, 4, 8, 16, 32, 64, ...`
+ - `factor = 3`: `0, 3, 6, 12, 24, 48, 96, ...`
+ """
yield 0
- for n in itertools.count(2):
- yield factor * (2 ** (n - 2))
+ for n in itertools.count():
+ yield factor * 2**n
class AsyncHTTPConnection(AsyncConnectionInterface):
def __init__(
self,
origin: Origin,
- ssl_context: Optional[ssl.SSLContext] = None,
- keepalive_expiry: Optional[float] = None,
+ ssl_context: ssl.SSLContext | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- local_address: Optional[str] = None,
- uds: Optional[str] = None,
- network_backend: Optional[AsyncNetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ local_address: str | None = None,
+ uds: str | None = None,
+ network_backend: AsyncNetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
self._origin = origin
self._ssl_context = ssl_context
@@ -52,7 +61,7 @@ class AsyncHTTPConnection(AsyncConnectionInterface):
self._network_backend: AsyncNetworkBackend = (
AutoBackend() if network_backend is None else network_backend
)
- self._connection: Optional[AsyncConnectionInterface] = None
+ self._connection: AsyncConnectionInterface | None = None
self._connect_failed: bool = False
self._request_lock = AsyncLock()
self._socket_options = socket_options
@@ -63,9 +72,9 @@ class AsyncHTTPConnection(AsyncConnectionInterface):
f"Attempted to send request to {request.url.origin} on connection to {self._origin}"
)
- async with self._request_lock:
- if self._connection is None:
- try:
+ try:
+ async with self._request_lock:
+ if self._connection is None:
stream = await self._connect(request)
ssl_object = stream.get_extra_info("ssl_object")
@@ -87,11 +96,9 @@ class AsyncHTTPConnection(AsyncConnectionInterface):
stream=stream,
keepalive_expiry=self._keepalive_expiry,
)
- except Exception as exc:
- self._connect_failed = True
- raise exc
- elif not self._connection.is_available():
- raise ConnectionNotAvailable()
+ except BaseException as exc:
+ self._connect_failed = True
+ raise exc
return await self._connection.handle_async_request(request)
@@ -130,7 +137,7 @@ class AsyncHTTPConnection(AsyncConnectionInterface):
)
trace.return_value = stream
- if self._origin.scheme == b"https":
+ if self._origin.scheme in (b"https", b"wss"):
ssl_context = (
default_ssl_context()
if self._ssl_context is None
@@ -203,13 +210,13 @@ class AsyncHTTPConnection(AsyncConnectionInterface):
# These context managers are not used in the standard flow, but are
# useful for testing or working with connection instances directly.
- async def __aenter__(self) -> "AsyncHTTPConnection":
+ async def __aenter__(self) -> AsyncHTTPConnection:
return self
async def __aexit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
await self.aclose()
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection_pool.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection_pool.py
index ddc0510e..96e973d0 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection_pool.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/connection_pool.py
@@ -1,41 +1,44 @@
+from __future__ import annotations
+
import ssl
import sys
-from types import TracebackType
-from typing import AsyncIterable, AsyncIterator, Iterable, List, Optional, Type
+import types
+import typing
from .._backends.auto import AutoBackend
from .._backends.base import SOCKET_OPTION, AsyncNetworkBackend
from .._exceptions import ConnectionNotAvailable, UnsupportedProtocol
-from .._models import Origin, Request, Response
-from .._synchronization import AsyncEvent, AsyncLock, AsyncShieldCancellation
+from .._models import Origin, Proxy, Request, Response
+from .._synchronization import AsyncEvent, AsyncShieldCancellation, AsyncThreadLock
from .connection import AsyncHTTPConnection
from .interfaces import AsyncConnectionInterface, AsyncRequestInterface
-class RequestStatus:
- def __init__(self, request: Request):
+class AsyncPoolRequest:
+ def __init__(self, request: Request) -> None:
self.request = request
- self.connection: Optional[AsyncConnectionInterface] = None
+ self.connection: AsyncConnectionInterface | None = None
self._connection_acquired = AsyncEvent()
- def set_connection(self, connection: AsyncConnectionInterface) -> None:
- assert self.connection is None
+ def assign_to_connection(self, connection: AsyncConnectionInterface | None) -> None:
self.connection = connection
self._connection_acquired.set()
- def unset_connection(self) -> None:
- assert self.connection is not None
+ def clear_connection(self) -> None:
self.connection = None
self._connection_acquired = AsyncEvent()
async def wait_for_connection(
- self, timeout: Optional[float] = None
+ self, timeout: float | None = None
) -> AsyncConnectionInterface:
if self.connection is None:
await self._connection_acquired.wait(timeout=timeout)
assert self.connection is not None
return self.connection
+ def is_queued(self) -> bool:
+ return self.connection is None
+
class AsyncConnectionPool(AsyncRequestInterface):
"""
@@ -44,17 +47,18 @@ class AsyncConnectionPool(AsyncRequestInterface):
def __init__(
self,
- ssl_context: Optional[ssl.SSLContext] = None,
- max_connections: Optional[int] = 10,
- max_keepalive_connections: Optional[int] = None,
- keepalive_expiry: Optional[float] = None,
+ ssl_context: ssl.SSLContext | None = None,
+ proxy: Proxy | None = None,
+ max_connections: int | None = 10,
+ max_keepalive_connections: int | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- local_address: Optional[str] = None,
- uds: Optional[str] = None,
- network_backend: Optional[AsyncNetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ local_address: str | None = None,
+ uds: str | None = None,
+ network_backend: AsyncNetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
"""
A connection pool for making HTTP requests.
@@ -86,7 +90,7 @@ class AsyncConnectionPool(AsyncRequestInterface):
in the TCP socket when the connection was established.
"""
self._ssl_context = ssl_context
-
+ self._proxy = proxy
self._max_connections = (
sys.maxsize if max_connections is None else max_connections
)
@@ -106,15 +110,61 @@ class AsyncConnectionPool(AsyncRequestInterface):
self._local_address = local_address
self._uds = uds
- self._pool: List[AsyncConnectionInterface] = []
- self._requests: List[RequestStatus] = []
- self._pool_lock = AsyncLock()
self._network_backend = (
AutoBackend() if network_backend is None else network_backend
)
self._socket_options = socket_options
+ # The mutable state on a connection pool is the queue of incoming requests,
+ # and the set of connections that are servicing those requests.
+ self._connections: list[AsyncConnectionInterface] = []
+ self._requests: list[AsyncPoolRequest] = []
+
+ # We only mutate the state of the connection pool within an 'optional_thread_lock'
+ # context. This holds a threading lock unless we're running in async mode,
+ # in which case it is a no-op.
+ self._optional_thread_lock = AsyncThreadLock()
+
def create_connection(self, origin: Origin) -> AsyncConnectionInterface:
+ if self._proxy is not None:
+ if self._proxy.url.scheme in (b"socks5", b"socks5h"):
+ from .socks_proxy import AsyncSocks5Connection
+
+ return AsyncSocks5Connection(
+ proxy_origin=self._proxy.url.origin,
+ proxy_auth=self._proxy.auth,
+ remote_origin=origin,
+ ssl_context=self._ssl_context,
+ keepalive_expiry=self._keepalive_expiry,
+ http1=self._http1,
+ http2=self._http2,
+ network_backend=self._network_backend,
+ )
+ elif origin.scheme == b"http":
+ from .http_proxy import AsyncForwardHTTPConnection
+
+ return AsyncForwardHTTPConnection(
+ proxy_origin=self._proxy.url.origin,
+ proxy_headers=self._proxy.headers,
+ proxy_ssl_context=self._proxy.ssl_context,
+ remote_origin=origin,
+ keepalive_expiry=self._keepalive_expiry,
+ network_backend=self._network_backend,
+ )
+ from .http_proxy import AsyncTunnelHTTPConnection
+
+ return AsyncTunnelHTTPConnection(
+ proxy_origin=self._proxy.url.origin,
+ proxy_headers=self._proxy.headers,
+ proxy_ssl_context=self._proxy.ssl_context,
+ remote_origin=origin,
+ ssl_context=self._ssl_context,
+ keepalive_expiry=self._keepalive_expiry,
+ http1=self._http1,
+ http2=self._http2,
+ network_backend=self._network_backend,
+ )
+
return AsyncHTTPConnection(
origin=origin,
ssl_context=self._ssl_context,
@@ -129,7 +179,7 @@ class AsyncConnectionPool(AsyncRequestInterface):
)
@property
- def connections(self) -> List[AsyncConnectionInterface]:
+ def connections(self) -> list[AsyncConnectionInterface]:
"""
Return a list of the connections currently in the pool.
@@ -144,64 +194,7 @@ class AsyncConnectionPool(AsyncRequestInterface):
]
```
"""
- return list(self._pool)
-
- async def _attempt_to_acquire_connection(self, status: RequestStatus) -> bool:
- """
- Attempt to provide a connection that can handle the given origin.
- """
- origin = status.request.url.origin
-
- # If there are queued requests in front of us, then don't acquire a
- # connection. We handle requests strictly in order.
- waiting = [s for s in self._requests if s.connection is None]
- if waiting and waiting[0] is not status:
- return False
-
- # Reuse an existing connection if one is currently available.
- for idx, connection in enumerate(self._pool):
- if connection.can_handle_request(origin) and connection.is_available():
- self._pool.pop(idx)
- self._pool.insert(0, connection)
- status.set_connection(connection)
- return True
-
- # If the pool is currently full, attempt to close one idle connection.
- if len(self._pool) >= self._max_connections:
- for idx, connection in reversed(list(enumerate(self._pool))):
- if connection.is_idle():
- await connection.aclose()
- self._pool.pop(idx)
- break
-
- # If the pool is still full, then we cannot acquire a connection.
- if len(self._pool) >= self._max_connections:
- return False
-
- # Otherwise create a new connection.
- connection = self.create_connection(origin)
- self._pool.insert(0, connection)
- status.set_connection(connection)
- return True
-
- async def _close_expired_connections(self) -> None:
- """
- Clean up the connection pool by closing off any connections that have expired.
- """
- # Close any connections that have expired their keep-alive time.
- for idx, connection in reversed(list(enumerate(self._pool))):
- if connection.has_expired():
- await connection.aclose()
- self._pool.pop(idx)
-
- # If the pool size exceeds the maximum number of allowed keep-alive connections,
- # then close off idle connections as required.
- pool_size = len(self._pool)
- for idx, connection in reversed(list(enumerate(self._pool))):
- if connection.is_idle() and pool_size > self._max_keepalive_connections:
- await connection.aclose()
- self._pool.pop(idx)
- pool_size -= 1
+ return list(self._connections)
async def handle_async_request(self, request: Request) -> Response:
"""
@@ -219,138 +212,209 @@ class AsyncConnectionPool(AsyncRequestInterface):
f"Request URL has an unsupported protocol '{scheme}://'."
)
- status = RequestStatus(request)
+ timeouts = request.extensions.get("timeout", {})
+ timeout = timeouts.get("pool", None)
- async with self._pool_lock:
- self._requests.append(status)
- await self._close_expired_connections()
- await self._attempt_to_acquire_connection(status)
+ with self._optional_thread_lock:
+ # Add the incoming request to our request queue.
+ pool_request = AsyncPoolRequest(request)
+ self._requests.append(pool_request)
- while True:
- timeouts = request.extensions.get("timeout", {})
- timeout = timeouts.get("pool", None)
- try:
- connection = await status.wait_for_connection(timeout=timeout)
- except BaseException as exc:
- # If we timeout here, or if the task is cancelled, then make
- # sure to remove the request from the queue before bubbling
- # up the exception.
- async with self._pool_lock:
- # Ensure only remove when task exists.
- if status in self._requests:
- self._requests.remove(status)
- raise exc
+ try:
+ while True:
+ with self._optional_thread_lock:
+ # Assign incoming requests to available connections,
+ # closing or creating new connections as required.
+ closing = self._assign_requests_to_connections()
+ await self._close_connections(closing)
- try:
- response = await connection.handle_async_request(request)
- except ConnectionNotAvailable:
- # The ConnectionNotAvailable exception is a special case, that
- # indicates we need to retry the request on a new connection.
- #
- # The most common case where this can occur is when multiple
- # requests are queued waiting for a single connection, which
- # might end up as an HTTP/2 connection, but which actually ends
- # up as HTTP/1.1.
- async with self._pool_lock:
- # Maintain our position in the request queue, but reset the
- # status so that the request becomes queued again.
- status.unset_connection()
- await self._attempt_to_acquire_connection(status)
- except BaseException as exc:
- with AsyncShieldCancellation():
- await self.response_closed(status)
- raise exc
- else:
- break
+ # Wait until this request has an assigned connection.
+ connection = await pool_request.wait_for_connection(timeout=timeout)
- # When we return the response, we wrap the stream in a special class
- # that handles notifying the connection pool once the response
- # has been released.
- assert isinstance(response.stream, AsyncIterable)
+ try:
+ # Send the request on the assigned connection.
+ response = await connection.handle_async_request(
+ pool_request.request
+ )
+ except ConnectionNotAvailable:
+ # In some cases a connection may initially be available to
+ # handle a request, but then become unavailable.
+ #
+ # In this case we clear the connection and try again.
+ pool_request.clear_connection()
+ else:
+ break # pragma: nocover
+
+ except BaseException as exc:
+ with self._optional_thread_lock:
+ # For any exception or cancellation we remove the request from
+ # the queue, and then re-assign requests to connections.
+ self._requests.remove(pool_request)
+ closing = self._assign_requests_to_connections()
+
+ await self._close_connections(closing)
+ raise exc from None
+
+ # Return the response. Note that in this case we still have to manage
+ # the point at which the response is closed.
+ assert isinstance(response.stream, typing.AsyncIterable)
return Response(
status=response.status,
headers=response.headers,
- content=ConnectionPoolByteStream(response.stream, self, status),
+ content=PoolByteStream(
+ stream=response.stream, pool_request=pool_request, pool=self
+ ),
extensions=response.extensions,
)
- async def response_closed(self, status: RequestStatus) -> None:
+ def _assign_requests_to_connections(self) -> list[AsyncConnectionInterface]:
"""
- This method acts as a callback once the request/response cycle is complete.
+ Manage the state of the connection pool, assigning incoming
+ requests to connections as available.
- It is called into from the `ConnectionPoolByteStream.aclose()` method.
+ Called whenever a new request is added or removed from the pool.
+
+ Any closing connections are returned, allowing the I/O for closing
+ those connections to be handled seperately.
"""
- assert status.connection is not None
- connection = status.connection
+ closing_connections = []
- async with self._pool_lock:
- # Update the state of the connection pool.
- if status in self._requests:
- self._requests.remove(status)
+ # First we handle cleaning up any connections that are closed,
+ # have expired their keep-alive, or surplus idle connections.
+ for connection in list(self._connections):
+ if connection.is_closed():
+ # log: "removing closed connection"
+ self._connections.remove(connection)
+ elif connection.has_expired():
+ # log: "closing expired connection"
+ self._connections.remove(connection)
+ closing_connections.append(connection)
+ elif (
+ connection.is_idle()
+ and len([connection.is_idle() for connection in self._connections])
+ > self._max_keepalive_connections
+ ):
+ # log: "closing idle connection"
+ self._connections.remove(connection)
+ closing_connections.append(connection)
- if connection.is_closed() and connection in self._pool:
- self._pool.remove(connection)
+ # Assign queued requests to connections.
+ queued_requests = [request for request in self._requests if request.is_queued()]
+ for pool_request in queued_requests:
+ origin = pool_request.request.url.origin
+ available_connections = [
+ connection
+ for connection in self._connections
+ if connection.can_handle_request(origin) and connection.is_available()
+ ]
+ idle_connections = [
+ connection for connection in self._connections if connection.is_idle()
+ ]
- # Since we've had a response closed, it's possible we'll now be able
- # to service one or more requests that are currently pending.
- for status in self._requests:
- if status.connection is None:
- acquired = await self._attempt_to_acquire_connection(status)
- # If we could not acquire a connection for a queued request
- # then we don't need to check anymore requests that are
- # queued later behind it.
- if not acquired:
- break
+ # There are three cases for how we may be able to handle the request:
+ #
+ # 1. There is an existing connection that can handle the request.
+ # 2. We can create a new connection to handle the request.
+ # 3. We can close an idle connection and then create a new connection
+ # to handle the request.
+ if available_connections:
+ # log: "reusing existing connection"
+ connection = available_connections[0]
+ pool_request.assign_to_connection(connection)
+ elif len(self._connections) < self._max_connections:
+ # log: "creating new connection"
+ connection = self.create_connection(origin)
+ self._connections.append(connection)
+ pool_request.assign_to_connection(connection)
+ elif idle_connections:
+ # log: "closing idle connection"
+ connection = idle_connections[0]
+ self._connections.remove(connection)
+ closing_connections.append(connection)
+ # log: "creating new connection"
+ connection = self.create_connection(origin)
+ self._connections.append(connection)
+ pool_request.assign_to_connection(connection)
- # Housekeeping.
- await self._close_expired_connections()
+ return closing_connections
+
+ async def _close_connections(self, closing: list[AsyncConnectionInterface]) -> None:
+ # Close connections which have been removed from the pool.
+ with AsyncShieldCancellation():
+ for connection in closing:
+ await connection.aclose()
async def aclose(self) -> None:
- """
- Close any connections in the pool.
- """
- async with self._pool_lock:
- for connection in self._pool:
- await connection.aclose()
- self._pool = []
- self._requests = []
+ # Explicitly close the connection pool.
+ # Clears all existing requests and connections.
+ with self._optional_thread_lock:
+ closing_connections = list(self._connections)
+ self._connections = []
+ await self._close_connections(closing_connections)
- async def __aenter__(self) -> "AsyncConnectionPool":
+ async def __aenter__(self) -> AsyncConnectionPool:
return self
async def __aexit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
await self.aclose()
+ def __repr__(self) -> str:
+ class_name = self.__class__.__name__
+ with self._optional_thread_lock:
+ request_is_queued = [request.is_queued() for request in self._requests]
+ connection_is_idle = [
+ connection.is_idle() for connection in self._connections
+ ]
-class ConnectionPoolByteStream:
- """
- A wrapper around the response byte stream, that additionally handles
- notifying the connection pool when the response has been closed.
- """
+ num_active_requests = request_is_queued.count(False)
+ num_queued_requests = request_is_queued.count(True)
+ num_active_connections = connection_is_idle.count(False)
+ num_idle_connections = connection_is_idle.count(True)
+ requests_info = (
+ f"Requests: {num_active_requests} active, {num_queued_requests} queued"
+ )
+ connection_info = (
+ f"Connections: {num_active_connections} active, {num_idle_connections} idle"
+ )
+
+ return f"<{class_name} [{requests_info} | {connection_info}]>"
+
+
+class PoolByteStream:
def __init__(
self,
- stream: AsyncIterable[bytes],
+ stream: typing.AsyncIterable[bytes],
+ pool_request: AsyncPoolRequest,
pool: AsyncConnectionPool,
- status: RequestStatus,
) -> None:
self._stream = stream
+ self._pool_request = pool_request
self._pool = pool
- self._status = status
+ self._closed = False
- async def __aiter__(self) -> AsyncIterator[bytes]:
- async for part in self._stream:
- yield part
+ async def __aiter__(self) -> typing.AsyncIterator[bytes]:
+ try:
+ async for part in self._stream:
+ yield part
+ except BaseException as exc:
+ await self.aclose()
+ raise exc from None
async def aclose(self) -> None:
- try:
- if hasattr(self._stream, "aclose"):
- await self._stream.aclose()
- finally:
+ if not self._closed:
+ self._closed = True
with AsyncShieldCancellation():
- await self._pool.response_closed(self._status)
+ if hasattr(self._stream, "aclose"):
+ await self._stream.aclose()
+
+ with self._pool._optional_thread_lock:
+ self._pool._requests.remove(self._pool_request)
+ closing = self._pool._assign_requests_to_connections()
+
+ await self._pool._close_connections(closing)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http11.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http11.py
index 7ad36642..e6d6d709 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http11.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http11.py
@@ -1,17 +1,11 @@
+from __future__ import annotations
+
import enum
import logging
+import ssl
import time
-from types import TracebackType
-from typing import (
- AsyncIterable,
- AsyncIterator,
- List,
- Optional,
- Tuple,
- Type,
- Union,
- cast,
-)
+import types
+import typing
import h11
@@ -20,6 +14,7 @@ from .._exceptions import (
ConnectionNotAvailable,
LocalProtocolError,
RemoteProtocolError,
+ WriteError,
map_exceptions,
)
from .._models import Origin, Request, Response
@@ -31,7 +26,7 @@ logger = logging.getLogger("httpcore.http11")
# A subset of `h11.Event` types supported by `_send_event`
-H11SendEvent = Union[
+H11SendEvent = typing.Union[
h11.Request,
h11.Data,
h11.EndOfMessage,
@@ -53,12 +48,12 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
self,
origin: Origin,
stream: AsyncNetworkStream,
- keepalive_expiry: Optional[float] = None,
+ keepalive_expiry: float | None = None,
) -> None:
self._origin = origin
self._network_stream = stream
- self._keepalive_expiry: Optional[float] = keepalive_expiry
- self._expire_at: Optional[float] = None
+ self._keepalive_expiry: float | None = keepalive_expiry
+ self._expire_at: float | None = None
self._state = HTTPConnectionState.NEW
self._state_lock = AsyncLock()
self._request_count = 0
@@ -84,10 +79,21 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
try:
kwargs = {"request": request}
- async with Trace("send_request_headers", logger, request, kwargs) as trace:
- await self._send_request_headers(**kwargs)
- async with Trace("send_request_body", logger, request, kwargs) as trace:
- await self._send_request_body(**kwargs)
+ try:
+ async with Trace(
+ "send_request_headers", logger, request, kwargs
+ ) as trace:
+ await self._send_request_headers(**kwargs)
+ async with Trace("send_request_body", logger, request, kwargs) as trace:
+ await self._send_request_body(**kwargs)
+ except WriteError:
+ # If we get a write error while we're writing the request,
+ # then we supress this error and move on to attempting to
+ # read the response. Servers can sometimes close the request
+ # pre-emptively and then respond with a well formed HTTP
+ # error response.
+ pass
+
async with Trace(
"receive_response_headers", logger, request, kwargs
) as trace:
@@ -96,6 +102,7 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
status,
reason_phrase,
headers,
+ trailing_data,
) = await self._receive_response_headers(**kwargs)
trace.return_value = (
http_version,
@@ -104,6 +111,14 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
headers,
)
+ network_stream = self._network_stream
+
+ # CONNECT or Upgrade request
+ if (status == 101) or (
+ (request.method == b"CONNECT") and (200 <= status < 300)
+ ):
+ network_stream = AsyncHTTP11UpgradeStream(network_stream, trailing_data)
+
return Response(
status=status,
headers=headers,
@@ -111,7 +126,7 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
extensions={
"http_version": http_version,
"reason_phrase": reason_phrase,
- "network_stream": self._network_stream,
+ "network_stream": network_stream,
},
)
except BaseException as exc:
@@ -138,16 +153,14 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("write", None)
- assert isinstance(request.stream, AsyncIterable)
+ assert isinstance(request.stream, typing.AsyncIterable)
async for chunk in request.stream:
event = h11.Data(data=chunk)
await self._send_event(event, timeout=timeout)
await self._send_event(h11.EndOfMessage(), timeout=timeout)
- async def _send_event(
- self, event: h11.Event, timeout: Optional[float] = None
- ) -> None:
+ async def _send_event(self, event: h11.Event, timeout: float | None = None) -> None:
bytes_to_send = self._h11_state.send(event)
if bytes_to_send is not None:
await self._network_stream.write(bytes_to_send, timeout=timeout)
@@ -156,7 +169,7 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
async def _receive_response_headers(
self, request: Request
- ) -> Tuple[bytes, int, bytes, List[Tuple[bytes, bytes]]]:
+ ) -> tuple[bytes, int, bytes, list[tuple[bytes, bytes]], bytes]:
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("read", None)
@@ -176,9 +189,13 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
# raw header casing, rather than the enforced lowercase headers.
headers = event.headers.raw_items()
- return http_version, event.status_code, event.reason, headers
+ trailing_data, _ = self._h11_state.trailing_data
- async def _receive_response_body(self, request: Request) -> AsyncIterator[bytes]:
+ return http_version, event.status_code, event.reason, headers, trailing_data
+
+ async def _receive_response_body(
+ self, request: Request
+ ) -> typing.AsyncIterator[bytes]:
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("read", None)
@@ -190,8 +207,8 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
break
async def _receive_event(
- self, timeout: Optional[float] = None
- ) -> Union[h11.Event, Type[h11.PAUSED]]:
+ self, timeout: float | None = None
+ ) -> h11.Event | type[h11.PAUSED]:
while True:
with map_exceptions({h11.RemoteProtocolError: RemoteProtocolError}):
event = self._h11_state.next_event()
@@ -216,7 +233,7 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
self._h11_state.receive_data(data)
else:
# mypy fails to narrow the type in the above if statement above
- return cast(Union[h11.Event, Type[h11.PAUSED]], event)
+ return event # type: ignore[return-value]
async def _response_closed(self) -> None:
async with self._state_lock:
@@ -292,14 +309,14 @@ class AsyncHTTP11Connection(AsyncConnectionInterface):
# These context managers are not used in the standard flow, but are
# useful for testing or working with connection instances directly.
- async def __aenter__(self) -> "AsyncHTTP11Connection":
+ async def __aenter__(self) -> AsyncHTTP11Connection:
return self
async def __aexit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
await self.aclose()
@@ -310,7 +327,7 @@ class HTTP11ConnectionByteStream:
self._request = request
self._closed = False
- async def __aiter__(self) -> AsyncIterator[bytes]:
+ async def __aiter__(self) -> typing.AsyncIterator[bytes]:
kwargs = {"request": self._request}
try:
async with Trace("receive_response_body", logger, self._request, kwargs):
@@ -329,3 +346,34 @@ class HTTP11ConnectionByteStream:
self._closed = True
async with Trace("response_closed", logger, self._request):
await self._connection._response_closed()
+
+
+class AsyncHTTP11UpgradeStream(AsyncNetworkStream):
+ def __init__(self, stream: AsyncNetworkStream, leading_data: bytes) -> None:
+ self._stream = stream
+ self._leading_data = leading_data
+
+ async def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
+ if self._leading_data:
+ buffer = self._leading_data[:max_bytes]
+ self._leading_data = self._leading_data[max_bytes:]
+ return buffer
+ else:
+ return await self._stream.read(max_bytes, timeout)
+
+ async def write(self, buffer: bytes, timeout: float | None = None) -> None:
+ await self._stream.write(buffer, timeout)
+
+ async def aclose(self) -> None:
+ await self._stream.aclose()
+
+ async def start_tls(
+ self,
+ ssl_context: ssl.SSLContext,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
+ ) -> AsyncNetworkStream:
+ return await self._stream.start_tls(ssl_context, server_hostname, timeout)
+
+ def get_extra_info(self, info: str) -> typing.Any:
+ return self._stream.get_extra_info(info)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http2.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http2.py
index 8dc776ff..dbd0beeb 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http2.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http2.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
import enum
import logging
import time
@@ -45,14 +47,14 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
self,
origin: Origin,
stream: AsyncNetworkStream,
- keepalive_expiry: typing.Optional[float] = None,
+ keepalive_expiry: float | None = None,
):
self._origin = origin
self._network_stream = stream
- self._keepalive_expiry: typing.Optional[float] = keepalive_expiry
+ self._keepalive_expiry: float | None = keepalive_expiry
self._h2_state = h2.connection.H2Connection(config=self.CONFIG)
self._state = HTTPConnectionState.IDLE
- self._expire_at: typing.Optional[float] = None
+ self._expire_at: float | None = None
self._request_count = 0
self._init_lock = AsyncLock()
self._state_lock = AsyncLock()
@@ -63,24 +65,22 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
self._connection_error = False
# Mapping from stream ID to response stream events.
- self._events: typing.Dict[
+ self._events: dict[
int,
- typing.Union[
- h2.events.ResponseReceived,
- h2.events.DataReceived,
- h2.events.StreamEnded,
- h2.events.StreamReset,
+ list[
+ h2.events.ResponseReceived
+ | h2.events.DataReceived
+ | h2.events.StreamEnded
+ | h2.events.StreamReset,
],
] = {}
# Connection terminated events are stored as state since
# we need to handle them for all streams.
- self._connection_terminated: typing.Optional[
- h2.events.ConnectionTerminated
- ] = None
+ self._connection_terminated: h2.events.ConnectionTerminated | None = None
- self._read_exception: typing.Optional[Exception] = None
- self._write_exception: typing.Optional[Exception] = None
+ self._read_exception: Exception | None = None
+ self._write_exception: Exception | None = None
async def handle_async_request(self, request: Request) -> Response:
if not self.can_handle_request(request.url.origin):
@@ -104,9 +104,11 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
async with self._init_lock:
if not self._sent_connection_init:
try:
- kwargs = {"request": request}
- async with Trace("send_connection_init", logger, request, kwargs):
- await self._send_connection_init(**kwargs)
+ sci_kwargs = {"request": request}
+ async with Trace(
+ "send_connection_init", logger, request, sci_kwargs
+ ):
+ await self._send_connection_init(**sci_kwargs)
except BaseException as exc:
with AsyncShieldCancellation():
await self.aclose()
@@ -284,7 +286,7 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
async def _receive_response(
self, request: Request, stream_id: int
- ) -> typing.Tuple[int, typing.List[typing.Tuple[bytes, bytes]]]:
+ ) -> tuple[int, list[tuple[bytes, bytes]]]:
"""
Return the response status code and headers for a given stream ID.
"""
@@ -295,6 +297,7 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
status_code = 200
headers = []
+ assert event.headers is not None
for k, v in event.headers:
if k == b":status":
status_code = int(v.decode("ascii", errors="ignore"))
@@ -312,6 +315,8 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
while True:
event = await self._receive_stream_event(request, stream_id)
if isinstance(event, h2.events.DataReceived):
+ assert event.flow_controlled_length is not None
+ assert event.data is not None
amount = event.flow_controlled_length
self._h2_state.acknowledge_received_data(amount, stream_id)
await self._write_outgoing_data(request)
@@ -321,9 +326,7 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
async def _receive_stream_event(
self, request: Request, stream_id: int
- ) -> typing.Union[
- h2.events.ResponseReceived, h2.events.DataReceived, h2.events.StreamEnded
- ]:
+ ) -> h2.events.ResponseReceived | h2.events.DataReceived | h2.events.StreamEnded:
"""
Return the next available event for a given stream ID.
@@ -337,7 +340,7 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
return event
async def _receive_events(
- self, request: Request, stream_id: typing.Optional[int] = None
+ self, request: Request, stream_id: int | None = None
) -> None:
"""
Read some data from the network until we see one or more events
@@ -384,7 +387,9 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
await self._write_outgoing_data(request)
- async def _receive_remote_settings_change(self, event: h2.events.Event) -> None:
+ async def _receive_remote_settings_change(
+ self, event: h2.events.RemoteSettingsChanged
+ ) -> None:
max_concurrent_streams = event.changed_settings.get(
h2.settings.SettingCodes.MAX_CONCURRENT_STREAMS
)
@@ -425,9 +430,7 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
# Wrappers around network read/write operations...
- async def _read_incoming_data(
- self, request: Request
- ) -> typing.List[h2.events.Event]:
+ async def _read_incoming_data(self, request: Request) -> list[h2.events.Event]:
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("read", None)
@@ -451,7 +454,7 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
self._connection_error = True
raise exc
- events: typing.List[h2.events.Event] = self._h2_state.receive_data(data)
+ events: list[h2.events.Event] = self._h2_state.receive_data(data)
return events
@@ -544,14 +547,14 @@ class AsyncHTTP2Connection(AsyncConnectionInterface):
# These context managers are not used in the standard flow, but are
# useful for testing or working with connection instances directly.
- async def __aenter__(self) -> "AsyncHTTP2Connection":
+ async def __aenter__(self) -> AsyncHTTP2Connection:
return self
async def __aexit__(
self,
- exc_type: typing.Optional[typing.Type[BaseException]] = None,
- exc_value: typing.Optional[BaseException] = None,
- traceback: typing.Optional[types.TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
await self.aclose()
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http_proxy.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http_proxy.py
index 62f51097..cc9d9206 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http_proxy.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/http_proxy.py
@@ -1,7 +1,9 @@
+from __future__ import annotations
+
+import base64
import logging
import ssl
-from base64 import b64encode
-from typing import Iterable, List, Mapping, Optional, Sequence, Tuple, Union
+import typing
from .._backends.base import SOCKET_OPTION, AsyncNetworkBackend
from .._exceptions import ProxyError
@@ -22,17 +24,18 @@ from .connection_pool import AsyncConnectionPool
from .http11 import AsyncHTTP11Connection
from .interfaces import AsyncConnectionInterface
-HeadersAsSequence = Sequence[Tuple[Union[bytes, str], Union[bytes, str]]]
-HeadersAsMapping = Mapping[Union[bytes, str], Union[bytes, str]]
+ByteOrStr = typing.Union[bytes, str]
+HeadersAsSequence = typing.Sequence[typing.Tuple[ByteOrStr, ByteOrStr]]
+HeadersAsMapping = typing.Mapping[ByteOrStr, ByteOrStr]
logger = logging.getLogger("httpcore.proxy")
def merge_headers(
- default_headers: Optional[Sequence[Tuple[bytes, bytes]]] = None,
- override_headers: Optional[Sequence[Tuple[bytes, bytes]]] = None,
-) -> List[Tuple[bytes, bytes]]:
+ default_headers: typing.Sequence[tuple[bytes, bytes]] | None = None,
+ override_headers: typing.Sequence[tuple[bytes, bytes]] | None = None,
+) -> list[tuple[bytes, bytes]]:
"""
Append default_headers and override_headers, de-duplicating if a key exists
in both cases.
@@ -48,32 +51,28 @@ def merge_headers(
return default_headers + override_headers
-def build_auth_header(username: bytes, password: bytes) -> bytes:
- userpass = username + b":" + password
- return b"Basic " + b64encode(userpass)
-
-
-class AsyncHTTPProxy(AsyncConnectionPool):
+class AsyncHTTPProxy(AsyncConnectionPool): # pragma: nocover
"""
A connection pool that sends requests via an HTTP proxy.
"""
def __init__(
self,
- proxy_url: Union[URL, bytes, str],
- proxy_auth: Optional[Tuple[Union[bytes, str], Union[bytes, str]]] = None,
- proxy_headers: Union[HeadersAsMapping, HeadersAsSequence, None] = None,
- ssl_context: Optional[ssl.SSLContext] = None,
- max_connections: Optional[int] = 10,
- max_keepalive_connections: Optional[int] = None,
- keepalive_expiry: Optional[float] = None,
+ proxy_url: URL | bytes | str,
+ proxy_auth: tuple[bytes | str, bytes | str] | None = None,
+ proxy_headers: HeadersAsMapping | HeadersAsSequence | None = None,
+ ssl_context: ssl.SSLContext | None = None,
+ proxy_ssl_context: ssl.SSLContext | None = None,
+ max_connections: int | None = 10,
+ max_keepalive_connections: int | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- local_address: Optional[str] = None,
- uds: Optional[str] = None,
- network_backend: Optional[AsyncNetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ local_address: str | None = None,
+ uds: str | None = None,
+ network_backend: AsyncNetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
"""
A connection pool for making HTTP requests.
@@ -88,6 +87,7 @@ class AsyncHTTPProxy(AsyncConnectionPool):
ssl_context: An SSL context to use for verifying connections.
If not specified, the default `httpcore.default_ssl_context()`
will be used.
+ proxy_ssl_context: The same as `ssl_context`, but for a proxy server rather than a remote origin.
max_connections: The maximum number of concurrent HTTP connections that
the pool should allow. Any attempt to send a request on a pool that
would exceed this amount will block until a connection is available.
@@ -122,13 +122,23 @@ class AsyncHTTPProxy(AsyncConnectionPool):
uds=uds,
socket_options=socket_options,
)
- self._ssl_context = ssl_context
+
self._proxy_url = enforce_url(proxy_url, name="proxy_url")
+ if (
+ self._proxy_url.scheme == b"http" and proxy_ssl_context is not None
+ ): # pragma: no cover
+ raise RuntimeError(
+ "The `proxy_ssl_context` argument is not allowed for the http scheme"
+ )
+
+ self._ssl_context = ssl_context
+ self._proxy_ssl_context = proxy_ssl_context
self._proxy_headers = enforce_headers(proxy_headers, name="proxy_headers")
if proxy_auth is not None:
username = enforce_bytes(proxy_auth[0], name="proxy_auth")
password = enforce_bytes(proxy_auth[1], name="proxy_auth")
- authorization = build_auth_header(username, password)
+ userpass = username + b":" + password
+ authorization = b"Basic " + base64.b64encode(userpass)
self._proxy_headers = [
(b"Proxy-Authorization", authorization)
] + self._proxy_headers
@@ -141,12 +151,14 @@ class AsyncHTTPProxy(AsyncConnectionPool):
remote_origin=origin,
keepalive_expiry=self._keepalive_expiry,
network_backend=self._network_backend,
+ proxy_ssl_context=self._proxy_ssl_context,
)
return AsyncTunnelHTTPConnection(
proxy_origin=self._proxy_url.origin,
proxy_headers=self._proxy_headers,
remote_origin=origin,
ssl_context=self._ssl_context,
+ proxy_ssl_context=self._proxy_ssl_context,
keepalive_expiry=self._keepalive_expiry,
http1=self._http1,
http2=self._http2,
@@ -159,16 +171,18 @@ class AsyncForwardHTTPConnection(AsyncConnectionInterface):
self,
proxy_origin: Origin,
remote_origin: Origin,
- proxy_headers: Union[HeadersAsMapping, HeadersAsSequence, None] = None,
- keepalive_expiry: Optional[float] = None,
- network_backend: Optional[AsyncNetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ proxy_headers: HeadersAsMapping | HeadersAsSequence | None = None,
+ keepalive_expiry: float | None = None,
+ network_backend: AsyncNetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
+ proxy_ssl_context: ssl.SSLContext | None = None,
) -> None:
self._connection = AsyncHTTPConnection(
origin=proxy_origin,
keepalive_expiry=keepalive_expiry,
network_backend=network_backend,
socket_options=socket_options,
+ ssl_context=proxy_ssl_context,
)
self._proxy_origin = proxy_origin
self._proxy_headers = enforce_headers(proxy_headers, name="proxy_headers")
@@ -221,23 +235,26 @@ class AsyncTunnelHTTPConnection(AsyncConnectionInterface):
self,
proxy_origin: Origin,
remote_origin: Origin,
- ssl_context: Optional[ssl.SSLContext] = None,
- proxy_headers: Optional[Sequence[Tuple[bytes, bytes]]] = None,
- keepalive_expiry: Optional[float] = None,
+ ssl_context: ssl.SSLContext | None = None,
+ proxy_ssl_context: ssl.SSLContext | None = None,
+ proxy_headers: typing.Sequence[tuple[bytes, bytes]] | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
- network_backend: Optional[AsyncNetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ network_backend: AsyncNetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
self._connection: AsyncConnectionInterface = AsyncHTTPConnection(
origin=proxy_origin,
keepalive_expiry=keepalive_expiry,
network_backend=network_backend,
socket_options=socket_options,
+ ssl_context=proxy_ssl_context,
)
self._proxy_origin = proxy_origin
self._remote_origin = remote_origin
self._ssl_context = ssl_context
+ self._proxy_ssl_context = proxy_ssl_context
self._proxy_headers = enforce_headers(proxy_headers, name="proxy_headers")
self._keepalive_expiry = keepalive_expiry
self._http1 = http1
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/interfaces.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/interfaces.py
index c998dd27..361583be 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/interfaces.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/interfaces.py
@@ -1,5 +1,7 @@
-from contextlib import asynccontextmanager
-from typing import AsyncIterator, Optional, Union
+from __future__ import annotations
+
+import contextlib
+import typing
from .._models import (
URL,
@@ -18,12 +20,12 @@ from .._models import (
class AsyncRequestInterface:
async def request(
self,
- method: Union[bytes, str],
- url: Union[URL, bytes, str],
+ method: bytes | str,
+ url: URL | bytes | str,
*,
headers: HeaderTypes = None,
- content: Union[bytes, AsyncIterator[bytes], None] = None,
- extensions: Optional[Extensions] = None,
+ content: bytes | typing.AsyncIterator[bytes] | None = None,
+ extensions: Extensions | None = None,
) -> Response:
# Strict type checking on our parameters.
method = enforce_bytes(method, name="method")
@@ -47,16 +49,16 @@ class AsyncRequestInterface:
await response.aclose()
return response
- @asynccontextmanager
+ @contextlib.asynccontextmanager
async def stream(
self,
- method: Union[bytes, str],
- url: Union[URL, bytes, str],
+ method: bytes | str,
+ url: URL | bytes | str,
*,
headers: HeaderTypes = None,
- content: Union[bytes, AsyncIterator[bytes], None] = None,
- extensions: Optional[Extensions] = None,
- ) -> AsyncIterator[Response]:
+ content: bytes | typing.AsyncIterator[bytes] | None = None,
+ extensions: Extensions | None = None,
+ ) -> typing.AsyncIterator[Response]:
# Strict type checking on our parameters.
method = enforce_bytes(method, name="method")
url = enforce_url(url, name="url")
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/socks_proxy.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/socks_proxy.py
index f12cb373..b363f55a 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_async/socks_proxy.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_async/socks_proxy.py
@@ -1,8 +1,9 @@
+from __future__ import annotations
+
import logging
import ssl
-import typing
-from socksio import socks5
+import socksio
from .._backends.auto import AutoBackend
from .._backends.base import AsyncNetworkBackend, AsyncNetworkStream
@@ -43,24 +44,24 @@ async def _init_socks5_connection(
*,
host: bytes,
port: int,
- auth: typing.Optional[typing.Tuple[bytes, bytes]] = None,
+ auth: tuple[bytes, bytes] | None = None,
) -> None:
- conn = socks5.SOCKS5Connection()
+ conn = socksio.socks5.SOCKS5Connection()
# Auth method request
auth_method = (
- socks5.SOCKS5AuthMethod.NO_AUTH_REQUIRED
+ socksio.socks5.SOCKS5AuthMethod.NO_AUTH_REQUIRED
if auth is None
- else socks5.SOCKS5AuthMethod.USERNAME_PASSWORD
+ else socksio.socks5.SOCKS5AuthMethod.USERNAME_PASSWORD
)
- conn.send(socks5.SOCKS5AuthMethodsRequest([auth_method]))
+ conn.send(socksio.socks5.SOCKS5AuthMethodsRequest([auth_method]))
outgoing_bytes = conn.data_to_send()
await stream.write(outgoing_bytes)
# Auth method response
incoming_bytes = await stream.read(max_bytes=4096)
response = conn.receive_data(incoming_bytes)
- assert isinstance(response, socks5.SOCKS5AuthReply)
+ assert isinstance(response, socksio.socks5.SOCKS5AuthReply)
if response.method != auth_method:
requested = AUTH_METHODS.get(auth_method, "UNKNOWN")
responded = AUTH_METHODS.get(response.method, "UNKNOWN")
@@ -68,25 +69,25 @@ async def _init_socks5_connection(
f"Requested {requested} from proxy server, but got {responded}."
)
- if response.method == socks5.SOCKS5AuthMethod.USERNAME_PASSWORD:
+ if response.method == socksio.socks5.SOCKS5AuthMethod.USERNAME_PASSWORD:
# Username/password request
assert auth is not None
username, password = auth
- conn.send(socks5.SOCKS5UsernamePasswordRequest(username, password))
+ conn.send(socksio.socks5.SOCKS5UsernamePasswordRequest(username, password))
outgoing_bytes = conn.data_to_send()
await stream.write(outgoing_bytes)
# Username/password response
incoming_bytes = await stream.read(max_bytes=4096)
response = conn.receive_data(incoming_bytes)
- assert isinstance(response, socks5.SOCKS5UsernamePasswordReply)
+ assert isinstance(response, socksio.socks5.SOCKS5UsernamePasswordReply)
if not response.success:
raise ProxyError("Invalid username/password")
# Connect request
conn.send(
- socks5.SOCKS5CommandRequest.from_address(
- socks5.SOCKS5Command.CONNECT, (host, port)
+ socksio.socks5.SOCKS5CommandRequest.from_address(
+ socksio.socks5.SOCKS5Command.CONNECT, (host, port)
)
)
outgoing_bytes = conn.data_to_send()
@@ -95,31 +96,29 @@ async def _init_socks5_connection(
# Connect response
incoming_bytes = await stream.read(max_bytes=4096)
response = conn.receive_data(incoming_bytes)
- assert isinstance(response, socks5.SOCKS5Reply)
- if response.reply_code != socks5.SOCKS5ReplyCode.SUCCEEDED:
+ assert isinstance(response, socksio.socks5.SOCKS5Reply)
+ if response.reply_code != socksio.socks5.SOCKS5ReplyCode.SUCCEEDED:
reply_code = REPLY_CODES.get(response.reply_code, "UNKOWN")
raise ProxyError(f"Proxy Server could not connect: {reply_code}.")
-class AsyncSOCKSProxy(AsyncConnectionPool):
+class AsyncSOCKSProxy(AsyncConnectionPool): # pragma: nocover
"""
A connection pool that sends requests via an HTTP proxy.
"""
def __init__(
self,
- proxy_url: typing.Union[URL, bytes, str],
- proxy_auth: typing.Optional[
- typing.Tuple[typing.Union[bytes, str], typing.Union[bytes, str]]
- ] = None,
- ssl_context: typing.Optional[ssl.SSLContext] = None,
- max_connections: typing.Optional[int] = 10,
- max_keepalive_connections: typing.Optional[int] = None,
- keepalive_expiry: typing.Optional[float] = None,
+ proxy_url: URL | bytes | str,
+ proxy_auth: tuple[bytes | str, bytes | str] | None = None,
+ ssl_context: ssl.SSLContext | None = None,
+ max_connections: int | None = 10,
+ max_keepalive_connections: int | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- network_backend: typing.Optional[AsyncNetworkBackend] = None,
+ network_backend: AsyncNetworkBackend | None = None,
) -> None:
"""
A connection pool for making HTTP requests.
@@ -167,7 +166,7 @@ class AsyncSOCKSProxy(AsyncConnectionPool):
username, password = proxy_auth
username_bytes = enforce_bytes(username, name="proxy_auth")
password_bytes = enforce_bytes(password, name="proxy_auth")
- self._proxy_auth: typing.Optional[typing.Tuple[bytes, bytes]] = (
+ self._proxy_auth: tuple[bytes, bytes] | None = (
username_bytes,
password_bytes,
)
@@ -192,12 +191,12 @@ class AsyncSocks5Connection(AsyncConnectionInterface):
self,
proxy_origin: Origin,
remote_origin: Origin,
- proxy_auth: typing.Optional[typing.Tuple[bytes, bytes]] = None,
- ssl_context: typing.Optional[ssl.SSLContext] = None,
- keepalive_expiry: typing.Optional[float] = None,
+ proxy_auth: tuple[bytes, bytes] | None = None,
+ ssl_context: ssl.SSLContext | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
- network_backend: typing.Optional[AsyncNetworkBackend] = None,
+ network_backend: AsyncNetworkBackend | None = None,
) -> None:
self._proxy_origin = proxy_origin
self._remote_origin = remote_origin
@@ -211,11 +210,12 @@ class AsyncSocks5Connection(AsyncConnectionInterface):
AutoBackend() if network_backend is None else network_backend
)
self._connect_lock = AsyncLock()
- self._connection: typing.Optional[AsyncConnectionInterface] = None
+ self._connection: AsyncConnectionInterface | None = None
self._connect_failed = False
async def handle_async_request(self, request: Request) -> Response:
timeouts = request.extensions.get("timeout", {})
+ sni_hostname = request.extensions.get("sni_hostname", None)
timeout = timeouts.get("connect", None)
async with self._connect_lock:
@@ -227,7 +227,7 @@ class AsyncSocks5Connection(AsyncConnectionInterface):
"port": self._proxy_origin.port,
"timeout": timeout,
}
- with Trace("connect_tcp", logger, request, kwargs) as trace:
+ async with Trace("connect_tcp", logger, request, kwargs) as trace:
stream = await self._network_backend.connect_tcp(**kwargs)
trace.return_value = stream
@@ -238,7 +238,7 @@ class AsyncSocks5Connection(AsyncConnectionInterface):
"port": self._remote_origin.port,
"auth": self._proxy_auth,
}
- with Trace(
+ async with Trace(
"setup_socks5_connection", logger, request, kwargs
) as trace:
await _init_socks5_connection(**kwargs)
@@ -258,7 +258,8 @@ class AsyncSocks5Connection(AsyncConnectionInterface):
kwargs = {
"ssl_context": ssl_context,
- "server_hostname": self._remote_origin.host.decode("ascii"),
+ "server_hostname": sni_hostname
+ or self._remote_origin.host.decode("ascii"),
"timeout": timeout,
}
async with Trace("start_tls", logger, request, kwargs) as trace:
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/__init__.cpython-312.pyc
index ee995e85..9a79d8f3 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/anyio.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/anyio.cpython-312.pyc
index 4049a7f8..2036c900 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/anyio.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/anyio.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/auto.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/auto.cpython-312.pyc
index bfdc76a6..0bdb1f54 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/auto.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/auto.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/base.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/base.cpython-312.pyc
index 2565cc96..5814c372 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/base.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/base.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/mock.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/mock.cpython-312.pyc
index cd0d7e03..349a5b5f 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/mock.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/mock.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/sync.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/sync.cpython-312.pyc
index e45951f4..e0bfcfd9 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/sync.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/sync.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/trio.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/trio.cpython-312.pyc
index 3f42306a..ebae9232 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/trio.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/__pycache__/trio.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/anyio.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/anyio.py
index 1ed5228d..a140095e 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/anyio.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/anyio.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
import ssl
import typing
@@ -20,13 +22,12 @@ class AnyIOStream(AsyncNetworkStream):
def __init__(self, stream: anyio.abc.ByteStream) -> None:
self._stream = stream
- async def read(
- self, max_bytes: int, timeout: typing.Optional[float] = None
- ) -> bytes:
+ async def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
exc_map = {
TimeoutError: ReadTimeout,
anyio.BrokenResourceError: ReadError,
anyio.ClosedResourceError: ReadError,
+ anyio.EndOfStream: ReadError,
}
with map_exceptions(exc_map):
with anyio.fail_after(timeout):
@@ -35,9 +36,7 @@ class AnyIOStream(AsyncNetworkStream):
except anyio.EndOfStream: # pragma: nocover
return b""
- async def write(
- self, buffer: bytes, timeout: typing.Optional[float] = None
- ) -> None:
+ async def write(self, buffer: bytes, timeout: float | None = None) -> None:
if not buffer:
return
@@ -56,12 +55,14 @@ class AnyIOStream(AsyncNetworkStream):
async def start_tls(
self,
ssl_context: ssl.SSLContext,
- server_hostname: typing.Optional[str] = None,
- timeout: typing.Optional[float] = None,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
) -> AsyncNetworkStream:
exc_map = {
TimeoutError: ConnectTimeout,
anyio.BrokenResourceError: ConnectError,
+ anyio.EndOfStream: ConnectError,
+ ssl.SSLError: ConnectError,
}
with map_exceptions(exc_map):
try:
@@ -98,12 +99,12 @@ class AnyIOBackend(AsyncNetworkBackend):
self,
host: str,
port: int,
- timeout: typing.Optional[float] = None,
- local_address: typing.Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
- ) -> AsyncNetworkStream:
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
+ ) -> AsyncNetworkStream: # pragma: nocover
if socket_options is None:
- socket_options = [] # pragma: no cover
+ socket_options = []
exc_map = {
TimeoutError: ConnectTimeout,
OSError: ConnectError,
@@ -124,8 +125,8 @@ class AnyIOBackend(AsyncNetworkBackend):
async def connect_unix_socket(
self,
path: str,
- timeout: typing.Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream: # pragma: nocover
if socket_options is None:
socket_options = []
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/auto.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/auto.py
index b612ba07..49f0e698 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/auto.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/auto.py
@@ -1,15 +1,15 @@
+from __future__ import annotations
+
import typing
-from typing import Optional
-
-import sniffio
+from .._synchronization import current_async_library
from .base import SOCKET_OPTION, AsyncNetworkBackend, AsyncNetworkStream
class AutoBackend(AsyncNetworkBackend):
async def _init_backend(self) -> None:
if not (hasattr(self, "_backend")):
- backend = sniffio.current_async_library()
+ backend = current_async_library()
if backend == "trio":
from .trio import TrioBackend
@@ -23,9 +23,9 @@ class AutoBackend(AsyncNetworkBackend):
self,
host: str,
port: int,
- timeout: Optional[float] = None,
- local_address: Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream:
await self._init_backend()
return await self._backend.connect_tcp(
@@ -39,8 +39,8 @@ class AutoBackend(AsyncNetworkBackend):
async def connect_unix_socket(
self,
path: str,
- timeout: Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream: # pragma: nocover
await self._init_backend()
return await self._backend.connect_unix_socket(
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/base.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/base.py
index 6cadedb5..cf55c8b1 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/base.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/base.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
import ssl
import time
import typing
@@ -10,10 +12,10 @@ SOCKET_OPTION = typing.Union[
class NetworkStream:
- def read(self, max_bytes: int, timeout: typing.Optional[float] = None) -> bytes:
+ def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
raise NotImplementedError() # pragma: nocover
- def write(self, buffer: bytes, timeout: typing.Optional[float] = None) -> None:
+ def write(self, buffer: bytes, timeout: float | None = None) -> None:
raise NotImplementedError() # pragma: nocover
def close(self) -> None:
@@ -22,9 +24,9 @@ class NetworkStream:
def start_tls(
self,
ssl_context: ssl.SSLContext,
- server_hostname: typing.Optional[str] = None,
- timeout: typing.Optional[float] = None,
- ) -> "NetworkStream":
+ server_hostname: str | None = None,
+ timeout: float | None = None,
+ ) -> NetworkStream:
raise NotImplementedError() # pragma: nocover
def get_extra_info(self, info: str) -> typing.Any:
@@ -36,17 +38,17 @@ class NetworkBackend:
self,
host: str,
port: int,
- timeout: typing.Optional[float] = None,
- local_address: typing.Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> NetworkStream:
raise NotImplementedError() # pragma: nocover
def connect_unix_socket(
self,
path: str,
- timeout: typing.Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> NetworkStream:
raise NotImplementedError() # pragma: nocover
@@ -55,14 +57,10 @@ class NetworkBackend:
class AsyncNetworkStream:
- async def read(
- self, max_bytes: int, timeout: typing.Optional[float] = None
- ) -> bytes:
+ async def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
raise NotImplementedError() # pragma: nocover
- async def write(
- self, buffer: bytes, timeout: typing.Optional[float] = None
- ) -> None:
+ async def write(self, buffer: bytes, timeout: float | None = None) -> None:
raise NotImplementedError() # pragma: nocover
async def aclose(self) -> None:
@@ -71,9 +69,9 @@ class AsyncNetworkStream:
async def start_tls(
self,
ssl_context: ssl.SSLContext,
- server_hostname: typing.Optional[str] = None,
- timeout: typing.Optional[float] = None,
- ) -> "AsyncNetworkStream":
+ server_hostname: str | None = None,
+ timeout: float | None = None,
+ ) -> AsyncNetworkStream:
raise NotImplementedError() # pragma: nocover
def get_extra_info(self, info: str) -> typing.Any:
@@ -85,17 +83,17 @@ class AsyncNetworkBackend:
self,
host: str,
port: int,
- timeout: typing.Optional[float] = None,
- local_address: typing.Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream:
raise NotImplementedError() # pragma: nocover
async def connect_unix_socket(
self,
path: str,
- timeout: typing.Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream:
raise NotImplementedError() # pragma: nocover
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/mock.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/mock.py
index f7aefebf..9b6edca0 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/mock.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/mock.py
@@ -1,6 +1,7 @@
+from __future__ import annotations
+
import ssl
import typing
-from typing import Optional
from .._exceptions import ReadError
from .base import (
@@ -21,19 +22,19 @@ class MockSSLObject:
class MockStream(NetworkStream):
- def __init__(self, buffer: typing.List[bytes], http2: bool = False) -> None:
+ def __init__(self, buffer: list[bytes], http2: bool = False) -> None:
self._buffer = buffer
self._http2 = http2
self._closed = False
- def read(self, max_bytes: int, timeout: Optional[float] = None) -> bytes:
+ def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
if self._closed:
raise ReadError("Connection closed")
if not self._buffer:
return b""
return self._buffer.pop(0)
- def write(self, buffer: bytes, timeout: Optional[float] = None) -> None:
+ def write(self, buffer: bytes, timeout: float | None = None) -> None:
pass
def close(self) -> None:
@@ -42,8 +43,8 @@ class MockStream(NetworkStream):
def start_tls(
self,
ssl_context: ssl.SSLContext,
- server_hostname: Optional[str] = None,
- timeout: Optional[float] = None,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
) -> NetworkStream:
return self
@@ -55,7 +56,7 @@ class MockStream(NetworkStream):
class MockBackend(NetworkBackend):
- def __init__(self, buffer: typing.List[bytes], http2: bool = False) -> None:
+ def __init__(self, buffer: list[bytes], http2: bool = False) -> None:
self._buffer = buffer
self._http2 = http2
@@ -63,17 +64,17 @@ class MockBackend(NetworkBackend):
self,
host: str,
port: int,
- timeout: Optional[float] = None,
- local_address: Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> NetworkStream:
return MockStream(list(self._buffer), http2=self._http2)
def connect_unix_socket(
self,
path: str,
- timeout: Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> NetworkStream:
return MockStream(list(self._buffer), http2=self._http2)
@@ -82,19 +83,19 @@ class MockBackend(NetworkBackend):
class AsyncMockStream(AsyncNetworkStream):
- def __init__(self, buffer: typing.List[bytes], http2: bool = False) -> None:
+ def __init__(self, buffer: list[bytes], http2: bool = False) -> None:
self._buffer = buffer
self._http2 = http2
self._closed = False
- async def read(self, max_bytes: int, timeout: Optional[float] = None) -> bytes:
+ async def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
if self._closed:
raise ReadError("Connection closed")
if not self._buffer:
return b""
return self._buffer.pop(0)
- async def write(self, buffer: bytes, timeout: Optional[float] = None) -> None:
+ async def write(self, buffer: bytes, timeout: float | None = None) -> None:
pass
async def aclose(self) -> None:
@@ -103,8 +104,8 @@ class AsyncMockStream(AsyncNetworkStream):
async def start_tls(
self,
ssl_context: ssl.SSLContext,
- server_hostname: Optional[str] = None,
- timeout: Optional[float] = None,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
) -> AsyncNetworkStream:
return self
@@ -116,7 +117,7 @@ class AsyncMockStream(AsyncNetworkStream):
class AsyncMockBackend(AsyncNetworkBackend):
- def __init__(self, buffer: typing.List[bytes], http2: bool = False) -> None:
+ def __init__(self, buffer: list[bytes], http2: bool = False) -> None:
self._buffer = buffer
self._http2 = http2
@@ -124,17 +125,17 @@ class AsyncMockBackend(AsyncNetworkBackend):
self,
host: str,
port: int,
- timeout: Optional[float] = None,
- local_address: Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream:
return AsyncMockStream(list(self._buffer), http2=self._http2)
async def connect_unix_socket(
self,
path: str,
- timeout: Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream:
return AsyncMockStream(list(self._buffer), http2=self._http2)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/sync.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/sync.py
index a4c85f04..4018a09c 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/sync.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/sync.py
@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+import functools
import socket
import ssl
import sys
@@ -17,17 +20,114 @@ from .._utils import is_socket_readable
from .base import SOCKET_OPTION, NetworkBackend, NetworkStream
+class TLSinTLSStream(NetworkStream): # pragma: no cover
+ """
+ Because the standard `SSLContext.wrap_socket` method does
+ not work for `SSLSocket` objects, we need this class
+ to implement TLS stream using an underlying `SSLObject`
+ instance in order to support TLS on top of TLS.
+ """
+
+ # Defined in RFC 8449
+ TLS_RECORD_SIZE = 16384
+
+ def __init__(
+ self,
+ sock: socket.socket,
+ ssl_context: ssl.SSLContext,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
+ ):
+ self._sock = sock
+ self._incoming = ssl.MemoryBIO()
+ self._outgoing = ssl.MemoryBIO()
+
+ self.ssl_obj = ssl_context.wrap_bio(
+ incoming=self._incoming,
+ outgoing=self._outgoing,
+ server_hostname=server_hostname,
+ )
+
+ self._sock.settimeout(timeout)
+ self._perform_io(self.ssl_obj.do_handshake)
+
+ def _perform_io(
+ self,
+ func: typing.Callable[..., typing.Any],
+ ) -> typing.Any:
+ ret = None
+
+ while True:
+ errno = None
+ try:
+ ret = func()
+ except (ssl.SSLWantReadError, ssl.SSLWantWriteError) as e:
+ errno = e.errno
+
+ self._sock.sendall(self._outgoing.read())
+
+ if errno == ssl.SSL_ERROR_WANT_READ:
+ buf = self._sock.recv(self.TLS_RECORD_SIZE)
+
+ if buf:
+ self._incoming.write(buf)
+ else:
+ self._incoming.write_eof()
+ if errno is None:
+ return ret
+
+ def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
+ exc_map: ExceptionMapping = {socket.timeout: ReadTimeout, OSError: ReadError}
+ with map_exceptions(exc_map):
+ self._sock.settimeout(timeout)
+ return typing.cast(
+ bytes, self._perform_io(functools.partial(self.ssl_obj.read, max_bytes))
+ )
+
+ def write(self, buffer: bytes, timeout: float | None = None) -> None:
+ exc_map: ExceptionMapping = {socket.timeout: WriteTimeout, OSError: WriteError}
+ with map_exceptions(exc_map):
+ self._sock.settimeout(timeout)
+ while buffer:
+ nsent = self._perform_io(functools.partial(self.ssl_obj.write, buffer))
+ buffer = buffer[nsent:]
+
+ def close(self) -> None:
+ self._sock.close()
+
+ def start_tls(
+ self,
+ ssl_context: ssl.SSLContext,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
+ ) -> NetworkStream:
+ raise NotImplementedError()
+
+ def get_extra_info(self, info: str) -> typing.Any:
+ if info == "ssl_object":
+ return self.ssl_obj
+ if info == "client_addr":
+ return self._sock.getsockname()
+ if info == "server_addr":
+ return self._sock.getpeername()
+ if info == "socket":
+ return self._sock
+ if info == "is_readable":
+ return is_socket_readable(self._sock)
+ return None
+
+
class SyncStream(NetworkStream):
def __init__(self, sock: socket.socket) -> None:
self._sock = sock
- def read(self, max_bytes: int, timeout: typing.Optional[float] = None) -> bytes:
+ def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
exc_map: ExceptionMapping = {socket.timeout: ReadTimeout, OSError: ReadError}
with map_exceptions(exc_map):
self._sock.settimeout(timeout)
return self._sock.recv(max_bytes)
- def write(self, buffer: bytes, timeout: typing.Optional[float] = None) -> None:
+ def write(self, buffer: bytes, timeout: float | None = None) -> None:
if not buffer:
return
@@ -44,8 +144,8 @@ class SyncStream(NetworkStream):
def start_tls(
self,
ssl_context: ssl.SSLContext,
- server_hostname: typing.Optional[str] = None,
- timeout: typing.Optional[float] = None,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
) -> NetworkStream:
exc_map: ExceptionMapping = {
socket.timeout: ConnectTimeout,
@@ -53,10 +153,18 @@ class SyncStream(NetworkStream):
}
with map_exceptions(exc_map):
try:
- self._sock.settimeout(timeout)
- sock = ssl_context.wrap_socket(
- self._sock, server_hostname=server_hostname
- )
+ if isinstance(self._sock, ssl.SSLSocket): # pragma: no cover
+ # If the underlying socket has already been upgraded
+ # to the TLS layer (i.e. is an instance of SSLSocket),
+ # we need some additional smarts to support TLS-in-TLS.
+ return TLSinTLSStream(
+ self._sock, ssl_context, server_hostname, timeout
+ )
+ else:
+ self._sock.settimeout(timeout)
+ sock = ssl_context.wrap_socket(
+ self._sock, server_hostname=server_hostname
+ )
except Exception as exc: # pragma: nocover
self.close()
raise exc
@@ -81,9 +189,9 @@ class SyncBackend(NetworkBackend):
self,
host: str,
port: int,
- timeout: typing.Optional[float] = None,
- local_address: typing.Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> NetworkStream:
# Note that we automatically include `TCP_NODELAY`
# in addition to any other custom socket options.
@@ -110,8 +218,8 @@ class SyncBackend(NetworkBackend):
def connect_unix_socket(
self,
path: str,
- timeout: typing.Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> NetworkStream: # pragma: nocover
if sys.platform == "win32":
raise RuntimeError(
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/trio.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/trio.py
index b1626d28..6f53f5f2 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/trio.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_backends/trio.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
import ssl
import typing
@@ -20,9 +22,7 @@ class TrioStream(AsyncNetworkStream):
def __init__(self, stream: trio.abc.Stream) -> None:
self._stream = stream
- async def read(
- self, max_bytes: int, timeout: typing.Optional[float] = None
- ) -> bytes:
+ async def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
timeout_or_inf = float("inf") if timeout is None else timeout
exc_map: ExceptionMapping = {
trio.TooSlowError: ReadTimeout,
@@ -34,9 +34,7 @@ class TrioStream(AsyncNetworkStream):
data: bytes = await self._stream.receive_some(max_bytes=max_bytes)
return data
- async def write(
- self, buffer: bytes, timeout: typing.Optional[float] = None
- ) -> None:
+ async def write(self, buffer: bytes, timeout: float | None = None) -> None:
if not buffer:
return
@@ -56,8 +54,8 @@ class TrioStream(AsyncNetworkStream):
async def start_tls(
self,
ssl_context: ssl.SSLContext,
- server_hostname: typing.Optional[str] = None,
- timeout: typing.Optional[float] = None,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
) -> AsyncNetworkStream:
timeout_or_inf = float("inf") if timeout is None else timeout
exc_map: ExceptionMapping = {
@@ -113,9 +111,9 @@ class TrioBackend(AsyncNetworkBackend):
self,
host: str,
port: int,
- timeout: typing.Optional[float] = None,
- local_address: typing.Optional[str] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ local_address: str | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream:
# By default for TCP sockets, trio enables TCP_NODELAY.
# https://trio.readthedocs.io/en/stable/reference-io.html#trio.SocketStream
@@ -139,8 +137,8 @@ class TrioBackend(AsyncNetworkBackend):
async def connect_unix_socket(
self,
path: str,
- timeout: typing.Optional[float] = None,
- socket_options: typing.Optional[typing.Iterable[SOCKET_OPTION]] = None,
+ timeout: float | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> AsyncNetworkStream: # pragma: nocover
if socket_options is None:
socket_options = []
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_exceptions.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_exceptions.py
index 81e7fc61..bc28d44f 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_exceptions.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_exceptions.py
@@ -1,11 +1,11 @@
import contextlib
-from typing import Iterator, Mapping, Type
+import typing
-ExceptionMapping = Mapping[Type[Exception], Type[Exception]]
+ExceptionMapping = typing.Mapping[typing.Type[Exception], typing.Type[Exception]]
@contextlib.contextmanager
-def map_exceptions(map: ExceptionMapping) -> Iterator[None]:
+def map_exceptions(map: ExceptionMapping) -> typing.Iterator[None]:
try:
yield
except Exception as exc: # noqa: PIE786
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_models.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_models.py
index e15305ee..8a65f133 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_models.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_models.py
@@ -1,29 +1,22 @@
-from typing import (
- Any,
- AsyncIterable,
- AsyncIterator,
- Iterable,
- Iterator,
- List,
- Mapping,
- Optional,
- Sequence,
- Tuple,
- Union,
-)
-from urllib.parse import urlparse
+from __future__ import annotations
+
+import base64
+import ssl
+import typing
+import urllib.parse
# Functions for typechecking...
-HeadersAsSequence = Sequence[Tuple[Union[bytes, str], Union[bytes, str]]]
-HeadersAsMapping = Mapping[Union[bytes, str], Union[bytes, str]]
-HeaderTypes = Union[HeadersAsSequence, HeadersAsMapping, None]
+ByteOrStr = typing.Union[bytes, str]
+HeadersAsSequence = typing.Sequence[typing.Tuple[ByteOrStr, ByteOrStr]]
+HeadersAsMapping = typing.Mapping[ByteOrStr, ByteOrStr]
+HeaderTypes = typing.Union[HeadersAsSequence, HeadersAsMapping, None]
-Extensions = Mapping[str, Any]
+Extensions = typing.MutableMapping[str, typing.Any]
-def enforce_bytes(value: Union[bytes, str], *, name: str) -> bytes:
+def enforce_bytes(value: bytes | str, *, name: str) -> bytes:
"""
Any arguments that are ultimately represented as bytes can be specified
either as bytes or as strings.
@@ -44,7 +37,7 @@ def enforce_bytes(value: Union[bytes, str], *, name: str) -> bytes:
raise TypeError(f"{name} must be bytes or str, but got {seen_type}.")
-def enforce_url(value: Union["URL", bytes, str], *, name: str) -> "URL":
+def enforce_url(value: URL | bytes | str, *, name: str) -> URL:
"""
Type check for URL parameters.
"""
@@ -58,15 +51,15 @@ def enforce_url(value: Union["URL", bytes, str], *, name: str) -> "URL":
def enforce_headers(
- value: Union[HeadersAsMapping, HeadersAsSequence, None] = None, *, name: str
-) -> List[Tuple[bytes, bytes]]:
+ value: HeadersAsMapping | HeadersAsSequence | None = None, *, name: str
+) -> list[tuple[bytes, bytes]]:
"""
Convienence function that ensure all items in request or response headers
are either bytes or strings in the plain ASCII range.
"""
if value is None:
return []
- elif isinstance(value, Mapping):
+ elif isinstance(value, typing.Mapping):
return [
(
enforce_bytes(k, name="header name"),
@@ -74,7 +67,7 @@ def enforce_headers(
)
for k, v in value.items()
]
- elif isinstance(value, Sequence):
+ elif isinstance(value, typing.Sequence):
return [
(
enforce_bytes(k, name="header name"),
@@ -90,8 +83,10 @@ def enforce_headers(
def enforce_stream(
- value: Union[bytes, Iterable[bytes], AsyncIterable[bytes], None], *, name: str
-) -> Union[Iterable[bytes], AsyncIterable[bytes]]:
+ value: bytes | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None,
+ *,
+ name: str,
+) -> typing.Iterable[bytes] | typing.AsyncIterable[bytes]:
if value is None:
return ByteStream(b"")
elif isinstance(value, bytes):
@@ -112,11 +107,11 @@ DEFAULT_PORTS = {
def include_request_headers(
- headers: List[Tuple[bytes, bytes]],
+ headers: list[tuple[bytes, bytes]],
*,
url: "URL",
- content: Union[None, bytes, Iterable[bytes], AsyncIterable[bytes]],
-) -> List[Tuple[bytes, bytes]]:
+ content: None | bytes | typing.Iterable[bytes] | typing.AsyncIterable[bytes],
+) -> list[tuple[bytes, bytes]]:
headers_set = set(k.lower() for k, v in headers)
if b"host" not in headers_set:
@@ -153,10 +148,10 @@ class ByteStream:
def __init__(self, content: bytes) -> None:
self._content = content
- def __iter__(self) -> Iterator[bytes]:
+ def __iter__(self) -> typing.Iterator[bytes]:
yield self._content
- async def __aiter__(self) -> AsyncIterator[bytes]:
+ async def __aiter__(self) -> typing.AsyncIterator[bytes]:
yield self._content
def __repr__(self) -> str:
@@ -169,7 +164,7 @@ class Origin:
self.host = host
self.port = port
- def __eq__(self, other: Any) -> bool:
+ def __eq__(self, other: typing.Any) -> bool:
return (
isinstance(other, Origin)
and self.scheme == other.scheme
@@ -253,12 +248,12 @@ class URL:
def __init__(
self,
- url: Union[bytes, str] = "",
+ url: bytes | str = "",
*,
- scheme: Union[bytes, str] = b"",
- host: Union[bytes, str] = b"",
- port: Optional[int] = None,
- target: Union[bytes, str] = b"",
+ scheme: bytes | str = b"",
+ host: bytes | str = b"",
+ port: int | None = None,
+ target: bytes | str = b"",
) -> None:
"""
Parameters:
@@ -270,7 +265,7 @@ class URL:
target: The target of the HTTP request. Such as `"/items?search=red"`.
"""
if url:
- parsed = urlparse(enforce_bytes(url, name="url"))
+ parsed = urllib.parse.urlparse(enforce_bytes(url, name="url"))
self.scheme = parsed.scheme
self.host = parsed.hostname or b""
self.port = parsed.port
@@ -291,12 +286,13 @@ class URL:
b"ws": 80,
b"wss": 443,
b"socks5": 1080,
+ b"socks5h": 1080,
}[self.scheme]
return Origin(
scheme=self.scheme, host=self.host, port=self.port or default_port
)
- def __eq__(self, other: Any) -> bool:
+ def __eq__(self, other: typing.Any) -> bool:
return (
isinstance(other, URL)
and other.scheme == self.scheme
@@ -324,12 +320,15 @@ class Request:
def __init__(
self,
- method: Union[bytes, str],
- url: Union[URL, bytes, str],
+ method: bytes | str,
+ url: URL | bytes | str,
*,
headers: HeaderTypes = None,
- content: Union[bytes, Iterable[bytes], AsyncIterable[bytes], None] = None,
- extensions: Optional[Extensions] = None,
+ content: bytes
+ | typing.Iterable[bytes]
+ | typing.AsyncIterable[bytes]
+ | None = None,
+ extensions: Extensions | None = None,
) -> None:
"""
Parameters:
@@ -338,20 +337,28 @@ class Request:
url: The request URL, either as a `URL` instance, or as a string or bytes.
For example: `"https://www.example.com".`
headers: The HTTP request headers.
- content: The content of the response body.
+ content: The content of the request body.
extensions: A dictionary of optional extra information included on
the request. Possible keys include `"timeout"`, and `"trace"`.
"""
self.method: bytes = enforce_bytes(method, name="method")
self.url: URL = enforce_url(url, name="url")
- self.headers: List[Tuple[bytes, bytes]] = enforce_headers(
+ self.headers: list[tuple[bytes, bytes]] = enforce_headers(
headers, name="headers"
)
- self.stream: Union[Iterable[bytes], AsyncIterable[bytes]] = enforce_stream(
- content, name="content"
+ self.stream: typing.Iterable[bytes] | typing.AsyncIterable[bytes] = (
+ enforce_stream(content, name="content")
)
self.extensions = {} if extensions is None else extensions
+ if "target" in self.extensions:
+ self.url = URL(
+ scheme=self.url.scheme,
+ host=self.url.host,
+ port=self.url.port,
+ target=self.extensions["target"],
+ )
+
def __repr__(self) -> str:
return f"<{self.__class__.__name__} [{self.method!r}]>"
@@ -366,8 +373,11 @@ class Response:
status: int,
*,
headers: HeaderTypes = None,
- content: Union[bytes, Iterable[bytes], AsyncIterable[bytes], None] = None,
- extensions: Optional[Extensions] = None,
+ content: bytes
+ | typing.Iterable[bytes]
+ | typing.AsyncIterable[bytes]
+ | None = None,
+ extensions: Extensions | None = None,
) -> None:
"""
Parameters:
@@ -379,11 +389,11 @@ class Response:
`"reason_phrase"`, and `"network_stream"`.
"""
self.status: int = status
- self.headers: List[Tuple[bytes, bytes]] = enforce_headers(
+ self.headers: list[tuple[bytes, bytes]] = enforce_headers(
headers, name="headers"
)
- self.stream: Union[Iterable[bytes], AsyncIterable[bytes]] = enforce_stream(
- content, name="content"
+ self.stream: typing.Iterable[bytes] | typing.AsyncIterable[bytes] = (
+ enforce_stream(content, name="content")
)
self.extensions = {} if extensions is None else extensions
@@ -392,7 +402,7 @@ class Response:
@property
def content(self) -> bytes:
if not hasattr(self, "_content"):
- if isinstance(self.stream, Iterable):
+ if isinstance(self.stream, typing.Iterable):
raise RuntimeError(
"Attempted to access 'response.content' on a streaming response. "
"Call 'response.read()' first."
@@ -410,7 +420,7 @@ class Response:
# Sync interface...
def read(self) -> bytes:
- if not isinstance(self.stream, Iterable): # pragma: nocover
+ if not isinstance(self.stream, typing.Iterable): # pragma: nocover
raise RuntimeError(
"Attempted to read an asynchronous response using 'response.read()'. "
"You should use 'await response.aread()' instead."
@@ -419,8 +429,8 @@ class Response:
self._content = b"".join([part for part in self.iter_stream()])
return self._content
- def iter_stream(self) -> Iterator[bytes]:
- if not isinstance(self.stream, Iterable): # pragma: nocover
+ def iter_stream(self) -> typing.Iterator[bytes]:
+ if not isinstance(self.stream, typing.Iterable): # pragma: nocover
raise RuntimeError(
"Attempted to stream an asynchronous response using 'for ... in "
"response.iter_stream()'. "
@@ -435,7 +445,7 @@ class Response:
yield chunk
def close(self) -> None:
- if not isinstance(self.stream, Iterable): # pragma: nocover
+ if not isinstance(self.stream, typing.Iterable): # pragma: nocover
raise RuntimeError(
"Attempted to close an asynchronous response using 'response.close()'. "
"You should use 'await response.aclose()' instead."
@@ -446,7 +456,7 @@ class Response:
# Async interface...
async def aread(self) -> bytes:
- if not isinstance(self.stream, AsyncIterable): # pragma: nocover
+ if not isinstance(self.stream, typing.AsyncIterable): # pragma: nocover
raise RuntimeError(
"Attempted to read an synchronous response using "
"'await response.aread()'. "
@@ -456,8 +466,8 @@ class Response:
self._content = b"".join([part async for part in self.aiter_stream()])
return self._content
- async def aiter_stream(self) -> AsyncIterator[bytes]:
- if not isinstance(self.stream, AsyncIterable): # pragma: nocover
+ async def aiter_stream(self) -> typing.AsyncIterator[bytes]:
+ if not isinstance(self.stream, typing.AsyncIterable): # pragma: nocover
raise RuntimeError(
"Attempted to stream an synchronous response using 'async for ... in "
"response.aiter_stream()'. "
@@ -473,7 +483,7 @@ class Response:
yield chunk
async def aclose(self) -> None:
- if not isinstance(self.stream, AsyncIterable): # pragma: nocover
+ if not isinstance(self.stream, typing.AsyncIterable): # pragma: nocover
raise RuntimeError(
"Attempted to close a synchronous response using "
"'await response.aclose()'. "
@@ -481,3 +491,26 @@ class Response:
)
if hasattr(self.stream, "aclose"):
await self.stream.aclose()
+
+
+class Proxy:
+ def __init__(
+ self,
+ url: URL | bytes | str,
+ auth: tuple[bytes | str, bytes | str] | None = None,
+ headers: HeadersAsMapping | HeadersAsSequence | None = None,
+ ssl_context: ssl.SSLContext | None = None,
+ ):
+ self.url = enforce_url(url, name="url")
+ self.headers = enforce_headers(headers, name="headers")
+ self.ssl_context = ssl_context
+
+ if auth is not None:
+ username = enforce_bytes(auth[0], name="auth")
+ password = enforce_bytes(auth[1], name="auth")
+ userpass = username + b":" + password
+ authorization = b"Basic " + base64.b64encode(userpass)
+ self.auth: tuple[bytes, bytes] | None = (username, password)
+ self.headers = [(b"Proxy-Authorization", authorization)] + self.headers
+ else:
+ self.auth = None
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/__init__.cpython-312.pyc
index fffafcf0..8e485bf7 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/__init__.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection.cpython-312.pyc
index 329122ab..e7d78f9d 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection_pool.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection_pool.cpython-312.pyc
index 0e8a0d66..1cd40565 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection_pool.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/connection_pool.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http11.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http11.cpython-312.pyc
index 9acdf160..1b0b9f18 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http11.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http11.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http2.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http2.cpython-312.pyc
index 6d4f6b2c..140fc04b 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http2.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http2.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http_proxy.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http_proxy.cpython-312.pyc
index aa311cd9..0df1822f 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http_proxy.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/http_proxy.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/interfaces.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/interfaces.cpython-312.pyc
index 77621796..03e5be82 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/interfaces.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/interfaces.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/socks_proxy.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/socks_proxy.cpython-312.pyc
index 2099f52e..b3d7bdb4 100644
Binary files a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/socks_proxy.cpython-312.pyc and b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/__pycache__/socks_proxy.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection.py
index 39b8b97e..363f8be8 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection.py
@@ -1,12 +1,14 @@
+from __future__ import annotations
+
import itertools
import logging
import ssl
-from types import TracebackType
-from typing import Iterable, Iterator, Optional, Type
+import types
+import typing
from .._backends.sync import SyncBackend
from .._backends.base import SOCKET_OPTION, NetworkBackend, NetworkStream
-from .._exceptions import ConnectError, ConnectionNotAvailable, ConnectTimeout
+from .._exceptions import ConnectError, ConnectTimeout
from .._models import Origin, Request, Response
from .._ssl import default_ssl_context
from .._synchronization import Lock
@@ -20,25 +22,32 @@ RETRIES_BACKOFF_FACTOR = 0.5 # 0s, 0.5s, 1s, 2s, 4s, etc.
logger = logging.getLogger("httpcore.connection")
-def exponential_backoff(factor: float) -> Iterator[float]:
+def exponential_backoff(factor: float) -> typing.Iterator[float]:
+ """
+ Generate a geometric sequence that has a ratio of 2 and starts with 0.
+
+ For example:
+ - `factor = 2`: `0, 2, 4, 8, 16, 32, 64, ...`
+ - `factor = 3`: `0, 3, 6, 12, 24, 48, 96, ...`
+ """
yield 0
- for n in itertools.count(2):
- yield factor * (2 ** (n - 2))
+ for n in itertools.count():
+ yield factor * 2**n
class HTTPConnection(ConnectionInterface):
def __init__(
self,
origin: Origin,
- ssl_context: Optional[ssl.SSLContext] = None,
- keepalive_expiry: Optional[float] = None,
+ ssl_context: ssl.SSLContext | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- local_address: Optional[str] = None,
- uds: Optional[str] = None,
- network_backend: Optional[NetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ local_address: str | None = None,
+ uds: str | None = None,
+ network_backend: NetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
self._origin = origin
self._ssl_context = ssl_context
@@ -52,7 +61,7 @@ class HTTPConnection(ConnectionInterface):
self._network_backend: NetworkBackend = (
SyncBackend() if network_backend is None else network_backend
)
- self._connection: Optional[ConnectionInterface] = None
+ self._connection: ConnectionInterface | None = None
self._connect_failed: bool = False
self._request_lock = Lock()
self._socket_options = socket_options
@@ -63,9 +72,9 @@ class HTTPConnection(ConnectionInterface):
f"Attempted to send request to {request.url.origin} on connection to {self._origin}"
)
- with self._request_lock:
- if self._connection is None:
- try:
+ try:
+ with self._request_lock:
+ if self._connection is None:
stream = self._connect(request)
ssl_object = stream.get_extra_info("ssl_object")
@@ -87,11 +96,9 @@ class HTTPConnection(ConnectionInterface):
stream=stream,
keepalive_expiry=self._keepalive_expiry,
)
- except Exception as exc:
- self._connect_failed = True
- raise exc
- elif not self._connection.is_available():
- raise ConnectionNotAvailable()
+ except BaseException as exc:
+ self._connect_failed = True
+ raise exc
return self._connection.handle_request(request)
@@ -130,7 +137,7 @@ class HTTPConnection(ConnectionInterface):
)
trace.return_value = stream
- if self._origin.scheme == b"https":
+ if self._origin.scheme in (b"https", b"wss"):
ssl_context = (
default_ssl_context()
if self._ssl_context is None
@@ -203,13 +210,13 @@ class HTTPConnection(ConnectionInterface):
# These context managers are not used in the standard flow, but are
# useful for testing or working with connection instances directly.
- def __enter__(self) -> "HTTPConnection":
+ def __enter__(self) -> HTTPConnection:
return self
def __exit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
self.close()
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection_pool.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection_pool.py
index dbcaff1f..9ccfa53e 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection_pool.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/connection_pool.py
@@ -1,41 +1,44 @@
+from __future__ import annotations
+
import ssl
import sys
-from types import TracebackType
-from typing import Iterable, Iterator, Iterable, List, Optional, Type
+import types
+import typing
from .._backends.sync import SyncBackend
from .._backends.base import SOCKET_OPTION, NetworkBackend
from .._exceptions import ConnectionNotAvailable, UnsupportedProtocol
-from .._models import Origin, Request, Response
-from .._synchronization import Event, Lock, ShieldCancellation
+from .._models import Origin, Proxy, Request, Response
+from .._synchronization import Event, ShieldCancellation, ThreadLock
from .connection import HTTPConnection
from .interfaces import ConnectionInterface, RequestInterface
-class RequestStatus:
- def __init__(self, request: Request):
+class PoolRequest:
+ def __init__(self, request: Request) -> None:
self.request = request
- self.connection: Optional[ConnectionInterface] = None
+ self.connection: ConnectionInterface | None = None
self._connection_acquired = Event()
- def set_connection(self, connection: ConnectionInterface) -> None:
- assert self.connection is None
+ def assign_to_connection(self, connection: ConnectionInterface | None) -> None:
self.connection = connection
self._connection_acquired.set()
- def unset_connection(self) -> None:
- assert self.connection is not None
+ def clear_connection(self) -> None:
self.connection = None
self._connection_acquired = Event()
def wait_for_connection(
- self, timeout: Optional[float] = None
+ self, timeout: float | None = None
) -> ConnectionInterface:
if self.connection is None:
self._connection_acquired.wait(timeout=timeout)
assert self.connection is not None
return self.connection
+ def is_queued(self) -> bool:
+ return self.connection is None
+
class ConnectionPool(RequestInterface):
"""
@@ -44,17 +47,18 @@ class ConnectionPool(RequestInterface):
def __init__(
self,
- ssl_context: Optional[ssl.SSLContext] = None,
- max_connections: Optional[int] = 10,
- max_keepalive_connections: Optional[int] = None,
- keepalive_expiry: Optional[float] = None,
+ ssl_context: ssl.SSLContext | None = None,
+ proxy: Proxy | None = None,
+ max_connections: int | None = 10,
+ max_keepalive_connections: int | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- local_address: Optional[str] = None,
- uds: Optional[str] = None,
- network_backend: Optional[NetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ local_address: str | None = None,
+ uds: str | None = None,
+ network_backend: NetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
"""
A connection pool for making HTTP requests.
@@ -86,7 +90,7 @@ class ConnectionPool(RequestInterface):
in the TCP socket when the connection was established.
"""
self._ssl_context = ssl_context
-
+ self._proxy = proxy
self._max_connections = (
sys.maxsize if max_connections is None else max_connections
)
@@ -106,15 +110,61 @@ class ConnectionPool(RequestInterface):
self._local_address = local_address
self._uds = uds
- self._pool: List[ConnectionInterface] = []
- self._requests: List[RequestStatus] = []
- self._pool_lock = Lock()
self._network_backend = (
SyncBackend() if network_backend is None else network_backend
)
self._socket_options = socket_options
+ # The mutable state on a connection pool is the queue of incoming requests,
+ # and the set of connections that are servicing those requests.
+ self._connections: list[ConnectionInterface] = []
+ self._requests: list[PoolRequest] = []
+
+ # We only mutate the state of the connection pool within an 'optional_thread_lock'
+ # context. This holds a threading lock unless we're running in async mode,
+ # in which case it is a no-op.
+ self._optional_thread_lock = ThreadLock()
+
def create_connection(self, origin: Origin) -> ConnectionInterface:
+ if self._proxy is not None:
+ if self._proxy.url.scheme in (b"socks5", b"socks5h"):
+ from .socks_proxy import Socks5Connection
+
+ return Socks5Connection(
+ proxy_origin=self._proxy.url.origin,
+ proxy_auth=self._proxy.auth,
+ remote_origin=origin,
+ ssl_context=self._ssl_context,
+ keepalive_expiry=self._keepalive_expiry,
+ http1=self._http1,
+ http2=self._http2,
+ network_backend=self._network_backend,
+ )
+ elif origin.scheme == b"http":
+ from .http_proxy import ForwardHTTPConnection
+
+ return ForwardHTTPConnection(
+ proxy_origin=self._proxy.url.origin,
+ proxy_headers=self._proxy.headers,
+ proxy_ssl_context=self._proxy.ssl_context,
+ remote_origin=origin,
+ keepalive_expiry=self._keepalive_expiry,
+ network_backend=self._network_backend,
+ )
+ from .http_proxy import TunnelHTTPConnection
+
+ return TunnelHTTPConnection(
+ proxy_origin=self._proxy.url.origin,
+ proxy_headers=self._proxy.headers,
+ proxy_ssl_context=self._proxy.ssl_context,
+ remote_origin=origin,
+ ssl_context=self._ssl_context,
+ keepalive_expiry=self._keepalive_expiry,
+ http1=self._http1,
+ http2=self._http2,
+ network_backend=self._network_backend,
+ )
+
return HTTPConnection(
origin=origin,
ssl_context=self._ssl_context,
@@ -129,7 +179,7 @@ class ConnectionPool(RequestInterface):
)
@property
- def connections(self) -> List[ConnectionInterface]:
+ def connections(self) -> list[ConnectionInterface]:
"""
Return a list of the connections currently in the pool.
@@ -144,64 +194,7 @@ class ConnectionPool(RequestInterface):
]
```
"""
- return list(self._pool)
-
- def _attempt_to_acquire_connection(self, status: RequestStatus) -> bool:
- """
- Attempt to provide a connection that can handle the given origin.
- """
- origin = status.request.url.origin
-
- # If there are queued requests in front of us, then don't acquire a
- # connection. We handle requests strictly in order.
- waiting = [s for s in self._requests if s.connection is None]
- if waiting and waiting[0] is not status:
- return False
-
- # Reuse an existing connection if one is currently available.
- for idx, connection in enumerate(self._pool):
- if connection.can_handle_request(origin) and connection.is_available():
- self._pool.pop(idx)
- self._pool.insert(0, connection)
- status.set_connection(connection)
- return True
-
- # If the pool is currently full, attempt to close one idle connection.
- if len(self._pool) >= self._max_connections:
- for idx, connection in reversed(list(enumerate(self._pool))):
- if connection.is_idle():
- connection.close()
- self._pool.pop(idx)
- break
-
- # If the pool is still full, then we cannot acquire a connection.
- if len(self._pool) >= self._max_connections:
- return False
-
- # Otherwise create a new connection.
- connection = self.create_connection(origin)
- self._pool.insert(0, connection)
- status.set_connection(connection)
- return True
-
- def _close_expired_connections(self) -> None:
- """
- Clean up the connection pool by closing off any connections that have expired.
- """
- # Close any connections that have expired their keep-alive time.
- for idx, connection in reversed(list(enumerate(self._pool))):
- if connection.has_expired():
- connection.close()
- self._pool.pop(idx)
-
- # If the pool size exceeds the maximum number of allowed keep-alive connections,
- # then close off idle connections as required.
- pool_size = len(self._pool)
- for idx, connection in reversed(list(enumerate(self._pool))):
- if connection.is_idle() and pool_size > self._max_keepalive_connections:
- connection.close()
- self._pool.pop(idx)
- pool_size -= 1
+ return list(self._connections)
def handle_request(self, request: Request) -> Response:
"""
@@ -219,138 +212,209 @@ class ConnectionPool(RequestInterface):
f"Request URL has an unsupported protocol '{scheme}://'."
)
- status = RequestStatus(request)
+ timeouts = request.extensions.get("timeout", {})
+ timeout = timeouts.get("pool", None)
- with self._pool_lock:
- self._requests.append(status)
- self._close_expired_connections()
- self._attempt_to_acquire_connection(status)
+ with self._optional_thread_lock:
+ # Add the incoming request to our request queue.
+ pool_request = PoolRequest(request)
+ self._requests.append(pool_request)
- while True:
- timeouts = request.extensions.get("timeout", {})
- timeout = timeouts.get("pool", None)
- try:
- connection = status.wait_for_connection(timeout=timeout)
- except BaseException as exc:
- # If we timeout here, or if the task is cancelled, then make
- # sure to remove the request from the queue before bubbling
- # up the exception.
- with self._pool_lock:
- # Ensure only remove when task exists.
- if status in self._requests:
- self._requests.remove(status)
- raise exc
+ try:
+ while True:
+ with self._optional_thread_lock:
+ # Assign incoming requests to available connections,
+ # closing or creating new connections as required.
+ closing = self._assign_requests_to_connections()
+ self._close_connections(closing)
- try:
- response = connection.handle_request(request)
- except ConnectionNotAvailable:
- # The ConnectionNotAvailable exception is a special case, that
- # indicates we need to retry the request on a new connection.
- #
- # The most common case where this can occur is when multiple
- # requests are queued waiting for a single connection, which
- # might end up as an HTTP/2 connection, but which actually ends
- # up as HTTP/1.1.
- with self._pool_lock:
- # Maintain our position in the request queue, but reset the
- # status so that the request becomes queued again.
- status.unset_connection()
- self._attempt_to_acquire_connection(status)
- except BaseException as exc:
- with ShieldCancellation():
- self.response_closed(status)
- raise exc
- else:
- break
+ # Wait until this request has an assigned connection.
+ connection = pool_request.wait_for_connection(timeout=timeout)
- # When we return the response, we wrap the stream in a special class
- # that handles notifying the connection pool once the response
- # has been released.
- assert isinstance(response.stream, Iterable)
+ try:
+ # Send the request on the assigned connection.
+ response = connection.handle_request(
+ pool_request.request
+ )
+ except ConnectionNotAvailable:
+ # In some cases a connection may initially be available to
+ # handle a request, but then become unavailable.
+ #
+ # In this case we clear the connection and try again.
+ pool_request.clear_connection()
+ else:
+ break # pragma: nocover
+
+ except BaseException as exc:
+ with self._optional_thread_lock:
+ # For any exception or cancellation we remove the request from
+ # the queue, and then re-assign requests to connections.
+ self._requests.remove(pool_request)
+ closing = self._assign_requests_to_connections()
+
+ self._close_connections(closing)
+ raise exc from None
+
+ # Return the response. Note that in this case we still have to manage
+ # the point at which the response is closed.
+ assert isinstance(response.stream, typing.Iterable)
return Response(
status=response.status,
headers=response.headers,
- content=ConnectionPoolByteStream(response.stream, self, status),
+ content=PoolByteStream(
+ stream=response.stream, pool_request=pool_request, pool=self
+ ),
extensions=response.extensions,
)
- def response_closed(self, status: RequestStatus) -> None:
+ def _assign_requests_to_connections(self) -> list[ConnectionInterface]:
"""
- This method acts as a callback once the request/response cycle is complete.
+ Manage the state of the connection pool, assigning incoming
+ requests to connections as available.
- It is called into from the `ConnectionPoolByteStream.close()` method.
+ Called whenever a new request is added or removed from the pool.
+
+ Any closing connections are returned, allowing the I/O for closing
+ those connections to be handled seperately.
"""
- assert status.connection is not None
- connection = status.connection
+ closing_connections = []
- with self._pool_lock:
- # Update the state of the connection pool.
- if status in self._requests:
- self._requests.remove(status)
+ # First we handle cleaning up any connections that are closed,
+ # have expired their keep-alive, or surplus idle connections.
+ for connection in list(self._connections):
+ if connection.is_closed():
+ # log: "removing closed connection"
+ self._connections.remove(connection)
+ elif connection.has_expired():
+ # log: "closing expired connection"
+ self._connections.remove(connection)
+ closing_connections.append(connection)
+ elif (
+ connection.is_idle()
+ and len([connection.is_idle() for connection in self._connections])
+ > self._max_keepalive_connections
+ ):
+ # log: "closing idle connection"
+ self._connections.remove(connection)
+ closing_connections.append(connection)
- if connection.is_closed() and connection in self._pool:
- self._pool.remove(connection)
+ # Assign queued requests to connections.
+ queued_requests = [request for request in self._requests if request.is_queued()]
+ for pool_request in queued_requests:
+ origin = pool_request.request.url.origin
+ available_connections = [
+ connection
+ for connection in self._connections
+ if connection.can_handle_request(origin) and connection.is_available()
+ ]
+ idle_connections = [
+ connection for connection in self._connections if connection.is_idle()
+ ]
- # Since we've had a response closed, it's possible we'll now be able
- # to service one or more requests that are currently pending.
- for status in self._requests:
- if status.connection is None:
- acquired = self._attempt_to_acquire_connection(status)
- # If we could not acquire a connection for a queued request
- # then we don't need to check anymore requests that are
- # queued later behind it.
- if not acquired:
- break
+ # There are three cases for how we may be able to handle the request:
+ #
+ # 1. There is an existing connection that can handle the request.
+ # 2. We can create a new connection to handle the request.
+ # 3. We can close an idle connection and then create a new connection
+ # to handle the request.
+ if available_connections:
+ # log: "reusing existing connection"
+ connection = available_connections[0]
+ pool_request.assign_to_connection(connection)
+ elif len(self._connections) < self._max_connections:
+ # log: "creating new connection"
+ connection = self.create_connection(origin)
+ self._connections.append(connection)
+ pool_request.assign_to_connection(connection)
+ elif idle_connections:
+ # log: "closing idle connection"
+ connection = idle_connections[0]
+ self._connections.remove(connection)
+ closing_connections.append(connection)
+ # log: "creating new connection"
+ connection = self.create_connection(origin)
+ self._connections.append(connection)
+ pool_request.assign_to_connection(connection)
- # Housekeeping.
- self._close_expired_connections()
+ return closing_connections
+
+ def _close_connections(self, closing: list[ConnectionInterface]) -> None:
+ # Close connections which have been removed from the pool.
+ with ShieldCancellation():
+ for connection in closing:
+ connection.close()
def close(self) -> None:
- """
- Close any connections in the pool.
- """
- with self._pool_lock:
- for connection in self._pool:
- connection.close()
- self._pool = []
- self._requests = []
+ # Explicitly close the connection pool.
+ # Clears all existing requests and connections.
+ with self._optional_thread_lock:
+ closing_connections = list(self._connections)
+ self._connections = []
+ self._close_connections(closing_connections)
- def __enter__(self) -> "ConnectionPool":
+ def __enter__(self) -> ConnectionPool:
return self
def __exit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
self.close()
+ def __repr__(self) -> str:
+ class_name = self.__class__.__name__
+ with self._optional_thread_lock:
+ request_is_queued = [request.is_queued() for request in self._requests]
+ connection_is_idle = [
+ connection.is_idle() for connection in self._connections
+ ]
-class ConnectionPoolByteStream:
- """
- A wrapper around the response byte stream, that additionally handles
- notifying the connection pool when the response has been closed.
- """
+ num_active_requests = request_is_queued.count(False)
+ num_queued_requests = request_is_queued.count(True)
+ num_active_connections = connection_is_idle.count(False)
+ num_idle_connections = connection_is_idle.count(True)
+ requests_info = (
+ f"Requests: {num_active_requests} active, {num_queued_requests} queued"
+ )
+ connection_info = (
+ f"Connections: {num_active_connections} active, {num_idle_connections} idle"
+ )
+
+ return f"<{class_name} [{requests_info} | {connection_info}]>"
+
+
+class PoolByteStream:
def __init__(
self,
- stream: Iterable[bytes],
+ stream: typing.Iterable[bytes],
+ pool_request: PoolRequest,
pool: ConnectionPool,
- status: RequestStatus,
) -> None:
self._stream = stream
+ self._pool_request = pool_request
self._pool = pool
- self._status = status
+ self._closed = False
- def __iter__(self) -> Iterator[bytes]:
- for part in self._stream:
- yield part
+ def __iter__(self) -> typing.Iterator[bytes]:
+ try:
+ for part in self._stream:
+ yield part
+ except BaseException as exc:
+ self.close()
+ raise exc from None
def close(self) -> None:
- try:
- if hasattr(self._stream, "close"):
- self._stream.close()
- finally:
+ if not self._closed:
+ self._closed = True
with ShieldCancellation():
- self._pool.response_closed(self._status)
+ if hasattr(self._stream, "close"):
+ self._stream.close()
+
+ with self._pool._optional_thread_lock:
+ self._pool._requests.remove(self._pool_request)
+ closing = self._pool._assign_requests_to_connections()
+
+ self._pool._close_connections(closing)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http11.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http11.py
index edcce72a..ebd3a974 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http11.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http11.py
@@ -1,17 +1,11 @@
+from __future__ import annotations
+
import enum
import logging
+import ssl
import time
-from types import TracebackType
-from typing import (
- Iterable,
- Iterator,
- List,
- Optional,
- Tuple,
- Type,
- Union,
- cast,
-)
+import types
+import typing
import h11
@@ -20,6 +14,7 @@ from .._exceptions import (
ConnectionNotAvailable,
LocalProtocolError,
RemoteProtocolError,
+ WriteError,
map_exceptions,
)
from .._models import Origin, Request, Response
@@ -31,7 +26,7 @@ logger = logging.getLogger("httpcore.http11")
# A subset of `h11.Event` types supported by `_send_event`
-H11SendEvent = Union[
+H11SendEvent = typing.Union[
h11.Request,
h11.Data,
h11.EndOfMessage,
@@ -53,12 +48,12 @@ class HTTP11Connection(ConnectionInterface):
self,
origin: Origin,
stream: NetworkStream,
- keepalive_expiry: Optional[float] = None,
+ keepalive_expiry: float | None = None,
) -> None:
self._origin = origin
self._network_stream = stream
- self._keepalive_expiry: Optional[float] = keepalive_expiry
- self._expire_at: Optional[float] = None
+ self._keepalive_expiry: float | None = keepalive_expiry
+ self._expire_at: float | None = None
self._state = HTTPConnectionState.NEW
self._state_lock = Lock()
self._request_count = 0
@@ -84,10 +79,21 @@ class HTTP11Connection(ConnectionInterface):
try:
kwargs = {"request": request}
- with Trace("send_request_headers", logger, request, kwargs) as trace:
- self._send_request_headers(**kwargs)
- with Trace("send_request_body", logger, request, kwargs) as trace:
- self._send_request_body(**kwargs)
+ try:
+ with Trace(
+ "send_request_headers", logger, request, kwargs
+ ) as trace:
+ self._send_request_headers(**kwargs)
+ with Trace("send_request_body", logger, request, kwargs) as trace:
+ self._send_request_body(**kwargs)
+ except WriteError:
+ # If we get a write error while we're writing the request,
+ # then we supress this error and move on to attempting to
+ # read the response. Servers can sometimes close the request
+ # pre-emptively and then respond with a well formed HTTP
+ # error response.
+ pass
+
with Trace(
"receive_response_headers", logger, request, kwargs
) as trace:
@@ -96,6 +102,7 @@ class HTTP11Connection(ConnectionInterface):
status,
reason_phrase,
headers,
+ trailing_data,
) = self._receive_response_headers(**kwargs)
trace.return_value = (
http_version,
@@ -104,6 +111,14 @@ class HTTP11Connection(ConnectionInterface):
headers,
)
+ network_stream = self._network_stream
+
+ # CONNECT or Upgrade request
+ if (status == 101) or (
+ (request.method == b"CONNECT") and (200 <= status < 300)
+ ):
+ network_stream = HTTP11UpgradeStream(network_stream, trailing_data)
+
return Response(
status=status,
headers=headers,
@@ -111,7 +126,7 @@ class HTTP11Connection(ConnectionInterface):
extensions={
"http_version": http_version,
"reason_phrase": reason_phrase,
- "network_stream": self._network_stream,
+ "network_stream": network_stream,
},
)
except BaseException as exc:
@@ -138,16 +153,14 @@ class HTTP11Connection(ConnectionInterface):
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("write", None)
- assert isinstance(request.stream, Iterable)
+ assert isinstance(request.stream, typing.Iterable)
for chunk in request.stream:
event = h11.Data(data=chunk)
self._send_event(event, timeout=timeout)
self._send_event(h11.EndOfMessage(), timeout=timeout)
- def _send_event(
- self, event: h11.Event, timeout: Optional[float] = None
- ) -> None:
+ def _send_event(self, event: h11.Event, timeout: float | None = None) -> None:
bytes_to_send = self._h11_state.send(event)
if bytes_to_send is not None:
self._network_stream.write(bytes_to_send, timeout=timeout)
@@ -156,7 +169,7 @@ class HTTP11Connection(ConnectionInterface):
def _receive_response_headers(
self, request: Request
- ) -> Tuple[bytes, int, bytes, List[Tuple[bytes, bytes]]]:
+ ) -> tuple[bytes, int, bytes, list[tuple[bytes, bytes]], bytes]:
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("read", None)
@@ -176,9 +189,13 @@ class HTTP11Connection(ConnectionInterface):
# raw header casing, rather than the enforced lowercase headers.
headers = event.headers.raw_items()
- return http_version, event.status_code, event.reason, headers
+ trailing_data, _ = self._h11_state.trailing_data
- def _receive_response_body(self, request: Request) -> Iterator[bytes]:
+ return http_version, event.status_code, event.reason, headers, trailing_data
+
+ def _receive_response_body(
+ self, request: Request
+ ) -> typing.Iterator[bytes]:
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("read", None)
@@ -190,8 +207,8 @@ class HTTP11Connection(ConnectionInterface):
break
def _receive_event(
- self, timeout: Optional[float] = None
- ) -> Union[h11.Event, Type[h11.PAUSED]]:
+ self, timeout: float | None = None
+ ) -> h11.Event | type[h11.PAUSED]:
while True:
with map_exceptions({h11.RemoteProtocolError: RemoteProtocolError}):
event = self._h11_state.next_event()
@@ -216,7 +233,7 @@ class HTTP11Connection(ConnectionInterface):
self._h11_state.receive_data(data)
else:
# mypy fails to narrow the type in the above if statement above
- return cast(Union[h11.Event, Type[h11.PAUSED]], event)
+ return event # type: ignore[return-value]
def _response_closed(self) -> None:
with self._state_lock:
@@ -292,14 +309,14 @@ class HTTP11Connection(ConnectionInterface):
# These context managers are not used in the standard flow, but are
# useful for testing or working with connection instances directly.
- def __enter__(self) -> "HTTP11Connection":
+ def __enter__(self) -> HTTP11Connection:
return self
def __exit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
self.close()
@@ -310,7 +327,7 @@ class HTTP11ConnectionByteStream:
self._request = request
self._closed = False
- def __iter__(self) -> Iterator[bytes]:
+ def __iter__(self) -> typing.Iterator[bytes]:
kwargs = {"request": self._request}
try:
with Trace("receive_response_body", logger, self._request, kwargs):
@@ -329,3 +346,34 @@ class HTTP11ConnectionByteStream:
self._closed = True
with Trace("response_closed", logger, self._request):
self._connection._response_closed()
+
+
+class HTTP11UpgradeStream(NetworkStream):
+ def __init__(self, stream: NetworkStream, leading_data: bytes) -> None:
+ self._stream = stream
+ self._leading_data = leading_data
+
+ def read(self, max_bytes: int, timeout: float | None = None) -> bytes:
+ if self._leading_data:
+ buffer = self._leading_data[:max_bytes]
+ self._leading_data = self._leading_data[max_bytes:]
+ return buffer
+ else:
+ return self._stream.read(max_bytes, timeout)
+
+ def write(self, buffer: bytes, timeout: float | None = None) -> None:
+ self._stream.write(buffer, timeout)
+
+ def close(self) -> None:
+ self._stream.close()
+
+ def start_tls(
+ self,
+ ssl_context: ssl.SSLContext,
+ server_hostname: str | None = None,
+ timeout: float | None = None,
+ ) -> NetworkStream:
+ return self._stream.start_tls(ssl_context, server_hostname, timeout)
+
+ def get_extra_info(self, info: str) -> typing.Any:
+ return self._stream.get_extra_info(info)
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http2.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http2.py
index d141d459..ddcc1890 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http2.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http2.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
import enum
import logging
import time
@@ -45,14 +47,14 @@ class HTTP2Connection(ConnectionInterface):
self,
origin: Origin,
stream: NetworkStream,
- keepalive_expiry: typing.Optional[float] = None,
+ keepalive_expiry: float | None = None,
):
self._origin = origin
self._network_stream = stream
- self._keepalive_expiry: typing.Optional[float] = keepalive_expiry
+ self._keepalive_expiry: float | None = keepalive_expiry
self._h2_state = h2.connection.H2Connection(config=self.CONFIG)
self._state = HTTPConnectionState.IDLE
- self._expire_at: typing.Optional[float] = None
+ self._expire_at: float | None = None
self._request_count = 0
self._init_lock = Lock()
self._state_lock = Lock()
@@ -63,24 +65,22 @@ class HTTP2Connection(ConnectionInterface):
self._connection_error = False
# Mapping from stream ID to response stream events.
- self._events: typing.Dict[
+ self._events: dict[
int,
- typing.Union[
- h2.events.ResponseReceived,
- h2.events.DataReceived,
- h2.events.StreamEnded,
- h2.events.StreamReset,
+ list[
+ h2.events.ResponseReceived
+ | h2.events.DataReceived
+ | h2.events.StreamEnded
+ | h2.events.StreamReset,
],
] = {}
# Connection terminated events are stored as state since
# we need to handle them for all streams.
- self._connection_terminated: typing.Optional[
- h2.events.ConnectionTerminated
- ] = None
+ self._connection_terminated: h2.events.ConnectionTerminated | None = None
- self._read_exception: typing.Optional[Exception] = None
- self._write_exception: typing.Optional[Exception] = None
+ self._read_exception: Exception | None = None
+ self._write_exception: Exception | None = None
def handle_request(self, request: Request) -> Response:
if not self.can_handle_request(request.url.origin):
@@ -104,9 +104,11 @@ class HTTP2Connection(ConnectionInterface):
with self._init_lock:
if not self._sent_connection_init:
try:
- kwargs = {"request": request}
- with Trace("send_connection_init", logger, request, kwargs):
- self._send_connection_init(**kwargs)
+ sci_kwargs = {"request": request}
+ with Trace(
+ "send_connection_init", logger, request, sci_kwargs
+ ):
+ self._send_connection_init(**sci_kwargs)
except BaseException as exc:
with ShieldCancellation():
self.close()
@@ -284,7 +286,7 @@ class HTTP2Connection(ConnectionInterface):
def _receive_response(
self, request: Request, stream_id: int
- ) -> typing.Tuple[int, typing.List[typing.Tuple[bytes, bytes]]]:
+ ) -> tuple[int, list[tuple[bytes, bytes]]]:
"""
Return the response status code and headers for a given stream ID.
"""
@@ -295,6 +297,7 @@ class HTTP2Connection(ConnectionInterface):
status_code = 200
headers = []
+ assert event.headers is not None
for k, v in event.headers:
if k == b":status":
status_code = int(v.decode("ascii", errors="ignore"))
@@ -312,6 +315,8 @@ class HTTP2Connection(ConnectionInterface):
while True:
event = self._receive_stream_event(request, stream_id)
if isinstance(event, h2.events.DataReceived):
+ assert event.flow_controlled_length is not None
+ assert event.data is not None
amount = event.flow_controlled_length
self._h2_state.acknowledge_received_data(amount, stream_id)
self._write_outgoing_data(request)
@@ -321,9 +326,7 @@ class HTTP2Connection(ConnectionInterface):
def _receive_stream_event(
self, request: Request, stream_id: int
- ) -> typing.Union[
- h2.events.ResponseReceived, h2.events.DataReceived, h2.events.StreamEnded
- ]:
+ ) -> h2.events.ResponseReceived | h2.events.DataReceived | h2.events.StreamEnded:
"""
Return the next available event for a given stream ID.
@@ -337,7 +340,7 @@ class HTTP2Connection(ConnectionInterface):
return event
def _receive_events(
- self, request: Request, stream_id: typing.Optional[int] = None
+ self, request: Request, stream_id: int | None = None
) -> None:
"""
Read some data from the network until we see one or more events
@@ -384,7 +387,9 @@ class HTTP2Connection(ConnectionInterface):
self._write_outgoing_data(request)
- def _receive_remote_settings_change(self, event: h2.events.Event) -> None:
+ def _receive_remote_settings_change(
+ self, event: h2.events.RemoteSettingsChanged
+ ) -> None:
max_concurrent_streams = event.changed_settings.get(
h2.settings.SettingCodes.MAX_CONCURRENT_STREAMS
)
@@ -425,9 +430,7 @@ class HTTP2Connection(ConnectionInterface):
# Wrappers around network read/write operations...
- def _read_incoming_data(
- self, request: Request
- ) -> typing.List[h2.events.Event]:
+ def _read_incoming_data(self, request: Request) -> list[h2.events.Event]:
timeouts = request.extensions.get("timeout", {})
timeout = timeouts.get("read", None)
@@ -451,7 +454,7 @@ class HTTP2Connection(ConnectionInterface):
self._connection_error = True
raise exc
- events: typing.List[h2.events.Event] = self._h2_state.receive_data(data)
+ events: list[h2.events.Event] = self._h2_state.receive_data(data)
return events
@@ -544,14 +547,14 @@ class HTTP2Connection(ConnectionInterface):
# These context managers are not used in the standard flow, but are
# useful for testing or working with connection instances directly.
- def __enter__(self) -> "HTTP2Connection":
+ def __enter__(self) -> HTTP2Connection:
return self
def __exit__(
self,
- exc_type: typing.Optional[typing.Type[BaseException]] = None,
- exc_value: typing.Optional[BaseException] = None,
- traceback: typing.Optional[types.TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
self.close()
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http_proxy.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http_proxy.py
index bb368dd4..ecca88f7 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http_proxy.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/http_proxy.py
@@ -1,7 +1,9 @@
+from __future__ import annotations
+
+import base64
import logging
import ssl
-from base64 import b64encode
-from typing import Iterable, List, Mapping, Optional, Sequence, Tuple, Union
+import typing
from .._backends.base import SOCKET_OPTION, NetworkBackend
from .._exceptions import ProxyError
@@ -22,17 +24,18 @@ from .connection_pool import ConnectionPool
from .http11 import HTTP11Connection
from .interfaces import ConnectionInterface
-HeadersAsSequence = Sequence[Tuple[Union[bytes, str], Union[bytes, str]]]
-HeadersAsMapping = Mapping[Union[bytes, str], Union[bytes, str]]
+ByteOrStr = typing.Union[bytes, str]
+HeadersAsSequence = typing.Sequence[typing.Tuple[ByteOrStr, ByteOrStr]]
+HeadersAsMapping = typing.Mapping[ByteOrStr, ByteOrStr]
logger = logging.getLogger("httpcore.proxy")
def merge_headers(
- default_headers: Optional[Sequence[Tuple[bytes, bytes]]] = None,
- override_headers: Optional[Sequence[Tuple[bytes, bytes]]] = None,
-) -> List[Tuple[bytes, bytes]]:
+ default_headers: typing.Sequence[tuple[bytes, bytes]] | None = None,
+ override_headers: typing.Sequence[tuple[bytes, bytes]] | None = None,
+) -> list[tuple[bytes, bytes]]:
"""
Append default_headers and override_headers, de-duplicating if a key exists
in both cases.
@@ -48,32 +51,28 @@ def merge_headers(
return default_headers + override_headers
-def build_auth_header(username: bytes, password: bytes) -> bytes:
- userpass = username + b":" + password
- return b"Basic " + b64encode(userpass)
-
-
-class HTTPProxy(ConnectionPool):
+class HTTPProxy(ConnectionPool): # pragma: nocover
"""
A connection pool that sends requests via an HTTP proxy.
"""
def __init__(
self,
- proxy_url: Union[URL, bytes, str],
- proxy_auth: Optional[Tuple[Union[bytes, str], Union[bytes, str]]] = None,
- proxy_headers: Union[HeadersAsMapping, HeadersAsSequence, None] = None,
- ssl_context: Optional[ssl.SSLContext] = None,
- max_connections: Optional[int] = 10,
- max_keepalive_connections: Optional[int] = None,
- keepalive_expiry: Optional[float] = None,
+ proxy_url: URL | bytes | str,
+ proxy_auth: tuple[bytes | str, bytes | str] | None = None,
+ proxy_headers: HeadersAsMapping | HeadersAsSequence | None = None,
+ ssl_context: ssl.SSLContext | None = None,
+ proxy_ssl_context: ssl.SSLContext | None = None,
+ max_connections: int | None = 10,
+ max_keepalive_connections: int | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- local_address: Optional[str] = None,
- uds: Optional[str] = None,
- network_backend: Optional[NetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ local_address: str | None = None,
+ uds: str | None = None,
+ network_backend: NetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
"""
A connection pool for making HTTP requests.
@@ -88,6 +87,7 @@ class HTTPProxy(ConnectionPool):
ssl_context: An SSL context to use for verifying connections.
If not specified, the default `httpcore.default_ssl_context()`
will be used.
+ proxy_ssl_context: The same as `ssl_context`, but for a proxy server rather than a remote origin.
max_connections: The maximum number of concurrent HTTP connections that
the pool should allow. Any attempt to send a request on a pool that
would exceed this amount will block until a connection is available.
@@ -122,13 +122,23 @@ class HTTPProxy(ConnectionPool):
uds=uds,
socket_options=socket_options,
)
- self._ssl_context = ssl_context
+
self._proxy_url = enforce_url(proxy_url, name="proxy_url")
+ if (
+ self._proxy_url.scheme == b"http" and proxy_ssl_context is not None
+ ): # pragma: no cover
+ raise RuntimeError(
+ "The `proxy_ssl_context` argument is not allowed for the http scheme"
+ )
+
+ self._ssl_context = ssl_context
+ self._proxy_ssl_context = proxy_ssl_context
self._proxy_headers = enforce_headers(proxy_headers, name="proxy_headers")
if proxy_auth is not None:
username = enforce_bytes(proxy_auth[0], name="proxy_auth")
password = enforce_bytes(proxy_auth[1], name="proxy_auth")
- authorization = build_auth_header(username, password)
+ userpass = username + b":" + password
+ authorization = b"Basic " + base64.b64encode(userpass)
self._proxy_headers = [
(b"Proxy-Authorization", authorization)
] + self._proxy_headers
@@ -141,12 +151,14 @@ class HTTPProxy(ConnectionPool):
remote_origin=origin,
keepalive_expiry=self._keepalive_expiry,
network_backend=self._network_backend,
+ proxy_ssl_context=self._proxy_ssl_context,
)
return TunnelHTTPConnection(
proxy_origin=self._proxy_url.origin,
proxy_headers=self._proxy_headers,
remote_origin=origin,
ssl_context=self._ssl_context,
+ proxy_ssl_context=self._proxy_ssl_context,
keepalive_expiry=self._keepalive_expiry,
http1=self._http1,
http2=self._http2,
@@ -159,16 +171,18 @@ class ForwardHTTPConnection(ConnectionInterface):
self,
proxy_origin: Origin,
remote_origin: Origin,
- proxy_headers: Union[HeadersAsMapping, HeadersAsSequence, None] = None,
- keepalive_expiry: Optional[float] = None,
- network_backend: Optional[NetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ proxy_headers: HeadersAsMapping | HeadersAsSequence | None = None,
+ keepalive_expiry: float | None = None,
+ network_backend: NetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
+ proxy_ssl_context: ssl.SSLContext | None = None,
) -> None:
self._connection = HTTPConnection(
origin=proxy_origin,
keepalive_expiry=keepalive_expiry,
network_backend=network_backend,
socket_options=socket_options,
+ ssl_context=proxy_ssl_context,
)
self._proxy_origin = proxy_origin
self._proxy_headers = enforce_headers(proxy_headers, name="proxy_headers")
@@ -221,23 +235,26 @@ class TunnelHTTPConnection(ConnectionInterface):
self,
proxy_origin: Origin,
remote_origin: Origin,
- ssl_context: Optional[ssl.SSLContext] = None,
- proxy_headers: Optional[Sequence[Tuple[bytes, bytes]]] = None,
- keepalive_expiry: Optional[float] = None,
+ ssl_context: ssl.SSLContext | None = None,
+ proxy_ssl_context: ssl.SSLContext | None = None,
+ proxy_headers: typing.Sequence[tuple[bytes, bytes]] | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
- network_backend: Optional[NetworkBackend] = None,
- socket_options: Optional[Iterable[SOCKET_OPTION]] = None,
+ network_backend: NetworkBackend | None = None,
+ socket_options: typing.Iterable[SOCKET_OPTION] | None = None,
) -> None:
self._connection: ConnectionInterface = HTTPConnection(
origin=proxy_origin,
keepalive_expiry=keepalive_expiry,
network_backend=network_backend,
socket_options=socket_options,
+ ssl_context=proxy_ssl_context,
)
self._proxy_origin = proxy_origin
self._remote_origin = remote_origin
self._ssl_context = ssl_context
+ self._proxy_ssl_context = proxy_ssl_context
self._proxy_headers = enforce_headers(proxy_headers, name="proxy_headers")
self._keepalive_expiry = keepalive_expiry
self._http1 = http1
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/interfaces.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/interfaces.py
index 5e95be1e..e673d4cc 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/interfaces.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/interfaces.py
@@ -1,5 +1,7 @@
-from contextlib import contextmanager
-from typing import Iterator, Optional, Union
+from __future__ import annotations
+
+import contextlib
+import typing
from .._models import (
URL,
@@ -18,12 +20,12 @@ from .._models import (
class RequestInterface:
def request(
self,
- method: Union[bytes, str],
- url: Union[URL, bytes, str],
+ method: bytes | str,
+ url: URL | bytes | str,
*,
headers: HeaderTypes = None,
- content: Union[bytes, Iterator[bytes], None] = None,
- extensions: Optional[Extensions] = None,
+ content: bytes | typing.Iterator[bytes] | None = None,
+ extensions: Extensions | None = None,
) -> Response:
# Strict type checking on our parameters.
method = enforce_bytes(method, name="method")
@@ -47,16 +49,16 @@ class RequestInterface:
response.close()
return response
- @contextmanager
+ @contextlib.contextmanager
def stream(
self,
- method: Union[bytes, str],
- url: Union[URL, bytes, str],
+ method: bytes | str,
+ url: URL | bytes | str,
*,
headers: HeaderTypes = None,
- content: Union[bytes, Iterator[bytes], None] = None,
- extensions: Optional[Extensions] = None,
- ) -> Iterator[Response]:
+ content: bytes | typing.Iterator[bytes] | None = None,
+ extensions: Extensions | None = None,
+ ) -> typing.Iterator[Response]:
# Strict type checking on our parameters.
method = enforce_bytes(method, name="method")
url = enforce_url(url, name="url")
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/socks_proxy.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/socks_proxy.py
index 407351d0..0ca96ddf 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/socks_proxy.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_sync/socks_proxy.py
@@ -1,8 +1,9 @@
+from __future__ import annotations
+
import logging
import ssl
-import typing
-from socksio import socks5
+import socksio
from .._backends.sync import SyncBackend
from .._backends.base import NetworkBackend, NetworkStream
@@ -43,24 +44,24 @@ def _init_socks5_connection(
*,
host: bytes,
port: int,
- auth: typing.Optional[typing.Tuple[bytes, bytes]] = None,
+ auth: tuple[bytes, bytes] | None = None,
) -> None:
- conn = socks5.SOCKS5Connection()
+ conn = socksio.socks5.SOCKS5Connection()
# Auth method request
auth_method = (
- socks5.SOCKS5AuthMethod.NO_AUTH_REQUIRED
+ socksio.socks5.SOCKS5AuthMethod.NO_AUTH_REQUIRED
if auth is None
- else socks5.SOCKS5AuthMethod.USERNAME_PASSWORD
+ else socksio.socks5.SOCKS5AuthMethod.USERNAME_PASSWORD
)
- conn.send(socks5.SOCKS5AuthMethodsRequest([auth_method]))
+ conn.send(socksio.socks5.SOCKS5AuthMethodsRequest([auth_method]))
outgoing_bytes = conn.data_to_send()
stream.write(outgoing_bytes)
# Auth method response
incoming_bytes = stream.read(max_bytes=4096)
response = conn.receive_data(incoming_bytes)
- assert isinstance(response, socks5.SOCKS5AuthReply)
+ assert isinstance(response, socksio.socks5.SOCKS5AuthReply)
if response.method != auth_method:
requested = AUTH_METHODS.get(auth_method, "UNKNOWN")
responded = AUTH_METHODS.get(response.method, "UNKNOWN")
@@ -68,25 +69,25 @@ def _init_socks5_connection(
f"Requested {requested} from proxy server, but got {responded}."
)
- if response.method == socks5.SOCKS5AuthMethod.USERNAME_PASSWORD:
+ if response.method == socksio.socks5.SOCKS5AuthMethod.USERNAME_PASSWORD:
# Username/password request
assert auth is not None
username, password = auth
- conn.send(socks5.SOCKS5UsernamePasswordRequest(username, password))
+ conn.send(socksio.socks5.SOCKS5UsernamePasswordRequest(username, password))
outgoing_bytes = conn.data_to_send()
stream.write(outgoing_bytes)
# Username/password response
incoming_bytes = stream.read(max_bytes=4096)
response = conn.receive_data(incoming_bytes)
- assert isinstance(response, socks5.SOCKS5UsernamePasswordReply)
+ assert isinstance(response, socksio.socks5.SOCKS5UsernamePasswordReply)
if not response.success:
raise ProxyError("Invalid username/password")
# Connect request
conn.send(
- socks5.SOCKS5CommandRequest.from_address(
- socks5.SOCKS5Command.CONNECT, (host, port)
+ socksio.socks5.SOCKS5CommandRequest.from_address(
+ socksio.socks5.SOCKS5Command.CONNECT, (host, port)
)
)
outgoing_bytes = conn.data_to_send()
@@ -95,31 +96,29 @@ def _init_socks5_connection(
# Connect response
incoming_bytes = stream.read(max_bytes=4096)
response = conn.receive_data(incoming_bytes)
- assert isinstance(response, socks5.SOCKS5Reply)
- if response.reply_code != socks5.SOCKS5ReplyCode.SUCCEEDED:
+ assert isinstance(response, socksio.socks5.SOCKS5Reply)
+ if response.reply_code != socksio.socks5.SOCKS5ReplyCode.SUCCEEDED:
reply_code = REPLY_CODES.get(response.reply_code, "UNKOWN")
raise ProxyError(f"Proxy Server could not connect: {reply_code}.")
-class SOCKSProxy(ConnectionPool):
+class SOCKSProxy(ConnectionPool): # pragma: nocover
"""
A connection pool that sends requests via an HTTP proxy.
"""
def __init__(
self,
- proxy_url: typing.Union[URL, bytes, str],
- proxy_auth: typing.Optional[
- typing.Tuple[typing.Union[bytes, str], typing.Union[bytes, str]]
- ] = None,
- ssl_context: typing.Optional[ssl.SSLContext] = None,
- max_connections: typing.Optional[int] = 10,
- max_keepalive_connections: typing.Optional[int] = None,
- keepalive_expiry: typing.Optional[float] = None,
+ proxy_url: URL | bytes | str,
+ proxy_auth: tuple[bytes | str, bytes | str] | None = None,
+ ssl_context: ssl.SSLContext | None = None,
+ max_connections: int | None = 10,
+ max_keepalive_connections: int | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
retries: int = 0,
- network_backend: typing.Optional[NetworkBackend] = None,
+ network_backend: NetworkBackend | None = None,
) -> None:
"""
A connection pool for making HTTP requests.
@@ -167,7 +166,7 @@ class SOCKSProxy(ConnectionPool):
username, password = proxy_auth
username_bytes = enforce_bytes(username, name="proxy_auth")
password_bytes = enforce_bytes(password, name="proxy_auth")
- self._proxy_auth: typing.Optional[typing.Tuple[bytes, bytes]] = (
+ self._proxy_auth: tuple[bytes, bytes] | None = (
username_bytes,
password_bytes,
)
@@ -192,12 +191,12 @@ class Socks5Connection(ConnectionInterface):
self,
proxy_origin: Origin,
remote_origin: Origin,
- proxy_auth: typing.Optional[typing.Tuple[bytes, bytes]] = None,
- ssl_context: typing.Optional[ssl.SSLContext] = None,
- keepalive_expiry: typing.Optional[float] = None,
+ proxy_auth: tuple[bytes, bytes] | None = None,
+ ssl_context: ssl.SSLContext | None = None,
+ keepalive_expiry: float | None = None,
http1: bool = True,
http2: bool = False,
- network_backend: typing.Optional[NetworkBackend] = None,
+ network_backend: NetworkBackend | None = None,
) -> None:
self._proxy_origin = proxy_origin
self._remote_origin = remote_origin
@@ -211,11 +210,12 @@ class Socks5Connection(ConnectionInterface):
SyncBackend() if network_backend is None else network_backend
)
self._connect_lock = Lock()
- self._connection: typing.Optional[ConnectionInterface] = None
+ self._connection: ConnectionInterface | None = None
self._connect_failed = False
def handle_request(self, request: Request) -> Response:
timeouts = request.extensions.get("timeout", {})
+ sni_hostname = request.extensions.get("sni_hostname", None)
timeout = timeouts.get("connect", None)
with self._connect_lock:
@@ -258,7 +258,8 @@ class Socks5Connection(ConnectionInterface):
kwargs = {
"ssl_context": ssl_context,
- "server_hostname": self._remote_origin.host.decode("ascii"),
+ "server_hostname": sni_hostname
+ or self._remote_origin.host.decode("ascii"),
"timeout": timeout,
}
with Trace("start_tls", logger, request, kwargs) as trace:
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_synchronization.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_synchronization.py
index bae27c1b..2ecc9e9c 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_synchronization.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_synchronization.py
@@ -1,8 +1,7 @@
-import threading
-from types import TracebackType
-from typing import Optional, Type
+from __future__ import annotations
-import sniffio
+import threading
+import types
from ._exceptions import ExceptionMapping, PoolTimeout, map_exceptions
@@ -11,7 +10,7 @@ from ._exceptions import ExceptionMapping, PoolTimeout, map_exceptions
try:
import trio
-except ImportError: # pragma: nocover
+except (ImportError, NotImplementedError): # pragma: nocover
trio = None # type: ignore
try:
@@ -20,7 +19,40 @@ except ImportError: # pragma: nocover
anyio = None # type: ignore
+def current_async_library() -> str:
+ # Determine if we're running under trio or asyncio.
+ # See https://sniffio.readthedocs.io/en/latest/
+ try:
+ import sniffio
+ except ImportError: # pragma: nocover
+ environment = "asyncio"
+ else:
+ environment = sniffio.current_async_library()
+
+ if environment not in ("asyncio", "trio"): # pragma: nocover
+ raise RuntimeError("Running under an unsupported async environment.")
+
+ if environment == "asyncio" and anyio is None: # pragma: nocover
+ raise RuntimeError(
+ "Running with asyncio requires installation of 'httpcore[asyncio]'."
+ )
+
+ if environment == "trio" and trio is None: # pragma: nocover
+ raise RuntimeError(
+ "Running with trio requires installation of 'httpcore[trio]'."
+ )
+
+ return environment
+
+
class AsyncLock:
+ """
+ This is a standard lock.
+
+ In the sync case `Lock` provides thread locking.
+ In the async case `AsyncLock` provides async locking.
+ """
+
def __init__(self) -> None:
self._backend = ""
@@ -29,43 +61,55 @@ class AsyncLock:
Detect if we're running under 'asyncio' or 'trio' and create
a lock with the correct implementation.
"""
- self._backend = sniffio.current_async_library()
+ self._backend = current_async_library()
if self._backend == "trio":
- if trio is None: # pragma: nocover
- raise RuntimeError(
- "Running under trio, requires the 'trio' package to be installed."
- )
self._trio_lock = trio.Lock()
- else:
- if anyio is None: # pragma: nocover
- raise RuntimeError(
- "Running under asyncio requires the 'anyio' package to be installed."
- )
+ elif self._backend == "asyncio":
self._anyio_lock = anyio.Lock()
- async def __aenter__(self) -> "AsyncLock":
+ async def __aenter__(self) -> AsyncLock:
if not self._backend:
self.setup()
if self._backend == "trio":
await self._trio_lock.acquire()
- else:
+ elif self._backend == "asyncio":
await self._anyio_lock.acquire()
return self
async def __aexit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
if self._backend == "trio":
self._trio_lock.release()
- else:
+ elif self._backend == "asyncio":
self._anyio_lock.release()
+class AsyncThreadLock:
+ """
+ This is a threading-only lock for no-I/O contexts.
+
+ In the sync case `ThreadLock` provides thread locking.
+ In the async case `AsyncThreadLock` is a no-op.
+ """
+
+ def __enter__(self) -> AsyncThreadLock:
+ return self
+
+ def __exit__(
+ self,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
+ ) -> None:
+ pass
+
+
class AsyncEvent:
def __init__(self) -> None:
self._backend = ""
@@ -75,18 +119,10 @@ class AsyncEvent:
Detect if we're running under 'asyncio' or 'trio' and create
a lock with the correct implementation.
"""
- self._backend = sniffio.current_async_library()
+ self._backend = current_async_library()
if self._backend == "trio":
- if trio is None: # pragma: nocover
- raise RuntimeError(
- "Running under trio requires the 'trio' package to be installed."
- )
self._trio_event = trio.Event()
- else:
- if anyio is None: # pragma: nocover
- raise RuntimeError(
- "Running under asyncio requires the 'anyio' package to be installed."
- )
+ elif self._backend == "asyncio":
self._anyio_event = anyio.Event()
def set(self) -> None:
@@ -95,30 +131,20 @@ class AsyncEvent:
if self._backend == "trio":
self._trio_event.set()
- else:
+ elif self._backend == "asyncio":
self._anyio_event.set()
- async def wait(self, timeout: Optional[float] = None) -> None:
+ async def wait(self, timeout: float | None = None) -> None:
if not self._backend:
self.setup()
if self._backend == "trio":
- if trio is None: # pragma: nocover
- raise RuntimeError(
- "Running under trio requires the 'trio' package to be installed."
- )
-
trio_exc_map: ExceptionMapping = {trio.TooSlowError: PoolTimeout}
timeout_or_inf = float("inf") if timeout is None else timeout
with map_exceptions(trio_exc_map):
with trio.fail_after(timeout_or_inf):
await self._trio_event.wait()
- else:
- if anyio is None: # pragma: nocover
- raise RuntimeError(
- "Running under asyncio requires the 'anyio' package to be installed."
- )
-
+ elif self._backend == "asyncio":
anyio_exc_map: ExceptionMapping = {TimeoutError: PoolTimeout}
with map_exceptions(anyio_exc_map):
with anyio.fail_after(timeout):
@@ -135,22 +161,12 @@ class AsyncSemaphore:
Detect if we're running under 'asyncio' or 'trio' and create
a semaphore with the correct implementation.
"""
- self._backend = sniffio.current_async_library()
+ self._backend = current_async_library()
if self._backend == "trio":
- if trio is None: # pragma: nocover
- raise RuntimeError(
- "Running under trio requires the 'trio' package to be installed."
- )
-
self._trio_semaphore = trio.Semaphore(
initial_value=self._bound, max_value=self._bound
)
- else:
- if anyio is None: # pragma: nocover
- raise RuntimeError(
- "Running under asyncio requires the 'anyio' package to be installed."
- )
-
+ elif self._backend == "asyncio":
self._anyio_semaphore = anyio.Semaphore(
initial_value=self._bound, max_value=self._bound
)
@@ -161,13 +177,13 @@ class AsyncSemaphore:
if self._backend == "trio":
await self._trio_semaphore.acquire()
- else:
+ elif self._backend == "asyncio":
await self._anyio_semaphore.acquire()
async def release(self) -> None:
if self._backend == "trio":
self._trio_semaphore.release()
- else:
+ elif self._backend == "asyncio":
self._anyio_semaphore.release()
@@ -184,39 +200,29 @@ class AsyncShieldCancellation:
Detect if we're running under 'asyncio' or 'trio' and create
a shielded scope with the correct implementation.
"""
- self._backend = sniffio.current_async_library()
+ self._backend = current_async_library()
if self._backend == "trio":
- if trio is None: # pragma: nocover
- raise RuntimeError(
- "Running under trio requires the 'trio' package to be installed."
- )
-
self._trio_shield = trio.CancelScope(shield=True)
- else:
- if anyio is None: # pragma: nocover
- raise RuntimeError(
- "Running under asyncio requires the 'anyio' package to be installed."
- )
-
+ elif self._backend == "asyncio":
self._anyio_shield = anyio.CancelScope(shield=True)
- def __enter__(self) -> "AsyncShieldCancellation":
+ def __enter__(self) -> AsyncShieldCancellation:
if self._backend == "trio":
self._trio_shield.__enter__()
- else:
+ elif self._backend == "asyncio":
self._anyio_shield.__enter__()
return self
def __exit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
if self._backend == "trio":
self._trio_shield.__exit__(exc_type, exc_value, traceback)
- else:
+ elif self._backend == "asyncio":
self._anyio_shield.__exit__(exc_type, exc_value, traceback)
@@ -224,18 +230,49 @@ class AsyncShieldCancellation:
class Lock:
+ """
+ This is a standard lock.
+
+ In the sync case `Lock` provides thread locking.
+ In the async case `AsyncLock` provides async locking.
+ """
+
def __init__(self) -> None:
self._lock = threading.Lock()
- def __enter__(self) -> "Lock":
+ def __enter__(self) -> Lock:
self._lock.acquire()
return self
def __exit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
+ ) -> None:
+ self._lock.release()
+
+
+class ThreadLock:
+ """
+ This is a threading-only lock for no-I/O contexts.
+
+ In the sync case `ThreadLock` provides thread locking.
+ In the async case `AsyncThreadLock` is a no-op.
+ """
+
+ def __init__(self) -> None:
+ self._lock = threading.Lock()
+
+ def __enter__(self) -> ThreadLock:
+ self._lock.acquire()
+ return self
+
+ def __exit__(
+ self,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
self._lock.release()
@@ -247,7 +284,9 @@ class Event:
def set(self) -> None:
self._event.set()
- def wait(self, timeout: Optional[float] = None) -> None:
+ def wait(self, timeout: float | None = None) -> None:
+ if timeout == float("inf"): # pragma: no cover
+ timeout = None
if not self._event.wait(timeout=timeout):
raise PoolTimeout() # pragma: nocover
@@ -267,13 +306,13 @@ class ShieldCancellation:
# Thread-synchronous codebases don't support cancellation semantics.
# We have this class because we need to mirror the async and sync
# cases within our package, but it's just a no-op.
- def __enter__(self) -> "ShieldCancellation":
+ def __enter__(self) -> ShieldCancellation:
return self
def __exit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
pass
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_trace.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_trace.py
index b122a53e..5f1cd7c4 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_trace.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_trace.py
@@ -1,7 +1,9 @@
+from __future__ import annotations
+
import inspect
import logging
-from types import TracebackType
-from typing import Any, Dict, Optional, Type
+import types
+import typing
from ._models import Request
@@ -11,8 +13,8 @@ class Trace:
self,
name: str,
logger: logging.Logger,
- request: Optional[Request] = None,
- kwargs: Optional[Dict[str, Any]] = None,
+ request: Request | None = None,
+ kwargs: dict[str, typing.Any] | None = None,
) -> None:
self.name = name
self.logger = logger
@@ -21,11 +23,11 @@ class Trace:
)
self.debug = self.logger.isEnabledFor(logging.DEBUG)
self.kwargs = kwargs or {}
- self.return_value: Any = None
+ self.return_value: typing.Any = None
self.should_trace = self.debug or self.trace_extension is not None
self.prefix = self.logger.name.split(".")[-1]
- def trace(self, name: str, info: Dict[str, Any]) -> None:
+ def trace(self, name: str, info: dict[str, typing.Any]) -> None:
if self.trace_extension is not None:
prefix_and_name = f"{self.prefix}.{name}"
ret = self.trace_extension(prefix_and_name, info)
@@ -44,7 +46,7 @@ class Trace:
message = f"{name} {args}"
self.logger.debug(message)
- def __enter__(self) -> "Trace":
+ def __enter__(self) -> Trace:
if self.should_trace:
info = self.kwargs
self.trace(f"{self.name}.started", info)
@@ -52,9 +54,9 @@ class Trace:
def __exit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
if self.should_trace:
if exc_value is None:
@@ -64,7 +66,7 @@ class Trace:
info = {"exception": exc_value}
self.trace(f"{self.name}.failed", info)
- async def atrace(self, name: str, info: Dict[str, Any]) -> None:
+ async def atrace(self, name: str, info: dict[str, typing.Any]) -> None:
if self.trace_extension is not None:
prefix_and_name = f"{self.prefix}.{name}"
coro = self.trace_extension(prefix_and_name, info)
@@ -84,7 +86,7 @@ class Trace:
message = f"{name} {args}"
self.logger.debug(message)
- async def __aenter__(self) -> "Trace":
+ async def __aenter__(self) -> Trace:
if self.should_trace:
info = self.kwargs
await self.atrace(f"{self.name}.started", info)
@@ -92,9 +94,9 @@ class Trace:
async def __aexit__(
self,
- exc_type: Optional[Type[BaseException]] = None,
- exc_value: Optional[BaseException] = None,
- traceback: Optional[TracebackType] = None,
+ exc_type: type[BaseException] | None = None,
+ exc_value: BaseException | None = None,
+ traceback: types.TracebackType | None = None,
) -> None:
if self.should_trace:
if exc_value is None:
diff --git a/Backend/venv/lib/python3.12/site-packages/httpcore/_utils.py b/Backend/venv/lib/python3.12/site-packages/httpcore/_utils.py
index df5dea8f..c44ff93c 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpcore/_utils.py
+++ b/Backend/venv/lib/python3.12/site-packages/httpcore/_utils.py
@@ -1,10 +1,11 @@
+from __future__ import annotations
+
import select
import socket
import sys
-import typing
-def is_socket_readable(sock: typing.Optional[socket.socket]) -> bool:
+def is_socket_readable(sock: socket.socket | None) -> bool:
"""
Return whether a socket, as identifed by its file descriptor, is readable.
"A socket is readable" means that the read buffer isn't empty, i.e. that calling
diff --git a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/RECORD
deleted file mode 100644
index 1cbe3ad6..00000000
--- a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/RECORD
+++ /dev/null
@@ -1,57 +0,0 @@
-../../../bin/httpx,sha256=YhM3lroNg2xkNdaFKicQjc2KywBLVV9r6yrAbSYZAio,216
-httpx-0.24.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
-httpx-0.24.1.dist-info/METADATA,sha256=ZBqGMGxXnjZ-UpNiE4mXBHZzuC4lRx_mTPc_R4YNoiQ,7428
-httpx-0.24.1.dist-info/RECORD,,
-httpx-0.24.1.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-httpx-0.24.1.dist-info/WHEEL,sha256=y1bSCq4r5i4nMmpXeUJMqs3ipKvkZObrIXSvJHm1qCI,87
-httpx-0.24.1.dist-info/entry_points.txt,sha256=2lVkdQmxLA1pNMgSN2eV89o90HCZezhmNwsy6ryKDSA,37
-httpx-0.24.1.dist-info/licenses/LICENSE.md,sha256=TsWdVE8StfU5o6cW_TIaxYzNgDC0ZSIfLIgCAM3yjY0,1508
-httpx/__init__.py,sha256=oCxVAsePEy5DE9eLhGAAq9H3RBGZUDaUROtGEyzbBRo,3210
-httpx/__pycache__/__init__.cpython-312.pyc,,
-httpx/__pycache__/__version__.cpython-312.pyc,,
-httpx/__pycache__/_api.cpython-312.pyc,,
-httpx/__pycache__/_auth.cpython-312.pyc,,
-httpx/__pycache__/_client.cpython-312.pyc,,
-httpx/__pycache__/_compat.cpython-312.pyc,,
-httpx/__pycache__/_config.cpython-312.pyc,,
-httpx/__pycache__/_content.cpython-312.pyc,,
-httpx/__pycache__/_decoders.cpython-312.pyc,,
-httpx/__pycache__/_exceptions.cpython-312.pyc,,
-httpx/__pycache__/_main.cpython-312.pyc,,
-httpx/__pycache__/_models.cpython-312.pyc,,
-httpx/__pycache__/_multipart.cpython-312.pyc,,
-httpx/__pycache__/_status_codes.cpython-312.pyc,,
-httpx/__pycache__/_types.cpython-312.pyc,,
-httpx/__pycache__/_urlparse.cpython-312.pyc,,
-httpx/__pycache__/_urls.cpython-312.pyc,,
-httpx/__pycache__/_utils.cpython-312.pyc,,
-httpx/__version__.py,sha256=bg4cSle4BdKgSjAPJGqR4kGXZ-nTOXf_1g68lFLU8To,108
-httpx/_api.py,sha256=cVU9ErzaXve5rqoPoSHr9yJbovHtICrcxR7yBoNSeOw,13011
-httpx/_auth.py,sha256=58FA-xqqp-XgLZ7Emd4-et-XXuTRaa5buiBYB2MzyvE,11773
-httpx/_client.py,sha256=A9MPP_d1ZlqcO5CeGLgyzVwdHgCpROYSdjoAUA6rpYE,68131
-httpx/_compat.py,sha256=lQa4SnZhS-kNQ8HKpSwKrmJ00nYQKDVaWwwnOYEvjMI,1602
-httpx/_config.py,sha256=9Tg0-pV93Hl5knjyZhCLcoEXymAMn-OLaDsEn2uPK14,12391
-httpx/_content.py,sha256=olbWqawdWWweXeW6gDYHPiEGjip5lqFZKv9OmVd-zIg,8092
-httpx/_decoders.py,sha256=dd8GSkEAe45BzRUF47zH_lg3-BcwXtxzPBSGP5Y4F90,9739
-httpx/_exceptions.py,sha256=xKw-U6vW7zmdReUAGYHMegYWZuDAuE5039L087SHe4Q,7880
-httpx/_main.py,sha256=m9C4RuqjOB6UqL3FFHMjmC45f4SDSO-iOREFLdw4IdM,15784
-httpx/_models.py,sha256=Ho9YjmVMkS-lEMhCGpecfYsenVZy2jsLJmKCexO50tI,42696
-httpx/_multipart.py,sha256=qzt35jAgapaRPwdq-lTKSA5YY6ayrfDIsZLdr3t4NWc,8972
-httpx/_status_codes.py,sha256=XKArMrSoo8oKBQCHdFGA-wsM2PcSTaHE8svDYOUcwWk,5584
-httpx/_transports/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-httpx/_transports/__pycache__/__init__.cpython-312.pyc,,
-httpx/_transports/__pycache__/asgi.cpython-312.pyc,,
-httpx/_transports/__pycache__/base.cpython-312.pyc,,
-httpx/_transports/__pycache__/default.cpython-312.pyc,,
-httpx/_transports/__pycache__/mock.cpython-312.pyc,,
-httpx/_transports/__pycache__/wsgi.cpython-312.pyc,,
-httpx/_transports/asgi.py,sha256=lKAL-6dhxqSnZA2fMWtj-MokSTIzjnwwa3DTkkof5cE,5317
-httpx/_transports/base.py,sha256=0BM8yZZEkdFT4tXXSm0h0dK0cSYA4hLgInj_BljGEGw,2510
-httpx/_transports/default.py,sha256=fla9xvSAM3BuGtaMa4PhbX1gW_9oafl8vzujOhcE-H8,12626
-httpx/_transports/mock.py,sha256=sDt3BDXbz8-W94kC8OXtGzF1PWH0y73h1De7Q-XkVtg,1179
-httpx/_transports/wsgi.py,sha256=72ZMPBLPV-aZB4gfsz_SOrJpgKJb6Z9W5wFxhlMQcqg,4754
-httpx/_types.py,sha256=BnX0adSAxLT9BzkxuX96S4odkC9UdLMgws6waxqEKuI,3333
-httpx/_urlparse.py,sha256=JvFjro7sdHohzXwybwYALTTGy2MakRpfFreBTQu9A4w,16669
-httpx/_urls.py,sha256=JAONd-2reXpB_WuQ7WuvhUcLuebiQeYJQPyszADmCow,21840
-httpx/_utils.py,sha256=jaCEUHN9jpHfoudrtSNxYTmTeRLeOrP-s-MOTvq23rA,15397
-httpx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
diff --git a/Backend/venv/lib/python3.12/site-packages/httpx-0.28.1.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/httpx-0.28.1.dist-info/INSTALLER
new file mode 100644
index 00000000..a1b589e3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/httpx-0.28.1.dist-info/INSTALLER
@@ -0,0 +1 @@
+pip
diff --git a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/httpx-0.28.1.dist-info/METADATA
similarity index 82%
rename from Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/METADATA
rename to Backend/venv/lib/python3.12/site-packages/httpx-0.28.1.dist-info/METADATA
index 84b89fb8..b0d2b196 100644
--- a/Backend/venv/lib/python3.12/site-packages/httpx-0.24.1.dist-info/METADATA
+++ b/Backend/venv/lib/python3.12/site-packages/httpx-0.28.1.dist-info/METADATA
@@ -1,14 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
Name: httpx
-Version: 0.24.1
+Version: 0.28.1
Summary: The next generation HTTP client.
Project-URL: Changelog, https://github.com/encode/httpx/blob/master/CHANGELOG.md
Project-URL: Documentation, https://www.python-httpx.org
Project-URL: Homepage, https://github.com/encode/httpx
Project-URL: Source, https://github.com/encode/httpx
Author-email: Tom Christie
-License-Expression: BSD-3-Clause
-License-File: LICENSE.md
+License: BSD-3-Clause
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
@@ -18,20 +17,20 @@ Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
-Requires-Python: >=3.7
+Requires-Python: >=3.8
+Requires-Dist: anyio
Requires-Dist: certifi
-Requires-Dist: httpcore<0.18.0,>=0.15.0
+Requires-Dist: httpcore==1.*
Requires-Dist: idna
-Requires-Dist: sniffio
Provides-Extra: brotli
-Requires-Dist: brotli; platform_python_implementation == 'CPython' and extra == 'brotli'
-Requires-Dist: brotlicffi; platform_python_implementation != 'CPython' and extra == 'brotli'
+Requires-Dist: brotli; (platform_python_implementation == 'CPython') and extra == 'brotli'
+Requires-Dist: brotlicffi; (platform_python_implementation != 'CPython') and extra == 'brotli'
Provides-Extra: cli
Requires-Dist: click==8.*; extra == 'cli'
Requires-Dist: pygments==2.*; extra == 'cli'
@@ -40,6 +39,8 @@ Provides-Extra: http2
Requires-Dist: h2<5,>=3; extra == 'http2'
Provides-Extra: socks
Requires-Dist: socksio==1.*; extra == 'socks'
+Provides-Extra: zstd
+Requires-Dist: zstandard>=0.18.0; extra == 'zstd'
Description-Content-Type: text/markdown
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+## Installation
+
+```bash
+pip install annotated-doc
+```
+
+Or with `uv`:
+
+```Python
+uv add annotated-doc
+```
+
+## Usage
+
+Import `Doc` and pass a single literal string with the documentation for the specific parameter, class attribute, return type, or variable.
+
+For example, to document a parameter `name` in a function `hi` you could do:
+
+```Python
+from typing import Annotated
+
+from annotated_doc import Doc
+
+def hi(name: Annotated[str, Doc("Who to say hi to")]) -> None:
+ print(f"Hi, {name}!")
+```
+
+You can also use it to document class attributes:
+
+```Python
+from typing import Annotated
+
+from annotated_doc import Doc
+
+class User:
+ name: Annotated[str, Doc("The user's name")]
+ age: Annotated[int, Doc("The user's age")]
+```
+
+The same way, you could document return types and variables, or anything that could have a type annotation with `Annotated`.
+
+## Who Uses This
+
+`annotated-doc` was made for:
+
+* [FastAPI](https://fastapi.tiangolo.com/)
+* [Typer](https://typer.tiangolo.com/)
+* [SQLModel](https://sqlmodel.tiangolo.com/)
+* [Asyncer](https://asyncer.tiangolo.com/)
+
+`annotated-doc` is supported by [griffe-typingdoc](https://github.com/mkdocstrings/griffe-typingdoc), which powers reference documentation like the one in the [FastAPI Reference](https://fastapi.tiangolo.com/reference/).
+
+## Reasons not to use `annotated-doc`
+
+You are already comfortable with one of the existing docstring formats, like:
+
+* Sphinx
+* numpydoc
+* Google
+* Keras
+
+Your team is already comfortable using them.
+
+You prefer having the documentation about parameters all together in a docstring, separated from the code defining them.
+
+You care about a specific set of users, using one specific editor, and that editor already has support for the specific docstring format you use.
+
+## Reasons to use `annotated-doc`
+
+* No micro-syntax to learn for newcomers, it’s **just Python** syntax.
+* **Editing** would be already fully supported by default by any editor (current or future) supporting Python syntax, including syntax errors, syntax highlighting, etc.
+* **Rendering** would be relatively straightforward to implement by static tools (tools that don't need runtime execution), as the information can be extracted from the AST they normally already create.
+* **Deduplication of information**: the name of a parameter would be defined in a single place, not duplicated inside of a docstring.
+* **Elimination** of the possibility of having **inconsistencies** when removing a parameter or class variable and **forgetting to remove** its documentation.
+* **Minimization** of the probability of adding a new parameter or class variable and **forgetting to add its documentation**.
+* **Elimination** of the possibility of having **inconsistencies** between the **name** of a parameter in the **signature** and the name in the docstring when it is renamed.
+* **Access** to the documentation string for each symbol at **runtime**, including existing (older) Python versions.
+* A more formalized way to document other symbols, like type aliases, that could use Annotated.
+* **Support** for apps using FastAPI, Typer and others.
+* **AI Accessibility**: AI tools will have an easier way understanding each parameter as the distance from documentation to parameter is much closer.
+
+## History
+
+I ([@tiangolo](https://github.com/tiangolo)) originally wanted for this to be part of the Python standard library (in [PEP 727](https://peps.python.org/pep-0727/)), but the proposal was withdrawn as there was a fair amount of negative feedback and opposition.
+
+The conclusion was that this was better done as an external effort, in a third-party library.
+
+So, here it is, with a simpler approach, as a third-party library, in a way that can be used by others, starting with FastAPI and friends.
+
+## License
+
+This project is licensed under the terms of the MIT license.
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/RECORD b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/RECORD
new file mode 100644
index 00000000..549e005a
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/RECORD
@@ -0,0 +1,11 @@
+annotated_doc-0.0.4.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
+annotated_doc-0.0.4.dist-info/METADATA,sha256=Irm5KJua33dY2qKKAjJ-OhKaVBVIfwFGej_dSe3Z1TU,6566
+annotated_doc-0.0.4.dist-info/RECORD,,
+annotated_doc-0.0.4.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
+annotated_doc-0.0.4.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+annotated_doc-0.0.4.dist-info/licenses/LICENSE,sha256=__Fwd5pqy_ZavbQFwIfxzuF4ZpHkqWpANFF-SlBKDN8,1086
+annotated_doc/__init__.py,sha256=VuyxxUe80kfEyWnOrCx_Bk8hybo3aKo6RYBlkBBYW8k,52
+annotated_doc/__pycache__/__init__.cpython-312.pyc,,
+annotated_doc/__pycache__/main.cpython-312.pyc,,
+annotated_doc/main.py,sha256=5Zfvxv80SwwLqpRW73AZyZyiM4bWma9QWRbp_cgD20s,1075
+annotated_doc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/WHEEL b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/WHEEL
new file mode 100644
index 00000000..045c8acd
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/WHEEL
@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.4.5)
+Root-Is-Purelib: true
+Tag: py3-none-any
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/entry_points.txt b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/entry_points.txt
new file mode 100644
index 00000000..c3ad4726
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/entry_points.txt
@@ -0,0 +1,4 @@
+[console_scripts]
+
+[gui_scripts]
+
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/licenses/LICENSE b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/licenses/LICENSE
new file mode 100644
index 00000000..7a254464
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/annotated_doc-0.0.4.dist-info/licenses/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sebastián Ramírez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc/__init__.py b/Backend/venv/lib/python3.12/site-packages/annotated_doc/__init__.py
new file mode 100644
index 00000000..a0152a7d
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/annotated_doc/__init__.py
@@ -0,0 +1,3 @@
+from .main import Doc as Doc
+
+__version__ = "0.0.4"
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc/__pycache__/__init__.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/annotated_doc/__pycache__/__init__.cpython-312.pyc
new file mode 100644
index 00000000..22cd974c
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/annotated_doc/__pycache__/__init__.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc/__pycache__/main.cpython-312.pyc b/Backend/venv/lib/python3.12/site-packages/annotated_doc/__pycache__/main.cpython-312.pyc
new file mode 100644
index 00000000..1d462977
Binary files /dev/null and b/Backend/venv/lib/python3.12/site-packages/annotated_doc/__pycache__/main.cpython-312.pyc differ
diff --git a/Backend/venv/lib/python3.12/site-packages/annotated_doc/main.py b/Backend/venv/lib/python3.12/site-packages/annotated_doc/main.py
new file mode 100644
index 00000000..7063c59e
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/annotated_doc/main.py
@@ -0,0 +1,36 @@
+class Doc:
+ """Define the documentation of a type annotation using `Annotated`, to be
+ used in class attributes, function and method parameters, return values,
+ and variables.
+
+ The value should be a positional-only string literal to allow static tools
+ like editors and documentation generators to use it.
+
+ This complements docstrings.
+
+ The string value passed is available in the attribute `documentation`.
+
+ Example:
+
+ ```Python
+ from typing import Annotated
+ from annotated_doc import Doc
+
+ def hi(name: Annotated[str, Doc("Who to say hi to")]) -> None:
+ print(f"Hi, {name}!")
+ ```
+ """
+
+ def __init__(self, documentation: str, /) -> None:
+ self.documentation = documentation
+
+ def __repr__(self) -> str:
+ return f"Doc({self.documentation!r})"
+
+ def __hash__(self) -> int:
+ return hash(self.documentation)
+
+ def __eq__(self, other: object) -> bool:
+ if not isinstance(other, Doc):
+ return NotImplemented
+ return self.documentation == other.documentation
diff --git a/Backend/venv/lib/python3.12/site-packages/Pillow-10.1.0.dist-info/REQUESTED b/Backend/venv/lib/python3.12/site-packages/annotated_doc/py.typed
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/Pillow-10.1.0.dist-info/REQUESTED
rename to Backend/venv/lib/python3.12/site-packages/annotated_doc/py.typed
diff --git a/Backend/venv/lib/python3.12/site-packages/Pillow-10.1.0.dist-info/INSTALLER b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/INSTALLER
similarity index 100%
rename from Backend/venv/lib/python3.12/site-packages/Pillow-10.1.0.dist-info/INSTALLER
rename to Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/INSTALLER
diff --git a/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/METADATA b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/METADATA
new file mode 100644
index 00000000..19aa46c3
--- /dev/null
+++ b/Backend/venv/lib/python3.12/site-packages/authlib-1.6.5.dist-info/METADATA
@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: Authlib
+Version: 1.6.5
+Summary: The ultimate Python library in building OAuth and OpenID Connect servers and clients.
+Author-email: Hsiaoming Yang 
+
+
+
+ 
-
- 
+
+ 
-
-
-
-
-
-
-
-
-
-
-
+
+
+### Gold and Silver Sponsors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -123,7 +152,7 @@ The key features are:
"_[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products._"
-