chore: debugging certs

CHANGELOG.md

@@ -1,10 +1,3 @@
-# [0.8.0](https://github.com/sasjs/server/compare/v0.7.3...v0.8.0) (2022-06-21)
-
-
-### Features
-
-* **certs:** ENV variables updated and set CA Root for HTTPS server ([2119e9d](https://github.com/sasjs/server/commit/2119e9de9ab1e5ce1222658f554ac74f4f35cf4d))
-
 ## [0.7.3](https://github.com/sasjs/server/compare/v0.7.2...v0.7.3) (2022-06-20)
 
 

README.md

@@ -99,10 +99,9 @@ SASV9_OPTIONS= -NOXCMD
 ## Additional Web Server Options
 #
 
-# ENV variables for PROTOCOL: `https`
-PRIVATE_KEY=privkey.pem (required)
-CERT_CHAIN=certificate.pem (required)
-CA_ROOT=fullchain.pem (optional)
+# ENV variables required for PROTOCOL: `https`
+PRIVATE_KEY=privkey.pem
+FULL_CHAIN=fullchain.pem
 
 # ENV variables required for MODE: `server`
 ACCESS_TOKEN_SECRET=<secret>

api/.env.example

@@ -4,8 +4,7 @@ WHITELIST=<space separated urls, each starting with protocol `http` or `https`>
 
 PROTOCOL=[http|https] default considered as http
 PRIVATE_KEY=privkey.pem
-CERT_CHAIN=certificate.pem
-CA_ROOT=fullchain.pem
+FULL_CHAIN=fullchain.pem
 
 PORT=[5000] default value is 5000
 

api/src/controllers/internal/Execution.ts

@@ -1,6 +1,10 @@
 import path from 'path'
 import fs from 'fs'
-import { getSessionController, processProgram } from './'
+import {
+  getSASSessionController,
+  getJSSessionController,
+  processProgram
+} from './'
 import { readFile, fileExists, createFile, readFileBinary } from '@sasjs/utils'
 import { PreProgramVars, Session, TreeNode } from '../../types'
 import {
@@ -72,7 +76,10 @@ export class ExecutionController {
     session: sessionByFileUpload,
     runTime
   }: ExecuteProgramParams): Promise<ExecuteReturnRaw | ExecuteReturnJson> {
-    const sessionController = getSessionController(runTime)
+    const sessionController =
+      runTime === RunTimeType.SAS
+        ? getSASSessionController()
+        : getJSSessionController()
 
     const session =
       sessionByFileUpload ?? (await sessionController.getSession())

api/src/controllers/internal/FileUploadController.ts

@@ -1,7 +1,7 @@
 import { Request, RequestHandler } from 'express'
 import multer from 'multer'
 import { uuidv4 } from '@sasjs/utils'
-import { getSessionController } from '.'
+import { getSASSessionController, getJSSessionController } from '.'
 import {
   executeProgramRawValidation,
   getRunTimeAndFilePath,
@@ -37,23 +37,17 @@ export class FileUploadController {
     try {
       ;({ runTime } = await getRunTimeAndFilePath(programPath))
     } catch (err: any) {
-      return res.status(400).send({
+      res.status(400).send({
         status: 'failure',
         message: 'Job execution failed',
         error: typeof err === 'object' ? err.toString() : err
       })
     }
 
-    let sessionController
-    try {
-      sessionController = getSessionController(runTime)
-    } catch (err: any) {
-      return res.status(400).send({
-        status: 'failure',
-        message: err.message,
-        error: typeof err === 'object' ? err.toString() : err
-      })
-    }
+    const sessionController =
+      runTime === RunTimeType.SAS
+        ? getSASSessionController()
+        : getJSSessionController()
 
     const session = await sessionController.getSession()
     // marking consumed true, so that it's not available

api/src/controllers/internal/Session.ts

@@ -5,16 +5,14 @@ import { execFile } from 'child_process'
 import {
   getSessionsFolder,
   generateUniqueFileName,
-  sysInitCompiledPath,
-  RunTimeType
+  sysInitCompiledPath
 } from '../../utils'
 import {
   deleteFolder,
   createFile,
   fileExists,
   generateTimestamp,
-  readFile,
-  isWindows
+  readFile
 } from '@sasjs/utils'
 
 const execFilePromise = promisify(execFile)
@@ -90,7 +88,7 @@ ${autoExecContent}`
 
     // Additional windows specific options to avoid the desktop popups.
 
-    execFilePromise(process.sasLoc!, [
+    execFilePromise(process.sasLoc, [
       '-SYSIN',
       codePath,
       '-LOG',
@@ -101,9 +99,9 @@ ${autoExecContent}`
       session.path,
       '-AUTOEXEC',
       autoExecPath,
-      isWindows() ? '-nosplash' : '',
-      isWindows() ? '-icon' : '',
-      isWindows() ? '-nologo' : ''
+      process.platform === 'win32' ? '-nosplash' : '',
+      process.platform === 'win32' ? '-icon' : '',
+      process.platform === 'win32' ? '-nologo' : ''
     ])
       .then(() => {
         session.completed = true
@@ -194,21 +192,7 @@ export class JSSessionController extends SessionController {
   }
 }
 
-export const getSessionController = (
-  runTime: RunTimeType
-): SASSessionController | JSSessionController => {
-  if (runTime === RunTimeType.SAS) {
-    return getSASSessionController()
-  }
-
-  if (runTime === RunTimeType.JS) {
-    return getJSSessionController()
-  }
-
-  throw new Error('No Runtime is configured')
-}
-
-const getSASSessionController = (): SASSessionController => {
+export const getSASSessionController = (): SASSessionController => {
   if (process.sasSessionController) return process.sasSessionController
 
   process.sasSessionController = new SASSessionController()
@@ -216,7 +200,7 @@ const getSASSessionController = (): SASSessionController => {
   return process.sasSessionController
 }
 
-const getJSSessionController = (): JSSessionController => {
+export const getJSSessionController = (): JSSessionController => {
   if (process.jsSessionController) return process.jsSessionController
 
   process.jsSessionController = new JSSessionController()

api/src/controllers/internal/createJSProgram.ts

@@ -1,4 +1,3 @@
-import { isWindows } from '@sasjs/utils'
 import { PreProgramVars, Session } from '../../types'
 import { generateFileUploadJSCode } from '../../utils'
 import { ExecutionVars } from './'
@@ -21,7 +20,9 @@ export const createJSProgram = async (
   const preProgramVarStatments = `
 let _webout = '';
 const weboutPath = '${
-    isWindows() ? weboutPath.replace(/\\/g, '\\\\') : weboutPath
+    process.platform === 'win32'
+      ? weboutPath.replace(/\\/g, '\\\\')
+      : weboutPath
   }'; 
 const _sasjs_tokenfile = '${tokenFile}';
 const _sasjs_username = '${preProgramVariables?.username}';

api/src/controllers/internal/processProgram.ts

@@ -40,7 +40,7 @@ export const processProgram = async (
       // waiting for the open event so that we can have underlying file descriptor
       await once(writeStream, 'open')
 
-      execFileSync(process.nodeLoc!, [codePath], {
+      execFileSync(process.nodeLoc, [codePath], {
         stdio: ['ignore', writeStream, writeStream]
       })
 

api/src/types/system/process.d.ts

@@ -1,7 +1,7 @@
 declare namespace NodeJS {
   export interface Process {
-    sasLoc?: string
-    nodeLoc?: string
+    sasLoc: string
+    nodeLoc: string
     driveLoc: string
     sasSessionController?: import('../../controllers/internal').SASSessionController
     jsSessionController?: import('../../controllers/internal').JSSessionController

api/src/utils/getCertificates.ts

@@ -2,11 +2,11 @@ import path from 'path'
 import { fileExists, getString, readFile } from '@sasjs/utils'
 
 export const getCertificates = async () => {
-  const { PRIVATE_KEY, CERT_CHAIN, CA_ROOT } = process.env
+  const { PRIVATE_KEY, FULL_CHAIN, CA } = process.env
 
   const keyPath = PRIVATE_KEY ?? (await getFileInput('Private Key (PEM)'))
-  const certPath = CERT_CHAIN ?? (await getFileInput('Certificate Chain (PEM)'))
-  const caPath = CA_ROOT ?? (await getFileInput('CA ROOT (PEM)'))
+  const certPath = FULL_CHAIN ?? (await getFileInput('Full Chain (PEM)'))
+  const caPath = CA ?? (await getFileInput('Full Chain (PEM)'))
 
   console.log('keyPath: ', keyPath)
   console.log('certPath: ', certPath)
@@ -19,13 +19,8 @@ export const getCertificates = async () => {
   return { key, cert, ca }
 }
 
-const getFileInput = async (
-  filename: string,
-  required: boolean = true
-): Promise<string> => {
+const getFileInput = async (filename: string): Promise<string> => {
   const validator = async (filePath: string) => {
-    if (!required) return true
-
     if (!filePath) return `Path to ${filename} is required.`
 
     if (!(await fileExists(path.join(process.cwd(), filePath)))) {

api/src/utils/getDesktopFields.ts

@@ -1,20 +1,15 @@
 import path from 'path'
 import { getString } from '@sasjs/utils/input'
-import { createFolder, fileExists, folderExists, isWindows } from '@sasjs/utils'
-import { RunTimeType } from './verifyEnvVariables'
+import { createFolder, fileExists, folderExists } from '@sasjs/utils'
+
+const isWindows = () => process.platform === 'win32'
 
 export const getDesktopFields = async () => {
   const { SAS_PATH, NODE_PATH } = process.env
 
-  let sasLoc, nodeLoc
-
-  if (process.runTimes.includes(RunTimeType.SAS)) {
-    sasLoc = SAS_PATH ?? (await getSASLocation())
-  }
-
-  if (process.runTimes.includes(RunTimeType.JS)) {
-    nodeLoc = NODE_PATH ?? (await getNodeLocation())
-  }
+  const sasLoc = SAS_PATH ?? (await getSASLocation())
+  const nodeLoc = NODE_PATH ?? (await getNodeLocation())
+  // const driveLoc = DRIVE_PATH ?? (await getDriveLocation())
 
   return { sasLoc, nodeLoc }
 }

api/src/utils/setProcessVariables.ts

@@ -9,13 +9,11 @@ export const setProcessVariables = async () => {
     return
   }
 
-  const { MODE, RUN_TIMES } = process.env
-
-  process.runTimes = (RUN_TIMES?.split(',') as RunTimeType[]) ?? []
+  const { MODE } = process.env
 
   if (MODE === ModeType.Server) {
-    process.sasLoc = process.env.SAS_PATH
-    process.nodeLoc = process.env.NODE_PATH
+    process.sasLoc = process.env.SAS_PATH as string
+    process.nodeLoc = process.env.NODE_PATH as string
   } else {
     const { sasLoc, nodeLoc } = await getDesktopFields()
 
@@ -28,6 +26,9 @@ export const setProcessVariables = async () => {
   await createFolder(absPath)
   process.driveLoc = getRealPath(absPath)
 
+  const { RUN_TIMES } = process.env
+  process.runTimes = (RUN_TIMES as string).split(',') as RunTimeType[]
+
   console.log('sasLoc: ', process.sasLoc)
   console.log('sasDrive: ', process.driveLoc)
   console.log('runTimes: ', process.runTimes)

api/src/utils/verifyEnvVariables.ts

@@ -129,16 +129,16 @@ const verifyPROTOCOL = (): string[] => {
   }
 
   if (process.env.PROTOCOL === ProtocolType.HTTPS) {
-    const { PRIVATE_KEY, CERT_CHAIN } = process.env
+    const { PRIVATE_KEY, FULL_CHAIN } = process.env
 
     if (!PRIVATE_KEY)
       errors.push(
         `- PRIVATE_KEY is required for PROTOCOL '${ProtocolType.HTTPS}'`
       )
 
-    if (!CERT_CHAIN)
+    if (!FULL_CHAIN)
       errors.push(
-        `- CERT_CHAIN is required for PROTOCOL '${ProtocolType.HTTPS}'`
+        `- FULL_CHAIN is required for PROTOCOL '${ProtocolType.HTTPS}'`
       )
   }
 
@@ -258,5 +258,5 @@ const DEFAULTS = {
   PORT: '5000',
   HELMET_COEP: HelmetCoepType.TRUE,
   LOG_FORMAT_MORGAN: LOG_FORMAT_MORGANType.Common,
-  RUN_TIMES: RunTimeType.SAS
+  RUN_TIMES: `${RunTimeType.SAS}`
 }