api.go 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. package main
  2. import (
  3. "encoding/json"
  4. "net/http"
  5. "net/http/pprof"
  6. "imuslab.com/zoraxy/mod/acme/acmedns"
  7. "imuslab.com/zoraxy/mod/acme/acmewizard"
  8. "imuslab.com/zoraxy/mod/auth"
  9. "imuslab.com/zoraxy/mod/netstat"
  10. "imuslab.com/zoraxy/mod/netutils"
  11. "imuslab.com/zoraxy/mod/utils"
  12. )
  13. /*
  14. API.go
  15. This file contains all the API called by the web management interface
  16. */
  17. var requireAuth = true
  18. func initAPIs(targetMux *http.ServeMux) {
  19. authRouter := auth.NewManagedHTTPRouter(auth.RouterOption{
  20. AuthAgent: authAgent,
  21. RequireAuth: requireAuth,
  22. TargetMux: targetMux,
  23. DeniedHandler: func(w http.ResponseWriter, r *http.Request) {
  24. http.Error(w, "401 - Unauthorized", http.StatusUnauthorized)
  25. },
  26. })
  27. //Register the standard web services urls
  28. fs := http.FileServer(http.FS(webres))
  29. if development {
  30. fs = http.FileServer(http.Dir("web/"))
  31. }
  32. //Add a layer of middleware for advance control
  33. advHandler := FSHandler(fs)
  34. targetMux.Handle("/", advHandler)
  35. //Authentication APIs
  36. registerAuthAPIs(requireAuth, targetMux)
  37. //Reverse proxy
  38. authRouter.HandleFunc("/api/proxy/enable", ReverseProxyHandleOnOff)
  39. authRouter.HandleFunc("/api/proxy/add", ReverseProxyHandleAddEndpoint)
  40. authRouter.HandleFunc("/api/proxy/status", ReverseProxyStatus)
  41. authRouter.HandleFunc("/api/proxy/toggle", ReverseProxyToggleRuleSet)
  42. authRouter.HandleFunc("/api/proxy/list", ReverseProxyList)
  43. authRouter.HandleFunc("/api/proxy/detail", ReverseProxyListDetail)
  44. authRouter.HandleFunc("/api/proxy/edit", ReverseProxyHandleEditEndpoint)
  45. authRouter.HandleFunc("/api/proxy/setAlias", ReverseProxyHandleAlias)
  46. authRouter.HandleFunc("/api/proxy/del", DeleteProxyEndpoint)
  47. authRouter.HandleFunc("/api/proxy/updateCredentials", UpdateProxyBasicAuthCredentials)
  48. authRouter.HandleFunc("/api/proxy/tlscheck", HandleCheckSiteSupportTLS)
  49. authRouter.HandleFunc("/api/proxy/setIncoming", HandleIncomingPortSet)
  50. authRouter.HandleFunc("/api/proxy/useHttpsRedirect", HandleUpdateHttpsRedirect)
  51. authRouter.HandleFunc("/api/proxy/listenPort80", HandleUpdatePort80Listener)
  52. authRouter.HandleFunc("/api/proxy/requestIsProxied", HandleManagementProxyCheck)
  53. authRouter.HandleFunc("/api/proxy/developmentMode", HandleDevelopmentModeChange)
  54. //Reverse proxy upstream (load balance) APIs
  55. authRouter.HandleFunc("/api/proxy/upstream/list", ReverseProxyUpstreamList)
  56. authRouter.HandleFunc("/api/proxy/upstream/add", ReverseProxyUpstreamAdd)
  57. authRouter.HandleFunc("/api/proxy/upstream/setPriority", ReverseProxyUpstreamSetPriority)
  58. authRouter.HandleFunc("/api/proxy/upstream/update", ReverseProxyUpstreamUpdate)
  59. authRouter.HandleFunc("/api/proxy/upstream/remove", ReverseProxyUpstreamDelete)
  60. //Reverse proxy virtual directory APIs
  61. authRouter.HandleFunc("/api/proxy/vdir/list", ReverseProxyListVdir)
  62. authRouter.HandleFunc("/api/proxy/vdir/add", ReverseProxyAddVdir)
  63. authRouter.HandleFunc("/api/proxy/vdir/del", ReverseProxyDeleteVdir)
  64. authRouter.HandleFunc("/api/proxy/vdir/edit", ReverseProxyEditVdir)
  65. //Reverse proxy user define header apis
  66. authRouter.HandleFunc("/api/proxy/header/list", HandleCustomHeaderList)
  67. authRouter.HandleFunc("/api/proxy/header/add", HandleCustomHeaderAdd)
  68. authRouter.HandleFunc("/api/proxy/header/remove", HandleCustomHeaderRemove)
  69. authRouter.HandleFunc("/api/proxy/header/handleHSTS", HandleHSTSState)
  70. authRouter.HandleFunc("/api/proxy/header/handleHopByHop", HandleHopByHop)
  71. authRouter.HandleFunc("/api/proxy/header/handleHostOverwrite", HandleHostOverwrite)
  72. authRouter.HandleFunc("/api/proxy/header/handlePermissionPolicy", HandlePermissionPolicy)
  73. //Reverse proxy auth related APIs
  74. authRouter.HandleFunc("/api/proxy/auth/exceptions/list", ListProxyBasicAuthExceptionPaths)
  75. authRouter.HandleFunc("/api/proxy/auth/exceptions/add", AddProxyBasicAuthExceptionPaths)
  76. authRouter.HandleFunc("/api/proxy/auth/exceptions/delete", RemoveProxyBasicAuthExceptionPaths)
  77. //TLS / SSL config
  78. authRouter.HandleFunc("/api/cert/tls", handleToggleTLSProxy)
  79. authRouter.HandleFunc("/api/cert/tlsRequireLatest", handleSetTlsRequireLatest)
  80. authRouter.HandleFunc("/api/cert/upload", handleCertUpload)
  81. authRouter.HandleFunc("/api/cert/download", handleCertDownload)
  82. authRouter.HandleFunc("/api/cert/list", handleListCertificate)
  83. authRouter.HandleFunc("/api/cert/listdomains", handleListDomains)
  84. authRouter.HandleFunc("/api/cert/checkDefault", handleDefaultCertCheck)
  85. authRouter.HandleFunc("/api/cert/delete", handleCertRemove)
  86. //SSO and Oauth
  87. authRouter.HandleFunc("/api/sso/status", ssoHandler.HandleSSOStatus)
  88. authRouter.HandleFunc("/api/sso/enable", ssoHandler.HandleSSOEnable)
  89. authRouter.HandleFunc("/api/sso/setPort", ssoHandler.HandlePortChange)
  90. authRouter.HandleFunc("/api/sso/setAuthURL", ssoHandler.HandleSetAuthURL)
  91. authRouter.HandleFunc("/api/sso/app/register", ssoHandler.HandleRegisterApp)
  92. //authRouter.HandleFunc("/api/sso/app/list", ssoHandler.HandleListApp)
  93. //authRouter.HandleFunc("/api/sso/app/remove", ssoHandler.HandleRemoveApp)
  94. authRouter.HandleFunc("/api/sso/user/list", ssoHandler.HandleListUser)
  95. authRouter.HandleFunc("/api/sso/user/add", ssoHandler.HandleAddUser)
  96. authRouter.HandleFunc("/api/sso/user/edit", ssoHandler.HandleEditUser)
  97. authRouter.HandleFunc("/api/sso/user/remove", ssoHandler.HandleRemoveUser)
  98. //Redirection config
  99. authRouter.HandleFunc("/api/redirect/list", handleListRedirectionRules)
  100. authRouter.HandleFunc("/api/redirect/add", handleAddRedirectionRule)
  101. authRouter.HandleFunc("/api/redirect/delete", handleDeleteRedirectionRule)
  102. authRouter.HandleFunc("/api/redirect/regex", handleToggleRedirectRegexpSupport)
  103. //Access Rules API
  104. authRouter.HandleFunc("/api/access/list", handleListAccessRules)
  105. authRouter.HandleFunc("/api/access/attach", handleAttachRuleToHost)
  106. authRouter.HandleFunc("/api/access/create", handleCreateAccessRule)
  107. authRouter.HandleFunc("/api/access/remove", handleRemoveAccessRule)
  108. authRouter.HandleFunc("/api/access/update", handleUpadateAccessRule)
  109. //Blacklist APIs
  110. authRouter.HandleFunc("/api/blacklist/list", handleListBlacklisted)
  111. authRouter.HandleFunc("/api/blacklist/country/add", handleCountryBlacklistAdd)
  112. authRouter.HandleFunc("/api/blacklist/country/remove", handleCountryBlacklistRemove)
  113. authRouter.HandleFunc("/api/blacklist/ip/add", handleIpBlacklistAdd)
  114. authRouter.HandleFunc("/api/blacklist/ip/remove", handleIpBlacklistRemove)
  115. authRouter.HandleFunc("/api/blacklist/enable", handleBlacklistEnable)
  116. //Whitelist APIs
  117. authRouter.HandleFunc("/api/whitelist/list", handleListWhitelisted)
  118. authRouter.HandleFunc("/api/whitelist/country/add", handleCountryWhitelistAdd)
  119. authRouter.HandleFunc("/api/whitelist/country/remove", handleCountryWhitelistRemove)
  120. authRouter.HandleFunc("/api/whitelist/ip/add", handleIpWhitelistAdd)
  121. authRouter.HandleFunc("/api/whitelist/ip/remove", handleIpWhitelistRemove)
  122. authRouter.HandleFunc("/api/whitelist/enable", handleWhitelistEnable)
  123. //Path Blocker APIs
  124. authRouter.HandleFunc("/api/pathrule/add", pathRuleHandler.HandleAddBlockingPath)
  125. authRouter.HandleFunc("/api/pathrule/list", pathRuleHandler.HandleListBlockingPath)
  126. authRouter.HandleFunc("/api/pathrule/remove", pathRuleHandler.HandleRemoveBlockingPath)
  127. //Statistic & uptime monitoring API
  128. authRouter.HandleFunc("/api/stats/summary", statisticCollector.HandleTodayStatLoad)
  129. authRouter.HandleFunc("/api/stats/countries", HandleCountryDistrSummary)
  130. authRouter.HandleFunc("/api/stats/netstat", netstatBuffers.HandleGetNetworkInterfaceStats)
  131. authRouter.HandleFunc("/api/stats/netstatgraph", netstatBuffers.HandleGetBufferedNetworkInterfaceStats)
  132. authRouter.HandleFunc("/api/stats/listnic", netstat.HandleListNetworkInterfaces)
  133. authRouter.HandleFunc("/api/utm/list", HandleUptimeMonitorListing)
  134. //Global Area Network APIs
  135. authRouter.HandleFunc("/api/gan/network/info", ganManager.HandleGetNodeID)
  136. authRouter.HandleFunc("/api/gan/network/add", ganManager.HandleAddNetwork)
  137. authRouter.HandleFunc("/api/gan/network/remove", ganManager.HandleRemoveNetwork)
  138. authRouter.HandleFunc("/api/gan/network/list", ganManager.HandleListNetwork)
  139. authRouter.HandleFunc("/api/gan/network/name", ganManager.HandleNetworkNaming)
  140. //authRouter.HandleFunc("/api/gan/network/detail", ganManager.HandleNetworkDetails)
  141. authRouter.HandleFunc("/api/gan/network/setRange", ganManager.HandleSetRanges)
  142. authRouter.HandleFunc("/api/gan/network/join", ganManager.HandleServerJoinNetwork)
  143. authRouter.HandleFunc("/api/gan/network/leave", ganManager.HandleServerLeaveNetwork)
  144. authRouter.HandleFunc("/api/gan/members/list", ganManager.HandleMemberList)
  145. authRouter.HandleFunc("/api/gan/members/ip", ganManager.HandleMemberIP)
  146. authRouter.HandleFunc("/api/gan/members/name", ganManager.HandleMemberNaming)
  147. authRouter.HandleFunc("/api/gan/members/authorize", ganManager.HandleMemberAuthorization)
  148. authRouter.HandleFunc("/api/gan/members/delete", ganManager.HandleMemberDelete)
  149. //Stream (TCP / UDP) Proxy
  150. authRouter.HandleFunc("/api/streamprox/config/add", streamProxyManager.HandleAddProxyConfig)
  151. authRouter.HandleFunc("/api/streamprox/config/edit", streamProxyManager.HandleEditProxyConfigs)
  152. authRouter.HandleFunc("/api/streamprox/config/list", streamProxyManager.HandleListConfigs)
  153. authRouter.HandleFunc("/api/streamprox/config/start", streamProxyManager.HandleStartProxy)
  154. authRouter.HandleFunc("/api/streamprox/config/stop", streamProxyManager.HandleStopProxy)
  155. authRouter.HandleFunc("/api/streamprox/config/delete", streamProxyManager.HandleRemoveProxy)
  156. authRouter.HandleFunc("/api/streamprox/config/status", streamProxyManager.HandleGetProxyStatus)
  157. //mDNS APIs
  158. authRouter.HandleFunc("/api/mdns/list", HandleMdnsListing)
  159. authRouter.HandleFunc("/api/mdns/discover", HandleMdnsScanning)
  160. //Zoraxy Analytic
  161. authRouter.HandleFunc("/api/analytic/list", AnalyticLoader.HandleSummaryList)
  162. authRouter.HandleFunc("/api/analytic/load", AnalyticLoader.HandleLoadTargetDaySummary)
  163. authRouter.HandleFunc("/api/analytic/loadRange", AnalyticLoader.HandleLoadTargetRangeSummary)
  164. authRouter.HandleFunc("/api/analytic/exportRange", AnalyticLoader.HandleRangeExport)
  165. authRouter.HandleFunc("/api/analytic/resetRange", AnalyticLoader.HandleRangeReset)
  166. //Network utilities
  167. authRouter.HandleFunc("/api/tools/ipscan", HandleIpScan)
  168. authRouter.HandleFunc("/api/tools/traceroute", netutils.HandleTraceRoute)
  169. authRouter.HandleFunc("/api/tools/ping", netutils.HandlePing)
  170. authRouter.HandleFunc("/api/tools/whois", netutils.HandleWhois)
  171. authRouter.HandleFunc("/api/tools/webssh", HandleCreateProxySession)
  172. authRouter.HandleFunc("/api/tools/websshSupported", HandleWebSshSupportCheck)
  173. authRouter.HandleFunc("/api/tools/wol", HandleWakeOnLan)
  174. authRouter.HandleFunc("/api/tools/smtp/get", HandleSMTPGet)
  175. authRouter.HandleFunc("/api/tools/smtp/set", HandleSMTPSet)
  176. authRouter.HandleFunc("/api/tools/smtp/admin", HandleAdminEmailGet)
  177. authRouter.HandleFunc("/api/tools/smtp/test", HandleTestEmailSend)
  178. authRouter.HandleFunc("/api/tools/fwdproxy/enable", forwardProxy.HandleToogle)
  179. authRouter.HandleFunc("/api/tools/fwdproxy/port", forwardProxy.HandlePort)
  180. //Account Reset
  181. targetMux.HandleFunc("/api/account/reset", HandleAdminAccountResetEmail)
  182. targetMux.HandleFunc("/api/account/new", HandleNewPasswordSetup)
  183. //ACME & Auto Renewer
  184. authRouter.HandleFunc("/api/acme/listExpiredDomains", acmeHandler.HandleGetExpiredDomains)
  185. authRouter.HandleFunc("/api/acme/obtainCert", AcmeCheckAndHandleRenewCertificate)
  186. authRouter.HandleFunc("/api/acme/autoRenew/enable", acmeAutoRenewer.HandleAutoRenewEnable)
  187. authRouter.HandleFunc("/api/acme/autoRenew/ca", HandleACMEPreferredCA)
  188. authRouter.HandleFunc("/api/acme/autoRenew/email", acmeAutoRenewer.HandleACMEEmail)
  189. authRouter.HandleFunc("/api/acme/autoRenew/setDomains", acmeAutoRenewer.HandleSetAutoRenewDomains)
  190. authRouter.HandleFunc("/api/acme/autoRenew/setEAB", acmeAutoRenewer.HanldeSetEAB)
  191. authRouter.HandleFunc("/api/acme/autoRenew/setDNS", acmeAutoRenewer.HanldeSetDNS)
  192. authRouter.HandleFunc("/api/acme/autoRenew/listDomains", acmeAutoRenewer.HandleLoadAutoRenewDomains)
  193. authRouter.HandleFunc("/api/acme/autoRenew/renewPolicy", acmeAutoRenewer.HandleRenewPolicy)
  194. authRouter.HandleFunc("/api/acme/autoRenew/renewNow", acmeAutoRenewer.HandleRenewNow)
  195. authRouter.HandleFunc("/api/acme/dns/providers", acmedns.HandleServeProvidersJson)
  196. authRouter.HandleFunc("/api/acme/wizard", acmewizard.HandleGuidedStepCheck) //ACME Wizard
  197. //Static Web Server
  198. authRouter.HandleFunc("/api/webserv/status", staticWebServer.HandleGetStatus)
  199. authRouter.HandleFunc("/api/webserv/start", staticWebServer.HandleStartServer)
  200. authRouter.HandleFunc("/api/webserv/stop", staticWebServer.HandleStopServer)
  201. authRouter.HandleFunc("/api/webserv/setPort", HandleStaticWebServerPortChange)
  202. authRouter.HandleFunc("/api/webserv/setDirList", staticWebServer.SetEnableDirectoryListing)
  203. if *allowWebFileManager {
  204. //Web Directory Manager file operation functions
  205. authRouter.HandleFunc("/api/fs/list", staticWebServer.FileManager.HandleList)
  206. authRouter.HandleFunc("/api/fs/upload", staticWebServer.FileManager.HandleUpload)
  207. authRouter.HandleFunc("/api/fs/download", staticWebServer.FileManager.HandleDownload)
  208. authRouter.HandleFunc("/api/fs/newFolder", staticWebServer.FileManager.HandleNewFolder)
  209. authRouter.HandleFunc("/api/fs/copy", staticWebServer.FileManager.HandleFileCopy)
  210. authRouter.HandleFunc("/api/fs/move", staticWebServer.FileManager.HandleFileMove)
  211. authRouter.HandleFunc("/api/fs/properties", staticWebServer.FileManager.HandleFileProperties)
  212. authRouter.HandleFunc("/api/fs/del", staticWebServer.FileManager.HandleFileDelete)
  213. }
  214. //Docker UX Optimizations
  215. authRouter.HandleFunc("/api/docker/available", DockerUXOptimizer.HandleDockerAvailable)
  216. authRouter.HandleFunc("/api/docker/containers", DockerUXOptimizer.HandleDockerContainersList)
  217. //Others
  218. targetMux.HandleFunc("/api/info/x", HandleZoraxyInfo)
  219. authRouter.HandleFunc("/api/info/geoip", HandleGeoIpLookup)
  220. authRouter.HandleFunc("/api/conf/export", ExportConfigAsZip)
  221. authRouter.HandleFunc("/api/conf/import", ImportConfigFromZip)
  222. authRouter.HandleFunc("/api/log/list", LogViewer.HandleListLog)
  223. authRouter.HandleFunc("/api/log/read", LogViewer.HandleReadLog)
  224. //Debug
  225. authRouter.HandleFunc("/api/info/pprof", pprof.Index)
  226. //If you got APIs to add, append them here
  227. }
  228. // Function to renders Auth related APIs
  229. func registerAuthAPIs(requireAuth bool, targetMux *http.ServeMux) {
  230. //Auth APIs
  231. targetMux.HandleFunc("/api/auth/login", authAgent.HandleLogin)
  232. targetMux.HandleFunc("/api/auth/logout", authAgent.HandleLogout)
  233. targetMux.HandleFunc("/api/auth/checkLogin", func(w http.ResponseWriter, r *http.Request) {
  234. if requireAuth {
  235. authAgent.CheckLogin(w, r)
  236. } else {
  237. utils.SendJSONResponse(w, "true")
  238. }
  239. })
  240. targetMux.HandleFunc("/api/auth/username", func(w http.ResponseWriter, r *http.Request) {
  241. username, err := authAgent.GetUserName(w, r)
  242. if err != nil {
  243. http.Error(w, http.StatusText(http.StatusUnauthorized), http.StatusUnauthorized)
  244. return
  245. }
  246. js, _ := json.Marshal(username)
  247. utils.SendJSONResponse(w, string(js))
  248. })
  249. targetMux.HandleFunc("/api/auth/userCount", func(w http.ResponseWriter, r *http.Request) {
  250. uc := authAgent.GetUserCounts()
  251. js, _ := json.Marshal(uc)
  252. utils.SendJSONResponse(w, string(js))
  253. })
  254. targetMux.HandleFunc("/api/auth/register", func(w http.ResponseWriter, r *http.Request) {
  255. if authAgent.GetUserCounts() == 0 {
  256. //Allow register root admin
  257. authAgent.HandleRegisterWithoutEmail(w, r, func(username, reserved string) {
  258. })
  259. } else {
  260. //This function is disabled
  261. utils.SendErrorResponse(w, "Root management account already exists")
  262. }
  263. })
  264. targetMux.HandleFunc("/api/auth/changePassword", func(w http.ResponseWriter, r *http.Request) {
  265. username, err := authAgent.GetUserName(w, r)
  266. if err != nil {
  267. http.Error(w, "401 - Unauthorized", http.StatusUnauthorized)
  268. return
  269. }
  270. oldPassword, err := utils.PostPara(r, "oldPassword")
  271. if err != nil {
  272. utils.SendErrorResponse(w, "empty current password")
  273. return
  274. }
  275. newPassword, err := utils.PostPara(r, "newPassword")
  276. if err != nil {
  277. utils.SendErrorResponse(w, "empty new password")
  278. return
  279. }
  280. confirmPassword, _ := utils.PostPara(r, "confirmPassword")
  281. if newPassword != confirmPassword {
  282. utils.SendErrorResponse(w, "confirm password not match")
  283. return
  284. }
  285. //Check if the old password correct
  286. oldPasswordCorrect, _ := authAgent.ValidateUsernameAndPasswordWithReason(username, oldPassword)
  287. if !oldPasswordCorrect {
  288. utils.SendErrorResponse(w, "Invalid current password given")
  289. return
  290. }
  291. //Change the password of the root user
  292. authAgent.UnregisterUser(username)
  293. authAgent.CreateUserAccount(username, newPassword, "")
  294. })
  295. }