Merge branch 'crosbymichael-master' into crosbymichael-dist

Conflicts:
	app/app.js
	package.json

.air.toml

@@ -1,52 +0,0 @@
-root = "."
-testdata_dir = "testdata"
-tmp_dir = ".tmp"
-
-[build]
-  args_bin = []
-  bin = "./dist/portainer"
-  cmd = "SKIP_GO_GET=true make build-server"
-  delay = 1000
-  exclude_dir = []
-  exclude_file = []
-  exclude_regex = ["_test.go"]
-  exclude_unchanged = false
-  follow_symlink = false
-  full_bin = "./dist/portainer --log-level=DEBUG"
-  include_dir = ["api"]
-  include_ext = ["go"]
-  include_file = []
-  kill_delay = "0s"
-  log = "build-errors.log"
-  poll = false
-  poll_interval = 0
-  post_cmd = []
-  pre_cmd = []
-  rerun = false
-  rerun_delay = 500
-  send_interrupt = false
-  stop_on_error = false
-
-[color]
-  app = ""
-  build = "yellow"
-  main = "magenta"
-  runner = "green"
-  watcher = "cyan"
-
-[log]
-  main_only = false
-  silent = false
-  time = false
-
-[misc]
-  clean_on_exit = false
-
-[proxy]
-  app_port = 0
-  enabled = false
-  proxy_port = 0
-
-[screen]
-  clear_on_rebuild = false
-  keep_scroll = true

.dockerignore

@@ -1,5 +1,4 @@
-*
-!dist
-!build
-!metadata.json
-!docker-extension/build
+node_modules
+bower_components
+.git
+Dockerfile

.env.defaults

@@ -1 +0,0 @@
-PORTAINER_EDITION=CE

.eslintignore

@@ -1,3 +0,0 @@
-node_modules/
-dist/
-test/

.eslintrc.yml

@@ -1,162 +0,0 @@
-env:
-  browser: true
-  jquery: true
-  node: true
-  es6: true
-
-globals:
-  angular: true
-
-extends:
-  - 'eslint:recommended'
-  - 'plugin:storybook/recommended'
-  - 'plugin:import/typescript'
-  - prettier
-
-plugins:
-  - import
-
-parserOptions:
-  ecmaVersion: latest
-  sourceType: module
-  project: './tsconfig.json'
-  ecmaFeatures:
-    modules: true
-
-rules:
-  no-console: error
-  no-alert: error
-  no-control-regex: 'off'
-  no-empty: warn
-  no-empty-function: warn
-  no-useless-escape: 'off'
-  import/named: error
-  import/order:
-    [
-      'error',
-      {
-        pathGroups:
-          [
-            { pattern: '@@/**', group: 'internal', position: 'after' },
-            { pattern: '@/**', group: 'internal' },
-            { pattern: '{Kubernetes,Portainer,Agent,Azure,Docker}/**', group: 'internal' },
-          ],
-        groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
-        pathGroupsExcludedImportTypes: ['internal'],
-      },
-    ]
-  no-restricted-imports:
-    - error
-    - patterns:
-        - group:
-            - '@/react/test-utils/*'
-          message: 'These utils are just for test files'
-
-settings:
-  'import/resolver':
-    alias:
-      map:
-        - ['@@', './app/react/components']
-        - ['@', './app']
-      extensions: ['.js', '.ts', '.tsx']
-    typescript: true
-    node: true
-
-overrides:
-  - files:
-      - app/**/*.ts{,x}
-    parserOptions:
-      project: './tsconfig.json'
-    parser: '@typescript-eslint/parser'
-    plugins:
-      - '@typescript-eslint'
-      - 'regex'
-    extends:
-      - airbnb
-      - airbnb-typescript
-      - 'plugin:eslint-comments/recommended'
-      - 'plugin:react-hooks/recommended'
-      - 'plugin:react/jsx-runtime'
-      - 'plugin:@typescript-eslint/recommended'
-      - 'plugin:@typescript-eslint/eslint-recommended'
-      - 'plugin:promise/recommended'
-      - 'plugin:storybook/recommended'
-      - prettier # should be last
-    settings:
-      react:
-        version: 'detect'
-
-    rules:
-      no-console: error
-      import/order:
-        [
-          'error',
-          {
-            pathGroups: [{ pattern: '@@/**', group: 'internal', position: 'after' }, { pattern: '@/**', group: 'internal' }],
-            groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
-            'newlines-between': 'always',
-          },
-        ]
-      no-plusplus: off
-      func-style: [error, 'declaration']
-      import/prefer-default-export: off
-      no-use-before-define: 'off'
-      '@typescript-eslint/no-use-before-define': ['error', { functions: false, 'allowNamedExports': true }]
-      no-shadow: 'off'
-      '@typescript-eslint/no-shadow': off
-      jsx-a11y/no-autofocus: warn
-      react/forbid-prop-types: off
-      react/require-default-props: off
-      react/no-array-index-key: off
-      no-underscore-dangle: off
-      react/jsx-filename-extension: [0]
-      import/no-extraneous-dependencies: ['error', { devDependencies: true }]
-      '@typescript-eslint/explicit-module-boundary-types': off
-      '@typescript-eslint/no-unused-vars': 'error'
-      '@typescript-eslint/no-explicit-any': 'error'
-      'jsx-a11y/label-has-associated-control':
-        - error
-        - assert: either
-          controlComponents:
-            - Input
-            - Checkbox
-      'jsx-a11y/control-has-associated-label': off
-      'react/function-component-definition': ['error', { 'namedComponents': 'function-declaration' }]
-      'react/jsx-no-bind': off
-      'no-await-in-loop': 'off'
-      'react/jsx-no-useless-fragment': ['error', { allowExpressions: true }]
-      'regex/invalid': ['error', [{ 'regex': '<Icon icon="(.*)"', 'message': 'Please directly import the `lucide-react` icon instead of using the string' }]]
-      '@typescript-eslint/no-restricted-imports':
-        - error
-        - patterns:
-            - group:
-                - '@/react/test-utils/*'
-              message: 'These utils are just for test files'
-    overrides: # allow props spreading for hoc files
-      - files:
-          - app/**/with*.ts{,x}
-        rules:
-          'react/jsx-props-no-spreading': off
-  - files:
-      - app/**/*.test.*
-    plugins:
-      - '@vitest'
-    extends:
-      - 'plugin:@vitest/legacy-recommended'
-    env:
-      '@vitest/env': true
-    rules:
-      'react/jsx-no-constructed-context-values': off
-      '@typescript-eslint/no-restricted-imports': off
-      no-restricted-imports: off
-      'react/jsx-props-no-spreading': off
-      '@vitest/no-conditional-expect': warn
-      'max-classes-per-file': off
-  - files:
-      - app/**/*.stories.*
-    rules:
-      'no-alert': off
-      '@typescript-eslint/no-restricted-imports': off
-      no-restricted-imports: off
-      'react/jsx-props-no-spreading': off
-      'storybook/no-renderer-packages': off

.git-blame-ignore-revs

@@ -1,8 +0,0 @@
-# prettier
-cf5056d9c03b62d91a25c3b9127caac838695f98
-
-# prettier v2
-42e7db0ae7897d3cb72b0ea1ecf57ee2dd694169
-
-# tailwind prettier
-58d66d3142950bb90a7d85511c034ac9fabba9ba

.github/DISCUSSION_TEMPLATE/help.yaml

@@ -1,11 +0,0 @@
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Before asking a question, make sure it hasn't been already asked and answered. You can search our [discussions](https://github.com/orgs/portainer/discussions) and [bug reports](https://github.com/portainer/portainer/issues) in GitHub.  Also, be sure to check our [knowledge base](https://portal.portainer.io/knowledge) and [documentation](https://docs.portainer.io/) first.
-
-  - type: textarea
-    attributes:
-      label: Ask a Question!
-    validations:
-      required: true

.github/DISCUSSION_TEMPLATE/ideas.yaml

@@ -1,38 +0,0 @@
-body:
-  - type: markdown
-    attributes:
-      value: |
-        # Welcome!
-        
-        Thanks for suggesting an idea for Portainer!
-
-        Before opening a new idea or feature request, make sure that we do not have any duplicates already open. You can ensure this by [searching this discussion category](https://github.com/orgs/portainer/discussions/categories/ideas). If there is a duplicate, please add a comment to the existing idea instead.
-
-        Also, be sure to check our [knowledge base](https://portal.portainer.io/knowledge) and [documentation](https://docs.portainer.io) as they may point you toward a solution.
-        
-        **DO NOT FILE DUPLICATE REQUESTS.**
-
-  - type: textarea
-    attributes:
-      label: Is your feature request related to a problem? Please describe
-      description: Short list of what the feature request aims to address.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Describe the solution you'd like
-      description: A clear and concise description of what you want to happen.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Describe alternatives you've considered
-      description: A clear and concise description of any alternative solutions or features you've considered.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Additional context
-      description: Add any other context or screenshots about the feature request here.
-    validations:
-      required: false

.github/ISSUE_TEMPLATE.md

@@ -1,42 +0,0 @@
-<!--
-
-Thanks for opening an issue on Portainer !
-
-Do you need help or have a question? Come chat with us on Slack https://portainer.io/slack/ or gitter https://gitter.im/portainer/Lobby.
-
-If you are reporting a new issue, make sure that we do not have any duplicates
-already open. You can ensure this by searching the issue list for this
-repository. If there is a duplicate, please close your issue and add a comment
-to the existing issue instead.
-
-Also, be sure to check our FAQ and documentation first: https://portainer.readthedocs.io
-
-If you suspect your issue is a bug, please edit your issue description to
-include the BUG REPORT INFORMATION shown below.
-
----------------------------------------------------
-BUG REPORT INFORMATION
----------------------------------------------------
-You do NOT have to include this information if this is a FEATURE REQUEST
--->
-
-**Description**
-
-<!--
-Briefly describe the problem you are having in a few paragraphs.
--->
-
-**Steps to reproduce the issue:**
-
-1. 2. 3.
-
-Any other info e.g. Why do you consider this to be a bug? What did you expect to happen instead?
-
-**Technical details:**
-
-- Portainer version:
-- Target Docker version (the host/cluster you manage):
-- Platform (windows/linux):
-- Command used to start Portainer (`docker run -p 9443:9443 portainer/portainer`):
-- Target Swarm version (if applicable):
-- Browser:

.github/ISSUE_TEMPLATE/Custom.md.old

@@ -1,25 +0,0 @@
----
-name: Question
-about: Ask us a question about Portainer usage or deployment
-title: ''
-labels: ''
-assignees: ''
----
-
-Before you start, we need a little bit more information from you:
-
-Use Case (delete as appropriate): Using Portainer at Home, Using Portainer in a Commercial setup.
-
-Have you reviewed our technical documentation and knowledge base? Yes/No
-
-<!--
-
-You can find more information about Portainer support framework policy here: https://old.portainer.io/2019/04/portainer-support-policy/
-
-Do you need help or have a question? Come chat with us on Slack https://portainer.io/slack/
-
-Also, be sure to check our FAQ and documentation first: https://documentation.portainer.io/
--->
-
-**Question**:
-How can I deploy Portainer on... ?

.github/ISSUE_TEMPLATE/Feature_request.md.old

@@ -1,33 +0,0 @@
----
-name: Feature request
-about: Suggest a feature/enhancement that should be added in Portainer
-title: ''
-labels: ''
-assignees: ''
----
-
-<!--
-
-Thanks for opening a feature request for Portainer !
-
-Do you need help or have a question? Come chat with us on Slack https://portainer.io/slack/
-
-Before opening a new issue, make sure that we do not have any duplicates
-already open. You can ensure this by searching the issue list for this
-repository. If there is a duplicate, please close your issue and add a comment
-to the existing issue instead.
-
-Also, be sure to check our FAQ and documentation first: https://documentation.portainer.io/
--->
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,203 +0,0 @@
-name: Bug Report
-description: Create a report to help us improve.
-labels: kind/bug,bug/need-confirmation
-body:
-  - type: markdown
-    attributes:
-      value: |
-        # Welcome!
-
-        The issue tracker is for reporting bugs. If you have an [idea for a new feature](https://github.com/orgs/portainer/discussions/categories/ideas) or a [general question about Portainer](https://github.com/orgs/portainer/discussions/categories/help) please post in our [GitHub Discussions](https://github.com/orgs/portainer/discussions).
-
-        You can also ask for help in our [community Slack channel](https://join.slack.com/t/portainer/shared_invite/zt-txh3ljab-52QHTyjCqbe5RibC2lcjKA).
-
-        Please note that we only provide support for current versions of Portainer. You can find a list of supported versions in our [lifecycle policy](https://docs.portainer.io/start/lifecycle).
-
-        **DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS**.
-
-  - type: checkboxes
-    id: terms
-    attributes:
-      label: Before you start please confirm the following.
-      options:
-        - label: Yes, I've searched similar issues on [GitHub](https://github.com/portainer/portainer/issues).
-          required: true
-        - label: Yes, I've checked whether this issue is covered in the Portainer [documentation](https://docs.portainer.io).
-          required: true
-
-  - type: markdown
-    attributes:
-      value: |
-        # About your issue
-
-        Tell us a bit about the issue you're having.
-
-        How to write a good bug report:
-
-        - Respect the issue template as much as possible.
-        - Summarize the issue so that we understand what is going wrong.
-        - Describe what you would have expected to have happened, and what actually happened instead.
-        - Provide easy to follow steps to reproduce the issue. 
-        - Remain clear and concise.
-        - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown).
-
-  - type: textarea
-    attributes:
-      label: Problem Description
-      description: A clear and concise description of what the bug is.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Expected Behavior
-      description: A clear and concise description of what you expected to happen.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Actual Behavior
-      description: A clear and concise description of what actually happens.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Steps to Reproduce
-      description: Please be as detailed as possible when providing steps to reproduce.
-      placeholder: |
-        1. Go to '...'
-        2. Click on '....'
-        3. Scroll down to '....'
-        4. See error
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Portainer logs or screenshots
-      description: Provide Portainer container logs or any screenshots related to the issue.
-    validations:
-      required: false
-
-  - type: markdown
-    attributes:
-      value: |
-        # About your environment
-
-        Tell us a bit about your Portainer environment.
-
-  - type: dropdown
-    attributes:
-      label: Portainer version
-      description: We only provide support for current versions of Portainer as per the lifecycle policy linked above. If you are on an older version of Portainer we recommend [updating first](https://docs.portainer.io/start/upgrade) in case your bug has already been fixed.
-      multiple: false
-      options:
-        - '2.39.0'
-        - '2.38.1'
-        - '2.38.0'
-        - '2.37.0'
-        - '2.36.0'
-        - '2.35.0'
-        - '2.34.0'
-        - '2.33.7'
-        - '2.33.6'
-        - '2.33.5'
-        - '2.33.4'
-        - '2.33.3'
-        - '2.33.2'
-        - '2.33.1'
-        - '2.33.0'
-        - '2.32.0'
-        - '2.31.3'
-        - '2.31.2'
-        - '2.31.1'
-        - '2.31.0'
-        - '2.30.1'
-        - '2.30.0'
-        - '2.29.2'
-        - '2.29.1'
-        - '2.29.0'
-        - '2.28.1'
-        - '2.28.0'
-        - '2.27.9'
-        - '2.27.8'
-        - '2.27.7'
-        - '2.27.6'
-        - '2.27.5'
-        - '2.27.4'
-        - '2.27.3'
-        - '2.27.2'
-        - '2.27.1'
-        - '2.27.0'
-        - '2.26.1'
-        - '2.26.0'
-        - '2.25.1'
-        - '2.25.0'
-        - '2.24.1'
-        - '2.24.0'
-        - '2.23.0'
-        - '2.22.0'
-        - '2.21.5'
-        - '2.21.4'
-        - '2.21.3'
-        - '2.21.2'
-    validations:
-      required: true
-
-  - type: dropdown
-    attributes:
-      label: Portainer Edition
-      multiple: false
-      options:
-        - 'Business Edition (BE/EE) with 5NF / 3NF license'
-        - 'Business Edition (BE/EE) with Home & Student license'
-        - 'Business Edition (BE/EE) with Starter license'
-        - 'Business Edition (BE/EE) with Professional or Enterprise license'
-        - 'Community Edition (CE)'
-    validations:
-      required: true
-
-  - type: input
-    attributes:
-      label: Platform and Version
-      description: |
-        Enter your container management platform (Docker | Swarm | Kubernetes) along with the version. 
-        Example: Docker 24.0.3 | Docker Swarm 24.0.3 | Kubernetes 1.26
-        You can find our supported platforms [in our documentation](https://docs.portainer.io/start/requirements-and-prerequisites).
-    validations:
-      required: true
-
-  - type: input
-    attributes:
-      label: OS and Architecture
-      description: |
-        Enter your Operating System, Version and Architecture. Example: Ubuntu 22.04, AMD64 | Raspbian OS, ARM64
-    validations:
-      required: true
-
-  - type: input
-    attributes:
-      label: Browser
-      description: |
-        Enter your browser and version. Example: Google Chrome 114.0
-    validations:
-      required: false
-
-  - type: textarea
-    attributes:
-      label: What command did you use to deploy Portainer?
-      description: |
-        Example: `docker run -d -p 8000:8000 -p 9443:9443 --name portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:latest`
-        If you deployed Portainer using a compose file or manifest you can provide this here as well.
-      render: bash
-    validations:
-      required: false
-
-  - type: textarea
-    attributes:
-      label: Additional Information
-      description: Any additional information about your environment, the bug, or anything else you think might be helpful.
-    validations:
-      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Question
-    url: https://github.com/orgs/portainer/discussions/new?category=help
-    about: Ask us a question about Portainer usage or deployment.
-  - name: Idea or Feature Request
-    url: https://github.com/orgs/portainer/discussions/new?category=ideas
-    about: Suggest an idea or feature/enhancement that should be added in Portainer.
-  - name: Portainer Business Edition - Get 3 Nodes Free
-    url: https://www.portainer.io/take-3
-    about: Portainer Business Edition has more features, more support and you can now get 3 nodes free for as long as you want.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +0,0 @@
-closes #0 <!-- Github issue number (remove if unknown) -->
-closes [CE-0] <!-- Jira link number (remove if unknown). Please also add the same [CE-XXX] at the back of the PR title -->
-
-### Changes:

.gitignore

@@ -1,22 +1,7 @@
+logs/*
+!.gitkeep
+*.esproj/*
 node_modules
 bower_components
-dist
-portainer-checksum.txt
-api/cmd/portainer/portainer*
-storybook-static
-.tmp
-**/.vscode/settings.json
-**/.vscode/tasks.json
-.vscode
-*.DS_Store
-
-.eslintcache
-__debug_bin*
-
-api/docs
 .idea
-.env
-go.work.sum
-
-.vitest
-
+*.iml

.godir

@@ -0,0 +1 @@
+dockerui

.golangci-forward.yaml

@@ -1,16 +0,0 @@
-version: "2"
-linters:
-  default: none
-  enable:
-    - forbidigo
-  settings:
-    forbidigo:
-      forbid:
-        - pattern: ^dataservices.DataStore.(EdgeGroup|EdgeJob|EdgeStack|EndpointRelation|Endpoint|GitCredential|Registry|ResourceControl|Role|Settings|Snapshot|SSLSettings|Stack|Tag|User)$
-          msg: Use a transaction instead
-      analyze-types: true
-  exclusions:
-    rules:
-      - path: _test\.go
-        linters:
-          - forbidigo

.golangci.yaml

@@ -1,108 +0,0 @@
-version: "2"
-
-run:
-  allow-parallel-runners: true
-linters:
-  default: none
-  enable:
-    - bodyclose
-    - copyloopvar
-    - depguard
-    - errcheck
-    - errorlint
-    - forbidigo
-    - govet
-    - ineffassign
-    - intrange
-    - perfsprint
-    - staticcheck
-    - unused
-    - mirror
-    - durationcheck
-    - errorlint
-    - govet
-    - usetesting
-    - zerologlint
-    - testifylint
-    - modernize
-    - unconvert
-    - unused
-    - zerologlint
-    - exptostd
-  settings:
-    staticcheck:
-      checks: ["all", "-ST1003", "-ST1005", "-ST1016", "-SA1019", "-QF1003"]
-    depguard:
-      rules:
-        main:
-          files:
-            - '!**/*_test.go'
-            - '!**/base.go'
-            - '!**/base_tx.go'
-          deny:
-            - pkg: encoding/json
-              desc: use github.com/segmentio/encoding/json
-            - pkg: golang.org/x/exp
-              desc: exp is not allowed
-            - pkg: github.com/portainer/libcrypto
-              desc: use github.com/portainer/portainer/pkg/libcrypto
-            - pkg: github.com/portainer/libhttp
-              desc: use github.com/portainer/portainer/pkg/libhttp
-            - pkg: golang.org/x/crypto
-              desc: golang.org/x/crypto is not allowed because of FIPS mode
-            - pkg: github.com/ProtonMail/go-crypto/openpgp
-              desc: github.com/ProtonMail/go-crypto/openpgp is not allowed because of FIPS mode
-            - pkg: github.com/cosi-project/runtime
-              desc: github.com/cosi-project/runtime is not allowed because of FIPS mode
-            - pkg: gopkg.in/yaml.v2
-              desc: use go.yaml.in/yaml/v3 instead
-            - pkg: gopkg.in/yaml.v3
-              desc: use go.yaml.in/yaml/v3 instead
-            - pkg: github.com/golang-jwt/jwt/v4
-              desc: use github.com/golang-jwt/jwt/v5 instead
-            - pkg: github.com/mitchellh/mapstructure
-              desc: use github.com/go-viper/mapstructure/v2 instead
-            - pkg: gopkg.in/alecthomas/kingpin.v2
-              desc: use github.com/alecthomas/kingpin/v2 instead
-            - pkg: github.com/jcmturner/gokrb5$
-              desc: use github.com/jcmturner/gokrb5/v8 instead
-            - pkg: github.com/gofrs/uuid
-              desc: use github.com/google/uuid
-            - pkg: github.com/Masterminds/semver$
-              desc: use github.com/Masterminds/semver/v3
-            - pkg: github.com/blang/semver
-              desc: use github.com/Masterminds/semver/v3
-            - pkg: github.com/coreos/go-semver
-              desc: use github.com/Masterminds/semver/v3
-            - pkg: github.com/hashicorp/go-version
-              desc: use github.com/Masterminds/semver/v3
-    forbidigo:
-      forbid:
-        - pattern: ^tls\.Config$
-          msg: Use crypto.CreateTLSConfiguration() instead
-        - pattern: ^tls\.Config\.(InsecureSkipVerify|MinVersion|MaxVersion|CipherSuites|CurvePreferences)$
-          msg: Do not set this field directly, use crypto.CreateTLSConfiguration() instead
-        - pattern: ^object\.(Commit|Tag)\.Verify$
-          msg: "Not allowed because of FIPS mode"
-        - pattern: ^(types\.SystemContext\.)?(DockerDaemonInsecureSkipTLSVerify|DockerInsecureSkipTLSVerify|OCIInsecureSkipTLSVerify)$
-          msg: "Not allowed because of FIPS mode"
-      analyze-types: true
-  exclusions:
-    generated: lax
-    presets:
-      - comments
-      - common-false-positives
-      - legacy
-    paths:
-      - third_party$
-      - builtin$
-      - examples$
-formatters:
-  enable:
-    - gofmt
-  exclusions:
-    generated: lax
-    paths:
-      - third_party$
-      - builtin$
-      - examples$

.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-cd $(dirname -- "$0") && pnpm lint-staged

.prettierignore

@@ -1,3 +0,0 @@
-dist
-api/datastore/test_data
-coverage

.prettierrc

@@ -1,25 +0,0 @@
-{
-  "printWidth": 180,
-  "singleQuote": true,
-  "htmlWhitespaceSensitivity": "strict",
-  "trailingComma": "es5",
-  "overrides": [
-    {
-      "files": [
-        "*.html"
-      ],
-      "options": {
-        "parser": "angular"
-      }
-    },
-    {
-      "files": [
-        "*.{j,t}sx",
-        "*.ts"
-      ],
-      "options": {
-        "printWidth": 80
-      }
-    }
-  ]
-}

.storybook/main.ts

@@ -1,111 +0,0 @@
-import { StorybookConfig } from '@storybook/react-webpack5';
-
-import TsconfigPathsPlugin from 'tsconfig-paths-webpack-plugin';
-import { Configuration } from 'webpack';
-import postcss from 'postcss';
-
-const config: StorybookConfig = {
-  stories: ['../app/**/*.stories.@(ts|tsx)'],
-  addons: [
-    '@storybook/addon-links',
-    '@storybook/addon-essentials',
-    '@storybook/addon-webpack5-compiler-swc',
-    '@chromatic-com/storybook',
-    {
-      name: '@storybook/addon-styling-webpack',
-
-      options: {
-        rules: [
-          {
-            test: /\.css$/,
-            sideEffects: true,
-            use: [
-              require.resolve('style-loader'),
-              {
-                loader: require.resolve('css-loader'),
-                options: {
-                  importLoaders: 1,
-                  modules: {
-                    localIdentName: '[path][name]__[local]',
-                    auto: true,
-                    exportLocalsConvention: 'camelCaseOnly',
-                  },
-                },
-              },
-              {
-                loader: require.resolve('postcss-loader'),
-                options: {
-                  implementation: postcss,
-                },
-              },
-            ],
-          },
-        ],
-      },
-    },
-  ],
-  webpackFinal: (config) => {
-    const rules = config?.module?.rules || [];
-
-    const imageRule = rules.find((rule) => {
-      const test = (rule as { test: RegExp }).test;
-
-      if (!test) {
-        return false;
-      }
-
-      return test.test('.svg');
-    }) as { [key: string]: any };
-
-    imageRule.exclude = /\.svg$/;
-
-    rules.unshift({
-      test: /\.svg$/i,
-      type: 'asset',
-      resourceQuery: {
-        not: [/c/],
-      }, // exclude react component if *.svg?url
-    });
-
-    rules.unshift({
-      test: /\.svg$/i,
-      issuer: /\.(js|ts)(x)?$/,
-      resourceQuery: /c/,
-      // *.svg?c
-      use: [
-        {
-          loader: '@svgr/webpack',
-          options: {
-            icon: true,
-          },
-        },
-      ],
-    });
-    return {
-      ...config,
-      resolve: {
-        ...config.resolve,
-        plugins: [
-          ...(config.resolve?.plugins || []),
-          new TsconfigPathsPlugin({
-            extensions: config.resolve?.extensions,
-          }),
-        ],
-      },
-      module: {
-        ...config.module,
-        rules,
-      },
-    } satisfies Configuration;
-  },
-  staticDirs: ['./public'],
-  typescript: {
-    reactDocgen: 'react-docgen-typescript',
-  },
-  framework: {
-    name: '@storybook/react-webpack5',
-    options: {},
-  },
-};
-
-export default config;

.storybook/preview.tsx

@@ -1,50 +0,0 @@
-import '../app/assets/css';
-import { pushStateLocationPlugin, UIRouter } from '@uirouter/react';
-import { initialize as initMSW, mswLoader } from 'msw-storybook-addon';
-import { handlers } from '../app/setup-tests/server-handlers';
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-import { Preview } from '@storybook/react';
-
-initMSW(
-  {
-    onUnhandledRequest: ({ method, url }) => {
-      if (url.startsWith('/api')) {
-        console.error(`Unhandled ${method} request to ${url}.
-
-        This exception has been only logged in the console, however, it's strongly recommended to resolve this error as you don't want unmocked data in Storybook stories.
-
-        If you wish to mock an error response, please refer to this guide: https://mswjs.io/docs/recipes/mocking-error-responses
-      `);
-      }
-    },
-  },
-  handlers
-);
-
-const testQueryClient = new QueryClient({
-  defaultOptions: { queries: { retry: false } },
-});
-
-const preview: Preview = {
-  decorators: (Story) => (
-    <QueryClientProvider client={testQueryClient}>
-      <UIRouter plugins={[pushStateLocationPlugin]}>
-        <Story />
-      </UIRouter>
-    </QueryClientProvider>
-  ),
-  loaders: [mswLoader],
-  parameters: {
-    controls: {
-      matchers: {
-        color: /(background|color)$/i,
-        date: /Date$/,
-      },
-    },
-    msw: {
-      handlers,
-    },
-  },
-};
-
-export default preview;

.storybook/public/mockServiceWorker.js

@@ -1,284 +0,0 @@
-/* eslint-disable */
-/* tslint:disable */
-
-/**
- * Mock Service Worker (2.0.11).
- * @see https://github.com/mswjs/msw
- * - Please do NOT modify this file.
- * - Please do NOT serve this file on production.
- */
-
-const INTEGRITY_CHECKSUM = 'c5f7f8e188b673ea4e677df7ea3c5a39';
-const IS_MOCKED_RESPONSE = Symbol('isMockedResponse');
-const activeClientIds = new Set();
-
-self.addEventListener('install', function () {
-  self.skipWaiting();
-});
-
-self.addEventListener('activate', function (event) {
-  event.waitUntil(self.clients.claim());
-});
-
-self.addEventListener('message', async function (event) {
-  const clientId = event.source.id;
-
-  if (!clientId || !self.clients) {
-    return;
-  }
-
-  const client = await self.clients.get(clientId);
-
-  if (!client) {
-    return;
-  }
-
-  const allClients = await self.clients.matchAll({
-    type: 'window',
-  });
-
-  switch (event.data) {
-    case 'KEEPALIVE_REQUEST': {
-      sendToClient(client, {
-        type: 'KEEPALIVE_RESPONSE',
-      });
-      break;
-    }
-
-    case 'INTEGRITY_CHECK_REQUEST': {
-      sendToClient(client, {
-        type: 'INTEGRITY_CHECK_RESPONSE',
-        payload: INTEGRITY_CHECKSUM,
-      });
-      break;
-    }
-
-    case 'MOCK_ACTIVATE': {
-      activeClientIds.add(clientId);
-
-      sendToClient(client, {
-        type: 'MOCKING_ENABLED',
-        payload: true,
-      });
-      break;
-    }
-
-    case 'MOCK_DEACTIVATE': {
-      activeClientIds.delete(clientId);
-      break;
-    }
-
-    case 'CLIENT_CLOSED': {
-      activeClientIds.delete(clientId);
-
-      const remainingClients = allClients.filter((client) => {
-        return client.id !== clientId;
-      });
-
-      // Unregister itself when there are no more clients
-      if (remainingClients.length === 0) {
-        self.registration.unregister();
-      }
-
-      break;
-    }
-  }
-});
-
-self.addEventListener('fetch', function (event) {
-  const { request } = event;
-
-  // Bypass navigation requests.
-  if (request.mode === 'navigate') {
-    return;
-  }
-
-  // Opening the DevTools triggers the "only-if-cached" request
-  // that cannot be handled by the worker. Bypass such requests.
-  if (request.cache === 'only-if-cached' && request.mode !== 'same-origin') {
-    return;
-  }
-
-  // Bypass all requests when there are no active clients.
-  // Prevents the self-unregistered worked from handling requests
-  // after it's been deleted (still remains active until the next reload).
-  if (activeClientIds.size === 0) {
-    return;
-  }
-
-  // Generate unique request ID.
-  const requestId = crypto.randomUUID();
-  event.respondWith(handleRequest(event, requestId));
-});
-
-async function handleRequest(event, requestId) {
-  const client = await resolveMainClient(event);
-  const response = await getResponse(event, client, requestId);
-
-  // Send back the response clone for the "response:*" life-cycle events.
-  // Ensure MSW is active and ready to handle the message, otherwise
-  // this message will pend indefinitely.
-  if (client && activeClientIds.has(client.id)) {
-    (async function () {
-      const responseClone = response.clone();
-
-      sendToClient(
-        client,
-        {
-          type: 'RESPONSE',
-          payload: {
-            requestId,
-            isMockedResponse: IS_MOCKED_RESPONSE in response,
-            type: responseClone.type,
-            status: responseClone.status,
-            statusText: responseClone.statusText,
-            body: responseClone.body,
-            headers: Object.fromEntries(responseClone.headers.entries()),
-          },
-        },
-        [responseClone.body]
-      );
-    })();
-  }
-
-  return response;
-}
-
-// Resolve the main client for the given event.
-// Client that issues a request doesn't necessarily equal the client
-// that registered the worker. It's with the latter the worker should
-// communicate with during the response resolving phase.
-async function resolveMainClient(event) {
-  const client = await self.clients.get(event.clientId);
-
-  if (client?.frameType === 'top-level') {
-    return client;
-  }
-
-  const allClients = await self.clients.matchAll({
-    type: 'window',
-  });
-
-  return allClients
-    .filter((client) => {
-      // Get only those clients that are currently visible.
-      return client.visibilityState === 'visible';
-    })
-    .find((client) => {
-      // Find the client ID that's recorded in the
-      // set of clients that have registered the worker.
-      return activeClientIds.has(client.id);
-    });
-}
-
-async function getResponse(event, client, requestId) {
-  const { request } = event;
-
-  // Clone the request because it might've been already used
-  // (i.e. its body has been read and sent to the client).
-  const requestClone = request.clone();
-
-  function passthrough() {
-    const headers = Object.fromEntries(requestClone.headers.entries());
-
-    // Remove internal MSW request header so the passthrough request
-    // complies with any potential CORS preflight checks on the server.
-    // Some servers forbid unknown request headers.
-    delete headers['x-msw-intention'];
-
-    return fetch(requestClone, { headers });
-  }
-
-  // Bypass mocking when the client is not active.
-  if (!client) {
-    return passthrough();
-  }
-
-  // Bypass initial page load requests (i.e. static assets).
-  // The absence of the immediate/parent client in the map of the active clients
-  // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
-  // and is not ready to handle requests.
-  if (!activeClientIds.has(client.id)) {
-    return passthrough();
-  }
-
-  // Bypass requests with the explicit bypass header.
-  // Such requests can be issued by "ctx.fetch()".
-  const mswIntention = request.headers.get('x-msw-intention');
-  if (['bypass', 'passthrough'].includes(mswIntention)) {
-    return passthrough();
-  }
-
-  // Notify the client that a request has been intercepted.
-  const requestBuffer = await request.arrayBuffer();
-  const clientMessage = await sendToClient(
-    client,
-    {
-      type: 'REQUEST',
-      payload: {
-        id: requestId,
-        url: request.url,
-        mode: request.mode,
-        method: request.method,
-        headers: Object.fromEntries(request.headers.entries()),
-        cache: request.cache,
-        credentials: request.credentials,
-        destination: request.destination,
-        integrity: request.integrity,
-        redirect: request.redirect,
-        referrer: request.referrer,
-        referrerPolicy: request.referrerPolicy,
-        body: requestBuffer,
-        keepalive: request.keepalive,
-      },
-    },
-    [requestBuffer]
-  );
-
-  switch (clientMessage.type) {
-    case 'MOCK_RESPONSE': {
-      return respondWithMock(clientMessage.data);
-    }
-
-    case 'MOCK_NOT_FOUND': {
-      return passthrough();
-    }
-  }
-
-  return passthrough();
-}
-
-function sendToClient(client, message, transferrables = []) {
-  return new Promise((resolve, reject) => {
-    const channel = new MessageChannel();
-
-    channel.port1.onmessage = (event) => {
-      if (event.data && event.data.error) {
-        return reject(event.data.error);
-      }
-
-      resolve(event.data);
-    };
-
-    client.postMessage(message, [channel.port2].concat(transferrables.filter(Boolean)));
-  });
-}
-
-async function respondWithMock(response) {
-  // Setting response status code to 0 is a no-op.
-  // However, when responding with a "Response.error()", the produced Response
-  // instance will have status code set to 0. Since it's not possible to create
-  // a Response instance with status code 0, handle that use-case separately.
-  if (response.status === 0) {
-    return Response.error();
-  }
-
-  const mockedResponse = new Response(response.body, response);
-
-  Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
-    value: true,
-    enumerable: true,
-  });
-
-  return mockedResponse;
-}

ATTRIBUTIONS.md

@@ -1,32 +0,0 @@
-# Open Source License Attribution
-
-This application uses Open Source components. You can find the source
-code of their open source projects along with license information below.
-We acknowledge and are grateful to these developers for their contributions
-to open source.
-
-### [angular-json-tree](https://github.com/awendland/angular-json-tree)
-
-by [Alex Wendland](https://github.com/awendland) is licensed under [CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)
-
-### [caniuse-db](https://github.com/Fyrd/caniuse)
-
-by [caniuse.com](caniuse.com) is licensed under [CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)
-
-### [caniuse-lite](https://github.com/ben-eb/caniuse-lite)
-
-by [caniuse.com](caniuse.com) is licensed under [CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)
-
-### [spdx-exceptions](https://github.com/jslicense/spdx-exceptions.json)
-
-by Kyle Mitchell using [SPDX](https://spdx.dev/) from Linux Foundation licensed under [CC BY 3.0 License](https://creativecommons.org/licenses/by/3.0/)
-
-### [fontawesome-free](https://github.com/FortAwesome/Font-Awesome) Icons
-
-by [Fort Awesome](https://fortawesome.com/) is licensed under [CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)
-
-Portainer also contains the following code, which is licensed under the [MIT license](https://opensource.org/licenses/MIT):
-
-UI For Docker: Copyright (c) 2013-2016 Michael Crosby (crosbymichael.com), Kevan Ahlquist (kevanahlquist.com), Anthony Lapenna (portainer.io)
-
-rdash-angular: Copyright (c) [2014][elliot hesp]

CLAUDE.md

@@ -1,44 +0,0 @@
-# Portainer Community Edition
-
-Open-source container management platform with full Docker and Kubernetes support.
-
-see also:
-
-- docs/guidelines/server-architecture.md
-- docs/guidelines/go-conventions.md
-- docs/guidelines/typescript-conventions.md
-
-## Package Manager
-
-- **PNPM** 10+ (for frontend)
-- **Go** 1.25.7 (for backend)
-
-## Build Commands
-
-```bash
-# Full build
-make build              # Build both client and server
-make build-client       # Build React/AngularJS frontend
-make build-server       # Build Go binary
-make build-image        # Build Docker image
-
-# Development
-make dev                # Run both in dev mode
-make dev-client         # Start webpack-dev-server (port 8999)
-make dev-server         # Run containerized Go server
-
-pnpm run dev            # Webpack dev server
-pnpm run build          # Build frontend with webpack
-pnpm run test           # Run frontend tests
-
-# Testing
-make test               # All tests (backend + frontend)
-make test-server        # Backend tests only
-make lint               # Lint all code
-make format             # Format code
-```
-
-## Development Servers
-
-- Frontend: http://localhost:8999
-- Backend: http://localhost:9000 (HTTP) / https://localhost:9443 (HTTPS)

CODE_OF_CONDUCT.md

@@ -1,46 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at anthony.lapenna@portainer.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -1,156 +0,0 @@
-# Contributing Guidelines
-
-Some basic conventions for contributing to this project.
-
-## General
-
-Please make sure that there aren't existing pull requests attempting to address the issue mentioned. Likewise, please check for issues related to update, as someone else may be working on the issue in a branch or fork.
-
-- Please open a discussion in a new issue / existing issue to talk about the changes you'd like to bring
-- Develop in a topic branch, not master/develop
-
-When creating a new branch, prefix it with the _type_ of the change (see section **Commit Message Format** below), the associated opened issue number, a dash and some text describing the issue (using dash as a separator).
-
-For example, if you work on a bugfix for the issue #361, you could name the branch `fix361-template-selection`.
-
-## Issues open to contribution
-
-Want to contribute but don't know where to start? Have a look at the issues labeled with the `good first issue` label: https://github.com/portainer/portainer/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22
-
-## Commit Message Format
-
-Each commit message should include a **type**, a **scope** and a **subject**:
-
-```
- <type>(<scope>): <subject>
-```
-
-Lines should not exceed 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools and produces a nice, neat commit log ie:
-
-```
- #271 feat(containers): add exposed ports in the containers view
- #270 fix(templates): fix a display issue in the templates view
- #269 style(dashboard): update dashboard with new layout
-```
-
-### Type
-
-Must be one of the following:
-
-- **feat**: A new feature
-- **fix**: A bug fix
-- **docs**: Documentation only changes
-- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
-  semi-colons, etc)
-- **refactor**: A code change that neither fixes a bug or adds a feature
-- **test**: Adding missing tests
-- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
-  generation
-
-### Scope
-
-The scope could be anything specifying place of the commit change. For example `networks`,
-`containers`, `images` etc...
-You can use the **area** label tag associated on the issue here (for `area/containers` use `containers` as a scope...)
-
-### Subject
-
-The subject contains succinct description of the change:
-
-- use the imperative, present tense: "change" not "changed" nor "changes"
-- don't capitalize first letter
-- no dot (.) at the end
-
-## Contribution process
-
-Our contribution process is described below. Some of the steps can be visualized inside GitHub via specific `status/` labels, such as `status/1-functional-review` or `status/2-technical-review`.
-
-### Bug report
-
-![portainer_bugreport_workflow](https://user-images.githubusercontent.com/5485061/45727219-50190a00-bbf5-11e8-9fe8-3a563bb8d5d7.png)
-
-### Feature request
-
-The feature request process is similar to the bug report process but has an extra functional validation before the technical validation as well as a documentation validation before the testing phase.
-
-![portainer_featurerequest_workflow](https://user-images.githubusercontent.com/5485061/45727229-5ad39f00-bbf5-11e8-9550-16ba66c50615.png)
-
-## Build and run Portainer locally
-
-Ensure you have Docker, Node.js, pnpm, and Golang installed in the correct versions.
-
-Install dependencies:
-
-```sh
-$ make deps
-```
-
-Then build and run the project in a Docker container:
-
-```sh
-$ make dev
-```
-
-Portainer server can now be accessed at <https://localhost:9443>. and UI dev server runs on <http://localhost:8999>.
-
-if you want to build the project you can run:
-
-```sh
-make build-all
-```
-
-For additional make commands, run `make help`.
-
-Find more detailed steps at <https://docs.portainer.io/contribute/build>.
-
-### Build customization
-
-You can customize the following settings:
-
-- `PORTAINER_DATA`: The host dir or volume name used by portainer (default is `/tmp/portainer`, which won't persist over reboots).
-- `PORTAINER_PROJECT`: The root dir of the repository - `${portainerRoot}/dist/` is imported into the container to get the build artifacts and external tools (defaults to `your current dir`).
-- `PORTAINER_FLAGS`: a list of flags to be used on the portainer commandline, in the form `--admin-password=<pwd hash> --feat fdo=false --feat open-amt` (default: `""`).
-
-## Testing your build
-
-The `--log-level=DEBUG` flag can be passed to the Portainer container in order to provide additional debug output which may be useful when troubleshooting your builds. Please note that this flag was originally intended for internal use and as such the format, functionality and output may change between releases without warning.
-
-## Adding api docs
-
-When adding a new resource (or a route handler), we should add a new tag to api/http/handler/handler.go#L136 like this:
-
-```
-// @tag.name <Name of resource>
-// @tag.description a short description
-```
-
-When adding a new route to an existing handler use the following as a template (you can use `swapi` snippet if you're using vscode):
-
-```
-// @id
-// @summary
-// @description
-// @description **Access policy**:
-// @tags
-// @security ApiKeyAuth
-// @security jwt
-// @accept json
-// @produce json
-// @param id path int true "identifier"
-// @param body body Object true "details"
-// @success 200 {object} portainer. "Success"
-// @success 204 "Success"
-// @failure 400 "Invalid request"
-// @failure 403 "Permission denied"
-// @failure 404 " not found"
-// @failure 500 "Server error"
-// @router /{id} [get]
-```
-
-explanation about each line can be found (here)[https://github.com/swaggo/swag#api-operation]
-
-## Licensing
-
-See the [LICENSE](https://github.com/portainer/portainer/blob/develop/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
-
-We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

Dockerfile

@@ -0,0 +1,6 @@
+FROM scratch
+
+COPY dist /
+
+EXPOSE 9000
+ENTRYPOINT ["/dockerui"]

LICENSE

@@ -1,17 +1,7 @@
-Copyright (c) 2018 Portainer.io
+DockerUI: Copyright (c) 2013-2014 Michael Crosby. crosbymichael.com
 
-This software is provided 'as-is', without any express or implied
-warranty.  In no event will the authors be held liable for any damages
-arising from the use of this software.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-Permission is granted to anyone to use this software for any purpose,
-including commercial applications, and to alter it and redistribute it
-freely, subject to the following restrictions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-1. The origin of this software must not be misrepresented; you must not
-   claim that you wrote the original software. If you use this software
-   in a product, an acknowledgment in the product documentation would be
-   appreciated but is not required.
-2. Altered source versions must be plainly marked as such, and must not be
-   misrepresented as being the original software.
-3. This notice may not be removed or altered from any source distribution.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -1,118 +0,0 @@
-# build target, can be one of "production", "testing", "development"
-ENV=development
-WEBPACK_CONFIG=webpack/webpack.$(ENV).js
-TAG=local
-
-SWAG=go run github.com/swaggo/swag/cmd/swag@v1.16.2
-GOTESTSUM=go run gotest.tools/gotestsum@latest
-
-# Don't change anything below this line unless you know what you're doing
-.DEFAULT_GOAL := help
-
-
-##@ Building
-.PHONY: all init-dist build-storybook build build-client build-server build-image devops
-init-dist:
-	@mkdir -p dist
-
-all: tidy deps build-server build-client ## Build the client, server and download external dependancies (doesn't build an image)
-
-build-all: all ## Alias for the 'all' target (used by CI)
-
-build-client: init-dist ## Build the client
-	export NODE_ENV=$(ENV) && pnpm run build --config $(WEBPACK_CONFIG)
-
-build-server: init-dist ## Build the server binary
-	./build/build_binary.sh "$(PLATFORM)" "$(ARCH)"
-
-build-image: build-all ## Build the Portainer image locally
-	docker buildx build --load -t portainerci/portainer-ce:$(TAG) -f build/linux/Dockerfile .
-
-build-storybook: ## Build and serve the storybook files
-	pnpm run storybook:build
-
-##@ Build dependencies
-.PHONY: deps server-deps client-deps tidy
-deps: server-deps client-deps ## Download all client and server build dependancies
-
-server-deps: init-dist ## Download dependant server binaries
-	@./build/download_binaries.sh $(PLATFORM) $(ARCH)
-
-client-deps: ## Install client dependencies
-	pnpm install
-
-tidy: ## Tidy up the go.mod file
-	@go mod tidy
-
-##@ Cleanup
-.PHONY: clean
-clean: ## Remove all build and download artifacts
-	@echo "Clearing the dist directory..."
-	@rm -rf dist/*
-
-##@ Testing
-.PHONY: test test-client test-server
-test: test-server test-client ## Run all tests
-
-test-client: ## Run client tests
-	pnpm run test $(ARGS) --coverage
-
-test-server:	## Run server tests
-	$(GOTESTSUM) --format pkgname-and-test-fails --format-hide-empty-pkg --hide-summary skipped -- -cover -covermode=atomic -coverprofile=coverage.out ./...
-
-##@ Dev
-.PHONY: dev dev-client dev-server
-dev: ## Run both the client and server in development mode
-	make dev-server
-	make dev-client
-
-dev-client: ## Run the client in development mode
-	pnpm install && pnpm run dev
-
-dev-server: build-server ## Run the server in development mode
-	@./dev/run_container.sh
-
-dev-server-podman: build-server ## Run the server in development mode
-	@./dev/run_container_podman.sh
-
-##@ Format
-.PHONY: format format-client format-server
-
-format: format-client format-server ## Format all code
-
-format-client: ## Format client code
-	pnpm run format
-
-format-server: ## Format server code
-	go fmt ./...
-
-##@ Lint
-.PHONY: lint lint-client lint-server
-lint: lint-client lint-server ## Lint all code
-
-lint-client: ## Lint client code
-	pnpm run lint
-
-lint-server: tidy ## Lint server code
-	golangci-lint run --timeout=10m -c .golangci.yaml
-	golangci-lint run --timeout=10m --new-from-rev=HEAD~ -c .golangci-forward.yaml
-
-##@ Extension
-.PHONY: dev-extension
-dev-extension: build-server build-client ## Run the extension in development mode
-	make local -f build/docker-extension/Makefile
-
-##@ Docs
-.PHONY: docs-build docs-validate docs-clean docs-validate-clean
-docs-build: init-dist ## Build docs
-	go mod download -x
-	cd api && $(SWAG) init -o "../dist/docs" -ot "yaml" -g ./http/handler/handler.go --parseDependency --parseInternal --parseDepth 2 -p pascalcase --markdownFiles ./
-
-docs-validate: docs-build ## Validate docs
-	pnpm swagger2openapi --warnOnly dist/docs/swagger.yaml -o dist/docs/openapi.yaml
-	pnpm swagger-cli validate dist/docs/openapi.yaml
-
-##@ Helpers
-.PHONY: help
-help:  ## Display this help
-	@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

Procfile

@@ -0,0 +1 @@
+web: dockerui -p ":$PORT" -e "$DOCKER_ENDPOINT"

README.md

@@ -1,69 +1,82 @@
-<p align="center">
-  <img title="portainer" src='https://github.com/portainer/portainer/blob/develop/app/assets/images/portainer-github-banner.png?raw=true' />
-</p>
+## DockerUI
 
-**Portainer Community Edition** is a lightweight service delivery platform for containerized applications that can be used to manage Docker, Swarm, Kubernetes and ACI environments. It is designed to be as simple to deploy as it is to use. The application allows you to manage all your orchestrator resources (containers, images, volumes, networks and more) through a ‘smart’ GUI and/or an extensive API.
+![Containers](/containers.png)
+DockerUI is a web interface for the Docker Remote API.  The goal is to provide a pure client side implementation so it is effortless to connect and manage docker.  This project is not complete and is still under heavy development.
 
-Portainer consists of a single container that can run on any cluster. It can be deployed as a Linux container or a Windows native container.
+![Container](/container.png)
 
-**Portainer Business Edition** builds on the open-source base and includes a range of advanced features and functions (like RBAC and Support) that are specific to the needs of business users.
 
-- [Compare Portainer CE and Compare Portainer BE](https://www.portainer.io/features)
-- [Take3 – get 3 free nodes of Portainer Business for as long as you want them](https://www.portainer.io/take-3)
-- [Portainer BE install guide](https://academy.portainer.io/install/)
+### Goals
+* Minimal dependencies - I really want to keep this project a pure html/js app.
+* Consistency - The web UI should be consistent with the commands found on the docker CLI.
 
-## Latest Version
+### Container Quickstart 
+1. Run: `docker run -d -p 9000:9000 --privileged -v /var/run/docker.sock:/var/run/docker.sock dockerui/dockerui`
 
-Portainer CE is updated regularly. We aim to do an update release every couple of months.
+2. Open your browser to `http://<dockerd host ip>:9000`
 
-[![latest version](https://img.shields.io/github/v/release/portainer/portainer?color=%2344cc11&label=Latest%20release&style=for-the-badge)](https://github.com/portainer/portainer/releases/latest)
 
-## Getting started
+Bind mounting the Unix socket into the DockerUI container is much more secure than exposing your docker daemon over TCP. The `--privileged` flag is required for hosts using SELinux. You should still secure your DockerUI instance behind some type of auth. Directions for using Nginx auth are [here](https://github.com/crosbymichael/dockerui/wiki/Dockerui-with-Nginx-HTTP-Auth).
 
-- [Deploy Portainer](https://docs.portainer.io/start/install-ce)
-- [Documentation](https://docs.portainer.io)
-- [Contribute to the project](https://docs.portainer.io/contribute/contribute)
+### Specify socket to connect to Docker daemon
 
-## Features & Functions
+By default DockerUI connects to the Docker daemon with`/var/run/docker.sock`. For this to work you need to bind mount the unix socket into the container with `-v /var/run/docker.sock:/var/run/docker.sock`.
 
-View [this](https://www.portainer.io/features) table to see all of the Portainer CE functionality and compare to Portainer Business.
+You can use the `-e` flag to change this socket:
 
-## Getting help
+    # Connect to a tcp socket:
+    $ docker run -d -p 9000:9000 --privileged dockerui/dockerui -e http://127.0.0.1:2375
 
-Portainer CE is an open source project and is supported by the community. You can buy a supported version of Portainer at portainer.io
+### Change address/port DockerUI is served on
+DockerUI listens on port 9000 by default. If you run DockerUI inside a container then you can bind the container's internal port to any external address and port:
 
-Learn more about Portainer's community support channels [here.](https://www.portainer.io/resources/get-help/get-support)
+    # Expose DockerUI on 10.20.30.1:80
+    $ docker run -d -p 10.20.30.1:80:9000 --privileged -v /var/run/docker.sock:/var/run/docker.sock dockerui/dockerui
 
-- Issues: https://github.com/portainer/portainer/issues
-- Slack (chat): [https://portainer.io/slack](https://portainer.io/slack)
+### Check the [wiki](//github.com/crosbymichael/dockerui/wiki) for more info about using dockerui
 
-You can join the Portainer Community by visiting [https://www.portainer.io/join-our-community](https://www.portainer.io/join-our-community). This will give you advance notice of events, content and other related Portainer content.
+### Stack
+* [Angular.js](https://github.com/angular/angular.js)
+* [Bootstrap](http://getbootstrap.com/)
+* [Gritter](https://github.com/jboesch/Gritter)
+* [Spin.js](https://github.com/fgnass/spin.js/)
+* [Golang](https://golang.org/)
+* [Vis.js](http://visjs.org/)
 
-## Reporting bugs and contributing
 
-- Want to report a bug or request a feature? Please open [an issue](https://github.com/portainer/portainer/issues/new).
-- Want to help us build **_portainer_**? Follow our [contribution guidelines](https://docs.portainer.io/contribute/contribute) to build it locally and make a pull request.
+### Todo:
+* Full repository support
+* Search
+* Push files to a container
+* Unit tests
 
-## Security
 
-For information about reporting security vulnerabilities, please see our [Security Policy](SECURITY.md).
+### License - MIT
+The DockerUI code is licensed under the MIT license.
 
-## Work for us
 
-If you are a developer, and our code in this repo makes sense to you, we would love to hear from you. We are always on the hunt for awesome devs, either freelance or employed. Drop us a line to success@portainer.io with your details and/or visit our [careers page](https://apply.workable.com/portainer/).
+**DockerUI:**
+Copyright (c) 2014-2015 Michael Crosby (crosbymichael.com), Kevan Ahlquist (kevanahlquist.com)
 
-## Privacy
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation 
+files (the "Software"), to deal in the Software without 
+restriction, including without limitation the rights to use, copy, 
+modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is 
+furnished to do so, subject to the following conditions:
 
-**To make sure we focus our development effort in the right places we need to know which features get used most often. To give us this information we use [Matomo Analytics](https://matomo.org/), which is hosted in Germany and is fully GDPR compliant.**
+The above copyright notice and this permission notice shall be 
+included in all copies or substantial portions of the Software.
 
-When Portainer first starts, you are given the option to DISABLE analytics. If you **don't** choose to disable it, we collect anonymous usage as per [our privacy policy](https://www.portainer.io/legal/privacy-policy). **Please note**, there is no personally identifiable information sent or stored at any time and we only use the data to help us improve Portainer.
-
-## Limitations
-
-Portainer supports "Current - 2 docker versions only. Prior versions may operate, however these are not supported.
-
-## Licensing
-
-Portainer is licensed under the zlib license. See [LICENSE](./LICENSE) for reference.
-
-Portainer also contains code from open source projects. See [ATTRIBUTIONS.md](./ATTRIBUTIONS.md) for a list.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
+HOLDERS BE LIABLE FOR ANY CLAIM, 
+DAMAGES OR OTHER LIABILITY, 
+WHETHER IN AN ACTION OF CONTRACT, 
+TORT OR OTHERWISE, 
+ARISING FROM, OUT OF OR IN CONNECTION WITH 
+THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SECURITY.md

@@ -1,61 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-Portainer maintains both Short-Term Support (STS) and Long-Term Support (LTS) versions in accordance with our official [Portainer Lifecycle Policy](https://docs.portainer.io/start/lifecycle).
-
-| Version Type | Support Status |
-| --- | --- |
-| LTS (Long-Term Support) | Supported for critical security fixes |
-| STS (Short-Term Support) | Supported until the next STS or LTS release |
-| Legacy / EOL | Not supported |
-
-For a detailed breakdown of current versions and their specific End of Life (EOL) dates, 
-please refer to the [Portainer Lifecycle Policy](https://docs.portainer.io/start/lifecycle).
-
-## Reporting a Vulnerability
-
-The Portainer team takes the security of our products seriously. If you believe you have found a security vulnerability in any Portainer-owned repository, please report it to us responsibly.
-
-**Please do not report security vulnerabilities via public GitHub issues.**
-
-### Disclosure Process
-
-1. **Report**: You can report in one of two ways:
-
-    - **GitHub**: Use the **Report a vulnerability** button on the **Security** tab of this repository.
-
-    - **Email**: Send your findings to security@portainer.io.
-
-2. **Details**: To help us verify the issue, please include:
-
-    - A description of the vulnerability and its potential impact.
-
-    - Step-by-step instructions to reproduce the issue (e.g. proof-of-concept code, scripts, or screenshots).
-
-    - The version of the software and the environment in which it was found.
-
-3. **Acknowledge**: We will acknowledge receipt of your report and provide an initial assessment.
-
-4. **Resolution**: We will work to resolve the issue as quickly as possible. We request that you do not disclose the vulnerability publicly until we have released a fix and notified affected users.
-
-## Our Commitment
-
-If you follow the responsible disclosure process, we will:
-
-- Respond to your report in a timely manner.
-
-- Provide an estimated timeline for remediation.
-
-- Notify you when the vulnerability has been patched.
-
-- Give credit for the discovery (if desired) once the fix is public.
-
-
-We will make every effort to promptly address any security weaknesses. Security advisories and fixes will be published through GitHub Security Advisories and other channels as needed.
-
-Thank you for helping keep Portainer and our community secure.
-
-## Resources
-
-- [Contributing to Portainer](https://docs.portainer.io/contribute/contribute#contributing-to-the-portainer-ce-codebase)

api/adminmonitor/admin_monitor.go

@@ -1,120 +0,0 @@
-package adminmonitor
-
-import (
-	"context"
-	"net/http"
-	"strings"
-	"sync"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-	httperror "github.com/portainer/portainer/pkg/libhttp/error"
-
-	"github.com/rs/zerolog/log"
-)
-
-const RedirectReasonAdminInitTimeout string = "AdminInitTimeout"
-
-type Monitor struct {
-	timeout           time.Duration
-	datastore         dataservices.DataStore
-	shutdownCtx       context.Context
-	cancellationFunc  context.CancelFunc
-	mu                sync.RWMutex
-	adminInitDisabled bool
-}
-
-// New creates a monitor that when started will wait for the timeout duration and then shutdown the application unless it has been initialized.
-func New(timeout time.Duration, datastore dataservices.DataStore, shutdownCtx context.Context) *Monitor {
-	return &Monitor{
-		timeout:           timeout,
-		datastore:         datastore,
-		shutdownCtx:       shutdownCtx,
-		adminInitDisabled: false,
-	}
-}
-
-// Starts starts the monitor. Active monitor could be stopped or shuttted down by cancelling the shutdown context.
-func (m *Monitor) Start() {
-	m.mu.Lock()
-	defer m.mu.Unlock()
-
-	if m.cancellationFunc != nil {
-		return
-	}
-
-	cancellationCtx, cancellationFunc := context.WithCancel(context.Background())
-	m.cancellationFunc = cancellationFunc
-
-	go func() {
-		log.Debug().Msg("start initialization monitor")
-
-		select {
-		case <-time.After(m.timeout):
-			initialized, err := m.WasInitialized()
-			if err != nil {
-				log.Error().Err(err).Msg("AdminMonitor failed to determine if Portainer is Initialized")
-				return
-			}
-
-			if !initialized {
-				log.Info().Msg("the Portainer instance timed out for security purposes, to re-enable your Portainer instance, you will need to restart Portainer")
-
-				m.mu.Lock()
-				defer m.mu.Unlock()
-
-				m.adminInitDisabled = true
-				return
-			}
-		case <-cancellationCtx.Done():
-			log.Debug().Msg("canceling initialization monitor")
-		case <-m.shutdownCtx.Done():
-			log.Debug().Msg("shutting down initialization monitor")
-		}
-	}()
-}
-
-// Stop stops monitor. Safe to call even if monitor wasn't started.
-func (m *Monitor) Stop() {
-	m.mu.Lock()
-	defer m.mu.Unlock()
-
-	if m.cancellationFunc == nil {
-		return
-	}
-
-	m.cancellationFunc()
-	m.cancellationFunc = nil
-}
-
-// WasInitialized is a system initialization check
-func (m *Monitor) WasInitialized() (bool, error) {
-	users, err := m.datastore.User().UsersByRole(portainer.AdministratorRole)
-	if err != nil {
-		return false, err
-	}
-
-	return len(users) > 0, nil
-}
-
-func (m *Monitor) WasInstanceDisabled() bool {
-	m.mu.RLock()
-	defer m.mu.RUnlock()
-
-	return m.adminInitDisabled
-}
-
-// WithRedirect checks whether administrator initialisation timeout. If so, it will return the error with redirect reason.
-// Otherwise, it will pass through the request to next
-func (m *Monitor) WithRedirect(next http.Handler) http.Handler {
-	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		if m.WasInstanceDisabled() && strings.HasPrefix(r.RequestURI, "/api") && r.RequestURI != "/api/status" && r.RequestURI != "/api/settings/public" {
-			w.Header().Set("redirect-reason", RedirectReasonAdminInitTimeout)
-			httperror.WriteError(w, http.StatusSeeOther, "Administrator initialization timeout", nil)
-			return
-		}
-
-		next.ServeHTTP(w, r)
-	})
-}

api/adminmonitor/admin_monitor_test.go

@@ -1,54 +0,0 @@
-package adminmonitor
-
-import (
-	"context"
-	"testing"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	i "github.com/portainer/portainer/api/internal/testhelpers"
-	"github.com/stretchr/testify/assert"
-)
-
-func Test_stopWithoutStarting(t *testing.T) {
-	monitor := New(1*time.Minute, nil, nil)
-	monitor.Stop()
-}
-
-func Test_stopCouldBeCalledMultipleTimes(t *testing.T) {
-	monitor := New(1*time.Minute, nil, nil)
-	monitor.Stop()
-	monitor.Stop()
-}
-
-func Test_startOrStopCouldBeCalledMultipleTimesConcurrently(t *testing.T) {
-	monitor := New(1*time.Minute, nil, context.Background())
-
-	go monitor.Start()
-	monitor.Start()
-
-	go monitor.Stop()
-	monitor.Stop()
-
-	time.Sleep(2 * time.Second)
-}
-
-func Test_canStopStartedMonitor(t *testing.T) {
-	monitor := New(1*time.Minute, nil, context.Background())
-	monitor.Start()
-	assert.NotNil(t, monitor.cancellationFunc, "cancellation function is missing in started monitor")
-
-	monitor.Stop()
-	assert.Nil(t, monitor.cancellationFunc, "cancellation function should absent in stopped monitor")
-}
-
-func Test_start_shouldDisableInstanceAfterTimeout_ifNotInitialized(t *testing.T) {
-	timeout := 10 * time.Millisecond
-
-	datastore := i.NewDatastore(i.WithUsers([]portainer.User{}))
-	monitor := New(timeout, datastore, context.Background())
-	monitor.Start()
-
-	<-time.After(20 * timeout)
-	assert.True(t, monitor.WasInstanceDisabled(), "monitor should have been timeout and instance is disabled")
-}

api/agent/version.go

@@ -1,74 +0,0 @@
-package agent
-
-import (
-	"crypto/tls"
-	"errors"
-	"fmt"
-	"io"
-	"net/http"
-	"strconv"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/url"
-
-	"github.com/rs/zerolog/log"
-)
-
-// GetAgentVersionAndPlatform returns the agent version and platform
-//
-// it sends a ping to the agent and parses the version and platform from the headers
-func GetAgentVersionAndPlatform(endpointUrl string, tlsConfig *tls.Config) (portainer.AgentPlatform, string, error) { //nolint:forbidigo
-	httpCli := &http.Client{Timeout: 3 * time.Second}
-
-	if tlsConfig != nil {
-		httpCli.Transport = &http.Transport{TLSClientConfig: tlsConfig}
-	}
-
-	parsedURL, err := url.ParseURL(endpointUrl + "/ping")
-	if err != nil {
-		return 0, "", err
-	}
-
-	parsedURL.Scheme = "https"
-
-	req, err := http.NewRequest(http.MethodGet, parsedURL.String(), nil)
-	if err != nil {
-		return 0, "", err
-	}
-
-	resp, err := httpCli.Do(req)
-	if err != nil {
-		return 0, "", err
-	}
-
-	_, _ = io.Copy(io.Discard, resp.Body)
-	if err := resp.Body.Close(); err != nil {
-		log.Warn().Err(err).Msg("failed to close response body")
-	}
-
-	if resp.StatusCode != http.StatusNoContent {
-		return 0, "", fmt.Errorf("Failed request with status %d", resp.StatusCode)
-	}
-
-	version := resp.Header.Get(portainer.PortainerAgentHeader)
-	if version == "" {
-		return 0, "", errors.New("Version Header is missing")
-	}
-
-	agentPlatformHeader := resp.Header.Get(portainer.HTTPResponseAgentPlatform)
-	if agentPlatformHeader == "" {
-		return 0, "", errors.New("Agent Platform Header is missing")
-	}
-
-	agentPlatformNumber, err := strconv.Atoi(agentPlatformHeader)
-	if err != nil {
-		return 0, "", err
-	}
-
-	if agentPlatformNumber == 0 {
-		return 0, "", errors.New("Agent platform is invalid")
-	}
-
-	return portainer.AgentPlatform(agentPlatformNumber), version, nil
-}

api/api-description.md

@@ -1,64 +0,0 @@
-Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API.
-Examples are available at https://documentation.portainer.io/api/api-examples/
-You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).
-
-# Authentication
-
-Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used.
-Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request
-with the **Bearer** authentication mechanism.
-
-Example:
-
-```
-Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE
-```
-
-# Security
-
-Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).
-
-Different access policies are available:
-
-- Public access
-- Authenticated access
-- Restricted access
-- Administrator access
-
-### Public access
-
-No authentication is required to access the environments(endpoints) with this access policy.
-
-### Authenticated access
-
-Authentication is required to access the environments(endpoints) with this access policy.
-
-### Restricted access
-
-Authentication is required to access the environments(endpoints) with this access policy.
-Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.
-
-### Administrator access
-
-Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.
-
-# Execute Docker requests
-
-Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).
-
-Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.
-
-To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).
-
-# Private Registry
-
-Using private registry, you will need to pass a based64 encoded JSON string ‘{"registryId":\<registryID value\>}’ inside the Request Header. The parameter name is "X-Registry-Auth".
-\<registryID value\> - The registry ID where the repository was created.
-
-Example:
-
-```
-eyJyZWdpc3RyeUlkIjoxfQ==
-```
-
-**NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/).

api/apikey/apikey.go

@@ -1,17 +0,0 @@
-package apikey
-
-import (
-	portainer "github.com/portainer/portainer/api"
-)
-
-// APIKeyService represents a service for managing API keys.
-type APIKeyService interface {
-	HashRaw(rawKey string) string
-	GenerateApiKey(user portainer.User, description string) (string, *portainer.APIKey, error)
-	GetAPIKey(apiKeyID portainer.APIKeyID) (*portainer.APIKey, error)
-	GetAPIKeys(userID portainer.UserID) ([]portainer.APIKey, error)
-	GetDigestUserAndKey(digest string) (portainer.User, portainer.APIKey, error)
-	UpdateAPIKey(apiKey *portainer.APIKey) error
-	DeleteAPIKey(apiKeyID portainer.APIKeyID) error
-	InvalidateUserKeyCache(userId portainer.UserID) bool
-}

api/apikey/apikey_test.go

@@ -1,52 +0,0 @@
-package apikey
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func Test_generateRandomKey(t *testing.T) {
-	is := assert.New(t)
-
-	tests := []struct {
-		name       string
-		wantLength int
-	}{
-		{
-			name:       "Generate a random key of length 16",
-			wantLength: 16,
-		},
-		{
-			name:       "Generate a random key of length 32",
-			wantLength: 32,
-		},
-		{
-			name:       "Generate a random key of length 64",
-			wantLength: 64,
-		},
-		{
-			name:       "Generate a random key of length 128",
-			wantLength: 128,
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got := GenerateRandomKey(tt.wantLength)
-			is.Len(got, tt.wantLength)
-		})
-	}
-
-	t.Run("Generated keys are unique", func(t *testing.T) {
-		keys := make(map[string]bool)
-
-		for range 100 {
-			key := GenerateRandomKey(8)
-			_, ok := keys[string(key)]
-			is.False(ok)
-
-			keys[string(key)] = true
-		}
-	})
-}

api/apikey/cache.go

@@ -1,79 +0,0 @@
-package apikey
-
-import (
-	portainer "github.com/portainer/portainer/api"
-
-	lru "github.com/hashicorp/golang-lru"
-)
-
-const DefaultAPIKeyCacheSize = 1024
-
-// entry is a tuple containing the user and API key associated to an API key digest
-type entry[T any] struct {
-	user   T
-	apiKey portainer.APIKey
-}
-
-type UserCompareFn[T any] func(T, portainer.UserID) bool
-
-// ApiKeyCache is a concurrency-safe, in-memory cache which primarily exists for to reduce database roundtrips.
-// We store the api-key digest (keys) and the associated user and key-data (values) in the cache.
-// This is required because HTTP requests will contain only the api-key digest in the x-api-key request header;
-// digest value must be mapped to a portainer user (and respective key data) for validation.
-// This cache is used to avoid multiple database queries to retrieve these user/key associated to the digest.
-type ApiKeyCache[T any] struct {
-	// cache type [string]entry cache (key: string(digest), value: user/key entry)
-	// note: []byte keys are not supported by golang-lru Cache
-	cache     *lru.Cache
-	userCmpFn UserCompareFn[T]
-}
-
-// NewAPIKeyCache creates a new cache for API keys
-func NewAPIKeyCache[T any](cacheSize int, userCompareFn UserCompareFn[T]) *ApiKeyCache[T] {
-	cache, _ := lru.New(cacheSize)
-
-	return &ApiKeyCache[T]{cache: cache, userCmpFn: userCompareFn}
-}
-
-// Get returns the user/key associated to an api-key's digest
-// This is required because HTTP requests will contain the digest of the API key in header,
-// the digest value must be mapped to a portainer user.
-func (c *ApiKeyCache[T]) Get(digest string) (T, portainer.APIKey, bool) {
-	val, ok := c.cache.Get(digest)
-	if !ok {
-		var t T
-
-		return t, portainer.APIKey{}, false
-	}
-
-	tuple := val.(entry[T])
-
-	return tuple.user, tuple.apiKey, true
-}
-
-// Set persists a user/key entry to the cache
-func (c *ApiKeyCache[T]) Set(digest string, user T, apiKey portainer.APIKey) {
-	c.cache.Add(digest, entry[T]{
-		user:   user,
-		apiKey: apiKey,
-	})
-}
-
-// Delete evicts a digest's user/key entry key from the cache
-func (c *ApiKeyCache[T]) Delete(digest string) {
-	c.cache.Remove(digest)
-}
-
-// InvalidateUserKeyCache loops through all the api-keys associated to a user and removes them from the cache
-func (c *ApiKeyCache[T]) InvalidateUserKeyCache(userId portainer.UserID) bool {
-	present := false
-
-	for _, k := range c.cache.Keys() {
-		user, _, _ := c.Get(k.(string))
-		if c.userCmpFn(user, userId) {
-			present = c.cache.Remove(k)
-		}
-	}
-
-	return present
-}

api/apikey/cache_test.go

@@ -1,181 +0,0 @@
-package apikey
-
-import (
-	"testing"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/stretchr/testify/assert"
-)
-
-func Test_apiKeyCacheGet(t *testing.T) {
-	is := assert.New(t)
-
-	keyCache := NewAPIKeyCache(10, compareUser)
-
-	// pre-populate cache
-	keyCache.cache.Add(string("foo"), entry[portainer.User]{user: portainer.User{}, apiKey: portainer.APIKey{}})
-	keyCache.cache.Add(string(""), entry[portainer.User]{user: portainer.User{}, apiKey: portainer.APIKey{}})
-
-	tests := []struct {
-		digest string
-		found  bool
-	}{
-		{
-			digest: "foo",
-			found:  true,
-		},
-		{
-			digest: "",
-			found:  true,
-		},
-		{
-			digest: "bar",
-			found:  false,
-		},
-	}
-
-	for _, test := range tests {
-		t.Run(test.digest, func(t *testing.T) {
-			_, _, found := keyCache.Get(test.digest)
-			is.Equal(test.found, found)
-		})
-	}
-}
-
-func Test_apiKeyCacheSet(t *testing.T) {
-	is := assert.New(t)
-
-	keyCache := NewAPIKeyCache(10, compareUser)
-
-	// pre-populate cache
-	keyCache.Set("bar", portainer.User{ID: 2}, portainer.APIKey{})
-	keyCache.Set("foo", portainer.User{ID: 1}, portainer.APIKey{})
-
-	// overwrite existing entry
-	keyCache.Set("foo", portainer.User{ID: 3}, portainer.APIKey{})
-
-	val, ok := keyCache.cache.Get(string("bar"))
-	is.True(ok)
-
-	tuple := val.(entry[portainer.User])
-	is.Equal(portainer.User{ID: 2}, tuple.user)
-
-	val, ok = keyCache.cache.Get(string("foo"))
-	is.True(ok)
-
-	tuple = val.(entry[portainer.User])
-	is.Equal(portainer.User{ID: 3}, tuple.user)
-}
-
-func Test_apiKeyCacheDelete(t *testing.T) {
-	is := assert.New(t)
-
-	keyCache := NewAPIKeyCache(10, compareUser)
-
-	t.Run("Delete an existing entry", func(t *testing.T) {
-		keyCache.cache.Add(string("foo"), entry[portainer.User]{user: portainer.User{ID: 1}, apiKey: portainer.APIKey{}})
-		keyCache.Delete("foo")
-
-		_, ok := keyCache.cache.Get(string("foo"))
-		is.False(ok)
-	})
-
-	t.Run("Delete a non-existing entry", func(t *testing.T) {
-		nonPanicFunc := func() { keyCache.Delete("non-existent-key") }
-		is.NotPanics(nonPanicFunc)
-	})
-}
-
-func Test_apiKeyCacheLRU(t *testing.T) {
-	is := assert.New(t)
-
-	tests := []struct {
-		name        string
-		cacheLen    int
-		key         []string
-		foundKeys   []string
-		evictedKeys []string
-	}{
-		{
-			name:        "Cache length is 1, add 2 keys",
-			cacheLen:    1,
-			key:         []string{"foo", "bar"},
-			foundKeys:   []string{"bar"},
-			evictedKeys: []string{"foo"},
-		},
-		{
-			name:        "Cache length is 1, add 3 keys",
-			cacheLen:    1,
-			key:         []string{"foo", "bar", "baz"},
-			foundKeys:   []string{"baz"},
-			evictedKeys: []string{"foo", "bar"},
-		},
-		{
-			name:        "Cache length is 2, add 3 keys",
-			cacheLen:    2,
-			key:         []string{"foo", "bar", "baz"},
-			foundKeys:   []string{"bar", "baz"},
-			evictedKeys: []string{"foo"},
-		},
-		{
-			name:        "Cache length is 2, add 4 keys",
-			cacheLen:    2,
-			key:         []string{"foo", "bar", "baz", "qux"},
-			foundKeys:   []string{"baz", "qux"},
-			evictedKeys: []string{"foo", "bar"},
-		},
-	}
-
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			keyCache := NewAPIKeyCache(test.cacheLen, compareUser)
-
-			for _, key := range test.key {
-				keyCache.Set(key, portainer.User{ID: 1}, portainer.APIKey{})
-			}
-
-			for _, key := range test.foundKeys {
-				_, _, found := keyCache.Get(key)
-				is.True(found, "Key %s not found", key)
-			}
-
-			for _, key := range test.evictedKeys {
-				_, _, found := keyCache.Get(key)
-				is.False(found, "key %s should have been evicted", key)
-			}
-		})
-	}
-}
-
-func Test_apiKeyCacheInvalidateUserKeyCache(t *testing.T) {
-	is := assert.New(t)
-
-	keyCache := NewAPIKeyCache(10, compareUser)
-
-	t.Run("Removes users keys from cache", func(t *testing.T) {
-		keyCache.cache.Add(string("foo"), entry[portainer.User]{user: portainer.User{ID: 1}, apiKey: portainer.APIKey{}})
-
-		ok := keyCache.InvalidateUserKeyCache(1)
-		is.True(ok)
-
-		_, ok = keyCache.cache.Get(string("foo"))
-		is.False(ok)
-	})
-
-	t.Run("Does not affect other keys", func(t *testing.T) {
-		keyCache.cache.Add(string("foo"), entry[portainer.User]{user: portainer.User{ID: 1}, apiKey: portainer.APIKey{}})
-		keyCache.cache.Add(string("bar"), entry[portainer.User]{user: portainer.User{ID: 2}, apiKey: portainer.APIKey{}})
-
-		ok := keyCache.InvalidateUserKeyCache(1)
-		is.True(ok)
-
-		ok = keyCache.InvalidateUserKeyCache(1)
-		is.False(ok)
-
-		_, ok = keyCache.cache.Get(string("foo"))
-		is.False(ok)
-
-		_, ok = keyCache.cache.Get(string("bar"))
-		is.True(ok)
-	})
-}

api/apikey/service.go

@@ -1,143 +0,0 @@
-package apikey
-
-import (
-	"crypto/rand"
-	"crypto/sha256"
-	"encoding/base64"
-	"fmt"
-	"io"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-
-	"github.com/pkg/errors"
-)
-
-const portainerAPIKeyPrefix = "ptr_"
-
-var ErrInvalidAPIKey = errors.New("Invalid API key")
-
-type apiKeyService struct {
-	apiKeyRepository dataservices.APIKeyRepository
-	userRepository   dataservices.UserService
-	cache            *ApiKeyCache[portainer.User]
-}
-
-// GenerateRandomKey generates a random key of specified length
-// source: https://github.com/gorilla/securecookie/blob/master/securecookie.go#L515
-func GenerateRandomKey(length int) []byte {
-	k := make([]byte, length)
-	if _, err := io.ReadFull(rand.Reader, k); err != nil {
-		return nil
-	}
-
-	return k
-}
-
-func compareUser(u portainer.User, id portainer.UserID) bool {
-	return u.ID == id
-}
-
-func NewAPIKeyService(apiKeyRepository dataservices.APIKeyRepository, userRepository dataservices.UserService) *apiKeyService {
-	return &apiKeyService{
-		apiKeyRepository: apiKeyRepository,
-		userRepository:   userRepository,
-		cache:            NewAPIKeyCache(DefaultAPIKeyCacheSize, compareUser),
-	}
-}
-
-// HashRaw computes a hash digest of provided raw API key.
-func (a *apiKeyService) HashRaw(rawKey string) string {
-	hashDigest := sha256.Sum256([]byte(rawKey))
-
-	return base64.StdEncoding.EncodeToString(hashDigest[:])
-}
-
-// GenerateApiKey generates a raw API key for a user (for one-time display).
-// The generated API key is stored in the cache and database.
-func (a *apiKeyService) GenerateApiKey(user portainer.User, description string) (string, *portainer.APIKey, error) {
-	randKey := GenerateRandomKey(32)
-	encodedRawAPIKey := base64.StdEncoding.EncodeToString(randKey)
-	prefixedAPIKey := portainerAPIKeyPrefix + encodedRawAPIKey
-	hashDigest := a.HashRaw(prefixedAPIKey)
-
-	apiKey := &portainer.APIKey{
-		UserID:      user.ID,
-		Description: description,
-		Prefix:      prefixedAPIKey[:7],
-		DateCreated: time.Now().Unix(),
-		Digest:      hashDigest,
-	}
-
-	if err := a.apiKeyRepository.Create(apiKey); err != nil {
-		return "", nil, errors.Wrap(err, "Unable to create API key")
-	}
-
-	// persist api-key to cache
-	a.cache.Set(apiKey.Digest, user, *apiKey)
-
-	return prefixedAPIKey, apiKey, nil
-}
-
-// GetAPIKey returns an API key by its ID.
-func (a *apiKeyService) GetAPIKey(apiKeyID portainer.APIKeyID) (*portainer.APIKey, error) {
-	return a.apiKeyRepository.Read(apiKeyID)
-}
-
-// GetAPIKeys returns all the API keys associated to a user.
-func (a *apiKeyService) GetAPIKeys(userID portainer.UserID) ([]portainer.APIKey, error) {
-	return a.apiKeyRepository.GetAPIKeysByUserID(userID)
-}
-
-// GetDigestUserAndKey returns the user and api-key associated to a specified hash digest.
-// A cache lookup is performed first; if the user/api-key is not found in the cache, respective database lookups are performed.
-func (a *apiKeyService) GetDigestUserAndKey(digest string) (portainer.User, portainer.APIKey, error) {
-	cachedUser, cachedKey, ok := a.cache.Get(digest)
-	if ok {
-		return cachedUser, cachedKey, nil
-	}
-
-	apiKey, err := a.apiKeyRepository.GetAPIKeyByDigest(digest)
-	if err != nil {
-		return portainer.User{}, portainer.APIKey{}, errors.Wrap(err, "Unable to retrieve API key")
-	}
-
-	user, err := a.userRepository.Read(apiKey.UserID)
-	if err != nil {
-		return portainer.User{}, portainer.APIKey{}, errors.Wrap(err, "Unable to retrieve digest user")
-	}
-
-	// persist api-key to cache - for quicker future lookups
-	a.cache.Set(apiKey.Digest, *user, *apiKey)
-
-	return *user, *apiKey, nil
-}
-
-// UpdateAPIKey updates an API key and in cache and database.
-func (a *apiKeyService) UpdateAPIKey(apiKey *portainer.APIKey) error {
-	user, _, err := a.GetDigestUserAndKey(apiKey.Digest)
-	if err != nil {
-		return errors.Wrap(err, "Unable to retrieve API key")
-	}
-
-	a.cache.Set(apiKey.Digest, user, *apiKey)
-
-	return a.apiKeyRepository.Update(apiKey.ID, apiKey)
-}
-
-// DeleteAPIKey deletes an API key and removes the digest/api-key entry from the cache.
-func (a *apiKeyService) DeleteAPIKey(apiKeyID portainer.APIKeyID) error {
-	apiKey, err := a.apiKeyRepository.Read(apiKeyID)
-	if err != nil {
-		return errors.Wrap(err, fmt.Sprintf("Unable to retrieve API key: %d", apiKeyID))
-	}
-
-	a.cache.Delete(apiKey.Digest)
-
-	return a.apiKeyRepository.Delete(apiKeyID)
-}
-
-func (a *apiKeyService) InvalidateUserKeyCache(userId portainer.UserID) bool {
-	return a.cache.InvalidateUserKeyCache(userId)
-}

api/apikey/service_test.go

@@ -1,307 +0,0 @@
-package apikey
-
-import (
-	"crypto/sha256"
-	"encoding/base64"
-	"fmt"
-	"strings"
-	"testing"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/datastore"
-
-	"github.com/rs/zerolog/log"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-func Test_SatisfiesAPIKeyServiceInterface(t *testing.T) {
-	is := assert.New(t)
-	is.Implements((*APIKeyService)(nil), NewAPIKeyService(nil, nil))
-}
-
-func Test_GenerateApiKey(t *testing.T) {
-	is := assert.New(t)
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	service := NewAPIKeyService(store.APIKeyRepository(), store.User())
-
-	t.Run("Successfully generates API key", func(t *testing.T) {
-		desc := "test-1"
-		rawKey, apiKey, err := service.GenerateApiKey(portainer.User{ID: 1}, desc)
-		require.NoError(t, err)
-		is.NotEmpty(rawKey)
-		is.NotEmpty(apiKey)
-		is.Equal(desc, apiKey.Description)
-	})
-
-	t.Run("Api key prefix is 7 chars", func(t *testing.T) {
-		rawKey, apiKey, err := service.GenerateApiKey(portainer.User{ID: 1}, "test-2")
-		require.NoError(t, err)
-
-		is.Equal(rawKey[:7], apiKey.Prefix)
-		is.Len(apiKey.Prefix, 7)
-	})
-
-	t.Run("Api key has 'ptr_' as prefix", func(t *testing.T) {
-		rawKey, _, err := service.GenerateApiKey(portainer.User{ID: 1}, "test-x")
-		require.NoError(t, err)
-
-		is.Equal(portainerAPIKeyPrefix, "ptr_")
-		is.True(strings.HasPrefix(rawKey, "ptr_"))
-	})
-
-	t.Run("Successfully caches API key", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-		_, apiKey, err := service.GenerateApiKey(user, "test-3")
-		require.NoError(t, err)
-
-		userFromCache, apiKeyFromCache, ok := service.cache.Get(apiKey.Digest)
-		is.True(ok)
-		is.Equal(user, userFromCache)
-		is.Equal(apiKey, &apiKeyFromCache)
-	})
-
-	t.Run("Decoded raw api-key digest matches generated digest", func(t *testing.T) {
-		rawKey, apiKey, err := service.GenerateApiKey(portainer.User{ID: 1}, "test-4")
-		require.NoError(t, err)
-
-		generatedDigest := sha256.Sum256([]byte(rawKey))
-
-		is.Equal(apiKey.Digest, base64.StdEncoding.EncodeToString(generatedDigest[:]))
-	})
-}
-
-func Test_GetAPIKey(t *testing.T) {
-	is := assert.New(t)
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	service := NewAPIKeyService(store.APIKeyRepository(), store.User())
-
-	t.Run("Successfully returns all API keys", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-		_, apiKey, err := service.GenerateApiKey(user, "test-1")
-		require.NoError(t, err)
-
-		apiKeyGot, err := service.GetAPIKey(apiKey.ID)
-		require.NoError(t, err)
-
-		is.Equal(apiKey, apiKeyGot)
-	})
-}
-
-func Test_GetAPIKeys(t *testing.T) {
-	is := assert.New(t)
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	service := NewAPIKeyService(store.APIKeyRepository(), store.User())
-
-	t.Run("Successfully returns all API keys", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-		_, _, err := service.GenerateApiKey(user, "test-1")
-		require.NoError(t, err)
-		_, _, err = service.GenerateApiKey(user, "test-2")
-		require.NoError(t, err)
-
-		keys, err := service.GetAPIKeys(user.ID)
-		require.NoError(t, err)
-		is.Len(keys, 2)
-	})
-}
-
-func Test_GetDigestUserAndKey(t *testing.T) {
-	is := assert.New(t)
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	service := NewAPIKeyService(store.APIKeyRepository(), store.User())
-
-	t.Run("Successfully returns user and api key associated to digest", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-		_, apiKey, err := service.GenerateApiKey(user, "test-1")
-		require.NoError(t, err)
-
-		userGot, apiKeyGot, err := service.GetDigestUserAndKey(apiKey.Digest)
-		require.NoError(t, err)
-		is.Equal(user, userGot)
-		is.Equal(*apiKey, apiKeyGot)
-	})
-
-	t.Run("Successfully caches user and api key associated to digest", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-		_, apiKey, err := service.GenerateApiKey(user, "test-1")
-		require.NoError(t, err)
-
-		userGot, apiKeyGot, err := service.GetDigestUserAndKey(apiKey.Digest)
-		require.NoError(t, err)
-		is.Equal(user, userGot)
-		is.Equal(*apiKey, apiKeyGot)
-
-		userFromCache, apiKeyFromCache, ok := service.cache.Get(apiKey.Digest)
-		is.True(ok)
-		is.Equal(userGot, userFromCache)
-		is.Equal(apiKeyGot, apiKeyFromCache)
-	})
-}
-
-func Test_UpdateAPIKey(t *testing.T) {
-	is := assert.New(t)
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	service := NewAPIKeyService(store.APIKeyRepository(), store.User())
-
-	t.Run("Successfully updates the api-key LastUsed time", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-
-		err := store.User().Create(&user)
-		require.NoError(t, err)
-
-		_, apiKey, err := service.GenerateApiKey(user, "test-x")
-		require.NoError(t, err)
-
-		apiKey.LastUsed = time.Now().UTC().Unix()
-		err = service.UpdateAPIKey(apiKey)
-		require.NoError(t, err)
-
-		_, apiKeyGot, err := service.GetDigestUserAndKey(apiKey.Digest)
-		require.NoError(t, err)
-
-		log.Debug().Str("wanted", fmt.Sprintf("%+v", apiKey)).Str("got", fmt.Sprintf("%+v", apiKeyGot)).Msg("")
-
-		is.Equal(apiKey.LastUsed, apiKeyGot.LastUsed)
-	})
-
-	t.Run("Successfully updates api-key in cache upon api-key update", func(t *testing.T) {
-		_, apiKey, err := service.GenerateApiKey(portainer.User{ID: 1}, "test-x2")
-		require.NoError(t, err)
-
-		_, apiKeyFromCache, ok := service.cache.Get(apiKey.Digest)
-		is.True(ok)
-		is.Equal(*apiKey, apiKeyFromCache)
-
-		apiKey.LastUsed = time.Now().UTC().Unix()
-		is.NotEqual(*apiKey, apiKeyFromCache)
-
-		err = service.UpdateAPIKey(apiKey)
-		require.NoError(t, err)
-
-		_, updatedAPIKeyFromCache, ok := service.cache.Get(apiKey.Digest)
-		is.True(ok)
-		is.Equal(*apiKey, updatedAPIKeyFromCache)
-	})
-}
-
-func Test_DeleteAPIKey(t *testing.T) {
-	is := assert.New(t)
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	service := NewAPIKeyService(store.APIKeyRepository(), store.User())
-
-	t.Run("Successfully updates the api-key", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-		_, apiKey, err := service.GenerateApiKey(user, "test-1")
-		require.NoError(t, err)
-
-		_, apiKeyGot, err := service.GetDigestUserAndKey(apiKey.Digest)
-		require.NoError(t, err)
-		is.Equal(*apiKey, apiKeyGot)
-
-		err = service.DeleteAPIKey(apiKey.ID)
-		require.NoError(t, err)
-
-		_, _, err = service.GetDigestUserAndKey(apiKey.Digest)
-		require.Error(t, err)
-	})
-
-	t.Run("Successfully removes api-key from cache upon deletion", func(t *testing.T) {
-		user := portainer.User{ID: 1}
-		_, apiKey, err := service.GenerateApiKey(user, "test-1")
-		require.NoError(t, err)
-
-		_, apiKeyFromCache, ok := service.cache.Get(apiKey.Digest)
-		is.True(ok)
-		is.Equal(*apiKey, apiKeyFromCache)
-
-		err = service.DeleteAPIKey(apiKey.ID)
-		require.NoError(t, err)
-
-		_, _, ok = service.cache.Get(apiKey.Digest)
-		is.False(ok)
-	})
-}
-
-func Test_InvalidateUserKeyCache(t *testing.T) {
-	is := assert.New(t)
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	service := NewAPIKeyService(store.APIKeyRepository(), store.User())
-
-	t.Run("Successfully updates evicts keys from cache", func(t *testing.T) {
-		// generate api keys
-		user := portainer.User{ID: 1}
-		_, apiKey1, err := service.GenerateApiKey(user, "test-1")
-		require.NoError(t, err)
-
-		_, apiKey2, err := service.GenerateApiKey(user, "test-2")
-		require.NoError(t, err)
-
-		// verify api keys are present in cache
-		_, apiKeyFromCache, ok := service.cache.Get(apiKey1.Digest)
-		is.True(ok)
-		is.Equal(*apiKey1, apiKeyFromCache)
-
-		_, apiKeyFromCache, ok = service.cache.Get(apiKey2.Digest)
-		is.True(ok)
-		is.Equal(*apiKey2, apiKeyFromCache)
-
-		// evict cache
-		ok = service.InvalidateUserKeyCache(user.ID)
-		is.True(ok)
-
-		// verify users keys have been flushed from cache
-		_, _, ok = service.cache.Get(apiKey1.Digest)
-		is.False(ok)
-
-		_, _, ok = service.cache.Get(apiKey2.Digest)
-		is.False(ok)
-	})
-
-	t.Run("User key eviction does not affect other users keys", func(t *testing.T) {
-		// generate keys for 2 users
-		user1 := portainer.User{ID: 1}
-		_, apiKey1, err := service.GenerateApiKey(user1, "test-1")
-		require.NoError(t, err)
-
-		user2 := portainer.User{ID: 2}
-		_, apiKey2, err := service.GenerateApiKey(user2, "test-2")
-		require.NoError(t, err)
-
-		// verify keys in cache
-		_, apiKeyFromCache, ok := service.cache.Get(apiKey1.Digest)
-		is.True(ok)
-		is.Equal(*apiKey1, apiKeyFromCache)
-
-		_, apiKeyFromCache, ok = service.cache.Get(apiKey2.Digest)
-		is.True(ok)
-		is.Equal(*apiKey2, apiKeyFromCache)
-
-		// evict key of single user from cache
-		ok = service.cache.InvalidateUserKeyCache(user1.ID)
-		is.True(ok)
-
-		// verify user1 key has been flushed from cache
-		_, _, ok = service.cache.Get(apiKey1.Digest)
-		is.False(ok)
-
-		// verify user2 key is still in cache
-		_, _, ok = service.cache.Get(apiKey2.Digest)
-		is.True(ok)
-	})
-}

api/archive/tar.go

@@ -1,70 +0,0 @@
-package archive
-
-import (
-	"archive/tar"
-	"bytes"
-)
-
-// TarFileInBuffer will create a tar archive containing a single file named via fileName and using the content
-// specified in fileContent. Returns the archive as a byte array.
-func TarFileInBuffer(fileContent []byte, fileName string, mode int64) ([]byte, error) {
-	var buffer bytes.Buffer
-	tarWriter := tar.NewWriter(&buffer)
-
-	header := &tar.Header{
-		Name: fileName,
-		Mode: mode,
-		Size: int64(len(fileContent)),
-	}
-
-	if err := tarWriter.WriteHeader(header); err != nil {
-		return nil, err
-	}
-
-	if _, err := tarWriter.Write(fileContent); err != nil {
-		return nil, err
-	}
-
-	if err := tarWriter.Close(); err != nil {
-		return nil, err
-	}
-
-	return buffer.Bytes(), nil
-}
-
-// tarFileInBuffer represents a tar archive buffer.
-type tarFileInBuffer struct {
-	b *bytes.Buffer
-	w *tar.Writer
-}
-
-func NewTarFileInBuffer() *tarFileInBuffer {
-	var b bytes.Buffer
-	return &tarFileInBuffer{b: &b, w: tar.NewWriter(&b)}
-}
-
-// Put puts a single file to tar archive buffer.
-func (t *tarFileInBuffer) Put(fileContent []byte, fileName string, mode int64) error {
-	hdr := &tar.Header{
-		Name: fileName,
-		Mode: mode,
-		Size: int64(len(fileContent)),
-	}
-
-	if err := t.w.WriteHeader(hdr); err != nil {
-		return err
-	}
-
-	_, err := t.w.Write(fileContent)
-
-	return err
-}
-
-// Bytes returns the archive as a byte array.
-func (t *tarFileInBuffer) Bytes() []byte {
-	return t.b.Bytes()
-}
-
-func (t *tarFileInBuffer) Close() error {
-	return t.w.Close()
-}

api/archive/targz.go

@@ -1,132 +0,0 @@
-package archive
-
-import (
-	"archive/tar"
-	"compress/gzip"
-	"errors"
-	"fmt"
-	"io"
-	"os"
-	"path/filepath"
-	"strings"
-
-	"github.com/portainer/portainer/api/filesystem"
-	"github.com/portainer/portainer/api/logs"
-)
-
-// TarGzDir creates a tar.gz archive and returns it's path.
-// abosolutePath should be an absolute path to a directory.
-// Archive name will be <directoryName>.tar.gz and will be placed next to the directory.
-func TarGzDir(absolutePath string) (string, error) {
-	targzPath := filepath.Join(absolutePath, filepath.Base(absolutePath)+".tar.gz")
-	outFile, err := os.Create(targzPath)
-	if err != nil {
-		return "", err
-	}
-	defer logs.CloseAndLogErr(outFile)
-
-	zipWriter := gzip.NewWriter(outFile)
-	defer logs.CloseAndLogErr(zipWriter)
-
-	tarWriter := tar.NewWriter(zipWriter)
-	defer logs.CloseAndLogErr(tarWriter)
-
-	err = filepath.Walk(absolutePath, func(path string, info os.FileInfo, err error) error {
-		if err != nil {
-			return err
-		}
-
-		if path == targzPath {
-			return nil // skip archive file
-		}
-
-		pathInArchive := filepath.Clean(strings.TrimPrefix(path, absolutePath))
-		if pathInArchive == "" {
-			return nil // skip root dir
-		}
-
-		return addToArchive(tarWriter, pathInArchive, path, info)
-	})
-
-	return targzPath, err
-}
-
-func addToArchive(tarWriter *tar.Writer, pathInArchive string, path string, info os.FileInfo) error {
-	if info.IsDir() {
-		return nil
-	}
-
-	file, err := os.Open(path)
-	if err != nil {
-		return err
-	}
-
-	stat, err := file.Stat()
-	if err != nil {
-		return err
-	}
-
-	header, err := tar.FileInfoHeader(stat, stat.Name())
-	if err != nil {
-		return err
-	}
-	header.Name = pathInArchive // use relative paths in archive
-
-	err = tarWriter.WriteHeader(header)
-	if err != nil {
-		return err
-	}
-	if stat.IsDir() {
-		return nil
-	}
-
-	_, err = io.Copy(tarWriter, file)
-	return err
-}
-
-// ExtractTarGz reads a .tar.gz archive from the reader and extracts it into outputDirPath directory
-func ExtractTarGz(r io.Reader, outputDirPath string) error {
-	zipReader, err := gzip.NewReader(r)
-	if err != nil {
-		return err
-	}
-	defer logs.CloseAndLogErr(zipReader)
-
-	tarReader := tar.NewReader(zipReader)
-
-	for {
-		header, err := tarReader.Next()
-
-		if errors.Is(err, io.EOF) {
-			break
-		}
-
-		if err != nil {
-			return err
-		}
-
-		switch header.Typeflag {
-		case tar.TypeDir:
-			// skip, dir will be created with a file
-		case tar.TypeReg:
-			p := filesystem.JoinPaths(outputDirPath, header.Name)
-			if err := os.MkdirAll(filepath.Dir(p), 0o744); err != nil {
-				return fmt.Errorf("Failed to extract dir %s", filepath.Dir(p))
-			}
-			outFile, err := os.Create(p)
-			if err != nil {
-				return fmt.Errorf("Failed to create file %s", header.Name)
-			}
-			if _, err := io.Copy(outFile, tarReader); err != nil {
-				return fmt.Errorf("Failed to extract file %s", header.Name)
-			}
-			logs.CloseAndLogErr(outFile)
-		default:
-			return fmt.Errorf("tar: unknown type: %v in %s",
-				header.Typeflag,
-				header.Name)
-		}
-	}
-
-	return nil
-}

api/archive/targz_test.go

@@ -1,166 +0,0 @@
-package archive
-
-import (
-	"archive/tar"
-	"compress/gzip"
-	"os"
-	"os/exec"
-	"path"
-	"path/filepath"
-	"testing"
-
-	"github.com/portainer/portainer/api/filesystem"
-	"github.com/rs/zerolog/log"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-func listFiles(dir string) []string {
-	items := make([]string, 0)
-
-	if err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
-		if path == dir {
-			return nil
-		}
-
-		items = append(items, path)
-
-		return nil
-	}); err != nil {
-		log.Warn().Err(err).Msg("failed to list files in directory")
-	}
-
-	return items
-}
-
-func Test_shouldCreateArchive(t *testing.T) {
-	tmpdir := t.TempDir()
-	content := []byte("content")
-
-	err := os.WriteFile(path.Join(tmpdir, "outer"), content, 0600)
-	require.NoError(t, err)
-
-	err = os.MkdirAll(path.Join(tmpdir, "dir"), 0700)
-	require.NoError(t, err)
-
-	err = os.WriteFile(path.Join(tmpdir, "dir", ".dotfile"), content, 0600)
-	require.NoError(t, err)
-
-	err = os.WriteFile(path.Join(tmpdir, "dir", "inner"), content, 0600)
-	require.NoError(t, err)
-
-	gzPath, err := TarGzDir(tmpdir)
-	require.NoError(t, err)
-	assert.Equal(t, filepath.Join(tmpdir, filepath.Base(tmpdir)+".tar.gz"), gzPath)
-
-	extractionDir := t.TempDir()
-	cmd := exec.Command("tar", "-xzf", gzPath, "-C", extractionDir)
-	if err := cmd.Run(); err != nil {
-		t.Fatal("Failed to extract archive: ", err)
-	}
-	extractedFiles := listFiles(extractionDir)
-
-	wasExtracted := func(p string) {
-		fullpath := path.Join(extractionDir, p)
-		assert.Contains(t, extractedFiles, fullpath)
-		copyContent, err := os.ReadFile(fullpath)
-		require.NoError(t, err)
-		assert.Equal(t, content, copyContent)
-	}
-
-	wasExtracted("outer")
-	wasExtracted("dir/inner")
-	wasExtracted("dir/.dotfile")
-}
-
-func Test_shouldCreateArchive2(t *testing.T) {
-	tmpdir := t.TempDir()
-	content := []byte("content")
-
-	err := os.WriteFile(path.Join(tmpdir, "outer"), content, 0600)
-	require.NoError(t, err)
-
-	err = os.MkdirAll(path.Join(tmpdir, "dir"), 0700)
-	require.NoError(t, err)
-
-	err = os.WriteFile(path.Join(tmpdir, "dir", ".dotfile"), content, 0600)
-	require.NoError(t, err)
-
-	err = os.WriteFile(path.Join(tmpdir, "dir", "inner"), content, 0600)
-	require.NoError(t, err)
-
-	gzPath, err := TarGzDir(tmpdir)
-	require.NoError(t, err)
-	assert.Equal(t, filepath.Join(tmpdir, filepath.Base(tmpdir)+".tar.gz"), gzPath)
-
-	extractionDir := t.TempDir()
-	r, _ := os.Open(gzPath)
-	if err := ExtractTarGz(r, extractionDir); err != nil {
-		t.Fatal("Failed to extract archive: ", err)
-	}
-	extractedFiles := listFiles(extractionDir)
-
-	wasExtracted := func(p string) {
-		fullpath := path.Join(extractionDir, p)
-		assert.Contains(t, extractedFiles, fullpath)
-		copyContent, _ := os.ReadFile(fullpath)
-		assert.Equal(t, content, copyContent)
-	}
-
-	wasExtracted("outer")
-	wasExtracted("dir/inner")
-	wasExtracted("dir/.dotfile")
-}
-
-func TestExtractTarGzPathTraversal(t *testing.T) {
-	testDir := t.TempDir()
-
-	// Create an evil file with a path traversal attempt
-	tarPath := filesystem.JoinPaths(testDir, "evil.tar.gz")
-
-	evilFile, err := os.Create(tarPath)
-	require.NoError(t, err)
-
-	gzWriter := gzip.NewWriter(evilFile)
-	tarWriter := tar.NewWriter(gzWriter)
-
-	content := []byte("evil content")
-
-	header := &tar.Header{
-		Name:     "../evil.txt",
-		Mode:     0600,
-		Size:     int64(len(content)),
-		Typeflag: tar.TypeReg,
-	}
-
-	err = tarWriter.WriteHeader(header)
-	require.NoError(t, err)
-
-	_, err = tarWriter.Write(content)
-	require.NoError(t, err)
-
-	err = tarWriter.Close()
-	require.NoError(t, err)
-
-	err = gzWriter.Close()
-	require.NoError(t, err)
-
-	err = evilFile.Close()
-	require.NoError(t, err)
-
-	// Attempt to extract the evil file
-	extractionDir := filesystem.JoinPaths(testDir, "extraction")
-	err = os.Mkdir(extractionDir, 0700)
-	require.NoError(t, err)
-
-	tarFile, err := os.Open(tarPath)
-	require.NoError(t, err)
-
-	// Check that the file didn't escape
-	err = ExtractTarGz(tarFile, extractionDir)
-	require.NoError(t, err)
-	require.NoFileExists(t, filesystem.JoinPaths(testDir, "evil.txt"))
-
-	err = tarFile.Close()
-	require.NoError(t, err)
-}

api/archive/zip.go

@@ -1,73 +0,0 @@
-package archive
-
-import (
-	"archive/zip"
-	"fmt"
-	"io"
-	"os"
-	"path/filepath"
-	"strings"
-
-	"github.com/portainer/portainer/api/logs"
-
-	"github.com/pkg/errors"
-)
-
-// UnzipFile will decompress a zip archive, moving all files and folders
-// within the zip file (parameter 1) to an output directory (parameter 2).
-func UnzipFile(src string, dest string) error {
-	r, err := zip.OpenReader(src)
-	if err != nil {
-		return err
-	}
-	defer logs.CloseAndLogErr(r)
-
-	for _, f := range r.File {
-		p := filepath.Join(dest, f.Name)
-
-		// Check for ZipSlip. More Info: http://bit.ly/2MsjAWE
-		if !strings.HasPrefix(p, filepath.Clean(dest)+string(os.PathSeparator)) {
-			return fmt.Errorf("%s: illegal file path", p)
-		}
-
-		if f.FileInfo().IsDir() {
-			// Make Folder
-			if err := os.MkdirAll(p, os.ModePerm); err != nil {
-				return err
-			}
-
-			continue
-		}
-
-		if err := unzipFile(f, p); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-func unzipFile(f *zip.File, p string) error {
-	// Make File
-	if err := os.MkdirAll(filepath.Dir(p), os.ModePerm); err != nil {
-		return errors.Wrapf(err, "unzipFile: can't make a path %s", p)
-	}
-
-	outFile, err := os.OpenFile(p, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
-	if err != nil {
-		return errors.Wrapf(err, "unzipFile: can't create file %s", p)
-	}
-	defer logs.CloseAndLogErr(outFile)
-
-	rc, err := f.Open()
-	if err != nil {
-		return errors.Wrapf(err, "unzipFile: can't open zip file %s in the archive", f.Name)
-	}
-	defer logs.CloseAndLogErr(rc)
-
-	if _, err = io.Copy(outFile, rc); err != nil {
-		return errors.Wrapf(err, "unzipFile: can't copy an archived file content")
-	}
-
-	return nil
-}

api/archive/zip_test.go

@@ -1,30 +0,0 @@
-package archive
-
-import (
-	"path/filepath"
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-func TestUnzipFile(t *testing.T) {
-	dir := t.TempDir()
-	/*
-		Archive structure.
-		├── 0
-		│	├── 1
-		│	│	└── 2.txt
-		│	└── 1.txt
-		└── 0.txt
-	*/
-
-	err := UnzipFile("./testdata/sample_archive.zip", dir)
-
-	require.NoError(t, err)
-	archiveDir := dir + "/sample_archive"
-	assert.FileExists(t, filepath.Join(archiveDir, "0.txt"))
-	assert.FileExists(t, filepath.Join(archiveDir, "0", "1.txt"))
-	assert.FileExists(t, filepath.Join(archiveDir, "0", "1", "2.txt"))
-
-}

api/aws/ecr/authorization_token.go

@@ -1,61 +0,0 @@
-package ecr
-
-import (
-	"context"
-	"encoding/base64"
-	"errors"
-	"strings"
-	"time"
-)
-
-func (s *Service) GetEncodedAuthorizationToken() (token *string, expiry *time.Time, err error) {
-	getAuthorizationTokenOutput, err := s.client.GetAuthorizationToken(context.TODO(), nil)
-	if err != nil {
-		return
-	}
-
-	if len(getAuthorizationTokenOutput.AuthorizationData) == 0 {
-		err = errors.New("AuthorizationData is empty")
-		return
-	}
-
-	authData := getAuthorizationTokenOutput.AuthorizationData[0]
-
-	token = authData.AuthorizationToken
-	expiry = authData.ExpiresAt
-
-	return
-}
-
-func (s *Service) GetAuthorizationToken() (token *string, expiry *time.Time, err error) {
-	tokenEncodedStr, expiry, err := s.GetEncodedAuthorizationToken()
-	if err != nil {
-		return
-	}
-
-	tokenByte, err := base64.StdEncoding.DecodeString(*tokenEncodedStr)
-	if err != nil {
-		return
-	}
-	tokenStr := string(tokenByte)
-	token = &tokenStr
-
-	return
-}
-
-func (s *Service) ParseAuthorizationToken(token string) (username string, password string, err error) {
-	if len(token) == 0 {
-		return
-	}
-
-	splitToken := strings.Split(token, ":")
-	if len(splitToken) < 2 {
-		err = errors.New("invalid ECR authorization token")
-		return
-	}
-
-	username = splitToken[0]
-	password = splitToken[1]
-
-	return
-}

api/aws/ecr/ecr.go

@@ -1,41 +0,0 @@
-package ecr
-
-import (
-	"github.com/aws/aws-sdk-go-v2/aws"
-	"github.com/aws/aws-sdk-go-v2/credentials"
-	"github.com/aws/aws-sdk-go-v2/service/ecr"
-)
-
-// Registry represents an ECR registry endpoint information.
-// This struct is used to parse and validate ECR endpoint URLs.
-type Registry struct {
-	ID     string // AWS account ID (empty for accountless endpoints like "ecr-fips.us-west-1.amazonaws.com")
-	FIPS   bool   // Whether this is a FIPS endpoint (contains "-fips" in the URL)
-	Region string // AWS region (e.g., "us-east-1", "us-gov-west-1")
-	Public bool   // Whether this is ecr-public.aws.com
-}
-
-type (
-	Service struct {
-		accessKey string
-		secretKey string
-		region    string
-		client    *ecr.Client
-	}
-)
-
-func NewService(accessKey, secretKey, region string) *Service {
-	options := ecr.Options{
-		Region:      region,
-		Credentials: aws.NewCredentialsCache(credentials.NewStaticCredentialsProvider(accessKey, secretKey, "")),
-	}
-
-	client := ecr.New(options)
-
-	return &Service{
-		accessKey: accessKey,
-		secretKey: secretKey,
-		region:    region,
-		client:    client,
-	}
-}

api/aws/ecr/parse_endpoints.go

@@ -1,70 +0,0 @@
-package ecr
-
-import (
-	"fmt"
-	"net/url"
-	"regexp"
-	"strings"
-)
-
-// ecrEndpointPattern matches all valid ECR endpoints including account-prefixed and accountless formats.
-// Based on AWS ECR credential helper regex but extended to support accountless endpoints.
-//
-// Supported formats:
-//   - Account-prefixed: 123456789012.dkr.ecr-fips.us-east-1.amazonaws.com
-//   - Account-prefixed (hyphen): 123456789012.dkr-ecr-fips.us-west-1.on.aws
-//   - Accountless service: ecr-fips.us-west-1.amazonaws.com
-//   - Accountless API: ecr-fips.us-east-1.api.aws
-//   - Non-FIPS variants: All formats above without "-fips"
-//
-// Regex groups:
-//   - Group 1: Full account prefix (optional) - e.g., "123456789012.dkr." or "123456789012.dkr-"
-//   - Group 2: Account ID (optional) - e.g., "123456789012"
-//   - Group 3: FIPS flag (optional) - either "-fips" or empty string
-//   - Group 4: Region - e.g., "us-east-1", "us-gov-west-1"
-//   - Group 5: Domain suffix - e.g., "amazonaws.com", "api.aws"
-var ecrEndpointPattern = regexp.MustCompile(
-	`^((\d{12})\.dkr[\.\-])?ecr(\-fips)?\.([a-zA-Z0-9][a-zA-Z0-9-_]*)\.(amazonaws\.(?:com(?:\.cn)?|eu)|api\.aws|on\.(?:aws|amazonwebservices\.com\.cn)|sc2s\.sgov\.gov|c2s\.ic\.gov|cloud\.adc-e\.uk|csp\.hci\.ic\.gov)$`,
-)
-
-// ParseECREndpoint parses an ECR registry URL and extracts registry information.
-
-// This function replaces the AWS ECR credential helper library's ExtractRegistry function,
-// which only supports account-prefixed endpoints.
-//
-// Reference: https://docs.aws.amazon.com/general/latest/gr/ecr.html
-func ParseECREndpoint(urlStr string) (*Registry, error) {
-	// Normalize URL by adding https:// prefix if not present
-	if !strings.HasPrefix(urlStr, "https://") && !strings.HasPrefix(urlStr, "http://") {
-		urlStr = "https://" + urlStr
-	}
-
-	u, err := url.Parse(urlStr)
-	if err != nil {
-		return nil, fmt.Errorf("invalid URL: %w", err)
-	}
-
-	hostname := u.Hostname()
-
-	// Special case: ECR Public
-	// ECR Public uses a different domain and doesn't have FIPS variant
-	if hostname == "ecr-public.aws.com" {
-		return &Registry{
-			FIPS:   false,
-			Public: true,
-		}, nil
-	}
-
-	// Parse standard ECR endpoints using regex
-	matches := ecrEndpointPattern.FindStringSubmatch(hostname)
-	if len(matches) == 0 {
-		return nil, fmt.Errorf("not a valid ECR endpoint: %s", hostname)
-	}
-
-	return &Registry{
-		ID:     matches[2],            // Account ID (may be empty for accountless endpoints)
-		FIPS:   matches[3] == "-fips", // Check if "-fips" is present
-		Region: matches[4],            // AWS region
-		Public: false,
-	}, nil
-}

api/aws/ecr/parse_endpoints_test.go

@@ -1,253 +0,0 @@
-package ecr
-
-import (
-	"testing"
-)
-
-func TestParseECREndpoint(t *testing.T) {
-	tests := []struct {
-		name      string
-		url       string
-		want      *Registry
-		wantError bool
-	}{
-		// Standard AWS Commercial - Account-prefixed FIPS
-		{
-			name: "account-prefixed FIPS us-east-1",
-			url:  "123456789012.dkr.ecr-fips.us-east-1.amazonaws.com",
-			want: &Registry{
-				ID:     "123456789012",
-				FIPS:   true,
-				Region: "us-east-1",
-				Public: false,
-			},
-		},
-		{
-			name: "account-prefixed FIPS us-west-2",
-			url:  "123456789012.dkr.ecr-fips.us-west-2.amazonaws.com",
-			want: &Registry{
-				ID:     "123456789012",
-				FIPS:   true,
-				Region: "us-west-2",
-				Public: false,
-			},
-		},
-
-		// Accountless FIPS service endpoints
-		{
-			name: "accountless FIPS us-west-1",
-			url:  "ecr-fips.us-west-1.amazonaws.com",
-			want: &Registry{
-				ID:     "",
-				FIPS:   true,
-				Region: "us-west-1",
-				Public: false,
-			},
-		},
-		{
-			name: "accountless FIPS us-east-2",
-			url:  "ecr-fips.us-east-2.amazonaws.com",
-			want: &Registry{
-				ID:     "",
-				FIPS:   true,
-				Region: "us-east-2",
-				Public: false,
-			},
-		},
-
-		// Accountless FIPS API endpoints
-		{
-			name: "accountless FIPS API us-west-1",
-			url:  "ecr-fips.us-west-1.api.aws",
-			want: &Registry{
-				ID:     "",
-				FIPS:   true,
-				Region: "us-west-1",
-				Public: false,
-			},
-		},
-		{
-			name: "accountless FIPS API us-east-1",
-			url:  "ecr-fips.us-east-1.api.aws",
-			want: &Registry{
-				ID:     "",
-				FIPS:   true,
-				Region: "us-east-1",
-				Public: false,
-			},
-		},
-
-		// on.aws domain with hyphen separator
-		{
-			name: "account-prefixed FIPS hyphen us-west-1",
-			url:  "123456789012.dkr-ecr-fips.us-west-1.on.aws",
-			want: &Registry{
-				ID:     "123456789012",
-				FIPS:   true,
-				Region: "us-west-1",
-				Public: false,
-			},
-		},
-		{
-			name: "account-prefixed FIPS hyphen us-east-2",
-			url:  "123456789012.dkr-ecr-fips.us-east-2.on.aws",
-			want: &Registry{
-				ID:     "123456789012",
-				FIPS:   true,
-				Region: "us-east-2",
-				Public: false,
-			},
-		},
-
-		// AWS GovCloud
-		{
-			name: "account-prefixed FIPS us-gov-east-1",
-			url:  "123456789012.dkr.ecr-fips.us-gov-east-1.amazonaws.com",
-			want: &Registry{
-				ID:     "123456789012",
-				FIPS:   true,
-				Region: "us-gov-east-1",
-				Public: false,
-			},
-		},
-		{
-			name: "account-prefixed FIPS us-gov-west-1",
-			url:  "123456789012.dkr.ecr-fips.us-gov-west-1.amazonaws.com",
-			want: &Registry{
-				ID:     "123456789012",
-				FIPS:   true,
-				Region: "us-gov-west-1",
-				Public: false,
-			},
-		},
-		{
-			name: "accountless FIPS us-gov-west-1",
-			url:  "ecr-fips.us-gov-west-1.amazonaws.com",
-			want: &Registry{
-				ID:     "",
-				FIPS:   true,
-				Region: "us-gov-west-1",
-				Public: false,
-			},
-		},
-		{
-			name: "accountless FIPS API us-gov-east-1",
-			url:  "ecr-fips.us-gov-east-1.api.aws",
-			want: &Registry{
-				ID:     "",
-				FIPS:   true,
-				Region: "us-gov-east-1",
-				Public: false,
-			},
-		},
-
-		// ECR Public
-		{
-			name: "ecr-public",
-			url:  "ecr-public.aws.com",
-			want: &Registry{
-				ID:     "",
-				FIPS:   false,
-				Region: "",
-				Public: true,
-			},
-		},
-
-		// Non-FIPS endpoints (valid ECR but FIPS=false)
-		{
-			name: "account-prefixed non-FIPS us-east-1",
-			url:  "123456789012.dkr.ecr.us-east-1.amazonaws.com",
-			want: &Registry{
-				ID:     "123456789012",
-				FIPS:   false,
-				Region: "us-east-1",
-				Public: false,
-			},
-		},
-		{
-			name: "accountless non-FIPS us-west-1",
-			url:  "ecr.us-west-1.amazonaws.com",
-			want: &Registry{
-				ID:     "",
-				FIPS:   false,
-				Region: "us-west-1",
-				Public: false,
-			},
-		},
-		{
-			name: "accountless non-FIPS API us-east-2",
-			url:  "ecr.us-east-2.api.aws",
-			want: &Registry{
-				ID:     "",
-				FIPS:   false,
-				Region: "us-east-2",
-				Public: false,
-			},
-		},
-
-		// URLs with https:// prefix
-		{
-			name: "with https prefix",
-			url:  "https://ecr-fips.us-west-1.amazonaws.com",
-			want: &Registry{
-				ID:     "",
-				FIPS:   true,
-				Region: "us-west-1",
-				Public: false,
-			},
-		},
-
-		// Invalid endpoints
-		{
-			name:      "not an ECR URL",
-			url:       "not-an-ecr-url.com",
-			wantError: true,
-		},
-		{
-			name:      "invalid account ID length",
-			url:       "123.dkr.ecr-fips.us-east-1.amazonaws.com",
-			wantError: true,
-		},
-		{
-			name:      "empty string",
-			url:       "",
-			wantError: true,
-		},
-		{
-			name:      "docker hub",
-			url:       "docker.io",
-			wantError: true,
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got, err := ParseECREndpoint(tt.url)
-
-			if tt.wantError {
-				if err == nil {
-					t.Errorf("ParseECREndpoint() expected error but got none")
-				}
-				return
-			}
-
-			if err != nil {
-				t.Errorf("ParseECREndpoint() unexpected error: %v", err)
-				return
-			}
-
-			if got.ID != tt.want.ID {
-				t.Errorf("ParseECREndpoint() ID = %v, want %v", got.ID, tt.want.ID)
-			}
-			if got.FIPS != tt.want.FIPS {
-				t.Errorf("ParseECREndpoint() FIPS = %v, want %v", got.FIPS, tt.want.FIPS)
-			}
-			if got.Region != tt.want.Region {
-				t.Errorf("ParseECREndpoint() Region = %v, want %v", got.Region, tt.want.Region)
-			}
-			if got.Public != tt.want.Public {
-				t.Errorf("ParseECREndpoint() Public = %v, want %v", got.Public, tt.want.Public)
-			}
-		})
-	}
-}

api/backup/backup.go

@@ -1,110 +0,0 @@
-package backup
-
-import (
-	"fmt"
-	"os"
-	"path"
-	"path/filepath"
-	"time"
-
-	"github.com/portainer/portainer/api/archive"
-	"github.com/portainer/portainer/api/crypto"
-	"github.com/portainer/portainer/api/dataservices"
-	"github.com/portainer/portainer/api/filesystem"
-	"github.com/portainer/portainer/api/http/offlinegate"
-	"github.com/portainer/portainer/api/logs"
-
-	"github.com/pkg/errors"
-	"github.com/rs/zerolog/log"
-)
-
-const rwxr__r__ os.FileMode = 0o744
-
-var filesToBackup = []string{
-	"certs",
-	"chisel",
-	"compose",
-	"config.json",
-	"custom_templates",
-	"edge_jobs",
-	"edge_stacks",
-	"extensions",
-	"portainer.key",
-	"portainer.pub",
-	"tls",
-}
-
-// Creates a tar.gz system archive and encrypts it if password is not empty. Returns a path to the archive file.
-func CreateBackupArchive(password string, gate *offlinegate.OfflineGate, datastore dataservices.DataStore, filestorePath string) (string, error) {
-	backupDirPath, err := backupDatabaseAndFilesystem(gate, datastore, filestorePath)
-	if err != nil {
-		return "", err
-	}
-
-	archivePath, err := archive.TarGzDir(backupDirPath)
-	if err != nil {
-		return "", errors.Wrap(err, "Failed to make an archive")
-	}
-
-	if password != "" {
-		archivePath, err = encrypt(archivePath, password)
-		if err != nil {
-			return "", errors.Wrap(err, "Failed to encrypt backup with the password")
-		}
-	}
-
-	return archivePath, nil
-}
-
-func backupDatabaseAndFilesystem(gate *offlinegate.OfflineGate, datastore dataservices.DataStore, filestorePath string) (string, error) {
-	unlock := gate.Lock()
-	defer unlock()
-
-	backupDirPath := filepath.Join(filestorePath, "backup", time.Now().Format("2006-01-02_15-04-05"))
-	if err := os.MkdirAll(backupDirPath, rwxr__r__); err != nil {
-		return "", errors.Wrap(err, "Failed to create backup dir")
-	}
-
-	// new export
-	exportFilename := path.Join(backupDirPath, fmt.Sprintf("export-%d.json", time.Now().Unix()))
-
-	if err := datastore.Export(exportFilename); err != nil {
-		log.Error().Err(err).Str("filename", exportFilename).Msg("failed to export")
-	} else {
-		log.Debug().Str("filename", exportFilename).Msg("file exported")
-	}
-
-	if err := backupDb(backupDirPath, datastore); err != nil {
-		return "", errors.Wrap(err, "Failed to backup database")
-	}
-
-	for _, filename := range filesToBackup {
-		if err := filesystem.CopyPath(filepath.Join(filestorePath, filename), backupDirPath); err != nil {
-			return "", errors.Wrap(err, "Failed to create backup file")
-		}
-	}
-
-	return backupDirPath, nil
-}
-
-func backupDb(backupDirPath string, datastore dataservices.DataStore) error {
-	dbFileName := datastore.Connection().GetDatabaseFileName()
-	_, err := datastore.Backup(filepath.Join(backupDirPath, dbFileName))
-	return err
-}
-
-func encrypt(path string, passphrase string) (string, error) {
-	in, err := os.Open(path)
-	if err != nil {
-		return "", err
-	}
-	defer logs.CloseAndLogErr(in)
-
-	outFileName := path + ".encrypted"
-	out, err := os.Create(outFileName)
-	if err != nil {
-		return "", err
-	}
-
-	return outFileName, crypto.AesEncrypt(in, out, []byte(passphrase))
-}

api/backup/restore.go

@@ -1,121 +0,0 @@
-package backup
-
-import (
-	"context"
-	"io"
-	"io/fs"
-	"os"
-	"path/filepath"
-	"regexp"
-	"time"
-
-	"github.com/pkg/errors"
-	"github.com/portainer/portainer/api/archive"
-	"github.com/portainer/portainer/api/crypto"
-	"github.com/portainer/portainer/api/database/boltdb"
-	"github.com/portainer/portainer/api/dataservices"
-	"github.com/portainer/portainer/api/filesystem"
-	"github.com/portainer/portainer/api/http/offlinegate"
-
-	"github.com/rs/zerolog/log"
-)
-
-var filesToRestore = append(filesToBackup, "portainer.db")
-
-// Restores system state from backup archive, will trigger system shutdown, when finished.
-func RestoreArchive(archive io.Reader, password string, filestorePath string, gate *offlinegate.OfflineGate, datastore dataservices.DataStore, shutdownTrigger context.CancelFunc) error {
-	var err error
-	if password != "" {
-		archive, err = decrypt(archive, password)
-		if err != nil {
-			return errors.Wrap(err, "failed to decrypt the archive. Please ensure the password is correct and try again")
-		}
-	}
-
-	restorePath := filepath.Join(filestorePath, "restore", time.Now().Format("20060102150405"))
-	defer func() {
-		if err := os.RemoveAll(filepath.Dir(restorePath)); err != nil {
-			log.Warn().Err(err).Msg("failed to clean up restore files")
-		}
-	}()
-
-	if err := extractArchive(archive, restorePath); err != nil {
-		return errors.Wrap(err, "cannot extract files from the archive. Please ensure the password is correct and try again")
-	}
-
-	unlock := gate.Lock()
-	defer unlock()
-
-	if err := datastore.Close(); err != nil {
-		return errors.Wrap(err, "Failed to stop db")
-	}
-
-	// At some point, backups were created containing a subdirectory, now we need to handle both
-	restorePath, err = getRestoreSourcePath(restorePath)
-	if err != nil {
-		return errors.Wrap(err, "failed to restore from backup. Portainer database missing from backup file")
-	}
-
-	if err := restoreFiles(restorePath, filestorePath); err != nil {
-		return errors.Wrap(err, "failed to restore the system state")
-	}
-
-	shutdownTrigger()
-	return nil
-}
-
-func decrypt(r io.Reader, password string) (io.Reader, error) {
-	return crypto.AesDecrypt(r, []byte(password))
-}
-
-func extractArchive(r io.Reader, destinationDirPath string) error {
-	return archive.ExtractTarGz(r, destinationDirPath)
-}
-
-func getRestoreSourcePath(dir string) (string, error) {
-	// find portainer.db or portainer.edb file. Return the parent directory
-	var portainerdbRegex = regexp.MustCompile(`^portainer.e?db$`)
-
-	backupDirPath := dir
-	err := filepath.WalkDir(dir, func(path string, d fs.DirEntry, err error) error {
-		if err != nil {
-			return err
-		}
-
-		if portainerdbRegex.MatchString(d.Name()) {
-			backupDirPath = filepath.Dir(path)
-			return filepath.SkipDir
-		}
-		return nil
-	})
-
-	return backupDirPath, err
-}
-
-func restoreFiles(srcDir string, destinationDir string) error {
-	for _, filename := range filesToRestore {
-		if err := filesystem.CopyPath(filepath.Join(srcDir, filename), destinationDir); err != nil {
-			return err
-		}
-	}
-
-	// TODO:  This is very boltdb module specific once again due to the filename.  Move to bolt module? Refactor for another day
-
-	// Prevent the possibility of having both databases.  Remove any default new instance
-	if err := os.Remove(filepath.Join(destinationDir, boltdb.DatabaseFileName)); err != nil && !os.IsNotExist(err) {
-		return err
-	}
-
-	if err := os.Remove(filepath.Join(destinationDir, boltdb.EncryptedDatabaseFileName)); err != nil && !os.IsNotExist(err) {
-		return err
-	}
-
-	// Now copy the database.  It'll be either portainer.db or portainer.edb
-
-	// Note: CopyPath does not return an error if the source file doesn't exist
-	if err := filesystem.CopyPath(filepath.Join(srcDir, boltdb.EncryptedDatabaseFileName), destinationDir); err != nil {
-		return err
-	}
-
-	return filesystem.CopyPath(filepath.Join(srcDir, boltdb.DatabaseFileName), destinationDir)
-}

api/chisel/crypto/crypto.go

@@ -1,61 +0,0 @@
-package crypto
-
-import (
-	"crypto/ecdsa"
-	"crypto/elliptic"
-	"crypto/x509"
-	"encoding/pem"
-	"fmt"
-	"io"
-	"math/big"
-
-	chshare "github.com/jpillora/chisel/share"
-)
-
-var one = new(big.Int).SetInt64(1)
-
-// GenerateGo119CompatibleKey This function is basically copied from chshare.GenerateKey.
-func GenerateGo119CompatibleKey(seed string) ([]byte, error) {
-	r := chshare.NewDetermRand([]byte(seed))
-	priv, err := ecdsaGenerateKey(elliptic.P256(), r)
-	if err != nil {
-		return nil, err
-	}
-	b, err := x509.MarshalECPrivateKey(priv)
-	if err != nil {
-		return nil, fmt.Errorf("Unable to marshal ECDSA private key: %w", err)
-	}
-	return pem.EncodeToMemory(&pem.Block{Type: "EC PRIVATE KEY", Bytes: b}), nil
-}
-
-// This function is copied from Go1.19
-func randFieldElement(c elliptic.Curve, rand io.Reader) (k *big.Int, err error) {
-	params := c.Params()
-	// Note that for P-521 this will actually be 63 bits more than the order, as
-	// division rounds down, but the extra bit is inconsequential.
-	b := make([]byte, params.N.BitLen()/8+8)
-	_, err = io.ReadFull(rand, b)
-	if err != nil {
-		return
-	}
-
-	k = new(big.Int).SetBytes(b)
-	n := new(big.Int).Sub(params.N, one)
-	k.Mod(k, n)
-	k.Add(k, one)
-	return
-}
-
-// This function is copied from Go1.19
-func ecdsaGenerateKey(c elliptic.Curve, rand io.Reader) (*ecdsa.PrivateKey, error) {
-	k, err := randFieldElement(c, rand)
-	if err != nil {
-		return nil, err
-	}
-
-	priv := new(ecdsa.PrivateKey)
-	priv.Curve = c
-	priv.D = k
-	priv.X, priv.Y = c.ScalarBaseMult(k.Bytes())
-	return priv, nil
-}

api/chisel/crypto/crypto_test.go

@@ -1,37 +0,0 @@
-package crypto
-
-import (
-	"reflect"
-	"testing"
-)
-
-func TestGenerateGo119CompatibleKey(t *testing.T) {
-	type args struct {
-		seed string
-	}
-	tests := []struct {
-		name    string
-		args    args
-		want    []byte
-		wantErr bool
-	}{
-		{
-			name:    "Generate Go 1.19 compatible private key with a given seed",
-			args:    args{seed: "94qh17MCIk8BOkiI"},
-			want:    []byte("-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEIHeohwk0Gy3RHVVViaHz7pz/HOiqA7fkv1FTM3mGgfT3oAoGCCqGSM49\nAwEHoUQDQgAEN7riX06xDsLNPuUmOvYFluNEakcFwZZRVvOcIYk/9VYnanDzW0Km\n8/BUUiKyJDuuGdS4fj9SlQ4iL8yBK01uKg==\n-----END EC PRIVATE KEY-----\n"),
-			wantErr: false,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got, err := GenerateGo119CompatibleKey(tt.args.seed)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("GenerateGo119CompatibleKey() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-			if !reflect.DeepEqual(got, tt.want) {
-				t.Errorf("GenerateGo119CompatibleKey()\ngot: Z %v\nwant: %v", got, tt.want)
-			}
-		})
-	}
-}

api/chisel/key.go

@@ -1,24 +0,0 @@
-package chisel
-
-import (
-	"encoding/base64"
-	"fmt"
-	"strconv"
-	"strings"
-)
-
-// GenerateEdgeKey will generate a key that can be used by an Edge agent to register with a Portainer instance.
-// The key represents the following data in this particular format:
-// portainer_instance_url|tunnel_server_addr|tunnel_server_fingerprint|endpoint_ID
-// The key returned by this function is a base64 encoded version of the data.
-func (service *Service) GenerateEdgeKey(url, host string, endpointIdentifier int) string {
-	keyInformation := []string{
-		url,
-		fmt.Sprintf("%s:%s", host, service.serverPort),
-		service.serverFingerprint,
-		strconv.Itoa(endpointIdentifier),
-	}
-
-	key := strings.Join(keyInformation, "|")
-	return base64.RawStdEncoding.EncodeToString([]byte(key))
-}

api/chisel/service.go

@@ -1,305 +0,0 @@
-package chisel
-
-import (
-	"context"
-	"fmt"
-	"io"
-	"net/http"
-	"sync"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-	"github.com/portainer/portainer/api/http/proxy"
-
-	chserver "github.com/jpillora/chisel/server"
-	"github.com/jpillora/chisel/share/ccrypto"
-	"github.com/rs/zerolog/log"
-)
-
-const (
-	tunnelCleanupInterval = 10 * time.Second
-	activeTimeout         = 4*time.Minute + 30*time.Second
-	pingTimeout           = 3 * time.Second
-)
-
-// Service represents a service to manage the state of multiple reverse tunnels.
-// It is used to start a reverse tunnel server and to manage the connection status of each tunnel
-// connected to the tunnel server.
-type Service struct {
-	serverFingerprint      string
-	serverPort             string
-	activeTunnels          map[portainer.EndpointID]*portainer.TunnelDetails
-	edgeJobs               map[portainer.EndpointID][]portainer.EdgeJob
-	dataStore              dataservices.DataStore
-	snapshotService        portainer.SnapshotService
-	chiselServer           *chserver.Server
-	shutdownCtx            context.Context
-	ProxyManager           *proxy.Manager
-	mu                     sync.RWMutex
-	fileService            portainer.FileService
-	defaultCheckinInterval int
-}
-
-// NewService returns a pointer to a new instance of Service
-func NewService(dataStore dataservices.DataStore, shutdownCtx context.Context, fileService portainer.FileService) *Service {
-	defaultCheckinInterval := portainer.DefaultEdgeAgentCheckinIntervalInSeconds
-
-	settings, err := dataStore.Settings().Settings()
-	if err == nil {
-		defaultCheckinInterval = settings.EdgeAgentCheckinInterval
-	} else {
-		log.Error().Err(err).Msg("unable to retrieve the settings from the database")
-	}
-
-	return &Service{
-		activeTunnels:          make(map[portainer.EndpointID]*portainer.TunnelDetails),
-		edgeJobs:               make(map[portainer.EndpointID][]portainer.EdgeJob),
-		dataStore:              dataStore,
-		shutdownCtx:            shutdownCtx,
-		fileService:            fileService,
-		defaultCheckinInterval: defaultCheckinInterval,
-	}
-}
-
-// pingAgent ping the given agent so that the agent can keep the tunnel alive
-func (service *Service) pingAgent(endpointID portainer.EndpointID) error {
-	endpoint, err := service.dataStore.Endpoint().Endpoint(endpointID)
-	if err != nil {
-		return err
-	}
-
-	tunnelAddr, err := service.TunnelAddr(endpoint)
-	if err != nil {
-		return err
-	}
-
-	requestURL := fmt.Sprintf("http://%s/ping", tunnelAddr)
-	req, err := http.NewRequest(http.MethodHead, requestURL, nil)
-	if err != nil {
-		return err
-	}
-
-	httpClient := &http.Client{
-		Timeout: pingTimeout,
-	}
-
-	resp, err := httpClient.Do(req)
-	if err != nil {
-		return err
-	}
-
-	_, _ = io.Copy(io.Discard, resp.Body)
-	return resp.Body.Close()
-}
-
-// KeepTunnelAlive keeps the tunnel of the given environment for maxAlive duration, or until ctx is done
-func (service *Service) KeepTunnelAlive(endpointID portainer.EndpointID, ctx context.Context, maxAlive time.Duration) {
-	go service.keepTunnelAlive(endpointID, ctx, maxAlive)
-}
-
-func (service *Service) keepTunnelAlive(endpointID portainer.EndpointID, ctx context.Context, maxAlive time.Duration) {
-	log.Debug().
-		Int("endpoint_id", int(endpointID)).
-		Float64("max_alive_minutes", maxAlive.Minutes()).
-		Msg("KeepTunnelAlive: start")
-
-	maxAliveTicker := time.NewTicker(maxAlive)
-	defer maxAliveTicker.Stop()
-
-	pingTicker := time.NewTicker(tunnelCleanupInterval)
-	defer pingTicker.Stop()
-
-	for {
-		select {
-		case <-pingTicker.C:
-			service.UpdateLastActivity(endpointID)
-
-			if err := service.pingAgent(endpointID); err != nil {
-				log.Debug().
-					Int("endpoint_id", int(endpointID)).
-					Err(err).
-					Msg("KeepTunnelAlive: ping agent")
-			}
-		case <-maxAliveTicker.C:
-			log.Debug().
-				Int("endpoint_id", int(endpointID)).
-				Float64("timeout_minutes", maxAlive.Minutes()).
-				Msg("KeepTunnelAlive: tunnel keep alive timeout")
-
-			return
-		case <-ctx.Done():
-			err := ctx.Err()
-			log.Debug().
-				Int("endpoint_id", int(endpointID)).
-				Err(err).
-				Msg("KeepTunnelAlive: tunnel stop")
-
-			return
-		}
-	}
-}
-
-// StartTunnelServer starts a tunnel server on the specified addr and port.
-// It uses a seed to generate a new private/public key pair. If the seed cannot
-// be found inside the database, it will generate a new one randomly and persist it.
-// It starts the tunnel status verification process in the background.
-// The snapshotter is used in the tunnel status verification process.
-func (service *Service) StartTunnelServer(addr, port string, snapshotService portainer.SnapshotService) error {
-	privateKeyFile, err := service.retrievePrivateKeyFile()
-	if err != nil {
-		return err
-	}
-
-	config := &chserver.Config{
-		Reverse: true,
-		KeyFile: privateKeyFile,
-	}
-
-	chiselServer, err := chserver.NewServer(config)
-	if err != nil {
-		return err
-	}
-
-	service.serverFingerprint = chiselServer.GetFingerprint()
-	service.serverPort = port
-
-	if err := chiselServer.Start(addr, port); err != nil {
-		return err
-	}
-
-	service.chiselServer = chiselServer
-
-	// TODO: work-around Chisel default behavior.
-	// By default, Chisel will allow anyone to connect if no user exists.
-	username, password := generateRandomCredentials()
-	if err = service.chiselServer.AddUser(username, password, "127.0.0.1"); err != nil {
-		return err
-	}
-
-	service.snapshotService = snapshotService
-
-	go service.startTunnelVerificationLoop()
-
-	return nil
-}
-
-// StopTunnelServer stops tunnel http server
-func (service *Service) StopTunnelServer() error {
-	return service.chiselServer.Close()
-}
-
-func (service *Service) retrievePrivateKeyFile() (string, error) {
-	privateKeyFile := service.fileService.GetDefaultChiselPrivateKeyPath()
-
-	if exists, _ := service.fileService.FileExists(privateKeyFile); exists {
-		log.Info().
-			Str("private-key", privateKeyFile).
-			Msg("found Chisel private key file on disk")
-
-		return privateKeyFile, nil
-	}
-
-	log.Debug().
-		Str("private-key", privateKeyFile).
-		Msg("chisel private key file does not exist")
-
-	privateKey, err := ccrypto.GenerateKey("")
-	if err != nil {
-		log.Error().
-			Err(err).
-			Msg("failed to generate chisel private key")
-
-		return "", err
-	}
-
-	if err = service.fileService.StoreChiselPrivateKey(privateKey); err != nil {
-		log.Error().
-			Err(err).
-			Msg("failed to save Chisel private key to disk")
-
-		return "", err
-	}
-
-	log.Info().
-		Str("private-key", privateKeyFile).
-		Msg("generated a new Chisel private key file")
-
-	return privateKeyFile, nil
-}
-
-func (service *Service) startTunnelVerificationLoop() {
-	log.Debug().
-		Float64("check_interval_seconds", tunnelCleanupInterval.Seconds()).
-		Msg("starting tunnel management process")
-
-	ticker := time.NewTicker(tunnelCleanupInterval)
-
-	for {
-		select {
-		case <-ticker.C:
-			service.checkTunnels()
-		case <-service.shutdownCtx.Done():
-			log.Debug().Msg("shutting down tunnel service")
-
-			if err := service.StopTunnelServer(); err != nil {
-				log.Debug().Err(err).Msg("stopped tunnel service")
-			}
-
-			ticker.Stop()
-			return
-		}
-	}
-}
-
-// checkTunnels finds the first tunnel that has not had any activity recently
-// and attempts to take a snapshot, then closes it and returns
-func (service *Service) checkTunnels() {
-	service.mu.RLock()
-
-	for endpointID, tunnel := range service.activeTunnels {
-		elapsed := time.Since(tunnel.LastActivity)
-		log.Debug().
-			Int("endpoint_id", int(endpointID)).
-			Float64("last_activity_seconds", elapsed.Seconds()).
-			Msg("environment tunnel monitoring")
-
-		if tunnel.Status == portainer.EdgeAgentManagementRequired && elapsed < activeTimeout {
-			continue
-		}
-
-		tunnelPort := tunnel.Port
-
-		service.mu.RUnlock()
-
-		log.Debug().
-			Int("endpoint_id", int(endpointID)).
-			Float64("last_activity_seconds", elapsed.Seconds()).
-			Float64("timeout_seconds", activeTimeout.Seconds()).
-			Msg("last activity timeout exceeded")
-
-		if err := service.snapshotEnvironment(endpointID, tunnelPort); err != nil {
-			log.Error().
-				Int("endpoint_id", int(endpointID)).
-				Err(err).
-				Msg("unable to snapshot Edge environment")
-		}
-
-		service.close(endpointID)
-
-		return
-	}
-
-	service.mu.RUnlock()
-}
-
-func (service *Service) snapshotEnvironment(endpointID portainer.EndpointID, tunnelPort int) error {
-	endpoint, err := service.dataStore.Endpoint().Endpoint(endpointID)
-	if err != nil {
-		return err
-	}
-
-	endpoint.URL = fmt.Sprintf("tcp://127.0.0.1:%d", tunnelPort)
-
-	return service.snapshotService.SnapshotEndpoint(endpoint)
-}

api/chisel/service_test.go

@@ -1,59 +0,0 @@
-package chisel
-
-import (
-	"context"
-	"net"
-	"net/http"
-	"testing"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/datastore"
-	"github.com/portainer/portainer/pkg/fips"
-
-	"github.com/stretchr/testify/require"
-)
-
-func init() {
-	fips.InitFIPS(false)
-}
-
-func TestPingAgentPanic(t *testing.T) {
-	endpoint := &portainer.Endpoint{
-		ID:          1,
-		EdgeID:      "test-edge-id",
-		Type:        portainer.EdgeAgentOnDockerEnvironment,
-		UserTrusted: true,
-	}
-
-	_, store := datastore.MustNewTestStore(t, true, true)
-
-	s := NewService(store, nil, nil)
-
-	defer func() {
-		require.Nil(t, recover())
-	}()
-
-	mux := http.NewServeMux()
-	mux.HandleFunc("/ping", func(w http.ResponseWriter, r *http.Request) {
-		time.Sleep(pingTimeout + 1*time.Second)
-	})
-
-	ln, err := net.ListenTCP("tcp", &net.TCPAddr{IP: net.IPv4(127, 0, 0, 1), Port: 0})
-	require.NoError(t, err)
-
-	srv := &http.Server{Handler: mux}
-
-	errCh := make(chan error)
-	go func() {
-		errCh <- srv.Serve(ln)
-	}()
-
-	err = s.Open(endpoint)
-	require.NoError(t, err)
-	s.activeTunnels[endpoint.ID].Port = ln.Addr().(*net.TCPAddr).Port
-
-	require.Error(t, s.pingAgent(endpoint.ID))
-	require.NoError(t, srv.Shutdown(context.Background()))
-	require.ErrorIs(t, <-errCh, http.ErrServerClosed)
-}

api/chisel/tunnel.go

@@ -1,239 +0,0 @@
-package chisel
-
-import (
-	"encoding/base64"
-	"errors"
-	"fmt"
-	"net"
-	"strings"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/internal/edge"
-	"github.com/portainer/portainer/api/internal/edge/cache"
-	"github.com/portainer/portainer/api/internal/endpointutils"
-	"github.com/portainer/portainer/pkg/libcrypto"
-	"github.com/portainer/portainer/pkg/librand"
-
-	"github.com/dchest/uniuri"
-	"github.com/rs/zerolog/log"
-)
-
-const (
-	minAvailablePort = 49152
-	maxAvailablePort = 65535
-)
-
-var (
-	ErrNonEdgeEnv = errors.New("cannot open a tunnel for non-edge environments")
-	ErrAsyncEnv   = errors.New("cannot open a tunnel for async edge environments")
-	ErrInvalidEnv = errors.New("cannot open a tunnel for an invalid environment")
-)
-
-// Open will mark the tunnel as REQUIRED so the agent opens it
-func (s *Service) Open(endpoint *portainer.Endpoint) error {
-	if !endpointutils.IsEdgeEndpoint(endpoint) {
-		return ErrNonEdgeEnv
-	}
-
-	if endpoint.Edge.AsyncMode {
-		return ErrAsyncEnv
-	}
-
-	if endpoint.ID == 0 || endpoint.EdgeID == "" || !endpoint.UserTrusted {
-		return ErrInvalidEnv
-	}
-
-	s.mu.Lock()
-	defer s.mu.Unlock()
-
-	if _, ok := s.activeTunnels[endpoint.ID]; ok {
-		return nil
-	}
-
-	defer cache.Del(endpoint.ID)
-
-	tun := &portainer.TunnelDetails{
-		Status:       portainer.EdgeAgentManagementRequired,
-		Port:         s.getUnusedPort(),
-		LastActivity: time.Now(),
-	}
-
-	username, password := generateRandomCredentials()
-
-	if s.chiselServer != nil {
-		authorizedRemote := fmt.Sprintf("^R:0.0.0.0:%d$", tun.Port)
-
-		if err := s.chiselServer.AddUser(username, password, authorizedRemote); err != nil {
-			return err
-		}
-	}
-
-	credentials, err := encryptCredentials(username, password, endpoint.EdgeID)
-	if err != nil {
-		return err
-	}
-
-	tun.Credentials = credentials
-
-	s.activeTunnels[endpoint.ID] = tun
-
-	return nil
-}
-
-// close removes the tunnel from the map so the agent will close it
-func (s *Service) close(endpointID portainer.EndpointID) {
-	s.mu.Lock()
-	defer s.mu.Unlock()
-
-	tun, ok := s.activeTunnels[endpointID]
-	if !ok {
-		return
-	}
-
-	if len(tun.Credentials) > 0 && s.chiselServer != nil {
-		user, _, _ := strings.Cut(tun.Credentials, ":")
-		s.chiselServer.DeleteUser(user)
-	}
-
-	if s.ProxyManager != nil {
-		s.ProxyManager.DeleteEndpointProxy(endpointID)
-	}
-
-	delete(s.activeTunnels, endpointID)
-
-	cache.Del(endpointID)
-}
-
-// Config returns the tunnel details needed for the agent to connect
-func (s *Service) Config(endpointID portainer.EndpointID) portainer.TunnelDetails {
-	s.mu.RLock()
-	defer s.mu.RUnlock()
-
-	if tun, ok := s.activeTunnels[endpointID]; ok {
-		return *tun
-	}
-
-	return portainer.TunnelDetails{Status: portainer.EdgeAgentIdle}
-}
-
-// TunnelAddr returns the address of the local tunnel, including the port, it
-// will block until the tunnel is ready
-func (s *Service) TunnelAddr(endpoint *portainer.Endpoint) (string, error) {
-	if err := s.Open(endpoint); err != nil {
-		return "", err
-	}
-
-	tun := s.Config(endpoint.ID)
-	checkinInterval := time.Duration(s.tryEffectiveCheckinInterval(endpoint)) * time.Second
-
-	for t0 := time.Now(); ; {
-		if time.Since(t0) > 2*checkinInterval {
-			s.close(endpoint.ID)
-
-			return "", errors.New("unable to open the tunnel")
-		}
-
-		// Check if the tunnel is established
-		conn, err := net.DialTCP("tcp", nil, &net.TCPAddr{IP: net.IPv4(127, 0, 0, 1), Port: tun.Port})
-		if err != nil {
-			time.Sleep(checkinInterval / 100)
-
-			continue
-		}
-
-		if err := conn.Close(); err != nil {
-			log.Warn().Err(err).Msg("failed to close tcp connection")
-		}
-
-		break
-	}
-
-	s.UpdateLastActivity(endpoint.ID)
-
-	return fmt.Sprintf("127.0.0.1:%d", tun.Port), nil
-}
-
-// tryEffectiveCheckinInterval avoids a potential deadlock by returning a
-// previous known value after a timeout
-func (s *Service) tryEffectiveCheckinInterval(endpoint *portainer.Endpoint) int {
-	ch := make(chan int, 1)
-
-	go func() {
-		ch <- edge.EffectiveCheckinInterval(s.dataStore, endpoint)
-	}()
-
-	select {
-	case <-time.After(50 * time.Millisecond):
-		s.mu.RLock()
-		defer s.mu.RUnlock()
-
-		return s.defaultCheckinInterval
-	case i := <-ch:
-		s.mu.Lock()
-		s.defaultCheckinInterval = i
-		s.mu.Unlock()
-
-		return i
-	}
-}
-
-// UpdateLastActivity sets the current timestamp to avoid the tunnel timeout
-func (s *Service) UpdateLastActivity(endpointID portainer.EndpointID) {
-	s.mu.Lock()
-	defer s.mu.Unlock()
-
-	if tun, ok := s.activeTunnels[endpointID]; ok {
-		tun.LastActivity = time.Now()
-	}
-}
-
-// NOTE: it needs to be called with the lock acquired
-// getUnusedPort is used to generate an unused random port in the dynamic port range.
-// Dynamic ports (also called private ports) are 49152 to 65535.
-func (service *Service) getUnusedPort() int {
-	port := randomInt(minAvailablePort, maxAvailablePort)
-
-	for _, tunnel := range service.activeTunnels {
-		if tunnel.Port == port {
-			return service.getUnusedPort()
-		}
-	}
-
-	conn, err := net.DialTCP("tcp", nil, &net.TCPAddr{IP: net.IPv4(127, 0, 0, 1), Port: port})
-	if err == nil {
-		if err := conn.Close(); err != nil {
-			log.Warn().Msg("failed to close tcp connection that checks if port is free")
-		}
-
-		log.Debug().
-			Int("port", port).
-			Msg("selected port is in use, trying a different one")
-
-		return service.getUnusedPort()
-	}
-
-	return port
-}
-
-func randomInt(min, max int) int {
-	return min + librand.Intn(max-min)
-}
-
-func generateRandomCredentials() (string, string) {
-	username := uniuri.NewLen(8)
-	password := uniuri.NewLen(8)
-
-	return username, password
-}
-
-func encryptCredentials(username, password, key string) (string, error) {
-	credentials := fmt.Sprintf("%s:%s", username, password)
-
-	encryptedCredentials, err := libcrypto.Encrypt([]byte(credentials), []byte(key))
-	if err != nil {
-		return "", err
-	}
-
-	return base64.RawStdEncoding.EncodeToString(encryptedCredentials), nil
-}

api/chisel/tunnel_test.go

@@ -1,79 +0,0 @@
-package chisel
-
-import (
-	"net"
-	"strings"
-	"testing"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-)
-
-type testSettingsService struct {
-	dataservices.SettingsService
-}
-
-func (s *testSettingsService) Settings() (*portainer.Settings, error) {
-	return &portainer.Settings{
-		EdgeAgentCheckinInterval: 1,
-	}, nil
-}
-
-type testStore struct {
-	dataservices.DataStore
-}
-
-func (s *testStore) Settings() dataservices.SettingsService {
-	return &testSettingsService{}
-}
-
-func TestGetUnusedPort(t *testing.T) {
-	testCases := []struct {
-		name            string
-		existingTunnels map[portainer.EndpointID]*portainer.TunnelDetails
-		expectedError   error
-	}{
-		{
-			name: "simple case",
-		},
-		{
-			name: "existing tunnels",
-			existingTunnels: map[portainer.EndpointID]*portainer.TunnelDetails{
-				portainer.EndpointID(1): {
-					Port: 53072,
-				},
-				portainer.EndpointID(2): {
-					Port: 63072,
-				},
-			},
-		},
-	}
-
-	for _, tc := range testCases {
-		t.Run(tc.name, func(t *testing.T) {
-			store := &testStore{}
-			s := NewService(store, nil, nil)
-			s.activeTunnels = tc.existingTunnels
-			port := s.getUnusedPort()
-
-			if port < 49152 || port > 65535 {
-				t.Fatalf("Expected port to be inbetween 49152 and 65535 but got %d", port)
-			}
-
-			for _, tun := range tc.existingTunnels {
-				if tun.Port == port {
-					t.Fatalf("returned port %d already has an existing tunnel", port)
-				}
-			}
-
-			conn, err := net.DialTCP("tcp", nil, &net.TCPAddr{IP: net.IPv4(127, 0, 0, 1), Port: port})
-			if err == nil {
-				// Ignore error
-				_ = conn.Close()
-				t.Fatalf("expected port %d to be unused", port)
-			} else if !strings.Contains(err.Error(), "connection refused") {
-				t.Fatalf("unexpected error: %v", err)
-			}
-		})
-	}
-}

api/cli/cli.go

@@ -1,211 +0,0 @@
-package cli
-
-import (
-	"errors"
-	"os"
-	"path/filepath"
-	"strings"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-
-	"github.com/alecthomas/kingpin/v2"
-	"github.com/rs/zerolog/log"
-)
-
-// Service implements the CLIService interface
-type Service struct{}
-
-var (
-	ErrInvalidEndpointProtocol       = errors.New("Invalid environment protocol: Portainer only supports unix://, npipe:// or tcp://")
-	ErrSocketOrNamedPipeNotFound     = errors.New("Unable to locate Unix socket or named pipe")
-	ErrInvalidSnapshotInterval       = errors.New("Invalid snapshot interval")
-	ErrAdminPassExcludeAdminPassFile = errors.New("Cannot use --admin-password with --admin-password-file")
-)
-
-func CLIFlags() *portainer.CLIFlags {
-	return &portainer.CLIFlags{
-		Addr:                      kingpin.Flag("bind", "Address and port to serve Portainer").Default(defaultBindAddress).Short('p').String(),
-		AddrHTTPS:                 kingpin.Flag("bind-https", "Address and port to serve Portainer via https").Default(defaultHTTPSBindAddress).String(),
-		TunnelAddr:                kingpin.Flag("tunnel-addr", "Address to serve the tunnel server").Default(defaultTunnelServerAddress).String(),
-		TunnelPort:                kingpin.Flag("tunnel-port", "Port to serve the tunnel server").Default(defaultTunnelServerPort).String(),
-		Assets:                    kingpin.Flag("assets", "Path to the assets").Default(defaultAssetsDirectory).Short('a').String(),
-		Data:                      kingpin.Flag("data", "Path to the folder where the data is stored").Default(defaultDataDirectory).Short('d').String(),
-		EndpointURL:               kingpin.Flag("host", "Environment URL").Short('H').String(),
-		FeatureFlags:              kingpin.Flag("feat", "List of feature flags").Envar(portainer.FeatureFlagEnvVar).Strings(),
-		EnableEdgeComputeFeatures: kingpin.Flag("edge-compute", "Enable Edge Compute features").Bool(),
-		NoAnalytics:               kingpin.Flag("no-analytics", "Disable Analytics in app (deprecated)").Bool(),
-		TLSSkipVerify:             kingpin.Flag("tlsskipverify", "Disable TLS server verification").Default(defaultTLSSkipVerify).Bool(),
-		HTTPDisabled:              kingpin.Flag("http-disabled", "Serve portainer only on https").Default(defaultHTTPDisabled).Bool(),
-		HTTPEnabled:               kingpin.Flag("http-enabled", "Serve portainer on http").Default(defaultHTTPEnabled).Bool(),
-		Rollback:                  kingpin.Flag("rollback", "Rollback the database to the previous backup").Bool(),
-		SnapshotInterval:          kingpin.Flag("snapshot-interval", "Duration between each environment snapshot job").String(),
-		AdminPassword:             kingpin.Flag("admin-password", "Set admin password with provided hash").String(),
-		AdminPasswordFile:         kingpin.Flag("admin-password-file", "Path to the file containing the password for the admin user").String(),
-		Labels:                    pairs(kingpin.Flag("hide-label", "Hide containers with a specific label in the UI").Short('l')),
-		Logo:                      kingpin.Flag("logo", "URL for the logo displayed in the UI").String(),
-		Templates:                 kingpin.Flag("templates", "URL to the templates definitions.").Short('t').String(),
-		BaseURL:                   kingpin.Flag("base-url", "Base URL parameter such as portainer if running portainer as http://yourdomain.com/portainer/.").Short('b').Default(defaultBaseURL).String(),
-		InitialMmapSize:           kingpin.Flag("initial-mmap-size", "Initial mmap size of the database in bytes").Int(),
-		MaxBatchSize:              kingpin.Flag("max-batch-size", "Maximum size of a batch").Int(),
-		MaxBatchDelay:             kingpin.Flag("max-batch-delay", "Maximum delay before a batch starts").Duration(),
-		SecretKeyName:             kingpin.Flag("secret-key-name", "Secret key name for encryption and will be used as /run/secrets/<secret-key-name>.").Default(defaultSecretKeyName).String(),
-		LogLevel:                  kingpin.Flag("log-level", "Set the minimum logging level to show").Default("INFO").Enum("DEBUG", "INFO", "WARN", "ERROR"),
-		LogMode:                   kingpin.Flag("log-mode", "Set the logging output mode").Default("PRETTY").Enum("NOCOLOR", "PRETTY", "JSON"),
-		PullLimitCheckDisabled:    kingpin.Flag("pull-limit-check-disabled", "Pull limit check").Envar(portainer.PullLimitCheckDisabledEnvVar).Default(defaultPullLimitCheckDisabled).Bool(),
-		TrustedOrigins:            kingpin.Flag("trusted-origins", "List of trusted origins for CSRF protection. Separate multiple origins with a comma.").Envar(portainer.TrustedOriginsEnvVar).String(),
-		CSP:                       kingpin.Flag("csp", "Content Security Policy (CSP) header").Envar(portainer.CSPEnvVar).Default("true").Bool(),
-		CompactDB:                 kingpin.Flag("compact-db", "Enable database compaction on startup").Envar(portainer.CompactDBEnvVar).Default("false").Bool(),
-	}
-}
-
-// ParseFlags parse the CLI flags and return a portainer.Flags struct
-func (Service) ParseFlags(version string) (*portainer.CLIFlags, error) {
-	kingpin.Version(version)
-
-	var hasSSLFlag, hasSSLCertFlag, hasSSLKeyFlag bool
-	sslFlag := kingpin.Flag(
-		"ssl",
-		"Secure Portainer instance using SSL (deprecated)",
-	).Default(defaultSSL).IsSetByUser(&hasSSLFlag)
-	ssl := sslFlag.Bool()
-	sslCertFlag := kingpin.Flag(
-		"sslcert",
-		"Path to the SSL certificate used to secure the Portainer instance",
-	).IsSetByUser(&hasSSLCertFlag)
-	sslCert := sslCertFlag.String()
-	sslKeyFlag := kingpin.Flag(
-		"sslkey",
-		"Path to the SSL key used to secure the Portainer instance",
-	).IsSetByUser(&hasSSLKeyFlag)
-	sslKey := sslKeyFlag.String()
-
-	flags := CLIFlags()
-
-	var hasTLSFlag, hasTLSCertFlag, hasTLSKeyFlag bool
-	tlsFlag := kingpin.Flag("tlsverify", "TLS support").Default(defaultTLS).IsSetByUser(&hasTLSFlag)
-	flags.TLS = tlsFlag.Bool()
-	tlsCertFlag := kingpin.Flag(
-		"tlscert",
-		"Path to the TLS certificate file",
-	).Default(defaultTLSCertPath).IsSetByUser(&hasTLSCertFlag)
-	flags.TLSCert = tlsCertFlag.String()
-	tlsKeyFlag := kingpin.Flag("tlskey", "Path to the TLS key").Default(defaultTLSKeyPath).IsSetByUser(&hasTLSKeyFlag)
-	flags.TLSKey = tlsKeyFlag.String()
-	flags.TLSCacert = kingpin.Flag("tlscacert", "Path to the CA").Default(defaultTLSCACertPath).String()
-
-	flags.KubectlShellImage = kingpin.Flag(
-		"kubectl-shell-image",
-		"Kubectl shell image",
-	).Envar(portainer.KubectlShellImageEnvVar).Default(portainer.DefaultKubectlShellImage).String()
-
-	kingpin.Parse()
-
-	if !filepath.IsAbs(*flags.Assets) {
-		ex, err := os.Executable()
-		if err != nil {
-			panic(err)
-		}
-
-		*flags.Assets = filepath.Join(filepath.Dir(ex), *flags.Assets)
-	}
-
-	// If the user didn't provide a tls flag remove the defaults to match previous behaviour
-	if !hasTLSFlag {
-		if !hasTLSCertFlag {
-			*flags.TLSCert = ""
-		}
-
-		if !hasTLSKeyFlag {
-			*flags.TLSKey = ""
-		}
-	}
-
-	if hasSSLFlag {
-		log.Warn().Msgf("the %q flag is deprecated. use %q instead.", sslFlag.Model().Name, tlsFlag.Model().Name)
-
-		if !hasTLSFlag {
-			flags.TLS = ssl
-		}
-	}
-
-	if hasSSLCertFlag {
-		log.Warn().Msgf("the %q flag is deprecated. use %q instead.", sslCertFlag.Model().Name, tlsCertFlag.Model().Name)
-
-		if !hasTLSCertFlag {
-			flags.TLSCert = sslCert
-		}
-	}
-
-	if hasSSLKeyFlag {
-		log.Warn().Msgf("the %q flag is deprecated. use %q instead.", sslKeyFlag.Model().Name, tlsKeyFlag.Model().Name)
-
-		if !hasTLSKeyFlag {
-			flags.TLSKey = sslKey
-		}
-	}
-
-	return flags, nil
-}
-
-// ValidateFlags validates the values of the flags.
-func (Service) ValidateFlags(flags *portainer.CLIFlags) error {
-	displayDeprecationWarnings(flags)
-
-	if err := validateEndpointURL(*flags.EndpointURL); err != nil {
-		return err
-	}
-
-	if err := validateSnapshotInterval(*flags.SnapshotInterval); err != nil {
-		return err
-	}
-
-	if *flags.AdminPassword != "" && *flags.AdminPasswordFile != "" {
-		return ErrAdminPassExcludeAdminPassFile
-	}
-
-	return nil
-}
-
-func displayDeprecationWarnings(flags *portainer.CLIFlags) {
-	if *flags.NoAnalytics {
-		log.Warn().Msg("the --no-analytics flag has been kept to allow migration of instances running a previous version of Portainer with this flag enabled, to version 2.0 where enabling this flag will have no effect")
-	}
-}
-
-func validateEndpointURL(endpointURL string) error {
-	if endpointURL == "" {
-		return nil
-	}
-
-	if !strings.HasPrefix(endpointURL, "unix://") && !strings.HasPrefix(endpointURL, "tcp://") && !strings.HasPrefix(endpointURL, "npipe://") {
-		return ErrInvalidEndpointProtocol
-	}
-
-	if strings.HasPrefix(endpointURL, "unix://") || strings.HasPrefix(endpointURL, "npipe://") {
-		socketPath := strings.TrimPrefix(endpointURL, "unix://")
-		socketPath = strings.TrimPrefix(socketPath, "npipe://")
-
-		if _, err := os.Stat(socketPath); err != nil {
-			if os.IsNotExist(err) {
-				return ErrSocketOrNamedPipeNotFound
-			}
-
-			return err
-		}
-	}
-
-	return nil
-}
-
-func validateSnapshotInterval(snapshotInterval string) error {
-	if snapshotInterval == "" {
-		return nil
-	}
-
-	if _, err := time.ParseDuration(snapshotInterval); err != nil {
-		return ErrInvalidSnapshotInterval
-	}
-
-	return nil
-}

api/cli/cli_test.go

@@ -1,209 +0,0 @@
-package cli
-
-import (
-	"io"
-	"os"
-	"strings"
-	"testing"
-
-	zerolog "github.com/rs/zerolog/log"
-	"github.com/stretchr/testify/require"
-)
-
-func TestOptionParser(t *testing.T) {
-	p := Service{}
-	require.NotNil(t, p)
-
-	a := os.Args
-	defer func() { os.Args = a }()
-
-	os.Args = []string{"portainer", "--edge-compute"}
-
-	opts, err := p.ParseFlags("2.34.5")
-	require.NoError(t, err)
-
-	require.False(t, *opts.HTTPDisabled)
-	require.True(t, *opts.EnableEdgeComputeFeatures)
-}
-
-func TestParseTLSFlags(t *testing.T) {
-	testCases := []struct {
-		name                string
-		args                []string
-		expectedTLSFlag     bool
-		expectedTLSCertFlag string
-		expectedTLSKeyFlag  string
-		expectedLogMessages []string
-	}{
-		{
-			name:                "no flags",
-			expectedTLSFlag:     false,
-			expectedTLSCertFlag: "",
-			expectedTLSKeyFlag:  "",
-		},
-		{
-			name: "only ssl flag",
-			args: []string{
-				"portainer",
-				"--ssl",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "",
-			expectedTLSKeyFlag:  "",
-		},
-		{
-			name: "only tls flag",
-			args: []string{
-				"portainer",
-				"--tlsverify",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: defaultTLSCertPath,
-			expectedTLSKeyFlag:  defaultTLSKeyPath,
-		},
-		{
-			name: "partial ssl flags",
-			args: []string{
-				"portainer",
-				"--ssl",
-				"--sslcert=ssl-cert-flag-value",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "ssl-cert-flag-value",
-			expectedTLSKeyFlag:  "",
-		},
-		{
-			name: "partial tls flags",
-			args: []string{
-				"portainer",
-				"--tlsverify",
-				"--tlscert=tls-cert-flag-value",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "tls-cert-flag-value",
-			expectedTLSKeyFlag:  defaultTLSKeyPath,
-		},
-		{
-			name: "partial tls and ssl flags",
-			args: []string{
-				"portainer",
-				"--tlsverify",
-				"--tlscert=tls-cert-flag-value",
-				"--sslkey=ssl-key-flag-value",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "tls-cert-flag-value",
-			expectedTLSKeyFlag:  "ssl-key-flag-value",
-		},
-		{
-			name: "partial tls and ssl flags 2",
-			args: []string{
-				"portainer",
-				"--ssl",
-				"--tlscert=tls-cert-flag-value",
-				"--sslkey=ssl-key-flag-value",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "tls-cert-flag-value",
-			expectedTLSKeyFlag:  "ssl-key-flag-value",
-		},
-		{
-			name: "ssl flags",
-			args: []string{
-				"portainer",
-				"--ssl",
-				"--sslcert=ssl-cert-flag-value",
-				"--sslkey=ssl-key-flag-value",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "ssl-cert-flag-value",
-			expectedTLSKeyFlag:  "ssl-key-flag-value",
-			expectedLogMessages: []string{
-				"the \\\"ssl\\\" flag is deprecated. use \\\"tlsverify\\\" instead.",
-				"the \\\"sslcert\\\" flag is deprecated. use \\\"tlscert\\\" instead.",
-				"the \\\"sslkey\\\" flag is deprecated. use \\\"tlskey\\\" instead.",
-			},
-		},
-		{
-			name: "tls flags",
-			args: []string{
-				"portainer",
-				"--tlsverify",
-				"--tlscert=tls-cert-flag-value",
-				"--tlskey=tls-key-flag-value",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "tls-cert-flag-value",
-			expectedTLSKeyFlag:  "tls-key-flag-value",
-		},
-		{
-			name: "tls and ssl flags",
-			args: []string{
-				"portainer",
-				"--tlsverify",
-				"--tlscert=tls-cert-flag-value",
-				"--tlskey=tls-key-flag-value",
-				"--ssl",
-				"--sslcert=ssl-cert-flag-value",
-				"--sslkey=ssl-key-flag-value",
-			},
-			expectedTLSFlag:     true,
-			expectedTLSCertFlag: "tls-cert-flag-value",
-			expectedTLSKeyFlag:  "tls-key-flag-value",
-			expectedLogMessages: []string{
-				"the \\\"ssl\\\" flag is deprecated. use \\\"tlsverify\\\" instead.",
-				"the \\\"sslcert\\\" flag is deprecated. use \\\"tlscert\\\" instead.",
-				"the \\\"sslkey\\\" flag is deprecated. use \\\"tlskey\\\" instead.",
-			},
-		},
-	}
-
-	for _, tc := range testCases {
-		t.Run(tc.name, func(t *testing.T) {
-			var logOutput strings.Builder
-			setupLogOutput(t, &logOutput)
-
-			if tc.args == nil {
-				tc.args = []string{"portainer"}
-			}
-			setOsArgs(t, tc.args)
-
-			s := Service{}
-			flags, err := s.ParseFlags("test-version")
-			if err != nil {
-				t.Fatalf("error parsing flags: %v", err)
-			}
-
-			if flags.TLS == nil {
-				t.Fatal("TLS flag was nil")
-			}
-
-			require.Equal(t, tc.expectedTLSFlag, *flags.TLS, "tlsverify flag didn't match")
-			require.Equal(t, tc.expectedTLSCertFlag, *flags.TLSCert, "tlscert flag didn't match")
-			require.Equal(t, tc.expectedTLSKeyFlag, *flags.TLSKey, "tlskey flag didn't match")
-
-			for _, expectedLogMessage := range tc.expectedLogMessages {
-				require.Contains(t, logOutput.String(), expectedLogMessage, "Log didn't contain expected message")
-			}
-		})
-	}
-}
-
-func setOsArgs(t *testing.T, args []string) {
-	t.Helper()
-	previousArgs := os.Args
-	os.Args = args
-	t.Cleanup(func() {
-		os.Args = previousArgs
-	})
-}
-
-func setupLogOutput(t *testing.T, w io.Writer) {
-	t.Helper()
-
-	oldLogger := zerolog.Logger
-	zerolog.Logger = zerolog.Output(w)
-	t.Cleanup(func() {
-		zerolog.Logger = oldLogger
-	})
-}

api/cli/confirm.go

@@ -1,23 +0,0 @@
-package cli
-
-import (
-	"bufio"
-	"fmt"
-	"os"
-	"strings"
-)
-
-// Confirm starts a rollback db cli application
-func Confirm(message string) (bool, error) {
-	fmt.Printf("%s [y/N] ", message)
-
-	reader := bufio.NewReader(os.Stdin)
-
-	answer, err := reader.ReadString('\n')
-	if err != nil {
-		return false, err
-	}
-
-	answer = strings.ReplaceAll(answer, "\n", "")
-	return strings.EqualFold(answer, "y") || strings.EqualFold(answer, "yes"), nil
-}

api/cli/defaults.go

@@ -1,23 +0,0 @@
-//go:build !windows
-
-package cli
-
-const (
-	defaultBindAddress            = ":9000"
-	defaultHTTPSBindAddress       = ":9443"
-	defaultTunnelServerAddress    = "0.0.0.0"
-	defaultTunnelServerPort       = "8000"
-	defaultDataDirectory          = "/data"
-	defaultAssetsDirectory        = "./"
-	defaultTLS                    = "false"
-	defaultTLSSkipVerify          = "false"
-	defaultTLSCACertPath          = "/certs/ca.pem"
-	defaultTLSCertPath            = "/certs/cert.pem"
-	defaultTLSKeyPath             = "/certs/key.pem"
-	defaultHTTPDisabled           = "false"
-	defaultHTTPEnabled            = "false"
-	defaultSSL                    = "false"
-	defaultBaseURL                = "/"
-	defaultSecretKeyName          = "portainer"
-	defaultPullLimitCheckDisabled = "false"
-)

api/cli/defaults_windows.go

@@ -1,22 +0,0 @@
-package cli
-
-const (
-	defaultBindAddress            = ":9000"
-	defaultHTTPSBindAddress       = ":9443"
-	defaultTunnelServerAddress    = "0.0.0.0"
-	defaultTunnelServerPort       = "8000"
-	defaultDataDirectory          = "C:\\data"
-	defaultAssetsDirectory        = "./"
-	defaultTLS                    = "false"
-	defaultTLSSkipVerify          = "false"
-	defaultTLSCACertPath          = "C:\\certs\\ca.pem"
-	defaultTLSCertPath            = "C:\\certs\\cert.pem"
-	defaultTLSKeyPath             = "C:\\certs\\key.pem"
-	defaultHTTPDisabled           = "false"
-	defaultHTTPEnabled            = "false"
-	defaultSSL                    = "false"
-	defaultSnapshotInterval       = "5m"
-	defaultBaseURL                = "/"
-	defaultSecretKeyName          = "portainer"
-	defaultPullLimitCheckDisabled = "false"
-)

api/cli/pairlist.go

@@ -1,41 +0,0 @@
-package cli
-
-import (
-	portainer "github.com/portainer/portainer/api"
-
-	"fmt"
-	"strings"
-
-	"github.com/alecthomas/kingpin/v2"
-)
-
-type pairList []portainer.Pair
-
-// Set implementation for a list of portainer.Pair
-func (l *pairList) Set(value string) error {
-	parts := strings.SplitN(value, "=", 2)
-	if len(parts) != 2 {
-		return fmt.Errorf("expected NAME=VALUE got '%s'", value)
-	}
-	p := new(portainer.Pair)
-	p.Name = parts[0]
-	p.Value = parts[1]
-	*l = append(*l, *p)
-	return nil
-}
-
-// String implementation for a list of pair
-func (l *pairList) String() string {
-	return ""
-}
-
-// IsCumulative implementation for a list of pair
-func (l *pairList) IsCumulative() bool {
-	return true
-}
-
-func pairs(s kingpin.Settings) (target *[]portainer.Pair) {
-	target = new([]portainer.Pair)
-	s.SetValue((*pairList)(target))
-	return
-}

api/cmd/portainer/main.go

@@ -1,645 +0,0 @@
-package main
-
-import (
-	"cmp"
-	"context"
-	"crypto/sha256"
-	"os"
-	"path"
-	"strings"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/apikey"
-	"github.com/portainer/portainer/api/chisel"
-	"github.com/portainer/portainer/api/cli"
-	"github.com/portainer/portainer/api/crypto"
-	"github.com/portainer/portainer/api/database"
-	"github.com/portainer/portainer/api/database/boltdb"
-	"github.com/portainer/portainer/api/database/models"
-	"github.com/portainer/portainer/api/dataservices"
-	"github.com/portainer/portainer/api/datastore"
-	"github.com/portainer/portainer/api/datastore/migrator"
-	"github.com/portainer/portainer/api/datastore/postinit"
-	"github.com/portainer/portainer/api/docker"
-	dockerclient "github.com/portainer/portainer/api/docker/client"
-	"github.com/portainer/portainer/api/exec"
-	"github.com/portainer/portainer/api/filesystem"
-	"github.com/portainer/portainer/api/git"
-	"github.com/portainer/portainer/api/hostmanagement/openamt"
-	"github.com/portainer/portainer/api/http"
-	"github.com/portainer/portainer/api/http/proxy"
-	kubeproxy "github.com/portainer/portainer/api/http/proxy/factory/kubernetes"
-	"github.com/portainer/portainer/api/internal/authorization"
-	"github.com/portainer/portainer/api/internal/edge/edgestacks"
-	"github.com/portainer/portainer/api/internal/endpointutils"
-	"github.com/portainer/portainer/api/internal/snapshot"
-	"github.com/portainer/portainer/api/internal/ssl"
-	"github.com/portainer/portainer/api/internal/upgrade"
-	"github.com/portainer/portainer/api/jwt"
-	"github.com/portainer/portainer/api/kubernetes"
-	kubecli "github.com/portainer/portainer/api/kubernetes/cli"
-	"github.com/portainer/portainer/api/ldap"
-	"github.com/portainer/portainer/api/logs"
-	"github.com/portainer/portainer/api/oauth"
-	"github.com/portainer/portainer/api/pendingactions"
-	"github.com/portainer/portainer/api/pendingactions/actions"
-	"github.com/portainer/portainer/api/pendingactions/handlers"
-	"github.com/portainer/portainer/api/platform"
-	"github.com/portainer/portainer/api/scheduler"
-	"github.com/portainer/portainer/api/stacks/deployments"
-	"github.com/portainer/portainer/pkg/build"
-	"github.com/portainer/portainer/pkg/featureflags"
-	"github.com/portainer/portainer/pkg/fips"
-	"github.com/portainer/portainer/pkg/libhelm"
-	libhelmtypes "github.com/portainer/portainer/pkg/libhelm/types"
-	"github.com/portainer/portainer/pkg/libstack/compose"
-	"github.com/portainer/portainer/pkg/validate"
-
-	"github.com/google/uuid"
-	"github.com/rs/zerolog/log"
-)
-
-func initCLI() *portainer.CLIFlags {
-	cliService := cli.Service{}
-
-	flags, err := cliService.ParseFlags(portainer.APIVersion)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed parsing flags")
-	}
-
-	if err := cliService.ValidateFlags(flags); err != nil {
-		log.Fatal().Err(err).Msg("failed validating flags")
-	}
-
-	return flags
-}
-
-func initFileService(dataStorePath string) portainer.FileService {
-	fileService, err := filesystem.NewService(dataStorePath, "")
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed creating file service")
-	}
-
-	return fileService
-}
-
-func initDataStore(flags *portainer.CLIFlags, secretKey []byte, fileService portainer.FileService, shutdownCtx context.Context) dataservices.DataStore {
-	connection, err := database.NewDatabase("boltdb", *flags.Data, secretKey, *flags.CompactDB)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed creating database connection")
-	}
-
-	if bconn, ok := connection.(*boltdb.DbConnection); ok {
-		bconn.MaxBatchSize = *flags.MaxBatchSize
-		bconn.MaxBatchDelay = *flags.MaxBatchDelay
-		bconn.InitialMmapSize = *flags.InitialMmapSize
-	} else {
-		log.Fatal().Msg("failed creating database connection: expecting a boltdb database type but a different one was received")
-	}
-
-	store := datastore.NewStore(flags, fileService, connection)
-
-	isNew, err := store.Open()
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed opening store")
-	}
-
-	if *flags.Rollback {
-		if err := store.Rollback(false); err != nil {
-			log.Fatal().Err(err).Msg("failed rolling back")
-		}
-
-		log.Info().Msg("exiting rollback")
-		os.Exit(0)
-	}
-
-	// Init sets some defaults - it's basically a migration
-	if err := store.Init(); err != nil {
-		log.Fatal().Err(err).Msg("failed initializing data store")
-	}
-
-	if isNew {
-		instanceId, err := uuid.NewRandom()
-		if err != nil {
-			log.Fatal().Err(err).Msg("failed generating instance id")
-		}
-
-		migratorInstance := migrator.NewMigrator(&migrator.MigratorParameters{Flags: flags})
-		migratorCount := migratorInstance.GetMigratorCountOfCurrentAPIVersion()
-
-		// from MigrateData
-		v := models.Version{
-			SchemaVersion: portainer.APIVersion,
-			Edition:       int(portainer.PortainerCE),
-			InstanceID:    instanceId.String(),
-			MigratorCount: migratorCount,
-		}
-
-		if err := store.VersionService.UpdateVersion(&v); err != nil {
-			log.Fatal().Err(err).Msg("failed to update version")
-		}
-
-		if err := updateSettingsFromFlags(store, flags); err != nil {
-			log.Fatal().Err(err).Msg("failed updating settings from flags")
-		}
-	} else if err := store.MigrateData(); err != nil {
-		log.Fatal().Err(err).Msg("failed migration")
-	}
-
-	if err := updateSettingsFromFlags(store, flags); err != nil {
-		log.Fatal().Err(err).Msg("failed updating settings from flags")
-	}
-
-	// this is for the db restore functionality - needs more tests.
-	go func() {
-		<-shutdownCtx.Done()
-
-		defer logs.CloseAndLogErr(connection)
-	}()
-
-	return store
-}
-
-// checkDBSchemaServerVersionMatch checks if the server version matches the db scehma version
-func checkDBSchemaServerVersionMatch(dbStore dataservices.DataStore, serverVersion string, serverEdition int) bool {
-	v, err := dbStore.Version().Version()
-	if err != nil {
-		return false
-	}
-
-	return v.SchemaVersion == serverVersion && v.Edition == serverEdition
-}
-
-func initKubernetesDeployer(kubernetesTokenCacheManager *kubeproxy.TokenCacheManager, kubernetesClientFactory *kubecli.ClientFactory, dataStore dataservices.DataStore, reverseTunnelService portainer.ReverseTunnelService, signatureService portainer.DigitalSignatureService, proxyManager *proxy.Manager) portainer.KubernetesDeployer {
-	return exec.NewKubernetesDeployer(kubernetesTokenCacheManager, kubernetesClientFactory, dataStore, reverseTunnelService, signatureService, proxyManager)
-}
-
-func initHelmPackageManager() (libhelmtypes.HelmPackageManager, error) {
-	return libhelm.NewHelmPackageManager()
-}
-
-func initAPIKeyService(datastore dataservices.DataStore) apikey.APIKeyService {
-	return apikey.NewAPIKeyService(datastore.APIKeyRepository(), datastore.User())
-}
-
-func initJWTService(userSessionTimeout string, dataStore dataservices.DataStore) (portainer.JWTService, error) {
-	if userSessionTimeout == "" {
-		userSessionTimeout = portainer.DefaultUserSessionTimeout
-	}
-
-	return jwt.NewService(userSessionTimeout, dataStore)
-}
-
-func initDigitalSignatureService() portainer.DigitalSignatureService {
-	return crypto.NewECDSAService(os.Getenv("AGENT_SECRET"))
-}
-
-func initSSLService(addr, certPath, keyPath string, fileService portainer.FileService, dataStore dataservices.DataStore, shutdownTrigger context.CancelFunc) (*ssl.Service, error) {
-	slices := strings.Split(addr, ":")
-
-	host := slices[0]
-	if host == "" {
-		host = "0.0.0.0"
-	}
-
-	sslService := ssl.NewService(fileService, dataStore, shutdownTrigger)
-
-	if err := sslService.Init(host, certPath, keyPath); err != nil {
-		return nil, err
-	}
-
-	return sslService, nil
-}
-
-func initSnapshotService(
-	snapshotIntervalFromFlag string,
-	dataStore dataservices.DataStore,
-	dockerClientFactory *dockerclient.ClientFactory,
-	kubernetesClientFactory *kubecli.ClientFactory,
-	shutdownCtx context.Context,
-	pendingActionsService *pendingactions.PendingActionsService,
-) (portainer.SnapshotService, error) {
-	dockerSnapshotter := docker.NewSnapshotter(dockerClientFactory)
-	kubernetesSnapshotter := kubernetes.NewSnapshotter(kubernetesClientFactory)
-
-	snapshotService, err := snapshot.NewService(snapshotIntervalFromFlag, dataStore, dockerSnapshotter, kubernetesSnapshotter, shutdownCtx, pendingActionsService)
-	if err != nil {
-		return nil, err
-	}
-
-	return snapshotService, nil
-}
-
-func initStatus(instanceID string) *portainer.Status {
-	return &portainer.Status{
-		Version:    portainer.APIVersion,
-		InstanceID: instanceID,
-	}
-}
-
-func updateSettingsFromFlags(dataStore dataservices.DataStore, flags *portainer.CLIFlags) error {
-	settings, err := dataStore.Settings().Settings()
-	if err != nil {
-		return err
-	}
-
-	settings.SnapshotInterval = cmp.Or(*flags.SnapshotInterval, settings.SnapshotInterval)
-	settings.LogoURL = cmp.Or(*flags.Logo, settings.LogoURL)
-	settings.EnableEdgeComputeFeatures = cmp.Or(*flags.EnableEdgeComputeFeatures, settings.EnableEdgeComputeFeatures)
-	settings.TemplatesURL = cmp.Or(*flags.Templates, settings.TemplatesURL)
-
-	if *flags.Labels != nil {
-		settings.BlackListedLabels = *flags.Labels
-	}
-
-	settings.AgentSecret = ""
-	if agentKey, ok := os.LookupEnv("AGENT_SECRET"); ok {
-		settings.AgentSecret = agentKey
-	}
-
-	if err := dataStore.Settings().UpdateSettings(settings); err != nil {
-		return err
-	}
-
-	sslSettings, err := dataStore.SSLSettings().Settings()
-	if err != nil {
-		return err
-	}
-
-	if *flags.HTTPDisabled {
-		sslSettings.HTTPEnabled = false
-	} else if *flags.HTTPEnabled {
-		sslSettings.HTTPEnabled = true
-	}
-
-	return dataStore.SSLSettings().UpdateSettings(sslSettings)
-}
-
-func loadAndParseKeyPair(fileService portainer.FileService, signatureService portainer.DigitalSignatureService) error {
-	private, public, err := fileService.LoadKeyPair()
-	if err != nil {
-		return err
-	}
-
-	return signatureService.ParseKeyPair(private, public)
-}
-
-func generateAndStoreKeyPair(fileService portainer.FileService, signatureService portainer.DigitalSignatureService) error {
-	private, public, err := signatureService.GenerateKeyPair()
-	if err != nil {
-		return err
-	}
-
-	privateHeader, publicHeader := signatureService.PEMHeaders()
-
-	return fileService.StoreKeyPair(private, public, privateHeader, publicHeader)
-}
-
-func initKeyPair(fileService portainer.FileService, signatureService portainer.DigitalSignatureService) error {
-	existingKeyPair, err := fileService.KeyPairFilesExist()
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed checking for existing key pair")
-	}
-
-	if existingKeyPair {
-		return loadAndParseKeyPair(fileService, signatureService)
-	}
-
-	return generateAndStoreKeyPair(fileService, signatureService)
-}
-
-// dbSecretPath build the path to the file that contains the db encryption
-// secret. Normally in Docker this is built from the static path inside
-// /run/secrets for example: /run/secrets/<keyFilenameFlag> but for ease of
-// use outside Docker it also accepts an absolute path
-func dbSecretPath(keyFilenameFlag string) string {
-	if path.IsAbs(keyFilenameFlag) {
-		return keyFilenameFlag
-	}
-	return path.Join("/run/secrets", keyFilenameFlag)
-}
-
-func loadEncryptionSecretKey(keyfilename string) []byte {
-	content, err := os.ReadFile(keyfilename)
-	if err != nil {
-		if os.IsNotExist(err) {
-			log.Info().Str("filename", keyfilename).Msg("encryption key file not present")
-		} else {
-			log.Info().Err(err).Msg("error reading encryption key file")
-		}
-
-		return nil
-	}
-
-	// return a 32 byte hash of the secret (required for AES)
-	// fips compliant version of this is not implemented in -ce
-	hash := sha256.Sum256(content)
-
-	return hash[:]
-}
-
-func buildServer(flags *portainer.CLIFlags) portainer.Server {
-	shutdownCtx, shutdownTrigger := context.WithCancel(context.Background())
-
-	if flags.FeatureFlags != nil {
-		featureflags.Parse(*flags.FeatureFlags, portainer.SupportedFeatureFlags)
-	}
-
-	trustedOrigins := []string{}
-	if *flags.TrustedOrigins != "" {
-		// validate if the trusted origins are valid urls
-		for origin := range strings.SplitSeq(*flags.TrustedOrigins, ",") {
-			if !validate.IsTrustedOrigin(origin) {
-				log.Fatal().Str("trusted_origin", origin).Msg("invalid url for trusted origin. Please check the trusted origins flag.")
-			}
-
-			trustedOrigins = append(trustedOrigins, origin)
-		}
-	}
-
-	// -ce can not ever be run in FIPS mode
-	fips.InitFIPS(false)
-
-	fileService := initFileService(*flags.Data)
-	encryptionKey := loadEncryptionSecretKey(dbSecretPath(*flags.SecretKeyName))
-	if encryptionKey == nil {
-		log.Info().Msg("proceeding without encryption key")
-	}
-
-	dataStore := initDataStore(flags, encryptionKey, fileService, shutdownCtx)
-
-	if err := dataStore.CheckCurrentEdition(); err != nil {
-		log.Fatal().Err(err).Msg("")
-	}
-
-	// check if the db schema version matches with server version
-	if !checkDBSchemaServerVersionMatch(dataStore, portainer.APIVersion, int(portainer.Edition)) {
-		log.Fatal().Msg("The database schema version does not align with the server version. Please consider reverting to the previous server version or addressing the database migration issue.")
-	}
-
-	instanceID, err := dataStore.Version().InstanceID()
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed getting instance id")
-	}
-
-	apiKeyService := initAPIKeyService(dataStore)
-
-	settings, err := dataStore.Settings().Settings()
-	if err != nil {
-		log.Fatal().Err(err).Msg("")
-	}
-
-	jwtService, err := initJWTService(settings.UserSessionTimeout, dataStore)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed initializing JWT service")
-	}
-
-	ldapService := ldap.Service{}
-
-	oauthService := oauth.NewService()
-
-	gitService := git.NewService(shutdownCtx)
-
-	// Setting insecureSkipVerify to true to preserve the old behaviour.
-	openAMTService := openamt.NewService(true)
-
-	cryptoService := crypto.Service{}
-
-	signatureService := initDigitalSignatureService()
-
-	edgeStacksService := edgestacks.NewService(dataStore)
-
-	sslService, err := initSSLService(*flags.AddrHTTPS, *flags.TLSCert, *flags.TLSKey, fileService, dataStore, shutdownTrigger)
-	if err != nil {
-		log.Fatal().Err(err).Msg("")
-	}
-
-	sslSettings, err := sslService.GetSSLSettings()
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed to get SSL settings")
-	}
-
-	if err := initKeyPair(fileService, signatureService); err != nil {
-		log.Fatal().Err(err).Msg("failed initializing key pair")
-	}
-
-	reverseTunnelService := chisel.NewService(dataStore, shutdownCtx, fileService)
-
-	dockerClientFactory := dockerclient.NewClientFactory(signatureService, reverseTunnelService)
-
-	kubernetesClientFactory, err := kubecli.NewClientFactory(signatureService, reverseTunnelService, dataStore, instanceID, *flags.AddrHTTPS, settings.UserSessionTimeout)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed initializing Kubernetes Client Factory service")
-	}
-
-	authorizationService := authorization.NewService(dataStore)
-	authorizationService.K8sClientFactory = kubernetesClientFactory
-
-	kubernetesTokenCacheManager := kubeproxy.NewTokenCacheManager()
-
-	kubeClusterAccessService := kubernetes.NewKubeClusterAccessService(*flags.BaseURL, *flags.AddrHTTPS, sslSettings.CertPath)
-
-	proxyManager := proxy.NewManager(kubernetesClientFactory)
-
-	reverseTunnelService.ProxyManager = proxyManager
-
-	dockerConfigPath := fileService.GetDockerConfigPath()
-
-	composeDeployer := compose.NewComposeDeployer()
-
-	composeStackManager := exec.NewComposeStackManager(composeDeployer, proxyManager, dataStore)
-
-	swarmStackManager, err := exec.NewSwarmStackManager(*flags.Assets, dockerConfigPath, signatureService, fileService, reverseTunnelService, dataStore)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed initializing swarm stack manager")
-	}
-
-	kubernetesDeployer := initKubernetesDeployer(kubernetesTokenCacheManager, kubernetesClientFactory, dataStore, reverseTunnelService, signatureService, proxyManager)
-
-	pendingActionsService := pendingactions.NewService(dataStore, kubernetesClientFactory)
-	pendingActionsService.RegisterHandler(actions.CleanNAPWithOverridePolicies, handlers.NewHandlerCleanNAPWithOverridePolicies(authorizationService, dataStore))
-	pendingActionsService.RegisterHandler(actions.DeletePortainerK8sRegistrySecrets, handlers.NewHandlerDeleteRegistrySecrets(authorizationService, dataStore, kubernetesClientFactory))
-	pendingActionsService.RegisterHandler(actions.PostInitMigrateEnvironment, handlers.NewHandlerPostInitMigrateEnvironment(authorizationService, dataStore, kubernetesClientFactory, dockerClientFactory, *flags.Assets, kubernetesDeployer))
-
-	snapshotService, err := initSnapshotService(*flags.SnapshotInterval, dataStore, dockerClientFactory, kubernetesClientFactory, shutdownCtx, pendingActionsService)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed initializing snapshot service")
-	}
-
-	snapshotService.Start()
-
-	proxyManager.NewProxyFactory(dataStore, signatureService, reverseTunnelService, dockerClientFactory, kubernetesClientFactory, kubernetesTokenCacheManager, gitService, snapshotService, jwtService)
-
-	helmPackageManager, err := initHelmPackageManager()
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed initializing helm package manager")
-	}
-
-	applicationStatus := initStatus(instanceID)
-
-	// channel to control when the admin user is created
-	adminCreationDone := make(chan struct{}, 1)
-
-	go endpointutils.InitEndpoint(shutdownCtx, adminCreationDone, flags, dataStore, snapshotService)
-
-	adminPasswordHash := ""
-
-	if *flags.AdminPasswordFile != "" {
-		content, err := fileService.GetFileContent(*flags.AdminPasswordFile, "")
-		if err != nil {
-			log.Fatal().Err(err).Msg("failed getting admin password file")
-		}
-
-		adminPasswordHash, err = cryptoService.Hash(strings.TrimSuffix(string(content), "\n"))
-		if err != nil {
-			log.Fatal().Err(err).Msg("failed hashing admin password")
-		}
-	} else if *flags.AdminPassword != "" {
-		adminPasswordHash = *flags.AdminPassword
-	}
-
-	if adminPasswordHash != "" {
-		users, err := dataStore.User().UsersByRole(portainer.AdministratorRole)
-		if err != nil {
-			log.Fatal().Err(err).Msg("failed getting admin user")
-		}
-
-		if len(users) == 0 {
-			log.Info().Msg("created admin user with the given password.")
-
-			user := &portainer.User{
-				Username: "admin",
-				Role:     portainer.AdministratorRole,
-				Password: adminPasswordHash,
-			}
-
-			if err := dataStore.User().Create(user); err != nil {
-				log.Fatal().Err(err).Msg("failed creating admin user")
-			}
-
-			// notify the admin user is created, the endpoint initialization can start
-			adminCreationDone <- struct{}{}
-		} else {
-			log.Info().Msg("instance already has an administrator user defined, skipping admin password related flags.")
-		}
-	}
-
-	if err := reverseTunnelService.StartTunnelServer(*flags.TunnelAddr, *flags.TunnelPort, snapshotService); err != nil {
-		log.Fatal().Err(err).Msg("failed starting tunnel server")
-	}
-
-	scheduler := scheduler.NewScheduler(shutdownCtx)
-	stackDeployer := deployments.NewStackDeployer(swarmStackManager, composeStackManager, kubernetesDeployer, dockerClientFactory, dataStore)
-	if err := deployments.StartStackSchedules(scheduler, stackDeployer, dataStore, gitService); err != nil {
-		log.Fatal().Err(err).Msg("failed to start stack scheduler")
-	}
-
-	sslDBSettings, err := dataStore.SSLSettings().Settings()
-	if err != nil {
-		log.Fatal().Msg("failed to fetch SSL settings from DB")
-	}
-
-	platformService, err := platform.NewService(dataStore)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed initializing platform service")
-	}
-
-	upgradeService, err := upgrade.NewService(
-		*flags.Assets,
-		kubernetesClientFactory,
-		dockerClientFactory,
-		composeStackManager,
-		dataStore,
-		fileService,
-		stackDeployer,
-	)
-	if err != nil {
-		log.Fatal().Err(err).Msg("failed initializing upgrade service")
-	}
-
-	// Our normal migrations run as part of the database initialization
-	// but some more complex migrations require access to a kubernetes or docker
-	// client. Therefore we run a separate migration process just before
-	// starting the server.
-	postInitMigrator := postinit.NewPostInitMigrator(
-		kubernetesClientFactory,
-		dockerClientFactory,
-		dataStore,
-		*flags.Assets,
-		kubernetesDeployer,
-	)
-	if err := postInitMigrator.PostInitMigrate(); err != nil {
-		log.Fatal().Err(err).Msg("failure during post init migrations")
-	}
-
-	return &http.Server{
-		AuthorizationService:        authorizationService,
-		ReverseTunnelService:        reverseTunnelService,
-		Status:                      applicationStatus,
-		BindAddress:                 *flags.Addr,
-		BindAddressHTTPS:            *flags.AddrHTTPS,
-		CSP:                         *flags.CSP,
-		HTTPEnabled:                 sslDBSettings.HTTPEnabled,
-		AssetsPath:                  *flags.Assets,
-		DataStore:                   dataStore,
-		EdgeStacksService:           edgeStacksService,
-		SwarmStackManager:           swarmStackManager,
-		ComposeStackManager:         composeStackManager,
-		KubernetesDeployer:          kubernetesDeployer,
-		HelmPackageManager:          helmPackageManager,
-		APIKeyService:               apiKeyService,
-		CryptoService:               cryptoService,
-		JWTService:                  jwtService,
-		FileService:                 fileService,
-		LDAPService:                 ldapService,
-		OAuthService:                oauthService,
-		GitService:                  gitService,
-		OpenAMTService:              openAMTService,
-		ProxyManager:                proxyManager,
-		KubernetesTokenCacheManager: kubernetesTokenCacheManager,
-		KubeClusterAccessService:    kubeClusterAccessService,
-		SignatureService:            signatureService,
-		SnapshotService:             snapshotService,
-		SSLService:                  sslService,
-		DockerClientFactory:         dockerClientFactory,
-		KubernetesClientFactory:     kubernetesClientFactory,
-		Scheduler:                   scheduler,
-		ShutdownCtx:                 shutdownCtx,
-		ShutdownTrigger:             shutdownTrigger,
-		StackDeployer:               stackDeployer,
-		UpgradeService:              upgradeService,
-		AdminCreationDone:           adminCreationDone,
-		PendingActionsService:       pendingActionsService,
-		PlatformService:             platformService,
-		PullLimitCheckDisabled:      *flags.PullLimitCheckDisabled,
-		TrustedOrigins:              trustedOrigins,
-	}
-}
-
-func main() {
-	logs.ConfigureLogger()
-	logs.SetLoggingMode("PRETTY")
-
-	flags := initCLI()
-
-	logs.SetLoggingLevel(*flags.LogLevel)
-	logs.SetLoggingMode(*flags.LogMode)
-
-	for {
-		server := buildServer(flags)
-
-		log.Info().
-			Str("version", portainer.APIVersion).
-			Str("build_number", build.BuildNumber).
-			Str("image_tag", build.ImageTag).
-			Str("nodejs_version", build.NodejsVersion).
-			Str("pnpm_version", build.PnpmVersion).
-			Str("webpack_version", build.WebpackVersion).
-			Str("go_version", build.GoVersion).
-			Msg("starting Portainer")
-
-		err := server.Start()
-
-		log.Info().Err(err).Msg("HTTP server exited")
-	}
-}

api/cmd/portainer/main_test.go

@@ -1,57 +0,0 @@
-package main
-
-import (
-	"os"
-	"path"
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-const secretFileName = "secret.txt"
-
-func createPasswordFile(t *testing.T, secretPath, password string) string {
-	err := os.WriteFile(secretPath, []byte(password), 0600)
-	require.NoError(t, err)
-	return secretPath
-}
-
-func TestLoadEncryptionSecretKey(t *testing.T) {
-	tempDir := t.TempDir()
-	secretPath := path.Join(tempDir, secretFileName)
-
-	// first pointing to file that does not exist, gives nil hash (no encryption)
-	encryptionKey := loadEncryptionSecretKey(secretPath)
-	require.Nil(t, encryptionKey)
-
-	// point to a directory instead of a file
-	encryptionKey = loadEncryptionSecretKey(tempDir)
-	require.Nil(t, encryptionKey)
-
-	password := "portainer@1234"
-	createPasswordFile(t, secretPath, password)
-
-	encryptionKey = loadEncryptionSecretKey(secretPath)
-	require.NotNil(t, encryptionKey)
-	// should be 32 bytes for aes256 encryption
-	require.Len(t, encryptionKey, 32)
-}
-
-func TestDBSecretPath(t *testing.T) {
-	tests := []struct {
-		keyFilenameFlag string
-		expected        string
-	}{
-		{keyFilenameFlag: "secret.txt", expected: "/run/secrets/secret.txt"},
-		{keyFilenameFlag: "/tmp/secret.txt", expected: "/tmp/secret.txt"},
-		{keyFilenameFlag: "/run/secrets/secret.txt", expected: "/run/secrets/secret.txt"},
-		{keyFilenameFlag: "./secret.txt", expected: "/run/secrets/secret.txt"},
-		{keyFilenameFlag: "../secret.txt", expected: "/run/secret.txt"},
-		{keyFilenameFlag: "foo/bar/secret.txt", expected: "/run/secrets/foo/bar/secret.txt"},
-	}
-
-	for _, test := range tests {
-		assert.Equal(t, test.expected, dbSecretPath(test.keyFilenameFlag))
-	}
-}

api/concurrent/concurrent.go

@@ -1,148 +0,0 @@
-// Package concurrent provides utilities for running multiple functions concurrently in Go.
-// For example, many kubernetes calls can take a while to fulfill.  Oftentimes in Portainer
-// we need to get a list of objects from multiple kubernetes REST APIs. We can often call these
-// apis concurrently to speed up the response time.
-// This package provides a clean way to do just that.
-//
-// Examples:
-//   The ConfigMaps and Secrets function converted using concurrent.Run.
-/*
-
-// GetConfigMapsAndSecrets gets all the ConfigMaps AND all the Secrets for a
-// given namespace in a k8s endpoint. The result is a list of both config maps
-// and secrets. The IsSecret boolean property indicates if a given struct is a
-// secret or configmap.
-func (kcl *KubeClient) GetConfigMapsAndSecrets(namespace string) ([]models.K8sConfigMapOrSecret, error) {
-
-	// use closures to capture the current kube client and namespace by declaring wrapper functions
-	// that match the interface signature for concurrent.Func
-
-	listConfigMaps := func(ctx context.Context) (any, error) {
-		return kcl.cli.CoreV1().ConfigMaps(namespace).List(context.Background(), meta.ListOptions{})
-	}
-
-	listSecrets := func(ctx context.Context) (any, error) {
-		return kcl.cli.CoreV1().Secrets(namespace).List(context.Background(), meta.ListOptions{})
-	}
-
-	// run the functions concurrently and wait for results.  We can also pass in a context to cancel.
-	// e.g. Deadline timer.
-	results, err := concurrent.Run(context.TODO(), listConfigMaps, listSecrets)
-	if err != nil {
-		return nil, err
-	}
-
-	var configMapList *core.ConfigMapList
-	var secretList *core.SecretList
-	for _, r := range results {
-		switch v := r.Result.(type) {
-		case *core.ConfigMapList:
-			configMapList = v
-		case *core.SecretList:
-			secretList = v
-		}
-	}
-
-	// TODO: Applications
-	var combined []models.K8sConfigMapOrSecret
-	for _, m := range configMapList.Items {
-		var cm models.K8sConfigMapOrSecret
-		cm.UID = string(m.UID)
-		cm.Name = m.Name
-		cm.Namespace = m.Namespace
-		cm.Annotations = m.Annotations
-		cm.Data = m.Data
-		cm.CreationDate = m.CreationTimestamp.Time.UTC().Format(time.RFC3339)
-		combined = append(combined, cm)
-	}
-
-	for _, s := range secretList.Items {
-		var secret models.K8sConfigMapOrSecret
-		secret.UID = string(s.UID)
-		secret.Name = s.Name
-		secret.Namespace = s.Namespace
-		secret.Annotations = s.Annotations
-		secret.Data = msbToMss(s.Data)
-		secret.CreationDate = s.CreationTimestamp.Time.UTC().Format(time.RFC3339)
-		secret.IsSecret = true
-		secret.SecretType = string(s.Type)
-		combined = append(combined, secret)
-	}
-
-	return combined, nil
-}
-
-*/
-
-package concurrent
-
-import (
-	"context"
-	"sync"
-)
-
-// Result contains the result and any error returned from running a client task function
-type Result struct {
-	Result any   // the result of running the task function
-	Err    error // any error that occurred while running the task function
-}
-
-// Func is a function returns a result or error
-type Func func(ctx context.Context) (any, error)
-
-// Run runs a list of functions returns the results
-func Run(ctx context.Context, maxConcurrency int, tasks ...Func) ([]Result, error) {
-	var wg sync.WaitGroup
-
-	resultsChan := make(chan Result, len(tasks))
-	taskChan := make(chan Func, len(tasks))
-
-	localCtx, cancelCtx := context.WithCancel(ctx)
-	defer cancelCtx()
-
-	runTask := func() {
-		defer wg.Done()
-
-		for fn := range taskChan {
-			result, err := fn(localCtx)
-			resultsChan <- Result{Result: result, Err: err}
-		}
-	}
-
-	// Set maxConcurrency to the number of tasks if zero or negative
-	if maxConcurrency <= 0 {
-		maxConcurrency = len(tasks)
-	}
-
-	// Start worker goroutines
-	for range maxConcurrency {
-		wg.Add(1)
-		go runTask()
-	}
-
-	// Add tasks to the task channel
-	for _, fn := range tasks {
-		taskChan <- fn
-	}
-
-	// Close the task channel to signal workers to stop when all tasks are done
-	close(taskChan)
-
-	// Wait for all workers to complete
-	wg.Wait()
-	close(resultsChan)
-
-	// Collect the results and cancel on error
-	results := make([]Result, 0, len(tasks))
-	for r := range resultsChan {
-		if r.Err != nil {
-			cancelCtx()
-
-			return nil, r.Err
-		}
-
-		results = append(results, r)
-	}
-
-	return results, nil
-}

api/connection.go

@@ -1,56 +0,0 @@
-package portainer
-
-import (
-	"io"
-)
-
-type ReadTransaction interface {
-	GetObject(bucketName string, key []byte, object any) error
-	GetRawBytes(bucketName string, key []byte) ([]byte, error)
-	GetAll(bucketName string, obj any, append func(o any) (any, error)) error
-	GetAllWithKeyPrefix(bucketName string, keyPrefix []byte, obj any, append func(o any) (any, error)) error
-	KeyExists(bucketName string, key []byte) (bool, error)
-}
-
-type Transaction interface {
-	ReadTransaction
-
-	SetServiceName(bucketName string) error
-	UpdateObject(bucketName string, key []byte, object any) error
-	DeleteObject(bucketName string, key []byte) error
-	CreateObject(bucketName string, fn func(uint64) (int, any)) error
-	CreateObjectWithId(bucketName string, id int, obj any) error
-	CreateObjectWithStringId(bucketName string, id []byte, obj any) error
-	DeleteAllObjects(bucketName string, obj any, matching func(o any) (id int, ok bool)) error
-	GetNextIdentifier(bucketName string) int
-}
-
-type Connection interface {
-	Transaction
-
-	Open() error
-	Close() error
-
-	UpdateTx(fn func(Transaction) error) error
-	ViewTx(fn func(Transaction) error) error
-
-	// write the db contents to filename as json (the schema needs defining)
-	ExportRaw(filename string) error
-
-	// TODO: this one is very database specific atm
-	BackupTo(w io.Writer) error
-	GetDatabaseFileName() string
-	GetDatabaseFilePath() string
-	GetStorePath() string
-	GetDatabaseFileSize() (int64, error)
-
-	IsEncryptedStore() bool
-	NeedsEncryptionMigration() (bool, error)
-	SetEncrypted(encrypted bool)
-
-	BackupMetadata() (map[string]any, error)
-	RestoreMetadata(s map[string]any) error
-
-	UpdateObjectFunc(bucketName string, key []byte, object any, updateFn func()) error
-	ConvertToKey(v int) []byte
-}

api/crypto/aes.go

@@ -1,410 +0,0 @@
-package crypto
-
-import (
-	"bufio"
-	"bytes"
-	"crypto/aes"
-	"crypto/cipher"
-	"crypto/pbkdf2"
-	"crypto/rand"
-	"crypto/sha256"
-	"errors"
-	"fmt"
-	"io"
-	"strings"
-
-	"github.com/portainer/portainer/pkg/fips"
-
-	// Not allowed in FIPS mode
-	"golang.org/x/crypto/argon2" //nolint:depguard
-	"golang.org/x/crypto/scrypt" //nolint:depguard
-)
-
-const (
-	// AES GCM settings
-	aesGcmHeader    = "AES256-GCM" // The encrypted file header
-	aesGcmBlockSize = 1024 * 1024  // 1MB block for aes gcm
-
-	aesGcmFIPSHeader    = "FIPS-AES256-GCM"
-	aesGcmFIPSBlockSize = 16 * 1024 * 1024 // 16MB block for aes gcm
-
-	// Argon2 settings
-	// Recommended settings lower memory hardware according to current OWASP recommendations
-	// Considering some people run portainer on a NAS I think it's prudent not to assume we're on server grade hardware
-	// https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#argon2id
-	argon2MemoryCost = 12 * 1024
-	argon2TimeCost   = 3
-	argon2Threads    = 1
-	argon2KeyLength  = 32
-
-	pbkdf2Iterations = 600_000 // use recommended iterations from https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#pbkdf2 a little overkill for this use
-	pbkdf2SaltLength = 32
-)
-
-// AesEncrypt reads from input, encrypts with AES-256 and writes to output. passphrase is used to generate an encryption key
-func AesEncrypt(input io.Reader, output io.Writer, passphrase []byte) error {
-	if fips.FIPSMode() {
-		if err := aesEncryptGCMFIPS(input, output, passphrase); err != nil {
-			return fmt.Errorf("error encrypting file: %w", err)
-		}
-	} else {
-		if err := aesEncryptGCM(input, output, passphrase); err != nil {
-			return fmt.Errorf("error encrypting file: %w", err)
-		}
-	}
-
-	return nil
-}
-
-// AesDecrypt reads from input, decrypts with AES-256 and returns the reader to read the decrypted content from
-func AesDecrypt(input io.Reader, passphrase []byte) (io.Reader, error) {
-	return aesDecrypt(input, passphrase, fips.FIPSMode())
-}
-
-func aesDecrypt(input io.Reader, passphrase []byte, fipsMode bool) (io.Reader, error) {
-	// Read file header to determine how it was encrypted
-	inputReader := bufio.NewReader(input)
-	header, err := inputReader.Peek(len(aesGcmFIPSHeader))
-	if err != nil {
-		return nil, fmt.Errorf("error reading encrypted backup file header: %w", err)
-	}
-
-	if strings.HasPrefix(string(header), aesGcmFIPSHeader) {
-		if !fipsMode {
-			return nil, errors.New("fips encrypted file detected but fips mode is not enabled")
-		}
-
-		reader, err := aesDecryptGCMFIPS(inputReader, passphrase)
-		if err != nil {
-			return nil, fmt.Errorf("error decrypting file: %w", err)
-		}
-
-		return reader, nil
-	}
-
-	if strings.HasPrefix(string(header), aesGcmHeader) {
-		if fipsMode {
-			return nil, errors.New("fips mode is enabled but non-fips encrypted file detected")
-		}
-
-		reader, err := aesDecryptGCM(inputReader, passphrase)
-		if err != nil {
-			return nil, fmt.Errorf("error decrypting file: %w", err)
-		}
-
-		return reader, nil
-	}
-
-	// Use the previous decryption routine which has no header (to support older archives)
-	reader, err := aesDecryptOFB(inputReader, passphrase)
-	if err != nil {
-		return nil, fmt.Errorf("error decrypting legacy file backup: %w", err)
-	}
-
-	return reader, nil
-}
-
-// aesEncryptGCM reads from input, encrypts with AES-256 and writes to output. passphrase is used to generate an encryption key.
-func aesEncryptGCM(input io.Reader, output io.Writer, passphrase []byte) error {
-	// Derive key using argon2 with a random salt
-	salt := make([]byte, 16) // 16 bytes salt
-	if _, err := io.ReadFull(rand.Reader, salt); err != nil {
-		return err
-	}
-
-	key := argon2.IDKey(passphrase, salt, argon2TimeCost, argon2MemoryCost, argon2Threads, 32)
-	block, err := aes.NewCipher(key)
-	if err != nil {
-		return err
-	}
-
-	aesgcm, err := cipher.NewGCM(block)
-	if err != nil {
-		return err
-	}
-
-	// Generate nonce
-	nonce, err := NewRandomNonce(aesgcm.NonceSize())
-	if err != nil {
-		return err
-	}
-
-	// write the header
-	if _, err := output.Write([]byte(aesGcmHeader)); err != nil {
-		return err
-	}
-
-	// Write nonce and salt to the output file
-	if _, err := output.Write(salt); err != nil {
-		return err
-	}
-	if _, err := output.Write(nonce.Value()); err != nil {
-		return err
-	}
-
-	// Buffer for reading plaintext blocks
-	buf := make([]byte, aesGcmBlockSize) // Adjust buffer size as needed
-	ciphertext := make([]byte, len(buf)+aesgcm.Overhead())
-
-	// Encrypt plaintext in blocks
-	for {
-		n, err := io.ReadFull(input, buf)
-		if n == 0 {
-			break // end of plaintext input
-		}
-
-		if err != nil && !errors.Is(err, io.EOF) && !errors.Is(err, io.ErrUnexpectedEOF) {
-			return err
-		}
-
-		// Seal encrypts the plaintext using the nonce returning the updated slice.
-		ciphertext = aesgcm.Seal(ciphertext[:0], nonce.Value(), buf[:n], nil)
-
-		if _, err := output.Write(ciphertext); err != nil {
-			return err
-		}
-
-		if err := nonce.Increment(); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-// aesDecryptGCM reads from input, decrypts with AES-256 and returns the reader to read the decrypted content from.
-func aesDecryptGCM(input io.Reader, passphrase []byte) (io.Reader, error) {
-	// Reader & verify header
-	header := make([]byte, len(aesGcmHeader))
-	if _, err := io.ReadFull(input, header); err != nil {
-		return nil, err
-	}
-
-	if string(header) != aesGcmHeader {
-		return nil, errors.New("invalid header")
-	}
-
-	// Read salt
-	salt := make([]byte, 16) // Salt size
-	if _, err := io.ReadFull(input, salt); err != nil {
-		return nil, err
-	}
-
-	key := argon2.IDKey(passphrase, salt, argon2TimeCost, argon2MemoryCost, argon2Threads, 32)
-
-	// Initialize AES cipher block
-	block, err := aes.NewCipher(key)
-	if err != nil {
-		return nil, err
-	}
-
-	// Create GCM mode with the cipher block
-	aesgcm, err := cipher.NewGCM(block)
-	if err != nil {
-		return nil, err
-	}
-
-	// Read nonce from the input reader
-	nonce := NewNonce(aesgcm.NonceSize())
-	if err := nonce.Read(input); err != nil {
-		return nil, err
-	}
-
-	// Initialize a buffer to store decrypted data
-	buf := bytes.Buffer{}
-	plaintext := make([]byte, aesGcmBlockSize)
-
-	// Decrypt the ciphertext in blocks
-	for {
-		// Read a block of ciphertext from the input reader
-		ciphertextBlock := make([]byte, aesGcmBlockSize+aesgcm.Overhead()) // Adjust block size as needed
-		n, err := io.ReadFull(input, ciphertextBlock)
-		if n == 0 {
-			break // end of ciphertext
-		}
-
-		if err != nil && !errors.Is(err, io.EOF) && !errors.Is(err, io.ErrUnexpectedEOF) {
-			return nil, err
-		}
-
-		// Decrypt the block of ciphertext
-		plaintext, err = aesgcm.Open(plaintext[:0], nonce.Value(), ciphertextBlock[:n], nil)
-		if err != nil {
-			return nil, err
-		}
-
-		if _, err := buf.Write(plaintext); err != nil {
-			return nil, err
-		}
-
-		if err := nonce.Increment(); err != nil {
-			return nil, err
-		}
-	}
-
-	return &buf, nil
-}
-
-// aesEncryptGCMFIPS reads from input, encrypts with AES-256 in a fips compliant
-// way and writes to output. passphrase is used to generate an encryption key.
-func aesEncryptGCMFIPS(input io.Reader, output io.Writer, passphrase []byte) error {
-	salt := make([]byte, pbkdf2SaltLength)
-	if _, err := io.ReadFull(rand.Reader, salt); err != nil {
-		return err
-	}
-
-	key, err := pbkdf2.Key(sha256.New, string(passphrase), salt, pbkdf2Iterations, 32)
-	if err != nil {
-		return fmt.Errorf("error deriving key: %w", err)
-	}
-
-	block, err := aes.NewCipher(key)
-	if err != nil {
-		return err
-	}
-
-	// write the header
-	if _, err := output.Write([]byte(aesGcmFIPSHeader)); err != nil {
-		return err
-	}
-
-	// Write nonce and salt to the output file
-	if _, err := output.Write(salt); err != nil {
-		return err
-	}
-
-	// Buffer for reading plaintext blocks
-	buf := make([]byte, aesGcmFIPSBlockSize)
-
-	// Encrypt plaintext in blocks
-	for {
-		// new random nonce for each block
-		aesgcm, err := cipher.NewGCMWithRandomNonce(block)
-		if err != nil {
-			return fmt.Errorf("error creating gcm: %w", err)
-		}
-
-		n, err := io.ReadFull(input, buf)
-		if n == 0 {
-			break // end of plaintext input
-		}
-
-		if err != nil && !errors.Is(err, io.EOF) && !errors.Is(err, io.ErrUnexpectedEOF) {
-			return err
-		}
-
-		// Seal encrypts the plaintext
-		ciphertext := aesgcm.Seal(nil, nil, buf[:n], nil)
-
-		if _, err := output.Write(ciphertext); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-// aesDecryptGCMFIPS reads from input, decrypts with AES-256 in a fips compliant
-// way and returns the reader to read the decrypted content from.
-func aesDecryptGCMFIPS(input io.Reader, passphrase []byte) (io.Reader, error) {
-	// Reader & verify header
-	header := make([]byte, len(aesGcmFIPSHeader))
-	if _, err := io.ReadFull(input, header); err != nil {
-		return nil, err
-	}
-
-	if string(header) != aesGcmFIPSHeader {
-		return nil, errors.New("invalid header")
-	}
-
-	// Read salt
-	salt := make([]byte, pbkdf2SaltLength)
-	if _, err := io.ReadFull(input, salt); err != nil {
-		return nil, err
-	}
-
-	key, err := pbkdf2.Key(sha256.New, string(passphrase), salt, pbkdf2Iterations, 32)
-	if err != nil {
-		return nil, fmt.Errorf("error deriving key: %w", err)
-	}
-
-	// Initialize AES cipher block
-	block, err := aes.NewCipher(key)
-	if err != nil {
-		return nil, err
-	}
-
-	// Initialize a buffer to store decrypted data
-	buf := bytes.Buffer{}
-
-	// Decrypt the ciphertext in blocks
-	for {
-		// Create GCM mode with the cipher block
-		aesgcm, err := cipher.NewGCMWithRandomNonce(block)
-		if err != nil {
-			return nil, err
-		}
-
-		// Read a block of ciphertext from the input reader
-		ciphertextBlock := make([]byte, aesGcmFIPSBlockSize+aesgcm.Overhead())
-		n, err := io.ReadFull(input, ciphertextBlock)
-		if n == 0 {
-			break // end of ciphertext
-		}
-
-		if err != nil && !errors.Is(err, io.EOF) && !errors.Is(err, io.ErrUnexpectedEOF) {
-			return nil, err
-		}
-
-		// Decrypt the block of ciphertext
-		plaintext, err := aesgcm.Open(nil, nil, ciphertextBlock[:n], nil)
-		if err != nil {
-			return nil, err
-		}
-
-		if _, err := buf.Write(plaintext); err != nil {
-			return nil, err
-		}
-	}
-
-	return &buf, nil
-}
-
-// aesDecryptOFB reads from input, decrypts with AES-256 and returns the reader to a read decrypted content from.
-// passphrase is used to generate an encryption key.
-// note: This function used to decrypt files that were encrypted without a header i.e. old archives
-func aesDecryptOFB(input io.Reader, passphrase []byte) (io.Reader, error) {
-	// making a 32 bytes key that would correspond to AES-256
-	// don't necessarily need a salt, so just kept in empty
-	key, err := scrypt.Key(passphrase, nil, 32768, 8, 1, 32)
-	if err != nil {
-		return nil, err
-	}
-
-	block, err := aes.NewCipher(key)
-	if err != nil {
-		return nil, err
-	}
-
-	// If the key is unique for each ciphertext, then it's ok to use a zero IV.
-	var iv [aes.BlockSize]byte
-	stream := cipher.NewOFB(block, iv[:])
-	reader := &cipher.StreamReader{S: stream, R: input}
-
-	return reader, nil
-}
-
-// HasEncryptedHeader checks if the data has an encrypted header, note that fips
-// mode changes this behavior and so will only recognize data encrypted by the
-// same mode (fips enabled or disabled)
-func HasEncryptedHeader(data []byte) bool {
-	return hasEncryptedHeader(data, fips.FIPSMode())
-}
-
-func hasEncryptedHeader(data []byte, fipsMode bool) bool {
-	if fipsMode {
-		return bytes.HasPrefix(data, []byte(aesGcmFIPSHeader))
-	}
-
-	return bytes.HasPrefix(data, []byte(aesGcmHeader))
-}

api/crypto/aes_test.go

@@ -1,444 +0,0 @@
-package crypto
-
-import (
-	"crypto/aes"
-	"crypto/cipher"
-	"io"
-	"math/rand"
-	"os"
-	"path/filepath"
-	"testing"
-
-	"github.com/portainer/portainer/api/logs"
-	"github.com/portainer/portainer/pkg/fips"
-
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-	"golang.org/x/crypto/scrypt"
-)
-
-func init() {
-	fips.InitFIPS(false)
-}
-
-const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
-
-func randBytes(n int) []byte {
-	b := make([]byte, n)
-	for i := range b {
-		b[i] = letterBytes[rand.Intn(len(letterBytes))]
-	}
-
-	return b
-}
-
-type encryptFunc func(input io.Reader, output io.Writer, passphrase []byte) error
-type decryptFunc func(input io.Reader, passphrase []byte) (io.Reader, error)
-
-func Test_encryptAndDecrypt_withTheSamePassword(t *testing.T) {
-	const passphrase = "passphrase"
-
-	testFunc := func(t *testing.T, encrypt encryptFunc, decrypt decryptFunc, decryptShouldSucceed bool) {
-		tmpdir := t.TempDir()
-
-		var (
-			originFilePath    = filepath.Join(tmpdir, "origin")
-			encryptedFilePath = filepath.Join(tmpdir, "encrypted")
-			decryptedFilePath = filepath.Join(tmpdir, "decrypted")
-		)
-
-		content := randBytes(1024*1024*100 + 523)
-		err := os.WriteFile(originFilePath, content, 0600)
-		require.NoError(t, err)
-
-		originFile, _ := os.Open(originFilePath)
-		defer logs.CloseAndLogErr(originFile)
-
-		encryptedFileWriter, _ := os.Create(encryptedFilePath)
-
-		err = encrypt(originFile, encryptedFileWriter, []byte(passphrase))
-		require.NoError(t, err, "Failed to encrypt a file")
-		logs.CloseAndLogErr(encryptedFileWriter)
-
-		encryptedContent, err := os.ReadFile(encryptedFilePath)
-		require.NoError(t, err, "Couldn't read encrypted file")
-		assert.NotEqual(t, encryptedContent, content, "Content wasn't encrypted")
-
-		encryptedFileReader, err := os.Open(encryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(encryptedFileReader)
-
-		decryptedFileWriter, err := os.Create(decryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(decryptedFileWriter)
-
-		decryptedReader, err := decrypt(encryptedFileReader, []byte(passphrase))
-		if !decryptShouldSucceed {
-			require.Error(t, err, "Failed to decrypt file as indicated by decryptShouldSucceed")
-		} else {
-			require.NoError(t, err, "Failed to decrypt file indicated by decryptShouldSucceed")
-
-			_, err = io.Copy(decryptedFileWriter, decryptedReader)
-			require.NoError(t, err)
-
-			decryptedContent, err := os.ReadFile(decryptedFilePath)
-			require.NoError(t, err)
-			assert.Equal(t, content, decryptedContent, "Original and decrypted content should match")
-		}
-	}
-
-	t.Run("fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCMFIPS, aesDecryptGCMFIPS, true)
-	})
-
-	t.Run("non_fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCM, aesDecryptGCM, true)
-	})
-
-	t.Run("system_fips_mode_public_entry_points", func(t *testing.T) {
-		// use the init mode, public entry points
-		testFunc(t, AesEncrypt, AesDecrypt, true)
-	})
-
-	t.Run("fips_encrypted_file_header_fails_in_non_fips_mode", func(t *testing.T) {
-		// use aesDecrypt which checks the header, confirm that it fails
-		decrypt := func(input io.Reader, passphrase []byte) (io.Reader, error) {
-			return aesDecrypt(input, passphrase, false)
-		}
-
-		testFunc(t, aesEncryptGCMFIPS, decrypt, false)
-	})
-
-	t.Run("non_fips_encrypted_file_header_fails_in_fips_mode", func(t *testing.T) {
-		// use aesDecrypt which checks the header, confirm that it fails
-		decrypt := func(input io.Reader, passphrase []byte) (io.Reader, error) {
-			return aesDecrypt(input, passphrase, true)
-		}
-
-		testFunc(t, aesEncryptGCM, decrypt, false)
-	})
-
-	t.Run("fips_encrypted_file_fails_in_non_fips_mode", func(t *testing.T) {
-		testFunc(t, aesEncryptGCMFIPS, aesDecryptGCM, false)
-	})
-
-	t.Run("non_fips_encrypted_file_with_fips_mode_should_fail", func(t *testing.T) {
-		testFunc(t, aesEncryptGCM, aesDecryptGCMFIPS, false)
-	})
-
-	t.Run("fips_with_base_aesDecrypt", func(t *testing.T) {
-		// maximize coverage, use the base aesDecrypt function with valid fips mode
-		decrypt := func(input io.Reader, passphrase []byte) (io.Reader, error) {
-			return aesDecrypt(input, passphrase, true)
-		}
-
-		testFunc(t, aesEncryptGCMFIPS, decrypt, true)
-	})
-
-	t.Run("legacy", func(t *testing.T) {
-		testFunc(t, legacyAesEncrypt, aesDecryptOFB, true)
-	})
-}
-
-func Test_encryptAndDecrypt_withStrongPassphrase(t *testing.T) {
-	const passphrase = "A strong passphrase with special characters: !@#$%^&*()_+"
-
-	testFunc := func(t *testing.T, encrypt encryptFunc, decrypt decryptFunc) {
-		tmpdir := t.TempDir()
-
-		var (
-			originFilePath    = filepath.Join(tmpdir, "origin2")
-			encryptedFilePath = filepath.Join(tmpdir, "encrypted2")
-			decryptedFilePath = filepath.Join(tmpdir, "decrypted2")
-		)
-
-		content := randBytes(500)
-
-		err := os.WriteFile(originFilePath, content, 0600)
-		require.NoError(t, err)
-
-		originFile, err := os.Open(originFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(originFile)
-
-		encryptedFileWriter, _ := os.Create(encryptedFilePath)
-
-		err = encrypt(originFile, encryptedFileWriter, []byte(passphrase))
-		require.NoError(t, err, "Failed to encrypt a file")
-		logs.CloseAndLogErr(encryptedFileWriter)
-
-		encryptedContent, err := os.ReadFile(encryptedFilePath)
-		require.NoError(t, err, "Couldn't read encrypted file")
-		assert.NotEqual(t, encryptedContent, content, "Content wasn't encrypted")
-
-		encryptedFileReader, err := os.Open(encryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(encryptedFileReader)
-
-		decryptedFileWriter, err := os.Create(decryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(decryptedFileWriter)
-
-		decryptedReader, err := decrypt(encryptedFileReader, []byte(passphrase))
-		require.NoError(t, err, "Failed to decrypt file")
-
-		_, err = io.Copy(decryptedFileWriter, decryptedReader)
-		require.NoError(t, err)
-
-		decryptedContent, err := os.ReadFile(decryptedFilePath)
-		require.NoError(t, err)
-		assert.Equal(t, content, decryptedContent, "Original and decrypted content should match")
-	}
-
-	t.Run("fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCMFIPS, aesDecryptGCMFIPS)
-	})
-
-	t.Run("non_fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCM, aesDecryptGCM)
-	})
-}
-
-func Test_encryptAndDecrypt_withTheSamePasswordSmallFile(t *testing.T) {
-	testFunc := func(t *testing.T, encrypt encryptFunc, decrypt decryptFunc) {
-		tmpdir := t.TempDir()
-
-		var (
-			originFilePath    = filepath.Join(tmpdir, "origin2")
-			encryptedFilePath = filepath.Join(tmpdir, "encrypted2")
-			decryptedFilePath = filepath.Join(tmpdir, "decrypted2")
-		)
-
-		content := randBytes(500)
-		err := os.WriteFile(originFilePath, content, 0600)
-		require.NoError(t, err)
-
-		originFile, err := os.Open(originFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(originFile)
-
-		encryptedFileWriter, err := os.Create(encryptedFilePath)
-		require.NoError(t, err)
-
-		err = encrypt(originFile, encryptedFileWriter, []byte("passphrase"))
-		require.NoError(t, err, "Failed to encrypt a file")
-		logs.CloseAndLogErr(encryptedFileWriter)
-
-		encryptedContent, err := os.ReadFile(encryptedFilePath)
-		require.NoError(t, err, "Couldn't read encrypted file")
-		assert.NotEqual(t, encryptedContent, content, "Content wasn't encrypted")
-
-		encryptedFileReader, err := os.Open(encryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(encryptedFileReader)
-
-		decryptedFileWriter, err := os.Create(decryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(decryptedFileWriter)
-
-		decryptedReader, err := decrypt(encryptedFileReader, []byte("passphrase"))
-		require.NoError(t, err, "Failed to decrypt file")
-
-		_, err = io.Copy(decryptedFileWriter, decryptedReader)
-		require.NoError(t, err)
-
-		decryptedContent, err := os.ReadFile(decryptedFilePath)
-		require.NoError(t, err)
-		assert.Equal(t, content, decryptedContent, "Original and decrypted content should match")
-	}
-
-	t.Run("fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCMFIPS, aesDecryptGCMFIPS)
-	})
-
-	t.Run("non_fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCM, aesDecryptGCM)
-	})
-}
-
-func Test_encryptAndDecrypt_withEmptyPassword(t *testing.T) {
-	testFunc := func(t *testing.T, encrypt encryptFunc, decrypt decryptFunc) {
-		tmpdir := t.TempDir()
-
-		var (
-			originFilePath    = filepath.Join(tmpdir, "origin")
-			encryptedFilePath = filepath.Join(tmpdir, "encrypted")
-			decryptedFilePath = filepath.Join(tmpdir, "decrypted")
-		)
-
-		content := randBytes(1024 * 50)
-		err := os.WriteFile(originFilePath, content, 0600)
-		require.NoError(t, err)
-
-		originFile, err := os.Open(originFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(originFile)
-
-		encryptedFileWriter, err := os.Create(encryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(encryptedFileWriter)
-
-		err = encrypt(originFile, encryptedFileWriter, []byte(""))
-		require.NoError(t, err, "Failed to encrypt a file")
-
-		encryptedContent, err := os.ReadFile(encryptedFilePath)
-		require.NoError(t, err, "Couldn't read encrypted file")
-		assert.NotEqual(t, encryptedContent, content, "Content wasn't encrypted")
-
-		encryptedFileReader, err := os.Open(encryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(encryptedFileReader)
-
-		decryptedFileWriter, err := os.Create(decryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(decryptedFileWriter)
-
-		decryptedReader, err := decrypt(encryptedFileReader, []byte(""))
-		require.NoError(t, err, "Failed to decrypt file")
-
-		_, err = io.Copy(decryptedFileWriter, decryptedReader)
-		require.NoError(t, err)
-
-		decryptedContent, err := os.ReadFile(decryptedFilePath)
-		require.NoError(t, err)
-		assert.Equal(t, content, decryptedContent, "Original and decrypted content should match")
-	}
-
-	t.Run("fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCMFIPS, aesDecryptGCMFIPS)
-	})
-
-	t.Run("non_fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCM, aesDecryptGCM)
-	})
-}
-
-func Test_decryptWithDifferentPassphrase_shouldProduceWrongResult(t *testing.T) {
-	testFunc := func(t *testing.T, encrypt encryptFunc, decrypt decryptFunc) {
-		tmpdir := t.TempDir()
-
-		var (
-			originFilePath    = filepath.Join(tmpdir, "origin")
-			encryptedFilePath = filepath.Join(tmpdir, "encrypted")
-			decryptedFilePath = filepath.Join(tmpdir, "decrypted")
-		)
-
-		content := randBytes(1034)
-		err := os.WriteFile(originFilePath, content, 0600)
-		require.NoError(t, err)
-
-		originFile, err := os.Open(originFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(originFile)
-
-		encryptedFileWriter, err := os.Create(encryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(encryptedFileWriter)
-
-		err = encrypt(originFile, encryptedFileWriter, []byte("passphrase"))
-		require.NoError(t, err, "Failed to encrypt a file")
-		encryptedContent, err := os.ReadFile(encryptedFilePath)
-		require.NoError(t, err, "Couldn't read encrypted file")
-		assert.NotEqual(t, encryptedContent, content, "Content wasn't encrypted")
-
-		encryptedFileReader, err := os.Open(encryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(encryptedFileReader)
-
-		decryptedFileWriter, err := os.Create(decryptedFilePath)
-		require.NoError(t, err)
-		defer logs.CloseAndLogErr(decryptedFileWriter)
-
-		_, err = decrypt(encryptedFileReader, []byte("garbage"))
-		require.Error(t, err, "Should not allow decrypt with wrong passphrase")
-	}
-
-	t.Run("fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCMFIPS, aesDecryptGCMFIPS)
-	})
-
-	t.Run("non_fips", func(t *testing.T) {
-		testFunc(t, aesEncryptGCM, aesDecryptGCM)
-	})
-}
-
-func legacyAesEncrypt(input io.Reader, output io.Writer, passphrase []byte) error {
-	key, err := scrypt.Key(passphrase, nil, 32768, 8, 1, 32)
-	if err != nil {
-		return err
-	}
-
-	block, err := aes.NewCipher(key)
-	if err != nil {
-		return err
-	}
-
-	var iv [aes.BlockSize]byte
-	stream := cipher.NewOFB(block, iv[:])
-
-	writer := &cipher.StreamWriter{S: stream, W: output}
-	if _, err := io.Copy(writer, input); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-func Test_hasEncryptedHeader(t *testing.T) {
-	tests := []struct {
-		name     string
-		data     []byte
-		fipsMode bool
-		want     bool
-	}{
-		{
-			name:     "non-FIPS mode with valid header",
-			data:     []byte("AES256-GCM" + "some encrypted data"),
-			fipsMode: false,
-			want:     true,
-		},
-		{
-			name:     "non-FIPS mode with FIPS header",
-			data:     []byte("FIPS-AES256-GCM" + "some encrypted data"),
-			fipsMode: false,
-			want:     false,
-		},
-		{
-			name:     "FIPS mode with valid header",
-			data:     []byte("FIPS-AES256-GCM" + "some encrypted data"),
-			fipsMode: true,
-			want:     true,
-		},
-		{
-			name:     "FIPS mode with non-FIPS header",
-			data:     []byte("AES256-GCM" + "some encrypted data"),
-			fipsMode: true,
-			want:     false,
-		},
-		{
-			name:     "invalid header",
-			data:     []byte("INVALID-HEADER" + "some data"),
-			fipsMode: false,
-			want:     false,
-		},
-		{
-			name:     "empty data",
-			data:     []byte{},
-			fipsMode: false,
-			want:     false,
-		},
-		{
-			name:     "nil data",
-			data:     nil,
-			fipsMode: false,
-			want:     false,
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got := hasEncryptedHeader(tt.data, tt.fipsMode)
-			assert.Equal(t, tt.want, got)
-		})
-	}
-}

api/crypto/ecdsa.go

@@ -1,135 +0,0 @@
-package crypto
-
-import (
-	"crypto/ecdsa"
-	"crypto/elliptic"
-	"crypto/rand"
-	"crypto/x509"
-	"encoding/base64"
-	"encoding/hex"
-
-	"github.com/portainer/portainer/pkg/libcrypto"
-)
-
-const (
-	// PrivateKeyPemHeader represents the header that is appended to the PEM file when
-	// storing the private key.
-	PrivateKeyPemHeader = "EC PRIVATE KEY"
-	// PublicKeyPemHeader represents the header that is appended to the PEM file when
-	// storing the public key.
-	PublicKeyPemHeader = "ECDSA PUBLIC KEY"
-)
-
-// ECDSAService is a service used to create digital signatures when communicating with
-// an agent based environment(endpoint). It will automatically generates a key pair using ECDSA or
-// can also reuse an existing ECDSA key pair.
-type ECDSAService struct {
-	privateKey    *ecdsa.PrivateKey
-	publicKey     *ecdsa.PublicKey
-	encodedPubKey string
-	secret        string
-}
-
-// NewECDSAService returns a pointer to a ECDSAService.
-// An optional secret can be specified
-func NewECDSAService(secret string) *ECDSAService {
-	return &ECDSAService{
-		secret: secret,
-	}
-}
-
-// EncodedPublicKey returns the encoded version of the public that can be used
-// to be shared with other services. It's the hexadecimal encoding of the public key
-// content.
-func (service *ECDSAService) EncodedPublicKey() string {
-	return service.encodedPubKey
-}
-
-// PEMHeaders returns the ECDSA PEM headers.
-func (service *ECDSAService) PEMHeaders() (string, string) {
-	return PrivateKeyPemHeader, PublicKeyPemHeader
-}
-
-// ParseKeyPair parses existing private/public key pair content and associate
-// the parsed keys to the service.
-func (service *ECDSAService) ParseKeyPair(private, public []byte) error {
-	privateKey, err := x509.ParseECPrivateKey(private)
-	if err != nil {
-		return err
-	}
-
-	service.privateKey = privateKey
-
-	encodedKey := hex.EncodeToString(public)
-	service.encodedPubKey = encodedKey
-
-	publicKey, err := x509.ParsePKIXPublicKey(public)
-	if err != nil {
-		return err
-	}
-
-	service.publicKey = publicKey.(*ecdsa.PublicKey)
-
-	return nil
-}
-
-// GenerateKeyPair will create a new key pair using ECDSA.
-func (service *ECDSAService) GenerateKeyPair() ([]byte, []byte, error) {
-	pubkeyCurve := elliptic.P256()
-
-	privatekey, err := ecdsa.GenerateKey(pubkeyCurve, rand.Reader)
-	if err != nil {
-		return nil, nil, err
-	}
-
-	service.privateKey = privatekey
-	service.publicKey = &privatekey.PublicKey
-
-	private, err := x509.MarshalECPrivateKey(service.privateKey)
-	if err != nil {
-		return nil, nil, err
-	}
-
-	public, err := x509.MarshalPKIXPublicKey(service.publicKey)
-	if err != nil {
-		return nil, nil, err
-	}
-
-	encodedKey := hex.EncodeToString(public)
-	service.encodedPubKey = encodedKey
-
-	return private, public, nil
-}
-
-// CreateSignature creates a digital signature.
-// It automatically hash a specific message using MD5 and creates a signature from
-// that hash.
-// If a secret is associated to the service, it will be used instead of the specified
-// message.
-// It then encodes the generated signature in base64.
-func (service *ECDSAService) CreateSignature(message string) (string, error) {
-	if service.secret != "" {
-		message = service.secret
-	}
-
-	hash := libcrypto.InsecureHashFromBytes([]byte(message))
-
-	r, s, err := ecdsa.Sign(rand.Reader, service.privateKey, hash)
-	if err != nil {
-		return "", err
-	}
-
-	keyBytes := service.privateKey.Params().BitSize / 8
-
-	rBytes := r.Bytes()
-	rBytesPadded := make([]byte, keyBytes)
-	copy(rBytesPadded[keyBytes-len(rBytes):], rBytes)
-
-	sBytes := s.Bytes()
-	sBytesPadded := make([]byte, keyBytes)
-	copy(sBytesPadded[keyBytes-len(sBytes):], sBytes)
-
-	signature := append(rBytesPadded, sBytesPadded...)
-
-	return base64.RawStdEncoding.EncodeToString(signature), nil
-}

api/crypto/ecdsa_test.go

@@ -1,22 +0,0 @@
-package crypto
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/require"
-)
-
-func TestCreateSignature(t *testing.T) {
-	var s = NewECDSAService("secret")
-
-	privKey, pubKey, err := s.GenerateKeyPair()
-	require.NoError(t, err)
-	require.NotEmpty(t, privKey)
-	require.NotEmpty(t, pubKey)
-
-	m := "test message"
-	r, err := s.CreateSignature(m)
-	require.NoError(t, err)
-	require.NotEqual(t, r, m)
-	require.NotEmpty(t, r)
-}

api/crypto/hash.go

@@ -1,24 +0,0 @@
-package crypto
-
-import (
-	// Not allowed in FIPS mode
-	"golang.org/x/crypto/bcrypt" //nolint:depguard
-)
-
-// Service represents a service for encrypting/hashing data.
-type Service struct{}
-
-// Hash hashes a string using the bcrypt algorithm
-func (Service) Hash(data string) (string, error) {
-	bytes, err := bcrypt.GenerateFromPassword([]byte(data), bcrypt.DefaultCost)
-	if err != nil {
-		return "", err
-	}
-
-	return string(bytes), err
-}
-
-// CompareHashAndData compares a hash to clear data and returns an error if the comparison fails.
-func (Service) CompareHashAndData(hash string, data string) error {
-	return bcrypt.CompareHashAndPassword([]byte(hash), []byte(data))
-}

api/crypto/hash_test.go

@@ -1,63 +0,0 @@
-package crypto
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/require"
-)
-
-func TestService_Hash(t *testing.T) {
-	var s = Service{}
-
-	type args struct {
-		hash string
-		data string
-	}
-	tests := []struct {
-		name   string
-		args   args
-		expect bool
-	}{
-		{
-			name: "Empty",
-			args: args{
-				hash: "",
-				data: "",
-			},
-			expect: false,
-		},
-		{
-			name: "Matching",
-			args: args{
-				hash: "$2a$10$6BFGd94oYx8k0bFNO6f33uPUpcpAJyg8UVX.akLe9EthF/ZBTXqcy",
-				data: "Passw0rd!",
-			},
-			expect: true,
-		},
-		{
-			name: "Not matching",
-			args: args{
-				hash: "$2a$10$ltKrUZ7492xyutHOb0/XweevU4jyw7QO66rP32jTVOMb3EX3JxA/a",
-				data: "Passw0rd!",
-			},
-			expect: false,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-
-			err := s.CompareHashAndData(tt.args.hash, tt.args.data)
-			if (err != nil) == tt.expect {
-				t.Errorf("Service.CompareHashAndData() = %v", err)
-			}
-		})
-	}
-}
-
-func TestHash(t *testing.T) {
-	s := Service{}
-
-	hash, err := s.Hash("Passw0rd!")
-	require.NoError(t, err)
-	require.NotEmpty(t, hash)
-}

api/crypto/nonce.go

@@ -1,61 +0,0 @@
-package crypto
-
-import (
-	"crypto/rand"
-	"errors"
-	"io"
-)
-
-type Nonce struct {
-	val []byte
-}
-
-func NewNonce(size int) *Nonce {
-	return &Nonce{val: make([]byte, size)}
-}
-
-// NewRandomNonce generates a new initial nonce with the lower byte set to a random value
-// This ensures there are plenty of nonce values available before rolling over
-// Based on ideas from the Secure Programming Cookbook for C and C++ by John Viega, Matt Messier
-// https://www.oreilly.com/library/view/secure-programming-cookbook/0596003943/ch04s09.html
-func NewRandomNonce(size int) (*Nonce, error) {
-	randomBytes := 1
-	if size <= randomBytes {
-		return nil, errors.New("nonce size must be greater than the number of random bytes")
-	}
-
-	randomPart := make([]byte, randomBytes)
-	if _, err := rand.Read(randomPart); err != nil {
-		return nil, err
-	}
-
-	zeroPart := make([]byte, size-randomBytes)
-	nonceVal := append(randomPart, zeroPart...)
-	return &Nonce{val: nonceVal}, nil
-}
-
-func (n *Nonce) Read(stream io.Reader) error {
-	_, err := io.ReadFull(stream, n.val)
-	return err
-}
-
-func (n *Nonce) Value() []byte {
-	return n.val
-}
-
-func (n *Nonce) Increment() error {
-	// Start incrementing from the least significant byte
-	for i := len(n.val) - 1; i >= 0; i-- {
-		// Increment the current byte
-		n.val[i]++
-
-		// Check for overflow
-		if n.val[i] != 0 {
-			// No overflow, nonce is successfully incremented
-			return nil
-		}
-	}
-
-	// If we reach here, it means the nonce has overflowed
-	return errors.New("nonce overflow")
-}

api/crypto/tls.go

@@ -1,124 +0,0 @@
-package crypto
-
-import (
-	"crypto/tls"
-	"crypto/x509"
-	"os"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/pkg/fips"
-)
-
-// CreateTLSConfiguration creates a basic tls.Config with recommended TLS settings
-func CreateTLSConfiguration(insecureSkipVerify bool) *tls.Config { //nolint:forbidigo
-	return createTLSConfiguration(fips.FIPSMode(), insecureSkipVerify)
-}
-
-func createTLSConfiguration(fipsEnabled bool, insecureSkipVerify bool) *tls.Config { //nolint:forbidigo
-	if fipsEnabled {
-		return &tls.Config{ //nolint:forbidigo
-			MinVersion: tls.VersionTLS12,
-			MaxVersion: tls.VersionTLS13,
-			CipherSuites: []uint16{
-				tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
-				tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
-				tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
-				tls.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
-			},
-			CurvePreferences: []tls.CurveID{tls.CurveP256, tls.CurveP384, tls.CurveP521},
-		}
-	}
-
-	return &tls.Config{ //nolint:forbidigo
-		MinVersion: tls.VersionTLS12,
-		CipherSuites: []uint16{
-			tls.TLS_AES_128_GCM_SHA256,
-			tls.TLS_AES_256_GCM_SHA384,
-			tls.TLS_CHACHA20_POLY1305_SHA256,
-			tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
-			tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
-			tls.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
-			tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
-			tls.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,
-			tls.TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,
-			tls.TLS_RSA_WITH_AES_128_GCM_SHA256,
-			tls.TLS_RSA_WITH_AES_256_GCM_SHA384,
-			tls.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
-			tls.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,
-			tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
-			tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
-			tls.TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,
-			tls.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,
-		},
-		InsecureSkipVerify: insecureSkipVerify, //nolint:forbidigo
-	}
-}
-
-// CreateTLSConfigurationFromBytes initializes a tls.Config using a CA certificate, a certificate and a key
-// loaded from memory.
-func CreateTLSConfigurationFromBytes(useTLS bool, caCert, cert, key []byte, skipClientVerification, skipServerVerification bool) (*tls.Config, error) { //nolint:forbidigo
-	return createTLSConfigurationFromBytes(fips.FIPSMode(), useTLS, caCert, cert, key, skipClientVerification, skipServerVerification)
-}
-
-func createTLSConfigurationFromBytes(fipsEnabled, useTLS bool, caCert, cert, key []byte, skipClientVerification, skipServerVerification bool) (*tls.Config, error) { //nolint:forbidigo
-	if !useTLS {
-		return nil, nil
-	}
-
-	config := createTLSConfiguration(fipsEnabled, skipServerVerification)
-
-	if !skipClientVerification || fipsEnabled {
-		certificate, err := tls.X509KeyPair(cert, key)
-		if err != nil {
-			return nil, err
-		}
-
-		config.Certificates = []tls.Certificate{certificate}
-	}
-
-	if !skipServerVerification || fipsEnabled {
-		caCertPool := x509.NewCertPool()
-		caCertPool.AppendCertsFromPEM(caCert)
-		config.RootCAs = caCertPool
-	}
-
-	return config, nil
-}
-
-// CreateTLSConfigurationFromDisk initializes a tls.Config using a CA certificate, a certificate and a key
-// loaded from disk.
-func CreateTLSConfigurationFromDisk(config portainer.TLSConfiguration) (*tls.Config, error) { //nolint:forbidigo
-	return createTLSConfigurationFromDisk(fips.FIPSMode(), config)
-}
-
-func createTLSConfigurationFromDisk(fipsEnabled bool, config portainer.TLSConfiguration) (*tls.Config, error) { //nolint:forbidigo
-	if !config.TLS && fipsEnabled {
-		return nil, fips.ErrTLSRequired
-	} else if !config.TLS {
-		return nil, nil
-	}
-
-	tlsConfig := createTLSConfiguration(fipsEnabled, config.TLSSkipVerify)
-
-	if config.TLSCertPath != "" && config.TLSKeyPath != "" {
-		cert, err := tls.LoadX509KeyPair(config.TLSCertPath, config.TLSKeyPath)
-		if err != nil {
-			return nil, err
-		}
-
-		tlsConfig.Certificates = []tls.Certificate{cert}
-	}
-
-	if !tlsConfig.InsecureSkipVerify && config.TLSCACertPath != "" { //nolint:forbidigo
-		caCert, err := os.ReadFile(config.TLSCACertPath)
-		if err != nil {
-			return nil, err
-		}
-
-		caCertPool := x509.NewCertPool()
-		caCertPool.AppendCertsFromPEM(caCert)
-		tlsConfig.RootCAs = caCertPool
-	}
-
-	return tlsConfig, nil
-}

api/crypto/tls_test.go

@@ -1,87 +0,0 @@
-package crypto
-
-import (
-	"crypto/tls"
-	"testing"
-
-	portainer "github.com/portainer/portainer/api"
-
-	"github.com/stretchr/testify/require"
-)
-
-func TestCreateTLSConfiguration(t *testing.T) {
-	// InsecureSkipVerify = false
-	config := CreateTLSConfiguration(false)
-	require.Equal(t, config.MinVersion, uint16(tls.VersionTLS12)) //nolint:forbidigo
-	require.False(t, config.InsecureSkipVerify)                   //nolint:forbidigo
-
-	// InsecureSkipVerify = true
-	config = CreateTLSConfiguration(true)
-	require.Equal(t, config.MinVersion, uint16(tls.VersionTLS12)) //nolint:forbidigo
-	require.True(t, config.InsecureSkipVerify)                    //nolint:forbidigo
-}
-
-func TestCreateTLSConfigurationFIPS(t *testing.T) {
-	fips := true
-
-	fipsCipherSuites := []uint16{
-		tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
-		tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
-		tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
-		tls.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
-	}
-
-	fipsCurvePreferences := []tls.CurveID{tls.CurveP256, tls.CurveP384, tls.CurveP521}
-
-	config := createTLSConfiguration(fips, false)
-	require.Equal(t, config.MinVersion, uint16(tls.VersionTLS12))   //nolint:forbidigo
-	require.Equal(t, config.MaxVersion, uint16(tls.VersionTLS13))   //nolint:forbidigo
-	require.Equal(t, config.CipherSuites, fipsCipherSuites)         //nolint:forbidigo
-	require.Equal(t, config.CurvePreferences, fipsCurvePreferences) //nolint:forbidigo
-	require.False(t, config.InsecureSkipVerify)                     //nolint:forbidigo
-}
-
-func TestCreateTLSConfigurationFromBytes(t *testing.T) {
-	// No TLS
-	config, err := CreateTLSConfigurationFromBytes(false, nil, nil, nil, false, false)
-	require.NoError(t, err)
-	require.Nil(t, config)
-
-	// Skip TLS client/server verifications
-	config, err = CreateTLSConfigurationFromBytes(true, nil, nil, nil, true, true)
-	require.NoError(t, err)
-	require.NotNil(t, config)
-
-	// Empty TLS
-	config, err = CreateTLSConfigurationFromBytes(true, nil, nil, nil, false, false)
-	require.Error(t, err)
-	require.Nil(t, config)
-}
-
-func TestCreateTLSConfigurationFromDisk(t *testing.T) {
-	// No TLS
-	config, err := CreateTLSConfigurationFromDisk(portainer.TLSConfiguration{})
-	require.NoError(t, err)
-	require.Nil(t, config)
-
-	// Skip TLS verifications
-	config, err = CreateTLSConfigurationFromDisk(portainer.TLSConfiguration{
-		TLS:           true,
-		TLSSkipVerify: true,
-	})
-	require.NoError(t, err)
-	require.NotNil(t, config)
-}
-
-func TestCreateTLSConfigurationFromDiskFIPS(t *testing.T) {
-	fips := true
-
-	// Skipping TLS verifications cannot be done in FIPS mode
-	config, err := createTLSConfigurationFromDisk(fips, portainer.TLSConfiguration{
-		TLS:           true,
-		TLSSkipVerify: true,
-	})
-	require.NoError(t, err)
-	require.NotNil(t, config)
-	require.False(t, config.InsecureSkipVerify) //nolint:forbidigo
-}

api/database/boltdb/db.go

@@ -1,476 +0,0 @@
-package boltdb
-
-import (
-	"encoding/binary"
-	"errors"
-	"fmt"
-	"io"
-	"math"
-	"os"
-	"path"
-	"strconv"
-	"time"
-
-	portainer "github.com/portainer/portainer/api"
-	dserrors "github.com/portainer/portainer/api/dataservices/errors"
-
-	"github.com/rs/zerolog/log"
-	bolt "go.etcd.io/bbolt"
-)
-
-const (
-	DatabaseFileName          = "portainer.db"
-	EncryptedDatabaseFileName = "portainer.edb"
-
-	txMaxSize       = 65536
-	compactedSuffix = ".compacted"
-)
-
-var (
-	ErrHaveEncryptedAndUnencrypted = errors.New("Portainer has detected both an encrypted and un-encrypted database and cannot start.  Only one database should exist")
-	ErrHaveEncryptedWithNoKey      = errors.New("The portainer database is encrypted, but no secret was loaded")
-)
-
-type DbConnection struct {
-	Path            string
-	MaxBatchSize    int
-	MaxBatchDelay   time.Duration
-	InitialMmapSize int
-	EncryptionKey   []byte
-	isEncrypted     bool
-	Compact         bool
-
-	*bolt.DB
-}
-
-// GetDatabaseFileName get the database filename
-func (connection *DbConnection) GetDatabaseFileName() string {
-	if connection.IsEncryptedStore() {
-		return EncryptedDatabaseFileName
-	}
-
-	return DatabaseFileName
-}
-
-// GetDataseFilePath get the path + filename for the database file
-func (connection *DbConnection) GetDatabaseFilePath() string {
-	if connection.IsEncryptedStore() {
-		return path.Join(connection.Path, EncryptedDatabaseFileName)
-	}
-
-	return path.Join(connection.Path, DatabaseFileName)
-}
-
-// GetStorePath get the filename and path for the database file
-func (connection *DbConnection) GetStorePath() string {
-	return connection.Path
-}
-
-func (connection *DbConnection) GetDatabaseFileSize() (int64, error) {
-	file, err := os.Stat(connection.GetDatabaseFilePath())
-	if err != nil {
-		return 0, fmt.Errorf("Failed to stat database file path: %s err: %w", connection.GetDatabaseFilePath(), err)
-	}
-
-	return file.Size(), nil
-}
-
-func (connection *DbConnection) SetEncrypted(flag bool) {
-	connection.isEncrypted = flag
-}
-
-// Return true if the database is encrypted
-func (connection *DbConnection) IsEncryptedStore() bool {
-	return connection.getEncryptionKey() != nil
-}
-
-// NeedsEncryptionMigration returns true if database encryption is enabled and
-// we have an un-encrypted DB that requires migration to an encrypted DB
-func (connection *DbConnection) NeedsEncryptionMigration() (bool, error) {
-	// Cases:  Note, we need to check both portainer.db and portainer.edb
-	// to determine if it's a new store.   We only need to differentiate between cases 2,3 and 5
-
-	// 1) portainer.edb + key     => False
-	// 2) portainer.edb + no key  => ERROR Fatal!
-	// 3) portainer.db  + key     => True  (needs migration)
-	// 4) portainer.db  + no key  => False
-	// 5) NoDB (new)    + key     => False
-	// 6) NoDB (new)    + no key  => False
-	// 7) portainer.db & portainer.edb => ERROR Fatal!
-
-	// If we have a loaded encryption key, always set encrypted
-	if connection.EncryptionKey != nil {
-		connection.SetEncrypted(true)
-	}
-
-	// Check for portainer.db
-	dbFile := path.Join(connection.Path, DatabaseFileName)
-	_, err := os.Stat(dbFile)
-	haveDbFile := err == nil
-
-	// Check for portainer.edb
-	edbFile := path.Join(connection.Path, EncryptedDatabaseFileName)
-	_, err = os.Stat(edbFile)
-	haveEdbFile := err == nil
-
-	if haveDbFile && haveEdbFile {
-		// 7 - encrypted and unencrypted db?
-		return false, ErrHaveEncryptedAndUnencrypted
-	}
-
-	if haveDbFile && connection.EncryptionKey != nil {
-		// 3 - needs migration
-		return true, nil
-	}
-
-	if haveEdbFile && connection.EncryptionKey == nil {
-		// 2 - encrypted db, but no key?
-		return false, ErrHaveEncryptedWithNoKey
-	}
-
-	// 1, 4, 5, 6
-	return false, nil
-}
-
-// Open opens and initializes the BoltDB database.
-func (connection *DbConnection) Open() error {
-	log.Info().Str("filename", connection.GetDatabaseFileName()).Msg("loading PortainerDB")
-
-	databasePath := connection.GetDatabaseFilePath()
-	db, err := bolt.Open(databasePath, 0600, connection.boltOptions(connection.Compact))
-	if err != nil {
-		return err
-	}
-
-	db.MaxBatchSize = connection.MaxBatchSize
-	db.MaxBatchDelay = connection.MaxBatchDelay
-	connection.DB = db
-
-	if connection.Compact {
-		log.Info().Msg("compacting database")
-		if err := connection.compact(); err != nil {
-			log.Error().Err(err).Msg("failed to compact database")
-
-			// Close the read-only database and re-open in read-write mode
-			if err := connection.Close(); err != nil {
-				log.Warn().Err(err).Msg("failure to close the database after failed compaction")
-			}
-
-			connection.Compact = false
-
-			return connection.Open()
-		} else {
-			log.Info().Msg("database compaction completed")
-		}
-	}
-
-	return nil
-}
-
-// Close closes the BoltDB database.
-// Safe to being called multiple times.
-func (connection *DbConnection) Close() error {
-	log.Info().Msg("closing PortainerDB")
-
-	if connection.DB != nil {
-		return connection.DB.Close()
-	}
-
-	return nil
-}
-
-func (connection *DbConnection) txFn(fn func(portainer.Transaction) error) func(*bolt.Tx) error {
-	return func(tx *bolt.Tx) error {
-		return fn(&DbTransaction{conn: connection, tx: tx})
-	}
-}
-
-// UpdateTx executes the given function inside a read-write transaction
-func (connection *DbConnection) UpdateTx(fn func(portainer.Transaction) error) error {
-	if connection.MaxBatchDelay > 0 && connection.MaxBatchSize > 1 {
-		return connection.Batch(connection.txFn(fn))
-	}
-
-	return connection.Update(connection.txFn(fn))
-}
-
-// ViewTx executes the given function inside a read-only transaction
-func (connection *DbConnection) ViewTx(fn func(portainer.Transaction) error) error {
-	return connection.View(connection.txFn(fn))
-}
-
-// BackupTo backs up db to a provided writer.
-// It does hot backup and doesn't block other database reads and writes
-func (connection *DbConnection) BackupTo(w io.Writer) error {
-	return connection.View(func(tx *bolt.Tx) error {
-		_, err := tx.WriteTo(w)
-
-		return err
-	})
-}
-
-func (connection *DbConnection) ExportRaw(filename string) error {
-	databasePath := connection.GetDatabaseFilePath()
-	if _, err := os.Stat(databasePath); err != nil {
-		return fmt.Errorf("stat on %s failed, error: %w", databasePath, err)
-	}
-
-	b, err := connection.ExportJSON(databasePath, true)
-	if err != nil {
-		return err
-	}
-
-	return os.WriteFile(filename, b, 0600)
-}
-
-// ConvertToKey returns an 8-byte big endian representation of v.
-// This function is typically used for encoding integer IDs to byte slices
-// so that they can be used as BoltDB keys.
-func (connection *DbConnection) ConvertToKey(v int) []byte {
-	b := make([]byte, 8)
-	binary.BigEndian.PutUint64(b, uint64(v))
-
-	return b
-}
-
-// keyToString Converts a key to a string value suitable for logging
-func keyToString(b []byte) string {
-	if len(b) != 8 {
-		return string(b)
-	}
-
-	v := binary.BigEndian.Uint64(b)
-	if v <= math.MaxInt32 {
-		return strconv.FormatUint(v, 10)
-	}
-
-	return string(b)
-}
-
-// CreateBucket is a generic function used to create a bucket inside a database.
-func (connection *DbConnection) SetServiceName(bucketName string) error {
-	return connection.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.SetServiceName(bucketName)
-	})
-}
-
-// GetObject is a generic function used to retrieve an unmarshalled object from a database.
-func (connection *DbConnection) GetObject(bucketName string, key []byte, object any) error {
-	return connection.ViewTx(func(tx portainer.Transaction) error {
-		return tx.GetObject(bucketName, key, object)
-	})
-}
-
-func (connection *DbConnection) GetRawBytes(bucketName string, key []byte) ([]byte, error) {
-	var value []byte
-
-	err := connection.ViewTx(func(tx portainer.Transaction) error {
-		var err error
-		value, err = tx.GetRawBytes(bucketName, key)
-
-		return err
-	})
-
-	return value, err
-}
-
-func (connection *DbConnection) KeyExists(bucketName string, key []byte) (bool, error) {
-	var exists bool
-
-	err := connection.ViewTx(func(tx portainer.Transaction) error {
-		var err error
-		exists, err = tx.KeyExists(bucketName, key)
-
-		return err
-	})
-
-	return exists, err
-}
-
-func (connection *DbConnection) getEncryptionKey() []byte {
-	if !connection.isEncrypted {
-		return nil
-	}
-
-	return connection.EncryptionKey
-}
-
-// UpdateObject is a generic function used to update an object inside a database.
-func (connection *DbConnection) UpdateObject(bucketName string, key []byte, object any) error {
-	return connection.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.UpdateObject(bucketName, key, object)
-	})
-}
-
-// UpdateObjectFunc is a generic function used to update an object safely without race conditions.
-func (connection *DbConnection) UpdateObjectFunc(bucketName string, key []byte, object any, updateFn func()) error {
-	return connection.Batch(func(tx *bolt.Tx) error {
-		bucket := tx.Bucket([]byte(bucketName))
-
-		data := bucket.Get(key)
-		if data == nil {
-			return fmt.Errorf("%w (bucket=%s, key=%s)", dserrors.ErrObjectNotFound, bucketName, keyToString(key))
-		}
-
-		err := connection.UnmarshalObject(data, object)
-		if err != nil {
-			return err
-		}
-
-		updateFn()
-
-		data, err = connection.MarshalObject(object)
-		if err != nil {
-			return err
-		}
-
-		return bucket.Put(key, data)
-	})
-}
-
-// DeleteObject is a generic function used to delete an object inside a database.
-func (connection *DbConnection) DeleteObject(bucketName string, key []byte) error {
-	return connection.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.DeleteObject(bucketName, key)
-	})
-}
-
-// DeleteAllObjects delete all objects where matching() returns (id, ok).
-// TODO: think about how to return the error inside (maybe change ok to type err, and use "notfound"?
-func (connection *DbConnection) DeleteAllObjects(bucketName string, obj any, matching func(o any) (id int, ok bool)) error {
-	return connection.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.DeleteAllObjects(bucketName, obj, matching)
-	})
-}
-
-// GetNextIdentifier is a generic function that returns the specified bucket identifier incremented by 1.
-func (connection *DbConnection) GetNextIdentifier(bucketName string) int {
-	var identifier int
-
-	_ = connection.UpdateTx(func(tx portainer.Transaction) error {
-		identifier = tx.GetNextIdentifier(bucketName)
-		return nil
-	})
-
-	return identifier
-}
-
-// CreateObject creates a new object in the bucket, using the next bucket sequence id
-func (connection *DbConnection) CreateObject(bucketName string, fn func(uint64) (int, any)) error {
-	return connection.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.CreateObject(bucketName, fn)
-	})
-}
-
-// CreateObjectWithId creates a new object in the bucket, using the specified id
-func (connection *DbConnection) CreateObjectWithId(bucketName string, id int, obj any) error {
-	return connection.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.CreateObjectWithId(bucketName, id, obj)
-	})
-}
-
-// CreateObjectWithStringId creates a new object in the bucket, using the specified id
-func (connection *DbConnection) CreateObjectWithStringId(bucketName string, id []byte, obj any) error {
-	return connection.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.CreateObjectWithStringId(bucketName, id, obj)
-	})
-}
-
-func (connection *DbConnection) GetAll(bucketName string, obj any, appendFn func(o any) (any, error)) error {
-	return connection.ViewTx(func(tx portainer.Transaction) error {
-		return tx.GetAll(bucketName, obj, appendFn)
-	})
-}
-
-func (connection *DbConnection) GetAllWithKeyPrefix(bucketName string, keyPrefix []byte, obj any, appendFn func(o any) (any, error)) error {
-	return connection.ViewTx(func(tx portainer.Transaction) error {
-		return tx.GetAllWithKeyPrefix(bucketName, keyPrefix, obj, appendFn)
-	})
-}
-
-// BackupMetadata will return a copy of the boltdb sequence numbers for all buckets.
-func (connection *DbConnection) BackupMetadata() (map[string]any, error) {
-	buckets := map[string]any{}
-
-	err := connection.View(func(tx *bolt.Tx) error {
-		return tx.ForEach(func(name []byte, bucket *bolt.Bucket) error {
-			bucketName := string(name)
-			seqId := bucket.Sequence()
-			buckets[bucketName] = int(seqId)
-
-			return nil
-		})
-	})
-
-	return buckets, err
-}
-
-// RestoreMetadata will restore the boltdb sequence numbers for all buckets.
-func (connection *DbConnection) RestoreMetadata(s map[string]any) error {
-	var err error
-
-	for bucketName, v := range s {
-		id, ok := v.(float64) // JSON ints are unmarshalled to interface as float64. See: https://pkg.go.dev/encoding/json#Decoder.Decode
-		if !ok {
-			log.Error().Str("bucket", bucketName).Msg("failed to restore metadata to bucket, skipped")
-
-			continue
-		}
-
-		err = connection.Batch(func(tx *bolt.Tx) error {
-			bucket, err := tx.CreateBucketIfNotExists([]byte(bucketName))
-			if err != nil {
-				return err
-			}
-
-			return bucket.SetSequence(uint64(id))
-		})
-	}
-
-	return err
-}
-
-// compact attempts to compact the database and replace it iff it succeeds
-func (connection *DbConnection) compact() (err error) {
-	compactedPath := connection.GetDatabaseFilePath() + compactedSuffix
-
-	if err := os.Remove(compactedPath); err != nil && !errors.Is(err, os.ErrNotExist) {
-		return fmt.Errorf("failure to remove an existing compacted database: %w", err)
-	}
-
-	compactedDB, err := bolt.Open(compactedPath, 0o600, connection.boltOptions(false))
-	if err != nil {
-		return fmt.Errorf("failure to create the compacted database: %w", err)
-	}
-
-	compactedDB.MaxBatchSize = connection.MaxBatchSize
-	compactedDB.MaxBatchDelay = connection.MaxBatchDelay
-
-	if err := bolt.Compact(compactedDB, connection.DB, txMaxSize); err != nil {
-		return fmt.Errorf("failure to compact the database: %w",
-			errors.Join(err, compactedDB.Close(), os.Remove(compactedPath)))
-	}
-
-	if err := os.Rename(compactedPath, connection.GetDatabaseFilePath()); err != nil {
-		return fmt.Errorf("failure to move the compacted database: %w",
-			errors.Join(err, compactedDB.Close(), os.Remove(compactedPath)))
-	}
-
-	if err := connection.Close(); err != nil {
-		log.Warn().Err(err).Msg("failure to close the database after compaction")
-	}
-
-	connection.DB = compactedDB
-
-	return nil
-}
-
-func (connection *DbConnection) boltOptions(readOnly bool) *bolt.Options {
-	return &bolt.Options{
-		Timeout:         1 * time.Second,
-		InitialMmapSize: connection.InitialMmapSize,
-		FreelistType:    bolt.FreelistMapType,
-		NoFreelistSync:  true,
-		ReadOnly:        readOnly,
-	}
-}

api/database/boltdb/db_test.go

@@ -1,200 +0,0 @@
-package boltdb
-
-import (
-	"os"
-	"path"
-	"testing"
-
-	"github.com/portainer/portainer/api/filesystem"
-
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-	"go.etcd.io/bbolt"
-)
-
-func Test_NeedsEncryptionMigration(t *testing.T) {
-	// Test the specific scenarios mentioned in NeedsEncryptionMigration
-
-	// i.e.
-	// Cases:  Note, we need to check both portainer.db and portainer.edb
-	// to determine if it's a new store.   We only need to differentiate between cases 2,3 and 5
-
-	// 1) portainer.edb + key     => False
-	// 2) portainer.edb + no key  => ERROR Fatal!
-	// 3) portainer.db  + key     => True  (needs migration)
-	// 4) portainer.db  + no key  => False
-	// 5) NoDB (new)    + key     => False
-	// 6) NoDB (new)    + no key  => False
-	// 7) portainer.db & portainer.edb (key not important) => ERROR Fatal!
-
-	is := assert.New(t)
-	dir := t.TempDir()
-
-	cases := []struct {
-		name         string
-		dbname       string
-		key          bool
-		expectError  error
-		expectResult bool
-	}{
-		{
-			name:         "portainer.edb + key",
-			dbname:       EncryptedDatabaseFileName,
-			key:          true,
-			expectError:  nil,
-			expectResult: false,
-		},
-		{
-			name:         "portainer.db + key (migration needed)",
-			dbname:       DatabaseFileName,
-			key:          true,
-			expectError:  nil,
-			expectResult: true,
-		},
-		{
-			name:         "portainer.db + no key",
-			dbname:       DatabaseFileName,
-			key:          false,
-			expectError:  nil,
-			expectResult: false,
-		},
-		{
-			name:         "NoDB (new) + key",
-			dbname:       "",
-			key:          false,
-			expectError:  nil,
-			expectResult: false,
-		},
-		{
-			name:         "NoDB (new) + no key",
-			dbname:       "",
-			key:          false,
-			expectError:  nil,
-			expectResult: false,
-		},
-
-		// error tests
-		{
-			name:         "portainer.edb + no key",
-			dbname:       EncryptedDatabaseFileName,
-			key:          false,
-			expectError:  ErrHaveEncryptedWithNoKey,
-			expectResult: false,
-		},
-		{
-			name:         "portainer.db & portainer.edb",
-			dbname:       "both",
-			key:          true,
-			expectError:  ErrHaveEncryptedAndUnencrypted,
-			expectResult: false,
-		},
-	}
-
-	for _, tc := range cases {
-		t.Run(tc.name, func(t *testing.T) {
-			connection := DbConnection{Path: dir}
-
-			if tc.dbname == "both" {
-				// Special case.  If portainer.db and portainer.edb exist.
-				dbFile1 := path.Join(connection.Path, DatabaseFileName)
-				f, _ := os.Create(dbFile1)
-
-				err := f.Close()
-				require.NoError(t, err)
-
-				defer func() {
-					err := os.Remove(dbFile1)
-					require.NoError(t, err)
-				}()
-
-				dbFile2 := path.Join(connection.Path, EncryptedDatabaseFileName)
-				f, _ = os.Create(dbFile2)
-
-				err = f.Close()
-				require.NoError(t, err)
-
-				defer func() {
-					err := os.Remove(dbFile2)
-					require.NoError(t, err)
-				}()
-			} else if tc.dbname != "" {
-				dbFile := path.Join(connection.Path, tc.dbname)
-				f, _ := os.Create(dbFile)
-
-				err := f.Close()
-				require.NoError(t, err)
-
-				defer func() {
-					err := os.Remove(dbFile)
-					require.NoError(t, err)
-				}()
-			}
-
-			if tc.key {
-				connection.EncryptionKey = []byte("secret")
-			}
-
-			result, err := connection.NeedsEncryptionMigration()
-
-			is.Equal(tc.expectError, err, "Fatal Error failure. Test: %s", tc.name)
-			is.Equal(result, tc.expectResult, "Failed test: %s", tc.name)
-		})
-	}
-}
-
-func TestDBCompaction(t *testing.T) {
-	db := &DbConnection{Path: t.TempDir()}
-
-	err := db.Open()
-	require.NoError(t, err)
-
-	err = db.Update(func(tx *bbolt.Tx) error {
-		b, err := tx.CreateBucketIfNotExists([]byte("testbucket"))
-		if err != nil {
-			return err
-		}
-
-		err = b.Put([]byte("key"), []byte("value"))
-		require.NoError(t, err)
-
-		return nil
-	})
-	require.NoError(t, err)
-
-	err = db.Close()
-	require.NoError(t, err)
-
-	// Reopen the DB to trigger compaction
-	db.Compact = true
-	err = db.Open()
-	require.NoError(t, err)
-
-	// Check that the data is still there
-	err = db.View(func(tx *bbolt.Tx) error {
-		b := tx.Bucket([]byte("testbucket"))
-		if b == nil {
-			return nil
-		}
-
-		val := b.Get([]byte("key"))
-		require.Equal(t, []byte("value"), val)
-
-		return nil
-	})
-	require.NoError(t, err)
-
-	err = db.Close()
-	require.NoError(t, err)
-
-	// Failures
-	compactedPath := db.GetDatabaseFilePath() + compactedSuffix
-	err = os.Mkdir(compactedPath, 0o755)
-	require.NoError(t, err)
-
-	f, err := os.Create(filesystem.JoinPaths(compactedPath, "somefile"))
-	require.NoError(t, err)
-	require.NoError(t, f.Close())
-
-	err = db.Open()
-	require.NoError(t, err)
-}

api/database/boltdb/export.go

@@ -1,108 +0,0 @@
-package boltdb
-
-import (
-	"time"
-
-	"github.com/portainer/portainer/api/logs"
-	"github.com/rs/zerolog/log"
-	"github.com/segmentio/encoding/json"
-	bolt "go.etcd.io/bbolt"
-)
-
-func backupMetadata(connection *bolt.DB) (map[string]any, error) {
-	buckets := map[string]any{}
-
-	err := connection.View(func(tx *bolt.Tx) error {
-		err := tx.ForEach(func(name []byte, bucket *bolt.Bucket) error {
-			bucketName := string(name)
-			seqId := bucket.Sequence()
-			buckets[bucketName] = int(seqId)
-			return nil
-		})
-
-		return err
-	})
-
-	return buckets, err
-}
-
-// ExportJSON creates a JSON representation from a DbConnection. You can include
-// the database's metadata or ignore it. Ensure the database is closed before
-// using this function.
-// inspired by github.com/konoui/boltdb-exporter (which has no license)
-// but very much simplified, based on how we use boltdb
-func (c *DbConnection) ExportJSON(databasePath string, metadata bool) ([]byte, error) {
-	log.Debug().Str("databasePath", databasePath).Msg("exportJson")
-
-	connection, err := bolt.Open(databasePath, 0600, &bolt.Options{Timeout: 1 * time.Second, ReadOnly: true})
-	if err != nil {
-		return []byte("{}"), err
-	}
-	defer logs.CloseAndLogErr(connection)
-
-	backup := make(map[string]any)
-	if metadata {
-		meta, err := backupMetadata(connection)
-		if err != nil {
-			log.Error().Err(err).Msg("failed exporting metadata")
-		}
-
-		backup["__metadata"] = meta
-	}
-
-	if err := connection.View(func(tx *bolt.Tx) error {
-		return tx.ForEach(func(name []byte, bucket *bolt.Bucket) error {
-			bucketName := string(name)
-			var list []any
-			version := make(map[string]string)
-			cursor := bucket.Cursor()
-			for k, v := cursor.First(); k != nil; k, v = cursor.Next() {
-				if v == nil {
-					continue
-				}
-
-				var obj any
-				err := c.UnmarshalObject(v, &obj)
-				if err != nil {
-					log.Error().
-						Str("bucket", bucketName).
-						Str("object", string(v)).
-						Err(err).
-						Msg("failed to unmarshal")
-
-					obj = v
-				}
-
-				if bucketName == "version" {
-					version[string(k)] = string(v)
-				} else {
-					list = append(list, obj)
-				}
-			}
-
-			if bucketName == "version" {
-				backup[bucketName] = version
-				return nil
-			}
-
-			if bucketName == "ssl" ||
-				bucketName == "settings" ||
-				bucketName == "tunnel_server" {
-				backup[bucketName] = nil
-				if len(list) > 0 {
-					backup[bucketName] = list[0]
-				}
-
-				return nil
-			}
-
-			backup[bucketName] = list
-
-			return nil
-		})
-	}); err != nil {
-		return []byte("{}"), err
-	}
-
-	return json.MarshalIndent(backup, "", "  ")
-}

api/database/boltdb/json.go

@@ -1,106 +0,0 @@
-package boltdb
-
-import (
-	"bytes"
-	"crypto/aes"
-	"crypto/cipher"
-
-	"github.com/pkg/errors"
-	"github.com/segmentio/encoding/json"
-)
-
-var errEncryptedStringTooShort = errors.New("encrypted string too short")
-
-// MarshalObject encodes an object to binary format
-func (connection *DbConnection) MarshalObject(object any) ([]byte, error) {
-	buf := &bytes.Buffer{}
-
-	// Special case for the VERSION bucket. Here we're not using json
-	if v, ok := object.(string); ok {
-		buf.WriteString(v)
-	} else {
-		enc := json.NewEncoder(buf)
-		enc.SetSortMapKeys(false)
-		enc.SetAppendNewline(false)
-
-		if err := enc.Encode(object); err != nil {
-			return nil, err
-		}
-	}
-
-	if connection.getEncryptionKey() == nil {
-		return buf.Bytes(), nil
-	}
-
-	return encrypt(buf.Bytes(), connection.getEncryptionKey())
-}
-
-// UnmarshalObject decodes an object from binary data
-func (connection *DbConnection) UnmarshalObject(data []byte, object any) error {
-	var err error
-	if connection.getEncryptionKey() != nil {
-		data, err = decrypt(data, connection.getEncryptionKey())
-		if err != nil {
-			return errors.Wrap(err, "Failed decrypting object")
-		}
-	}
-
-	if err := json.Unmarshal(data, object); err != nil {
-		// Special case for the VERSION bucket. Here we're not using json
-		// So we need to return it as a string
-		s, ok := object.(*string)
-		if !ok {
-			return errors.Wrap(err, "Failed unmarshalling object")
-		}
-
-		*s = string(data)
-	}
-
-	return err
-}
-
-// mmm, don't have a KMS .... aes GCM seems the most likely from
-// https://gist.github.com/atoponce/07d8d4c833873be2f68c34f9afc5a78a#symmetric-encryption
-
-func encrypt(plaintext []byte, passphrase []byte) (encrypted []byte, err error) {
-	block, err := aes.NewCipher(passphrase)
-	if err != nil {
-		return encrypted, err
-	}
-
-	// NewGCMWithRandomNonce in go 1.24 handles setting up the nonce and adding it to the encrypted output
-	gcm, err := cipher.NewGCMWithRandomNonce(block)
-	if err != nil {
-		return encrypted, err
-	}
-
-	return gcm.Seal(nil, nil, plaintext, nil), nil
-}
-
-func decrypt(encrypted []byte, passphrase []byte) (plaintextByte []byte, err error) {
-	if string(encrypted) == "false" {
-		return []byte("false"), nil
-	}
-
-	block, err := aes.NewCipher(passphrase)
-	if err != nil {
-		return encrypted, errors.Wrap(err, "Error creating cypher block")
-	}
-
-	// NewGCMWithRandomNonce in go 1.24 handles reading the nonce from the encrypted input for us
-	gcm, err := cipher.NewGCMWithRandomNonce(block)
-	if err != nil {
-		return encrypted, errors.Wrap(err, "Error creating GCM")
-	}
-
-	if len(encrypted) < gcm.NonceSize() {
-		return encrypted, errEncryptedStringTooShort
-	}
-
-	plaintextByte, err = gcm.Open(nil, nil, encrypted, nil)
-	if err != nil {
-		return encrypted, errors.Wrap(err, "Error decrypting text")
-	}
-
-	return plaintextByte, err
-}

api/database/boltdb/json_test.go

@@ -1,275 +0,0 @@
-package boltdb
-
-import (
-	"crypto/aes"
-	"crypto/cipher"
-	"crypto/rand"
-	"crypto/sha256"
-	"encoding/base64"
-	"fmt"
-	"io"
-	"testing"
-
-	"github.com/google/uuid"
-	"github.com/pkg/errors"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-const (
-	jsonobject = `{"LogoURL":"","BlackListedLabels":[],"AuthenticationMethod":1,"InternalAuthSettings": {"RequiredPasswordLength": 12}"LDAPSettings":{"AnonymousMode":true,"ReaderDN":"","URL":"","TLSConfig":{"TLS":false,"TLSSkipVerify":false},"StartTLS":false,"SearchSettings":[{"BaseDN":"","Filter":"","UserNameAttribute":""}],"GroupSearchSettings":[{"GroupBaseDN":"","GroupFilter":"","GroupAttribute":""}],"AutoCreateUsers":true},"OAuthSettings":{"ClientID":"","AccessTokenURI":"","AuthorizationURI":"","ResourceURI":"","RedirectURI":"","UserIdentifier":"","Scopes":"","OAuthAutoCreateUsers":false,"DefaultTeamID":0,"SSO":true,"LogoutURI":"","KubeSecretKey":"j0zLVtY/lAWBk62ByyF0uP80SOXaitsABP0TTJX8MhI="},"OpenAMTConfiguration":{"Enabled":false,"MPSServer":"","MPSUser":"","MPSPassword":"","MPSToken":"","CertFileContent":"","CertFileName":"","CertFilePassword":"","DomainName":""},"FeatureFlagSettings":{},"SnapshotInterval":"5m","TemplatesURL":"https://raw.githubusercontent.com/portainer/templates/master/templates-2.0.json","EdgeAgentCheckinInterval":5,"EnableEdgeComputeFeatures":false,"UserSessionTimeout":"8h","KubeconfigExpiry":"0","HelmRepositoryURL":"https://charts.bitnami.com/bitnami","KubectlShellImage":"portainer/kubectl-shell","DisplayDonationHeader":false,"DisplayExternalContributors":false,"EnableHostManagementFeatures":false,"AllowVolumeBrowserForRegularUsers":false,"AllowBindMountsForRegularUsers":false,"AllowPrivilegedModeForRegularUsers":false,"AllowHostNamespaceForRegularUsers":false,"AllowStackManagementForRegularUsers":false,"AllowDeviceMappingForRegularUsers":false,"AllowContainerCapabilitiesForRegularUsers":false}`
-	passphrase = "my secret key"
-)
-
-func secretToEncryptionKey(passphrase string) []byte {
-	hash := sha256.Sum256([]byte(passphrase))
-	return hash[:]
-}
-
-func Test_MarshalObjectUnencrypted(t *testing.T) {
-	is := assert.New(t)
-
-	uuid := uuid.New()
-
-	tests := []struct {
-		object   any
-		expected string
-	}{
-		{
-			object:   nil,
-			expected: `null`,
-		},
-		{
-			object:   true,
-			expected: `true`,
-		},
-		{
-			object:   false,
-			expected: `false`,
-		},
-		{
-			object:   123,
-			expected: `123`,
-		},
-		{
-			object:   "456",
-			expected: "456",
-		},
-		{
-			object:   uuid,
-			expected: "\"" + uuid.String() + "\"",
-		},
-		{
-			object:   uuid.String(),
-			expected: uuid.String(),
-		},
-		{
-			object:   map[string]any{"key": "value"},
-			expected: `{"key":"value"}`,
-		},
-		{
-			object:   []bool{true, false},
-			expected: `[true,false]`,
-		},
-		{
-			object:   []int{1, 2, 3},
-			expected: `[1,2,3]`,
-		},
-		{
-			object:   []string{"1", "2", "3"},
-			expected: `["1","2","3"]`,
-		},
-		{
-			object:   []map[string]any{{"key1": "value1"}, {"key2": "value2"}},
-			expected: `[{"key1":"value1"},{"key2":"value2"}]`,
-		},
-		{
-			object:   []any{1, "2", false, map[string]any{"key1": "value1"}},
-			expected: `[1,"2",false,{"key1":"value1"}]`,
-		},
-	}
-
-	conn := DbConnection{}
-
-	for _, test := range tests {
-		t.Run(fmt.Sprintf("%s -> %s", test.object, test.expected), func(t *testing.T) {
-			data, err := conn.MarshalObject(test.object)
-			require.NoError(t, err)
-			is.Equal(test.expected, string(data))
-		})
-	}
-}
-
-func Test_UnMarshalObjectUnencrypted(t *testing.T) {
-	is := assert.New(t)
-
-	// Based on actual data entering and what we expect out of the function
-
-	tests := []struct {
-		object   []byte
-		expected string
-	}{
-		{
-			object:   []byte(""),
-			expected: "",
-		},
-		{
-			object:   []byte("35"),
-			expected: "35",
-		},
-		{
-			// An unmarshalled byte string should return the same without error
-			object:   []byte("9ca4a1dd-a439-4593-b386-a7dfdc2e9fc6"),
-			expected: "9ca4a1dd-a439-4593-b386-a7dfdc2e9fc6",
-		},
-		{
-			// An un-marshalled json object string should return the same as a string without error also
-			object:   []byte(jsonobject),
-			expected: jsonobject,
-		},
-	}
-
-	conn := DbConnection{}
-
-	for _, test := range tests {
-		t.Run(fmt.Sprintf("%s -> %s", test.object, test.expected), func(t *testing.T) {
-			var object string
-			err := conn.UnmarshalObject(test.object, &object)
-			require.NoError(t, err)
-			is.Equal(test.expected, object)
-		})
-	}
-}
-
-func Test_ObjectMarshallingEncrypted(t *testing.T) {
-	is := assert.New(t)
-
-	// Based on actual data entering and what we expect out of the function
-
-	tests := []struct {
-		object   []byte
-		expected string
-	}{
-		{
-			object: []byte(""),
-		},
-		{
-			object: []byte("35"),
-		},
-		{
-			// An unmarshalled byte string should return the same without error
-			object: []byte("9ca4a1dd-a439-4593-b386-a7dfdc2e9fc6"),
-		},
-		{
-			// An un-marshalled json object string should return the same as a string without error also
-			object: []byte(jsonobject),
-		},
-	}
-
-	key := secretToEncryptionKey(passphrase)
-	conn := DbConnection{EncryptionKey: key, isEncrypted: true}
-	for _, test := range tests {
-		t.Run(fmt.Sprintf("%s -> %s", test.object, test.expected), func(t *testing.T) {
-
-			data, err := conn.MarshalObject(test.object)
-			require.NoError(t, err)
-
-			var object []byte
-			err = conn.UnmarshalObject(data, &object)
-
-			require.NoError(t, err)
-			is.Equal(test.object, object)
-		})
-	}
-}
-
-func Test_NonceSources(t *testing.T) {
-	// ensure that the new go 1.24 NewGCMWithRandomNonce works correctly with
-	// the old way of creating and including the nonce
-
-	encryptOldFn := func(plaintext []byte, passphrase []byte) (encrypted []byte, err error) {
-		block, _ := aes.NewCipher(passphrase)
-		gcm, err := cipher.NewGCM(block)
-		if err != nil {
-			return encrypted, err
-		}
-
-		nonce := make([]byte, gcm.NonceSize())
-		if _, err := io.ReadFull(rand.Reader, nonce); err != nil {
-			return encrypted, err
-		}
-
-		return gcm.Seal(nonce, nonce, plaintext, nil), nil
-	}
-
-	decryptOldFn := func(encrypted []byte, passphrase []byte) (plaintext []byte, err error) {
-		block, err := aes.NewCipher(passphrase)
-		if err != nil {
-			return encrypted, errors.Wrap(err, "Error creating cypher block")
-		}
-
-		gcm, err := cipher.NewGCM(block)
-		if err != nil {
-			return encrypted, errors.Wrap(err, "Error creating GCM")
-		}
-
-		nonceSize := gcm.NonceSize()
-		if len(encrypted) < nonceSize {
-			return encrypted, errEncryptedStringTooShort
-		}
-
-		nonce, ciphertextByteClean := encrypted[:nonceSize], encrypted[nonceSize:]
-
-		plaintext, err = gcm.Open(nil, nonce, ciphertextByteClean, nil)
-		if err != nil {
-			return encrypted, errors.Wrap(err, "Error decrypting text")
-		}
-
-		return plaintext, err
-	}
-
-	encryptNewFn := encrypt
-	decryptNewFn := decrypt
-
-	passphrase := make([]byte, 32)
-	_, err := io.ReadFull(rand.Reader, passphrase)
-	require.NoError(t, err)
-
-	junk := make([]byte, 1024)
-	_, err = io.ReadFull(rand.Reader, junk)
-	require.NoError(t, err)
-
-	junkEnc := make([]byte, base64.StdEncoding.EncodedLen(len(junk)))
-	base64.StdEncoding.Encode(junkEnc, junk)
-
-	cases := [][]byte{
-		[]byte("test"),
-		[]byte("35"),
-		[]byte("9ca4a1dd-a439-4593-b386-a7dfdc2e9fc6"),
-		[]byte(jsonobject),
-		passphrase,
-		junk,
-		junkEnc,
-	}
-
-	for _, plain := range cases {
-		var enc, dec []byte
-		var err error
-
-		enc, err = encryptOldFn(plain, passphrase)
-		require.NoError(t, err)
-
-		dec, err = decryptNewFn(enc, passphrase)
-		require.NoError(t, err)
-
-		require.Equal(t, plain, dec)
-
-		enc, err = encryptNewFn(plain, passphrase)
-		require.NoError(t, err)
-
-		dec, err = decryptOldFn(enc, passphrase)
-		require.NoError(t, err)
-
-		require.Equal(t, plain, dec)
-	}
-}

api/database/boltdb/tx.go

@@ -1,179 +0,0 @@
-package boltdb
-
-import (
-	"bytes"
-	"fmt"
-
-	dserrors "github.com/portainer/portainer/api/dataservices/errors"
-
-	"github.com/pkg/errors"
-	"github.com/rs/zerolog/log"
-	bolt "go.etcd.io/bbolt"
-)
-
-type DbTransaction struct {
-	conn *DbConnection
-	tx   *bolt.Tx
-}
-
-func (tx *DbTransaction) SetServiceName(bucketName string) error {
-	_, err := tx.tx.CreateBucketIfNotExists([]byte(bucketName))
-	return err
-}
-
-func (tx *DbTransaction) GetObject(bucketName string, key []byte, object any) error {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-
-	value := bucket.Get(key)
-	if value == nil {
-		return fmt.Errorf("%w (bucket=%s, key=%s)", dserrors.ErrObjectNotFound, bucketName, keyToString(key))
-	}
-
-	return tx.conn.UnmarshalObject(value, object)
-}
-
-func (tx *DbTransaction) GetRawBytes(bucketName string, key []byte) ([]byte, error) {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-
-	value := bucket.Get(key)
-	if value == nil {
-		return nil, fmt.Errorf("%w (bucket=%s, key=%s)", dserrors.ErrObjectNotFound, bucketName, keyToString(key))
-	}
-
-	if tx.conn.getEncryptionKey() != nil {
-		var err error
-
-		if value, err = decrypt(value, tx.conn.getEncryptionKey()); err != nil {
-			return value, errors.Wrap(err, "Failed decrypting object")
-		}
-	}
-
-	return value, nil
-}
-
-func (tx *DbTransaction) KeyExists(bucketName string, key []byte) (bool, error) {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-
-	value := bucket.Get(key)
-
-	return value != nil, nil
-}
-
-func (tx *DbTransaction) UpdateObject(bucketName string, key []byte, object any) error {
-	data, err := tx.conn.MarshalObject(object)
-	if err != nil {
-		return err
-	}
-
-	bucket := tx.tx.Bucket([]byte(bucketName))
-	return bucket.Put(key, data)
-}
-
-func (tx *DbTransaction) DeleteObject(bucketName string, key []byte) error {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-	return bucket.Delete(key)
-}
-
-func (tx *DbTransaction) DeleteAllObjects(bucketName string, obj any, matchingFn func(o any) (id int, ok bool)) error {
-	var ids []int
-
-	bucket := tx.tx.Bucket([]byte(bucketName))
-
-	cursor := bucket.Cursor()
-	for k, v := cursor.First(); k != nil; k, v = cursor.Next() {
-		err := tx.conn.UnmarshalObject(v, &obj)
-		if err != nil {
-			return err
-		}
-
-		if id, ok := matchingFn(obj); ok {
-			ids = append(ids, id)
-		}
-	}
-
-	for _, id := range ids {
-		if err := bucket.Delete(tx.conn.ConvertToKey(id)); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-func (tx *DbTransaction) GetNextIdentifier(bucketName string) int {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-
-	id, err := bucket.NextSequence()
-	if err != nil {
-		log.Error().Err(err).Str("bucket", bucketName).Msg("failed to get the next identifier")
-
-		return 0
-	}
-
-	return int(id)
-}
-
-func (tx *DbTransaction) CreateObject(bucketName string, fn func(uint64) (int, any)) error {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-
-	seqId, _ := bucket.NextSequence()
-	id, obj := fn(seqId)
-
-	data, err := tx.conn.MarshalObject(obj)
-	if err != nil {
-		return err
-	}
-
-	return bucket.Put(tx.conn.ConvertToKey(id), data)
-}
-
-func (tx *DbTransaction) CreateObjectWithId(bucketName string, id int, obj any) error {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-	data, err := tx.conn.MarshalObject(obj)
-	if err != nil {
-		return err
-	}
-
-	return bucket.Put(tx.conn.ConvertToKey(id), data)
-}
-
-func (tx *DbTransaction) CreateObjectWithStringId(bucketName string, id []byte, obj any) error {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-	data, err := tx.conn.MarshalObject(obj)
-	if err != nil {
-		return err
-	}
-
-	return bucket.Put(id, data)
-}
-
-func (tx *DbTransaction) GetAll(bucketName string, obj any, appendFn func(o any) (any, error)) error {
-	bucket := tx.tx.Bucket([]byte(bucketName))
-
-	return bucket.ForEach(func(k []byte, v []byte) error {
-		err := tx.conn.UnmarshalObject(v, obj)
-		if err == nil {
-			obj, err = appendFn(obj)
-		}
-
-		return err
-	})
-}
-
-func (tx *DbTransaction) GetAllWithKeyPrefix(bucketName string, keyPrefix []byte, obj any, appendFn func(o any) (any, error)) error {
-	cursor := tx.tx.Bucket([]byte(bucketName)).Cursor()
-
-	for k, v := cursor.Seek(keyPrefix); k != nil && bytes.HasPrefix(k, keyPrefix); k, v = cursor.Next() {
-		err := tx.conn.UnmarshalObject(v, obj)
-		if err != nil {
-			return err
-		}
-
-		obj, err = appendFn(obj)
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
-}

api/database/boltdb/tx_test.go

@@ -1,104 +0,0 @@
-package boltdb
-
-import (
-	"errors"
-	"testing"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-	"github.com/stretchr/testify/require"
-)
-
-const testBucketName = "test-bucket"
-const testId = 1234
-
-type testStruct struct {
-	Key   string
-	Value string
-}
-
-func TestTxs(t *testing.T) {
-	conn := DbConnection{Path: t.TempDir()}
-
-	err := conn.Open()
-	require.NoError(t, err)
-	defer func() {
-		err := conn.Close()
-		require.NoError(t, err)
-	}()
-
-	// Error propagation
-	err = conn.UpdateTx(func(tx portainer.Transaction) error {
-		return errors.New("this is an error")
-	})
-	require.Error(t, err)
-
-	// Create an object
-	newObj := testStruct{Key: "key", Value: "value"}
-
-	err = conn.UpdateTx(func(tx portainer.Transaction) error {
-		if err := tx.SetServiceName(testBucketName); err != nil {
-			return err
-		}
-
-		return tx.CreateObjectWithId(testBucketName, testId, newObj)
-	})
-	require.NoError(t, err)
-
-	obj := testStruct{}
-	err = conn.ViewTx(func(tx portainer.Transaction) error {
-		return tx.GetObject(testBucketName, conn.ConvertToKey(testId), &obj)
-	})
-	require.NoError(t, err)
-
-	if obj.Key != newObj.Key || obj.Value != newObj.Value {
-		t.Fatalf("expected %s:%s, got %s:%s instead", newObj.Key, newObj.Value, obj.Key, obj.Value)
-	}
-
-	// Update an object
-	updatedObj := testStruct{Key: "updated-key", Value: "updated-value"}
-
-	err = conn.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.UpdateObject(testBucketName, conn.ConvertToKey(testId), &updatedObj)
-	})
-	require.NoError(t, err)
-
-	err = conn.ViewTx(func(tx portainer.Transaction) error {
-		return tx.GetObject(testBucketName, conn.ConvertToKey(testId), &obj)
-	})
-	require.NoError(t, err)
-
-	if obj.Key != updatedObj.Key || obj.Value != updatedObj.Value {
-		t.Fatalf("expected %s:%s, got %s:%s instead", updatedObj.Key, updatedObj.Value, obj.Key, obj.Value)
-	}
-
-	// Delete an object
-	err = conn.UpdateTx(func(tx portainer.Transaction) error {
-		return tx.DeleteObject(testBucketName, conn.ConvertToKey(testId))
-	})
-	require.NoError(t, err)
-
-	err = conn.ViewTx(func(tx portainer.Transaction) error {
-		return tx.GetObject(testBucketName, conn.ConvertToKey(testId), &obj)
-	})
-	require.True(t, dataservices.IsErrObjectNotFound(err))
-
-	// Get next identifier
-	err = conn.UpdateTx(func(tx portainer.Transaction) error {
-		id1 := tx.GetNextIdentifier(testBucketName)
-		id2 := tx.GetNextIdentifier(testBucketName)
-
-		if id1+1 != id2 {
-			return errors.New("unexpected identifier sequence")
-		}
-
-		return nil
-	})
-	require.NoError(t, err)
-
-	// Try to write in a read transaction
-	err = conn.ViewTx(func(tx portainer.Transaction) error {
-		return tx.CreateObjectWithId(testBucketName, testId, newObj)
-	})
-	require.Error(t, err)
-}

api/database/database.go

@@ -1,21 +0,0 @@
-package database
-
-import (
-	"fmt"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/database/boltdb"
-)
-
-// NewDatabase should use config options to return a connection to the requested database
-func NewDatabase(storeType, storePath string, encryptionKey []byte, compact bool) (connection portainer.Connection, err error) {
-	if storeType == "boltdb" {
-		return &boltdb.DbConnection{
-			Path:          storePath,
-			EncryptionKey: encryptionKey,
-			Compact:       compact,
-		}, nil
-	}
-
-	return nil, fmt.Errorf("Unknown storage database: %s", storeType)
-}

api/database/database_test.go

@@ -1,24 +0,0 @@
-package database
-
-import (
-	"testing"
-
-	"github.com/portainer/portainer/api/database/boltdb"
-	"github.com/portainer/portainer/api/filesystem"
-
-	"github.com/stretchr/testify/require"
-)
-
-func TestNewDatabase(t *testing.T) {
-	dbPath := filesystem.JoinPaths(t.TempDir(), "test.db")
-	connection, err := NewDatabase("boltdb", dbPath, nil, false)
-	require.NoError(t, err)
-	require.NotNil(t, connection)
-
-	_, ok := connection.(*boltdb.DbConnection)
-	require.True(t, ok)
-
-	connection, err = NewDatabase("unknown", dbPath, nil, false)
-	require.Error(t, err)
-	require.Nil(t, connection)
-}

api/database/models/version.go

@@ -1,8 +0,0 @@
-package models
-
-type Version struct {
-	SchemaVersion string
-	MigratorCount int
-	Edition       int
-	InstanceID    string
-}

api/dataservices/apikeyrepository/apikeyrepository.go

@@ -1,103 +0,0 @@
-package apikeyrepository
-
-import (
-	"errors"
-	"fmt"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-	dserrors "github.com/portainer/portainer/api/dataservices/errors"
-
-	"github.com/rs/zerolog/log"
-)
-
-// BucketName represents the name of the bucket where this service stores data.
-const BucketName = "api_key"
-
-// Service represents a service for managing api-key data.
-type Service struct {
-	dataservices.BaseDataService[portainer.APIKey, portainer.APIKeyID]
-}
-
-// NewService creates a new instance of a service.
-func NewService(connection portainer.Connection) (*Service, error) {
-	if err := connection.SetServiceName(BucketName); err != nil {
-		return nil, err
-	}
-
-	return &Service{
-		BaseDataService: dataservices.BaseDataService[portainer.APIKey, portainer.APIKeyID]{
-			Bucket:     BucketName,
-			Connection: connection,
-		},
-	}, nil
-}
-
-// GetAPIKeysByUserID returns a slice containing all the APIKeys a user has access to.
-func (service *Service) GetAPIKeysByUserID(userID portainer.UserID) ([]portainer.APIKey, error) {
-	result := make([]portainer.APIKey, 0)
-
-	err := service.Connection.GetAll(
-		BucketName,
-		&portainer.APIKey{},
-		func(obj any) (any, error) {
-			record, ok := obj.(*portainer.APIKey)
-			if !ok {
-				log.Debug().Str("obj", fmt.Sprintf("%#v", obj)).Msg("failed to convert to APIKey object")
-				return nil, fmt.Errorf("failed to convert to APIKey object: %s", obj)
-			}
-
-			if record.UserID == userID {
-				result = append(result, *record)
-			}
-
-			return &portainer.APIKey{}, nil
-		})
-
-	return result, err
-}
-
-// GetAPIKeyByDigest returns the API key for the associated digest.
-// Note: there is a 1-to-1 mapping of api-key and digest
-func (service *Service) GetAPIKeyByDigest(digest string) (*portainer.APIKey, error) {
-	var k *portainer.APIKey
-	stop := errors.New("ok")
-	err := service.Connection.GetAll(
-		BucketName,
-		&portainer.APIKey{},
-		func(obj any) (any, error) {
-			key, ok := obj.(*portainer.APIKey)
-			if !ok {
-				log.Debug().Str("obj", fmt.Sprintf("%#v", obj)).Msg("failed to convert to APIKey object")
-				return nil, fmt.Errorf("failed to convert to APIKey object: %s", obj)
-			}
-			if key.Digest == digest {
-				k = key
-				return nil, stop
-			}
-
-			return &portainer.APIKey{}, nil
-		})
-
-	if errors.Is(err, stop) {
-		return k, nil
-	}
-
-	if err == nil {
-		return nil, dserrors.ErrObjectNotFound
-	}
-
-	return nil, err
-}
-
-// Create creates a new APIKey object.
-func (service *Service) Create(record *portainer.APIKey) error {
-	return service.Connection.CreateObject(
-		BucketName,
-		func(id uint64) (int, any) {
-			record.ID = portainer.APIKeyID(id)
-
-			return int(record.ID), record
-		},
-	)
-}

api/dataservices/base.go

@@ -1,81 +0,0 @@
-package dataservices
-
-import (
-	portainer "github.com/portainer/portainer/api"
-
-	"golang.org/x/exp/constraints"
-)
-
-type BaseCRUD[T any, I constraints.Integer] interface {
-	Create(element *T) error
-	Read(ID I) (*T, error)
-	Exists(ID I) (bool, error)
-	ReadAll(predicates ...func(T) bool) ([]T, error)
-	Update(ID I, element *T) error
-	Delete(ID I) error
-}
-
-type BaseDataService[T any, I constraints.Integer] struct {
-	Bucket     string
-	Connection portainer.Connection
-}
-
-func (s *BaseDataService[T, I]) BucketName() string {
-	return s.Bucket
-}
-
-func (service *BaseDataService[T, I]) Tx(tx portainer.Transaction) BaseDataServiceTx[T, I] {
-	return BaseDataServiceTx[T, I]{
-		Bucket:     service.Bucket,
-		Connection: service.Connection,
-		Tx:         tx,
-	}
-}
-
-func (service BaseDataService[T, I]) Read(ID I) (*T, error) {
-	var element *T
-
-	return element, service.Connection.ViewTx(func(tx portainer.Transaction) error {
-		var err error
-		element, err = service.Tx(tx).Read(ID)
-
-		return err
-	})
-}
-
-func (service BaseDataService[T, I]) Exists(ID I) (bool, error) {
-	var exists bool
-
-	err := service.Connection.ViewTx(func(tx portainer.Transaction) error {
-		var err error
-		exists, err = service.Tx(tx).Exists(ID)
-
-		return err
-	})
-
-	return exists, err
-}
-
-// ReadAll retrieves all the elements that satisfy all the provided predicates.
-func (service BaseDataService[T, I]) ReadAll(predicates ...func(T) bool) ([]T, error) {
-	var collection = make([]T, 0)
-
-	return collection, service.Connection.ViewTx(func(tx portainer.Transaction) error {
-		var err error
-		collection, err = service.Tx(tx).ReadAll(predicates...)
-
-		return err
-	})
-}
-
-func (service BaseDataService[T, I]) Update(ID I, element *T) error {
-	return service.Connection.UpdateTx(func(tx portainer.Transaction) error {
-		return service.Tx(tx).Update(ID, element)
-	})
-}
-
-func (service BaseDataService[T, I]) Delete(ID I) error {
-	return service.Connection.UpdateTx(func(tx portainer.Transaction) error {
-		return service.Tx(tx).Delete(ID)
-	})
-}

api/dataservices/base_test.go

@@ -1,91 +0,0 @@
-package dataservices
-
-import (
-	"strconv"
-	"testing"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/slicesx"
-
-	"github.com/stretchr/testify/require"
-)
-
-type testObject struct {
-	ID    int
-	Value int
-}
-
-type mockConnection struct {
-	store map[int]testObject
-
-	portainer.Connection
-}
-
-func (m mockConnection) UpdateObject(bucket string, key []byte, value any) error {
-	obj := value.(*testObject)
-
-	m.store[obj.ID] = *obj
-
-	return nil
-}
-
-func (m mockConnection) GetAll(bucketName string, obj any, appendFn func(o any) (any, error)) error {
-	for _, v := range m.store {
-		if _, err := appendFn(&v); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-func (m mockConnection) UpdateTx(fn func(portainer.Transaction) error) error {
-	return fn(m)
-}
-
-func (m mockConnection) ViewTx(fn func(portainer.Transaction) error) error {
-	return fn(m)
-}
-
-func (m mockConnection) ConvertToKey(v int) []byte {
-	return []byte(strconv.Itoa(v))
-}
-func TestReadAll(t *testing.T) {
-	service := BaseDataService[testObject, int]{
-		Bucket:     "testBucket",
-		Connection: mockConnection{store: make(map[int]testObject)},
-	}
-
-	data := []testObject{
-		{ID: 1, Value: 1},
-		{ID: 2, Value: 2},
-		{ID: 3, Value: 3},
-		{ID: 4, Value: 4},
-		{ID: 5, Value: 5},
-	}
-
-	for _, item := range data {
-		err := service.Update(item.ID, &item)
-		require.NoError(t, err)
-	}
-
-	// ReadAll without predicates
-	result, err := service.ReadAll()
-	require.NoError(t, err)
-
-	expected := append([]testObject{}, data...)
-
-	require.ElementsMatch(t, expected, result)
-
-	// ReadAll with predicates
-	hasLowID := func(obj testObject) bool { return obj.ID < 3 }
-	isEven := func(obj testObject) bool { return obj.Value%2 == 0 }
-
-	result, err = service.ReadAll(hasLowID, isEven)
-	require.NoError(t, err)
-
-	expected = slicesx.Filter(expected, hasLowID)
-	expected = slicesx.Filter(expected, isEven)
-
-	require.ElementsMatch(t, expected, result)
-}

api/dataservices/base_tx.go

@@ -1,84 +0,0 @@
-package dataservices
-
-import (
-	portainer "github.com/portainer/portainer/api"
-
-	"golang.org/x/exp/constraints"
-)
-
-type BaseDataServiceTx[T any, I constraints.Integer] struct {
-	Bucket     string
-	Connection portainer.Connection
-	Tx         portainer.Transaction
-}
-
-func (service BaseDataServiceTx[T, I]) BucketName() string {
-	return service.Bucket
-}
-
-func (service BaseDataServiceTx[T, I]) Read(ID I) (*T, error) {
-	var element T
-	identifier := service.Connection.ConvertToKey(int(ID))
-
-	err := service.Tx.GetObject(service.Bucket, identifier, &element)
-	if err != nil {
-		return nil, err
-	}
-
-	return &element, nil
-}
-
-func (service BaseDataServiceTx[T, I]) Exists(ID I) (bool, error) {
-	identifier := service.Connection.ConvertToKey(int(ID))
-
-	return service.Tx.KeyExists(service.Bucket, identifier)
-}
-
-// ReadAll retrieves all the elements that satisfy all the provided predicates.
-func (service BaseDataServiceTx[T, I]) ReadAll(predicates ...func(T) bool) ([]T, error) {
-	var collection = make([]T, 0)
-
-	if len(predicates) == 0 {
-		return collection, service.Tx.GetAll(
-			service.Bucket,
-			new(T),
-			AppendFn(&collection),
-		)
-	}
-
-	filterFn := func(element T) bool {
-		for _, p := range predicates {
-			if !p(element) {
-				return false
-			}
-		}
-
-		return true
-	}
-
-	return collection, service.Tx.GetAll(
-		service.Bucket,
-		new(T),
-		FilterFn(&collection, filterFn),
-	)
-}
-
-func (service BaseDataServiceTx[T, I]) Update(ID I, element *T) error {
-	identifier := service.Connection.ConvertToKey(int(ID))
-	return service.Tx.UpdateObject(service.Bucket, identifier, element)
-}
-
-func (service BaseDataServiceTx[T, I]) Delete(ID I) error {
-	identifier := service.Connection.ConvertToKey(int(ID))
-	return service.Tx.DeleteObject(service.Bucket, identifier)
-}
-
-func Read[T any](tx portainer.Transaction, bucket string, key []byte) (*T, error) {
-	var element T
-
-	if err := tx.GetObject(bucket, key, &element); err != nil {
-		return nil, err
-	}
-
-	return &element, nil
-}

api/dataservices/customtemplate/customtemplate.go

@@ -1,39 +0,0 @@
-package customtemplate
-
-import (
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-)
-
-// BucketName represents the name of the bucket where this service stores data.
-const BucketName = "customtemplates"
-
-// Service represents a service for managing custom template data.
-type Service struct {
-	dataservices.BaseDataService[portainer.CustomTemplate, portainer.CustomTemplateID]
-}
-
-// NewService creates a new instance of a service.
-func NewService(connection portainer.Connection) (*Service, error) {
-	err := connection.SetServiceName(BucketName)
-	if err != nil {
-		return nil, err
-	}
-
-	return &Service{
-		BaseDataService: dataservices.BaseDataService[portainer.CustomTemplate, portainer.CustomTemplateID]{
-			Bucket:     BucketName,
-			Connection: connection,
-		},
-	}, nil
-}
-
-func (service *Service) GetNextIdentifier() int {
-	return service.Connection.GetNextIdentifier(BucketName)
-}
-
-func (service *Service) Create(customTemplate *portainer.CustomTemplate) error {
-	return service.Connection.UpdateTx(func(tx portainer.Transaction) error {
-		return service.Tx(tx).Create(customTemplate)
-	})
-}

api/dataservices/customtemplate/customtemplate_test.go

@@ -1,19 +0,0 @@
-package customtemplate_test
-
-import (
-	"testing"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/datastore"
-	"github.com/stretchr/testify/require"
-)
-
-func TestCustomTemplateCreate(t *testing.T) {
-	_, ds := datastore.MustNewTestStore(t, true, false)
-	require.NotNil(t, ds)
-
-	require.NoError(t, ds.CustomTemplate().Create(&portainer.CustomTemplate{ID: 1}))
-	e, err := ds.CustomTemplate().Read(1)
-	require.NoError(t, err)
-	require.Equal(t, portainer.CustomTemplateID(1), e.ID)
-}

api/dataservices/customtemplate/tx.go

@@ -1,31 +0,0 @@
-package customtemplate
-
-import (
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-)
-
-// Service represents a service for managing custom template data.
-type ServiceTx struct {
-	dataservices.BaseDataServiceTx[portainer.CustomTemplate, portainer.CustomTemplateID]
-}
-
-func (service *Service) Tx(tx portainer.Transaction) ServiceTx {
-	return ServiceTx{
-		BaseDataServiceTx: dataservices.BaseDataServiceTx[portainer.CustomTemplate, portainer.CustomTemplateID]{
-			Bucket:     BucketName,
-			Connection: service.Connection,
-			Tx:         tx,
-		},
-	}
-}
-
-func (service ServiceTx) GetNextIdentifier() int {
-	return service.Tx.GetNextIdentifier(BucketName)
-}
-
-// CreateCustomTemplate uses the existing id and saves it.
-// TODO: where does the ID come from, and is it safe?
-func (service ServiceTx) Create(customTemplate *portainer.CustomTemplate) error {
-	return service.Tx.CreateObjectWithId(BucketName, int(customTemplate.ID), customTemplate)
-}

api/dataservices/customtemplate/tx_test.go

@@ -1,28 +0,0 @@
-package customtemplate_test
-
-import (
-	"testing"
-
-	portainer "github.com/portainer/portainer/api"
-	"github.com/portainer/portainer/api/dataservices"
-	"github.com/portainer/portainer/api/datastore"
-	"github.com/stretchr/testify/require"
-)
-
-func TestCustomTemplateCreateTx(t *testing.T) {
-	_, ds := datastore.MustNewTestStore(t, true, false)
-	require.NotNil(t, ds)
-
-	require.NoError(t, ds.UpdateTx(func(tx dataservices.DataStoreTx) error {
-		return tx.CustomTemplate().Create(&portainer.CustomTemplate{ID: 1})
-	}))
-
-	var template *portainer.CustomTemplate
-	require.NoError(t, ds.ViewTx(func(tx dataservices.DataStoreTx) error {
-		var err error
-		template, err = tx.CustomTemplate().Read(1)
-		return err
-	}))
-
-	require.Equal(t, portainer.CustomTemplateID(1), template.ID)
-}