loader.go 12 KB

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