2
0

loader.go 11 KB

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