passbolt-browser-extension 3.0.6 → 4.6.2

package/.eslintrc.json

@@ -1,11 +1,13 @@
 {
   "parserOptions": {
-    "ecmaVersion": 8,
+    "ecmaVersion": 2018,
+    "requireConfigFile": false,
     "sourceType": "module",
-    "ecmaFeatures": {
-      "jsx": true
+    "babelOptions": {
+      "presets": ["@babel/preset-react"]
     }
   },
+  "parser": "@babel/eslint-parser",
   "extends": [
     "eslint:recommended",
     "plugin:react/recommended"
@@ -18,15 +20,30 @@
     "browser": true,
     "es6": true,
     "amd": true,
-    "jquery": true,
     "webextensions": true,
-    "jest": true
+    "jest": true,
+    "node": true
   },
   "globals": {
     "global": true,
     "__": true,
     "secretComplexity": true,
-    "port": true
+    "port": true,
+    "Validator": true,
+    "openpgp": true,
+    "PapaParse": true,
+    "kdbxweb": true,
+    "storage": true,
+    "jsSHA": true,
+    "XRegExp": true,
+    "stripslashes": true,
+    "urldecode": true,
+    "OpenpgpkeyEntity": true
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
   },
   "rules": {
     "strict": [
@@ -47,7 +64,12 @@
     // enforce consistent brace style for all control statements
     "no-eval": 2,
     // disallow the use of eval()
-    "no-extend-native": 2,
+    "no-extend-native": [
+      "error",
+      {
+        "exceptions": ["Error"]
+      }
+    ],
     // disallow extending native types
     "no-global-assign": 2,
     // disallow assignments to native objects or read-only global variables
@@ -81,15 +103,6 @@
     "eol-last": 1,
     // enforce at least one newline at the end of files
     "func-call-spacing": 1,
-    // require or disallow spacing between function identifiers and their invocations
-    "indent": [
-      "warn",
-      2,
-      {
-        "MemberExpression": 0,
-        "SwitchCase": 1
-      }
-    ],
     // enforce consistent indentation
     "key-spacing": [
       "warn",
@@ -184,7 +197,7 @@
     ],
     "object-shorthand": [
       "error",
-      "never"
+      "consistent"
     ],
     "multiline-comment-style": [
       "error",
@@ -198,7 +211,10 @@
         "uninitialized": "always"
       }
     ],
-    // enforce variables to be declared either together or separately in functions
+    /*
+     * require or disallow spacing between function identifiers and their invocations
+     * enforce variables to be declared either together or separately in functions
+     */
     "indent": [
       "warn",
       2,

package/.github/workflows/release.yaml

@@ -0,0 +1,17 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  build:
+    name: Create release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        name: Create Release
+        run: gh release create "${GITHUB_REF#refs/*/}" -t "${GITHUB_REF#refs/*/}" --notes-file RELEASE_NOTES.md

package/.github/workflows/release_candidate.yaml

@@ -0,0 +1,17 @@
+name: Create Release Candidate
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+-rc.[0-9]+"
+
+jobs:
+  build:
+    name: Create release candidate
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        name: Create Release candidate
+        run: gh release create "${GITHUB_REF#refs/*/}" -t "${GITHUB_REF#refs/*/}" -p --notes-file RELEASE_NOTES.md

package/.gitlab-ci/jobs/build.yml

@@ -0,0 +1,42 @@
+build:
+  stage: build
+  image: node:18
+  extends: .rules
+  artifacts:
+    when: always
+    paths:
+      - dist/chrome
+      - dist/firefox
+  script:
+    - |
+      apt-get update
+      apt-get install -y curl zip
+      npm ci
+      mkdir -p dist/firefox dist/chrome
+      npx grunt build
+      if [[ "$CI_COMMIT_TAG" != "" ]]; then
+        echo "Sending slack build notification"
+        echo "================================"
+        bash ./.gitlab-ci/scripts/bin/slack-status-messages.sh ":jigsaw: A new wild browser extension appeared! $CI_COMMIT_TAG" "$CI_PROJECT_URL/-/jobs/$CI_JOB_ID/artifacts/browse/dist/"
+      fi
+
+build_mv3:
+  stage: build
+  image: node:18
+  extends: .rules
+  artifacts:
+    when: always
+    paths:
+      - dist/chrome-mv3/
+  script:
+    - |
+      apt-get update
+      apt-get install -y curl zip
+      npm ci
+      mkdir -p dist/chrome-mv3
+      npx grunt build-chrome-mv3
+      if [[ "$CI_COMMIT_TAG" != "" ]]; then
+        echo "Sending slack build notification"
+        echo "================================"
+        bash ./.gitlab-ci/scripts/bin/slack-status-messages.sh ":jigsaw: A new wild MV3 browser extension appeared! $CI_COMMIT_TAG" "$CI_PROJECT_URL/-/jobs/$CI_JOB_ID/artifacts/browse/dist/"
+      fi

package/.gitlab-ci/jobs/publish.yml

@@ -0,0 +1,38 @@
+publish-chrome:
+  stage: publish
+  rules:
+    - if: "$CI_COMMIT_TAG"
+      when: manual
+  script:
+    - |
+      apt-get update && apt-get install -y curl
+      bash .gitlab-ci/scripts/bin/publish.sh chrome
+      echo "Sending slack build notification"
+      echo "================================"
+      bash ./.gitlab-ci/scripts/bin/slack-status-messages.sh ":rocket: passbolt-chrome-extension $CI_COMMIT_TAG has been published!" "$CI_PROJECT_URL/-/jobs/$CI_JOB_ID"
+
+publish-firefox:
+  stage: publish
+  rules:
+    - if: "$CI_COMMIT_TAG"
+      when: manual
+  script:
+    - |
+      apt-get update && apt-get install -y curl
+      bash .gitlab-ci/scripts/bin/publish.sh firefox
+      echo "Sending slack build notification"
+      echo "================================"
+      bash ./.gitlab-ci/scripts/bin/slack-status-messages.sh ":rocket: passbolt-firefox-extension $CI_COMMIT_TAG has been published!" "$CI_PROJECT_URL/-/jobs/$CI_JOB_ID"
+
+publish-edge:
+  stage: publish
+  rules:
+    - if: "$CI_COMMIT_TAG"
+      when: manual
+  script:
+    - |
+      apt-get update && apt-get install -y curl
+      bash .gitlab-ci/scripts/bin/publish.sh edge
+      echo "Sending slack build notification"
+      echo "================================"
+      bash ./.gitlab-ci/scripts/bin/slack-status-messages.sh ":rocket: passbolt-edge-extension $CI_COMMIT_TAG has been published!" "$CI_PROJECT_URL/-/jobs/$CI_JOB_ID"

package/.gitlab-ci/jobs/release.yml

@@ -0,0 +1,21 @@
+release_notes:
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  release:
+    description: "./RELEASE_NOTES.md"
+    tag_name: $CI_COMMIT_TAG
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
+      when: on_success
+  script: echo "Creating relase notes for $CI_COMMIT_TAG"
+  stage: release
+
+release_notes_candidate:
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  release:
+    tag_name: $CI_COMMIT_TAG
+    description: $CI_COMMIT_TAG
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+$/'
+      when: on_success
+  script: echo "Creating relase notes for $CI_COMMIT_TAG"
+  stage: release

package/.gitlab-ci/jobs/review.yml

@@ -0,0 +1,25 @@
+review-chrome:
+  stage: review
+  rules:
+    - if: "$CI_COMMIT_TAG"
+  script:
+    - |
+      apt-get update && apt-get install -y curl
+      bash .gitlab-ci/scripts/bin/review.sh chrome
+      echo "Sending slack build notification"
+      echo "================================"
+      bash ./.gitlab-ci/scripts/bin/slack-status-messages.sh ":airplane_departure: passbolt-chrome-extension $CI_COMMIT_TAG has been sent to review!" "$CI_PROJECT_URL/-/jobs/$CI_JOB_ID"
+
+review-firefox:
+  stage: review
+  rules:
+    - if: "$CI_COMMIT_TAG"
+  script:
+    - bash .gitlab-ci/scripts/bin/review.sh firefox
+
+review-edge:
+  stage: review
+  rules:
+    - if: "$CI_COMMIT_TAG"
+  script:
+    - bash .gitlab-ci/scripts/bin/review.sh edge

package/.gitlab-ci/jobs/test.yml

@@ -0,0 +1,32 @@
+tester:
+  stage: test
+  image: node:18
+  coverage: /Lines\s* [:] ([\d\.]+)%/
+  extends: .rules
+  script:
+    - npm ci
+    - npm run test:coverage
+  artifacts:
+    when: always
+    reports:
+      junit:
+        - junit.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura-coverage.xml
+
+linter:
+  stage: test
+  image: node:18
+  extends: .rules
+  script:
+    - npm ci
+    - npm run lint
+
+audit:
+  allow_failure: true
+  stage: test
+  image: node:18
+  extends: .rules
+  script:
+    - npm audit

package/.gitlab-ci/scripts/bin/publish.sh

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+
+# shellcheck disable=SC1091
+
+set -eu
+
+CI_SCRIPTS_DIR=$(dirname "$0")/..
+
+# shellcheck source=.gitlab-ci/scripts/lib/version-check.sh
+source "$CI_SCRIPTS_DIR"/lib/version-check.sh
+
+function send_to_firefox() {
+  echo "not supported yet"
+  exit 1
+}
+
+function send_to_edge() {
+  echo "not supported yet"
+  exit 1
+}
+
+function send_to_chrome() {
+  local token
+  token=$(curl "https://www.googleapis.com/oauth2/v4/token" -H 'Content-Type: application/json' -d "$PAYLOAD_WS" | grep access_token | awk '{print $2}' | awk -F'"' '$0=$2')
+  local id="$1"
+  curl \
+    -H "Authorization: Bearer $token"  \
+    -H "x-goog-api-version: 2" \
+    -H "Content-Length: 0" \
+    -X POST \
+    https://www.googleapis.com/chromewebstore/v1.1/items/"$id"/publish
+}
+
+if is_release_candidate "$CI_COMMIT_TAG"; then
+  case $1 in
+    chrome)
+      send_to_chrome "$PASSBOLT_TESTING_CHROME_ID"
+    ;;
+    firefox)
+      echo "We don't send RC for firefox to review"
+    ;;
+
+    edge)
+      echo "We don't send RC for edge to review"
+    ;;
+    *) echo "I don't recognize this option"
+    ;;
+  esac
+else
+  case "$1" in
+    chrome)
+      send_to_chrome "$PASSBOLT_STABLE_CHROME_ID"
+    ;;
+    firefox)
+      send_to_firefox
+    ;;
+    edge)
+      send_to_edge
+    ;;
+    *) echo "I don't recognize this option"
+    ;;
+  esac
+fi

package/.gitlab-ci/scripts/bin/review.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# shellcheck disable=SC1091
+
+set -eu
+
+CI_SCRIPTS_DIR=$(dirname "$0")/..
+
+# shellcheck source=.gitlab-ci/scripts/lib/version-check.sh
+source "$CI_SCRIPTS_DIR"/lib/version-check.sh
+
+function send_to_chrome() {
+  local token
+  token=$(curl "https://www.googleapis.com/oauth2/v4/token" -H 'Content-Type: application/json' -d "$PAYLOAD_WS" | grep access_token | awk '{print $2}' | awk -F'"' '$0=$2')
+  local id="$1"
+  curl \
+    -H "Authorization: Bearer $token"  \
+    -H "x-goog-api-version: 2" \
+    -X PUT \
+    -T "dist/chrome/passbolt-${CI_COMMIT_TAG#v}.zip" \
+    https://www.googleapis.com/upload/chromewebstore/v1.1/items/"$id"
+}
+
+if is_release_candidate "$CI_COMMIT_TAG"; then
+  case $1 in
+    chrome)
+      send_to_chrome "$PASSBOLT_TESTING_CHROME_ID"
+    ;;
+    firefox)
+      echo "We don't send RC for firefox to review"
+    ;;
+    edge)
+      echo "We don't send RC for edge to review"
+    ;;
+    *) echo "I don't recognize this option"
+    ;;
+  esac
+else
+  case $1 in
+    chrome)
+      send_to_chrome "$PASSBOLT_STABLE_CHROME_ID"
+    ;;
+    firefox)
+      echo "We don't send RC for firefox to review"
+    ;;
+    edge)
+      echo "We don't send RC for edge to review"
+    ;;
+    *) echo "I don't recognize this option"
+    ;;
+  esac
+fi

package/.gitlab-ci/scripts/bin/slack-status-messages.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# Variables required
+# CI_PROJECT_NAME
+# CI_PIPELINE_ID
+# SLACK_CHANNEL_ID
+# SLACK_WEBHOOK
+
+title="$1"
+url="$2"
+
+curl -X POST -H 'Content-type: application/json' $SLACK_WEBHOOK \
+--data-binary @- <<EOF
+{
+  "channel": "$SLACK_CHANNEL_ID",
+  "attachments": [
+    {
+      "color": "#36A64F",
+      "title": "$title",
+      "attachment_type": "default",
+      "actions": [
+        {
+          "name": "Check it!",
+          "text": "Check it!",
+          "type": "button",
+          "style": "primary",
+          "url": "$url"
+        }
+      ]
+    }
+  ]
+}
+EOF

package/.gitlab-ci/scripts/lib/git-helpers.sh

@@ -0,0 +1,29 @@
+function setup_gpg_key() {
+  key_path="$1"
+  passphrase="$2"
+  grip="$3"
+
+  mkdir -p ~/.gnupg
+  echo "allow-preset-passphrase" > ~/.gnupg/gpg-agent.conf
+  gpg-agent --homedir ~/.gnupg --use-standard-socket --daemon
+  /usr/lib/gnupg2/gpg-preset-passphrase -c "$grip" <<< "$passphrase"
+  gpg --pinentry-mode loopback --passphrase "$passphrase" --import "$key_path"
+}
+
+function setup_git_user() {
+  local email="$1"
+  local name="$2"
+  git config --global user.email "$email"
+  git config --global user.name "$name"
+  git config --global commit.gpgsign true
+  git config --global user.signingkey "$email"
+}
+
+function create_git_tag() {
+  local passbolt_version="$1"
+  local passbolt_flavour="$2"
+  local filter="$3"
+  local component="$4"
+  local tag="$passbolt_version-$passbolt_flavour-$filter"
+  git tag -a "$tag" -m "Release $tag version for $component package" > /dev/null
+}

package/.gitlab-ci/scripts/lib/set-env.sh

@@ -0,0 +1,25 @@
+# This function parses a tag in the form of:
+# v3.11.0-rc.1
+#
+# All of the fields are mandatory:
+# Version: v3.11.0-rc.1|v3.11.0
+#
+# It also provides the component based on if it is RC: testing|stable
+function parse_tag() {
+  local tag=$1
+
+  if is_release_candidate "$tag"; then
+    echo "$tag" | awk -F '-' '{print $1"-"$2,"testing"}'
+  else
+    echo "$tag" | awk -F '-' '{print $1,"stable"}'
+  fi
+}
+
+function calculate_regex() {
+  local message="$1"
+  local default_value="$2"
+  local pattern="$3"
+
+  result="$(echo "$message" | sed -nE "s/.*\[.*($pattern: *)([^]|^ |^,]+).*\]/\\2/p")"
+  echo "${result:-$default_value}"
+}

package/.gitlab-ci/scripts/lib/version-check.sh

@@ -0,0 +1,25 @@
+function is_valid_api_tag () {
+  if [[ ! $PASSBOLT_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
+    echo "Invalid version format: $PASSBOLT_VERSION"
+    return 1
+  fi
+}
+
+function is_release_candidate () {
+  local version=$1
+  if [[ ! $version =~ [0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+ ]];then
+    return 1
+  fi
+  return 0
+}
+
+function validate_config_version_and_api_tag () {
+  local version_file="$1"
+  local version
+  version=$(echo "$PASSBOLT_VERSION" | tr -d 'v')
+
+  if ! grep -q "$version" "$version_file"; then
+    echo "Version number in version.php does not match the tag: $PASSBOLT_VERSION"
+    return 1
+  fi
+}

package/.gitlab-ci.yml

@@ -1,22 +1,21 @@
 image: debian:stable-slim
 
-variables:
-  DOCKER_HOST: tcp://localhost:2375
-  DOCKER_DRIVER: overlay2
-
 stages:
   - test
+  - build
+  - review
+  - release
+  - publish
 
-tester:
-  stage: test
-  image: node:14
-  script:
-    - npm ci
-    - npm run test
+.rules:
+  rules:
+    - if: "$CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS"
+      when: never
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG || $CI_COMMIT_BRANCH'
 
-linter:
-  stage: test
-  image: node:12
-  script:
-    - npm ci
-    - npm run eslint
+include:
+  - local: "/.gitlab-ci/jobs/build.yml"
+  - local: "/.gitlab-ci/jobs/test.yml"
+  - local: "/.gitlab-ci/jobs/review.yml"
+  - local: "/.gitlab-ci/jobs/publish.yml"
+  - local: ".gitlab-ci/jobs/release.yml"

package/.jpmignore

@@ -13,6 +13,7 @@
 .bowerrc
 .gitignore
 .jpmignore
+.npmignore
 .idea
 locale/empty
 /data/less
@@ -20,4 +21,7 @@ Gruntfile.js
 CHANGELOG.MD
 README.MD
 npm-debug.log
-config.json.default
+config.json.default
+
+#jest test coverage
+/coverage