Merge branch 'main' of https://github.com/Infisical/infisical into bot

frontend/pages/api/auth/CheckAuth.ts

@@ -3,9 +3,6 @@ import SecurityClient from '~/utilities/SecurityClient';
 /**
  * This function is used to check if the user is authenticated.
  * To do that, we get their tokens from cookies, and verify if they are good.
- * @param {*} req
- * @param {*} res
- * @returns
  */
 const checkAuth = async () => {
   return SecurityClient.fetchCall('/api/v1/auth/checkAuth', {

frontend/pages/api/auth/CheckEmailVerificationCode.ts

@@ -5,8 +5,9 @@ interface Props {
 
 /**
  * This route check the verification code from the email that user just recieved
- * @param {*} email
- * @param {*} code
+ * @param {object} obj
+ * @param {string} obj.email
+ * @param {string} obj.code
  * @returns
  */
 const checkEmailVerificationCode = ({ email, code }: Props) => {

frontend/pages/api/auth/CompleteAccountInformationSignup.ts

@@ -15,16 +15,18 @@ interface Props {
 /**
  * This function is called in the end of the signup process.
  * It sends all the necessary nformation to the server.
- * @param {*} email
- * @param {*} firstName
- * @param {*} lastName
- * @param {*} workspace
- * @param {*} publicKey
- * @param {*} ciphertext
- * @param {*} iv
- * @param {*} tag
- * @param {*} salt
- * @param {*} verifier
+ * @param {object} obj
+ * @param {string} obj.email - email of the user completing signup
+ * @param {string} obj.firstName - first name of the user completing signup
+ * @param {string} obj.lastName - last name of the user completing sign up
+ * @param {string} obj.organizationName - organization name for this user (usually, [FIRST_NAME]'s organization)
+ * @param {string} obj.publicKey - public key of the user completing signup
+ * @param {string} obj.ciphertext
+ * @param {string} obj.iv
+ * @param {string} obj.tag
+ * @param {string} obj.salt
+ * @param {string} obj.verifier
+ * @param {string} obj.token - token that confirms a user's identity
  * @returns
  */
 const completeAccountInformationSignup = ({

frontend/pages/api/auth/CompleteAccountInformationSignupInvite.ts

@@ -14,15 +14,17 @@ interface Props {
 /**
  * This function is called in the end of the signup process.
  * It sends all the necessary nformation to the server.
- * @param {*} email
- * @param {*} firstName
- * @param {*} lastName
- * @param {*} publicKey
- * @param {*} ciphertext
- * @param {*} iv
- * @param {*} tag
- * @param {*} salt
- * @param {*} verifier
+ * @param {object} obj
+ * @param {string} obj.email - email of the user completing signupinvite flow
+ * @param {string} obj.firstName - first name of the user completing signupinvite flow
+ * @param {string} obj.lastName - last name of the user completing signupinvite flow
+ * @param {string} obj.publicKey - public key of the user completing signupinvite flow
+ * @param {string} obj.ciphertext
+ * @param {string} obj.iv
+ * @param {string} obj.tag
+ * @param {string} obj.salt
+ * @param {string} obj.verifier
+ * @param {string} obj.token - token that confirms a user's identity
  * @returns
  */
 const completeAccountInformationSignupInvite = ({

frontend/pages/api/auth/IssueBackupPrivateKey.ts

@@ -11,6 +11,14 @@ interface Props {
 
 /**
  * This is the route that issues a backup private key that will afterwards be added into a pdf
+ * @param {object} obj
+ * @param {string} obj.encryptedPrivateKey
+ * @param {string} obj.iv
+ * @param {string} obj.tag
+ * @param {string} obj.salt
+ * @param {string} obj.verifier
+ * @param {string} obj.clientProof
+ * @returns
  */
 const issueBackupPrivateKey = ({
   encryptedPrivateKey,

frontend/pages/api/auth/SRP1.ts

@@ -6,7 +6,7 @@ interface Props {
 
 /**
  * This is the first step of the change password process (pake)
- * @param {*} clientPublicKey
+ * @param {string} clientPublicKey
  * @returns
  */
 const SRP1 = ({ clientPublicKey }: Props) => {

frontend/pages/api/auth/VerifySignupInvite.ts

@@ -5,8 +5,9 @@ interface Props {
 
 /**
  * This route verifies the signup invite link
- * @param {*} email
- * @param {*} code
+ * @param {object} obj
+ * @param {string} obj.email - email that a user is trying to verify
+ * @param {string} obj.code - code that a user received to the abovementioned email
  * @returns
  */
 const verifySignupInvite = ({ email, code }: Props) => {

frontend/pages/api/files/GetSecrets.ts

@@ -2,8 +2,8 @@ import SecurityClient from '~/utilities/SecurityClient';
 
 /**
  * This function fetches the encrypted secrets from the .env file
- * @param {*} workspaceId
- * @param {*} env
+ * @param {string} workspaceId - project is for which a user is trying to get secrets
+ * @param {string} env - environment of a project for which a user is trying ot get secrets
  * @returns
  */
 const getSecrets = async (workspaceId: string, env: string) => {

frontend/pages/api/files/UploadSecrets.ts

@@ -9,8 +9,11 @@ interface Props {
 
 /**
  * This function uploads the encrypted .env file
- * @param {*} req
- * @param {*} res
+ * @param {object} obj
+ * @param {string} obj.workspaceId
+ * @param {} obj.secrets
+ * @param {} obj.keys
+ * @param {string} obj.environment
  * @returns
  */
 const uploadSecrets = async ({

frontend/pages/api/integrations/authorizeIntegration.ts

@@ -7,7 +7,10 @@ interface Props {
 }
 /**
  * This is the first step of the change password process (pake)
- * @param {*} clientPublicKey
+ * @param {object} obj
+ * @param {object} obj.workspaceId - project id for which we want to authorize the integration
+ * @param {object} obj.code
+ * @param {object} obj.integration - integration which a user is trying to turn on
  * @returns
  */
 const AuthorizeIntegration = ({ workspaceId, code, integration }: Props) => {

frontend/pages/dashboard/[id].js

@@ -385,14 +385,14 @@ export default function Dashboard() {
 
     if (nameErrors) {
       return createNotification({
-        text: 'Solve all name errors first!',
+        text: 'Solve all name errors before saving secrets.',
         type: 'error'
       });
     }
 
     if (duplicatesExist) {
       return createNotification({
-        text: "Your secrets weren't saved; please fix the conflicts first.",
+        text: 'Remove duplicated secret names before saving.',
         type: 'error'
       });
     }

frontend/pages/home/[id].tsx

@@ -47,7 +47,7 @@ const learningItem = ({
         >
           <div
             onClick={async () => {
-              if (userAction) {
+              if (userAction && userAction != 'first_time_secrets_pushed') {
                 await registerUserAction({
                   action: userAction
                 });

frontend/pages/signup.tsx

@@ -1,6 +1,5 @@
-import React, { useEffect, useRef, useState } from 'react';
+import React, { useEffect, useState } from 'react';
 import ReactCodeInput from 'react-code-input';
-import dynamic from 'next/dynamic';
 import Head from 'next/head';
 import Image from 'next/image';
 import Link from 'next/link';
@@ -181,15 +180,15 @@ export default function SignUp() {
       const PRIVATE_KEY = nacl.util.encodeBase64(secretKeyUint8Array);
       const PUBLIC_KEY = nacl.util.encodeBase64(publicKeyUint8Array);
 
-      const { ciphertext, iv, tag } = Aes256Gcm.encrypt(
-        PRIVATE_KEY,
-        password
+      const { ciphertext, iv, tag } = Aes256Gcm.encrypt({
+        text: PRIVATE_KEY,
+        secret: password
           .slice(0, 32)
           .padStart(
             32 + (password.slice(0, 32).length - new Blob([password]).size),
             '0'
           )
-      ) as { ciphertext: string; iv: string; tag: string };
+      }) as { ciphertext: string; iv: string; tag: string };
 
       localStorage.setItem('PRIVATE_KEY', PRIVATE_KEY);
 

frontend/pages/signupinvite.js

@@ -1,38 +1,38 @@
-import React, { useState } from "react";
-import Head from "next/head";
-import Image from "next/image";
-import Link from "next/link";
-import { useRouter } from "next/router";
-import { faCheck, faWarning, faX } from "@fortawesome/free-solid-svg-icons";
-import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
+import React, { useState } from 'react';
+import Head from 'next/head';
+import Image from 'next/image';
+import Link from 'next/link';
+import { useRouter } from 'next/router';
+import { faCheck, faWarning, faX } from '@fortawesome/free-solid-svg-icons';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 
-import Button from "~/components/basic/buttons/Button";
-import InputField from "~/components/basic/InputField";
-import Aes256Gcm from "~/components/utilities/cryptography/aes-256-gcm";
-import issueBackupKey from "~/components/utilities/cryptography/issueBackupKey";
-import attemptLogin from "~/utilities/attemptLogin";
-import passwordCheck from "~/utilities/checks/PasswordCheck";
+import Button from '~/components/basic/buttons/Button';
+import InputField from '~/components/basic/InputField';
+import Aes256Gcm from '~/components/utilities/cryptography/aes-256-gcm';
+import issueBackupKey from '~/components/utilities/cryptography/issueBackupKey';
+import attemptLogin from '~/utilities/attemptLogin';
+import passwordCheck from '~/utilities/checks/PasswordCheck';
 
-import completeAccountInformationSignupInvite from "./api/auth/CompleteAccountInformationSignupInvite";
-import verifySignupInvite from "./api/auth/VerifySignupInvite";
+import completeAccountInformationSignupInvite from './api/auth/CompleteAccountInformationSignupInvite';
+import verifySignupInvite from './api/auth/VerifySignupInvite';
 
-const nacl = require("tweetnacl");
-const jsrp = require("jsrp");
-nacl.util = require("tweetnacl-util");
+const nacl = require('tweetnacl');
+const jsrp = require('jsrp');
+nacl.util = require('tweetnacl-util');
 const client = new jsrp.client();
-const queryString = require("query-string");
+const queryString = require('query-string');
 
 export default function SignupInvite() {
-  const [password, setPassword] = useState("");
-  const [firstName, setFirstName] = useState("");
-  const [lastName, setLastName] = useState("");
+  const [password, setPassword] = useState('');
+  const [firstName, setFirstName] = useState('');
+  const [lastName, setLastName] = useState('');
   const [firstNameError, setFirstNameError] = useState(false);
   const [lastNameError, setLastNameError] = useState(false);
   const [passwordErrorLength, setPasswordErrorLength] = useState(false);
   const [passwordErrorNumber, setPasswordErrorNumber] = useState(false);
   const [passwordErrorLowerCase, setPasswordErrorLowerCase] = useState(false);
   const router = useRouter();
-  const parsedUrl = queryString.parse(router.asPath.split("?")[1]);
+  const parsedUrl = queryString.parse(router.asPath.split('?')[1]);
   const [email, setEmail] = useState(parsedUrl.to);
   const token = parsedUrl.token;
   const [errorLogin, setErrorLogin] = useState(false);
@@ -74,21 +74,22 @@ export default function SignupInvite() {
       const PRIVATE_KEY = nacl.util.encodeBase64(secretKeyUint8Array);
       const PUBLIC_KEY = nacl.util.encodeBase64(publicKeyUint8Array);
 
-      const { ciphertext, iv, tag } = Aes256Gcm.encrypt(
-        PRIVATE_KEY,
-        password
+      const { ciphertext, iv, tag } = Aes256Gcm.encrypt({
+        text: PRIVATE_KEY,
+        secret: password
           .slice(0, 32)
           .padStart(
             32 + (password.slice(0, 32).length - new Blob([password]).size),
-            "0"
+            '0'
           )
-      );
-      localStorage.setItem("PRIVATE_KEY", PRIVATE_KEY);
+      });
+
+      localStorage.setItem('PRIVATE_KEY', PRIVATE_KEY);
 
       client.init(
         {
           username: email,
-          password: password,
+          password: password
         },
         async () => {
           client.createVerifier(async (err, result) => {
@@ -102,17 +103,17 @@ export default function SignupInvite() {
               tag,
               salt: result.salt,
               verifier: result.verifier,
-              token: verificationToken,
+              token: verificationToken
             });
 
             // if everything works, go the main dashboard page.
-            if (!errorCheck && response.status == "200") {
+            if (!errorCheck && response.status == '200') {
               response = await response.json();
 
-              localStorage.setItem("publicKey", PUBLIC_KEY);
-              localStorage.setItem("encryptedPrivateKey", ciphertext);
-              localStorage.setItem("iv", iv);
-              localStorage.setItem("tag", tag);
+              localStorage.setItem('publicKey', PUBLIC_KEY);
+              localStorage.setItem('encryptedPrivateKey', ciphertext);
+              localStorage.setItem('iv', iv);
+              localStorage.setItem('tag', tag);
 
               try {
                 await attemptLogin(
@@ -126,7 +127,7 @@ export default function SignupInvite() {
                 setStep(3);
               } catch (error) {
                 setIsLoading(false);
-                console.log("Error", error);
+                console.log('Error', error);
               }
             }
           });
@@ -155,14 +156,14 @@ export default function SignupInvite() {
           onButtonPressed={async () => {
             const response = await verifySignupInvite({
               email,
-              code: token,
+              code: token
             });
             if (response.status == 200) {
               setVerificationToken((await response.json()).token);
               setStep(2);
             } else {
-              console.log("ERROR", response);
-              router.push("/requestnewinvite");
+              console.log('ERROR', response);
+              router.push('/requestnewinvite');
             }
           }}
           size="lg"
@@ -211,7 +212,7 @@ export default function SignupInvite() {
               setPasswordErrorLength,
               setPasswordErrorNumber,
               setPasswordErrorLowerCase,
-              currentErrorCheck: false,
+              currentErrorCheck: false
             });
           }}
           type="password"
@@ -244,7 +245,7 @@ export default function SignupInvite() {
               )}
               <div
                 className={`${
-                  passwordErrorLength ? "text-gray-400" : "text-gray-600"
+                  passwordErrorLength ? 'text-gray-400' : 'text-gray-600'
                 } text-sm`}
               >
                 14 characters
@@ -264,7 +265,7 @@ export default function SignupInvite() {
               )}
               <div
                 className={`${
-                  passwordErrorLowerCase ? "text-gray-400" : "text-gray-600"
+                  passwordErrorLowerCase ? 'text-gray-400' : 'text-gray-600'
                 } text-sm`}
               >
                 1 lowercase character
@@ -284,7 +285,7 @@ export default function SignupInvite() {
               )}
               <div
                 className={`${
-                  passwordErrorNumber ? "text-gray-400" : "text-gray-600"
+                  passwordErrorNumber ? 'text-gray-400' : 'text-gray-600'
                 } text-sm`}
               >
                 1 number
@@ -335,11 +336,11 @@ export default function SignupInvite() {
             await issueBackupKey({
               email,
               password,
-              personalName: firstName + " " + lastName,
+              personalName: firstName + ' ' + lastName,
               setBackupKeyError,
-              setBackupKeyIssued,
+              setBackupKeyIssued
             });
-            router.push("/dashboard/");
+            router.push('/dashboard/');
           }}
           size="lg"
         />