loader.go 14 KB

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