license.go 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. //go:build ee
  2. // +build ee
  3. package pro
  4. import (
  5. "bytes"
  6. "crypto/rand"
  7. "encoding/json"
  8. "errors"
  9. "fmt"
  10. "io"
  11. "net/http"
  12. "time"
  13. "golang.org/x/exp/slog"
  14. "github.com/gravitl/netmaker/database"
  15. "github.com/gravitl/netmaker/logic"
  16. "github.com/gravitl/netmaker/models"
  17. "github.com/gravitl/netmaker/netclient/ncutils"
  18. "github.com/gravitl/netmaker/servercfg"
  19. "golang.org/x/crypto/nacl/box"
  20. )
  21. const (
  22. db_license_key = "netmaker-id-key-pair"
  23. )
  24. type apiServerConf struct {
  25. PrivateKey []byte `json:"private_key" binding:"required"`
  26. PublicKey []byte `json:"public_key" binding:"required"`
  27. }
  28. // AddLicenseHooks - adds the validation and cache clear hooks
  29. func AddLicenseHooks() {
  30. logic.HookManagerCh <- models.HookDetails{
  31. Hook: ValidateLicense,
  32. Interval: time.Hour,
  33. }
  34. logic.HookManagerCh <- models.HookDetails{
  35. Hook: ClearLicenseCache,
  36. Interval: time.Hour,
  37. }
  38. }
  39. // ValidateLicense - the initial and periodic license check for netmaker server
  40. // checks if a license is valid + limits are not exceeded
  41. // if license is free_tier and limits exceeds, then function should error
  42. // if license is not valid, function should error
  43. func ValidateLicense() (err error) {
  44. defer func() {
  45. if err != nil {
  46. err = fmt.Errorf("%w: %s", errValidation, err.Error())
  47. }
  48. servercfg.ErrLicenseValidation = err
  49. }()
  50. licenseKeyValue := servercfg.GetLicenseKey()
  51. netmakerTenantID := servercfg.GetNetmakerTenantID()
  52. slog.Info("proceeding with Netmaker license validation...")
  53. if len(licenseKeyValue) == 0 {
  54. err = errors.New("empty license-key (LICENSE_KEY environment variable)")
  55. return err
  56. }
  57. if len(netmakerTenantID) == 0 {
  58. err = errors.New("empty tenant-id (NETMAKER_TENANT_ID environment variable)")
  59. return err
  60. }
  61. apiPublicKey, err := getLicensePublicKey(licenseKeyValue)
  62. if err != nil {
  63. err = fmt.Errorf("failed to get license public key: %w", err)
  64. return err
  65. }
  66. tempPubKey, tempPrivKey, err := FetchApiServerKeys()
  67. if err != nil {
  68. err = fmt.Errorf("failed to fetch api server keys: %w", err)
  69. return err
  70. }
  71. licenseSecret := LicenseSecret{
  72. AssociatedID: netmakerTenantID,
  73. Usage: getCurrentServerUsage(),
  74. }
  75. secretData, err := json.Marshal(&licenseSecret)
  76. if err != nil {
  77. err = fmt.Errorf("failed to marshal license secret: %w", err)
  78. return err
  79. }
  80. encryptedData, err := ncutils.BoxEncrypt(secretData, apiPublicKey, tempPrivKey)
  81. if err != nil {
  82. err = fmt.Errorf("failed to encrypt license secret data: %w", err)
  83. return err
  84. }
  85. validationResponse, err := validateLicenseKey(encryptedData, tempPubKey)
  86. if err != nil {
  87. err = fmt.Errorf("failed to validate license key: %w", err)
  88. return err
  89. }
  90. if len(validationResponse) == 0 {
  91. err = errors.New("empty validation response")
  92. return err
  93. }
  94. var licenseResponse ValidatedLicense
  95. if err = json.Unmarshal(validationResponse, &licenseResponse); err != nil {
  96. err = fmt.Errorf("failed to unmarshal validation response: %w", err)
  97. return err
  98. }
  99. respData, err := ncutils.BoxDecrypt(base64decode(licenseResponse.EncryptedLicense), apiPublicKey, tempPrivKey)
  100. if err != nil {
  101. err = fmt.Errorf("failed to decrypt license: %w", err)
  102. return err
  103. }
  104. license := LicenseKey{}
  105. if err = json.Unmarshal(respData, &license); err != nil {
  106. err = fmt.Errorf("failed to unmarshal license key: %w", err)
  107. return err
  108. }
  109. slog.Info("License validation succeeded!")
  110. return nil
  111. }
  112. // FetchApiServerKeys - fetches netmaker license keys for identification
  113. // as well as secure communication with API
  114. // if none present, it generates a new pair
  115. func FetchApiServerKeys() (pub *[32]byte, priv *[32]byte, err error) {
  116. var returnData = apiServerConf{}
  117. currentData, err := database.FetchRecord(database.SERVERCONF_TABLE_NAME, db_license_key)
  118. if err != nil && !database.IsEmptyRecord(err) {
  119. return nil, nil, err
  120. } else if database.IsEmptyRecord(err) { // need to generate a new identifier pair
  121. pub, priv, err = box.GenerateKey(rand.Reader)
  122. if err != nil {
  123. return nil, nil, err
  124. }
  125. pubBytes, err := ncutils.ConvertKeyToBytes(pub)
  126. if err != nil {
  127. return nil, nil, err
  128. }
  129. privBytes, err := ncutils.ConvertKeyToBytes(priv)
  130. if err != nil {
  131. return nil, nil, err
  132. }
  133. returnData.PrivateKey = privBytes
  134. returnData.PublicKey = pubBytes
  135. record, err := json.Marshal(&returnData)
  136. if err != nil {
  137. return nil, nil, err
  138. }
  139. if err = database.Insert(db_license_key, string(record), database.SERVERCONF_TABLE_NAME); err != nil {
  140. return nil, nil, err
  141. }
  142. } else {
  143. if err = json.Unmarshal([]byte(currentData), &returnData); err != nil {
  144. return nil, nil, err
  145. }
  146. priv, err = ncutils.ConvertBytesToKey(returnData.PrivateKey)
  147. if err != nil {
  148. return nil, nil, err
  149. }
  150. pub, err = ncutils.ConvertBytesToKey(returnData.PublicKey)
  151. if err != nil {
  152. return nil, nil, err
  153. }
  154. }
  155. return pub, priv, nil
  156. }
  157. func getLicensePublicKey(licensePubKeyEncoded string) (*[32]byte, error) {
  158. decodedPubKey := base64decode(licensePubKeyEncoded)
  159. return ncutils.ConvertBytesToKey(decodedPubKey)
  160. }
  161. func validateLicenseKey(encryptedData []byte, publicKey *[32]byte) ([]byte, error) {
  162. publicKeyBytes, err := ncutils.ConvertKeyToBytes(publicKey)
  163. if err != nil {
  164. return nil, err
  165. }
  166. msg := ValidateLicenseRequest{
  167. LicenseKey: servercfg.GetLicenseKey(),
  168. NmServerPubKey: base64encode(publicKeyBytes),
  169. EncryptedPart: base64encode(encryptedData),
  170. }
  171. requestBody, err := json.Marshal(msg)
  172. if err != nil {
  173. return nil, err
  174. }
  175. req, err := http.NewRequest(http.MethodPost, getAccountsHost()+"/api/v1/license/validate", bytes.NewReader(requestBody))
  176. if err != nil {
  177. return nil, err
  178. }
  179. req.Header.Add("Content-Type", "application/json")
  180. req.Header.Add("Accept", "application/json")
  181. client := &http.Client{}
  182. var body []byte
  183. validateResponse, err := client.Do(req)
  184. if err != nil { // check cache
  185. body, err = getCachedResponse()
  186. if err != nil {
  187. return nil, err
  188. }
  189. slog.Warn("proceeding with cached response, Netmaker API may be down")
  190. } else {
  191. defer validateResponse.Body.Close()
  192. if validateResponse.StatusCode != 200 {
  193. return nil, fmt.Errorf("could not validate license, got status code %d", validateResponse.StatusCode)
  194. } // if you received a 200 cache the response locally
  195. body, err = io.ReadAll(validateResponse.Body)
  196. if err != nil {
  197. return nil, err
  198. }
  199. cacheResponse(body)
  200. }
  201. return body, err
  202. }
  203. func getAccountsHost() string {
  204. switch servercfg.GetEnvironment() {
  205. case "dev":
  206. return accountsHostDevelopment
  207. case "staging":
  208. return accountsHostStaging
  209. default:
  210. return accountsHostProduction
  211. }
  212. }
  213. func cacheResponse(response []byte) error {
  214. var lrc = licenseResponseCache{
  215. Body: response,
  216. }
  217. record, err := json.Marshal(&lrc)
  218. if err != nil {
  219. return err
  220. }
  221. return database.Insert(license_cache_key, string(record), database.CACHE_TABLE_NAME)
  222. }
  223. func getCachedResponse() ([]byte, error) {
  224. var lrc licenseResponseCache
  225. record, err := database.FetchRecord(database.CACHE_TABLE_NAME, license_cache_key)
  226. if err != nil {
  227. return nil, err
  228. }
  229. if err = json.Unmarshal([]byte(record), &lrc); err != nil {
  230. return nil, err
  231. }
  232. return lrc.Body, nil
  233. }
  234. // ClearLicenseCache - clears the cached validate response
  235. func ClearLicenseCache() error {
  236. return database.DeleteRecord(database.CACHE_TABLE_NAME, license_cache_key)
  237. }