vpn.go 27 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046
  1. package ovpm
  2. import (
  3. "bytes"
  4. "fmt"
  5. "io"
  6. "math/big"
  7. "net"
  8. "os"
  9. "os/exec"
  10. "path/filepath"
  11. "strings"
  12. "sync"
  13. "text/template"
  14. "time"
  15. "github.com/asaskevich/govalidator"
  16. "github.com/cad/ovpm/pki"
  17. "github.com/cad/ovpm/supervisor"
  18. "github.com/coreos/go-iptables/iptables"
  19. "github.com/google/uuid"
  20. "github.com/jinzhu/gorm"
  21. "github.com/sirupsen/logrus"
  22. )
  23. // Possible VPN protocols.
  24. const (
  25. TCPProto string = "tcp"
  26. UDPProto string = "udp"
  27. )
  28. // serverModel is database model for storing VPN server related stuff.
  29. type dbServerModel struct {
  30. gorm.Model
  31. Name string `gorm:"unique_index"` // Server name.
  32. SerialNumber string
  33. Hostname string // Server's ip address or FQDN
  34. Port string // Server's listening port
  35. Proto string // Server's proto udp or tcp
  36. Cert string // Server RSA certificate.
  37. Key string // Server RSA private key.
  38. CACert string // Root CA RSA certificate.
  39. CAKey string // Root CA RSA key.
  40. Net string // VPN network.
  41. Mask string // VPN network mask.
  42. CRL string // Certificate Revocation List
  43. DNS string // DNS servers to push to the clients.
  44. KeepalivePeriod string // Keepalive ping period
  45. KeepaliveTimeout string // Keepalive timeout
  46. UseLZO bool // Use LZO compression
  47. }
  48. var serverInstance *Server
  49. var once sync.Once
  50. // Server represents VPN server.
  51. type Server struct {
  52. dbServerModel
  53. webPort string
  54. emitToFileFunc func(path, content string, mode uint) error
  55. openFunc func(path string) (io.Reader, error)
  56. parseStatusLogFunc func(f io.Reader) ([]clEntry, []rtEntry)
  57. }
  58. // TheServer returns a pointer to the server instance.
  59. //
  60. // Server instance is a singleton instance that is initialized
  61. // on the first call made to the TheServer().
  62. func TheServer() *Server {
  63. once.Do(func() {
  64. // Initialize the server instance by setting default mockable funcs & attributes.
  65. serverInstance = &Server{
  66. emitToFileFunc: emitToFile,
  67. openFunc: func(path string) (io.Reader, error) {
  68. return os.Open(path)
  69. },
  70. parseStatusLogFunc: parseStatusLog,
  71. }
  72. })
  73. if db != nil {
  74. serverInstance.Refresh()
  75. } else {
  76. logrus.Warn("database is not connected yet. skipping server instance refresh")
  77. }
  78. return serverInstance
  79. }
  80. // CheckSerial takes a serial number and checks it against the current server's serial number.
  81. func (svr *Server) CheckSerial(serial string) bool {
  82. return serial == svr.SerialNumber
  83. }
  84. // GetSerialNumber returns server's serial number.
  85. func (svr *Server) GetSerialNumber() string {
  86. return svr.SerialNumber
  87. }
  88. // GetServerName returns server's name.
  89. func (svr *Server) GetServerName() string {
  90. if svr.Name != "" {
  91. return svr.Name
  92. }
  93. return "default"
  94. }
  95. // GetHostname returns vpn server's hostname.
  96. func (svr *Server) GetHostname() string {
  97. return svr.Hostname
  98. }
  99. // GetPort returns vpn server's port.
  100. func (svr *Server) GetPort() string {
  101. if svr.Port != "" {
  102. return svr.Port
  103. }
  104. return DefaultVPNPort
  105. }
  106. // GetProto returns vpn server's proto.
  107. func (svr *Server) GetProto() string {
  108. if svr.Proto != "" {
  109. return svr.Proto
  110. }
  111. return DefaultVPNProto
  112. }
  113. // CAExpiresAt returns the expiry date time of the CA.
  114. func (svr *Server) CAExpiresAt() time.Time {
  115. if !svr.IsInitialized() {
  116. return time.Time{}
  117. }
  118. crt, err := pki.ReadCertFromPEM(svr.CACert)
  119. if err != nil {
  120. logrus.Fatalf("can't parse cert: %v", err)
  121. }
  122. return crt.NotAfter
  123. }
  124. // ExpiresAt returns the expiry date time of the server cert.
  125. func (svr *Server) ExpiresAt() time.Time {
  126. if !svr.IsInitialized() {
  127. return time.Time{}
  128. }
  129. crt, err := pki.ReadCertFromPEM(svr.Cert)
  130. if err != nil {
  131. logrus.Fatalf("can't parse cert: %v", err)
  132. }
  133. return crt.NotAfter
  134. }
  135. // GetKey returns vpn server's key.
  136. func (svr *Server) GetKey() string {
  137. return svr.Key
  138. }
  139. // GetCACert returns vpn server's cacert.
  140. func (svr *Server) GetCACert() string {
  141. return svr.CACert
  142. }
  143. // GetCAKey returns vpn server's cakey.
  144. func (svr *Server) GetCAKey() string {
  145. return svr.CAKey
  146. }
  147. // GetNet returns vpn server's net.
  148. func (svr *Server) GetNet() string {
  149. return svr.Net
  150. }
  151. // GetMask returns vpn server's mask.
  152. func (svr *Server) GetMask() string {
  153. return svr.Mask
  154. }
  155. // GetCRL returns vpn server's crl.
  156. func (svr *Server) GetCRL() string {
  157. return svr.CRL
  158. }
  159. // GetDNS returns vpn server's dns.
  160. func (svr *Server) GetDNS() string {
  161. if svr.DNS != "" {
  162. return svr.DNS
  163. }
  164. return DefaultVPNDNS
  165. }
  166. // GetCreatedAt returns server's created at.
  167. func (svr *Server) GetCreatedAt() string {
  168. return svr.CreatedAt.Format(time.UnixDate)
  169. }
  170. func (svr *Server) GetKeepalivePeriod() string {
  171. if svr.KeepalivePeriod != "" {
  172. return svr.KeepalivePeriod
  173. }
  174. return DefaultKeepalivePeriod
  175. }
  176. func (svr *Server) GetKeepaliveTimeout() string {
  177. if svr.KeepaliveTimeout != "" {
  178. return svr.KeepaliveTimeout
  179. }
  180. return DefaultKeepaliveTimeout
  181. }
  182. func (svr *Server) IsUseLZO() bool {
  183. return svr.UseLZO
  184. }
  185. // Init regenerates keys and certs for a Root CA, gets initial settings for the VPN server
  186. // and saves them in the database.
  187. //
  188. // 'proto' can be either "udp" or "tcp" and if it's "" it defaults to "udp".
  189. //
  190. // 'ipblock' is a IP network in the CIDR form. VPN clients get their IP addresses from this network.
  191. // It defaults to const 'DefaultVPNNetwork'.
  192. //
  193. // 'keepalivePeriod' is the ping period to check if the remote peer is alive.
  194. // It defaults to const 'DefaultKeepalivePeriod'
  195. //
  196. // 'keeapliveTimeout' is the ping timeout to assume that remote peer is down.
  197. // It defaults to const 'DefaultKeepaliveTimeout'
  198. //
  199. // 'useLZO' is used to determine whether to use the lzo compression algorithm to support older clients.
  200. // It defaults to false due to security issues and deprecation
  201. //
  202. // Please note that, Init is potentially destructive procedure, it will cause invalidation of
  203. // existing .ovpn profiles of the current users. So it should be used carefully.
  204. func (svr *Server) Init(hostname string, port string, proto string, ipblock string, dns string, keepalivePeriod string, keepaliveTimeout string, useLZO bool) error {
  205. if port == "" {
  206. port = DefaultVPNPort
  207. }
  208. if dns == "" {
  209. dns = DefaultVPNDNS
  210. }
  211. if keepalivePeriod == "" {
  212. keepalivePeriod = DefaultKeepalivePeriod
  213. }
  214. if keepaliveTimeout == "" {
  215. keepaliveTimeout = DefaultKeepaliveTimeout
  216. }
  217. switch proto {
  218. case "":
  219. proto = UDPProto
  220. case UDPProto:
  221. proto = UDPProto
  222. case TCPProto:
  223. proto = TCPProto
  224. default:
  225. return fmt.Errorf("validation error: proto:`%s` should be either 'tcp' or 'udp'", proto)
  226. }
  227. // vpn network to use.
  228. var ipnet *net.IPNet
  229. // If user didn't specify, pick the vpn network from defaults.
  230. if ipblock == "" {
  231. var err error
  232. _, ipnet, err = net.ParseCIDR(DefaultVPNNetwork)
  233. if err != nil {
  234. return fmt.Errorf("can not parse CIDR %s: %v", DefaultVPNNetwork, err)
  235. }
  236. }
  237. // Check if the user specified vpn network is valid.
  238. if ipblock != "" && !govalidator.IsCIDR(ipblock) {
  239. return fmt.Errorf("validation error: ipblock:`%s` should be a CIDR network", ipblock)
  240. }
  241. // Use user specified vpn network.
  242. if ipblock != "" {
  243. var err error
  244. _, ipnet, err = net.ParseCIDR(ipblock)
  245. if err != nil {
  246. return fmt.Errorf("can parse ipblock: %s", err)
  247. }
  248. }
  249. if !govalidator.IsNumeric(port) {
  250. return fmt.Errorf("validation error: port:`%s` should be numeric", port)
  251. }
  252. if !govalidator.IsNumeric(keepaliveTimeout) {
  253. return fmt.Errorf("validation error: keepaliveTimeout:`%s` should be numeric", keepaliveTimeout)
  254. }
  255. if !govalidator.IsNumeric(keepalivePeriod) {
  256. return fmt.Errorf("validation error: keepalivePeriod:`%s` should be numeric", keepalivePeriod)
  257. }
  258. serverName := "default"
  259. if svr := TheServer(); svr.IsInitialized() {
  260. if err := svr.Deinit(); err != nil {
  261. logrus.Errorf("server can not be deleted: %v", err)
  262. return err
  263. }
  264. }
  265. if !govalidator.IsHost(hostname) {
  266. return fmt.Errorf("validation error: hostname:`%s` should be either an ip address or a FQDN", hostname)
  267. }
  268. if !govalidator.IsIPv4(dns) {
  269. return fmt.Errorf("validation error: dns:`%s` should be an ip address", dns)
  270. }
  271. ca, err := pki.NewCA()
  272. if err != nil {
  273. return fmt.Errorf("can not create ca creds: %s", err)
  274. }
  275. srv, err := pki.NewServerCertHolder(ca)
  276. if err != nil {
  277. return fmt.Errorf("can not create server cert creds: %s", err)
  278. }
  279. serialNumber := uuid.New().String()
  280. serverInstance := dbServerModel{
  281. Name: serverName,
  282. SerialNumber: serialNumber,
  283. Hostname: hostname,
  284. Proto: proto,
  285. Port: port,
  286. Cert: srv.Cert,
  287. Key: srv.Key,
  288. CACert: ca.Cert,
  289. CAKey: ca.Key,
  290. Net: ipnet.IP.To4().String(),
  291. Mask: net.IP(ipnet.Mask).To4().String(),
  292. DNS: dns,
  293. KeepalivePeriod: keepalivePeriod,
  294. KeepaliveTimeout: keepaliveTimeout,
  295. UseLZO: useLZO,
  296. }
  297. db.Create(&serverInstance)
  298. if db.NewRecord(&serverInstance) {
  299. return fmt.Errorf("can not create server instance on database")
  300. }
  301. users, err := GetAllUsers()
  302. if err != nil {
  303. return err
  304. }
  305. // Sign all users in the db with the new server
  306. for _, user := range users {
  307. err := user.Renew()
  308. logrus.Infof("user certificate changed for %s, you should run: $ ovpm user export-config --user %s", user.Username, user.Username)
  309. if err != nil {
  310. logrus.Errorf("can not sign user %s: %v", user.Username, err)
  311. continue
  312. }
  313. // Set dynamic ip to user.
  314. user.HostID = 0
  315. db.Save(&user.dbUserModel)
  316. }
  317. TheServer().EmitWithRestart()
  318. logrus.Infof("server initialized")
  319. return nil
  320. }
  321. // Update updates VPN server attributes.
  322. func (svr *Server) Update(ipblock string, dns string) error {
  323. if !svr.IsInitialized() {
  324. return fmt.Errorf("server is not initialized")
  325. }
  326. var changed bool
  327. if ipblock != "" && govalidator.IsCIDR(ipblock) {
  328. var ipnet *net.IPNet
  329. _, ipnet, err := net.ParseCIDR(ipblock)
  330. if err != nil {
  331. return fmt.Errorf("can not parse CIDR %s: %v", ipblock, err)
  332. }
  333. svr.dbServerModel.Net = ipnet.IP.To4().String()
  334. svr.dbServerModel.Mask = net.IP(ipnet.Mask).To4().String()
  335. changed = true
  336. }
  337. if dns != "" && govalidator.IsIPv4(dns) {
  338. svr.dbServerModel.DNS = dns
  339. changed = true
  340. }
  341. if changed {
  342. db.Save(svr.dbServerModel)
  343. users, err := GetAllUsers()
  344. if err != nil {
  345. return err
  346. }
  347. // Set all users to dynamic ip address.
  348. // This way we prevent any ip range mismatch.
  349. for _, user := range users {
  350. user.HostID = 0
  351. db.Save(user.dbUserModel)
  352. }
  353. svr.EmitWithRestart()
  354. logrus.Infof("server updated")
  355. }
  356. return nil
  357. }
  358. // Deinit deletes the VPN server from the database and frees the allocated resources.
  359. func (svr *Server) Deinit() error {
  360. if !svr.IsInitialized() {
  361. return fmt.Errorf("server not found")
  362. }
  363. db.Unscoped().Delete(&dbServerModel{})
  364. db.Unscoped().Delete(&dbRevokedModel{})
  365. svr.EmitWithRestart()
  366. return nil
  367. }
  368. // DumpsClientConfig generates .ovpn file for the given vpn user and returns it as a string.
  369. func (svr *Server) DumpsClientConfig(username string) (string, error) {
  370. var result bytes.Buffer
  371. user, err := GetUser(username)
  372. if err != nil {
  373. return "", err
  374. }
  375. params := struct {
  376. Hostname string
  377. Port string
  378. CA string
  379. Key string
  380. Cert string
  381. NoGW bool
  382. Proto string
  383. KeepalivePeriod string
  384. KeepaliveTimeout string
  385. UseLZO bool
  386. }{
  387. Hostname: svr.GetHostname(),
  388. Port: svr.GetPort(),
  389. CA: svr.GetCACert(),
  390. Key: user.getKey(),
  391. Cert: user.GetCert(),
  392. NoGW: user.IsNoGW(),
  393. Proto: svr.GetProto(),
  394. KeepalivePeriod: svr.GetKeepalivePeriod(),
  395. KeepaliveTimeout: svr.GetKeepaliveTimeout(),
  396. UseLZO: svr.IsUseLZO(),
  397. }
  398. t, err := template.New("client.ovpn").Parse(clientOvpnTemplate)
  399. if err != nil {
  400. return "", fmt.Errorf("can not parse client.ovpn.tmpl template: %s", err)
  401. }
  402. err = t.Execute(&result, params)
  403. if err != nil {
  404. return "", fmt.Errorf("can not render client.ovpn: %s", err)
  405. }
  406. return result.String(), nil
  407. }
  408. // DumpClientConfig generates .ovpn file for the given vpn user and dumps it to outPath.
  409. func (svr *Server) DumpClientConfig(username, path string) error {
  410. result, err := svr.DumpsClientConfig(username)
  411. if err != nil {
  412. return err
  413. }
  414. // Wite rendered content into openvpn server conf.
  415. return svr.emitToFile(path, result, 0)
  416. }
  417. // GetSystemCA returns the system CA from the database if available.
  418. func (svr *Server) GetSystemCA() (*pki.CA, error) {
  419. server := dbServerModel{}
  420. db.First(&server)
  421. if db.NewRecord(&server) {
  422. return nil, fmt.Errorf("server record does not exists in db")
  423. }
  424. return &pki.CA{
  425. CertHolder: pki.CertHolder{
  426. Cert: server.CACert,
  427. Key: server.CAKey,
  428. },
  429. }, nil
  430. }
  431. // vpnProc represents the OpenVPN process that is managed by the ovpm supervisor globally OpenVPN.
  432. var vpnProc supervisor.Supervisable
  433. // StartVPNProc starts the OpenVPN process.
  434. func (svr *Server) StartVPNProc() {
  435. if !svr.IsInitialized() {
  436. logrus.Error("can not launch OpenVPN because system is not initialized")
  437. return
  438. }
  439. if vpnProc == nil {
  440. panic(fmt.Sprintf("vpnProc is not initialized!"))
  441. }
  442. if vpnProc.Status() == supervisor.RUNNING {
  443. logrus.Error("OpenVPN is already started")
  444. return
  445. }
  446. svr.Emit()
  447. vpnProc.Start()
  448. ensureNatEnabled()
  449. }
  450. // RestartVPNProc restarts the OpenVPN process.
  451. func (svr *Server) RestartVPNProc() {
  452. if !svr.IsInitialized() {
  453. logrus.Error("can not launch OpenVPN because system is not initialized")
  454. return
  455. }
  456. if vpnProc == nil {
  457. panic(fmt.Sprintf("vpnProc is not initialized!"))
  458. }
  459. svr.Emit()
  460. vpnProc.Restart()
  461. ensureNatEnabled()
  462. }
  463. // StopVPNProc stops the OpenVPN process.
  464. func (svr *Server) StopVPNProc() {
  465. if vpnProc == nil {
  466. panic(fmt.Sprintf("vpnProc is not initialized!"))
  467. }
  468. if vpnProc.Status() != supervisor.RUNNING {
  469. logrus.Error("OpenVPN is already not running")
  470. return
  471. }
  472. vpnProc.Stop()
  473. }
  474. // Emit generates all needed files for the OpenVPN server and dumps them to their corresponding paths defined in the config.
  475. func (svr *Server) Emit() error {
  476. // Check dependencies
  477. if !checkOpenVPNExecutable() {
  478. return fmt.Errorf("openvpn executable can not be found! you should install OpenVPN on this machine")
  479. }
  480. if !checkOpenSSLExecutable() {
  481. return fmt.Errorf("openssl executable can not be found! you should install openssl on this machine")
  482. }
  483. if !checkIptablesExecutable() {
  484. return fmt.Errorf("iptables executable can not be found")
  485. }
  486. if !svr.IsInitialized() {
  487. return fmt.Errorf("you should create a server first. e.g. $ ovpm vpn create-server")
  488. }
  489. if err := svr.emitServerConf(); err != nil {
  490. return fmt.Errorf("can not emit server conf: %s", err)
  491. }
  492. if err := svr.emitServerCert(); err != nil {
  493. return fmt.Errorf("can not emit server cert: %s", err)
  494. }
  495. if err := svr.emitServerKey(); err != nil {
  496. return fmt.Errorf("can not emit server key: %s", err)
  497. }
  498. if err := svr.emitCACert(); err != nil {
  499. return fmt.Errorf("can not emit ca cert : %s", err)
  500. }
  501. if err := svr.emitCAKey(); err != nil {
  502. return fmt.Errorf("can not emit ca key: %s", err)
  503. }
  504. if err := svr.emitDHParams(); err != nil {
  505. return fmt.Errorf("can not emit dhparams: %s", err)
  506. }
  507. if err := svr.emitCCD(); err != nil {
  508. return fmt.Errorf("can not emit ccd: %s", err)
  509. }
  510. if err := svr.emitIptables(); err != nil {
  511. return fmt.Errorf("can not emit iptables: %s", err)
  512. }
  513. if err := svr.emitCRL(); err != nil {
  514. return fmt.Errorf("can not emit crl: %s", err)
  515. }
  516. logrus.Info("configurations emitted to the filesystem")
  517. return nil
  518. }
  519. // EmitWithRestart restarts vpnProc after calling EmitWithRestart().
  520. func (svr *Server) EmitWithRestart() error {
  521. if err := svr.Emit(); err != nil {
  522. return err
  523. }
  524. if svr.IsInitialized() {
  525. for {
  526. if vpnProc.Status() == supervisor.RUNNING || vpnProc.Status() == supervisor.STOPPED {
  527. logrus.Info("OpenVPN process is restarting")
  528. svr.RestartVPNProc()
  529. break
  530. }
  531. time.Sleep(1 * time.Second)
  532. }
  533. }
  534. return nil
  535. }
  536. // emitToFile is a proxy that calls svr.emitToFileFunc.
  537. func (svr *Server) emitToFile(path, content string, mode uint) error {
  538. return svr.emitToFileFunc(path, content, mode)
  539. }
  540. // emitToFile is an implementation for svr.emitToFileFunc.
  541. func emitToFile(path, content string, mode uint) error {
  542. // When testing don't emit files to the filesystem. Just pretend you did.
  543. if Testing {
  544. return nil
  545. }
  546. file, err := os.Create(path)
  547. if err != nil {
  548. return fmt.Errorf("Cannot create file %s: %v", path, err)
  549. }
  550. if mode != 0 {
  551. file.Chmod(os.FileMode(mode))
  552. }
  553. defer file.Close()
  554. fmt.Fprintf(file, content)
  555. return nil
  556. }
  557. func (svr *Server) emitServerConf() error {
  558. port := DefaultVPNPort
  559. if serverInstance.Port != "" {
  560. port = serverInstance.Port
  561. }
  562. proto := DefaultVPNProto
  563. if serverInstance.Proto != "" {
  564. proto = serverInstance.Proto
  565. }
  566. dns := DefaultVPNDNS
  567. if serverInstance.DNS != "" {
  568. dns = serverInstance.DNS
  569. }
  570. var result bytes.Buffer
  571. server := struct {
  572. CertPath string
  573. KeyPath string
  574. CACertPath string
  575. CAKeyPath string
  576. CCDPath string
  577. CRLPath string
  578. DHParamsPath string
  579. Net string
  580. Mask string
  581. Port string
  582. Proto string
  583. DNS string
  584. KeepalivePeriod string
  585. KeepaliveTimeout string
  586. UseLZO bool
  587. }{
  588. CertPath: _DefaultCertPath,
  589. KeyPath: _DefaultKeyPath,
  590. CACertPath: _DefaultCACertPath,
  591. CAKeyPath: _DefaultCAKeyPath,
  592. CCDPath: _DefaultVPNCCDPath,
  593. CRLPath: _DefaultCRLPath,
  594. DHParamsPath: _DefaultDHParamsPath,
  595. Net: svr.Net,
  596. Mask: svr.Mask,
  597. Port: port,
  598. Proto: proto,
  599. DNS: dns,
  600. KeepalivePeriod: svr.GetKeepalivePeriod(),
  601. KeepaliveTimeout: svr.GetKeepaliveTimeout(),
  602. UseLZO: svr.IsUseLZO(),
  603. }
  604. t, err := template.New("server.conf").Parse(serverConfTemplate)
  605. if err != nil {
  606. return fmt.Errorf("can not parse server.conf.tmpl template: %s", err)
  607. }
  608. err = t.Execute(&result, server)
  609. if err != nil {
  610. return fmt.Errorf("can not render server.conf: %s", err)
  611. }
  612. // Wite rendered content into openvpn server conf.
  613. return svr.emitToFile(_DefaultVPNConfPath, result.String(), 0)
  614. }
  615. // Refresh synchronizes the server instance from db.
  616. func (svr *Server) Refresh() error {
  617. //db = CreateDB("sqlite3", "")
  618. var dbServer dbServerModel
  619. q := db.First(&dbServer)
  620. if err := q.Error; err != nil {
  621. return fmt.Errorf("can't get server from db: %v", err)
  622. }
  623. if q.RecordNotFound() {
  624. return fmt.Errorf("server is not initialized")
  625. }
  626. svr.dbServerModel = dbServer
  627. return nil
  628. }
  629. // GetConnectedUsers will return a list of users who are currently connected
  630. // to the VPN service.
  631. func (svr *Server) GetConnectedUsers() ([]User, error) {
  632. var users []User
  633. // Open the status log file.
  634. f, err := svr.openFunc(_DefaultStatusLogPath)
  635. if err != nil {
  636. panic(err)
  637. }
  638. cl, _ := svr.parseStatusLogFunc(f) // client list from OpenVPN status log
  639. for _, c := range cl {
  640. var u dbUserModel
  641. q := db.Where(dbUserModel{Username: c.CommonName}).First(&u)
  642. if q.RecordNotFound() {
  643. logrus.WithFields(
  644. logrus.Fields{"CommonName": c.CommonName},
  645. ).Error("user not found: common name reported by the OpenVPN is not found in the database")
  646. continue
  647. }
  648. if err := q.Error; err != nil {
  649. return nil, fmt.Errorf("unknown db error: %v", err)
  650. }
  651. users = append(users, User{
  652. dbUserModel: u,
  653. isConnected: true,
  654. connectedSince: c.ConnectedSince,
  655. bytesReceived: c.BytesReceived,
  656. bytesSent: c.BytesSent,
  657. })
  658. }
  659. return users, nil
  660. }
  661. // IsInitialized checks if there is a default VPN server configured in the database or not.
  662. func (svr *Server) IsInitialized() bool {
  663. var serverModel dbServerModel
  664. q := db.First(&serverModel)
  665. if err := q.Error; err != nil {
  666. logrus.Errorf("can't retrieve server from db: %v", err)
  667. }
  668. if q.RecordNotFound() {
  669. return false
  670. }
  671. return true
  672. }
  673. func (svr *Server) emitServerKey() error {
  674. // Write rendered content into key file.
  675. return svr.emitToFile(_DefaultKeyPath, svr.Key, 0600)
  676. }
  677. func (svr *Server) emitServerCert() error {
  678. // Write rendered content into the cert file.
  679. return svr.emitToFile(_DefaultCertPath, svr.Cert, 0)
  680. }
  681. func (svr *Server) emitCRL() error {
  682. var revokedDBItems []*dbRevokedModel
  683. db.Find(&revokedDBItems)
  684. var revokedCertSerials []*big.Int
  685. for _, item := range revokedDBItems {
  686. bi := big.NewInt(0)
  687. bi.SetString(item.SerialNumber, 16)
  688. revokedCertSerials = append(revokedCertSerials, bi)
  689. }
  690. systemCA, err := svr.GetSystemCA()
  691. if err != nil {
  692. return fmt.Errorf("can not emit CRL: %v", err)
  693. }
  694. crl, err := pki.NewCRL(systemCA, revokedCertSerials...)
  695. if err != nil {
  696. return fmt.Errorf("can not emit crl: %v", err)
  697. }
  698. return svr.emitToFile(_DefaultCRLPath, crl, 0)
  699. }
  700. func (svr *Server) emitCACert() error {
  701. // Write rendered content into the ca cert file.
  702. return svr.emitToFile(_DefaultCACertPath, svr.CACert, 0)
  703. }
  704. func (svr *Server) emitCAKey() error {
  705. // Write rendered content into the ca key file.
  706. return svr.emitToFile(_DefaultCAKeyPath, svr.CAKey, 0600)
  707. }
  708. func (svr *Server) emitCCD() error {
  709. users, err := GetAllUsers()
  710. if err != nil {
  711. return err
  712. }
  713. // Filesystem related stuff. Skipping when testing.
  714. if !Testing {
  715. // Clean and then create and write rendered ccd data.
  716. err = os.RemoveAll(_DefaultVPNCCDPath)
  717. if err != nil {
  718. if os.IsNotExist(err) {
  719. } else {
  720. return err
  721. }
  722. }
  723. if _, err := os.Stat(_DefaultVPNCCDPath); err != nil {
  724. }
  725. err = os.Mkdir(_DefaultVPNCCDPath, 0755)
  726. if err != nil {
  727. if !os.IsExist(err) {
  728. return err
  729. }
  730. }
  731. }
  732. // Render ccd templates for the users.
  733. for _, user := range users {
  734. var associatedRoutes [][3]string
  735. var serverNets [][2]string
  736. for _, network := range GetAllNetworks() {
  737. switch network.Type {
  738. case ROUTE:
  739. for _, assocUsername := range network.GetAssociatedUsernames() {
  740. if assocUsername == user.Username {
  741. via := network.Via
  742. ip, mask, err := net.ParseCIDR(network.CIDR)
  743. if err != nil {
  744. return err
  745. }
  746. associatedRoutes = append(associatedRoutes, [3]string{ip.To4().String(), net.IP(mask.Mask).To4().String(), via})
  747. }
  748. }
  749. case SERVERNET:
  750. // Push associated servernets to client when client is not getting vpn server as default gw.
  751. if user.IsNoGW() {
  752. for _, assocUsername := range network.GetAssociatedUsernames() {
  753. if assocUsername == user.Username {
  754. ip, mask, err := net.ParseCIDR(network.CIDR)
  755. if err != nil {
  756. return err
  757. }
  758. serverNets = append(serverNets, [2]string{ip.To4().String(), net.IP(mask.Mask).To4().String()})
  759. }
  760. }
  761. }
  762. }
  763. }
  764. var result bytes.Buffer
  765. params := struct {
  766. IP string
  767. NetMask string
  768. Routes [][3]string // [0] is IP, [1] is Netmask, [2] is Via
  769. Servernets [][2]string // [0] is IP, [1] is Netmask
  770. RedirectGW bool
  771. }{IP: user.getIP().String(), NetMask: svr.Mask, Routes: associatedRoutes, Servernets: serverNets, RedirectGW: !user.NoGW}
  772. t, err := template.New("ccd.file.tmpl").Parse(ccdFileTemplate)
  773. if err != nil {
  774. return fmt.Errorf("can not parse ccd.file.tmpl template: %s", err)
  775. }
  776. err = t.Execute(&result, params)
  777. if err != nil {
  778. return fmt.Errorf("can not render ccd file %s: %s", user.Username, err)
  779. }
  780. if err = svr.emitToFile(filepath.Join(_DefaultVPNCCDPath, user.Username), result.String(), 0); err != nil {
  781. return err
  782. }
  783. }
  784. return nil
  785. }
  786. func (svr *Server) emitDHParams() error {
  787. var result bytes.Buffer
  788. t, err := template.New("dh4096.pem.tmpl").Parse(dh4096PemTemplate)
  789. if err != nil {
  790. return fmt.Errorf("can not parse dh4096.pem template: %s", err)
  791. }
  792. err = t.Execute(&result, nil)
  793. if err != nil {
  794. return fmt.Errorf("can not render dh4096.pem file: %s", err)
  795. }
  796. return svr.emitToFile(_DefaultDHParamsPath, result.String(), 0)
  797. }
  798. func (svr *Server) emitIptables() error {
  799. if Testing {
  800. return nil
  801. }
  802. ipt, err := iptables.NewWithProtocol(iptables.ProtocolIPv4)
  803. if err != nil {
  804. return fmt.Errorf("can not create new iptables object: %v", err)
  805. }
  806. for _, network := range GetAllNetworks() {
  807. associatedUsernames := network.GetAssociatedUsernames()
  808. switch network.Type {
  809. case SERVERNET:
  810. users, err := GetAllUsers()
  811. if err != nil {
  812. return err
  813. }
  814. // Find associated users and emit iptables configs for the users
  815. // regarding the network's type and attributes.
  816. for _, user := range users {
  817. // Find out if the user is associated or not.
  818. var found bool
  819. for _, auser := range associatedUsernames {
  820. if user.Username == auser {
  821. found = true
  822. break
  823. }
  824. }
  825. userIP, _, err := net.ParseCIDR(user.GetIPNet())
  826. if err != nil {
  827. return err
  828. }
  829. _, networkIPNet, err := net.ParseCIDR(network.CIDR)
  830. if err != nil {
  831. return err
  832. }
  833. // get destination network's iface
  834. iface := interfaceOfIP(networkIPNet)
  835. if iface == nil {
  836. logrus.Warnf("network doesn't exist on server %s[SERVERNET]: cant find interface for %s", network.Name, networkIPNet.String())
  837. return nil
  838. }
  839. // enable nat for the user to the destination network n
  840. if found {
  841. err = ipt.AppendUnique("nat", "POSTROUTING", "-s", userIP.String(), "-o", iface.Name, "-j", "MASQUERADE")
  842. if err != nil {
  843. logrus.Error(err)
  844. return err
  845. }
  846. } else {
  847. err = ipt.Delete("nat", "POSTROUTING", "-s", userIP.String(), "-o", iface.Name, "-j", "MASQUERADE")
  848. if err != nil {
  849. logrus.Debug(err)
  850. }
  851. }
  852. }
  853. }
  854. }
  855. return nil
  856. }
  857. func checkOpenVPNExecutable() bool {
  858. executable := getOpenVPNExecutable()
  859. if executable == "" {
  860. logrus.Error("openvpn is not installed ✘")
  861. return false
  862. }
  863. logrus.Debugf("openvpn executable detected: %s ✔", executable)
  864. return true
  865. }
  866. func getOpenVPNExecutable() string {
  867. cmd := exec.Command("which", "openvpn")
  868. output, err := cmd.Output()
  869. if err != nil {
  870. logrus.Errorf("openvpn is not installed: %s ✘", err)
  871. return ""
  872. }
  873. logrus.Debugf("openvpn executable detected: %s ✔", strings.TrimSpace(string(output[:])))
  874. return strings.TrimSpace(string(output[:]))
  875. }
  876. func checkOpenSSLExecutable() bool {
  877. cmd := exec.Command("which", "openssl")
  878. output, err := cmd.Output()
  879. if err != nil {
  880. logrus.Errorf("openssl is not installed: %s ✘", err)
  881. return false
  882. }
  883. logrus.Debugf("openssl executable detected: %s ✔", strings.TrimSpace(string(output[:])))
  884. return true
  885. }
  886. func checkIptablesExecutable() bool {
  887. cmd := exec.Command("which", "iptables")
  888. output, err := cmd.Output()
  889. if err != nil {
  890. logrus.Errorf("iptables is not installed: %s ✘", err)
  891. return false
  892. }
  893. logrus.Debugf("iptables executable detected: %s ✔", strings.TrimSpace(string(output[:])))
  894. return true
  895. }
  896. func ensureBaseDir() {
  897. if Testing {
  898. return
  899. }
  900. os.Mkdir(varBasePath, 0755)
  901. }
  902. func init() {
  903. ensureBaseDir()
  904. var err error
  905. vpnProc, err = supervisor.NewProcess(getOpenVPNExecutable(), varBasePath, []string{"--config", _DefaultVPNConfPath})
  906. if err != nil {
  907. logrus.Errorf("can not create process: %v", err)
  908. }
  909. }