university-core 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. university_core-0.1.0/.gitignore +39 -0
  2. university_core-0.1.0/LICENSE +21 -0
  3. university_core-0.1.0/PKG-INFO +109 -0
  4. university_core-0.1.0/README.md +43 -0
  5. university_core-0.1.0/pyproject.toml +81 -0
  6. university_core-0.1.0/src/university/audit/__init__.py +9 -0
  7. university_core-0.1.0/src/university/audit/actions.py +80 -0
  8. university_core-0.1.0/src/university/audit/admin.py +39 -0
  9. university_core-0.1.0/src/university/audit/api/__init__.py +0 -0
  10. university_core-0.1.0/src/university/audit/api/v1/__init__.py +0 -0
  11. university_core-0.1.0/src/university/audit/api/v1/serializers.py +49 -0
  12. university_core-0.1.0/src/university/audit/api/v1/urls.py +12 -0
  13. university_core-0.1.0/src/university/audit/api/v1/views.py +41 -0
  14. university_core-0.1.0/src/university/audit/apps.py +76 -0
  15. university_core-0.1.0/src/university/audit/management/__init__.py +0 -0
  16. university_core-0.1.0/src/university/audit/management/commands/__init__.py +0 -0
  17. university_core-0.1.0/src/university/audit/management/commands/university_verify_audit.py +25 -0
  18. university_core-0.1.0/src/university/audit/migrations/0001_initial.py +60 -0
  19. university_core-0.1.0/src/university/audit/migrations/__init__.py +0 -0
  20. university_core-0.1.0/src/university/audit/models.py +137 -0
  21. university_core-0.1.0/src/university/audit/selectors.py +52 -0
  22. university_core-0.1.0/src/university/audit/services.py +132 -0
  23. university_core-0.1.0/src/university/audit/sinks.py +32 -0
  24. university_core-0.1.0/src/university/core/__init__.py +30 -0
  25. university_core-0.1.0/src/university/core/admin.py +34 -0
  26. university_core-0.1.0/src/university/core/api/__init__.py +1 -0
  27. university_core-0.1.0/src/university/core/api/exceptions.py +108 -0
  28. university_core-0.1.0/src/university/core/api/pagination.py +34 -0
  29. university_core-0.1.0/src/university/core/api/schema.py +107 -0
  30. university_core-0.1.0/src/university/core/api/serializers.py +50 -0
  31. university_core-0.1.0/src/university/core/api/throttling.py +60 -0
  32. university_core-0.1.0/src/university/core/api/urls.py +36 -0
  33. university_core-0.1.0/src/university/core/api/v1/__init__.py +0 -0
  34. university_core-0.1.0/src/university/core/api/v1/urls.py +11 -0
  35. university_core-0.1.0/src/university/core/api/v1/views.py +34 -0
  36. university_core-0.1.0/src/university/core/api/views.py +27 -0
  37. university_core-0.1.0/src/university/core/apps.py +39 -0
  38. university_core-0.1.0/src/university/core/audiences.py +77 -0
  39. university_core-0.1.0/src/university/core/checks.py +176 -0
  40. university_core-0.1.0/src/university/core/conf.py +155 -0
  41. university_core-0.1.0/src/university/core/content.py +168 -0
  42. university_core-0.1.0/src/university/core/context.py +40 -0
  43. university_core-0.1.0/src/university/core/crypto.py +101 -0
  44. university_core-0.1.0/src/university/core/declarations.py +98 -0
  45. university_core-0.1.0/src/university/core/defaults.py +294 -0
  46. university_core-0.1.0/src/university/core/events.py +205 -0
  47. university_core-0.1.0/src/university/core/exceptions.py +108 -0
  48. university_core-0.1.0/src/university/core/health.py +93 -0
  49. university_core-0.1.0/src/university/core/hooks.py +111 -0
  50. university_core-0.1.0/src/university/core/http.py +85 -0
  51. university_core-0.1.0/src/university/core/idempotency.py +132 -0
  52. university_core-0.1.0/src/university/core/ids.py +54 -0
  53. university_core-0.1.0/src/university/core/integrations/__init__.py +1 -0
  54. university_core-0.1.0/src/university/core/integrations/celery.py +21 -0
  55. university_core-0.1.0/src/university/core/integrations/django_tasks.py +14 -0
  56. university_core-0.1.0/src/university/core/logging.py +141 -0
  57. university_core-0.1.0/src/university/core/management/__init__.py +0 -0
  58. university_core-0.1.0/src/university/core/management/commands/__init__.py +0 -0
  59. university_core-0.1.0/src/university/core/management/commands/university_modules.py +29 -0
  60. university_core-0.1.0/src/university/core/management/commands/university_purge.py +30 -0
  61. university_core-0.1.0/src/university/core/media.py +81 -0
  62. university_core-0.1.0/src/university/core/middleware.py +82 -0
  63. university_core-0.1.0/src/university/core/migrations/0001_initial.py +62 -0
  64. university_core-0.1.0/src/university/core/migrations/__init__.py +0 -0
  65. university_core-0.1.0/src/university/core/models.py +171 -0
  66. university_core-0.1.0/src/university/core/modules.py +130 -0
  67. university_core-0.1.0/src/university/core/payables.py +98 -0
  68. university_core-0.1.0/src/university/core/providers/__init__.py +51 -0
  69. university_core-0.1.0/src/university/core/providers/email.py +76 -0
  70. university_core-0.1.0/src/university/core/providers/http.py +62 -0
  71. university_core-0.1.0/src/university/core/providers/search.py +62 -0
  72. university_core-0.1.0/src/university/core/providers/sms.py +106 -0
  73. university_core-0.1.0/src/university/core/providers/spam.py +90 -0
  74. university_core-0.1.0/src/university/core/ratelimit.py +128 -0
  75. university_core-0.1.0/src/university/core/registry.py +303 -0
  76. university_core-0.1.0/src/university/core/retention.py +90 -0
  77. university_core-0.1.0/src/university/core/serialization.py +39 -0
  78. university_core-0.1.0/src/university/core/settings.py +140 -0
  79. university_core-0.1.0/src/university/core/storage.py +41 -0
  80. university_core-0.1.0/src/university/core/tasks.py +199 -0
  81. university_core-0.1.0/src/university/core/testing.py +224 -0
  82. university_core-0.1.0/src/university/core/uploads.py +218 -0
  83. university_core-0.1.0/src/university/core/urls.py +50 -0
  84. university_core-0.1.0/src/university/core/webhooks.py +159 -0
  85. university_core-0.1.0/src/university/permissions/__init__.py +13 -0
  86. university_core-0.1.0/src/university/permissions/admin.py +41 -0
  87. university_core-0.1.0/src/university/permissions/api/__init__.py +0 -0
  88. university_core-0.1.0/src/university/permissions/api/v1/__init__.py +0 -0
  89. university_core-0.1.0/src/university/permissions/api/v1/serializers.py +60 -0
  90. university_core-0.1.0/src/university/permissions/api/v1/urls.py +16 -0
  91. university_core-0.1.0/src/university/permissions/api/v1/views.py +139 -0
  92. university_core-0.1.0/src/university/permissions/apps.py +60 -0
  93. university_core-0.1.0/src/university/permissions/drf.py +86 -0
  94. university_core-0.1.0/src/university/permissions/migrations/0001_initial.py +58 -0
  95. university_core-0.1.0/src/university/permissions/migrations/__init__.py +0 -0
  96. university_core-0.1.0/src/university/permissions/models.py +83 -0
  97. university_core-0.1.0/src/university/permissions/scopes.py +40 -0
  98. university_core-0.1.0/src/university/permissions/services.py +337 -0
  99. university_core-0.1.0/src/university/security/__init__.py +9 -0
  100. university_core-0.1.0/src/university/security/admin.py +70 -0
  101. university_core-0.1.0/src/university/security/api/__init__.py +0 -0
  102. university_core-0.1.0/src/university/security/api/v1/__init__.py +0 -0
  103. university_core-0.1.0/src/university/security/api/v1/serializers.py +133 -0
  104. university_core-0.1.0/src/university/security/api/v1/urls.py +28 -0
  105. university_core-0.1.0/src/university/security/api/v1/views.py +282 -0
  106. university_core-0.1.0/src/university/security/apps.py +96 -0
  107. university_core-0.1.0/src/university/security/authentication.py +105 -0
  108. university_core-0.1.0/src/university/security/context.py +22 -0
  109. university_core-0.1.0/src/university/security/detection.py +54 -0
  110. university_core-0.1.0/src/university/security/events.py +12 -0
  111. university_core-0.1.0/src/university/security/handlers.py +37 -0
  112. university_core-0.1.0/src/university/security/migrations/0001_initial.py +151 -0
  113. university_core-0.1.0/src/university/security/migrations/__init__.py +0 -0
  114. university_core-0.1.0/src/university/security/models.py +179 -0
  115. university_core-0.1.0/src/university/security/providers/__init__.py +40 -0
  116. university_core-0.1.0/src/university/security/providers/base.py +27 -0
  117. university_core-0.1.0/src/university/security/providers/oidc.py +73 -0
  118. university_core-0.1.0/src/university/security/schema.py +35 -0
  119. university_core-0.1.0/src/university/security/services/__init__.py +1 -0
  120. university_core-0.1.0/src/university/security/services/api_keys.py +140 -0
  121. university_core-0.1.0/src/university/security/services/external.py +94 -0
  122. university_core-0.1.0/src/university/security/services/lockout.py +81 -0
  123. university_core-0.1.0/src/university/security/services/login.py +180 -0
  124. university_core-0.1.0/src/university/security/services/mfa.py +66 -0
  125. university_core-0.1.0/src/university/security/services/otp.py +153 -0
  126. university_core-0.1.0/src/university/security/services/sessions.py +216 -0
  127. university_core-0.1.0/src/university/security/templates/university/security/email/login_alert.txt +11 -0
  128. university_core-0.1.0/src/university/security/templates/university/security/email/login_alert_subject.txt +2 -0
  129. university_core-0.1.0/src/university/security/templates/university/security/email/otp_code.txt +5 -0
  130. university_core-0.1.0/src/university/security/templates/university/security/email/otp_code_subject.txt +2 -0
  131. university_core-0.1.0/src/university/security/tokens.py +132 -0
  132. university_core-0.1.0/src/university/users/__init__.py +8 -0
  133. university_core-0.1.0/src/university/users/admin.py +147 -0
  134. university_core-0.1.0/src/university/users/api/__init__.py +0 -0
  135. university_core-0.1.0/src/university/users/api/v1/__init__.py +0 -0
  136. university_core-0.1.0/src/university/users/api/v1/serializers.py +199 -0
  137. university_core-0.1.0/src/university/users/api/v1/urls.py +36 -0
  138. university_core-0.1.0/src/university/users/api/v1/views.py +353 -0
  139. university_core-0.1.0/src/university/users/apps.py +54 -0
  140. university_core-0.1.0/src/university/users/backends.py +73 -0
  141. university_core-0.1.0/src/university/users/constants.py +47 -0
  142. university_core-0.1.0/src/university/users/events.py +14 -0
  143. university_core-0.1.0/src/university/users/managers.py +65 -0
  144. university_core-0.1.0/src/university/users/migrations/0001_initial.py +162 -0
  145. university_core-0.1.0/src/university/users/migrations/__init__.py +0 -0
  146. university_core-0.1.0/src/university/users/models.py +254 -0
  147. university_core-0.1.0/src/university/users/selectors.py +52 -0
  148. university_core-0.1.0/src/university/users/services/__init__.py +77 -0
  149. university_core-0.1.0/src/university/users/services/account.py +218 -0
  150. university_core-0.1.0/src/university/users/services/data.py +85 -0
  151. university_core-0.1.0/src/university/users/services/lifecycle.py +181 -0
  152. university_core-0.1.0/src/university/users/services/preferences.py +50 -0
  153. university_core-0.1.0/src/university/users/services/registration.py +155 -0
  154. university_core-0.1.0/src/university/users/services/verification.py +104 -0
  155. university_core-0.1.0/src/university/users/templates/university/users/email/confirm_email_change.txt +8 -0
  156. university_core-0.1.0/src/university/users/templates/university/users/email/confirm_email_change_subject.txt +2 -0
  157. university_core-0.1.0/src/university/users/templates/university/users/email/email_change_notice.txt +7 -0
  158. university_core-0.1.0/src/university/users/templates/university/users/email/email_change_notice_subject.txt +2 -0
  159. university_core-0.1.0/src/university/users/templates/university/users/email/email_changed.txt +7 -0
  160. university_core-0.1.0/src/university/users/templates/university/users/email/email_changed_subject.txt +2 -0
  161. university_core-0.1.0/src/university/users/templates/university/users/email/password_changed.txt +6 -0
  162. university_core-0.1.0/src/university/users/templates/university/users/email/password_changed_subject.txt +2 -0
  163. university_core-0.1.0/src/university/users/templates/university/users/email/password_reset.txt +8 -0
  164. university_core-0.1.0/src/university/users/templates/university/users/email/password_reset_subject.txt +2 -0
  165. university_core-0.1.0/src/university/users/templates/university/users/email/registration_existing_account.txt +9 -0
  166. university_core-0.1.0/src/university/users/templates/university/users/email/registration_existing_account_subject.txt +2 -0
  167. university_core-0.1.0/src/university/users/templates/university/users/email/verify_email.txt +8 -0
  168. university_core-0.1.0/src/university/users/templates/university/users/email/verify_email_subject.txt +2 -0
  169. university_core-0.1.0/src/university/users/tokens.py +63 -0
  170. university_core-0.1.0/src/university/users/validators.py +77 -0
  171. university_core-0.1.0/tests/__init__.py +0 -0
  172. university_core-0.1.0/tests/conftest.py +1 -0
  173. university_core-0.1.0/tests/fake_provider.py +21 -0
  174. university_core-0.1.0/tests/settings.py +9 -0
  175. university_core-0.1.0/tests/test_api_infrastructure.py +188 -0
  176. university_core-0.1.0/tests/test_infrastructure.py +410 -0
  177. university_core-0.1.0/tests/test_permissions_audit.py +245 -0
  178. university_core-0.1.0/tests/test_security.py +395 -0
  179. university_core-0.1.0/tests/test_users.py +396 -0
  180. university_core-0.1.0/tests/testapp/__init__.py +1 -0
  181. university_core-0.1.0/tests/testapp/apps.py +58 -0
  182. university_core-0.1.0/tests/testapp/state.py +2 -0
  183. university_core-0.1.0/tests/testapp/tasks.py +10 -0
  184. university_core-0.1.0/tests/testapp/urls.py +13 -0
  185. university_core-0.1.0/tests/testapp/views.py +68 -0
  186. university_core-0.1.0/tests/urls.py +7 -0
@@ -0,0 +1,39 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ .eggs/
6
+ build/
7
+ dist/
8
+ .venv/
9
+ venv/
10
+ .nox/
11
+ .tox/
12
+ .pytest_cache/
13
+ .mypy_cache/
14
+ .ruff_cache/
15
+ .coverage
16
+ coverage.xml
17
+ htmlcov/
18
+
19
+ # Django
20
+ *.sqlite3
21
+ # Local user uploads (never the university.media source package).
22
+ /media/
23
+ /private-media/
24
+ example_project/media/
25
+ example_project/private-media/
26
+ staticfiles/
27
+
28
+ # Secrets — never commit
29
+ .env
30
+ .env.*
31
+ !.env.example
32
+ *.pem
33
+ *.key
34
+
35
+ # Editors / OS
36
+ .idea/
37
+ .vscode/
38
+ .DS_Store
39
+ Thumbs.db
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) [YEAR] [COPYRIGHT HOLDER]
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,109 @@
1
+ Metadata-Version: 2.5
2
+ Name: university-core
3
+ Version: 0.1.0
4
+ Summary: University Core: the secure, modular foundation of an African campus platform built on Django REST Framework.
5
+ Project-URL: Homepage, https://github.com/NzeStan/University
6
+ Project-URL: Documentation, https://github.com/NzeStan/University/tree/main/docs
7
+ Project-URL: Source, https://github.com/NzeStan/University
8
+ Project-URL: Changelog, https://github.com/NzeStan/University/blob/main/CHANGELOG.md
9
+ Project-URL: Issues, https://github.com/NzeStan/University/issues
10
+ Author-email: Ifeanyi Stanley <nnamaniifeanyi10@gmail.com>
11
+ License-Expression: MIT
12
+ License-File: LICENSE
13
+ Keywords: africa,campus,django,drf,modular,nigeria,platform,rest,university
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Environment :: Web Environment
16
+ Classifier: Framework :: Django
17
+ Classifier: Framework :: Django :: 5.2
18
+ Classifier: Framework :: Django :: 6.0
19
+ Classifier: Framework :: Django :: 6.1
20
+ Classifier: Intended Audience :: Developers
21
+ Classifier: Operating System :: OS Independent
22
+ Classifier: Programming Language :: Python :: 3
23
+ Classifier: Programming Language :: Python :: 3 :: Only
24
+ Classifier: Programming Language :: Python :: 3.11
25
+ Classifier: Programming Language :: Python :: 3.12
26
+ Classifier: Programming Language :: Python :: 3.13
27
+ Classifier: Programming Language :: Python :: 3.14
28
+ Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
29
+ Classifier: Topic :: Security
30
+ Classifier: Typing :: Typed
31
+ Requires-Python: >=3.11
32
+ Requires-Dist: django<6.2,>=5.2
33
+ Requires-Dist: djangorestframework<4,>=3.15
34
+ Requires-Dist: pyjwt<3,>=2.8
35
+ Provides-Extra: all
36
+ Requires-Dist: argon2-cffi>=23.1; extra == 'all'
37
+ Requires-Dist: celery>=5.3; extra == 'all'
38
+ Requires-Dist: django-cors-headers>=4.3; extra == 'all'
39
+ Requires-Dist: drf-spectacular>=0.27; extra == 'all'
40
+ Requires-Dist: pillow>=10.0; extra == 'all'
41
+ Requires-Dist: psycopg[binary]>=3.1; extra == 'all'
42
+ Requires-Dist: pyjwt[crypto]<3,>=2.8; extra == 'all'
43
+ Requires-Dist: redis>=5.0; extra == 'all'
44
+ Provides-Extra: argon2
45
+ Requires-Dist: argon2-cffi>=23.1; extra == 'argon2'
46
+ Provides-Extra: celery
47
+ Requires-Dist: celery>=5.3; extra == 'celery'
48
+ Provides-Extra: cors
49
+ Requires-Dist: django-cors-headers>=4.3; extra == 'cors'
50
+ Provides-Extra: images
51
+ Requires-Dist: pillow>=10.0; extra == 'images'
52
+ Provides-Extra: oidc
53
+ Requires-Dist: pyjwt[crypto]<3,>=2.8; extra == 'oidc'
54
+ Provides-Extra: openapi
55
+ Requires-Dist: drf-spectacular>=0.27; extra == 'openapi'
56
+ Provides-Extra: postgres
57
+ Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'
58
+ Provides-Extra: redis
59
+ Requires-Dist: redis>=5.0; extra == 'redis'
60
+ Provides-Extra: test
61
+ Requires-Dist: drf-spectacular>=0.27; extra == 'test'
62
+ Requires-Dist: pytest-cov>=5; extra == 'test'
63
+ Requires-Dist: pytest-django>=4.8; extra == 'test'
64
+ Requires-Dist: pytest>=8; extra == 'test'
65
+ Description-Content-Type: text/markdown
66
+
67
+ # university-core
68
+
69
+ **The secure, modular foundation of the University platform**: a Django REST Framework
70
+ platform for African campus ecosystems (Nigeria-first, Africa-ready).
71
+
72
+ `university-core` is the *level one* package. It provides five Django apps that nearly every
73
+ installation needs:
74
+
75
+ | App | Provides |
76
+ | --- | --- |
77
+ | `university.core` | UUID base models, soft deletion, namespaced settings, module registry and plugins, event bus, hooks, task abstraction, provider adapters (email, SMS, search, anti-spam), distributed rate limiting, idempotency, signed webhooks, secure uploads, health checks, structured logging, versioned API infrastructure, system checks, data retention |
78
+ | `university.users` | Swappable custom user model, accounts, verification, privacy/notification/security settings, consent, data export, soft deletion with anonymisation |
79
+ | `university.security` | JWT access tokens + rotating refresh tokens with reuse detection, sessions/devices, scoped API keys, lockout, suspicious-login alerts, OTP, MFA, passwordless, OIDC |
80
+ | `university.permissions` | Scoped RBAC with hierarchy resolution and privilege-escalation protection |
81
+ | `university.audit` | Append-only, HMAC-signed audit log |
82
+
83
+ Optional features come from *level two* packages such as
84
+ [`university-institution`](https://pypi.org/project/university-institution/).
85
+
86
+ ## Install
87
+
88
+ ```bash
89
+ pip install "university-core[postgres,redis,celery,openapi,argon2]"
90
+ ```
91
+
92
+ ```python
93
+ from university.core import CORE_APPS
94
+ from university.core.settings import recommended_middleware, rest_framework_settings
95
+
96
+ INSTALLED_APPS = [..., "rest_framework", *CORE_APPS]
97
+ MIDDLEWARE = recommended_middleware()
98
+ REST_FRAMEWORK = rest_framework_settings()
99
+ AUTH_USER_MODEL = "university_users.User"
100
+ AUTHENTICATION_BACKENDS = ["university.users.backends.UniversityAuthBackend"]
101
+ ```
102
+
103
+ ```python
104
+ urlpatterns = [path("", include("university.core.urls"))] # /health/, /api/v1/, /api/docs/
105
+ ```
106
+
107
+ Supported versions: Python 3.11–3.14; Django 5.2, 6.0, 6.1; DRF 3.15+.
108
+
109
+ Documentation, security policy and source: https://github.com/NzeStan/University
@@ -0,0 +1,43 @@
1
+ # university-core
2
+
3
+ **The secure, modular foundation of the University platform**: a Django REST Framework
4
+ platform for African campus ecosystems (Nigeria-first, Africa-ready).
5
+
6
+ `university-core` is the *level one* package. It provides five Django apps that nearly every
7
+ installation needs:
8
+
9
+ | App | Provides |
10
+ | --- | --- |
11
+ | `university.core` | UUID base models, soft deletion, namespaced settings, module registry and plugins, event bus, hooks, task abstraction, provider adapters (email, SMS, search, anti-spam), distributed rate limiting, idempotency, signed webhooks, secure uploads, health checks, structured logging, versioned API infrastructure, system checks, data retention |
12
+ | `university.users` | Swappable custom user model, accounts, verification, privacy/notification/security settings, consent, data export, soft deletion with anonymisation |
13
+ | `university.security` | JWT access tokens + rotating refresh tokens with reuse detection, sessions/devices, scoped API keys, lockout, suspicious-login alerts, OTP, MFA, passwordless, OIDC |
14
+ | `university.permissions` | Scoped RBAC with hierarchy resolution and privilege-escalation protection |
15
+ | `university.audit` | Append-only, HMAC-signed audit log |
16
+
17
+ Optional features come from *level two* packages such as
18
+ [`university-institution`](https://pypi.org/project/university-institution/).
19
+
20
+ ## Install
21
+
22
+ ```bash
23
+ pip install "university-core[postgres,redis,celery,openapi,argon2]"
24
+ ```
25
+
26
+ ```python
27
+ from university.core import CORE_APPS
28
+ from university.core.settings import recommended_middleware, rest_framework_settings
29
+
30
+ INSTALLED_APPS = [..., "rest_framework", *CORE_APPS]
31
+ MIDDLEWARE = recommended_middleware()
32
+ REST_FRAMEWORK = rest_framework_settings()
33
+ AUTH_USER_MODEL = "university_users.User"
34
+ AUTHENTICATION_BACKENDS = ["university.users.backends.UniversityAuthBackend"]
35
+ ```
36
+
37
+ ```python
38
+ urlpatterns = [path("", include("university.core.urls"))] # /health/, /api/v1/, /api/docs/
39
+ ```
40
+
41
+ Supported versions: Python 3.11–3.14; Django 5.2, 6.0, 6.1; DRF 3.15+.
42
+
43
+ Documentation, security policy and source: https://github.com/NzeStan/University
@@ -0,0 +1,81 @@
1
+ [build-system]
2
+ requires = ["hatchling>=1.24"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "university-core"
7
+ dynamic = ["version"]
8
+ description = "University Core: the secure, modular foundation of an African campus platform built on Django REST Framework."
9
+ readme = "README.md"
10
+ license = "MIT"
11
+ license-files = ["LICENSE"]
12
+ requires-python = ">=3.11"
13
+ authors = [{ name = "Ifeanyi Stanley", email = "nnamaniifeanyi10@gmail.com" }]
14
+ keywords = ["django", "drf", "rest", "platform", "campus", "university", "africa", "nigeria", "modular"]
15
+ classifiers = [
16
+ "Development Status :: 3 - Alpha",
17
+ "Environment :: Web Environment",
18
+ "Framework :: Django",
19
+ "Framework :: Django :: 5.2",
20
+ "Framework :: Django :: 6.0",
21
+ "Framework :: Django :: 6.1",
22
+ "Intended Audience :: Developers",
23
+ "Operating System :: OS Independent",
24
+ "Programming Language :: Python :: 3",
25
+ "Programming Language :: Python :: 3 :: Only",
26
+ "Programming Language :: Python :: 3.11",
27
+ "Programming Language :: Python :: 3.12",
28
+ "Programming Language :: Python :: 3.13",
29
+ "Programming Language :: Python :: 3.14",
30
+ "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
31
+ "Topic :: Security",
32
+ "Typing :: Typed",
33
+ ]
34
+ dependencies = [
35
+ "Django>=5.2,<6.2",
36
+ "djangorestframework>=3.15,<4",
37
+ "PyJWT>=2.8,<3",
38
+ ]
39
+
40
+ [project.optional-dependencies]
41
+ postgres = ["psycopg[binary]>=3.1"]
42
+ redis = ["redis>=5.0"]
43
+ celery = ["celery>=5.3"]
44
+ openapi = ["drf-spectacular>=0.27"]
45
+ argon2 = ["argon2-cffi>=23.1"]
46
+ oidc = ["PyJWT[crypto]>=2.8,<3"]
47
+ images = ["Pillow>=10.0"]
48
+ cors = ["django-cors-headers>=4.3"]
49
+ all = ["university-core[postgres,redis,celery,openapi,argon2,oidc,images,cors]"]
50
+ test = [
51
+ "pytest>=8",
52
+ "pytest-django>=4.8",
53
+ "pytest-cov>=5",
54
+ "drf-spectacular>=0.27",
55
+ ]
56
+
57
+ [project.urls]
58
+ Homepage = "https://github.com/NzeStan/University"
59
+ Documentation = "https://github.com/NzeStan/University/tree/main/docs"
60
+ Source = "https://github.com/NzeStan/University"
61
+ Changelog = "https://github.com/NzeStan/University/blob/main/CHANGELOG.md"
62
+ Issues = "https://github.com/NzeStan/University/issues"
63
+
64
+ [tool.hatch.version]
65
+ path = "src/university/core/__init__.py"
66
+
67
+ [tool.hatch.build.targets.wheel]
68
+ # PEP 420 namespace package: there is deliberately no src/university/__init__.py
69
+ packages = ["src/university"]
70
+ exclude = ["**/__pycache__"]
71
+
72
+ [tool.hatch.build.targets.sdist]
73
+ include = ["src/university", "tests", "README.md", "LICENSE", "pyproject.toml"]
74
+
75
+ [tool.pytest.ini_options]
76
+ DJANGO_SETTINGS_MODULE = "tests.settings"
77
+ pythonpath = ["."]
78
+ testpaths = ["tests"]
79
+ addopts = "-ra --strict-markers"
80
+ markers = ["security: security regression tests", "slow: slow tests"]
81
+ filterwarnings = ["error::RuntimeWarning"]
@@ -0,0 +1,9 @@
1
+ """Append-only, tamper-evident audit logging for security-sensitive actions.
2
+
3
+ Public API::
4
+
5
+ from university.audit.services import record
6
+ from university.audit.actions import AuditAction
7
+
8
+ record(AuditAction.LOGIN_SUCCEEDED, actor=user, target=session)
9
+ """
@@ -0,0 +1,80 @@
1
+ """Audit action names used by University Core.
2
+
3
+ Modules define their own constants following the same ``<area>.<subject>.<verb>``
4
+ convention (e.g. ``anonymous.identity.revealed``). The first segment is the
5
+ default audit *category*.
6
+ """
7
+
8
+ from __future__ import annotations
9
+
10
+
11
+ class AuditCategory:
12
+ AUTH = "auth"
13
+ SECURITY = "security"
14
+ ACCOUNT = "account"
15
+ PRIVACY = "privacy"
16
+ PERMISSION = "permission"
17
+ MODERATION = "moderation"
18
+ ADMIN = "admin"
19
+ SYSTEM = "system"
20
+
21
+
22
+ class AuditOutcome:
23
+ SUCCESS = "success"
24
+ FAILURE = "failure"
25
+ DENIED = "denied"
26
+
27
+
28
+ class AuditAction:
29
+ # Authentication
30
+ LOGIN_SUCCEEDED = "auth.login.succeeded"
31
+ LOGIN_FAILED = "auth.login.failed"
32
+ LOGIN_LOCKED = "auth.login.locked"
33
+ LOGIN_MFA_CHALLENGED = "auth.login.mfa_challenged"
34
+ LOGOUT = "auth.logout"
35
+ TOKEN_REFRESHED = "auth.token.refreshed"
36
+ SESSION_REVOKED = "auth.session.revoked"
37
+ SESSIONS_REVOKED = "auth.sessions.revoked"
38
+ EXTERNAL_IDENTITY_LINKED = "auth.external_identity.linked"
39
+ EXTERNAL_IDENTITY_UNLINKED = "auth.external_identity.unlinked"
40
+
41
+ # Security
42
+ REFRESH_TOKEN_REUSED = "security.refresh_token.reused"
43
+ SUSPICIOUS_LOGIN = "security.login.suspicious"
44
+ API_KEY_CREATED = "security.api_key.created"
45
+ API_KEY_REVOKED = "security.api_key.revoked"
46
+ MFA_ENABLED = "security.mfa.enabled"
47
+ MFA_DISABLED = "security.mfa.disabled"
48
+ OTP_LOCKED = "security.otp.locked"
49
+
50
+ # Account
51
+ ACCOUNT_REGISTERED = "account.registered"
52
+ ACCOUNT_REGISTRATION_DUPLICATE = "account.registration.duplicate"
53
+ EMAIL_VERIFIED = "account.email.verified"
54
+ EMAIL_CHANGE_REQUESTED = "account.email.change_requested"
55
+ EMAIL_CHANGED = "account.email.changed"
56
+ PHONE_VERIFIED = "account.phone.verified"
57
+ PHONE_REMOVED = "account.phone.removed"
58
+ PASSWORD_CHANGED = "account.password.changed"
59
+ PASSWORD_RESET_REQUESTED = "account.password.reset_requested"
60
+ PASSWORD_RESET_COMPLETED = "account.password.reset_completed"
61
+ ACCOUNT_SUSPENDED = "account.suspended"
62
+ ACCOUNT_BANNED = "account.banned"
63
+ ACCOUNT_REACTIVATED = "account.reactivated"
64
+ ACCOUNT_DELETED = "account.deleted"
65
+ ACCOUNT_RESTORED = "account.restored"
66
+ ACCOUNT_PURGED = "account.purged"
67
+
68
+ # Privacy
69
+ DATA_EXPORTED = "privacy.data.exported"
70
+ CONSENT_RECORDED = "privacy.consent.recorded"
71
+
72
+ # Permissions
73
+ ROLE_ASSIGNED = "permission.role.assigned"
74
+ ROLE_REVOKED = "permission.role.revoked"
75
+ ROLE_CREATED = "permission.role.created"
76
+ ROLE_UPDATED = "permission.role.updated"
77
+ PERMISSION_DENIED = "permission.denied"
78
+
79
+ # Audit
80
+ AUDIT_LOG_VIEWED = "security.audit_log.viewed"
@@ -0,0 +1,39 @@
1
+ from __future__ import annotations
2
+
3
+ from typing import Any
4
+
5
+ from django.contrib import admin
6
+
7
+ from university.audit.models import AuditLog
8
+
9
+
10
+ class SecurityCategoryFilter(admin.SimpleListFilter):
11
+ title = "security events"
12
+ parameter_name = "security"
13
+
14
+ def lookups(self, request: Any, model_admin: Any) -> list[tuple[str, str]]:
15
+ return [("1", "Security & authentication only")]
16
+
17
+ def queryset(self, request: Any, queryset: Any) -> Any:
18
+ if self.value() == "1":
19
+ return queryset.filter(category__in=["auth", "security"])
20
+ return queryset
21
+
22
+
23
+ @admin.register(AuditLog)
24
+ class AuditLogAdmin(admin.ModelAdmin):
25
+ list_display = ("created_at", "action", "outcome", "actor_ref", "target_type", "target_id", "ip_address")
26
+ list_filter = (SecurityCategoryFilter, "category", "outcome", "action")
27
+ search_fields = ("action", "actor_ref", "target_id", "request_id")
28
+ date_hierarchy = "created_at"
29
+ readonly_fields = [f.name for f in AuditLog._meta.fields]
30
+ show_full_result_count = False
31
+
32
+ def has_add_permission(self, request: Any) -> bool:
33
+ return False
34
+
35
+ def has_change_permission(self, request: Any, obj: Any = None) -> bool:
36
+ return False
37
+
38
+ def has_delete_permission(self, request: Any, obj: Any = None) -> bool:
39
+ return False
@@ -0,0 +1,49 @@
1
+ from __future__ import annotations
2
+
3
+ from rest_framework import serializers
4
+
5
+ from university.audit.models import AuditLog
6
+ from university.core.api.serializers import StrictModelSerializer
7
+
8
+
9
+ class AuditLogSerializer(StrictModelSerializer):
10
+ class Meta:
11
+ model = AuditLog
12
+ fields = (
13
+ "id",
14
+ "created_at",
15
+ "action",
16
+ "category",
17
+ "outcome",
18
+ "actor_ref",
19
+ "target_type",
20
+ "target_id",
21
+ "scope_type",
22
+ "scope_id",
23
+ "ip_address",
24
+ "user_agent",
25
+ "request_id",
26
+ "metadata",
27
+ "entry_hash",
28
+ )
29
+ read_only_fields = fields
30
+
31
+
32
+ class ActivitySerializer(StrictModelSerializer):
33
+ """A user's own activity — no internal metadata."""
34
+
35
+ class Meta:
36
+ model = AuditLog
37
+ fields = ("id", "created_at", "action", "outcome", "ip_address", "user_agent")
38
+ read_only_fields = fields
39
+
40
+
41
+ class AuditFilterSerializer(serializers.Serializer):
42
+ action = serializers.CharField(required=False)
43
+ category = serializers.CharField(required=False)
44
+ outcome = serializers.CharField(required=False)
45
+ actor = serializers.UUIDField(required=False)
46
+ target_type = serializers.CharField(required=False)
47
+ target_id = serializers.CharField(required=False)
48
+ since = serializers.DateTimeField(required=False)
49
+ until = serializers.DateTimeField(required=False)
@@ -0,0 +1,12 @@
1
+ from __future__ import annotations
2
+
3
+ from django.urls import path
4
+
5
+ from university.audit.api.v1 import views
6
+
7
+ app_name = "audit"
8
+
9
+ urlpatterns = [
10
+ path("audit/logs/", views.AuditLogListView.as_view(), name="log-list"),
11
+ path("me/activity/", views.MyActivityView.as_view(), name="my-activity"),
12
+ ]
@@ -0,0 +1,41 @@
1
+ from __future__ import annotations
2
+
3
+ from typing import Any
4
+
5
+ from rest_framework import generics, permissions
6
+
7
+ from university.audit.api.v1.serializers import ActivitySerializer, AuditLogSerializer
8
+ from university.audit.selectors import activity_for_user, filter_audit_log
9
+ from university.core.api.pagination import CursorPagination
10
+ from university.core.api.schema import OpenApiParameter, extend_schema
11
+ from university.permissions.drf import require_permission
12
+
13
+
14
+ class AuditLogListView(generics.ListAPIView):
15
+ """Platform audit log (requires ``audit.view``)."""
16
+
17
+ serializer_class = AuditLogSerializer
18
+ permission_classes = [permissions.IsAuthenticated, require_permission("audit.view")]
19
+
20
+ @extend_schema(
21
+ parameters=[
22
+ OpenApiParameter(name, str, required=False)
23
+ for name in ("action", "category", "outcome", "actor", "target_type", "target_id", "since", "until")
24
+ ]
25
+ )
26
+ def get(self, request: Any, *args: Any, **kwargs: Any) -> Any:
27
+ return super().get(request, *args, **kwargs)
28
+
29
+ def get_queryset(self) -> Any:
30
+ return filter_audit_log(self.request.query_params)
31
+
32
+
33
+ class MyActivityView(generics.ListAPIView):
34
+ """The authenticated user's own security activity."""
35
+
36
+ serializer_class = ActivitySerializer
37
+ permission_classes = [permissions.IsAuthenticated]
38
+ pagination_class = CursorPagination
39
+
40
+ def get_queryset(self) -> Any:
41
+ return activity_for_user(self.request.user)
@@ -0,0 +1,76 @@
1
+ from __future__ import annotations
2
+
3
+ from collections.abc import Iterable
4
+ from typing import Any
5
+
6
+ from django.utils.translation import gettext_lazy as _
7
+
8
+ from university.core import __version__
9
+ from university.core.declarations import PermissionDef, RetentionPolicy, RoleDef
10
+ from university.core.hooks import Hook, HookRegistry
11
+ from university.core.modules import UniversityAppConfig
12
+
13
+
14
+ class AuditConfig(UniversityAppConfig):
15
+ name = "university.audit"
16
+ label = "university_audit"
17
+ verbose_name = _("University Audit")
18
+ module_name = "audit"
19
+ module_version = __version__
20
+ module_requires = ("core",)
21
+ api_urlconfs = {"v1": "university.audit.api.v1.urls"}
22
+
23
+ def get_permissions(self) -> Iterable[PermissionDef]:
24
+ return [
25
+ PermissionDef("audit.view", "View the platform audit log.", sensitive=True),
26
+ PermissionDef("audit.verify", "Verify audit log integrity."),
27
+ ]
28
+
29
+ def get_roles(self) -> Iterable[RoleDef]:
30
+ return [
31
+ RoleDef(
32
+ key="security_auditor",
33
+ name="Security auditor",
34
+ scope_type="platform",
35
+ permissions=("audit.*",),
36
+ description="Read-only access to the audit log.",
37
+ )
38
+ ]
39
+
40
+ def get_retention_policies(self) -> Iterable[RetentionPolicy]:
41
+ from university.audit.models import AuditLog
42
+ from university.core.retention import cutoff_days
43
+
44
+ def purge(cutoff: Any, dry_run: bool) -> int:
45
+ qs = AuditLog.objects.filter(created_at__lt=cutoff)
46
+ return qs.count() if dry_run else qs._purge()
47
+
48
+ return [
49
+ RetentionPolicy(
50
+ name="audit.log",
51
+ description="Audit log entries.",
52
+ setting="RETENTION.AUDIT_LOG_DAYS",
53
+ cutoff=cutoff_days("AUDIT_LOG_DAYS"),
54
+ purge=purge,
55
+ )
56
+ ]
57
+
58
+ def register_hooks(self, hooks: HookRegistry) -> None:
59
+ hooks.register(Hook.USER_EXPORT_DATA, export_user_activity)
60
+
61
+
62
+ def export_user_activity(user: Any) -> dict[str, Any]:
63
+ from university.audit.selectors import activity_for_user
64
+
65
+ return {
66
+ "security_activity": [
67
+ {
68
+ "action": e.action,
69
+ "outcome": e.outcome,
70
+ "created_at": e.created_at.isoformat(),
71
+ "ip_address": e.ip_address,
72
+ "user_agent": e.user_agent,
73
+ }
74
+ for e in activity_for_user(user)[:1000]
75
+ ]
76
+ }
@@ -0,0 +1,25 @@
1
+ from __future__ import annotations
2
+
3
+ from typing import Any
4
+
5
+ from django.core.management.base import BaseCommand, CommandError
6
+
7
+ from university.audit.services import verify_entries
8
+
9
+
10
+ class Command(BaseCommand):
11
+ help = "Verify the integrity of the audit log (per-entry HMACs and, if enabled, the hash chain)."
12
+
13
+ def add_arguments(self, parser: Any) -> None:
14
+ parser.add_argument("--chain", action="store_true", help="Also verify the hash chain.")
15
+ parser.add_argument("--limit", type=int, default=50, help="Maximum issues to print.")
16
+
17
+ def handle(self, *args: Any, **options: Any) -> None:
18
+ issues = 0
19
+ for issue in verify_entries(check_chain=options["chain"] or None):
20
+ issues += 1
21
+ if issues <= options["limit"]:
22
+ self.stderr.write(self.style.ERROR(f"{issue.entry_id}: {issue.problem}"))
23
+ if issues:
24
+ raise CommandError(f"Audit log verification failed: {issues} issue(s).")
25
+ self.stdout.write(self.style.SUCCESS("Audit log verified: no issues found."))