1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
|
"""
MeshBay Hub — SQLAlchemy 2.0 ORM models.
Tables:
users — registered users (identity + public keys)
nodes — node announcements
groups — group registry
group_members — group membership
refresh_tokens — hashed refresh tokens
ip_logs — connection log for legal compliance (1-year retention)
"""
import uuid
from datetime import UTC, datetime
from sqlalchemy import (
Boolean,
DateTime,
ForeignKey,
Index,
Integer,
String,
Text,
text,
)
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
def _now() -> datetime:
return datetime.now(UTC)
def _uuid() -> str:
return str(uuid.uuid4())
class Base(DeclarativeBase):
pass
# ── Users ─────────────────────────────────────────────────────────────────────
class User(Base):
__tablename__ = "users"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
username: Mapped[str] = mapped_column(String(64), unique=True, nullable=False)
email: Mapped[str] = mapped_column(String(256), nullable=False) # kept for recovery
pw_hash: Mapped[bytes] = mapped_column(nullable=False)
pw_salt: Mapped[bytes] = mapped_column(nullable=False)
pw_version: Mapped[int] = mapped_column(Integer, default=1)
# No user identity keys here. The hub published them and the invite flow
# wrapped the group key for whatever it returned, which is finding H3; since
# the node does the wrapping, nothing reads a key from this directory. Keys
# are generated per node and pinned there (meshbay_node/roster.py).
email_hash: Mapped[str | None] = mapped_column(String(64), nullable=True) # HMAC blind index
pk_node_ed25519: Mapped[str | None] = mapped_column(String(64), nullable=True)
hub_id: Mapped[str] = mapped_column(String(128), nullable=False)
# user|moderator|admin
role: Mapped[str] = mapped_column(String(16), default="user")
# active|suspended|revoked
status: Mapped[str] = mapped_column(String(16), default="active")
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
# The second half of what opens this account's keypair bundles on nodes
# (`auth.seal_pepper`, sealed at rest). A bundle is sealed under a key derived
# from the passphrase *and* this, so an operator holding one cannot test
# passphrase guesses offline: the pepper is handed only to a session that
# proved the passphrase or a device key, never to a node. Created the first
# time it is asked for; the version names which pepper sealed a bundle.
bundle_pepper: Mapped[str | None] = mapped_column(String(128), nullable=True)
bundle_pepper_version: Mapped[int] = mapped_column(Integer, default=1, server_default="1")
nodes: Mapped[list["Node"]] = relationship(back_populates="user")
group_memberships: Mapped[list["GroupMember"]] = relationship(back_populates="user")
refresh_tokens: Mapped[list["RefreshToken"]] = relationship(back_populates="user")
ip_logs: Mapped[list["IPLog"]] = relationship(back_populates="user")
__table_args__ = (
Index("ix_users_username", "username"),
Index("ix_users_email", "email"),
Index("ix_users_email_hash", "email_hash", unique=True),
)
# ── Nodes ─────────────────────────────────────────────────────────────────────
class Node(Base):
__tablename__ = "nodes"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
user_id: Mapped[str] = mapped_column(ForeignKey("users.id"), nullable=False)
pk_node: Mapped[str] = mapped_column(String(64), nullable=False) # Ed25519 b64
endpoint_hint: Mapped[str | None] = mapped_column(String(128)) # "ip:port" or null
# The address the hub saw this node connect from, recorded on an announce
# that carried a valid Ed25519 signature over a fresh timestamp. Unlike
# endpoint_hint — which the node discovers through STUN and sends us — this
# is observed rather than claimed, and it is the one to answer questions
# with. IPv4 or IPv6.
observed_ip: Mapped[str | None] = mapped_column(String(45))
last_seen: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
announced_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
user: Mapped["User"] = relationship(back_populates="nodes")
__table_args__ = (Index("ix_nodes_user_id", "user_id"),)
# ── Groups ────────────────────────────────────────────────────────────────────
class Group(Base):
__tablename__ = "groups"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
name: Mapped[str] = mapped_column(String(128), nullable=False)
admin_id: Mapped[str] = mapped_column(ForeignKey("users.id"), nullable=False)
visibility: Mapped[str] = mapped_column(String(16), default="private") # public|private
join_policy: Mapped[str] = mapped_column(String(16), default="invite") # open|request|invite
description: Mapped[str | None] = mapped_column(String(512))
# active|suspended|revoked
status: Mapped[str] = mapped_column(String(16), default="active")
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
# First time a node registered on /v1/nodes/ws announcing that it hosts this
# group. Until then the group has no files, no key and nobody to serve it, so
# it is shown to its owner only and is what `prune-groups` collects. Set once
# and never cleared: a node going offline does not un-host a group.
hosted_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
last_activity_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True), default=_now, nullable=False)
members: Mapped[list["GroupMember"]] = relationship(back_populates="group")
__table_args__ = (
Index("ix_groups_name", "name"),
# One name per owner, case-insensitively. The group's identity stays its
# UUID; this is what makes `name@owner` a handle a human can rely on
# (two different owners may still both have a "photos"). Enforced in the
# DB so a race cannot slip a second one past the check in create_group.
Index("uq_groups_owner_name", "admin_id", text("lower(name)"), unique=True),
)
class GroupMember(Base):
__tablename__ = "group_members"
group_id: Mapped[str] = mapped_column(ForeignKey("groups.id"), primary_key=True)
user_id: Mapped[str] = mapped_column(ForeignKey("users.id"), primary_key=True)
# Set here rather than in the browser: a notification nobody wants should not
# be created at all. It used to be a checkbox in localStorage that nothing
# read, so muting a group did nothing whatsoever.
muted: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
joined_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
group: Mapped["Group"] = relationship(back_populates="members")
user: Mapped["User"] = relationship(back_populates="group_memberships")
class GroupInvitation(Base):
"""
Somebody asked to add this account to a group, and it has not said yes.
Separate from `GroupMember` on purpose. A membership row is what the hub
acts on — it lets an account's client dial the group's nodes, names the
group in the account's MNP tokens and lists the group in its sidebar and in
Search — and an owner could create one for any username, unasked. That made
any account able to have any other account's client connect to a node of
its choosing. So an owner's addition is an invitation until the invitee
accepts it; redeeming an invitation link, joining an open group and creating
a group are the account's own acts and still write the membership directly.
"""
__tablename__ = "group_invitations"
group_id: Mapped[str] = mapped_column(ForeignKey("groups.id"), primary_key=True)
user_id: Mapped[str] = mapped_column(ForeignKey("users.id"), primary_key=True)
invited_by: Mapped[str | None] = mapped_column(ForeignKey("users.id"))
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
__table_args__ = (Index("ix_group_invitations_user", "user_id"),)
class GroupHost(Base):
"""
A node the group's owner has approved as a host, refused, or not yet
answered (`approved` / `refused` / `pending`).
A node registers for the groups it claims, and clients connect to whichever
registered node answers first. Every member holds the group key, so a
member's node passes the handshake like the real host would: the ceiling on
what a node may claim cannot be "groups its account belongs to". It is
"groups its account owns", plus the nodes listed here as `approved`. A node
that claims a group it may not host is recorded `pending`, and the owner is
told, so a legitimate second host is one click away rather than refused.
"""
__tablename__ = "group_hosts"
group_id: Mapped[str] = mapped_column(ForeignKey("groups.id"), primary_key=True)
node_id: Mapped[str] = mapped_column(ForeignKey("nodes.id"), primary_key=True)
status: Mapped[str] = mapped_column(String(16), default="pending", nullable=False)
requested_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
decided_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
__table_args__ = (Index("ix_group_hosts_node", "node_id"),)
class GroupInviteLink(Base):
"""
The hub's half of an invitation link (docs/MESHBAY_DESIGN.md §7.3).
A link carries two secrets. The node's code decides whether someone gets the
group key, and the hub never sees it. This row decides whether someone may
*reach* the node at all — membership, which is all the hub has to give — for
the first account that redeems it. The ticket is stored as `sha256(ticket)`,
so a copy of this table opens nothing.
The address is optional and binds nothing: when the inviter gave one,
`email_masked` is what the owner's list shows (`al***@ex***.com`).
"""
__tablename__ = "group_invite_links"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
group_id: Mapped[str] = mapped_column(ForeignKey("groups.id"), nullable=False)
created_by: Mapped[str] = mapped_column(ForeignKey("users.id"), nullable=False)
ticket_hash: Mapped[str] = mapped_column(String(64), nullable=False)
email_masked: Mapped[str | None] = mapped_column(String(128))
# The node's handle for its half, so cancelling can take back both.
node_invite_id: Mapped[str] = mapped_column(String(32), nullable=False, default="")
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
expires_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
redeemed_by: Mapped[str | None] = mapped_column(ForeignKey("users.id"))
redeemed_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
__table_args__ = (
Index("uq_invite_links_ticket", "ticket_hash", unique=True),
Index("ix_invite_links_group", "group_id"),
)
# ── Refresh tokens ────────────────────────────────────────────────────────────
class RefreshToken(Base):
__tablename__ = "refresh_tokens"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
user_id: Mapped[str] = mapped_column(ForeignKey("users.id"), nullable=False)
token_hash: Mapped[str] = mapped_column(String(64), unique=True, nullable=False) # blake3 hex
family_id: Mapped[str] = mapped_column(String(36), nullable=False, default=_uuid)
expires_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
revoked: Mapped[bool] = mapped_column(Boolean, default=False)
user: Mapped["User"] = relationship(back_populates="refresh_tokens")
__table_args__ = (
Index("ix_refresh_tokens_hash", "token_hash"),
Index("ix_refresh_tokens_family", "family_id"),
)
# ── IP logs (legal compliance) ────────────────────────────────────────────────
class HubPeer(Base):
"""Trusted peer hub for MHP federation."""
__tablename__ = "hub_peers"
hub_id: Mapped[str] = mapped_column(String(128), primary_key=True)
hub_url: Mapped[str] = mapped_column(String(256), nullable=False)
pk_hub_pem: Mapped[str] = mapped_column(Text, nullable=False)
trusted_since: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
class FederatedGroup(Base):
"""
Groups received from peer hubs via MHP federation.
Included in public /v1/groups search results with hub_id attribution.
"""
__tablename__ = "federated_groups"
id: Mapped[str] = mapped_column(String(36), primary_key=True)
name: Mapped[str] = mapped_column(String(128), nullable=False)
source_hub: Mapped[str] = mapped_column(String(128), nullable=False)
join_policy: Mapped[str] = mapped_column(String(16), default="invite")
received_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
updated_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
__table_args__ = (
Index("ix_federated_groups_source", "source_hub"),
Index("ix_federated_groups_name", "name"),
)
class UserDevice(Base):
"""
A device's key for authenticating **to the hub**, and nothing else.
This is not a reintroduction of the key directory that was H3, and the
distinction is worth being precise about because it looks like one:
* **Nobody reads this but the hub.** No endpoint publishes it, nothing
wraps a group key for it, and no node ever asks for it. H3 was a
directory *others* read from, where a substituted key was handed the
GEK by an honest member.
* **It is not a node identity key.** Those are generated per node, pinned
there, and never leave that relationship (`docs/MESHBAY_DESIGN.md` §3.2).
A device holds one of these *plus* a different key per node, so nothing
here correlates a person across operators.
What it does cost, stated plainly: the hub now knows how many devices an
account has and when each one last signed in. That is new metadata, and it
is the price of not deriving a key from the passphrase on every sign-in.
"""
__tablename__ = "user_devices"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
user_id: Mapped[str] = mapped_column(ForeignKey("users.id"), nullable=False)
# base64 raw Ed25519, unique so one device key belongs to one account
pk_auth_ed25519: Mapped[str] = mapped_column(String(64), unique=True, nullable=False)
label: Mapped[str] = mapped_column(String(64), default="")
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
last_seen: Mapped[datetime | None] = mapped_column(
DateTime(timezone=True), nullable=True)
__table_args__ = (Index("ix_user_devices_user", "user_id"),)
class Notification(Base):
__tablename__ = "notifications"
id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
user_id: Mapped[str] = mapped_column(ForeignKey("users.id"), nullable=False)
kind: Mapped[str] = mapped_column(String(32), nullable=False)
# Which group this is about, when it is about one. Chat keeps a single row per
# group and moves its date, so a busy conversation is one line that says when
# it last spoke — not forty lines saying it spoke.
group_id: Mapped[str | None] = mapped_column(ForeignKey("groups.id"))
title: Mapped[str] = mapped_column(String(256), nullable=False)
detail: Mapped[str | None] = mapped_column(String(512))
link: Mapped[str | None] = mapped_column(String(256))
read: Mapped[bool] = mapped_column(Boolean, default=False)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
user: Mapped["User"] = relationship()
__table_args__ = (
Index("ix_notifications_user", "user_id"),
Index("ix_notifications_created", "created_at"),
)
class ContentReport(Base):
"""
Report of a public content hash for moderation.
Two reports → automatic suspension. Third → admin review needed.
"""
__tablename__ = "content_reports"
id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
reporter_id: Mapped[str | None] = mapped_column(ForeignKey("users.id"))
content_hash: Mapped[str] = mapped_column(String(64), nullable=False) # blake3 hex
group_id: Mapped[str | None] = mapped_column(ForeignKey("groups.id"))
reason: Mapped[str] = mapped_column(String(32), default="illegal")
detail: Mapped[str | None] = mapped_column(String(256))
ip_address: Mapped[str] = mapped_column(String(45), nullable=False)
reported_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
__table_args__ = (
Index("ix_content_reports_hash", "content_hash"),
Index("ix_content_reports_group", "group_id"),
)
class ContentBlocklist(Base):
"""
Hash-based blocklist for public content.
Populated automatically after threshold reports, or manually by admins.
"""
__tablename__ = "content_blocklist"
content_hash: Mapped[str] = mapped_column(String(64), primary_key=True)
reason: Mapped[str] = mapped_column(String(64), nullable=False)
added_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
added_by: Mapped[str | None] = mapped_column(String(64)) # "auto" or admin username
class ContentReview(Base):
"""
A reported hash waiting for — or given — an administrator's decision.
Opened when enough distinct accounts have reported it; `status` is
`pending`, then `blocked` or `dismissed`. A dismissed hash stays dismissed:
more reports of it do not reopen it, and an administrator can still block
it from the blocklist. The reports themselves stay in `content_reports`.
"""
__tablename__ = "content_reviews"
content_hash: Mapped[str] = mapped_column(String(64), primary_key=True)
status: Mapped[str] = mapped_column(String(16), default="pending")
opened_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
decided_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
decided_by: Mapped[str | None] = mapped_column(String(64))
class UserPreference(Base):
__tablename__ = "user_preferences"
user_id: Mapped[str] = mapped_column(
String(36), ForeignKey("users.id"), primary_key=True)
key: Mapped[str] = mapped_column(String(64), primary_key=True)
value: Mapped[str] = mapped_column(Text, nullable=False)
class MailQuota(Base):
"""How much mail has gone where, kept across restarts.
This was a pair of dicts in `mail.py`, which meant a restart handed out a
fresh allowance — and a hub restarts whenever it is deployed. A budget a
restart forgets is not a budget, for the same reason the denylist is
persisted rather than held in memory (S3).
One row per thing being counted:
`hour` the instance's hourly total
`dest:<hash>` one recipient, hashed — this table must not become a
list of plaintext addresses (S2)
"""
__tablename__ = "mail_quota"
key: Mapped[str] = mapped_column(String(64), primary_key=True)
window_start: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
count: Mapped[int] = mapped_column(Integer, default=0)
last_sent: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
class KnownBrowser(Base):
"""A browser this account has signed in from, for the sign-in lockout.
Its own failure counter, which a stranger cannot spend: the lockout keyed by
username alone let anyone who knew a name keep its owner out of every
browser, four requests an hour. Only a hash of the token is kept. It is not
a credential — a sign-in presenting it still needs the passphrase.
"""
__tablename__ = "known_browsers"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
user_id: Mapped[str] = mapped_column(ForeignKey("users.id"), nullable=False,
index=True)
token_hash: Mapped[str] = mapped_column(String(64), unique=True, nullable=False)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
last_used_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
class LoginThrottle(Base):
"""Wrong passphrases per username, for the sign-in lockout (`login_throttle.py`).
Keyed by a hash of the name as typed rather than by account, so an unknown
name is counted — and locked — exactly like a real one (M1), and so a
passphrase typed into the username field is never stored. Rows age out with
the lockout window and are purged by the cleanup task.
"""
__tablename__ = "login_throttle"
key: Mapped[str] = mapped_column(String(64), primary_key=True)
failures: Mapped[int] = mapped_column(Integer, nullable=False, default=0)
last_failure_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
class AdminPin(Base):
"""
Which account an allow-listed admin name (`hub.toml` `admin_usernames`)
belongs to, recorded the first time an active account holds it.
The allow-list names people by username, and a username is not an identity:
deleting an account releases its name, and whoever registered it next
inherited the admin role. The allow-list now grants the pinned
account, so a name that changes hands grants nothing. No foreign key, on
purpose: the pin has to outlive the account it points at, or the name would
be free to pin again. A name removed from the allow-list loses its pin at
the next start, which is how an operator hands a listed name to a new
account.
"""
__tablename__ = "admin_pins"
username: Mapped[str] = mapped_column(String(64), primary_key=True)
user_id: Mapped[str] = mapped_column(String(36), nullable=False)
pinned_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
class HubSetting(Base):
"""
Instance-wide settings an admin changes at runtime from the panel.
Deliberately a key/value table rather than fields in `hub.toml`: the config
file is read once at boot and editing it means an SSH session and a restart,
which is not what "toggle this from the admin page" means. Anything here is a
policy the running hub can change on itself.
Absent key ⇒ the built-in default (see `meshbay_hub.hub_settings`). An older
hub with no row behaves exactly as it did before the setting existed.
"""
__tablename__ = "hub_settings"
key: Mapped[str] = mapped_column(String(64), primary_key=True)
value: Mapped[str] = mapped_column(Text, nullable=False)
updated_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True), default=_now, onupdate=_now)
class IPLog(Base):
"""
Connection log for legal compliance.
Retention: minimum 1 year (LCEN / EU e-Commerce Directive).
Events: account_create, login, login_fail, group_create, group_join, group_leave,
node_announce, token_refresh.
"""
__tablename__ = "ip_logs"
id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
# null for failed logins
user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id"))
# The name this account had, written when it is deleted. The username is
# released on deletion and the row itself is tombstoned, so the join that
# normally supplies the name would answer "deleted-3f9a1c" for exactly the
# records the log exists to answer questions about.
username: Mapped[str | None] = mapped_column(String(64))
event: Mapped[str] = mapped_column(String(32), nullable=False)
ip_address: Mapped[str] = mapped_column(String(45), nullable=False) # IPv4 or IPv6
# e.g. username on fail
detail: Mapped[str | None] = mapped_column(String(256))
timestamp: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
user: Mapped["User | None"] = relationship(back_populates="ip_logs")
__table_args__ = (
Index("ix_ip_logs_user_id", "user_id"),
Index("ix_ip_logs_timestamp", "timestamp"),
Index("ix_ip_logs_ip", "ip_address"),
)
class EmailVerification(Base):
"""
One-time codes for email verification.
Purposes:
- registration: confirm the address at sign-up (account stays pending until verified)
- email_change: confirm a new address before it replaces the old one
- invitation: notify an invitee with the group invite code
"""
__tablename__ = "email_verifications"
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=_uuid)
email_hash: Mapped[str] = mapped_column(String(64), nullable=False)
email_encrypted: Mapped[str | None] = mapped_column(String(256))
code: Mapped[str] = mapped_column(String(16), nullable=False)
purpose: Mapped[str] = mapped_column(String(16), nullable=False)
user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id"))
group_id: Mapped[str | None] = mapped_column(ForeignKey("groups.id"))
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=_now)
expires_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
verified_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
attempts: Mapped[int] = mapped_column(Integer, default=0)
__table_args__ = (
Index("ix_email_verif_hash", "email_hash"),
Index("ix_email_verif_user", "user_id"),
)
|