loader.go 12 KB

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