sftpgo_api_cli 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906
  1. #!/usr/bin/env python
  2. import argparse
  3. from datetime import datetime
  4. import json
  5. import platform
  6. import sys
  7. import time
  8. import requests
  9. try:
  10. import urllib.parse as urlparse
  11. except ImportError:
  12. import urlparse
  13. try:
  14. import pygments
  15. from pygments.lexers import JsonLexer
  16. from pygments.formatters import TerminalFormatter
  17. except ImportError:
  18. pygments = None
  19. try:
  20. import pwd
  21. import spwd
  22. except ImportError:
  23. pwd = None
  24. class SFTPGoApiRequests:
  25. def __init__(self, debug, baseUrl, authType, authUser, authPassword, secure, no_color):
  26. self.userPath = urlparse.urljoin(baseUrl, '/api/v1/user')
  27. self.folderPath = urlparse.urljoin(baseUrl, '/api/v1/folder')
  28. self.quotaScanPath = urlparse.urljoin(baseUrl, '/api/v1/quota_scan')
  29. self.folderQuotaScanPath = urlparse.urljoin(baseUrl, '/api/v1/folder_quota_scan')
  30. self.activeConnectionsPath = urlparse.urljoin(baseUrl, '/api/v1/connection')
  31. self.versionPath = urlparse.urljoin(baseUrl, '/api/v1/version')
  32. self.providerStatusPath = urlparse.urljoin(baseUrl, '/api/v1/providerstatus')
  33. self.dumpDataPath = urlparse.urljoin(baseUrl, '/api/v1/dumpdata')
  34. self.loadDataPath = urlparse.urljoin(baseUrl, '/api/v1/loaddata')
  35. self.updateUsedQuotaPath = urlparse.urljoin(baseUrl, "/api/v1/quota_update")
  36. self.updateFolderUsedQuotaPath = urlparse.urljoin(baseUrl, "/api/v1/folder_quota_update")
  37. self.debug = debug
  38. if authType == 'basic':
  39. self.auth = requests.auth.HTTPBasicAuth(authUser, authPassword)
  40. elif authType == 'digest':
  41. self.auth = requests.auth.HTTPDigestAuth(authUser, authPassword)
  42. else:
  43. self.auth = None
  44. self.verify = secure
  45. self.no_color = no_color
  46. def formatAsJSON(self, text):
  47. if not text:
  48. return ''
  49. json_string = json.dumps(json.loads(text), sort_keys=True, indent=2)
  50. if not self.no_color and pygments:
  51. return pygments.highlight(json_string, JsonLexer(), TerminalFormatter())
  52. return json_string
  53. def printResponse(self, r):
  54. if 'content-type' in r.headers and 'application/json' in r.headers['content-type']:
  55. if self.debug:
  56. if pygments is None:
  57. print('')
  58. print('Response color highlight is not available: you need pygments 1.5 or above.')
  59. print('')
  60. print('Executed request: {} {} - request body: {}'.format(
  61. r.request.method, r.url, self.formatAsJSON(r.request.body)))
  62. print('')
  63. print('Got response, status code: {} body:'.format(r.status_code))
  64. print(self.formatAsJSON(r.text))
  65. else:
  66. print(r.text)
  67. def buildUserObject(self, user_id=0, username='', password='', public_keys=[], home_dir='', uid=0, gid=0,
  68. max_sessions=0, quota_size=0, quota_files=0, permissions={}, upload_bandwidth=0, download_bandwidth=0,
  69. status=1, expiration_date=0, allowed_ip=[], denied_ip=[], fs_provider='local', s3_bucket='',
  70. s3_region='', s3_access_key='', s3_access_secret='', s3_endpoint='', s3_storage_class='',
  71. s3_key_prefix='', gcs_bucket='', gcs_key_prefix='', gcs_storage_class='', gcs_credentials_file='',
  72. gcs_automatic_credentials='automatic', denied_login_methods=[], virtual_folders=[],
  73. denied_patterns=[], allowed_patterns=[], s3_upload_part_size=0, s3_upload_concurrency=0,
  74. max_upload_file_size=0, denied_protocols=[], az_container='', az_account_name='', az_account_key='',
  75. az_sas_url='', az_endpoint='', az_upload_part_size=0, az_upload_concurrency=0, az_key_prefix='',
  76. az_use_emulator=False, az_access_tier='', additional_info='', crypto_passphrase='', sftp_endpoint='',
  77. sftp_username='', sftp_password='', sftp_private_key_path='', sftp_fingerprints=[], sftp_prefix=''):
  78. user = {'id':user_id, 'username':username, 'uid':uid, 'gid':gid,
  79. 'max_sessions':max_sessions, 'quota_size':quota_size, 'quota_files':quota_files,
  80. 'upload_bandwidth':upload_bandwidth, 'download_bandwidth':download_bandwidth,
  81. 'status':status, 'expiration_date':expiration_date, 'additional_info':additional_info}
  82. if password is not None:
  83. user.update({'password':password})
  84. if public_keys:
  85. if len(public_keys) == 1 and not public_keys[0]:
  86. user.update({'public_keys':[]})
  87. else:
  88. user.update({'public_keys':public_keys})
  89. if home_dir:
  90. user.update({'home_dir':home_dir})
  91. if permissions:
  92. user.update({'permissions':permissions})
  93. if virtual_folders:
  94. user.update({'virtual_folders':self.buildVirtualFolders(virtual_folders)})
  95. user.update({'filters':self.buildFilters(allowed_ip, denied_ip, denied_login_methods, denied_patterns,
  96. allowed_patterns, max_upload_file_size, denied_protocols)})
  97. user.update({'filesystem':self.buildFsConfig(fs_provider, s3_bucket, s3_region, s3_access_key, s3_access_secret,
  98. s3_endpoint, s3_storage_class, s3_key_prefix, gcs_bucket,
  99. gcs_key_prefix, gcs_storage_class, gcs_credentials_file,
  100. gcs_automatic_credentials, s3_upload_part_size, s3_upload_concurrency,
  101. az_container, az_account_name, az_account_key, az_sas_url,
  102. az_endpoint, az_upload_part_size, az_upload_concurrency, az_key_prefix,
  103. az_use_emulator, az_access_tier, crypto_passphrase, sftp_endpoint,
  104. sftp_username, sftp_password, sftp_private_key_path,
  105. sftp_fingerprints, sftp_prefix)})
  106. return user
  107. def buildVirtualFolders(self, vfolders):
  108. result = []
  109. for f in vfolders:
  110. if '::' in f:
  111. vpath = ''
  112. mapped_path = ''
  113. quota_files = 0
  114. quota_size = 0
  115. values = f.split('::')
  116. if len(values) > 1:
  117. vpath = values[0]
  118. mapped_path = values[1]
  119. if len(values) > 2:
  120. try:
  121. quota_files = int(values[2])
  122. except:
  123. pass
  124. if len(values) > 3:
  125. try:
  126. quota_size = int(values[3])
  127. except:
  128. pass
  129. if vpath and mapped_path:
  130. result.append({"virtual_path":vpath, "mapped_path":mapped_path,
  131. "quota_files":quota_files, "quota_size":quota_size})
  132. return result
  133. def buildPermissions(self, root_perms, subdirs_perms):
  134. permissions = {}
  135. if root_perms:
  136. permissions.update({'/':root_perms})
  137. for p in subdirs_perms:
  138. if '::' in p:
  139. directory = None
  140. values = []
  141. for value in p.split('::'):
  142. if directory is None:
  143. directory = value
  144. else:
  145. values = [v.strip() for v in value.split(',') if v.strip()]
  146. if directory:
  147. permissions.update({directory:values})
  148. return permissions
  149. def buildFilters(self, allowed_ip, denied_ip, denied_login_methods, denied_patterns, allowed_patterns,
  150. max_upload_file_size, denied_protocols):
  151. filters = {"max_upload_file_size":max_upload_file_size}
  152. if allowed_ip:
  153. if len(allowed_ip) == 1 and not allowed_ip[0]:
  154. filters.update({'allowed_ip':[]})
  155. else:
  156. filters.update({'allowed_ip':allowed_ip})
  157. if denied_ip:
  158. if len(denied_ip) == 1 and not denied_ip[0]:
  159. filters.update({'denied_ip':[]})
  160. else:
  161. filters.update({'denied_ip':denied_ip})
  162. if denied_login_methods:
  163. if len(denied_login_methods) == 1 and not denied_login_methods[0]:
  164. filters.update({'denied_login_methods':[]})
  165. else:
  166. filters.update({'denied_login_methods':denied_login_methods})
  167. if denied_protocols:
  168. if len(denied_protocols) == 1 and not denied_protocols[0]:
  169. filters.update({'denied_protocols':[]})
  170. else:
  171. filters.update({'denied_protocols':denied_protocols})
  172. patterns_filter = []
  173. patterns_denied = []
  174. patterns_allowed = []
  175. if denied_patterns:
  176. for e in denied_patterns:
  177. if '::' in e:
  178. directory = None
  179. values = []
  180. for value in e.split('::'):
  181. if directory is None:
  182. directory = value
  183. else:
  184. values = [v.strip() for v in value.split(',') if v.strip()]
  185. if directory:
  186. patterns_denied.append({'path':directory, 'denied_patterns':values,
  187. 'allowed_patterns':[]})
  188. if allowed_patterns:
  189. for e in allowed_patterns:
  190. if '::' in e:
  191. directory = None
  192. values = []
  193. for value in e.split('::'):
  194. if directory is None:
  195. directory = value
  196. else:
  197. values = [v.strip() for v in value.split(',') if v.strip()]
  198. if directory:
  199. patterns_allowed.append({'path':directory, 'allowed_patterns':values,
  200. 'denied_patterns':[]})
  201. if patterns_allowed and patterns_denied:
  202. for allowed in patterns_allowed:
  203. for denied in patterns_denied:
  204. if allowed.get('path') == denied.get('path'):
  205. allowed.update({'denied_patterns':denied.get('denied_patterns')})
  206. patterns_filter.append(allowed)
  207. for denied in patterns_denied:
  208. found = False
  209. for allowed in patterns_allowed:
  210. if allowed.get('path') == denied.get('path'):
  211. found = True
  212. if not found:
  213. patterns_filter.append(denied)
  214. elif patterns_allowed:
  215. patterns_filter = patterns_allowed
  216. elif patterns_denied:
  217. patterns_filter = patterns_denied
  218. if allowed_patterns or denied_patterns:
  219. filters.update({'file_patterns':patterns_filter})
  220. return filters
  221. def buildFsConfig(self, fs_provider, s3_bucket, s3_region, s3_access_key, s3_access_secret, s3_endpoint,
  222. s3_storage_class, s3_key_prefix, gcs_bucket, gcs_key_prefix, gcs_storage_class,
  223. gcs_credentials_file, gcs_automatic_credentials, s3_upload_part_size, s3_upload_concurrency,
  224. az_container, az_account_name, az_account_key, az_sas_url, az_endpoint, az_upload_part_size,
  225. az_upload_concurrency, az_key_prefix, az_use_emulator, az_access_tier, crypto_passphrase,
  226. sftp_endpoint, sftp_username, sftp_password, sftp_private_key_path, sftp_fingerprints, sftp_prefix):
  227. fs_config = {'provider':0}
  228. if fs_provider == 'S3':
  229. secret = {}
  230. if s3_access_secret:
  231. secret.update({"status":"Plain", "payload":s3_access_secret})
  232. s3config = {'bucket':s3_bucket, 'region':s3_region, 'access_key':s3_access_key, 'access_secret':
  233. secret, 'endpoint':s3_endpoint, 'storage_class':s3_storage_class, 'key_prefix':
  234. s3_key_prefix, 'upload_part_size':s3_upload_part_size, 'upload_concurrency':s3_upload_concurrency}
  235. fs_config.update({'provider':1, 's3config':s3config})
  236. elif fs_provider == 'GCS':
  237. gcsconfig = {'bucket':gcs_bucket, 'key_prefix':gcs_key_prefix, 'storage_class':gcs_storage_class,
  238. 'credentials':{}}
  239. if gcs_automatic_credentials == "automatic":
  240. gcsconfig.update({'automatic_credentials':1})
  241. else:
  242. gcsconfig.update({'automatic_credentials':0})
  243. if gcs_credentials_file:
  244. with open(gcs_credentials_file) as creds:
  245. secret = {"status":"Plain", "payload":creds.read()}
  246. gcsconfig.update({'credentials':secret, 'automatic_credentials':0})
  247. fs_config.update({'provider':2, 'gcsconfig':gcsconfig})
  248. elif fs_provider == "AzureBlob":
  249. secret = {}
  250. if az_account_key:
  251. secret.update({"status":"Plain", "payload":az_account_key})
  252. azureconfig = {'container':az_container, 'account_name':az_account_name, 'account_key':secret,
  253. 'sas_url':az_sas_url, 'endpoint':az_endpoint, 'upload_part_size':az_upload_part_size,
  254. 'upload_concurrency':az_upload_concurrency, 'key_prefix':az_key_prefix, 'use_emulator':
  255. az_use_emulator, 'access_tier':az_access_tier}
  256. fs_config.update({'provider':3, 'azblobconfig':azureconfig})
  257. elif fs_provider == 'Crypto':
  258. cryptoconfig = {'passphrase':{'status':'Plain', 'payload':crypto_passphrase}}
  259. fs_config.update({'provider':4, 'cryptconfig':cryptoconfig})
  260. elif fs_provider == 'SFTP':
  261. sftpconfig = {'endpoint':sftp_endpoint, 'username':sftp_username, 'fingerprints':sftp_fingerprints,
  262. 'prefix':sftp_prefix}
  263. if sftp_password:
  264. pwd = {'status':'Plain', 'payload':sftp_password}
  265. sftpconfig.update({'password':pwd})
  266. if sftp_private_key_path:
  267. with open(sftp_private_key_path) as pkey:
  268. key = {'status':'Plain', 'payload':pkey.read()}
  269. sftpconfig.update({'private_key':key})
  270. fs_config.update({'provider':5, 'sftpconfig':sftpconfig})
  271. return fs_config
  272. def getUsers(self, limit=100, offset=0, order='ASC', username=''):
  273. r = requests.get(self.userPath, params={'limit':limit, 'offset':offset, 'order':order,
  274. 'username':username}, auth=self.auth, verify=self.verify)
  275. self.printResponse(r)
  276. def getUserByID(self, user_id):
  277. r = requests.get(urlparse.urljoin(self.userPath, 'user/' + str(user_id)), auth=self.auth, verify=self.verify)
  278. self.printResponse(r)
  279. def addUser(self, username='', password='', public_keys='', home_dir='', uid=0, gid=0, max_sessions=0, quota_size=0,
  280. quota_files=0, perms=[], upload_bandwidth=0, download_bandwidth=0, status=1, expiration_date=0,
  281. subdirs_permissions=[], allowed_ip=[], denied_ip=[], fs_provider='local', s3_bucket='', s3_region='',
  282. s3_access_key='', s3_access_secret='', s3_endpoint='', s3_storage_class='', s3_key_prefix='', gcs_bucket='',
  283. gcs_key_prefix='', gcs_storage_class='', gcs_credentials_file='', gcs_automatic_credentials='automatic',
  284. denied_login_methods=[], virtual_folders=[], denied_patterns=[], allowed_patterns=[],
  285. s3_upload_part_size=0, s3_upload_concurrency=0, max_upload_file_size=0, denied_protocols=[], az_container="",
  286. az_account_name='', az_account_key='', az_sas_url='', az_endpoint='', az_upload_part_size=0,
  287. az_upload_concurrency=0, az_key_prefix='', az_use_emulator=False, az_access_tier='', additional_info='',
  288. crypto_passphrase='', sftp_endpoint='', sftp_username='', sftp_password='', sftp_private_key_path='',
  289. sftp_fingerprints=[], sftp_prefix=''):
  290. u = self.buildUserObject(0, username, password, public_keys, home_dir, uid, gid, max_sessions,
  291. quota_size, quota_files, self.buildPermissions(perms, subdirs_permissions), upload_bandwidth, download_bandwidth,
  292. status, expiration_date, allowed_ip, denied_ip, fs_provider, s3_bucket, s3_region, s3_access_key,
  293. s3_access_secret, s3_endpoint, s3_storage_class, s3_key_prefix, gcs_bucket, gcs_key_prefix, gcs_storage_class,
  294. gcs_credentials_file, gcs_automatic_credentials, denied_login_methods, virtual_folders, denied_patterns,
  295. allowed_patterns, s3_upload_part_size, s3_upload_concurrency, max_upload_file_size, denied_protocols,
  296. az_container, az_account_name, az_account_key, az_sas_url, az_endpoint, az_upload_part_size,
  297. az_upload_concurrency, az_key_prefix, az_use_emulator, az_access_tier, additional_info, crypto_passphrase,
  298. sftp_endpoint, sftp_username, sftp_password, sftp_private_key_path, sftp_fingerprints, sftp_prefix)
  299. r = requests.post(self.userPath, json=u, auth=self.auth, verify=self.verify)
  300. self.printResponse(r)
  301. def updateUser(self, user_id, username='', password='', public_keys='', home_dir='', uid=0, gid=0, max_sessions=0,
  302. quota_size=0, quota_files=0, perms=[], upload_bandwidth=0, download_bandwidth=0, status=1,
  303. expiration_date=0, subdirs_permissions=[], allowed_ip=[], denied_ip=[], fs_provider='local',
  304. s3_bucket='', s3_region='', s3_access_key='', s3_access_secret='', s3_endpoint='', s3_storage_class='',
  305. s3_key_prefix='', gcs_bucket='', gcs_key_prefix='', gcs_storage_class='', gcs_credentials_file='',
  306. gcs_automatic_credentials='automatic', denied_login_methods=[], virtual_folders=[], denied_patterns=[],
  307. allowed_patterns=[], s3_upload_part_size=0, s3_upload_concurrency=0, max_upload_file_size=0,
  308. denied_protocols=[], disconnect=0, az_container='', az_account_name='', az_account_key='', az_sas_url='',
  309. az_endpoint='', az_upload_part_size=0, az_upload_concurrency=0, az_key_prefix='', az_use_emulator=False,
  310. az_access_tier='', additional_info='', crypto_passphrase='', sftp_endpoint='', sftp_username='',
  311. sftp_password='', sftp_private_key_path='', sftp_fingerprints=[], sftp_prefix=''):
  312. u = self.buildUserObject(user_id, username, password, public_keys, home_dir, uid, gid, max_sessions,
  313. quota_size, quota_files, self.buildPermissions(perms, subdirs_permissions), upload_bandwidth, download_bandwidth,
  314. status, expiration_date, allowed_ip, denied_ip, fs_provider, s3_bucket, s3_region, s3_access_key,
  315. s3_access_secret, s3_endpoint, s3_storage_class, s3_key_prefix, gcs_bucket, gcs_key_prefix, gcs_storage_class,
  316. gcs_credentials_file, gcs_automatic_credentials, denied_login_methods, virtual_folders, denied_patterns,
  317. allowed_patterns, s3_upload_part_size, s3_upload_concurrency, max_upload_file_size, denied_protocols,
  318. az_container, az_account_name, az_account_key, az_sas_url, az_endpoint, az_upload_part_size,
  319. az_upload_concurrency, az_key_prefix, az_use_emulator, az_access_tier, additional_info, crypto_passphrase,
  320. sftp_endpoint, sftp_username, sftp_password, sftp_private_key_path, sftp_fingerprints, sftp_prefix)
  321. r = requests.put(urlparse.urljoin(self.userPath, 'user/' + str(user_id)), params={'disconnect':disconnect},
  322. json=u, auth=self.auth, verify=self.verify)
  323. self.printResponse(r)
  324. def deleteUser(self, user_id):
  325. r = requests.delete(urlparse.urljoin(self.userPath, 'user/' + str(user_id)), auth=self.auth, verify=self.verify)
  326. self.printResponse(r)
  327. def updateQuotaUsage(self, username, used_quota_size, used_quota_files, mode):
  328. req = {"username":username, "used_quota_files":used_quota_files, "used_quota_size":used_quota_size}
  329. r = requests.put(self.updateUsedQuotaPath, params={'mode':mode}, json=req, auth=self.auth, verify=self.verify)
  330. self.printResponse(r)
  331. def updateFolderQuotaUsage(self, mapped_path, used_quota_size, used_quota_files, mode):
  332. req = {"mapped_path":mapped_path, "used_quota_files":used_quota_files, "used_quota_size":used_quota_size}
  333. r = requests.put(self.updateFolderUsedQuotaPath, params={'mode':mode}, json=req, auth=self.auth, verify=self.verify)
  334. self.printResponse(r)
  335. def getConnections(self):
  336. r = requests.get(self.activeConnectionsPath, auth=self.auth, verify=self.verify)
  337. self.printResponse(r)
  338. def closeConnection(self, connectionID):
  339. r = requests.delete(urlparse.urljoin(self.activeConnectionsPath, 'connection/' + str(connectionID)), auth=self.auth)
  340. self.printResponse(r)
  341. def getQuotaScans(self):
  342. r = requests.get(self.quotaScanPath, auth=self.auth, verify=self.verify)
  343. self.printResponse(r)
  344. def startQuotaScan(self, username):
  345. u = self.buildUserObject(0, username)
  346. r = requests.post(self.quotaScanPath, json=u, auth=self.auth, verify=self.verify)
  347. self.printResponse(r)
  348. def getFoldersQuotaScans(self):
  349. r = requests.get(self.folderQuotaScanPath, auth=self.auth, verify=self.verify)
  350. self.printResponse(r)
  351. def startFolderQuotaScan(self, mapped_path):
  352. f = {"mapped_path":mapped_path}
  353. r = requests.post(self.folderQuotaScanPath, json=f, auth=self.auth, verify=self.verify)
  354. self.printResponse(r)
  355. def addFolder(self, mapped_path):
  356. f = {"mapped_path":mapped_path}
  357. r = requests.post(self.folderPath, json=f, auth=self.auth, verify=self.verify)
  358. self.printResponse(r)
  359. def deleteFolder(self, mapped_path):
  360. r = requests.delete(self.folderPath, params={'folder_path':mapped_path}, auth=self.auth, verify=self.verify)
  361. self.printResponse(r)
  362. def getFolders(self, limit=100, offset=0, order='ASC', mapped_path=''):
  363. r = requests.get(self.folderPath, params={'limit':limit, 'offset':offset, 'order':order,
  364. 'folder_path':mapped_path}, auth=self.auth, verify=self.verify)
  365. self.printResponse(r)
  366. def getVersion(self):
  367. r = requests.get(self.versionPath, auth=self.auth, verify=self.verify)
  368. self.printResponse(r)
  369. def getProviderStatus(self):
  370. r = requests.get(self.providerStatusPath, auth=self.auth, verify=self.verify)
  371. self.printResponse(r)
  372. def dumpData(self, output_file, indent):
  373. r = requests.get(self.dumpDataPath, params={'output_file':output_file, 'indent':indent},
  374. auth=self.auth, verify=self.verify)
  375. self.printResponse(r)
  376. def loadData(self, input_file, scan_quota, mode):
  377. r = requests.get(self.loadDataPath, params={'input_file':input_file, 'scan_quota':scan_quota,
  378. 'mode':mode},
  379. auth=self.auth, verify=self.verify)
  380. self.printResponse(r)
  381. class ConvertUsers:
  382. def __init__(self, input_file, users_format, output_file, min_uid, max_uid, usernames, force_uid, force_gid):
  383. self.input_file = input_file
  384. self.users_format = users_format
  385. self.output_file = output_file
  386. self.min_uid = min_uid
  387. self.max_uid = max_uid
  388. self.usernames = usernames
  389. self.force_uid = force_uid
  390. self.force_gid = force_gid
  391. self.SFTPGoUsers = []
  392. def setSFTPGoRestApi(self, api):
  393. self.SFTPGoRestAPI = api
  394. def addUser(self, user):
  395. user['id'] = len(self.SFTPGoUsers) + 1
  396. print('')
  397. print('New user imported: {}'.format(user))
  398. print('')
  399. self.SFTPGoUsers.append(user)
  400. def saveUsers(self):
  401. if self.SFTPGoUsers:
  402. data = {'users':self.SFTPGoUsers}
  403. jsonData = json.dumps(data)
  404. with open(self.output_file, 'w') as f:
  405. f.write(jsonData)
  406. print()
  407. print('Number of users saved to "{}": {}. You can import them using loaddata'.format(self.output_file,
  408. len(self.SFTPGoUsers)))
  409. print()
  410. sys.exit(0)
  411. else:
  412. print('No user imported')
  413. sys.exit(1)
  414. def convert(self):
  415. if self.users_format == 'unix-passwd':
  416. self.convertFromUnixPasswd()
  417. elif self.users_format == 'pure-ftpd':
  418. self.convertFromPureFTPD()
  419. else:
  420. self.convertFromProFTPD()
  421. self.saveUsers()
  422. def isUserValid(self, username, uid):
  423. if self.usernames and not username in self.usernames:
  424. return False
  425. if self.min_uid >= 0 and uid < self.min_uid:
  426. return False
  427. if self.max_uid >= 0 and uid > self.max_uid:
  428. return False
  429. return True
  430. def convertFromUnixPasswd(self):
  431. days_from_epoch_time = time.time() / 86400
  432. for user in pwd.getpwall():
  433. username = user.pw_name
  434. password = user.pw_passwd
  435. uid = user.pw_uid
  436. gid = user.pw_gid
  437. home_dir = user.pw_dir
  438. status = 1
  439. expiration_date = 0
  440. if not self.isUserValid(username, uid):
  441. continue
  442. if self.force_uid >= 0:
  443. uid = self.force_uid
  444. if self.force_gid >= 0:
  445. gid = self.force_gid
  446. # FIXME: if the passwords aren't in /etc/shadow they are probably DES encrypted and we don't support them
  447. if password == 'x' or password == '*':
  448. user_info = spwd.getspnam(username)
  449. password = user_info.sp_pwdp
  450. if not password or password == '!!':
  451. print('cannot import user "{}" without a password'.format(username))
  452. continue
  453. if user_info.sp_inact > 0:
  454. last_pwd_change_diff = days_from_epoch_time - user_info.sp_lstchg
  455. if last_pwd_change_diff > user_info.sp_inact:
  456. status = 0
  457. if user_info.sp_expire > 0:
  458. expiration_date = user_info.sp_expire * 86400
  459. permissions = self.SFTPGoRestAPI.buildPermissions(['*'], [])
  460. self.addUser(self.SFTPGoRestAPI.buildUserObject(0, username, password, [], home_dir, uid, gid, 0, 0, 0,
  461. permissions, 0, 0, status, expiration_date))
  462. def convertFromProFTPD(self):
  463. with open(self.input_file, 'r') as f:
  464. for line in f:
  465. fields = line.split(':')
  466. if len(fields) > 6:
  467. username = fields[0]
  468. password = fields[1]
  469. uid = int(fields[2])
  470. gid = int(fields[3])
  471. home_dir = fields[5]
  472. if not self.isUserValid(username, uid, gid):
  473. continue
  474. if self.force_uid >= 0:
  475. uid = self.force_uid
  476. if self.force_gid >= 0:
  477. gid = self.force_gid
  478. permissions = self.SFTPGoRestAPI.buildPermissions(['*'], [])
  479. self.addUser(self.SFTPGoRestAPI.buildUserObject(0, username, password, [], home_dir, uid, gid, 0, 0,
  480. 0, permissions, 0, 0, 1, 0))
  481. def convertPureFTPDIP(self, fields):
  482. result = []
  483. if not fields:
  484. return result
  485. for v in fields.split(','):
  486. ip_mask = v.strip()
  487. if not ip_mask:
  488. continue
  489. if ip_mask.count('.') < 3 and ip_mask.count(':') < 3:
  490. print('cannot import pure-ftpd IP: {}'.format(ip_mask))
  491. continue
  492. if '/' not in ip_mask:
  493. ip_mask += '/32'
  494. result.append(ip_mask)
  495. return result
  496. def convertFromPureFTPD(self):
  497. with open(self.input_file, 'r') as f:
  498. for line in f:
  499. fields = line.split(':')
  500. if len(fields) > 16:
  501. username = fields[0]
  502. password = fields[1]
  503. uid = int(fields[2])
  504. gid = int(fields[3])
  505. home_dir = fields[5]
  506. upload_bandwidth = 0
  507. if fields[6]:
  508. upload_bandwidth = int(int(fields[6]) / 1024)
  509. download_bandwidth = 0
  510. if fields[7]:
  511. download_bandwidth = int(int(fields[7]) / 1024)
  512. max_sessions = 0
  513. if fields[10]:
  514. max_sessions = int(fields[10])
  515. quota_files = 0
  516. if fields[11]:
  517. quota_files = int(fields[11])
  518. quota_size = 0
  519. if fields[12]:
  520. quota_size = int(fields[12])
  521. allowed_ip = self.convertPureFTPDIP(fields[15])
  522. denied_ip = self.convertPureFTPDIP(fields[16])
  523. if not self.isUserValid(username, uid, gid):
  524. continue
  525. if self.force_uid >= 0:
  526. uid = self.force_uid
  527. if self.force_gid >= 0:
  528. gid = self.force_gid
  529. permissions = self.SFTPGoRestAPI.buildPermissions(['*'], [])
  530. self.addUser(self.SFTPGoRestAPI.buildUserObject(0, username, password, [], home_dir, uid, gid,
  531. max_sessions, quota_size, quota_files, permissions,
  532. upload_bandwidth, download_bandwidth, 1, 0, allowed_ip,
  533. denied_ip))
  534. def validDate(s):
  535. if not s:
  536. return datetime.fromtimestamp(0)
  537. try:
  538. return datetime.strptime(s, '%Y-%m-%d')
  539. except ValueError:
  540. msg = 'Not a valid date: "{0}".'.format(s)
  541. raise argparse.ArgumentTypeError(msg)
  542. def getDatetimeAsMillisSinceEpoch(dt):
  543. epoch = datetime.fromtimestamp(0)
  544. return int((dt - epoch).total_seconds() * 1000)
  545. def addCommonUserArguments(parser):
  546. parser.add_argument('username', type=str)
  547. parser.add_argument('-P', '--password', type=str, default=None, help='Default: %(default)s')
  548. parser.add_argument('-K', '--public-keys', type=str, nargs='+', default=[], help='Public keys or SSH user certificates. ' +
  549. 'Default: %(default)s')
  550. parser.add_argument('-H', '--home-dir', type=str, default='', help='Default: %(default)s')
  551. parser.add_argument('--uid', type=int, default=0, help='Default: %(default)s')
  552. parser.add_argument('--gid', type=int, default=0, help='Default: %(default)s')
  553. parser.add_argument('-C', '--max-sessions', type=int, default=0,
  554. help='Maximum concurrent sessions. 0 means unlimited. Default: %(default)s')
  555. parser.add_argument('-S', '--quota-size', type=int, default=0,
  556. help='Maximum size allowed as bytes. 0 means unlimited. Default: %(default)s')
  557. parser.add_argument('-F', '--quota-files', type=int, default=0, help='default: %(default)s')
  558. parser.add_argument('-G', '--permissions', type=str, nargs='+', default=[],
  559. choices=['*', 'list', 'download', 'upload', 'overwrite', 'delete', 'rename', 'create_dirs',
  560. 'create_symlinks', 'chmod', 'chown', 'chtimes'], help='Permissions for the root directory '
  561. +'(/). Default: %(default)s')
  562. parser.add_argument('-L', '--denied-login-methods', type=str, nargs='+', default=[],
  563. choices=['', 'publickey', 'password', 'keyboard-interactive', 'publickey+password',
  564. 'publickey+keyboard-interactive'], help='Default: %(default)s')
  565. parser.add_argument('--denied-protocols', type=str, nargs='+', default=[],
  566. choices=['', 'SSH', 'FTP', 'DAV'], help='Default: %(default)s')
  567. parser.add_argument('--subdirs-permissions', type=str, nargs='*', default=[], help='Permissions for subdirs. '
  568. +'For example: "/somedir::list,download" "/otherdir/subdir::*" Default: %(default)s')
  569. parser.add_argument('--virtual-folders', type=str, nargs='*', default=[], help='Virtual folder mapping. For example: '
  570. +'"/vpath::/home/adir" "/vpath::C:\adir::[quota_file]::[quota_size]". Quota parameters -1 means '
  571. +'included inside user quota, 0 means unlimited. Ignored for non local filesystems. Default: %(default)s')
  572. parser.add_argument('-U', '--upload-bandwidth', type=int, default=0,
  573. help='Maximum upload bandwidth as KB/s, 0 means unlimited. Default: %(default)s')
  574. parser.add_argument('-D', '--download-bandwidth', type=int, default=0,
  575. help='Maximum download bandwidth as KB/s, 0 means unlimited. Default: %(default)s')
  576. parser.add_argument('--status', type=int, choices=[0, 1], default=1,
  577. help='User\'s status. 1 enabled, 0 disabled. Default: %(default)s')
  578. parser.add_argument('--max-upload-file-size', type=int, default=0,
  579. help='Maximum allowed size, as bytes, for a single file upload, 0 means unlimited. Default: %(default)s')
  580. parser.add_argument('--additional-info', type=str, default='', help='Free form text field. Default: %(default)s')
  581. parser.add_argument('-E', '--expiration-date', type=validDate, default='',
  582. help='Expiration date as YYYY-MM-DD, empty string means no expiration. Default: %(default)s')
  583. parser.add_argument('-Y', '--allowed-ip', type=str, nargs='+', default=[],
  584. help='Allowed IP/Mask in CIDR notation. For example "192.168.2.0/24" or "2001:db8::/32". Default: %(default)s')
  585. parser.add_argument('-N', '--denied-ip', type=str, nargs='+', default=[],
  586. help='Denied IP/Mask in CIDR notation. For example "192.168.2.0/24" or "2001:db8::/32". Default: %(default)s')
  587. parser.add_argument('--denied-patterns', type=str, nargs='*', default=[], help='Denied file patterns case insensitive. '
  588. +'The format is /dir::pattern1,pattern2. For example: "/somedir::*.jpg,*.png" "/otherdir/subdir::a*b?.zip,*.rar". ' +
  589. ' You have to set both denied and allowed patterns to update existing values or none to preserve them.' +
  590. ' If you only set allowed or denied patterns the missing one is assumed to be an empty list. Default: %(default)s')
  591. parser.add_argument('--allowed-patterns', type=str, nargs='*', default=[], help='Allowed file patterns case insensitive. '
  592. +'The format is /dir::pattern1,pattern2. For example: "/somedir::*.jpg,a*b?.png" "/otherdir/subdir::*.zip,*.rar". ' +
  593. 'Default: %(default)s')
  594. parser.add_argument('--fs', type=str, default='local', choices=['local', 'S3', 'GCS', 'AzureBlob', 'Crypto', 'SFTP'],
  595. help='Filesystem provider. Default: %(default)s')
  596. parser.add_argument('--s3-bucket', type=str, default='', help='Default: %(default)s')
  597. parser.add_argument('--s3-key-prefix', type=str, default='', help='Virtual root directory. If non empty only this ' +
  598. 'directory and its contents will be available. Cannot start with "/". For example "folder/subfolder/".' +
  599. ' Default: %(default)s')
  600. parser.add_argument('--s3-region', type=str, default='', help='Default: %(default)s')
  601. parser.add_argument('--s3-access-key', type=str, default='', help='Default: %(default)s')
  602. parser.add_argument('--s3-access-secret', type=str, default='', help='Default: %(default)s')
  603. parser.add_argument('--s3-endpoint', type=str, default='', help='Default: %(default)s')
  604. parser.add_argument('--s3-storage-class', type=str, default='', help='Default: %(default)s')
  605. parser.add_argument('--s3-upload-part-size', type=int, default=0, help='The buffer size for multipart uploads (MB). ' +
  606. 'Zero means the default (5 MB). Minimum is 5. Default: %(default)s')
  607. parser.add_argument('--s3-upload-concurrency', type=int, default=0, help='How many parts are uploaded in parallel. ' +
  608. 'Zero means the default (2). Default: %(default)s')
  609. parser.add_argument('--gcs-bucket', type=str, default='', help='Default: %(default)s')
  610. parser.add_argument('--gcs-key-prefix', type=str, default='', help='Virtual root directory. If non empty only this ' +
  611. 'directory and its contents will be available. Cannot start with "/". For example "folder/subfolder/".' +
  612. ' Default: %(default)s')
  613. parser.add_argument('--gcs-storage-class', type=str, default='', help='Default: %(default)s')
  614. parser.add_argument('--gcs-credentials-file', type=str, default='', help='Default: %(default)s')
  615. parser.add_argument('--gcs-automatic-credentials', type=str, default='automatic', choices=['explicit', 'automatic'],
  616. help='If you provide a credentials file this argument will be setted to "explicit". Default: %(default)s')
  617. parser.add_argument('--az-container', type=str, default='', help='Default: %(default)s')
  618. parser.add_argument('--az-account-name', type=str, default='', help='Default: %(default)s')
  619. parser.add_argument('--az-account-key', type=str, default='', help='Default: %(default)s')
  620. parser.add_argument('--az-sas-url', type=str, default='', help='Shared access signature URL. Default: %(default)s')
  621. parser.add_argument('--az-endpoint', type=str, default='', help='Default: %(default)s')
  622. parser.add_argument('--az-access-tier', type=str, default='', choices=['', 'Hot', 'Cool', 'Archive'],
  623. help='Default: %(default)s')
  624. parser.add_argument('--az-upload-part-size', type=int, default=0, help='The buffer size for multipart uploads (MB). ' +
  625. 'Zero means the default (1 MB). Default: %(default)s')
  626. parser.add_argument('--az-upload-concurrency', type=int, default=0, help='How many parts are uploaded in parallel. ' +
  627. 'Zero means the default (1). Default: %(default)s')
  628. parser.add_argument('--az-key-prefix', type=str, default='', help='Virtual root directory. If non empty only this ' +
  629. 'directory and its contents will be available. Cannot start with "/". For example "folder/subfolder/".' +
  630. ' Default: %(default)s')
  631. parser.add_argument('--az-use-emulator', type=bool, default=False, help='Default: %(default)s')
  632. parser.add_argument('--crypto-passphrase', type=str, default='', help='Passphrase for encryption/decryption, to use ' +
  633. 'with Crypto filesystem')
  634. parser.add_argument('--sftp-endpoint', type=str, default='', help='SFTP endpoint as host:port')
  635. parser.add_argument('--sftp-username', type=str, default='', help='Default: %(default)s')
  636. parser.add_argument('--sftp-password', type=str, default='', help='Default: %(default)s')
  637. parser.add_argument('--sftp-private-key-path', type=str, default='', help='Default: %(default)s')
  638. parser.add_argument('--sftp-fingerprints', type=str, nargs='+', default=[], help='Default: %(default)s')
  639. parser.add_argument('--sftp-prefix', type=str, default='', help='Default: %(default)s')
  640. if __name__ == '__main__':
  641. parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
  642. parser.add_argument('-b', '--base-url', type=str, default='http://127.0.0.1:8080',
  643. help='Base URL for SFTPGo REST API. Default: %(default)s')
  644. parser.add_argument('-a', '--auth-type', type=str, default=None, choices=['basic', 'digest'],
  645. help='HTTP authentication type. Default: %(default)s')
  646. parser.add_argument('-u', '--auth-user', type=str, default='',
  647. help='User for HTTP authentication. Default: %(default)s')
  648. parser.add_argument('-p', '--auth-password', type=str, default='',
  649. help='Password for HTTP authentication. Default: %(default)s')
  650. parser.add_argument('-d', '--debug', dest='debug', action='store_true')
  651. parser.set_defaults(debug=False)
  652. parser.add_argument('-i', '--insecure', dest='secure', action='store_false',
  653. help='Set to false to ignore verifying the SSL certificate')
  654. parser.set_defaults(secure=True)
  655. has_colors_default = pygments is not None and platform.system() != 'Windows'
  656. group = parser.add_mutually_exclusive_group(required=False)
  657. group.add_argument('-t', '--no-color', dest='no_color', action='store_true', default=(not has_colors_default),
  658. help='Disable color highlight for JSON responses. You need python pygments module 1.5 or above to have highlighted output')
  659. group.add_argument('-c', '--color', dest='no_color', action='store_false', default=has_colors_default,
  660. help='Enable color highlight for JSON responses. You need python pygments module 1.5 or above to have highlighted output')
  661. parser.add_argument_group(group)
  662. subparsers = parser.add_subparsers(dest='command', help='sub-command --help')
  663. subparsers.required = True
  664. parserAddUser = subparsers.add_parser('add-user', help='Add a new SFTP user')
  665. addCommonUserArguments(parserAddUser)
  666. parserUpdateUser = subparsers.add_parser('update-user', help='Update an existing user')
  667. parserUpdateUser.add_argument('id', type=int, help='User\'s ID to update')
  668. parserUpdateUser.add_argument('--disconnect', type=int, choices=[0, 1], default=0,
  669. help='0 means the user will not be disconnected and it will continue to use the old ' +
  670. 'configuration until connected. 1 means the user will be disconnected after a successful ' +
  671. 'update. It must login again and so it will be forced to use the new configuration. ' +
  672. 'Default: %(default)s')
  673. addCommonUserArguments(parserUpdateUser)
  674. parserDeleteUser = subparsers.add_parser('delete-user', help='Delete an existing user')
  675. parserDeleteUser.add_argument('id', type=int, help='User\'s ID to delete')
  676. parserGetUsers = subparsers.add_parser('get-users', help='Returns an array with one or more SFTP users')
  677. parserGetUsers.add_argument('-L', '--limit', type=int, default=100, choices=range(1, 501),
  678. help='Maximum allowed value is 500. Default: %(default)s', metavar='[1...500]')
  679. parserGetUsers.add_argument('-O', '--offset', type=int, default=0, help='Default: %(default)s')
  680. parserGetUsers.add_argument('-U', '--username', type=str, default='', help='Default: %(default)s')
  681. parserGetUsers.add_argument('-S', '--order', type=str, choices=['ASC', 'DESC'], default='ASC',
  682. help='default: %(default)s')
  683. parserGetUserByID = subparsers.add_parser('get-user-by-id', help='Find user by ID')
  684. parserGetUserByID.add_argument('id', type=int)
  685. parserGetConnections = subparsers.add_parser('get-connections',
  686. help='Get the active users and info about their uploads/downloads')
  687. parserCloseConnection = subparsers.add_parser('close-connection', help='Terminate an active SFTP/SCP connection')
  688. parserCloseConnection.add_argument('connectionID', type=str)
  689. parserGetQuotaScans = subparsers.add_parser('get-quota-scans', help='Get the active quota scans for users home directories')
  690. parserStartQuotaScan = subparsers.add_parser('start-quota-scan', help='Start a new user quota scan')
  691. addCommonUserArguments(parserStartQuotaScan)
  692. parserGetFolderQuotaScans = subparsers.add_parser('get-folders-quota-scans', help='Get the active quota scans for folders')
  693. parserStartFolderQuotaScan = subparsers.add_parser('start-folder-quota-scan', help='Start a new folder quota scan')
  694. parserStartFolderQuotaScan.add_argument('folder_path', type=str)
  695. parserGetFolders = subparsers.add_parser('get-folders', help='Returns an array with one or more folders')
  696. parserGetFolders.add_argument('-L', '--limit', type=int, default=100, choices=range(1, 501),
  697. help='Maximum allowed value is 500. Default: %(default)s', metavar='[1...500]')
  698. parserGetFolders.add_argument('-O', '--offset', type=int, default=0, help='Default: %(default)s')
  699. parserGetFolders.add_argument('-P', '--folder-path', type=str, default='', help='Default: %(default)s')
  700. parserGetFolders.add_argument('-S', '--order', type=str, choices=['ASC', 'DESC'], default='ASC',
  701. help='default: %(default)s')
  702. parserAddFolder = subparsers.add_parser('add-folder', help='Add a new folder')
  703. parserAddFolder.add_argument('folder_path', type=str)
  704. parserDeleteFolder = subparsers.add_parser('delete-folder', help='Delete an existing folder')
  705. parserDeleteFolder.add_argument('folder_path', type=str)
  706. parserGetVersion = subparsers.add_parser('get-version', help='Get version details')
  707. parserGetProviderStatus = subparsers.add_parser('get-provider-status', help='Get data provider status')
  708. parserDumpData = subparsers.add_parser('dumpdata', help='Backup SFTPGo data serializing them as JSON')
  709. parserDumpData.add_argument('output_file', type=str)
  710. parserDumpData.add_argument('-I', '--indent', type=int, choices=[0, 1], default=0,
  711. help='0 means no indentation. 1 means format the output JSON. Default: %(default)s')
  712. parserLoadData = subparsers.add_parser('loaddata', help='Restore SFTPGo data from a JSON backup')
  713. parserLoadData.add_argument('input_file', type=str)
  714. parserLoadData.add_argument('-Q', '--scan-quota', type=int, choices=[0, 1, 2], default=0,
  715. help='0 means no quota scan after a user is added/updated. 1 means always scan quota. 2 ' +
  716. 'means scan quota if the user has quota restrictions. Default: %(default)s')
  717. parserLoadData.add_argument('-M', '--mode', type=int, choices=[0, 1, 2], default=0,
  718. help='0 means new users are added, existing users are updated. 1 means new users are added,' +
  719. ' existing users are not modified. 2 is the same as 0 but if an updated user is connected ' +
  720. 'it will be disconnected and so forced to use the new configuration Default: %(default)s')
  721. parserUpdateQuotaUsage = subparsers.add_parser('update-quota-usage', help='Update the user used quota limits')
  722. parserUpdateQuotaUsage.add_argument('username', type=str)
  723. parserUpdateQuotaUsage.add_argument('-M', '--mode', type=str, choices=["add", "reset"], default="reset",
  724. help='the update mode specifies if the given quota usage values should be added or ' +
  725. 'replace the current ones. Default: %(default)s')
  726. parserUpdateQuotaUsage.add_argument('-S', '--used_quota_size', type=int, default=0, help='Default: %(default)s')
  727. parserUpdateQuotaUsage.add_argument('-F', '--used_quota_files', type=int, default=0, help='Default: %(default)s')
  728. parserUpdateFolderQuotaUsage = subparsers.add_parser('update-folder-quota-usage', help='Update the folder used quota limits')
  729. parserUpdateFolderQuotaUsage.add_argument('folder_path', type=str)
  730. parserUpdateFolderQuotaUsage.add_argument('-M', '--mode', type=str, choices=["add", "reset"], default="reset",
  731. help='the update mode specifies if the given quota usage values should be added or ' +
  732. 'replace the current ones. Default: %(default)s')
  733. parserUpdateFolderQuotaUsage.add_argument('-S', '--used_quota_size', type=int, default=0, help='Default: %(default)s')
  734. parserUpdateFolderQuotaUsage.add_argument('-F', '--used_quota_files', type=int, default=0, help='Default: %(default)s')
  735. parserConvertUsers = subparsers.add_parser('convert-users', help='Convert users to a JSON format suitable to use ' +
  736. 'with loadddata')
  737. supportedUsersFormats = []
  738. help_text = ''
  739. if pwd is not None:
  740. supportedUsersFormats.append('unix-passwd')
  741. help_text = 'To import from unix-passwd format you need the permission to read /etc/shadow that is typically granted to the root user only'
  742. supportedUsersFormats.append('pure-ftpd')
  743. supportedUsersFormats.append('proftpd')
  744. parserConvertUsers.add_argument('input_file', type=str)
  745. parserConvertUsers.add_argument('users_format', type=str, choices=supportedUsersFormats, help=help_text)
  746. parserConvertUsers.add_argument('output_file', type=str)
  747. parserConvertUsers.add_argument('--min-uid', type=int, default=-1, help='if >= 0 only import users with UID greater ' +
  748. 'or equal to this value. Default: %(default)s')
  749. parserConvertUsers.add_argument('--max-uid', type=int, default=-1, help='if >= 0 only import users with UID lesser ' +
  750. 'or equal to this value. Default: %(default)s')
  751. parserConvertUsers.add_argument('--usernames', type=str, nargs='+', default=[], help='Only import users with these ' +
  752. 'usernames. Default: %(default)s')
  753. parserConvertUsers.add_argument('--force-uid', type=int, default=-1, help='if >= 0 the imported users will have this UID in SFTPGo. Default: %(default)s')
  754. parserConvertUsers.add_argument('--force-gid', type=int, default=-1, help='if >= 0 the imported users will have this GID in SFTPGp. Default: %(default)s')
  755. args = parser.parse_args()
  756. api = SFTPGoApiRequests(args.debug, args.base_url, args.auth_type, args.auth_user, args.auth_password, args.secure,
  757. args.no_color)
  758. if args.command == 'add-user':
  759. api.addUser(args.username, args.password, args.public_keys, args.home_dir, args.uid, args.gid, args.max_sessions,
  760. args.quota_size, args.quota_files, args.permissions, args.upload_bandwidth, args.download_bandwidth,
  761. args.status, getDatetimeAsMillisSinceEpoch(args.expiration_date), args.subdirs_permissions, args.allowed_ip,
  762. args.denied_ip, args.fs, args.s3_bucket, args.s3_region, args.s3_access_key, args.s3_access_secret,
  763. args.s3_endpoint, args.s3_storage_class, args.s3_key_prefix, args.gcs_bucket, args.gcs_key_prefix,
  764. args.gcs_storage_class, args.gcs_credentials_file, args.gcs_automatic_credentials,
  765. args.denied_login_methods, args.virtual_folders, args.denied_patterns, args.allowed_patterns,
  766. args.s3_upload_part_size, args.s3_upload_concurrency, args.max_upload_file_size, args.denied_protocols,
  767. args.az_container, args.az_account_name, args.az_account_key, args.az_sas_url, args.az_endpoint,
  768. args.az_upload_part_size, args.az_upload_concurrency, args.az_key_prefix, args.az_use_emulator,
  769. args.az_access_tier, args.additional_info, args.crypto_passphrase, args.sftp_endpoint, args.sftp_username,
  770. args.sftp_password, args.sftp_private_key_path, args.sftp_fingerprints, args.sftp_prefix)
  771. elif args.command == 'update-user':
  772. api.updateUser(args.id, args.username, args.password, args.public_keys, args.home_dir, args.uid, args.gid,
  773. args.max_sessions, args.quota_size, args.quota_files, args.permissions, args.upload_bandwidth,
  774. args.download_bandwidth, args.status, getDatetimeAsMillisSinceEpoch(args.expiration_date),
  775. args.subdirs_permissions, args.allowed_ip, args.denied_ip, args.fs, args.s3_bucket, args.s3_region,
  776. args.s3_access_key, args.s3_access_secret, args.s3_endpoint, args.s3_storage_class,
  777. args.s3_key_prefix, args.gcs_bucket, args.gcs_key_prefix, args.gcs_storage_class,
  778. args.gcs_credentials_file, args.gcs_automatic_credentials, args.denied_login_methods,
  779. args.virtual_folders, args.denied_patterns, args.allowed_patterns, args.s3_upload_part_size,
  780. args.s3_upload_concurrency, args.max_upload_file_size, args.denied_protocols, args.disconnect,
  781. args.az_container, args.az_account_name, args.az_account_key, args.az_sas_url, args.az_endpoint,
  782. args.az_upload_part_size, args.az_upload_concurrency, args.az_key_prefix, args.az_use_emulator,
  783. args.az_access_tier, args.additional_info, args.crypto_passphrase, args.sftp_endpoint,
  784. args.sftp_username, args.sftp_password, args.sftp_private_key_path, args.sftp_fingerprints,
  785. args.sftp_prefix)
  786. elif args.command == 'delete-user':
  787. api.deleteUser(args.id)
  788. elif args.command == 'get-users':
  789. api.getUsers(args.limit, args.offset, args.order, args.username)
  790. elif args.command == 'get-user-by-id':
  791. api.getUserByID(args.id)
  792. elif args.command == 'get-connections':
  793. api.getConnections()
  794. elif args.command == 'close-connection':
  795. api.closeConnection(args.connectionID)
  796. elif args.command == 'get-quota-scans':
  797. api.getQuotaScans()
  798. elif args.command == 'start-quota-scan':
  799. api.startQuotaScan(args.username)
  800. elif args.command == 'get-folders':
  801. api.getFolders(args.limit, args.offset, args.order, args.folder_path)
  802. elif args.command == 'add-folder':
  803. api.addFolder(args.folder_path)
  804. elif args.command == 'delete-folder':
  805. api.deleteFolder(args.folder_path)
  806. elif args.command == 'get-folders-quota-scans':
  807. api.getFoldersQuotaScans()
  808. elif args.command == 'start-folder-quota-scan':
  809. api.startFolderQuotaScan(args.folder_path)
  810. elif args.command == 'get-version':
  811. api.getVersion()
  812. elif args.command == 'get-provider-status':
  813. api.getProviderStatus()
  814. elif args.command == 'dumpdata':
  815. api.dumpData(args.output_file, args.indent)
  816. elif args.command == 'loaddata':
  817. api.loadData(args.input_file, args.scan_quota, args.mode)
  818. elif args.command == 'update-quota-usage':
  819. api.updateQuotaUsage(args.username, args.used_quota_size, args.used_quota_files, args.mode)
  820. elif args.command == 'update-folder-quota-usage':
  821. api.updateFolderQuotaUsage(args.folder_path, args.used_quota_size, args.used_quota_files, args.mode)
  822. elif args.command == 'convert-users':
  823. convertUsers = ConvertUsers(args.input_file, args.users_format, args.output_file, args.min_uid, args.max_uid,
  824. args.usernames, args.force_uid, args.force_gid)
  825. convertUsers.setSFTPGoRestApi(api)
  826. convertUsers.convert()