sftpgo_api_cli.py 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563
  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.quotaScanPath = urlparse.urljoin(baseUrl, '/api/v1/quota_scan')
  28. self.activeConnectionsPath = urlparse.urljoin(baseUrl, '/api/v1/connection')
  29. self.versionPath = urlparse.urljoin(baseUrl, '/api/v1/version')
  30. self.providerStatusPath = urlparse.urljoin(baseUrl, '/api/v1/providerstatus')
  31. self.dumpDataPath = urlparse.urljoin(baseUrl, '/api/v1/dumpdata')
  32. self.loadDataPath = urlparse.urljoin(baseUrl, '/api/v1/loaddata')
  33. self.debug = debug
  34. if authType == 'basic':
  35. self.auth = requests.auth.HTTPBasicAuth(authUser, authPassword)
  36. elif authType == 'digest':
  37. self.auth = requests.auth.HTTPDigestAuth(authUser, authPassword)
  38. else:
  39. self.auth = None
  40. self.verify = secure
  41. self.no_color = no_color
  42. def formatAsJSON(self, text):
  43. if not text:
  44. return ""
  45. json_string = json.dumps(json.loads(text), sort_keys=True, indent=2)
  46. if not self.no_color and pygments:
  47. return pygments.highlight(json_string, JsonLexer(), TerminalFormatter())
  48. return json_string
  49. def printResponse(self, r):
  50. if "content-type" in r.headers and "application/json" in r.headers["content-type"]:
  51. if self.debug:
  52. if pygments is None:
  53. print('')
  54. print('Response color highlight is not available: you need pygments 1.5 or above.')
  55. print('')
  56. print("Executed request: {} {} - request body: {}".format(
  57. r.request.method, r.url, self.formatAsJSON(r.request.body)))
  58. print('')
  59. print("Got response, status code: {} body:".format(r.status_code))
  60. print(self.formatAsJSON(r.text))
  61. else:
  62. print(r.text)
  63. def buildUserObject(self, user_id=0, username="", password="", public_keys=[], home_dir="", uid=0, gid=0,
  64. max_sessions=0, quota_size=0, quota_files=0, permissions={}, upload_bandwidth=0, download_bandwidth=0,
  65. status=1, expiration_date=0, allowed_ip=[], denied_ip=[], fs_provider='local', s3_bucket='',
  66. s3_region='', s3_access_key='', s3_access_secret='', s3_endpoint='', s3_storage_class=''):
  67. user = {"id":user_id, "username":username, "uid":uid, "gid":gid,
  68. "max_sessions":max_sessions, "quota_size":quota_size, "quota_files":quota_files,
  69. "upload_bandwidth":upload_bandwidth, "download_bandwidth":download_bandwidth,
  70. "status":status, "expiration_date":expiration_date}
  71. if password is not None:
  72. user.update({"password":password})
  73. if public_keys:
  74. if len(public_keys) == 1 and not public_keys[0]:
  75. user.update({"public_keys":[]})
  76. else:
  77. user.update({"public_keys":public_keys})
  78. if home_dir:
  79. user.update({"home_dir":home_dir})
  80. if permissions:
  81. user.update({"permissions":permissions})
  82. if allowed_ip or denied_ip:
  83. user.update({"filters":self.buildFilters(allowed_ip, denied_ip)})
  84. user.update({"filesystem":self.buildFsConfig(fs_provider, s3_bucket, s3_region, s3_access_key,
  85. s3_access_secret, s3_endpoint, s3_storage_class)})
  86. return user
  87. def buildPermissions(self, root_perms, subdirs_perms):
  88. permissions = {}
  89. if root_perms:
  90. permissions.update({"/":root_perms})
  91. for p in subdirs_perms:
  92. if ":" in p:
  93. directory = None
  94. values = []
  95. for value in p.split(":"):
  96. if directory is None:
  97. directory = value
  98. else:
  99. values = [v.strip() for v in value.split(",") if v.strip()]
  100. if directory and values:
  101. permissions.update({directory:values})
  102. return permissions
  103. def buildFilters(self, allowed_ip, denied_ip):
  104. filters = {}
  105. if allowed_ip:
  106. if len(allowed_ip) == 1 and not allowed_ip[0]:
  107. filters.update({'allowed_ip':[]})
  108. else:
  109. filters.update({'allowed_ip':allowed_ip})
  110. if denied_ip:
  111. if len(denied_ip) == 1 and not denied_ip[0]:
  112. filters.update({'denied_ip':[]})
  113. else:
  114. filters.update({'denied_ip':denied_ip})
  115. return filters
  116. def buildFsConfig(self, fs_provider, s3_bucket, s3_region, s3_access_key, s3_access_secret, s3_endpoint,
  117. s3_storage_class):
  118. fs_config = {'provider':0}
  119. if fs_provider == 'S3':
  120. s3config = {'bucket':s3_bucket, 'region':s3_region, 'access_key':s3_access_key, 'access_secret':
  121. s3_access_secret, 'endpoint':s3_endpoint, 'storage_class':s3_storage_class}
  122. fs_config.update({'provider':1, 's3config':s3config})
  123. return fs_config
  124. def getUsers(self, limit=100, offset=0, order="ASC", username=""):
  125. r = requests.get(self.userPath, params={"limit":limit, "offset":offset, "order":order,
  126. "username":username}, auth=self.auth, verify=self.verify)
  127. self.printResponse(r)
  128. def getUserByID(self, user_id):
  129. r = requests.get(urlparse.urljoin(self.userPath, "user/" + str(user_id)), auth=self.auth, verify=self.verify)
  130. self.printResponse(r)
  131. def addUser(self, username="", password="", public_keys="", home_dir="", uid=0, gid=0, max_sessions=0, quota_size=0,
  132. quota_files=0, perms=[], upload_bandwidth=0, download_bandwidth=0, status=1, expiration_date=0,
  133. subdirs_permissions=[], allowed_ip=[], denied_ip=[], fs_provider='local', s3_bucket='', s3_region='',
  134. s3_access_key='', s3_access_secret='', s3_endpoint='', s3_storage_class=''):
  135. u = self.buildUserObject(0, username, password, public_keys, home_dir, uid, gid, max_sessions,
  136. quota_size, quota_files, self.buildPermissions(perms, subdirs_permissions), upload_bandwidth, download_bandwidth,
  137. status, expiration_date, allowed_ip, denied_ip, fs_provider, s3_bucket, s3_region,
  138. s3_access_key, s3_access_secret, s3_endpoint, s3_storage_class)
  139. r = requests.post(self.userPath, json=u, auth=self.auth, verify=self.verify)
  140. self.printResponse(r)
  141. def updateUser(self, user_id, username="", password="", public_keys="", home_dir="", uid=0, gid=0, max_sessions=0,
  142. quota_size=0, quota_files=0, perms=[], upload_bandwidth=0, download_bandwidth=0, status=1,
  143. expiration_date=0, subdirs_permissions=[], allowed_ip=[], denied_ip=[], fs_provider='local',
  144. s3_bucket='', s3_region='', s3_access_key='', s3_access_secret='', s3_endpoint='', s3_storage_class=''):
  145. u = self.buildUserObject(user_id, username, password, public_keys, home_dir, uid, gid, max_sessions,
  146. quota_size, quota_files, self.buildPermissions(perms, subdirs_permissions), upload_bandwidth, download_bandwidth,
  147. status, expiration_date, allowed_ip, denied_ip, fs_provider, s3_bucket, s3_region, s3_access_key,
  148. s3_access_secret, s3_endpoint, s3_storage_class)
  149. r = requests.put(urlparse.urljoin(self.userPath, "user/" + str(user_id)), json=u, auth=self.auth, verify=self.verify)
  150. self.printResponse(r)
  151. def deleteUser(self, user_id):
  152. r = requests.delete(urlparse.urljoin(self.userPath, "user/" + str(user_id)), auth=self.auth, verify=self.verify)
  153. self.printResponse(r)
  154. def getConnections(self):
  155. r = requests.get(self.activeConnectionsPath, auth=self.auth, verify=self.verify)
  156. self.printResponse(r)
  157. def closeConnection(self, connectionID):
  158. r = requests.delete(urlparse.urljoin(self.activeConnectionsPath, "connection/" + str(connectionID)), auth=self.auth)
  159. self.printResponse(r)
  160. def getQuotaScans(self):
  161. r = requests.get(self.quotaScanPath, auth=self.auth, verify=self.verify)
  162. self.printResponse(r)
  163. def startQuotaScan(self, username):
  164. u = self.buildUserObject(0, username)
  165. r = requests.post(self.quotaScanPath, json=u, auth=self.auth, verify=self.verify)
  166. self.printResponse(r)
  167. def getVersion(self):
  168. r = requests.get(self.versionPath, auth=self.auth, verify=self.verify)
  169. self.printResponse(r)
  170. def getProviderStatus(self):
  171. r = requests.get(self.providerStatusPath, auth=self.auth, verify=self.verify)
  172. self.printResponse(r)
  173. def dumpData(self, output_file):
  174. r = requests.get(self.dumpDataPath, params={"output_file":output_file}, auth=self.auth,
  175. verify=self.verify)
  176. self.printResponse(r)
  177. def loadData(self, input_file, scan_quota):
  178. r = requests.get(self.loadDataPath, params={"input_file":input_file, "scan_quota":scan_quota},
  179. auth=self.auth, verify=self.verify)
  180. self.printResponse(r)
  181. class ConvertUsers:
  182. def __init__(self, input_file, users_format, output_file, min_uid, max_uid, usernames, force_uid, force_gid):
  183. self.input_file = input_file
  184. self.users_format = users_format
  185. self.output_file = output_file
  186. self.min_uid = min_uid
  187. self.max_uid = max_uid
  188. self.usernames = usernames
  189. self.force_uid = force_uid
  190. self.force_gid = force_gid
  191. self.SFTPGoUsers = []
  192. def setSFTPGoRestApi(self, api):
  193. self.SFTPGoRestAPI = api
  194. def addUser(self, user):
  195. user["id"] = len(self.SFTPGoUsers) + 1
  196. print('')
  197. print('New user imported: {}'.format(user))
  198. print('')
  199. self.SFTPGoUsers.append(user)
  200. def saveUsers(self):
  201. if self.SFTPGoUsers:
  202. data = {"users":self.SFTPGoUsers}
  203. jsonData = json.dumps(data)
  204. with open(self.output_file, 'w') as f:
  205. f.write(jsonData)
  206. print()
  207. print('Number of users saved to "{}": {}. You can import them using loaddata'.format(self.output_file,
  208. len(self.SFTPGoUsers)))
  209. print()
  210. sys.exit(0)
  211. else:
  212. print('No user imported')
  213. sys.exit(1)
  214. def convert(self):
  215. if self.users_format == "unix-passwd":
  216. self.convertFromUnixPasswd()
  217. elif self.users_format == "pure-ftpd":
  218. self.convertFromPureFTPD()
  219. else:
  220. self.convertFromProFTPD()
  221. self.saveUsers()
  222. def isUserValid(self, username, uid):
  223. if self.usernames and not username in self.usernames:
  224. return False
  225. if self.min_uid >= 0 and uid < self.min_uid:
  226. return False
  227. if self.max_uid >= 0 and uid > self.max_uid:
  228. return False
  229. return True
  230. def convertFromUnixPasswd(self):
  231. days_from_epoch_time = time.time() / 86400
  232. for user in pwd.getpwall():
  233. username = user.pw_name
  234. password = user.pw_passwd
  235. uid = user.pw_uid
  236. gid = user.pw_gid
  237. home_dir = user.pw_dir
  238. status = 1
  239. expiration_date = 0
  240. if not self.isUserValid(username, uid):
  241. continue
  242. if self.force_uid >= 0:
  243. uid = self.force_uid
  244. if self.force_gid >= 0:
  245. gid = self.force_gid
  246. # FIXME: if the passwords aren't in /etc/shadow they are probably DES encrypted and we don't support them
  247. if password == 'x' or password == '*':
  248. user_info = spwd.getspnam(username)
  249. password = user_info.sp_pwdp
  250. if not password or password == '!!':
  251. print('cannot import user "{}" without a password'.format(username))
  252. continue
  253. if user_info.sp_inact > 0:
  254. last_pwd_change_diff = days_from_epoch_time - user_info.sp_lstchg
  255. if last_pwd_change_diff > user_info.sp_inact:
  256. status = 0
  257. if user_info.sp_expire > 0:
  258. expiration_date = user_info.sp_expire * 86400
  259. permissions = self.SFTPGoRestAPI.buildPermissions(['*'], [])
  260. self.addUser(self.SFTPGoRestAPI.buildUserObject(0, username, password, [], home_dir, uid, gid, 0, 0, 0,
  261. permissions, 0, 0, status, expiration_date))
  262. def convertFromProFTPD(self):
  263. with open(self.input_file, 'r') as f:
  264. for line in f:
  265. fields = line.split(':')
  266. if len(fields) > 6:
  267. username = fields[0]
  268. password = fields[1]
  269. uid = int(fields[2])
  270. gid = int(fields[3])
  271. home_dir = fields[5]
  272. if not self.isUserValid(username, uid, gid):
  273. continue
  274. if self.force_uid >= 0:
  275. uid = self.force_uid
  276. if self.force_gid >= 0:
  277. gid = self.force_gid
  278. permissions = self.SFTPGoRestAPI.buildPermissions(['*'], [])
  279. self.addUser(self.SFTPGoRestAPI.buildUserObject(0, username, password, [], home_dir, uid, gid, 0, 0,
  280. 0, permissions, 0, 0, 1, 0))
  281. def convertPureFTPDIP(self, fields):
  282. result = []
  283. if not fields:
  284. return result
  285. for v in fields.split(","):
  286. ip_mask = v.strip()
  287. if not ip_mask:
  288. continue
  289. if ip_mask.count(".") < 3 and ip_mask.count(":") < 3:
  290. print("cannot import pure-ftpd IP: {}".format(ip_mask))
  291. continue
  292. if "/" not in ip_mask:
  293. ip_mask += "/32"
  294. result.append(ip_mask)
  295. return result
  296. def convertFromPureFTPD(self):
  297. with open(self.input_file, 'r') as f:
  298. for line in f:
  299. fields = line.split(':')
  300. if len(fields) > 16:
  301. username = fields[0]
  302. password = fields[1]
  303. uid = int(fields[2])
  304. gid = int(fields[3])
  305. home_dir = fields[5]
  306. upload_bandwidth = 0
  307. if fields[6]:
  308. upload_bandwidth = int(int(fields[6]) / 1024)
  309. download_bandwidth = 0
  310. if fields[7]:
  311. download_bandwidth = int(int(fields[7]) / 1024)
  312. max_sessions = 0
  313. if fields[10]:
  314. max_sessions = int(fields[10])
  315. quota_files = 0
  316. if fields[11]:
  317. quota_files = int(fields[11])
  318. quota_size = 0
  319. if fields[12]:
  320. quota_size = int(fields[12])
  321. allowed_ip = self.convertPureFTPDIP(fields[15])
  322. denied_ip = self.convertPureFTPDIP(fields[16])
  323. if not self.isUserValid(username, uid, gid):
  324. continue
  325. if self.force_uid >= 0:
  326. uid = self.force_uid
  327. if self.force_gid >= 0:
  328. gid = self.force_gid
  329. permissions = self.SFTPGoRestAPI.buildPermissions(['*'], [])
  330. self.addUser(self.SFTPGoRestAPI.buildUserObject(0, username, password, [], home_dir, uid, gid,
  331. max_sessions, quota_size, quota_files, permissions,
  332. upload_bandwidth, download_bandwidth, 1, 0, allowed_ip,
  333. denied_ip))
  334. def validDate(s):
  335. if not s:
  336. return datetime.fromtimestamp(0)
  337. try:
  338. return datetime.strptime(s, "%Y-%m-%d")
  339. except ValueError:
  340. msg = "Not a valid date: '{0}'.".format(s)
  341. raise argparse.ArgumentTypeError(msg)
  342. def getDatetimeAsMillisSinceEpoch(dt):
  343. epoch = datetime.fromtimestamp(0)
  344. return int((dt - epoch).total_seconds() * 1000)
  345. def addCommonUserArguments(parser):
  346. parser.add_argument('username', type=str)
  347. parser.add_argument('-P', '--password', type=str, default=None, help='Default: %(default)s')
  348. parser.add_argument('-K', '--public-keys', type=str, nargs='+', default=[], help='Default: %(default)s')
  349. parser.add_argument('-H', '--home-dir', type=str, default='', help='Default: %(default)s')
  350. parser.add_argument('--uid', type=int, default=0, help='Default: %(default)s')
  351. parser.add_argument('--gid', type=int, default=0, help='Default: %(default)s')
  352. parser.add_argument('-C', '--max-sessions', type=int, default=0,
  353. help='Maximum concurrent sessions. 0 means unlimited. Default: %(default)s')
  354. parser.add_argument('-S', '--quota-size', type=int, default=0,
  355. help='Maximum size allowed as bytes. 0 means unlimited. Default: %(default)s')
  356. parser.add_argument('-F', '--quota-files', type=int, default=0, help="default: %(default)s")
  357. parser.add_argument('-G', '--permissions', type=str, nargs='+', default=[],
  358. choices=['*', 'list', 'download', 'upload', 'overwrite', 'delete', 'rename', 'create_dirs',
  359. 'create_symlinks', 'chmod', 'chown', 'chtimes'], help='Permissions for the root directory '
  360. +'(/). Default: %(default)s')
  361. parser.add_argument('--subdirs-permissions', type=str, nargs='*', default=[], help='Permissions for subdirs. '
  362. +'For example: "/somedir:list,download" "/otherdir/subdir:*" Default: %(default)s')
  363. parser.add_argument('-U', '--upload-bandwidth', type=int, default=0,
  364. help='Maximum upload bandwidth as KB/s, 0 means unlimited. Default: %(default)s')
  365. parser.add_argument('-D', '--download-bandwidth', type=int, default=0,
  366. help='Maximum download bandwidth as KB/s, 0 means unlimited. Default: %(default)s')
  367. parser.add_argument('--status', type=int, choices=[0, 1], default=1,
  368. help='User\'s status. 1 enabled, 0 disabled. Default: %(default)s')
  369. parser.add_argument('-E', '--expiration-date', type=validDate, default="",
  370. help='Expiration date as YYYY-MM-DD, empty string means no expiration. Default: %(default)s')
  371. parser.add_argument('-Y', '--allowed-ip', type=str, nargs='+', default=[],
  372. help='Allowed IP/Mask in CIDR notation. For example "192.168.2.0/24" or "2001:db8::/32". Default: %(default)s')
  373. parser.add_argument('-N', '--denied-ip', type=str, nargs='+', default=[],
  374. help='Denied IP/Mask in CIDR notation. For example "192.168.2.0/24" or "2001:db8::/32". Default: %(default)s')
  375. parser.add_argument('--fs', type=str, default='local', choices=['local', 'S3'],
  376. help='Filesystem provider. Default: %(default)s')
  377. parser.add_argument('--s3-bucket', type=str, default='', help='Default: %(default)s')
  378. parser.add_argument('--s3-region', type=str, default='', help='Default: %(default)s')
  379. parser.add_argument('--s3-access-key', type=str, default='', help='Default: %(default)s')
  380. parser.add_argument('--s3-access-secret', type=str, default='', help='Default: %(default)s')
  381. parser.add_argument('--s3-endpoint', type=str, default='', help='Default: %(default)s')
  382. parser.add_argument('--s3-storage-class', type=str, default='', help='Default: %(default)s')
  383. if __name__ == '__main__':
  384. parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
  385. parser.add_argument('-b', '--base-url', type=str, default='http://127.0.0.1:8080',
  386. help='Base URL for SFTPGo REST API. Default: %(default)s')
  387. parser.add_argument('-a', '--auth-type', type=str, default=None, choices=['basic', 'digest'],
  388. help='HTTP authentication type. Default: %(default)s')
  389. parser.add_argument("-u", "--auth-user", type=str, default="",
  390. help='User for HTTP authentication. Default: %(default)s')
  391. parser.add_argument('-p', '--auth-password', type=str, default='',
  392. help='Password for HTTP authentication. Default: %(default)s')
  393. parser.add_argument('-d', '--debug', dest='debug', action='store_true')
  394. parser.set_defaults(debug=False)
  395. parser.add_argument('-i', '--insecure', dest='secure', action='store_false',
  396. help='Set to false to ignore verifying the SSL certificate')
  397. parser.set_defaults(secure=True)
  398. has_colors_default = pygments is not None and platform.system() != "Windows"
  399. group = parser.add_mutually_exclusive_group(required=False)
  400. group.add_argument('-t', '--no-color', dest='no_color', action='store_true', default=(not has_colors_default),
  401. help='Disable color highlight for JSON responses. You need python pygments module 1.5 or above to have highlighted output')
  402. group.add_argument('-c', '--color', dest='no_color', action='store_false', default=has_colors_default,
  403. help='Enable color highlight for JSON responses. You need python pygments module 1.5 or above to have highlighted output')
  404. parser.add_argument_group(group)
  405. subparsers = parser.add_subparsers(dest='command', help='sub-command --help')
  406. subparsers.required = True
  407. parserAddUser = subparsers.add_parser('add-user', help='Add a new SFTP user')
  408. addCommonUserArguments(parserAddUser)
  409. parserUpdateUser = subparsers.add_parser('update-user', help='Update an existing user')
  410. parserUpdateUser.add_argument('id', type=int, help='User\'s ID to update')
  411. addCommonUserArguments(parserUpdateUser)
  412. parserDeleteUser = subparsers.add_parser('delete-user', help='Delete an existing user')
  413. parserDeleteUser.add_argument('id', type=int, help='User\'s ID to delete')
  414. parserGetUsers = subparsers.add_parser('get-users', help='Returns an array with one or more SFTP users')
  415. parserGetUsers.add_argument('-L', '--limit', type=int, default=100, choices=range(1, 501),
  416. help='Maximum allowed value is 500. Default: %(default)s', metavar='[1...500]')
  417. parserGetUsers.add_argument('-O', '--offset', type=int, default=0, help='Default: %(default)s')
  418. parserGetUsers.add_argument('-U', '--username', type=str, default='', help='Default: %(default)s')
  419. parserGetUsers.add_argument('-S', '--order', type=str, choices=['ASC', 'DESC'], default='ASC',
  420. help='default: %(default)s')
  421. parserGetUserByID = subparsers.add_parser('get-user-by-id', help='Find user by ID')
  422. parserGetUserByID.add_argument('id', type=int)
  423. parserGetConnections = subparsers.add_parser('get-connections',
  424. help='Get the active users and info about their uploads/downloads')
  425. parserCloseConnection = subparsers.add_parser('close-connection', help='Terminate an active SFTP/SCP connection')
  426. parserCloseConnection.add_argument('connectionID', type=str)
  427. parserGetQuotaScans = subparsers.add_parser('get-quota-scans', help='Get the active quota scans')
  428. parserStartQuotaScans = subparsers.add_parser('start-quota-scan', help='Start a new quota scan')
  429. addCommonUserArguments(parserStartQuotaScans)
  430. parserGetVersion = subparsers.add_parser('get-version', help='Get version details')
  431. parserGetProviderStatus = subparsers.add_parser('get-provider-status', help='Get data provider status')
  432. parserDumpData = subparsers.add_parser('dumpdata', help='Backup SFTPGo data serializing them as JSON')
  433. parserDumpData.add_argument('output_file', type=str)
  434. parserLoadData = subparsers.add_parser('loaddata', help='Restore SFTPGo data from a JSON backup')
  435. parserLoadData.add_argument('input_file', type=str)
  436. parserLoadData.add_argument('-Q', '--scan-quota', type=int, choices=[0, 1, 2], default=0,
  437. help='0 means no quota scan after a user is added/updated. 1 means always scan quota. 2 ' +
  438. 'means scan quota if the user has quota restrictions. Default: %(default)s')
  439. parserConvertUsers = subparsers.add_parser('convert-users', help='Convert users to a JSON format suitable to use with loadddata')
  440. supportedUsersFormats = []
  441. help_text = ''
  442. if pwd is not None:
  443. supportedUsersFormats.append("unix-passwd")
  444. 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'
  445. supportedUsersFormats.append("pure-ftpd")
  446. supportedUsersFormats.append("proftpd")
  447. parserConvertUsers.add_argument('input_file', type=str)
  448. parserConvertUsers.add_argument('users_format', type=str, choices=supportedUsersFormats, help=help_text)
  449. parserConvertUsers.add_argument('output_file', type=str)
  450. parserConvertUsers.add_argument('--min-uid', type=int, default=-1, help='if >= 0 only import users with UID greater ' +
  451. 'or equal to this value. Default: %(default)s')
  452. parserConvertUsers.add_argument('--max-uid', type=int, default=-1, help='if >= 0 only import users with UID lesser ' +
  453. 'or equal to this value. Default: %(default)s')
  454. parserConvertUsers.add_argument('--usernames', type=str, nargs='+', default=[], help='Only import users with these ' +
  455. 'usernames. Default: %(default)s')
  456. parserConvertUsers.add_argument('--force-uid', type=int, default=-1, help='if >= 0 the imported users will have this UID in SFTPGo. Default: %(default)s')
  457. parserConvertUsers.add_argument('--force-gid', type=int, default=-1, help='if >= 0 the imported users will have this GID in SFTPGp. Default: %(default)s')
  458. args = parser.parse_args()
  459. api = SFTPGoApiRequests(args.debug, args.base_url, args.auth_type, args.auth_user, args.auth_password, args.secure,
  460. args.no_color)
  461. if args.command == 'add-user':
  462. api.addUser(args.username, args.password, args.public_keys, args.home_dir, args.uid, args.gid, args.max_sessions,
  463. args.quota_size, args.quota_files, args.permissions, args.upload_bandwidth, args.download_bandwidth,
  464. args.status, getDatetimeAsMillisSinceEpoch(args.expiration_date), args.subdirs_permissions, args.allowed_ip,
  465. args.denied_ip, args.fs, args.s3_bucket, args.s3_region, args.s3_access_key, args.s3_access_secret,
  466. args.s3_endpoint, args.s3_storage_class)
  467. elif args.command == 'update-user':
  468. api.updateUser(args.id, args.username, args.password, args.public_keys, args.home_dir, args.uid, args.gid,
  469. args.max_sessions, args.quota_size, args.quota_files, args.permissions, args.upload_bandwidth,
  470. args.download_bandwidth, args.status, getDatetimeAsMillisSinceEpoch(args.expiration_date),
  471. args.subdirs_permissions, args.allowed_ip, args.denied_ip, args.fs, args.s3_bucket, args.s3_region,
  472. args.s3_access_key, args.s3_access_secret, args.s3_endpoint, args.s3_storage_class)
  473. elif args.command == 'delete-user':
  474. api.deleteUser(args.id)
  475. elif args.command == 'get-users':
  476. api.getUsers(args.limit, args.offset, args.order, args.username)
  477. elif args.command == 'get-user-by-id':
  478. api.getUserByID(args.id)
  479. elif args.command == 'get-connections':
  480. api.getConnections()
  481. elif args.command == 'close-connection':
  482. api.closeConnection(args.connectionID)
  483. elif args.command == 'get-quota-scans':
  484. api.getQuotaScans()
  485. elif args.command == 'start-quota-scan':
  486. api.startQuotaScan(args.username)
  487. elif args.command == 'get-version':
  488. api.getVersion()
  489. elif args.command == 'get-provider-status':
  490. api.getProviderStatus()
  491. elif args.command == 'dumpdata':
  492. api.dumpData(args.output_file)
  493. elif args.command == 'loaddata':
  494. api.loadData(args.input_file, args.scan_quota)
  495. elif args.command == 'convert-users':
  496. convertUsers = ConvertUsers(args.input_file, args.users_format, args.output_file, args.min_uid, args.max_uid,
  497. args.usernames, args.force_uid, args.force_gid)
  498. convertUsers.setSFTPGoRestApi(api)
  499. convertUsers.convert()