def test_delete_on_bind(self):
"""Tests that 3PID invite tokens are deleted upon delivery after a successful
bind.
"""
self.sydent.run()
# The 3PID we're working with.
medium = "email"
address = "*****@*****.**"
# Mock post_json_get_nothing so the /onBind call doesn't fail.
async def post_json_get_nothing(uri, post_json, opts):
return Response((b"HTTP", 1, 1), 200, b"OK", None, None)
FederationHttpClient.post_json_get_nothing = Mock(
side_effect=post_json_get_nothing, )
# Manually insert an invite token, we'll check later that it's been deleted.
join_token_store = JoinTokenStore(self.sydent)
join_token_store.storeToken(
medium,
address,
"!someroom:example.com",
"@jane:example.com",
"sometoken",
)
# Make sure the token still exists and can be retrieved.
tokens = join_token_store.getTokens(medium, address)
self.assertEqual(len(tokens), 1, tokens)
# Bind the 3PID
self.sydent.threepidBinder.addBinding(
medium,
address,
"@john:example.com",
)
# Give Sydent some time to call /onBind and delete the token.
self.sydent.reactor.advance(1000)
cur = self.sydent.db.cursor()
# Manually retrieve the tokens for this 3PID. We don't use getTokens because it
# filters out sent tokens, so would return nothing even if the token hasn't been
# deleted.
res = cur.execute(
"SELECT medium, address, room_id, sender, token FROM invite_tokens"
" WHERE medium = ? AND address = ?",
(
medium,
address,
),
)
rows = res.fetchall()
# Check that we didn't get any result.
self.assertEqual(len(rows), 0, rows)
def addBinding(self, medium, address, mxid):
"""Binds the given 3pid to the given mxid.
It's assumed that we have somehow validated that the given user owns
the given 3pid
Args:
medium (str): the type of 3pid
address (str): the 3pid
mxid (str): the mxid to bind it to
"""
localAssocStore = LocalAssociationStore(self.sydent)
createdAt = time_msec()
expires = createdAt + ThreepidBinder.THREEPID_ASSOCIATION_LIFETIME_MS
assoc = ThreepidAssociation(medium, address, mxid, createdAt,
createdAt, expires)
localAssocStore.addOrUpdateAssociation(assoc)
self.sydent.pusher.doLocalPush()
joinTokenStore = JoinTokenStore(self.sydent)
pendingJoinTokens = joinTokenStore.getTokens(medium, address)
invites = []
for token in pendingJoinTokens:
token["mxid"] = mxid
token["signed"] = {
"mxid": mxid,
"token": token["token"],
}
token["signed"] = signedjson.sign.sign_json(
token["signed"], self.sydent.server_name,
self.sydent.keyring.ed25519)
invites.append(token)
if invites:
assoc.extra_fields["invites"] = invites
joinTokenStore.markTokensAsSent(medium, address)
signer = Signer(self.sydent)
sgassoc = signer.signedThreePidAssociation(assoc)
self._notify(sgassoc, 0)
return sgassoc
def addBinding(self, medium, address, mxid):
"""Binds the given 3pid to the given mxid.
It's assumed that we have somehow validated that the given user owns
the given 3pid
Args:
medium (str): the type of 3pid
address (str): the 3pid
mxid (str): the mxid to bind it to
"""
localAssocStore = LocalAssociationStore(self.sydent)
createdAt = time_msec()
expires = createdAt + ThreepidBinder.THREEPID_ASSOCIATION_LIFETIME_MS
assoc = ThreepidAssociation(medium, address, mxid, createdAt, createdAt, expires)
localAssocStore.addOrUpdateAssociation(assoc)
self.sydent.pusher.doLocalPush()
joinTokenStore = JoinTokenStore(self.sydent)
pendingJoinTokens = joinTokenStore.getTokens(medium, address)
invites = []
for token in pendingJoinTokens:
token["mxid"] = mxid
token["signed"] = {
"mxid": mxid,
"token": token["token"],
}
token["signed"] = signedjson.sign.sign_json(token["signed"], self.sydent.server_name, self.sydent.keyring.ed25519)
invites.append(token)
if invites:
assoc.extra_fields["invites"] = invites
joinTokenStore.markTokensAsSent(medium, address)
signer = Signer(self.sydent)
sgassoc = signer.signedThreePidAssociation(assoc)
self._notify(sgassoc, 0)
return sgassoc
def addBinding(self, valSessionId, clientSecret, mxid):
valSessionStore = ThreePidValSessionStore(self.sydent)
localAssocStore = LocalAssociationStore(self.sydent)
s = valSessionStore.getValidatedSession(valSessionId, clientSecret)
createdAt = time_msec()
expires = createdAt + ThreepidBinder.THREEPID_ASSOCIATION_LIFETIME_MS
assoc = ThreepidAssociation(s.medium, s.address, mxid, createdAt,
createdAt, expires)
localAssocStore.addOrUpdateAssociation(assoc)
self.sydent.pusher.doLocalPush()
joinTokenStore = JoinTokenStore(self.sydent)
pendingJoinTokens = joinTokenStore.getTokens(s.medium, s.address)
invites = []
for token in pendingJoinTokens:
token["mxid"] = mxid
token["signed"] = {
"mxid": mxid,
"token": token["token"],
}
token["signed"] = signedjson.sign.sign_json(
token["signed"], self.sydent.server_name,
self.sydent.keyring.ed25519)
invites.append(token)
if invites:
assoc.extra_fields["invites"] = invites
joinTokenStore.markTokensAsSent(s.medium, s.address)
assocSigner = AssociationSigner(self.sydent)
sgassoc = assocSigner.signedThreePidAssociation(assoc)
self._notify(sgassoc, 0)
return sgassoc
def addBinding(self, valSessionId, clientSecret, mxid):
valSessionStore = ThreePidValSessionStore(self.sydent)
localAssocStore = LocalAssociationStore(self.sydent)
s = valSessionStore.getValidatedSession(valSessionId, clientSecret)
createdAt = time_msec()
expires = createdAt + ThreepidBinder.THREEPID_ASSOCIATION_LIFETIME_MS
assoc = ThreepidAssociation(s.medium, s.address, mxid, createdAt, createdAt, expires)
localAssocStore.addOrUpdateAssociation(assoc)
self.sydent.pusher.doLocalPush()
joinTokenStore = JoinTokenStore(self.sydent)
pendingJoinTokens = joinTokenStore.getTokens(s.medium, s.address)
invites = []
for token in pendingJoinTokens:
token["mxid"] = mxid
token["signed"] = {
"mxid": mxid,
"token": token["token"],
}
token["signed"] = signedjson.sign.sign_json(token["signed"], self.sydent.server_name, self.sydent.keyring.ed25519)
invites.append(token)
if invites:
assoc.extra_fields["invites"] = invites
joinTokenStore.markTokensAsSent(s.medium, s.address)
assocSigner = AssociationSigner(self.sydent)
sgassoc = assocSigner.signedThreePidAssociation(assoc)
self._notify(sgassoc, 0)
return sgassoc
def addBinding(self, medium, address, mxid):
"""
Binds the given 3pid to the given mxid.
It's assumed that we have somehow validated that the given user owns
the given 3pid
:param medium: The medium of the 3PID to bind.
:type medium: unicode
:param address: The address of the 3PID to bind.
:type address: unicode
:param mxid: The MXID to bind the 3PID to.
:type mxid: unicode
:return: The signed association.
:rtype: dict[str, any]
"""
localAssocStore = LocalAssociationStore(self.sydent)
# Fill out the association details
createdAt = time_msec()
expires = createdAt + ThreepidBinder.THREEPID_ASSOCIATION_LIFETIME_MS
# Hash the medium + address and store that hash for the purposes of
# later lookups
str_to_hash = u' '.join(
[address, medium,
self.hashing_store.get_lookup_pepper()], )
lookup_hash = sha256_and_url_safe_base64(str_to_hash)
assoc = ThreepidAssociation(
medium,
address,
lookup_hash,
mxid,
createdAt,
createdAt,
expires,
)
localAssocStore.addOrUpdateAssociation(assoc)
self.sydent.pusher.doLocalPush()
joinTokenStore = JoinTokenStore(self.sydent)
pendingJoinTokens = joinTokenStore.getTokens(medium, address)
invites = []
for token in pendingJoinTokens:
token["mxid"] = mxid
token["signed"] = {
"mxid": mxid,
"token": token["token"],
}
token["signed"] = signedjson.sign.sign_json(
token["signed"], self.sydent.server_name,
self.sydent.keyring.ed25519)
invites.append(token)
if invites:
assoc.extra_fields["invites"] = invites
joinTokenStore.markTokensAsSent(medium, address)
signer = Signer(self.sydent)
sgassoc = signer.signedThreePidAssociation(assoc)
self._notify(sgassoc, 0)
return sgassoc
def addBinding(self, medium: str, address: str,
mxid: str) -> Dict[str, Any]:
"""
Binds the given 3pid to the given mxid.
It's assumed that we have somehow validated that the given user owns
the given 3pid
:param medium: The medium of the 3PID to bind.
:param address: The address of the 3PID to bind.
:param mxid: The MXID to bind the 3PID to.
:return: The signed association.
"""
# ensure we casefold email address before storing
normalised_address = normalise_address(address, medium)
localAssocStore = LocalAssociationStore(self.sydent)
# Fill out the association details
createdAt = time_msec()
expires = createdAt + ThreepidBinder.THREEPID_ASSOCIATION_LIFETIME_MS
# Hash the medium + address and store that hash for the purposes of
# later lookups
lookup_pepper = self.hashing_store.get_lookup_pepper()
assert lookup_pepper is not None
str_to_hash = " ".join([normalised_address, medium, lookup_pepper], )
lookup_hash = sha256_and_url_safe_base64(str_to_hash)
assoc = ThreepidAssociation(
medium,
normalised_address,
lookup_hash,
mxid,
createdAt,
createdAt,
expires,
)
localAssocStore.addOrUpdateAssociation(assoc)
self.sydent.pusher.doLocalPush()
joinTokenStore = JoinTokenStore(self.sydent)
pendingJoinTokens = joinTokenStore.getTokens(medium,
normalised_address)
invites = []
# Widen the value type to Any: we're going to set the signed key
# to point to a dict, but pendingJoinTokens yields Dict[str, str]
token: Dict[str, Any]
for token in pendingJoinTokens:
token["mxid"] = mxid
presigned = {
"mxid": mxid,
"token": token["token"],
}
token["signed"] = signedjson.sign.sign_json(
presigned,
self.sydent.config.general.server_name,
self.sydent.keyring.ed25519,
)
invites.append(token)
if invites:
assoc.extra_fields["invites"] = invites
joinTokenStore.markTokensAsSent(medium, normalised_address)
signer = Signer(self.sydent)
sgassoc = signer.signedThreePidAssociation(assoc)
defer.ensureDeferred(self._notify(sgassoc, 0))
return sgassoc