loader.go 12 KB

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