epicyon/capabilities.py

321 lines
11 KiB
Python
Raw Normal View History

__filename__ = "capabilities.py"
__author__ = "Bob Mottram"
__license__ = "AGPL3+"
2019-08-29 13:35:29 +00:00
__version__ = "1.0.0"
__maintainer__ = "Bob Mottram"
__email__ = "bob@freedombone.net"
__status__ = "Production"
2019-07-06 09:07:24 +00:00
import os
2019-07-07 11:53:32 +00:00
import datetime
import time
import json
import commentjson
from auth import createPassword
from utils import getNicknameFromActor
from utils import getDomainFromActor
2019-07-07 15:51:04 +00:00
def getOcapFilename(baseDir :str,nickname: str,domain: str,actor :str,subdir: str) -> str:
2019-07-09 14:20:23 +00:00
"""Returns the filename for a particular capability accepted or granted
Also creates directories as needed
"""
2019-08-18 20:43:10 +00:00
if not actor:
return None
if ':' in domain:
domain=domain.split(':')[0]
2019-07-07 16:33:59 +00:00
if not os.path.isdir(baseDir+'/accounts'):
os.mkdir(baseDir+'/accounts')
2019-07-07 15:51:04 +00:00
2019-07-07 16:33:59 +00:00
ocDir=baseDir+'/accounts/'+nickname+'@'+domain
if not os.path.isdir(ocDir):
os.mkdir(ocDir)
ocDir=baseDir+'/accounts/'+nickname+'@'+domain+'/ocap'
if not os.path.isdir(ocDir):
os.mkdir(ocDir)
ocDir=baseDir+'/accounts/'+nickname+'@'+domain+'/ocap/'+subdir
if not os.path.isdir(ocDir):
os.mkdir(ocDir)
2019-08-11 18:32:29 +00:00
2019-07-07 16:33:59 +00:00
return baseDir+'/accounts/'+nickname+'@'+domain+'/ocap/'+subdir+'/'+actor.replace('/','#')+'.json'
2019-07-07 11:53:32 +00:00
2019-07-07 22:06:46 +00:00
def CapablePost(postJson: {}, capabilityList: [], debug :bool) -> bool:
"""Determines whether a post arriving in the inbox
should be accepted accoring to the list of capabilities
"""
if postJson.get('type'):
# No announces/repeats
if postJson['type']=='Announce':
if 'inbox:noannounce' in capabilityList:
if debug:
print('DEBUG: inbox post rejected because inbox:noannounce')
return False
# No likes
if postJson['type']=='Like':
if 'inbox:nolike' in capabilityList:
if debug:
print('DEBUG: inbox post rejected because inbox:nolike')
return False
if postJson['type']=='Create':
if postJson.get('object'):
# Does this have a reply?
if postJson['object'].get('inReplyTo'):
if postJson['object']['inReplyTo']:
if 'inbox:noreply' in capabilityList:
if debug:
print('DEBUG: inbox post rejected because inbox:noreply')
return False
# are content warnings enforced?
if postJson['object'].get('sensitive'):
if not postJson['object']['sensitive']:
if 'inbox:cw' in capabilityList:
if debug:
print('DEBUG: inbox post rejected because inbox:cw')
return False
# content warning must have non-zero summary
if postJson['object'].get('summary'):
if len(postJson['object']['summary'])<2:
if 'inbox:cw' in capabilityList:
if debug:
print('DEBUG: inbox post rejected because inbox:cw, summary missing')
return False
if 'inbox:write' in capabilityList:
return True
return True
2019-07-07 11:53:32 +00:00
def capabilitiesRequest(baseDir: str,httpPrefix: str,domain: str, \
requestedActor: str, \
requestedCaps=["inbox:write","objects:read"]) -> {}:
2019-07-06 09:07:24 +00:00
# This is sent to the capabilities endpoint /caps/new
# which could be instance wide or for a particular person
2019-07-07 11:53:32 +00:00
# This could also be added to a follow activity
ocapId=createPassword(32)
ocapRequest = {
2019-08-18 11:23:04 +00:00
"@context": "https://www.w3.org/ns/activitystreams",
2019-07-07 11:53:32 +00:00
"id": httpPrefix+"://"+requestedDomain+"/caps/request/"+ocapId,
"type": "Request",
2019-07-06 10:38:48 +00:00
"capability": requestedCaps,
2019-07-06 09:15:40 +00:00
"actor": requestedActor
2019-07-06 09:07:24 +00:00
}
2019-07-07 11:53:32 +00:00
return ocapRequest
2019-07-07 15:51:04 +00:00
2019-07-07 13:53:12 +00:00
def capabilitiesAccept(baseDir: str,httpPrefix: str, \
nickname: str,domain: str, port: int, \
2019-07-07 11:53:32 +00:00
acceptedActor: str, saveToFile: bool, \
acceptedCaps=["inbox:write","objects:read"]) -> {}:
2019-07-06 09:07:24 +00:00
# This gets returned to capabilities requester
2019-07-07 11:53:32 +00:00
# This could also be added to a follow Accept activity
# reject excessively long actors
if len(acceptedActor)>256:
return None
2019-07-07 13:53:12 +00:00
fullDomain=domain
if port:
if port!=80 and port !=443:
if ':' not in domain:
fullDomain=domain+':'+str(port)
2019-07-07 13:53:12 +00:00
2019-07-07 11:53:32 +00:00
# make directories to store capabilities
2019-07-07 15:51:04 +00:00
ocapFilename=getOcapFilename(baseDir,nickname,fullDomain,acceptedActor,'accept')
2019-08-18 20:43:10 +00:00
if not ocapFilename:
return None
2019-07-07 11:53:32 +00:00
ocapAccept=None
# if the capability already exists then load it from file
2019-07-07 15:51:04 +00:00
if os.path.isfile(ocapFilename):
2019-10-12 09:37:21 +00:00
tries=0
while tries<5:
try:
with open(ocapFilename, 'r') as fp:
ocapAccept=commentjson.load(fp)
break
except Exception as e:
2019-10-17 10:26:56 +00:00
print('WARN: commentjson exception capabilitiesAccept - '+str(e))
2019-10-12 09:37:21 +00:00
time.sleep(1)
tries+=1
2019-07-07 11:53:32 +00:00
# otherwise create a new capability
if not ocapAccept:
acceptedActorNickname=getNicknameFromActor(acceptedActor)
2019-09-02 09:43:43 +00:00
if not acceptedActorNickname:
print('WARN: unable to find nickname in '+acceptedActor)
return None
acceptedActorDomain,acceptedActorPort=getDomainFromActor(acceptedActor)
if acceptedActorPort:
ocapId=acceptedActorNickname+'@'+acceptedActorDomain+':'+str(acceptedActorPort)+'#'+createPassword(32)
else:
ocapId=acceptedActorNickname+'@'+acceptedActorDomain+'#'+createPassword(32)
2019-07-07 11:53:32 +00:00
ocapAccept = {
2019-08-18 11:23:04 +00:00
"@context": "https://www.w3.org/ns/activitystreams",
2019-07-07 13:53:12 +00:00
"id": httpPrefix+"://"+fullDomain+"/caps/"+ocapId,
2019-07-07 11:53:32 +00:00
"type": "Capability",
"capability": acceptedCaps,
"scope": acceptedActor,
2019-07-07 13:53:12 +00:00
"actor": httpPrefix+"://"+fullDomain
2019-07-07 11:53:32 +00:00
}
if nickname:
2019-07-07 13:53:12 +00:00
ocapAccept['actor']=httpPrefix+"://"+fullDomain+'/users/'+nickname
2019-07-06 09:07:24 +00:00
2019-07-07 11:53:32 +00:00
if saveToFile:
2019-10-12 09:37:21 +00:00
tries=0
while tries<5:
try:
with open(ocapFilename, 'w') as fp:
commentjson.dump(ocapAccept, fp, indent=4, sort_keys=False)
break
except Exception as e:
print(e)
time.sleep(1)
tries+=1
2019-07-07 11:53:32 +00:00
return ocapAccept
2019-07-07 15:51:04 +00:00
def capabilitiesGrantedSave(baseDir :str,nickname :str,domain :str,ocap: {}) -> bool:
2019-07-07 11:53:32 +00:00
"""A capabilities accept is received, so stor it for
reference when sending to the actor
"""
if not ocap.get('actor'):
return False
2019-07-07 16:06:38 +00:00
ocapFilename=getOcapFilename(baseDir,nickname,domain,ocap['actor'],'granted')
2019-08-18 20:43:10 +00:00
if not ocapFilename:
return False
2019-10-12 09:37:21 +00:00
tries=0
while tries<5:
try:
with open(ocapFilename, 'w') as fp:
commentjson.dump(ocap, fp, indent=4, sort_keys=False)
break
except Exception as e:
print(e)
time.sleep(1)
tries+=1
2019-07-07 11:53:32 +00:00
return True
2019-07-09 14:20:23 +00:00
def capabilitiesUpdate(baseDir: str,httpPrefix: str, \
nickname: str,domain: str, port: int, \
updateActor: str, \
updateCaps: []) -> {}:
"""Used to sends an update for a change of object capabilities
Note that the capability id gets changed with a new random token
so that the old capabilities can't continue to be used
"""
# reject excessively long actors
if len(updateActor)>256:
return None
fullDomain=domain
if port:
if port!=80 and port !=443:
if ':' not in domain:
fullDomain=domain+':'+str(port)
2019-07-09 14:20:23 +00:00
# Get the filename of the capability
ocapFilename=getOcapFilename(baseDir,nickname,fullDomain,updateActor,'accept')
2019-08-18 20:43:10 +00:00
if not ocapFilename:
return None
2019-07-09 14:20:23 +00:00
# The capability should already exist for it to be updated
if not os.path.isfile(ocapFilename):
return None
# create an update activity
ocapUpdate = {
2019-08-18 11:23:04 +00:00
"@context": "https://www.w3.org/ns/activitystreams",
2019-07-09 14:20:23 +00:00
'type': 'Update',
'actor': httpPrefix+'://'+fullDomain+'/users/'+nickname,
'to': [updateActor],
'cc': [],
'object': {}
}
# read the existing capability
2019-10-12 09:37:21 +00:00
tries=0
while tries<5:
try:
with open(ocapFilename, 'r') as fp:
ocapJson=commentjson.load(fp)
break
except Exception as e:
2019-10-17 10:26:56 +00:00
print('WARN: commentjson exception capabilitiesUpdate - '+str(e))
2019-10-12 09:37:21 +00:00
time.sleep(1)
tries+=1
2019-07-09 14:20:23 +00:00
# set the new capabilities list. eg. ["inbox:write","objects:read"]
ocapJson['capability']=updateCaps
# change the id, so that the old capabilities can't continue to be used
updateActorNickname=getNicknameFromActor(updateActor)
2019-09-02 09:43:43 +00:00
if not updateActorNickname:
print('WARN: unable to find nickname in '+updateActor)
return None
2019-07-09 14:20:23 +00:00
updateActorDomain,updateActorPort=getDomainFromActor(updateActor)
if updateActorPort:
ocapId=updateActorNickname+'@'+updateActorDomain+':'+str(updateActorPort)+'#'+createPassword(32)
else:
ocapId=updateActorNickname+'@'+updateActorDomain+'#'+createPassword(32)
ocapJson['id']=httpPrefix+"://"+fullDomain+"/caps/"+ocapId
ocapUpdate['object']=ocapJson
# save it again
2019-10-12 09:37:21 +00:00
tries=0
while tries<5:
try:
with open(ocapFilename, 'w') as fp:
commentjson.dump(ocapJson, fp, indent=4, sort_keys=False)
break
except Exception as e:
print(e)
time.sleep(1)
tries+=1
2019-09-30 22:39:02 +00:00
2019-07-09 14:20:23 +00:00
return ocapUpdate
def capabilitiesReceiveUpdate(baseDir :str, \
nickname :str,domain :str,port :int, \
actor :str, \
newCapabilitiesId :str, \
capabilityList :[], debug :bool) -> bool:
"""An update for a capability or the given actor has arrived
"""
ocapFilename= \
getOcapFilename(baseDir,nickname,domain,actor,'granted')
2019-08-18 20:43:10 +00:00
if not ocapFilename:
return False
2019-07-09 14:20:23 +00:00
if not os.path.isfile(ocapFilename):
if debug:
print('DEBUG: capabilities file not found during update')
print(ocapFilename)
return False
2019-09-30 22:39:02 +00:00
ocapJson=None
2019-10-12 09:37:21 +00:00
tries=0
while tries<5:
try:
with open(ocapFilename, 'r') as fp:
ocapJson=commentjson.load(fp)
break
except Exception as e:
2019-10-17 10:26:56 +00:00
print('WARN: commentjson exception capabilitiesReceiveUpdate - '+str(e))
2019-10-12 09:37:21 +00:00
time.sleep(1)
tries+=1
2019-09-30 22:39:02 +00:00
if ocapJson:
2019-07-09 14:20:23 +00:00
ocapJson['id']=newCapabilitiesId
ocapJson['capability']=capabilityList
2019-09-30 22:39:02 +00:00
2019-10-12 09:37:21 +00:00
tries=0
while tries<5:
try:
with open(ocapFilename, 'w') as fp:
commentjson.dump(ocapJson, fp, indent=4, sort_keys=False)
return True
except Exception as e:
print(e)
time.sleep(1)
tries+=1
2019-07-09 14:20:23 +00:00
return False