2022-05-22 21:44:32 +00:00
#!/usr/bin/env python3
# MIT License
#
# Copyright (c) 2016-2022 Mark Qvist / unsigned.io
#
# 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.
import RNS
import argparse
import time
import sys
import os
from RNS . _version import __version__
APP_NAME = " rncp "
allow_all = False
allowed_identity_hashes = [ ]
2022-07-02 07:33:05 +00:00
def receive ( configdir , verbosity = 0 , quietness = 0 , allowed = [ ] , display_identity = False , limit = None , disable_auth = None , disable_announce = False ) :
2022-05-22 21:44:32 +00:00
global allow_all , allowed_identity_hashes
identity = None
targetloglevel = 3 + verbosity - quietness
reticulum = RNS . Reticulum ( configdir = configdir , loglevel = targetloglevel )
identity_path = RNS . Reticulum . identitypath + " / " + APP_NAME
if os . path . isfile ( identity_path ) :
identity = RNS . Identity . from_file ( identity_path )
if identity == None :
RNS . log ( " No valid saved identity found, creating new... " , RNS . LOG_INFO )
identity = RNS . Identity ( )
identity . to_file ( identity_path )
destination = RNS . Destination ( identity , RNS . Destination . IN , RNS . Destination . SINGLE , APP_NAME , " receive " )
if display_identity :
print ( " Identity : " + str ( identity ) )
print ( " Receiving on : " + RNS . prettyhexrep ( destination . hash ) )
exit ( 0 )
if disable_auth :
allow_all = True
else :
if allowed != None :
for a in allowed :
try :
dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH / / 8 ) * 2
if len ( a ) != dest_len :
raise ValueError ( " Allowed destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes). " . format ( hex = dest_len , byte = dest_len / / 2 ) )
try :
destination_hash = bytes . fromhex ( a )
allowed_identity_hashes . append ( destination_hash )
except Exception as e :
raise ValueError ( " Invalid destination entered. Check your input. " )
except Exception as e :
print ( str ( e ) )
exit ( 1 )
if len ( allowed_identity_hashes ) < 1 and not disable_auth :
print ( " Warning: No allowed identities configured, rncp will not accept any files! " )
destination . set_link_established_callback ( receive_link_established )
print ( " rncp ready to receive on " + RNS . prettyhexrep ( destination . hash ) )
if not disable_announce :
destination . announce ( )
while True :
time . sleep ( 1 )
def receive_link_established ( link ) :
RNS . log ( " Incoming link established " , RNS . LOG_VERBOSE )
link . set_remote_identified_callback ( receive_sender_identified )
link . set_resource_strategy ( RNS . Link . ACCEPT_APP )
link . set_resource_callback ( receive_resource_callback )
link . set_resource_started_callback ( receive_resource_started )
link . set_resource_concluded_callback ( receive_resource_concluded )
def receive_sender_identified ( link , identity ) :
2022-07-02 07:48:15 +00:00
global allow_all
2022-05-22 21:44:32 +00:00
if identity . hash in allowed_identity_hashes :
RNS . log ( " Authenticated sender " , RNS . LOG_VERBOSE )
else :
2022-07-02 07:33:05 +00:00
if not allow_all :
RNS . log ( " Sender not allowed, tearing down link " , RNS . LOG_VERBOSE )
link . teardown ( )
else :
pass
2022-05-22 21:44:32 +00:00
def receive_resource_callback ( resource ) :
2022-07-02 07:48:15 +00:00
global allow_all
2022-05-22 21:44:32 +00:00
sender_identity = resource . link . get_remote_identity ( )
if sender_identity != None :
if sender_identity . hash in allowed_identity_hashes :
return True
2022-07-02 07:48:15 +00:00
if allow_all :
return True
2022-05-22 21:44:32 +00:00
return False
def receive_resource_started ( resource ) :
if resource . link . get_remote_identity ( ) :
id_str = " from " + RNS . prettyhexrep ( resource . link . get_remote_identity ( ) . hash )
else :
id_str = " "
print ( " Starting resource transfer " + RNS . prettyhexrep ( resource . hash ) + id_str )
def receive_resource_concluded ( resource ) :
if resource . status == RNS . Resource . COMPLETE :
print ( str ( resource ) + " completed " )
if resource . total_size > 4 :
filename_len = int . from_bytes ( resource . data . read ( 2 ) , " big " )
filename = resource . data . read ( filename_len ) . decode ( " utf-8 " )
counter = 0
saved_filename = filename
while os . path . isfile ( saved_filename ) :
counter + = 1
saved_filename = filename + " . " + str ( counter )
file = open ( saved_filename , " wb " )
file . write ( resource . data . read ( ) )
file . close ( )
else :
print ( " Invalid data received, ignoring resource " )
else :
print ( " Resource failed " )
resource_done = False
current_resource = None
stats = [ ]
speed = 0.0
def sender_progress ( resource ) :
stats_max = 32
global current_resource , stats , speed , resource_done
current_resource = resource
now = time . time ( )
got = current_resource . get_progress ( ) * current_resource . total_size
entry = [ now , got ]
stats . append ( entry )
while len ( stats ) > stats_max :
stats . pop ( 0 )
span = now - stats [ 0 ] [ 0 ]
if span == 0 :
speed = 0
else :
diff = got - stats [ 0 ] [ 1 ]
speed = diff / span
if resource . status < RNS . Resource . COMPLETE :
resource_done = False
else :
resource_done = True
link = None
def send ( configdir , verbosity = 0 , quietness = 0 , destination = None , file = None , timeout = RNS . Transport . PATH_REQUEST_TIMEOUT ) :
global current_resource , resource_done , link , speed
from tempfile import TemporaryFile
targetloglevel = 3 + verbosity - quietness
try :
dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH / / 8 ) * 2
if len ( destination ) != dest_len :
raise ValueError ( " Allowed destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes). " . format ( hex = dest_len , byte = dest_len / / 2 ) )
try :
destination_hash = bytes . fromhex ( destination )
except Exception as e :
raise ValueError ( " Invalid destination entered. Check your input. " )
except Exception as e :
print ( str ( e ) )
exit ( 1 )
file_path = os . path . expanduser ( file )
if not os . path . isfile ( file_path ) :
print ( " File not found " )
exit ( 1 )
temp_file = TemporaryFile ( )
real_file = open ( file_path , " rb " )
filename_bytes = os . path . basename ( file_path ) . encode ( " utf-8 " )
filename_len = len ( filename_bytes )
if filename_len > 0xFFFF :
print ( " Filename exceeds max size, cannot send " )
exit ( 1 )
else :
print ( " Preparing file... " , end = " " )
temp_file . write ( filename_len . to_bytes ( 2 , " big " ) )
temp_file . write ( filename_bytes )
temp_file . write ( real_file . read ( ) )
temp_file . seek ( 0 )
2022-06-30 12:02:57 +00:00
print ( " \r \r " , end = " " )
2022-05-22 21:44:32 +00:00
reticulum = RNS . Reticulum ( configdir = configdir , loglevel = targetloglevel )
identity_path = RNS . Reticulum . identitypath + " / " + APP_NAME
if os . path . isfile ( identity_path ) :
2023-05-31 13:39:55 +00:00
identity = RNS . Identity . from_file ( identity_path )
if identity == None :
RNS . log ( " Could not load identity for rncp. The identity file at \" " + str ( identity_path ) + " \" may be corrupt or unreadable. " , RNS . LOG_ERROR )
exit ( 2 )
else :
identity = None
2022-05-22 21:44:32 +00:00
if identity == None :
RNS . log ( " No valid saved identity found, creating new... " , RNS . LOG_INFO )
identity = RNS . Identity ( )
identity . to_file ( identity_path )
if not RNS . Transport . has_path ( destination_hash ) :
RNS . Transport . request_path ( destination_hash )
print ( " Path to " + RNS . prettyhexrep ( destination_hash ) + " requested " , end = " " )
sys . stdout . flush ( )
i = 0
syms = " ⢄⢂⢁⡁⡈⡐⡠ "
estab_timeout = time . time ( ) + timeout
while not RNS . Transport . has_path ( destination_hash ) and time . time ( ) < estab_timeout :
time . sleep ( 0.1 )
print ( ( " \b \b " + syms [ i ] + " " ) , end = " " )
sys . stdout . flush ( )
i = ( i + 1 ) % len ( syms )
if not RNS . Transport . has_path ( destination_hash ) :
2022-06-30 12:02:57 +00:00
print ( " \r \r Path not found " )
2022-05-22 21:44:32 +00:00
exit ( 1 )
else :
2022-06-30 12:02:57 +00:00
print ( " \r \r Establishing link with " + RNS . prettyhexrep ( destination_hash ) + " " , end = " " )
2022-05-22 21:44:32 +00:00
receiver_identity = RNS . Identity . recall ( destination_hash )
receiver_destination = RNS . Destination (
receiver_identity ,
RNS . Destination . OUT ,
RNS . Destination . SINGLE ,
APP_NAME ,
" receive "
)
link = RNS . Link ( receiver_destination )
while link . status != RNS . Link . ACTIVE and time . time ( ) < estab_timeout :
time . sleep ( 0.1 )
print ( ( " \b \b " + syms [ i ] + " " ) , end = " " )
sys . stdout . flush ( )
i = ( i + 1 ) % len ( syms )
if not RNS . Transport . has_path ( destination_hash ) :
2022-06-30 12:02:57 +00:00
print ( " \r \r Could not establish link with " + RNS . prettyhexrep ( destination_hash ) )
2022-05-22 21:44:32 +00:00
exit ( 1 )
else :
2022-06-30 12:02:57 +00:00
print ( " \r \r Advertising file resource " , end = " " )
2022-05-22 21:44:32 +00:00
link . identify ( identity )
resource = RNS . Resource ( temp_file , link , callback = sender_progress , progress_callback = sender_progress )
current_resource = resource
while resource . status < RNS . Resource . TRANSFERRING :
time . sleep ( 0.1 )
print ( ( " \b \b " + syms [ i ] + " " ) , end = " " )
sys . stdout . flush ( )
i = ( i + 1 ) % len ( syms )
if resource . status > RNS . Resource . COMPLETE :
2022-06-30 12:02:57 +00:00
print ( " \r \r File was not accepted by " + RNS . prettyhexrep ( destination_hash ) )
2022-05-22 21:44:32 +00:00
exit ( 1 )
else :
2022-06-30 12:02:57 +00:00
print ( " \r \r Transferring file " , end = " " )
2022-05-22 21:44:32 +00:00
while not resource_done :
time . sleep ( 0.1 )
prg = current_resource . get_progress ( )
percent = round ( prg * 100.0 , 1 )
stat_str = str ( percent ) + " % - " + size_str ( int ( prg * current_resource . total_size ) ) + " of " + size_str ( current_resource . total_size ) + " - " + size_str ( speed , " b " ) + " ps "
print ( " \r \r Transferring file " + syms [ i ] + " " + stat_str , end = " " )
sys . stdout . flush ( )
i = ( i + 1 ) % len ( syms )
if current_resource . status != RNS . Resource . COMPLETE :
2022-06-30 12:02:57 +00:00
print ( " \r \r The transfer failed " )
2022-05-22 21:44:32 +00:00
exit ( 1 )
else :
2022-05-23 07:23:37 +00:00
print ( " \r \r " + str ( file_path ) + " copied to " + RNS . prettyhexrep ( destination_hash ) )
2022-05-22 21:44:32 +00:00
link . teardown ( )
time . sleep ( 0.25 )
real_file . close ( )
temp_file . close ( )
exit ( 0 )
def main ( ) :
try :
parser = argparse . ArgumentParser ( description = " Reticulum File Transfer Utility " )
parser . add_argument ( " file " , nargs = " ? " , default = None , help = " file to be transferred " , type = str )
parser . add_argument ( " destination " , nargs = " ? " , default = None , help = " hexadecimal hash of the receiver " , type = str )
parser . add_argument ( " --config " , metavar = " path " , action = " store " , default = None , help = " path to alternative Reticulum config directory " , type = str )
parser . add_argument ( ' -v ' , ' --verbose ' , action = ' count ' , default = 0 , help = " increase verbosity " )
parser . add_argument ( ' -q ' , ' --quiet ' , action = ' count ' , default = 0 , help = " decrease verbosity " )
2022-05-24 18:13:54 +00:00
parser . add_argument ( ' -p ' , ' --print-identity ' , action = ' store_true ' , default = False , help = " print identity and destination info and exit " )
2022-05-22 21:44:32 +00:00
parser . add_argument ( " -r " , ' --receive ' , action = ' store_true ' , default = False , help = " wait for incoming files " )
parser . add_argument ( " -b " , ' --no-announce ' , action = ' store_true ' , default = False , help = " don ' t announce at program start " )
2022-05-24 18:13:54 +00:00
parser . add_argument ( ' -a ' , metavar = " allowed_hash " , dest = " allowed " , action = ' append ' , help = " accept from this identity " , type = str )
2022-05-22 21:44:32 +00:00
parser . add_argument ( ' -n ' , ' --no-auth ' , action = ' store_true ' , default = False , help = " accept files from anyone " )
parser . add_argument ( " -w " , action = " store " , metavar = " seconds " , type = float , help = " sender timeout before giving up " , default = RNS . Transport . PATH_REQUEST_TIMEOUT )
# parser.add_argument("--limit", action="store", metavar="files", type=float, help="maximum number of files to accept", default=None)
parser . add_argument ( " --version " , action = " version " , version = " rncp {version} " . format ( version = __version__ ) )
args = parser . parse_args ( )
2022-05-24 18:13:54 +00:00
if args . receive or args . print_identity :
2022-05-22 21:44:32 +00:00
receive (
configdir = args . config ,
verbosity = args . verbose ,
quietness = args . quiet ,
2022-05-24 18:13:54 +00:00
allowed = args . allowed ,
display_identity = args . print_identity ,
2022-05-22 21:44:32 +00:00
# limit=args.limit,
disable_auth = args . no_auth ,
disable_announce = args . no_announce ,
)
elif args . destination != None and args . file != None :
send (
configdir = args . config ,
verbosity = args . verbose ,
quietness = args . quiet ,
destination = args . destination ,
file = args . file ,
timeout = args . w ,
)
else :
print ( " " )
parser . print_help ( )
print ( " " )
except KeyboardInterrupt :
print ( " " )
if resource != None :
resource . cancel ( )
if link != None :
link . teardown ( )
exit ( )
def size_str ( num , suffix = ' B ' ) :
units = [ ' ' , ' K ' , ' M ' , ' G ' , ' T ' , ' P ' , ' E ' , ' Z ' ]
last_unit = ' Y '
if suffix == ' b ' :
num * = 8
units = [ ' ' , ' K ' , ' M ' , ' G ' , ' T ' , ' P ' , ' E ' , ' Z ' ]
last_unit = ' Y '
for unit in units :
if abs ( num ) < 1000.0 :
if unit == " " :
return " %.0f %s %s " % ( num , unit , suffix )
else :
return " %.2f %s %s " % ( num , unit , suffix )
num / = 1000.0
return " %.2f %s %s " % ( num , last_unit , suffix )
if __name__ == " __main__ " :
main ( )