feat: Create new keyshade common package (#970)

Co-authored-by: Allan Joston Fernandes <allan@classcardapp.com>
Co-authored-by: Rajdip Bhattacharya <agentR47@gmail.com>

Author: 3 people

apps/api/src/common/cryptography.spec.ts

@@ -1,10 +1,5 @@
-import {
-  createKeyPair,
-  decrypt,
-  encrypt,
-  generateApiKey,
-  toSHA256
-} from './cryptography'
+import { decrypt, encrypt } from '@keyshade/common'
+import { createKeyPair, generateApiKey, toSHA256 } from './cryptography'
 
 describe('Cryptography Tests', () => {
   it('should be defined', () => {
@@ -39,7 +34,7 @@ describe('Cryptography Tests', () => {
       await decrypt(differentKeyPair.privateKey, encrypted)
     } catch (e) {
       expect(e).toBeDefined()
-      expect(e.message).toEqual('Bad MAC')
+      expect(e.message).toEqual('Decryption failed: Bad MAC')
     }
   })
 

apps/api/src/common/cryptography.ts

@@ -1,58 +1,6 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import { createHash, randomBytes } from 'crypto'
 
-/**
- * Encrypts the given data using the given public key.
- *
- * @param publicKey The public key to use for encryption. Must be a hexadecimal string.
- * @param data The data to encrypt.
- *
- * @returns The encrypted data as a JSON string.
- */
-export const encrypt = async (
-  publicKey: string,
-  data: string
-): Promise<string> => {
-  const eccrypto = require('eccrypto')
-
-  const encrypted = await eccrypto.encrypt(
-    Buffer.from(publicKey, 'hex'),
-    Buffer.from(data)
-  )
-
-  return JSON.stringify(encrypted)
-}
-
-/**
- * Decrypts the given data using the given private key.
- *
- * @param privateKey The private key to use for decryption. Must be a hexadecimal string.
- * @param data The data to decrypt.
- *
- * @returns The decrypted data as a string.
- */
-export const decrypt = async (
-  privateKey: string,
-  data: string
-): Promise<string> => {
-  const eccrypto = require('eccrypto')
-  const parsed = JSON.parse(data)
-
-  const eicesData = {
-    iv: Buffer.from(parsed.iv),
-    ephemPublicKey: Buffer.from(parsed.ephemPublicKey),
-    ciphertext: Buffer.from(parsed.ciphertext),
-    mac: Buffer.from(parsed.mac)
-  }
-
-  const decrypted = await eccrypto.decrypt(
-    Buffer.from(privateKey, 'hex'),
-    eicesData
-  )
-
-  return decrypted.toString()
-}
-
 /**
  * Generates a new key pair.
  *

apps/api/src/common/secret.ts

@@ -1,5 +1,5 @@
 import { SecretWithValues } from '@/secret/secret.types'
-import { decrypt } from './cryptography'
+import { decrypt } from '@keyshade/common'
 
 export async function getSecretWithValues(
   secretWithVersion: SecretWithValues['secret'] & {

apps/api/src/project/project.service.ts

@@ -24,7 +24,7 @@ import { v4 } from 'uuid'
 import { ProjectWithCounts, ProjectWithSecrets } from './project.types'
 import { ForkProject } from './dto/fork.project/fork.project'
 import { paginate } from '@/common/paginate'
-import { createKeyPair, decrypt, encrypt } from '@/common/cryptography'
+import { createKeyPair } from '@/common/cryptography'
 import { createEvent } from '@/common/event'
 import {
   constructErrorBody,
@@ -34,6 +34,7 @@ import {
 import { AuthenticatedUser } from '@/user/user.types'
 import { TierLimitService } from '@/common/tier-limit.service'
 import SlugGenerator from '@/common/slug-generator.service'
+import { decrypt, encrypt } from '@keyshade/common'
 
 @Injectable()
 export class ProjectService {

apps/api/src/secret/secret.service.ts

@@ -34,7 +34,6 @@ import {
   constructErrorBody,
   limitMaxItemsPerPage
 } from '@/common/util'
-import { decrypt, encrypt } from '@/common/cryptography'
 import { createEvent } from '@/common/event'
 import { getEnvironmentIdToSlugMap } from '@/common/environment'
 import { getSecretWithValues, generateSecretValue } from '@/common/secret'
@@ -43,6 +42,7 @@ import { SecretWithProject, SecretWithValues } from './secret.types'
 import { AuthenticatedUser } from '@/user/user.types'
 import { TierLimitService } from '@/common/tier-limit.service'
 import SlugGenerator from '@/common/slug-generator.service'
+import { decrypt, encrypt } from '@keyshade/common'
 
 @Injectable()
 export class SecretService {

apps/platform/src/components/dashboard/secret/secretCard/index.tsx

@@ -4,6 +4,7 @@ import { useAtom, useSetAtom } from 'jotai'
 import { NoteIconSVG } from '@public/svg/secret'
 import { TrashWhiteSVG, EyeOpenSVG, EyeSlashSVG } from '@public/svg/shared'
 import { useState } from 'react'
+import {decrypt} from '@keyshade/common'
 import {
   AccordionContent,
   AccordionItem,
@@ -39,7 +40,6 @@ import {
 } from '@/store'
 import AvatarComponent from '@/components/common/avatar'
 import { copyToClipboard } from '@/lib/clipboard'
-import { decrypt } from '@/lib/decrypt'
 
 interface SecretCardProps {
   secretData: Secret

apps/platform/src/lib/decrypt.ts

@@ -56,6 +56,15 @@ flag_management:
       paths:
         - packages/secret-scan/
       carryforward: true
+      statuses:
+        - type: project
+          target: 80%
+        - type: patch
+          target: 98%
+    - name: common
+      paths:
+        - packages/common/
+      carryforward: true
       statuses:
         - type: project
           target: 80%

codecov.yml

@@ -107,23 +107,25 @@
     "lint:api-client": "turbo run lint --filter=@keyshade/api-client",
     "lint:secret-scan": "turbo run lint --filter=@keyshade/secret-scan",
     "lint:schema": "turbo run lint --filter=@keyshade/schema",
+    "lint:common": "turbo run lint --filter=@keyshade/common",
     "build": "turbo run build",
-    "build:api": "pnpm db:generate-types && pnpm build:schema && turbo run build --filter=@keyshade/api",
+    "build:api": "pnpm db:generate-types && pnpm build:schema && pnpm build:common && turbo run build --filter=@keyshade/api",
     "build:web": "pnpm build:api-client && turbo run build --filter=@keyshade/web",
-    "build:platform": "pnpm build:api-client && turbo run build --filter=@keyshade/platform",
+    "build:platform": "pnpm build:api-client && pnpm build:common && turbo run build --filter=@keyshade/platform",
     "build:cli": "pnpm build:secret-scan && pnpm build:api-client && turbo run build --filter=@keyshade/cli",
     "build:api-client": "pnpm build:schema && turbo run --filter=@keyshade/api-client build",
     "build:schema": "turbo run build --filter=@keyshade/schema",
     "build:secret-scan": "turbo run build --filter=@keyshade/secret-scan",
-    "build:packages": "pnpm build:schema && turbo run --filter=@keyshade/api-client build && turbo run build --filter=@keyshade/secret-scan",
+    "build:common": "turbo run build --filter=@keyshade/common",
+    "build:packages": "pnpm build:schema && turbo run --filter=@keyshade/api-client build && turbo run build --filter=@keyshade/secret-scan && turbo run build --filter=@keyshade/common",
     "start": "turbo run start",
     "start:api": "turbo run start --filter=@keyshade/api",
     "start:web": "turbo run start --filter=@keyshade/web",
     "start:platform": "turbo run start --filter=@keyshade/platform",
     "start:cli": "turbo run start --filter=@keyshade/cli",
     "test": "turbo run test",
     "test:api": "pnpm unit:api && pnpm e2e:api",
-    "unit:api": "pnpm run --filter=@keyshade/api unit",
+    "unit:api": "pnpm build:common && pnpm run --filter=@keyshade/api unit",
     "e2e:api": "pnpm run --filter=@keyshade/api e2e",
     "test:web": "turbo run test --filter=@keyshade/web",
     "test:platform": "turbo run test --filter=@keyshade/platform",
@@ -171,6 +173,7 @@
     "@keyshade/api-client": "workspace:*",
     "@keyshade/schema": "workspace:*",
     "@keyshade/secret-scan": "workspace:*",
+    "@keyshade/common": "workspace:*",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^12.0.0",
     "@semantic-release/git": "^10.0.1",

package.json

@@ -0,0 +1,26 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module'
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended'
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unused-vars': ['warn']
+  }
+}

packages/common/.eslintrc.cjs

@@ -0,0 +1,8 @@
+.turbo/
+src/
+tests/
+eslintrc.js
+jest.config.ts
+tsconfig.json
+tsconfig.spec.json
+node_modules/

packages/common/.npmignore

@@ -0,0 +1,21 @@
+{
+  "name": "@keyshade/common",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "description": "This package includes common functions, constants, and other utilities used across multiple applications.",
+  "private": true,
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "watch": "tsc -w",
+    "start": "node dist/index.js",
+    "dev": "npx tsc && node dist/index.js",
+    "lint": "eslint \"{src,tests}/**/*.ts\" --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\""
+  },
+  "dependencies": {
+    "eccrypto": "^1.1.6"
+  },
+  "devDependencies": {
+    "@types/eccrypto": "^1.1.6"
+  }
+}