sftpgo_api_cli.py 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. #!/usr/bin/env python
  2. import argparse
  3. import json
  4. import requests
  5. try:
  6. import urllib.parse as urlparse
  7. except ImportError:
  8. import urlparse
  9. class SFTPGoApiRequests:
  10. def __init__(self, debug, baseUrl):
  11. self.userPath = urlparse.urljoin(baseUrl, "/api/v1/user")
  12. self.quotaScanPath = urlparse.urljoin(baseUrl, "/api/v1/quota_scan")
  13. self.activeConnectionsPath = urlparse.urljoin(baseUrl, "/api/v1/sftp_connection")
  14. self.debug = debug
  15. def formatAsJSON(self, text):
  16. if not text:
  17. return ""
  18. return json.dumps(json.loads(text), indent=2)
  19. def printResponse(self, r):
  20. if "content-type" in r.headers and "application/json" in r.headers["content-type"]:
  21. if self.debug:
  22. print("executed request: {} {} - status code: {} request body: {}".format(
  23. r.request.method, r.url, r.status_code, self.formatAsJSON(r.request.body)))
  24. print("got response, status code: {} body:".format(r.status_code))
  25. print(self.formatAsJSON(r.text))
  26. else:
  27. print(r.text)
  28. def buildUserObject(self, user_id=0, username="", password="", public_key="", home_dir="", uid=0,
  29. gid=0, max_sessions=0, quota_size=0, quota_files=0, permissions=[], upload_bandwidth=0,
  30. download_bandwidth=0):
  31. user = {"id":user_id, "username":username, "home_dir":home_dir, "uid":uid, "gid":gid,
  32. "max_sessions":max_sessions, "quota_size":quota_size, "quota_files":quota_files,
  33. "permissions":permissions, "upload_bandwidth":upload_bandwidth,
  34. "download_bandwidth":download_bandwidth}
  35. if password:
  36. user.update({"password":password})
  37. if public_key:
  38. user.update({"public_key":public_key})
  39. return user
  40. def getUsers(self, limit=100, offset=0, order="ASC", username=""):
  41. r = requests.get(self.userPath, params={"limit":limit, "offset":offset, "order":order,
  42. "username":username})
  43. self.printResponse(r)
  44. def getUserByID(self, user_id):
  45. r = requests.get(urlparse.urljoin(self.userPath, "user/" + str(user_id)))
  46. self.printResponse(r)
  47. def addUser(self, username="", password="", public_key="", home_dir="", uid=0, gid=0, max_sessions=0,
  48. quota_size=0, quota_files=0, permissions=[], upload_bandwidth=0, download_bandwidth=0):
  49. u = self.buildUserObject(0, username, password, public_key, home_dir, uid, gid, max_sessions,
  50. quota_size, quota_files, permissions, upload_bandwidth, download_bandwidth)
  51. r = requests.post(self.userPath, json=u)
  52. self.printResponse(r)
  53. def updateUser(self, user_id, username="", password="", public_key="", home_dir="", uid=0, gid=0,
  54. max_sessions=0, quota_size=0, quota_files=0, permissions=[], upload_bandwidth=0,
  55. download_bandwidth=0):
  56. u = self.buildUserObject(user_id, username, password, public_key, home_dir, uid, gid, max_sessions,
  57. quota_size, quota_files, permissions, upload_bandwidth, download_bandwidth)
  58. r = requests.put(urlparse.urljoin(self.userPath, "user/" + str(user_id)), json=u)
  59. self.printResponse(r)
  60. def deleteUser(self, user_id):
  61. r = requests.delete(urlparse.urljoin(self.userPath, "user/" + str(user_id)))
  62. self.printResponse(r)
  63. def getSFTPConnections(self):
  64. r = requests.get(self.activeConnectionsPath)
  65. self.printResponse(r)
  66. def closeSFTPConnection(self, connectionID):
  67. r = requests.delete(urlparse.urljoin(self.userPath, "sftp_connection/" + str(connectionID)))
  68. self.printResponse(r)
  69. def getQuotaScans(self):
  70. r = requests.get(self.quotaScanPath)
  71. self.printResponse(r)
  72. def startQuotaScan(self, username):
  73. u = self.buildUserObject(0, username)
  74. r = requests.post(self.quotaScanPath, json=u)
  75. self.printResponse(r)
  76. def addCommonUserArguments(parser):
  77. parser.add_argument('username', type=str)
  78. parser.add_argument('--password', type=str, default="", help="default: %(default)s")
  79. parser.add_argument('--public_key', type=str, nargs='+', default=[], help="default: %(default)s")
  80. parser.add_argument('--home_dir', type=str, default="", help="default: %(default)s")
  81. parser.add_argument('--uid', type=int, default=0, help="default: %(default)s")
  82. parser.add_argument('--gid', type=int, default=0, help="default: %(default)s")
  83. parser.add_argument('--max_sessions', type=int, default=0, help="default: %(default)s")
  84. parser.add_argument('--quota_size', type=int, default=0, help="default: %(default)s")
  85. parser.add_argument('--quota_files', type=int, default=0, help="default: %(default)s")
  86. parser.add_argument('--permissions', type=str, nargs='+', default=[],
  87. choices=['*', 'list', 'download', 'upload', 'delete', 'rename', 'create_dirs',
  88. 'create_symlinks'], help="default: %(default)s")
  89. parser.add_argument('--upload_bandwidth', type=int, default=0, help="default: %(default)s")
  90. parser.add_argument('--download_bandwidth', type=int, default=0, help="default: %(default)s")
  91. if __name__ == '__main__':
  92. parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
  93. parser.add_argument("--base_url", type=str, default="http://127.0.0.1:8080",
  94. help="Base URL for SFTPGo REST API. Default: %(default)s")
  95. parser.add_argument("--debug", dest='debug', action='store_true')
  96. parser.set_defaults(debug=False)
  97. subparsers = parser.add_subparsers(dest="command", help='sub-command --help')
  98. subparsers.required = True
  99. parserAddUser = subparsers.add_parser("add_user", help="Add a new SFTP user")
  100. addCommonUserArguments(parserAddUser)
  101. parserUpdateUser = subparsers.add_parser("update_user", help="Update an existing user")
  102. parserUpdateUser.add_argument('id', type=int)
  103. addCommonUserArguments(parserUpdateUser)
  104. parserDeleteUser = subparsers.add_parser("delete_user", help="Delete an existing user")
  105. parserDeleteUser.add_argument('id', type=int)
  106. parserGetUsers = subparsers.add_parser("get_users", help="Returns an array with one or more SFTP users")
  107. parserGetUsers.add_argument('--limit', type=int, default=100, help="default: %(default)s")
  108. parserGetUsers.add_argument('--offset', type=int, default=0, help="default: %(default)s")
  109. parserGetUsers.add_argument('--username', type=str, default="", help="default: %(default)s")
  110. parserGetUsers.add_argument('--order', type=str, choices=['ASC', 'DESC'], default='ASC',
  111. help="default: %(default)s")
  112. parserGetUserByID = subparsers.add_parser("get_user_by_id", help="Find user by ID")
  113. parserGetUserByID.add_argument('id', type=int)
  114. parserGetSFTPConnections = subparsers.add_parser("get_sftp_connections", help="Get the active sftp users and info about their uploads/downloads")
  115. parserCloseSFTPConnection = subparsers.add_parser("close_sftp_connection", help="Terminate an active SFTP connection")
  116. parserCloseSFTPConnection.add_argument("connectionID", type=str)
  117. parserGetQuotaScans = subparsers.add_parser("get_quota_scans", help="Get the active quota scans")
  118. parserStartQuotaScans = subparsers.add_parser("start_quota_scan", help="Start a new quota scan")
  119. addCommonUserArguments(parserStartQuotaScans)
  120. args = parser.parse_args()
  121. api = SFTPGoApiRequests(args.debug, args.base_url)
  122. if args.command == "add_user":
  123. api.addUser(args.username, args.password, args.public_key, args.home_dir,
  124. args.uid, args.gid, args.max_sessions, args.quota_size, args.quota_files,
  125. args.permissions, args.upload_bandwidth, args.download_bandwidth)
  126. elif args.command == "update_user":
  127. api.updateUser(args.id, args.username, args.password, args.public_key, args.home_dir,
  128. args.uid, args.gid, args.max_sessions, args.quota_size, args.quota_files,
  129. args.permissions, args.upload_bandwidth, args.download_bandwidth)
  130. elif args.command == "delete_user":
  131. api.deleteUser(args.id)
  132. elif args.command == "get_users":
  133. api.getUsers(args.limit, args.offset, args.order, args.username)
  134. elif args.command == "get_user_by_id":
  135. api.getUserByID(args.id)
  136. elif args.command == "get_sftp_connections":
  137. api.getSFTPConnections()
  138. elif args.command == "close_sftp_connection":
  139. api.closeSFTPConnection(args.connectionID)
  140. elif args.command == "get_quota_scans":
  141. api.getQuotaScans()
  142. elif args.command == "start_quota_scan":
  143. api.startQuotaScan(args.username)