loader.go 15 KB

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