mirror of
https://github.com/cupcakearmy/cryptgeon.git
synced 2024-12-22 16:26:28 +00:00
also expose internal shared functionality for external usage
This commit is contained in:
parent
a37a0932e0
commit
1a2728d21f
@ -1,5 +1,4 @@
|
|||||||
{
|
{
|
||||||
"packageManager": "pnpm@8.10.1",
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev:docker": "docker-compose -f docker-compose.dev.yaml up redis",
|
"dev:docker": "docker-compose -f docker-compose.dev.yaml up redis",
|
||||||
"dev:packages": "pnpm --parallel run dev",
|
"dev:packages": "pnpm --parallel run dev",
|
||||||
@ -17,5 +16,6 @@
|
|||||||
"@types/node": "^20.8.10",
|
"@types/node": "^20.8.10",
|
||||||
"npm-run-all": "^4.1.5",
|
"npm-run-all": "^4.1.5",
|
||||||
"shelljs": "^0.8.5"
|
"shelljs": "^0.8.5"
|
||||||
}
|
},
|
||||||
|
"packageManager": "pnpm@8.15.4"
|
||||||
}
|
}
|
||||||
|
@ -1,30 +1,33 @@
|
|||||||
{
|
{
|
||||||
"version": "2.4.0",
|
|
||||||
"name": "cryptgeon",
|
"name": "cryptgeon",
|
||||||
|
"version": "2.4.0",
|
||||||
|
"homepage": "https://github.com/cupcakearmy/cryptgeon",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/cupcakearmy/cryptgeon.git",
|
"url": "https://github.com/cupcakearmy/cryptgeon.git",
|
||||||
"directory": "packages/cli"
|
"directory": "packages/cli"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/cupcakearmy/cryptgeon",
|
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"engines": {
|
"exports": {
|
||||||
"node": ">=18"
|
".": {
|
||||||
|
"types": "./dist/index.d.ts",
|
||||||
|
"import": "./dist/index.js"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"scripts": {
|
"types": "./dist/index.d.ts",
|
||||||
"dev": "./scripts/build.js --watch",
|
|
||||||
"build": "./scripts/build.js",
|
|
||||||
"package": "./scripts/package.js",
|
|
||||||
"bin": "run-s build package",
|
|
||||||
"prepublishOnly": "run-s build"
|
|
||||||
},
|
|
||||||
"main": "./dist/index.cjs",
|
|
||||||
"bin": {
|
"bin": {
|
||||||
"cryptgeon": "./dist/index.cjs"
|
"cryptgeon": "./dist/cli.cjs"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"dist"
|
"dist"
|
||||||
],
|
],
|
||||||
|
"scripts": {
|
||||||
|
"bin": "run-s build package",
|
||||||
|
"build": "tsc && ./scripts/build.js",
|
||||||
|
"dev": "./scripts/build.js --watch",
|
||||||
|
"package": "./scripts/package.js",
|
||||||
|
"prepublishOnly": "run-s build"
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commander-js/extra-typings": "^11.1.0",
|
"@commander-js/extra-typings": "^11.1.0",
|
||||||
"@cryptgeon/shared": "workspace:*",
|
"@cryptgeon/shared": "workspace:*",
|
||||||
@ -39,5 +42,8 @@
|
|||||||
"pkg": "^5.8.1",
|
"pkg": "^5.8.1",
|
||||||
"pretty-bytes": "^6.1.1",
|
"pretty-bytes": "^6.1.1",
|
||||||
"typescript": "^5.2.2"
|
"typescript": "^5.2.2"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -4,14 +4,28 @@ import { build, context } from 'esbuild'
|
|||||||
import pkg from '../package.json' assert { type: 'json' }
|
import pkg from '../package.json' assert { type: 'json' }
|
||||||
|
|
||||||
const options = {
|
const options = {
|
||||||
entryPoints: ['./src/index.ts'],
|
entryPoints: ['./src/cli.ts'],
|
||||||
bundle: true,
|
bundle: true,
|
||||||
minify: true,
|
minify: true,
|
||||||
platform: 'node',
|
platform: 'node',
|
||||||
outfile: './dist/index.cjs',
|
outfile: './dist/cli.cjs',
|
||||||
define: { VERSION: `"${pkg.version}"` },
|
define: { VERSION: `"${pkg.version}"` },
|
||||||
}
|
}
|
||||||
|
|
||||||
const watch = process.argv.slice(2)[0] === '--watch'
|
const watch = process.argv.slice(2)[0] === '--watch'
|
||||||
if (watch) (await context(options)).watch()
|
if (watch) {
|
||||||
else await build(options)
|
;(await context(options)).watch()
|
||||||
|
} else {
|
||||||
|
await build(options)
|
||||||
|
|
||||||
|
// Also build internals to expose
|
||||||
|
await build({
|
||||||
|
entryPoints: ['./src/index.ts'],
|
||||||
|
bundle: true,
|
||||||
|
minify: true,
|
||||||
|
platform: 'node',
|
||||||
|
format: 'esm',
|
||||||
|
outfile: './dist/index.js',
|
||||||
|
define: { VERSION: `"${pkg.version}"` },
|
||||||
|
})
|
||||||
|
}
|
||||||
|
@ -13,5 +13,5 @@ const targets = [
|
|||||||
|
|
||||||
for (const target of targets) {
|
for (const target of targets) {
|
||||||
console.log(`🚀 Building ${target}`)
|
console.log(`🚀 Building ${target}`)
|
||||||
await exec(['./dist/index.cjs', '--target', target, '--output', `./bin/${target.replace('node18', 'cryptgeon')}`])
|
await exec(['./dist/cli.cjs', '--target', target, '--output', `./bin/${target.replace('node18', 'cryptgeon')}`])
|
||||||
}
|
}
|
||||||
|
106
packages/cli/src/cli.ts
Normal file
106
packages/cli/src/cli.ts
Normal file
@ -0,0 +1,106 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
import { Argument, Option, program } from '@commander-js/extra-typings'
|
||||||
|
import { setBase, status } from '@cryptgeon/shared'
|
||||||
|
import prettyBytes from 'pretty-bytes'
|
||||||
|
|
||||||
|
import { download } from './download.js'
|
||||||
|
import { parseFile, parseNumber } from './parsers.js'
|
||||||
|
import { getStdin } from './stdin.js'
|
||||||
|
import { upload } from './upload.js'
|
||||||
|
import { checkConstrains, exit } from './utils.js'
|
||||||
|
|
||||||
|
const defaultServer = process.env['CRYPTGEON_SERVER'] || 'https://cryptgeon.org'
|
||||||
|
const server = new Option('-s --server <url>', 'the cryptgeon server to use').default(defaultServer)
|
||||||
|
const files = new Argument('<file...>', 'Files to be sent').argParser(parseFile)
|
||||||
|
const text = new Argument('<text>', 'Text content of the note')
|
||||||
|
const password = new Option('-p --password <string>', 'manually set a password')
|
||||||
|
const all = new Option('-a --all', 'Save all files without prompt').default(false)
|
||||||
|
const url = new Argument('<url>', 'The url to open')
|
||||||
|
const views = new Option('-v --views <number>', 'Amount of views before getting destroyed').argParser(parseNumber)
|
||||||
|
const minutes = new Option('-m --minutes <number>', 'Minutes before the note expires').argParser(parseNumber)
|
||||||
|
|
||||||
|
// Node 18 guard
|
||||||
|
parseInt(process.version.slice(1).split(',')[0]) < 18 && exit('Node 18 or higher is required')
|
||||||
|
|
||||||
|
// @ts-ignore
|
||||||
|
const version: string = VERSION
|
||||||
|
|
||||||
|
program.name('cryptgeon').version(version).configureHelp({ showGlobalOptions: true })
|
||||||
|
|
||||||
|
program
|
||||||
|
.command('info')
|
||||||
|
.description('show information about the server')
|
||||||
|
.addOption(server)
|
||||||
|
.action(async (options) => {
|
||||||
|
setBase(options.server)
|
||||||
|
const response = await status()
|
||||||
|
const formatted = {
|
||||||
|
...response,
|
||||||
|
max_size: prettyBytes(response.max_size),
|
||||||
|
}
|
||||||
|
for (const key of Object.keys(formatted)) {
|
||||||
|
if (key.startsWith('theme_')) delete formatted[key as keyof typeof formatted]
|
||||||
|
}
|
||||||
|
console.table(formatted)
|
||||||
|
})
|
||||||
|
|
||||||
|
const send = program.command('send').description('send a note')
|
||||||
|
send
|
||||||
|
.command('file')
|
||||||
|
.addArgument(files)
|
||||||
|
.addOption(server)
|
||||||
|
.addOption(views)
|
||||||
|
.addOption(minutes)
|
||||||
|
.addOption(password)
|
||||||
|
.action(async (files, options) => {
|
||||||
|
setBase(options.server!)
|
||||||
|
await checkConstrains(options)
|
||||||
|
options.password ||= await getStdin()
|
||||||
|
try {
|
||||||
|
const url = await upload(files, { views: options.views, expiration: options.minutes, password: options.password })
|
||||||
|
console.log(`Note created:\n\n${url}`)
|
||||||
|
} catch {
|
||||||
|
exit('Could not create note')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
send
|
||||||
|
.command('text')
|
||||||
|
.addArgument(text)
|
||||||
|
.addOption(server)
|
||||||
|
.addOption(views)
|
||||||
|
.addOption(minutes)
|
||||||
|
.addOption(password)
|
||||||
|
.action(async (text, options) => {
|
||||||
|
setBase(options.server!)
|
||||||
|
await checkConstrains(options)
|
||||||
|
options.password ||= await getStdin()
|
||||||
|
try {
|
||||||
|
const url = await upload(text, { views: options.views, expiration: options.minutes, password: options.password })
|
||||||
|
console.log(`Note created:\n\n${url}`)
|
||||||
|
} catch {
|
||||||
|
exit('Could not create note')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
program
|
||||||
|
.command('open')
|
||||||
|
.description('open a link with text or files inside')
|
||||||
|
.addArgument(url)
|
||||||
|
.addOption(password)
|
||||||
|
.addOption(all)
|
||||||
|
.action(async (note, options) => {
|
||||||
|
try {
|
||||||
|
const url = new URL(note)
|
||||||
|
options.password ||= await getStdin()
|
||||||
|
try {
|
||||||
|
await download(url, options.all, options.password)
|
||||||
|
} catch (e) {
|
||||||
|
exit(e instanceof Error ? e.message : 'Unknown error occurred')
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
exit('Invalid URL')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
program.parse()
|
@ -5,12 +5,12 @@ import { basename, resolve } from 'node:path'
|
|||||||
import { AES, Hex } from 'occulto'
|
import { AES, Hex } from 'occulto'
|
||||||
import pretty from 'pretty-bytes'
|
import pretty from 'pretty-bytes'
|
||||||
|
|
||||||
import { exit } from './utils'
|
|
||||||
|
|
||||||
export async function download(url: URL, all: boolean, suggestedPassword?: string) {
|
export async function download(url: URL, all: boolean, suggestedPassword?: string) {
|
||||||
setBase(url.origin)
|
setBase(url.origin)
|
||||||
const id = url.pathname.split('/')[2]
|
const id = url.pathname.split('/')[2]
|
||||||
const preview = await info(id).catch(() => exit('Note does not exist or is expired'))
|
const preview = await info(id).catch(() => {
|
||||||
|
throw new Error('Note does not exist or is expired')
|
||||||
|
})
|
||||||
|
|
||||||
// Password
|
// Password
|
||||||
let password: string
|
let password: string
|
||||||
@ -35,13 +35,14 @@ export async function download(url: URL, all: boolean, suggestedPassword?: strin
|
|||||||
const key = derivation ? (await AES.derive(password, derivation))[0] : Hex.decode(password)
|
const key = derivation ? (await AES.derive(password, derivation))[0] : Hex.decode(password)
|
||||||
const note = await get(id)
|
const note = await get(id)
|
||||||
|
|
||||||
const couldNotDecrypt = () => exit('Could not decrypt note. Probably an invalid password')
|
const couldNotDecrypt = new Error('Could not decrypt note. Probably an invalid password')
|
||||||
switch (note.meta.type) {
|
switch (note.meta.type) {
|
||||||
case 'file':
|
case 'file':
|
||||||
const files = await Adapters.Files.decrypt(note.contents, key).catch(couldNotDecrypt)
|
const files = await Adapters.Files.decrypt(note.contents, key).catch(() => {
|
||||||
|
throw couldNotDecrypt
|
||||||
|
})
|
||||||
if (!files) {
|
if (!files) {
|
||||||
exit('No files found in note')
|
throw new Error('No files found in note')
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let selected: typeof files
|
let selected: typeof files
|
||||||
@ -63,7 +64,7 @@ export async function download(url: URL, all: boolean, suggestedPassword?: strin
|
|||||||
selected = files.filter((file) => names.includes(file.name))
|
selected = files.filter((file) => names.includes(file.name))
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!selected.length) exit('No files selected')
|
if (!selected.length) throw new Error('No files selected')
|
||||||
await Promise.all(
|
await Promise.all(
|
||||||
selected.map(async (file) => {
|
selected.map(async (file) => {
|
||||||
let filename = resolve(file.name)
|
let filename = resolve(file.name)
|
||||||
@ -79,7 +80,9 @@ export async function download(url: URL, all: boolean, suggestedPassword?: strin
|
|||||||
|
|
||||||
break
|
break
|
||||||
case 'text':
|
case 'text':
|
||||||
const plaintext = await Adapters.Text.decrypt(note.contents, key).catch(couldNotDecrypt)
|
const plaintext = await Adapters.Text.decrypt(note.contents, key).catch(() => {
|
||||||
|
throw couldNotDecrypt
|
||||||
|
})
|
||||||
console.log(plaintext)
|
console.log(plaintext)
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
@ -1,104 +1,4 @@
|
|||||||
#!/usr/bin/env node
|
export * from '@cryptgeon/shared'
|
||||||
|
export * from './download.js'
|
||||||
import { Argument, Option, program } from '@commander-js/extra-typings'
|
export * from './upload.js'
|
||||||
import { setBase, status } from '@cryptgeon/shared'
|
export * from './utils.js'
|
||||||
import prettyBytes from 'pretty-bytes'
|
|
||||||
|
|
||||||
import { download } from './download.js'
|
|
||||||
import { parseFile, parseNumber } from './parsers.js'
|
|
||||||
import { getStdin } from './stdin.js'
|
|
||||||
import { upload } from './upload.js'
|
|
||||||
import { exit } from './utils.js'
|
|
||||||
|
|
||||||
const defaultServer = process.env['CRYPTGEON_SERVER'] || 'https://cryptgeon.org'
|
|
||||||
const server = new Option('-s --server <url>', 'the cryptgeon server to use').default(defaultServer)
|
|
||||||
const files = new Argument('<file...>', 'Files to be sent').argParser(parseFile)
|
|
||||||
const text = new Argument('<text>', 'Text content of the note')
|
|
||||||
const password = new Option('-p --password <string>', 'manually set a password')
|
|
||||||
const all = new Option('-a --all', 'Save all files without prompt').default(false)
|
|
||||||
const url = new Argument('<url>', 'The url to open')
|
|
||||||
const views = new Option('-v --views <number>', 'Amount of views before getting destroyed').argParser(parseNumber)
|
|
||||||
const minutes = new Option('-m --minutes <number>', 'Minutes before the note expires').argParser(parseNumber)
|
|
||||||
|
|
||||||
// Node 18 guard
|
|
||||||
parseInt(process.version.slice(1).split(',')[0]) < 18 && exit('Node 18 or higher is required')
|
|
||||||
|
|
||||||
// @ts-ignore
|
|
||||||
const version: string = VERSION
|
|
||||||
|
|
||||||
async function checkConstrains(constrains: { views?: number; minutes?: number }) {
|
|
||||||
const { views, minutes } = constrains
|
|
||||||
if (views && minutes) exit('cannot set view and minutes constrains simultaneously')
|
|
||||||
if (!views && !minutes) constrains.views = 1
|
|
||||||
|
|
||||||
const response = await status()
|
|
||||||
if (views && views > response.max_views)
|
|
||||||
exit(`Only a maximum of ${response.max_views} views allowed. ${views} given.`)
|
|
||||||
if (minutes && minutes > response.max_expiration)
|
|
||||||
exit(`Only a maximum of ${response.max_expiration} minutes allowed. ${minutes} given.`)
|
|
||||||
}
|
|
||||||
|
|
||||||
program.name('cryptgeon').version(version).configureHelp({ showGlobalOptions: true })
|
|
||||||
|
|
||||||
program
|
|
||||||
.command('info')
|
|
||||||
.description('show information about the server')
|
|
||||||
.addOption(server)
|
|
||||||
.action(async (options) => {
|
|
||||||
setBase(options.server)
|
|
||||||
const response = await status()
|
|
||||||
const formatted = {
|
|
||||||
...response,
|
|
||||||
max_size: prettyBytes(response.max_size),
|
|
||||||
}
|
|
||||||
for (const key of Object.keys(formatted)) {
|
|
||||||
if (key.startsWith('theme_')) delete formatted[key as keyof typeof formatted]
|
|
||||||
}
|
|
||||||
console.table(formatted)
|
|
||||||
})
|
|
||||||
|
|
||||||
const send = program.command('send').description('send a note')
|
|
||||||
send
|
|
||||||
.command('file')
|
|
||||||
.addArgument(files)
|
|
||||||
.addOption(server)
|
|
||||||
.addOption(views)
|
|
||||||
.addOption(minutes)
|
|
||||||
.addOption(password)
|
|
||||||
.action(async (files, options) => {
|
|
||||||
setBase(options.server!)
|
|
||||||
await checkConstrains(options)
|
|
||||||
options.password ||= await getStdin()
|
|
||||||
await upload(files, { views: options.views, expiration: options.minutes, password: options.password })
|
|
||||||
})
|
|
||||||
send
|
|
||||||
.command('text')
|
|
||||||
.addArgument(text)
|
|
||||||
.addOption(server)
|
|
||||||
.addOption(views)
|
|
||||||
.addOption(minutes)
|
|
||||||
.addOption(password)
|
|
||||||
.action(async (text, options) => {
|
|
||||||
setBase(options.server!)
|
|
||||||
await checkConstrains(options)
|
|
||||||
options.password ||= await getStdin()
|
|
||||||
await upload(text, { views: options.views, expiration: options.minutes, password: options.password })
|
|
||||||
})
|
|
||||||
|
|
||||||
program
|
|
||||||
.command('open')
|
|
||||||
.description('open a link with text or files inside')
|
|
||||||
.addArgument(url)
|
|
||||||
.addOption(password)
|
|
||||||
.addOption(all)
|
|
||||||
.action(async (note, options) => {
|
|
||||||
try {
|
|
||||||
const url = new URL(note)
|
|
||||||
options.password ||= await getStdin()
|
|
||||||
await download(url, options.all, options.password)
|
|
||||||
} catch {
|
|
||||||
exit('Invalid URL')
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
program.parse()
|
|
||||||
|
@ -3,14 +3,11 @@ import { basename } from 'node:path'
|
|||||||
|
|
||||||
import { Adapters, BASE, create, FileDTO, Note, NoteMeta } from '@cryptgeon/shared'
|
import { Adapters, BASE, create, FileDTO, Note, NoteMeta } from '@cryptgeon/shared'
|
||||||
import mime from 'mime'
|
import mime from 'mime'
|
||||||
import { AES, Hex, TypedArray } from 'occulto'
|
import { AES, Hex } from 'occulto'
|
||||||
|
|
||||||
import { exit } from './utils.js'
|
|
||||||
|
|
||||||
type UploadOptions = Pick<Note, 'views' | 'expiration'> & { password?: string }
|
type UploadOptions = Pick<Note, 'views' | 'expiration'> & { password?: string }
|
||||||
|
|
||||||
export async function upload(input: string | string[], options: UploadOptions) {
|
export async function upload(input: string | string[], options: UploadOptions): Promise<string> {
|
||||||
try {
|
|
||||||
const { password, ...noteOptions } = options
|
const { password, ...noteOptions } = options
|
||||||
const derived = options.password ? await AES.derive(options.password) : undefined
|
const derived = options.password ? await AES.derive(options.password) : undefined
|
||||||
const key = derived ? derived[0] : await AES.generateKey()
|
const key = derived ? derived[0] : await AES.generateKey()
|
||||||
@ -44,8 +41,5 @@ export async function upload(input: string | string[], options: UploadOptions) {
|
|||||||
const result = await create(note)
|
const result = await create(note)
|
||||||
let url = `${BASE}/note/${result.id}`
|
let url = `${BASE}/note/${result.id}`
|
||||||
if (!derived) url += `#${Hex.encode(key)}`
|
if (!derived) url += `#${Hex.encode(key)}`
|
||||||
console.log(`Note created:\n\n${url}`)
|
return url
|
||||||
} catch {
|
|
||||||
exit('Could not create note')
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,19 @@
|
|||||||
|
import { status } from '@cryptgeon/shared'
|
||||||
import { exit as exitNode } from 'node:process'
|
import { exit as exitNode } from 'node:process'
|
||||||
|
|
||||||
export function exit(message: string) {
|
export function exit(message: string) {
|
||||||
console.error(message)
|
console.error(message)
|
||||||
exitNode(1)
|
exitNode(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export async function checkConstrains(constrains: { views?: number; minutes?: number }) {
|
||||||
|
const { views, minutes } = constrains
|
||||||
|
if (views && minutes) exit('cannot set view and minutes constrains simultaneously')
|
||||||
|
if (!views && !minutes) constrains.views = 1
|
||||||
|
|
||||||
|
const response = await status()
|
||||||
|
if (views && views > response.max_views)
|
||||||
|
exit(`Only a maximum of ${response.max_views} views allowed. ${views} given.`)
|
||||||
|
if (minutes && minutes > response.max_expiration)
|
||||||
|
exit(`Only a maximum of ${response.max_expiration} minutes allowed. ${minutes} given.`)
|
||||||
|
}
|
||||||
|
@ -3,8 +3,11 @@
|
|||||||
"target": "es2022",
|
"target": "es2022",
|
||||||
"module": "es2022",
|
"module": "es2022",
|
||||||
"moduleResolution": "node",
|
"moduleResolution": "node",
|
||||||
"noEmit": true,
|
"declaration": true,
|
||||||
|
"emitDeclarationOnly": true,
|
||||||
"strict": true,
|
"strict": true,
|
||||||
|
"outDir": "./dist",
|
||||||
|
"rootDir": "./src",
|
||||||
"allowSyntheticDefaultImports": true
|
"allowSyntheticDefaultImports": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
736
pnpm-lock.yaml
generated
736
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user