loader.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. package loader
  2. import (
  3. "encoding/base64"
  4. "errors"
  5. "fmt"
  6. "io/ioutil"
  7. "net/http"
  8. "os"
  9. "path/filepath"
  10. "strconv"
  11. gorillaws "github.com/gorilla/websocket"
  12. "github.com/porter-dev/api-contracts/generated/go/porter/v1/porterv1connect"
  13. "github.com/porter-dev/porter/api/server/shared/apierrors/alerter"
  14. "github.com/porter-dev/porter/api/server/shared/config"
  15. "github.com/porter-dev/porter/api/server/shared/config/env"
  16. "github.com/porter-dev/porter/api/server/shared/config/envloader"
  17. "github.com/porter-dev/porter/api/server/shared/websocket"
  18. "github.com/porter-dev/porter/ee/integrations/vault"
  19. "github.com/porter-dev/porter/internal/adapter"
  20. "github.com/porter-dev/porter/internal/analytics"
  21. "github.com/porter-dev/porter/internal/auth/sessionstore"
  22. "github.com/porter-dev/porter/internal/auth/token"
  23. "github.com/porter-dev/porter/internal/billing"
  24. "github.com/porter-dev/porter/internal/features"
  25. "github.com/porter-dev/porter/internal/helm/urlcache"
  26. "github.com/porter-dev/porter/internal/integrations/cloudflare"
  27. "github.com/porter-dev/porter/internal/integrations/dns"
  28. "github.com/porter-dev/porter/internal/integrations/powerdns"
  29. "github.com/porter-dev/porter/internal/notifier"
  30. "github.com/porter-dev/porter/internal/notifier/sendgrid"
  31. "github.com/porter-dev/porter/internal/oauth"
  32. "github.com/porter-dev/porter/internal/repository/credentials"
  33. "github.com/porter-dev/porter/internal/repository/gorm"
  34. "github.com/porter-dev/porter/internal/telemetry"
  35. lr "github.com/porter-dev/porter/pkg/logger"
  36. "github.com/porter-dev/porter/provisioner/client"
  37. pgorm "gorm.io/gorm"
  38. )
  39. var (
  40. InstanceBillingManager billing.BillingManager
  41. InstanceEnvConf *envloader.EnvConf
  42. InstanceDB *pgorm.DB
  43. )
  44. type EnvConfigLoader struct {
  45. version string
  46. }
  47. func NewEnvLoader(version string) config.ConfigLoader {
  48. return &EnvConfigLoader{version}
  49. }
  50. func sharedInit() {
  51. var err error
  52. InstanceEnvConf, _ = envloader.FromEnv()
  53. InstanceDB, err = adapter.New(InstanceEnvConf.DBConf)
  54. if err != nil {
  55. panic(err)
  56. }
  57. InstanceBillingManager = &billing.StripeBillingManager{
  58. StripeSecretKey: InstanceEnvConf.ServerConf.StripeSecretKey,
  59. StripePublishableKey: InstanceEnvConf.ServerConf.StripePublishableKey,
  60. }
  61. }
  62. func (e *EnvConfigLoader) LoadConfig() (res *config.Config, err error) {
  63. // ctx := context.Background()
  64. envConf := InstanceEnvConf
  65. sc := envConf.ServerConf
  66. if envConf == nil {
  67. return nil, errors.New("nil environment config passed to loader")
  68. }
  69. var instanceCredentialBackend credentials.CredentialStorage
  70. if envConf.DBConf.VaultEnabled {
  71. if envConf.DBConf.VaultAPIKey == "" || envConf.DBConf.VaultServerURL == "" || envConf.DBConf.VaultPrefix == "" {
  72. return nil, errors.New("vault is enabled but missing required environment variables [VAULT_API_KEY,VAULT_SERVER_URL,VAULT_PREFIX]")
  73. }
  74. instanceCredentialBackend = vault.NewClient(
  75. envConf.DBConf.VaultServerURL,
  76. envConf.DBConf.VaultAPIKey,
  77. envConf.DBConf.VaultPrefix,
  78. )
  79. }
  80. res = &config.Config{
  81. Logger: lr.NewConsole(sc.Debug),
  82. ServerConf: sc,
  83. DBConf: envConf.DBConf,
  84. RedisConf: envConf.RedisConf,
  85. BillingManager: InstanceBillingManager,
  86. CredentialBackend: instanceCredentialBackend,
  87. }
  88. res.Logger.Info().Msg("Loading MetadataFromConf")
  89. res.Metadata = config.MetadataFromConf(envConf.ServerConf, e.version)
  90. res.Logger.Info().Msg("Loaded MetadataFromConf")
  91. res.DB = InstanceDB
  92. var key [32]byte
  93. for i, b := range []byte(envConf.DBConf.EncryptionKey) {
  94. key[i] = b
  95. }
  96. res.Logger.Info().Msg("Creating new gorm repository")
  97. res.Repo = gorm.NewRepository(InstanceDB, &key, instanceCredentialBackend)
  98. res.Logger.Info().Msg("Created new gorm repository")
  99. res.Logger.Info().Msg("Creating new session store")
  100. // create the session store
  101. res.Store, err = sessionstore.NewStore(
  102. &sessionstore.NewStoreOpts{
  103. SessionRepository: res.Repo.Session(),
  104. CookieSecrets: envConf.ServerConf.CookieSecrets,
  105. Insecure: envConf.ServerConf.CookieInsecure,
  106. },
  107. )
  108. if err != nil {
  109. return nil, err
  110. }
  111. res.Logger.Info().Msg("Created new session store")
  112. res.TokenConf = &token.TokenGeneratorConf{
  113. TokenSecret: envConf.ServerConf.TokenGeneratorSecret,
  114. }
  115. res.UserNotifier = &notifier.EmptyUserNotifier{}
  116. if res.Metadata.Email {
  117. res.Logger.Info().Msg("Creating new user notifier")
  118. res.UserNotifier = sendgrid.NewUserNotifier(&sendgrid.UserNotifierOpts{
  119. SharedOpts: &sendgrid.SharedOpts{
  120. APIKey: envConf.ServerConf.SendgridAPIKey,
  121. SenderEmail: envConf.ServerConf.SendgridSenderEmail,
  122. },
  123. PWResetTemplateID: envConf.ServerConf.SendgridPWResetTemplateID,
  124. PWGHTemplateID: envConf.ServerConf.SendgridPWGHTemplateID,
  125. VerifyEmailTemplateID: envConf.ServerConf.SendgridVerifyEmailTemplateID,
  126. ProjectInviteTemplateID: envConf.ServerConf.SendgridProjectInviteTemplateID,
  127. DeleteProjectTemplateID: envConf.ServerConf.SendgridDeleteProjectTemplateID,
  128. })
  129. res.Logger.Info().Msg("Created new user notifier")
  130. }
  131. res.Alerter = alerter.NoOpAlerter{}
  132. if envConf.ServerConf.SentryDSN != "" {
  133. res.Logger.Info().Msg("Creating Sentry Alerter")
  134. res.Alerter, err = alerter.NewSentryAlerter(envConf.ServerConf.SentryDSN, envConf.ServerConf.SentryEnv)
  135. if err != nil {
  136. return nil, fmt.Errorf("failed to create new sentry alerter: %w", err)
  137. }
  138. res.Logger.Info().Msg("Created Sentry Alerter")
  139. }
  140. if sc.DOClientID != "" && sc.DOClientSecret != "" {
  141. res.Logger.Info().Msg("Creating Digital Ocean client")
  142. res.DOConf = oauth.NewDigitalOceanClient(&oauth.Config{
  143. ClientID: sc.DOClientID,
  144. ClientSecret: sc.DOClientSecret,
  145. Scopes: []string{"read", "write"},
  146. BaseURL: sc.ServerURL,
  147. })
  148. res.Logger.Info().Msg("Created Digital Ocean client")
  149. }
  150. if sc.GoogleClientID != "" && sc.GoogleClientSecret != "" {
  151. res.Logger.Info().Msg("Creating Google client")
  152. res.GoogleConf = oauth.NewGoogleClient(&oauth.Config{
  153. ClientID: sc.GoogleClientID,
  154. ClientSecret: sc.GoogleClientSecret,
  155. Scopes: []string{
  156. "openid",
  157. "profile",
  158. "email",
  159. },
  160. BaseURL: sc.ServerURL,
  161. })
  162. res.Logger.Info().Msg(" Google client")
  163. }
  164. // TODO: remove this as part of POR-1055
  165. if sc.GithubClientID != "" && sc.GithubClientSecret != "" {
  166. res.Logger.Info().Msg("Creating Github client")
  167. res.GithubConf = oauth.NewGithubClient(&oauth.Config{
  168. ClientID: sc.GithubClientID,
  169. ClientSecret: sc.GithubClientSecret,
  170. Scopes: []string{"read:user", "user:email"},
  171. BaseURL: sc.ServerURL,
  172. })
  173. res.Logger.Info().Msg("Created Github client")
  174. }
  175. if sc.GithubAppSecretBase64 != "" {
  176. if sc.GithubAppSecretPath == "" {
  177. sc.GithubAppSecretPath = "github-app-secret-key"
  178. }
  179. _, err := os.Stat(sc.GithubAppSecretPath)
  180. if err != nil {
  181. if !errors.Is(err, os.ErrNotExist) {
  182. return nil, fmt.Errorf("GITHUB_APP_SECRET_BASE64 provided, but error checking if GITHUB_APP_SECRET_PATH exists: %w", err)
  183. }
  184. secret, err := base64.StdEncoding.DecodeString(sc.GithubAppSecretBase64)
  185. if err != nil {
  186. return nil, fmt.Errorf("GITHUB_APP_SECRET_BASE64 provided, but error decoding: %w", err)
  187. }
  188. _, err = createDirectoryRecursively(sc.GithubAppSecretPath)
  189. if err != nil {
  190. return nil, fmt.Errorf("GITHUB_APP_SECRET_BASE64 provided, but error creating directory for GITHUB_APP_SECRET_PATH: %w", err)
  191. }
  192. err = os.WriteFile(sc.GithubAppSecretPath, secret, os.ModePerm)
  193. if err != nil {
  194. return nil, fmt.Errorf("GITHUB_APP_SECRET_BASE64 provided, but error writing to GITHUB_APP_SECRET_PATH: %w", err)
  195. }
  196. }
  197. }
  198. if sc.GithubAppClientID != "" &&
  199. sc.GithubAppClientSecret != "" &&
  200. sc.GithubAppName != "" &&
  201. sc.GithubAppWebhookSecret != "" &&
  202. sc.GithubAppSecretPath != "" &&
  203. sc.GithubAppID != "" {
  204. if AppID, err := strconv.ParseInt(sc.GithubAppID, 10, 64); err == nil {
  205. res.GithubAppConf = oauth.NewGithubAppClient(&oauth.Config{
  206. ClientID: sc.GithubAppClientID,
  207. ClientSecret: sc.GithubAppClientSecret,
  208. Scopes: []string{"read:user"},
  209. BaseURL: sc.ServerURL,
  210. }, sc.GithubAppName, sc.GithubAppWebhookSecret, sc.GithubAppSecretPath, AppID)
  211. }
  212. secret, err := ioutil.ReadFile(sc.GithubAppSecretPath)
  213. if err != nil {
  214. return nil, fmt.Errorf("could not read github app secret: %s", err)
  215. }
  216. sc.GithubAppSecret = append(sc.GithubAppSecret, secret...)
  217. }
  218. launchDarklyClient, err := features.GetClient(envConf.ServerConf.FeatureFlagClient, envConf.ServerConf.LaunchDarklySDKKey)
  219. if err != nil {
  220. return nil, fmt.Errorf("could not create launch darkly client: %s", err)
  221. }
  222. res.LaunchDarklyClient = launchDarklyClient
  223. if sc.StripeSecretKey == "" {
  224. res.Logger.Info().Msg("STRIPE_SECRET_KEY not set, all Stripe functionality will be disabled")
  225. }
  226. if sc.SlackClientID != "" && sc.SlackClientSecret != "" {
  227. res.Logger.Info().Msg("Creating Slack client")
  228. res.SlackConf = oauth.NewSlackClient(&oauth.Config{
  229. ClientID: sc.SlackClientID,
  230. ClientSecret: sc.SlackClientSecret,
  231. Scopes: []string{
  232. "incoming-webhook",
  233. "team:read",
  234. },
  235. BaseURL: sc.ServerURL,
  236. })
  237. res.Logger.Info().Msg("Created Slack client")
  238. }
  239. res.WSUpgrader = &websocket.Upgrader{
  240. WSUpgrader: &gorillaws.Upgrader{
  241. ReadBufferSize: 1024,
  242. WriteBufferSize: 1024,
  243. CheckOrigin: func(r *http.Request) bool {
  244. var err error
  245. defer func() {
  246. // TODO: this is only used to collect data for removing the `request origin not allowed by Upgrader.CheckOrigin` error
  247. if err != nil {
  248. res.Logger.Info().Msgf("error: %s, host: %s, origin: %s, serverURL: %s", err.Error(), r.Host, r.Header.Get("Origin"), sc.ServerURL)
  249. }
  250. }()
  251. return true
  252. },
  253. },
  254. }
  255. // construct the whitelisted users map
  256. wlUsers := make(map[uint]uint)
  257. for _, userID := range sc.WhitelistedUsers {
  258. wlUsers[userID] = userID
  259. }
  260. res.WhitelistedUsers = wlUsers
  261. res.Logger.Info().Msg("Creating URL Cache")
  262. res.URLCache = urlcache.Init(sc.DefaultApplicationHelmRepoURL, sc.DefaultAddonHelmRepoURL)
  263. res.Logger.Info().Msg("Created URL Cache")
  264. res.Logger.Info().Msg("Creating provisioner service client")
  265. provClient, err := getProvisionerServiceClient(sc)
  266. if err == nil && provClient != nil {
  267. res.ProvisionerClient = provClient
  268. }
  269. res.Logger.Info().Msg("Created provisioner service client")
  270. res.Logger.Info().Msg("Creating analytics client")
  271. res.AnalyticsClient = analytics.InitializeAnalyticsSegmentClient(sc.SegmentClientKey, res.Logger)
  272. res.Logger.Info().Msg("Created analytics client")
  273. switch sc.DnsProvider {
  274. case "powerdns":
  275. if sc.PowerDNSAPIKey != "" && sc.PowerDNSAPIServerURL != "" {
  276. res.DNSClient = &dns.Client{Client: powerdns.NewClient(sc.PowerDNSAPIServerURL, sc.PowerDNSAPIKey, sc.AppRootDomain)}
  277. }
  278. case "cloudflare":
  279. if sc.CloudflareAPIToken != "" {
  280. cloudflareClient, err := cloudflare.NewClient(sc.CloudflareAPIToken, sc.AppRootDomain)
  281. if err != nil {
  282. return res, fmt.Errorf("unable to create cloudflare client: %w", err)
  283. }
  284. res.DNSClient = &dns.Client{Client: cloudflareClient}
  285. }
  286. }
  287. res.EnableCAPIProvisioner = sc.EnableCAPIProvisioner
  288. if sc.EnableCAPIProvisioner {
  289. res.Logger.Info().Msg("Creating CCP client")
  290. if sc.ClusterControlPlaneAddress == "" {
  291. return res, errors.New("must provide CLUSTER_CONTROL_PLANE_ADDRESS")
  292. }
  293. client := porterv1connect.NewClusterControlPlaneServiceClient(http.DefaultClient, sc.ClusterControlPlaneAddress)
  294. res.ClusterControlPlaneClient = client
  295. res.Logger.Info().Msg("Created CCP client")
  296. }
  297. res.TelemetryConfig = telemetry.TracerConfig{
  298. ServiceName: sc.TelemetryName,
  299. CollectorURL: sc.TelemetryCollectorURL,
  300. }
  301. return res, nil
  302. }
  303. func getProvisionerServiceClient(sc *env.ServerConf) (*client.Client, error) {
  304. if sc.ProvisionerServerURL != "" && sc.ProvisionerToken != "" {
  305. baseURL := fmt.Sprintf("%s/api/v1", sc.ProvisionerServerURL)
  306. pClient, err := client.NewClient(baseURL, sc.ProvisionerToken, 0)
  307. if err != nil {
  308. return nil, err
  309. }
  310. return pClient, nil
  311. }
  312. return nil, fmt.Errorf("required env vars not set for provisioner")
  313. }
  314. // createDirectoryRecursively creates a directory and all its parents if they don't exist
  315. func createDirectoryRecursively(p string) (*os.File, error) {
  316. if err := os.MkdirAll(filepath.Dir(p), 0o770); err != nil {
  317. return nil, err
  318. }
  319. return os.Create(p)
  320. }