ext_client.go 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074
  1. package controller
  2. import (
  3. "context"
  4. "encoding/json"
  5. "errors"
  6. "fmt"
  7. "net"
  8. "net/http"
  9. "os"
  10. "reflect"
  11. "strconv"
  12. "strings"
  13. "github.com/go-playground/validator/v10"
  14. "github.com/gorilla/mux"
  15. "github.com/gravitl/netmaker/database"
  16. "github.com/gravitl/netmaker/db"
  17. "github.com/gravitl/netmaker/logger"
  18. "github.com/gravitl/netmaker/logic"
  19. "github.com/gravitl/netmaker/schema"
  20. "github.com/gravitl/netmaker/servercfg"
  21. "github.com/gravitl/netmaker/models"
  22. "github.com/gravitl/netmaker/mq"
  23. "github.com/skip2/go-qrcode"
  24. "golang.org/x/exp/slices"
  25. "golang.org/x/exp/slog"
  26. "golang.zx2c4.com/wireguard/wgctrl/wgtypes"
  27. )
  28. func extClientHandlers(r *mux.Router) {
  29. r.HandleFunc("/api/extclients", logic.SecurityCheck(true, http.HandlerFunc(getAllExtClients))).
  30. Methods(http.MethodGet)
  31. r.HandleFunc("/api/extclients/{network}", logic.SecurityCheck(true, http.HandlerFunc(getNetworkExtClients))).
  32. Methods(http.MethodGet)
  33. r.HandleFunc("/api/extclients/{network}/{clientid}", logic.SecurityCheck(false, http.HandlerFunc(getExtClient))).
  34. Methods(http.MethodGet)
  35. r.HandleFunc("/api/extclients/{network}/{clientid}/{type}", logic.SecurityCheck(false, http.HandlerFunc(getExtClientConf))).
  36. Methods(http.MethodGet)
  37. r.HandleFunc("/api/extclients/{network}/{clientid}", logic.SecurityCheck(false, http.HandlerFunc(updateExtClient))).
  38. Methods(http.MethodPut)
  39. r.HandleFunc("/api/extclients/{network}/{clientid}", logic.SecurityCheck(false, http.HandlerFunc(deleteExtClient))).
  40. Methods(http.MethodDelete)
  41. r.HandleFunc("/api/extclients/{network}/{nodeid}", logic.SecurityCheck(false, checkFreeTierLimits(limitChoiceMachines, http.HandlerFunc(createExtClient)))).
  42. Methods(http.MethodPost)
  43. r.HandleFunc("/api/v1/client_conf/{network}", logic.SecurityCheck(false, http.HandlerFunc(getExtClientHAConf))).Methods(http.MethodGet)
  44. }
  45. func checkIngressExists(nodeID string) bool {
  46. node, err := logic.GetNodeByID(nodeID)
  47. if err != nil {
  48. return false
  49. }
  50. return node.IsIngressGateway
  51. }
  52. // @Summary Get all remote access client associated with network
  53. // @Router /api/extclients/{network} [get]
  54. // @Tags Remote Access Client
  55. // @Security oauth2
  56. // @Success 200 {object} models.ExtClient
  57. // @Failure 500 {object} models.ErrorResponse
  58. func getNetworkExtClients(w http.ResponseWriter, r *http.Request) {
  59. w.Header().Set("Content-Type", "application/json")
  60. var extclients []models.ExtClient
  61. var params = mux.Vars(r)
  62. network := params["network"]
  63. extclients, err := logic.GetNetworkExtClients(network)
  64. if err != nil {
  65. logger.Log(0, r.Header.Get("user"),
  66. fmt.Sprintf("failed to get ext clients for network [%s]: %v", network, err))
  67. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  68. return
  69. }
  70. //Returns all the extclients in JSON format
  71. w.WriteHeader(http.StatusOK)
  72. json.NewEncoder(w).Encode(extclients)
  73. }
  74. // @Summary Fetches All Remote Access Clients across all networks
  75. // @Router /api/extclients [get]
  76. // @Tags Remote Access Client
  77. // @Security oauth2
  78. // @Success 200 {object} models.ExtClient
  79. // @Failure 500 {object} models.ErrorResponse
  80. // Not quite sure if this is necessary. Probably necessary based on front end but may
  81. // want to review after iteration 1 if it's being used or not
  82. func getAllExtClients(w http.ResponseWriter, r *http.Request) {
  83. w.Header().Set("Content-Type", "application/json")
  84. clients, err := logic.GetAllExtClients()
  85. if err != nil && !database.IsEmptyRecord(err) {
  86. logger.Log(0, "failed to get all extclients: ", err.Error())
  87. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  88. return
  89. }
  90. //Return all the extclients in JSON format
  91. logic.SortExtClient(clients[:])
  92. w.WriteHeader(http.StatusOK)
  93. json.NewEncoder(w).Encode(clients)
  94. }
  95. // @Summary Get an individual remote access client
  96. // @Router /api/extclients/{network}/{clientid} [get]
  97. // @Tags Remote Access Client
  98. // @Security oauth2
  99. // @Success 200 {object} models.ExtClient
  100. // @Failure 500 {object} models.ErrorResponse
  101. // @Failure 403 {object} models.ErrorResponse
  102. func getExtClient(w http.ResponseWriter, r *http.Request) {
  103. // set header.
  104. w.Header().Set("Content-Type", "application/json")
  105. var params = mux.Vars(r)
  106. clientid := params["clientid"]
  107. network := params["network"]
  108. client, err := logic.GetExtClient(clientid, network)
  109. if err != nil {
  110. logger.Log(
  111. 0,
  112. r.Header.Get("user"),
  113. fmt.Sprintf("failed to get extclient for [%s] on network [%s]: %v",
  114. clientid, network, err),
  115. )
  116. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  117. return
  118. }
  119. gwNode, err := logic.GetNodeByID(client.IngressGatewayID)
  120. if err != nil {
  121. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  122. return
  123. }
  124. logic.SetDNSOnWgConfig(&gwNode, &client)
  125. w.WriteHeader(http.StatusOK)
  126. json.NewEncoder(w).Encode(client)
  127. }
  128. // @Summary Get an individual remote access client
  129. // @Router /api/extclients/{network}/{clientid}/{type} [get]
  130. // @Tags Remote Access Client
  131. // @Security oauth2
  132. // @Success 200 {object} models.ExtClient
  133. // @Failure 500 {object} models.ErrorResponse
  134. // @Failure 403 {object} models.ErrorResponse
  135. func getExtClientConf(w http.ResponseWriter, r *http.Request) {
  136. // set header.
  137. w.Header().Set("Content-Type", "application/json")
  138. var params = mux.Vars(r)
  139. clientid := params["clientid"]
  140. networkid := params["network"]
  141. client, err := logic.GetExtClient(clientid, networkid)
  142. if err != nil {
  143. logger.Log(
  144. 0,
  145. r.Header.Get("user"),
  146. fmt.Sprintf("failed to get extclient for [%s] on network [%s]: %v",
  147. clientid, networkid, err),
  148. )
  149. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  150. return
  151. }
  152. gwnode, err := logic.GetNodeByID(client.IngressGatewayID)
  153. if err != nil {
  154. logger.Log(
  155. 0,
  156. r.Header.Get("user"),
  157. fmt.Sprintf(
  158. "failed to get ingress gateway node [%s] info: %v",
  159. client.IngressGatewayID,
  160. err,
  161. ),
  162. )
  163. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  164. return
  165. }
  166. eli, _ := (&schema.Egress{Network: gwnode.Network}).ListByNetwork(db.WithContext(context.TODO()))
  167. acls, _ := logic.ListAclsByNetwork(models.NetworkID(client.Network))
  168. logic.GetNodeEgressInfo(&gwnode, eli, acls)
  169. host, err := logic.GetHost(gwnode.HostID.String())
  170. if err != nil {
  171. logger.Log(
  172. 0,
  173. r.Header.Get("user"),
  174. fmt.Sprintf(
  175. "failed to get host for ingress gateway node [%s] info: %v",
  176. client.IngressGatewayID,
  177. err,
  178. ),
  179. )
  180. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  181. return
  182. }
  183. network, err := logic.GetParentNetwork(client.Network)
  184. if err != nil {
  185. logger.Log(
  186. 1,
  187. r.Header.Get("user"),
  188. "Could not retrieve Ingress Gateway Network",
  189. client.Network,
  190. )
  191. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  192. return
  193. }
  194. preferredIp := strings.TrimSpace(r.URL.Query().Get("preferredip"))
  195. if preferredIp != "" {
  196. allowedPreferredIps := []string{}
  197. for i := range gwnode.AdditionalRagIps {
  198. allowedPreferredIps = append(allowedPreferredIps, gwnode.AdditionalRagIps[i].String())
  199. }
  200. allowedPreferredIps = append(allowedPreferredIps, host.EndpointIP.String())
  201. allowedPreferredIps = append(allowedPreferredIps, host.EndpointIPv6.String())
  202. if !slices.Contains(allowedPreferredIps, preferredIp) {
  203. slog.Warn(
  204. "preferred endpoint ip is not associated with the RAG. proceeding with preferred ip",
  205. "preferred ip",
  206. preferredIp,
  207. )
  208. logic.ReturnErrorResponse(
  209. w,
  210. r,
  211. logic.FormatError(
  212. errors.New("preferred endpoint ip is not associated with the RAG"),
  213. "badrequest",
  214. ),
  215. )
  216. return
  217. }
  218. if net.ParseIP(preferredIp).To4() == nil {
  219. preferredIp = fmt.Sprintf("[%s]", preferredIp)
  220. }
  221. }
  222. addrString := client.Address
  223. if addrString != "" {
  224. addrString += "/32"
  225. }
  226. if client.Address6 != "" {
  227. if addrString != "" {
  228. addrString += ","
  229. }
  230. addrString += client.Address6 + "/128"
  231. }
  232. keepalive := ""
  233. if network.DefaultKeepalive != 0 {
  234. keepalive = "PersistentKeepalive = " + strconv.Itoa(int(network.DefaultKeepalive))
  235. }
  236. if gwnode.IngressPersistentKeepalive != 0 {
  237. keepalive = "PersistentKeepalive = " + strconv.Itoa(int(gwnode.IngressPersistentKeepalive))
  238. }
  239. gwendpoint := ""
  240. if preferredIp == "" {
  241. if host.EndpointIP.To4() == nil {
  242. gwendpoint = fmt.Sprintf("[%s]:%d", host.EndpointIPv6.String(), host.ListenPort)
  243. } else {
  244. gwendpoint = fmt.Sprintf("%s:%d", host.EndpointIP.String(), host.ListenPort)
  245. }
  246. } else {
  247. gwendpoint = fmt.Sprintf("%s:%d", preferredIp, host.ListenPort)
  248. }
  249. var newAllowedIPs string
  250. if logic.IsInternetGw(gwnode) {
  251. egressrange := "0.0.0.0/0"
  252. if gwnode.Address6.IP != nil && client.Address6 != "" {
  253. egressrange += "," + "::/0"
  254. }
  255. newAllowedIPs = egressrange
  256. } else {
  257. newAllowedIPs = network.AddressRange
  258. if newAllowedIPs != "" && network.AddressRange6 != "" {
  259. newAllowedIPs += ","
  260. }
  261. if network.AddressRange6 != "" {
  262. newAllowedIPs += network.AddressRange6
  263. }
  264. if egressGatewayRanges, err := logic.GetEgressRangesOnNetwork(&client); err == nil {
  265. for _, egressGatewayRange := range egressGatewayRanges {
  266. newAllowedIPs += "," + egressGatewayRange
  267. }
  268. }
  269. }
  270. logic.SetDNSOnWgConfig(&gwnode, &client)
  271. defaultDNS := ""
  272. if client.DNS != "" {
  273. defaultDNS = "DNS = " + client.DNS
  274. }
  275. defaultMTU := 1420
  276. if host.MTU != 0 {
  277. defaultMTU = host.MTU
  278. }
  279. if gwnode.IngressMTU != 0 {
  280. defaultMTU = int(gwnode.IngressMTU)
  281. }
  282. postUp := strings.Builder{}
  283. if client.PostUp != "" && params["type"] != "qr" {
  284. for _, loc := range strings.Split(client.PostUp, "\n") {
  285. postUp.WriteString(fmt.Sprintf("PostUp = %s\n", loc))
  286. }
  287. }
  288. postDown := strings.Builder{}
  289. if client.PostDown != "" && params["type"] != "qr" {
  290. for _, loc := range strings.Split(client.PostDown, "\n") {
  291. postDown.WriteString(fmt.Sprintf("PostDown = %s\n", loc))
  292. }
  293. }
  294. config := fmt.Sprintf(`[Interface]
  295. Address = %s
  296. PrivateKey = %s
  297. MTU = %d
  298. %s
  299. %s
  300. %s
  301. [Peer]
  302. PublicKey = %s
  303. AllowedIPs = %s
  304. Endpoint = %s
  305. %s
  306. `, addrString,
  307. client.PrivateKey,
  308. defaultMTU,
  309. defaultDNS,
  310. postUp.String(),
  311. postDown.String(),
  312. host.PublicKey,
  313. newAllowedIPs,
  314. gwendpoint,
  315. keepalive,
  316. )
  317. if params["type"] == "qr" {
  318. bytes, err := qrcode.Encode(config, qrcode.Medium, 220)
  319. if err != nil {
  320. logger.Log(1, r.Header.Get("user"), "failed to encode qr code: ", err.Error())
  321. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  322. return
  323. }
  324. w.Header().Set("Content-Type", "image/png")
  325. w.WriteHeader(http.StatusOK)
  326. _, err = w.Write(bytes)
  327. if err != nil {
  328. logger.Log(1, r.Header.Get("user"), "response writer error (qr) ", err.Error())
  329. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  330. return
  331. }
  332. return
  333. }
  334. if params["type"] == "file" {
  335. name := client.ClientID + ".conf"
  336. w.Header().Set("Content-Type", "application/config")
  337. w.Header().Set("Content-Disposition", "attachment; filename=\""+name+"\"")
  338. w.WriteHeader(http.StatusOK)
  339. _, err := fmt.Fprint(w, config)
  340. if err != nil {
  341. logger.Log(1, r.Header.Get("user"), "response writer error (file) ", err.Error())
  342. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  343. }
  344. return
  345. }
  346. logger.Log(2, r.Header.Get("user"), "retrieved ext client config")
  347. w.WriteHeader(http.StatusOK)
  348. json.NewEncoder(w).Encode(client)
  349. }
  350. // @Summary Get an individual remote access client
  351. // @Router /api/extclients/{network}/{clientid}/{type} [get]
  352. // @Tags Remote Access Client
  353. // @Security oauth2
  354. // @Success 200 {object} models.ExtClient
  355. // @Failure 500 {object} models.ErrorResponse
  356. // @Failure 403 {object} models.ErrorResponse
  357. func getExtClientHAConf(w http.ResponseWriter, r *http.Request) {
  358. var params = mux.Vars(r)
  359. networkid := params["network"]
  360. network, err := logic.GetParentNetwork(networkid)
  361. if err != nil {
  362. logger.Log(
  363. 1,
  364. r.Header.Get("user"),
  365. "Could not retrieve Ingress Gateway Network",
  366. networkid,
  367. )
  368. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  369. return
  370. }
  371. // fetch client based on availability
  372. nodes, _ := logic.GetNetworkNodes(networkid)
  373. defaultPolicy, _ := logic.GetDefaultPolicy(models.NetworkID(networkid), models.DevicePolicy)
  374. var targetGwID string
  375. var connectionCnt int = -1
  376. for _, nodeI := range nodes {
  377. if nodeI.IsGw {
  378. // check health status
  379. logic.GetNodeStatus(&nodeI, defaultPolicy.Enabled)
  380. if nodeI.Status != models.OnlineSt {
  381. continue
  382. }
  383. // Get Total connections on the gw
  384. clients := logic.GetGwExtclients(nodeI.ID.String(), networkid)
  385. if connectionCnt == -1 || len(clients) < connectionCnt {
  386. connectionCnt = len(clients)
  387. targetGwID = nodeI.ID.String()
  388. }
  389. }
  390. }
  391. gwnode, err := logic.GetNodeByID(targetGwID)
  392. if err != nil {
  393. logger.Log(
  394. 0,
  395. r.Header.Get("user"),
  396. fmt.Sprintf(
  397. "failed to get ingress gateway node [%s] info: %v",
  398. gwnode.ID,
  399. err,
  400. ),
  401. )
  402. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  403. return
  404. }
  405. host, err := logic.GetHost(gwnode.HostID.String())
  406. if err != nil {
  407. logger.Log(0, r.Header.Get("user"),
  408. fmt.Sprintf("failed to get ingress gateway host for node [%s] info: %v", gwnode.ID, err))
  409. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  410. return
  411. }
  412. var userName string
  413. if r.Header.Get("ismaster") == "yes" {
  414. userName = logic.MasterUser
  415. } else {
  416. caller, err := logic.GetUser(r.Header.Get("user"))
  417. if err != nil {
  418. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  419. return
  420. }
  421. userName = caller.UserName
  422. }
  423. // create client
  424. var extclient models.ExtClient
  425. extclient.OwnerID = userName
  426. extclient.IngressGatewayID = targetGwID
  427. extclient.Network = networkid
  428. extclient.Tags = make(map[models.TagID]struct{})
  429. listenPort := logic.GetPeerListenPort(host)
  430. extclient.IngressGatewayEndpoint = fmt.Sprintf("%s:%d", host.EndpointIP.String(), listenPort)
  431. extclient.Enabled = true
  432. if err = logic.CreateExtClient(&extclient); err != nil {
  433. slog.Error(
  434. "failed to create extclient",
  435. "user",
  436. r.Header.Get("user"),
  437. "network",
  438. networkid,
  439. "error",
  440. err,
  441. )
  442. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  443. return
  444. }
  445. client, err := logic.GetExtClient(extclient.ClientID, networkid)
  446. if err != nil {
  447. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  448. return
  449. }
  450. logic.SetDNSOnWgConfig(&gwnode, &client)
  451. defaultDNS := ""
  452. if client.DNS != "" {
  453. defaultDNS = "DNS = " + client.DNS
  454. }
  455. addrString := client.Address
  456. if addrString != "" {
  457. addrString += "/32"
  458. }
  459. if client.Address6 != "" {
  460. if addrString != "" {
  461. addrString += ","
  462. }
  463. addrString += client.Address6 + "/128"
  464. }
  465. keepalive := ""
  466. if network.DefaultKeepalive != 0 {
  467. keepalive = "PersistentKeepalive = " + strconv.Itoa(int(network.DefaultKeepalive))
  468. }
  469. if gwnode.IngressPersistentKeepalive != 0 {
  470. keepalive = "PersistentKeepalive = " + strconv.Itoa(int(gwnode.IngressPersistentKeepalive))
  471. }
  472. var newAllowedIPs string
  473. if logic.IsInternetGw(gwnode) || gwnode.InternetGwID != "" {
  474. egressrange := "0.0.0.0/0"
  475. if gwnode.Address6.IP != nil && client.Address6 != "" {
  476. egressrange += "," + "::/0"
  477. }
  478. newAllowedIPs = egressrange
  479. } else {
  480. newAllowedIPs = network.AddressRange
  481. if newAllowedIPs != "" && network.AddressRange6 != "" {
  482. newAllowedIPs += ","
  483. }
  484. if network.AddressRange6 != "" {
  485. newAllowedIPs += network.AddressRange6
  486. }
  487. if egressGatewayRanges, err := logic.GetEgressRangesOnNetwork(&client); err == nil {
  488. for _, egressGatewayRange := range egressGatewayRanges {
  489. newAllowedIPs += "," + egressGatewayRange
  490. }
  491. }
  492. }
  493. gwendpoint := ""
  494. if host.EndpointIP.To4() == nil {
  495. gwendpoint = fmt.Sprintf("[%s]:%d", host.EndpointIPv6.String(), host.ListenPort)
  496. } else {
  497. gwendpoint = fmt.Sprintf("%s:%d", host.EndpointIP.String(), host.ListenPort)
  498. }
  499. defaultMTU := 1420
  500. if host.MTU != 0 {
  501. defaultMTU = host.MTU
  502. }
  503. if gwnode.IngressMTU != 0 {
  504. defaultMTU = int(gwnode.IngressMTU)
  505. }
  506. postUp := strings.Builder{}
  507. if client.PostUp != "" && params["type"] != "qr" {
  508. for _, loc := range strings.Split(client.PostUp, "\n") {
  509. postUp.WriteString(fmt.Sprintf("PostUp = %s\n", loc))
  510. }
  511. }
  512. postDown := strings.Builder{}
  513. if client.PostDown != "" && params["type"] != "qr" {
  514. for _, loc := range strings.Split(client.PostDown, "\n") {
  515. postDown.WriteString(fmt.Sprintf("PostDown = %s\n", loc))
  516. }
  517. }
  518. config := fmt.Sprintf(`[Interface]
  519. Address = %s
  520. PrivateKey = %s
  521. MTU = %d
  522. %s
  523. %s
  524. %s
  525. [Peer]
  526. PublicKey = %s
  527. AllowedIPs = %s
  528. Endpoint = %s
  529. %s
  530. `, addrString,
  531. client.PrivateKey,
  532. defaultMTU,
  533. defaultDNS,
  534. postUp.String(),
  535. postDown.String(),
  536. host.PublicKey,
  537. newAllowedIPs,
  538. gwendpoint,
  539. keepalive,
  540. )
  541. go func() {
  542. if err := logic.SetClientDefaultACLs(&extclient); err != nil {
  543. slog.Error(
  544. "failed to set default acls for extclient",
  545. "user",
  546. r.Header.Get("user"),
  547. "network",
  548. networkid,
  549. "error",
  550. err,
  551. )
  552. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  553. return
  554. }
  555. if err := mq.PublishPeerUpdate(false); err != nil {
  556. logger.Log(1, "error publishing peer update ", err.Error())
  557. }
  558. if servercfg.IsDNSMode() {
  559. logic.SetDNS()
  560. }
  561. }()
  562. name := client.ClientID + ".conf"
  563. w.Header().Set("Content-Type", "application/config")
  564. w.Header().Set("Client-ID", client.ClientID)
  565. w.Header().Set("Content-Disposition", "attachment; filename=\""+name+"\"")
  566. w.WriteHeader(http.StatusOK)
  567. _, err = fmt.Fprint(w, config)
  568. if err != nil {
  569. logger.Log(1, r.Header.Get("user"), "response writer error (file) ", err.Error())
  570. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  571. }
  572. }
  573. // @Summary Create an individual remote access client
  574. // @Router /api/extclients/{network}/{nodeid} [post]
  575. // @Tags Remote Access Client
  576. // @Security oauth2
  577. // @Success 200 {string} string "OK"
  578. // @Failure 500 {object} models.ErrorResponse
  579. // @Failure 400 {object} models.ErrorResponse
  580. // @Failure 403 {object} models.ErrorResponse
  581. func createExtClient(w http.ResponseWriter, r *http.Request) {
  582. w.Header().Set("Content-Type", "application/json")
  583. var params = mux.Vars(r)
  584. nodeid := params["nodeid"]
  585. ingressExists := checkIngressExists(nodeid)
  586. if !ingressExists {
  587. err := errors.New("ingress does not exist")
  588. slog.Error("failed to create extclient", "user", r.Header.Get("user"), "error", err)
  589. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  590. return
  591. }
  592. var customExtClient models.CustomExtClient
  593. if err := json.NewDecoder(r.Body).Decode(&customExtClient); err != nil {
  594. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  595. return
  596. }
  597. if err := validateCustomExtClient(&customExtClient, true); err != nil {
  598. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  599. return
  600. }
  601. var gateway models.EgressGatewayRequest
  602. gateway.NetID = params["network"]
  603. gateway.Ranges = customExtClient.ExtraAllowedIPs
  604. err := logic.ValidateEgressRange(gateway.NetID, gateway.Ranges)
  605. if err != nil {
  606. logger.Log(0, r.Header.Get("user"), "error validating egress range: ", err.Error())
  607. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  608. return
  609. }
  610. node, err := logic.GetNodeByID(nodeid)
  611. if err != nil {
  612. logger.Log(0, r.Header.Get("user"),
  613. fmt.Sprintf("failed to get ingress gateway node [%s] info: %v", nodeid, err))
  614. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  615. return
  616. }
  617. var userName string
  618. if r.Header.Get("ismaster") == "yes" {
  619. userName = logic.MasterUser
  620. } else {
  621. caller, err := logic.GetUser(r.Header.Get("user"))
  622. if err != nil {
  623. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  624. return
  625. }
  626. userName = caller.UserName
  627. // check if user has a config already for remote access client
  628. extclients, err := logic.GetNetworkExtClients(node.Network)
  629. if err != nil {
  630. slog.Error("failed to get extclients", "error", err)
  631. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  632. return
  633. }
  634. // if device id is sent, we don't want to create another extclient for the same user
  635. // and gw, with the same device id.
  636. if customExtClient.DeviceID != "" {
  637. // let's first confirm that none of the user's extclients for this gw have device id.
  638. for _, extclient := range extclients {
  639. if extclient.DeviceID == customExtClient.DeviceID &&
  640. extclient.OwnerID == caller.UserName && nodeid == extclient.IngressGatewayID {
  641. err = errors.New("remote client config already exists on the gateway")
  642. slog.Error("failed to create extclient", "user", userName, "error", err)
  643. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  644. return
  645. }
  646. }
  647. }
  648. for _, extclient := range extclients {
  649. if extclient.RemoteAccessClientID != "" &&
  650. extclient.RemoteAccessClientID == customExtClient.RemoteAccessClientID &&
  651. extclient.OwnerID == caller.UserName && nodeid == extclient.IngressGatewayID {
  652. if customExtClient.DeviceID != "" && extclient.DeviceID == "" {
  653. // This extclient doesn’t include a device ID (and neither do the others).
  654. // We patch it by assigning the device ID from the incoming request.
  655. // When clients see that the config already exists, they will fetch
  656. // the one with their device ID. And we will return this one.
  657. extclient.DeviceID = customExtClient.DeviceID
  658. _ = logic.SaveExtClient(&extclient)
  659. }
  660. err = errors.New("remote client config already exists on the gateway")
  661. slog.Error("failed to create extclient", "user", userName, "error", err)
  662. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  663. return
  664. }
  665. }
  666. }
  667. extclient := logic.UpdateExtClient(&models.ExtClient{}, &customExtClient)
  668. extclient.OwnerID = userName
  669. extclient.RemoteAccessClientID = customExtClient.RemoteAccessClientID
  670. extclient.IngressGatewayID = nodeid
  671. extclient.Network = node.Network
  672. extclient.Tags = make(map[models.TagID]struct{})
  673. // extclient.Tags[models.TagID(fmt.Sprintf("%s.%s", extclient.Network,
  674. // models.RemoteAccessTagName))] = struct{}{}
  675. // set extclient dns to ingressdns if extclient dns is not explicitly
  676. gwDNS := logic.GetGwDNS(&node)
  677. if (extclient.DNS == "") && (gwDNS != "") {
  678. dns := gwDNS
  679. extclient.DNS = dns
  680. }
  681. host, err := logic.GetHost(node.HostID.String())
  682. if err != nil {
  683. logger.Log(0, r.Header.Get("user"),
  684. fmt.Sprintf("failed to get ingress gateway host for node [%s] info: %v", nodeid, err))
  685. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  686. return
  687. }
  688. listenPort := logic.GetPeerListenPort(host)
  689. extclient.IngressGatewayEndpoint = fmt.Sprintf("%s:%d", host.EndpointIP.String(), listenPort)
  690. extclient.Enabled = true
  691. parentNetwork, err := logic.GetNetwork(node.Network)
  692. if err == nil { // check if parent network default ACL is enabled (yes) or not (no)
  693. extclient.Enabled = parentNetwork.DefaultACL == "yes"
  694. }
  695. extclient.Os = customExtClient.Os
  696. extclient.DeviceID = customExtClient.DeviceID
  697. extclient.DeviceName = customExtClient.DeviceName
  698. if customExtClient.IsAlreadyConnectedToInetGw {
  699. slog.Warn("RAC/Client is already connected to internet gateway. this may mask their real IP address", "client IP", customExtClient.PublicEndpoint)
  700. }
  701. extclient.PublicEndpoint = customExtClient.PublicEndpoint
  702. extclient.Country = customExtClient.Country
  703. if customExtClient.RemoteAccessClientID != "" && customExtClient.Location == "" {
  704. extclient.Location = logic.GetHostLocInfo(logic.GetClientIP(r), os.Getenv("IP_INFO_TOKEN"))
  705. }
  706. extclient.Location = customExtClient.Location
  707. if err = logic.CreateExtClient(&extclient); err != nil {
  708. slog.Error(
  709. "failed to create extclient",
  710. "user",
  711. r.Header.Get("user"),
  712. "network",
  713. node.Network,
  714. "error",
  715. err,
  716. )
  717. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  718. return
  719. }
  720. slog.Info(
  721. "created extclient",
  722. "user",
  723. r.Header.Get("user"),
  724. "network",
  725. node.Network,
  726. "clientid",
  727. extclient.ClientID,
  728. )
  729. if extclient.RemoteAccessClientID != "" {
  730. // if created by user from client app, log event
  731. logic.LogEvent(&models.Event{
  732. Action: models.Connect,
  733. Source: models.Subject{
  734. ID: userName,
  735. Name: userName,
  736. Type: models.UserSub,
  737. },
  738. TriggeredBy: userName,
  739. Target: models.Subject{
  740. ID: extclient.Network,
  741. Name: extclient.Network,
  742. Type: models.NetworkSub,
  743. Info: extclient,
  744. },
  745. NetworkID: models.NetworkID(extclient.Network),
  746. Origin: models.ClientApp,
  747. })
  748. }
  749. w.WriteHeader(http.StatusOK)
  750. go func() {
  751. if err := logic.SetClientDefaultACLs(&extclient); err != nil {
  752. slog.Error(
  753. "failed to set default acls for extclient",
  754. "user",
  755. r.Header.Get("user"),
  756. "network",
  757. node.Network,
  758. "error",
  759. err,
  760. )
  761. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  762. return
  763. }
  764. if err := mq.PublishPeerUpdate(false); err != nil {
  765. logger.Log(1, "error setting ext peers on "+nodeid+": "+err.Error())
  766. }
  767. if servercfg.IsDNSMode() {
  768. logic.SetDNS()
  769. }
  770. }()
  771. }
  772. // @Summary Update an individual remote access client
  773. // @Router /api/extclients/{network}/{clientid} [put]
  774. // @Tags Remote Access Client
  775. // @Security oauth2
  776. // @Success 200 {object} models.ExtClient
  777. // @Failure 500 {object} models.ErrorResponse
  778. // @Failure 400 {object} models.ErrorResponse
  779. // @Failure 403 {object} models.ErrorResponse
  780. func updateExtClient(w http.ResponseWriter, r *http.Request) {
  781. w.Header().Set("Content-Type", "application/json")
  782. var params = mux.Vars(r)
  783. var update models.CustomExtClient
  784. //var oldExtClient models.ExtClient
  785. var replacePeers bool
  786. err := json.NewDecoder(r.Body).Decode(&update)
  787. if err != nil {
  788. logger.Log(0, r.Header.Get("user"), "error decoding request body: ",
  789. err.Error())
  790. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  791. return
  792. }
  793. clientid := params["clientid"]
  794. oldExtClient, err := logic.GetExtClientByName(clientid)
  795. if err != nil {
  796. slog.Error(
  797. "failed to retrieve extclient",
  798. "user",
  799. r.Header.Get("user"),
  800. "id",
  801. clientid,
  802. "error",
  803. err,
  804. )
  805. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  806. return
  807. }
  808. if oldExtClient.ClientID == update.ClientID {
  809. if err := validateCustomExtClient(&update, false); err != nil {
  810. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  811. return
  812. }
  813. } else {
  814. if err := validateCustomExtClient(&update, true); err != nil {
  815. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  816. return
  817. }
  818. }
  819. var gateway models.EgressGatewayRequest
  820. gateway.NetID = params["network"]
  821. gateway.Ranges = update.ExtraAllowedIPs
  822. err = logic.ValidateEgressRange(gateway.NetID, gateway.Ranges)
  823. if err != nil {
  824. logger.Log(0, r.Header.Get("user"), "error validating egress range: ", err.Error())
  825. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
  826. return
  827. }
  828. var changedID = update.ClientID != oldExtClient.ClientID
  829. if !reflect.DeepEqual(update.DeniedACLs, oldExtClient.DeniedACLs) {
  830. logic.SetClientACLs(&oldExtClient, update.DeniedACLs)
  831. }
  832. if update.PublicKey != oldExtClient.PublicKey {
  833. //remove old peer entry
  834. replacePeers = true
  835. }
  836. if update.RemoteAccessClientID != "" && update.Location == "" {
  837. update.Location = logic.GetHostLocInfo(logic.GetClientIP(r), os.Getenv("IP_INFO_TOKEN"))
  838. }
  839. newclient := logic.UpdateExtClient(&oldExtClient, &update)
  840. if err := logic.DeleteExtClient(oldExtClient.Network, oldExtClient.ClientID, true); err != nil {
  841. slog.Error(
  842. "failed to delete ext client",
  843. "user",
  844. r.Header.Get("user"),
  845. "id",
  846. oldExtClient.ClientID,
  847. "network",
  848. oldExtClient.Network,
  849. "error",
  850. err,
  851. )
  852. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  853. return
  854. }
  855. if err := logic.SaveExtClient(&newclient); err != nil {
  856. slog.Error(
  857. "failed to save ext client",
  858. "user",
  859. r.Header.Get("user"),
  860. "id",
  861. newclient.ClientID,
  862. "network",
  863. newclient.Network,
  864. "error",
  865. err,
  866. )
  867. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  868. return
  869. }
  870. logger.Log(0, r.Header.Get("user"), "updated ext client", update.ClientID)
  871. w.WriteHeader(http.StatusOK)
  872. json.NewEncoder(w).Encode(newclient)
  873. go func() {
  874. if changedID && servercfg.IsDNSMode() {
  875. logic.SetDNS()
  876. }
  877. if replacePeers || !update.Enabled {
  878. if err := mq.PublishDeletedClientPeerUpdate(&oldExtClient); err != nil {
  879. slog.Error("error deleting old ext peers", "error", err.Error())
  880. }
  881. }
  882. mq.PublishPeerUpdate(false)
  883. }()
  884. }
  885. // @Summary Delete an individual remote access client
  886. // @Router /api/extclients/{network}/{clientid} [delete]
  887. // @Tags Remote Access Client
  888. // @Security oauth2
  889. // @Success 200
  890. // @Failure 500 {object} models.ErrorResponse
  891. // @Failure 403 {object} models.ErrorResponse
  892. func deleteExtClient(w http.ResponseWriter, r *http.Request) {
  893. // Set header
  894. w.Header().Set("Content-Type", "application/json")
  895. // get params
  896. var params = mux.Vars(r)
  897. clientid := params["clientid"]
  898. network := params["network"]
  899. extclient, err := logic.GetExtClient(clientid, network)
  900. if err != nil {
  901. err = errors.New("Could not delete extclient " + params["clientid"])
  902. logger.Log(0, r.Header.Get("user"),
  903. fmt.Sprintf("failed to get extclient [%s],network [%s]: %v", clientid, network, err))
  904. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  905. return
  906. }
  907. ingressnode, err := logic.GetNodeByID(extclient.IngressGatewayID)
  908. if err != nil {
  909. logger.Log(
  910. 0,
  911. r.Header.Get("user"),
  912. fmt.Sprintf(
  913. "failed to get ingress gateway node [%s] info: %v",
  914. extclient.IngressGatewayID,
  915. err,
  916. ),
  917. )
  918. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  919. return
  920. }
  921. err = logic.DeleteExtClientAndCleanup(extclient)
  922. if err != nil {
  923. slog.Error("deleteExtClient: ", "Error", err.Error())
  924. err = errors.New("Could not delete extclient " + params["clientid"])
  925. logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
  926. return
  927. }
  928. go func() {
  929. if err := mq.PublishDeletedClientPeerUpdate(&extclient); err != nil {
  930. slog.Error("error setting ext peers on " + ingressnode.ID.String() + ": " + err.Error())
  931. }
  932. if servercfg.IsDNSMode() {
  933. logic.SetDNS()
  934. }
  935. }()
  936. logger.Log(0, r.Header.Get("user"),
  937. "Deleted extclient client", params["clientid"], "from network", params["network"])
  938. logic.ReturnSuccessResponse(w, r, params["clientid"]+" deleted.")
  939. }
  940. // validateCustomExtClient Validates the extclient object
  941. func validateCustomExtClient(customExtClient *models.CustomExtClient, checkID bool) error {
  942. v := validator.New()
  943. err := v.Struct(customExtClient)
  944. if err != nil {
  945. return err
  946. }
  947. //validate clientid
  948. if customExtClient.ClientID != "" {
  949. if err := isValid(customExtClient.ClientID, checkID); err != nil {
  950. return fmt.Errorf("client validation: %v", err)
  951. }
  952. }
  953. //extclient.ClientID = customExtClient.ClientID
  954. if len(customExtClient.PublicKey) > 0 {
  955. if _, err := wgtypes.ParseKey(customExtClient.PublicKey); err != nil {
  956. return errInvalidExtClientPubKey
  957. }
  958. //extclient.PublicKey = customExtClient.PublicKey
  959. }
  960. //validate extra ips
  961. if len(customExtClient.ExtraAllowedIPs) > 0 {
  962. for _, ip := range customExtClient.ExtraAllowedIPs {
  963. if _, _, err := net.ParseCIDR(ip); err != nil {
  964. return errInvalidExtClientExtraIP
  965. }
  966. }
  967. //extclient.ExtraAllowedIPs = customExtClient.ExtraAllowedIPs
  968. }
  969. //validate DNS
  970. if customExtClient.DNS != "" {
  971. ips := strings.Split(customExtClient.DNS, ",")
  972. for _, ip := range ips {
  973. trimmedIp := strings.TrimSpace(ip)
  974. if ip := net.ParseIP(trimmedIp); ip == nil {
  975. return errInvalidExtClientDNS
  976. }
  977. }
  978. }
  979. return nil
  980. }
  981. // isValid Checks if the clientid is valid
  982. func isValid(clientid string, checkID bool) error {
  983. if !validName(clientid) {
  984. return errInvalidExtClientID
  985. }
  986. if checkID {
  987. extclients, err := logic.GetAllExtClients()
  988. if err != nil {
  989. return fmt.Errorf("extclients isValid: %v", err)
  990. }
  991. for _, extclient := range extclients {
  992. if clientid == extclient.ClientID {
  993. return errDuplicateExtClientName
  994. }
  995. }
  996. }
  997. return nil
  998. }