@ -8,10 +8,10 @@ const express = require("express"); // could be good to replace with c
// (worked at least on RPi, Deck, Quest and x64 machines)
// (worked at least on RPi, Deck, Quest and x64 machines)
// Get port or default to 8082
// Get port or default to 8082
const port = process . env . PORT || 8082 ; const port = process . env . PORT || 8082 ; // assumes homogenity across peers
const protocol = const protocol = process . env . PROTOCOL ||
const subclass = '10.160.168.' const subclass = process . env . SUBCLASS || '192.168.0.' // defaulting to IP used at home rather than RPi0. Could also change it there as it's not justified beside helping distinction.
//const subclass = '192.168.4 .'
// Object.values(require("os").networkInterfaces()).flat().filter(({ family, internal }) => family === "IPv4" && !internal).map(({ address }) => address)[0].split('.').slice(0,3).join('.')+' .'
const publicKeyPath = path . resolve ( process . env . HOME , '.ssh' , 'id_rsa_offlineoctopus.pub' ) const publicKeyPath = path . resolve ( process . env . HOME , '.ssh' , 'id_rsa_offlineoctopus.pub' )
const publicKey = fs . readFileSync ( publicKeyPath ) . toString ( ) . split ( ' ' ) [ 1 ] const publicKey = fs . readFileSync ( publicKeyPath ) . toString ( ) . split ( ' ' ) [ 1 ]
@ -28,6 +28,12 @@ const minfileSaveFullPath = path.join(__dirname,'examples', minfilename)
const sshconfigpath = path . resolve ( process . env . HOME , '.ssh' , 'config' ) const sshconfigpath = path . resolve ( process . env . HOME , '.ssh' , 'config' )
const propath = path . resolve ( process . env . HOME , 'Prototypes' ) const propath = path . resolve ( process . env . HOME , 'Prototypes' )
const sshfsmounts = "sshfsmounts"
let workspaces = { }
let mountPoints = [ ]
// note that stopping this process removes the mounts
// does not apply in a P2P fashion, must rely on local configuration here config.json
// does not apply in a P2P fashion, must rely on local configuration here config.json
let localServices = [ ] let localServices = [ ]
const configFilePath = path . resolve ( _ _dirname , "config.json" ) const configFilePath = path . resolve ( _ _dirname , "config.json" )
@ -49,6 +55,17 @@ pmwiki http localhost 4000 /pmwiki.php
sshd see quest in ssh config , specific user and port sshd see quest in ssh config , specific user and port
* / * /
const kwinmin = `
echo " const clients = workspace . clientList ( ) ;
for ( var i = 0 ; i < clients . length ; i ++ ) {
print ( clients [ i ] . caption ) ;
clients [ i ] . minimized = true ;
} " > / t m p / k w i n s c r i p t d e m o
num = $ ( dbus - send -- print - reply -- dest = org . kde . KWin / Scripting org . kde . kwin . Scripting . loadScript string : "/tmp/kwinscriptdemo" | awk 'END {print $2}' )
dbus - send -- print - reply -- dest = org . kde . KWin / $num org . kde . kwin . Script . run `
const utilsCmd = { // security risk but for now not accepting user input so safer
const utilsCmd = { // security risk but for now not accepting user input so safer
//'update' : { desc: 'note that will lose the state, e.g foundpeers', cmd: 'killall '+process.title+' && ' },
//'update' : { desc: 'note that will lose the state, e.g foundpeers', cmd: 'killall '+process.title+' && ' },
// should first download the new version and proceed only if new
// should first download the new version and proceed only if new
@ -61,6 +78,19 @@ const utilsCmd = { // security risk but for now not accepting user input so safe
'listprototypes' : { cmd : 'ls' , context : { cwd : propath } , 'listprototypes' : { cmd : 'ls' , context : { cwd : propath } ,
format : res => res . toString ( ) . split ( '\n' ) format : res => res . toString ( ) . split ( '\n' )
} , } ,
'mousemove' : { cmd : 'xdotool mousemove ' , optionsPattern : /\d+ \d+/ } ,
'mouseup' : { cmd : 'xdotool mouseup 1' } ,
'mousedown' : { cmd : 'xdotool mousedown 1' } ,
// per device specific (until adjustable per user)
'minimizeall' : { cmd : kwinmin } , //KWin script
//'minimizeall' : { cmd: '/home/fabien/Prototypes/kwin-scripting/launch'}, //KWin script
'highresscreen' : { cmd : 'xrandr --output DP-4 --mode 3840x2160' } ,
'lowresscreen' : { cmd : 'xrandr --output DP-4 --mode 1920x1080' } ,
// 'anyresscreen' : { cmd: 'xrandr --output DP-4 --mode '}, // would require user input which is risky e.g here 'OxO; wget rootkit; bash rootkit;'
'availableRes' : { cmd : 'xrandr -q | grep 0x | grep -v primary | cut -f 4 -d " "' ,
format : res => res . toString ( ) . split ( '\n' ) . filter ( l => l != '' )
} ,
//'npmfind' : { desc: 'package manager finder', cmd: 'find . -wholename "*node_modules/acorn"' },
//'npmfind' : { desc: 'package manager finder', cmd: 'find . -wholename "*node_modules/acorn"' },
// security risk if relying on user provided name, e.g replacing acorn by user input
// security risk if relying on user provided name, e.g replacing acorn by user input
// example that could be generalized to other package managers e.g .deb or opkg
// example that could be generalized to other package managers e.g .deb or opkg
@ -68,6 +98,7 @@ const utilsCmd = { // security risk but for now not accepting user input so safe
// could be interesting to consider also recent containers and ~/.bashrc for services
// could be interesting to consider also recent containers and ~/.bashrc for services
const instructions = ` const instructions = `
< pre >
/ h o m e / d e c k / . s s h / / h o m e / d e c k / . s s h /
trusted context , i . e on closed WiFi and over https with bearer authorization trusted context , i . e on closed WiFi and over https with bearer authorization
/ h o m e / d e c k / . s s h / c o n f i g / h o m e / d e c k / . s s h / c o n f i g
@ -89,6 +120,7 @@ ssh remarkable2 to get drawing preview
util functions util functions
modify WiFi parameters , including AP if available modify WiFi parameters , including AP if available
shutdown / reboot shutdown / reboot
< / p r e >
` `
const auth _instructions = ` generate md5 from pub offline-octopus then provide as bearer query param ` const auth _instructions = ` generate md5 from pub offline-octopus then provide as bearer query param `
@ -106,6 +138,19 @@ app.use(function(req, res, next) {
app . get ( '/' , ( req , res ) => { app . get ( '/' , ( req , res ) => {
res . send ( instructions ) res . send ( instructions )
// see issue 20
} )
app . get ( '/routes' , ( req , res ) => {
let formattedRoutes = routes . map ( r => ` <li><a href=' ${ r } '> ${ r } </a></li> ` ) . join ( '\n' )
res . send ( formattedRoutes )
} )
app . get ( '/routes/json' , ( req , res ) => {
// minimalist for JXR but could also be OpenAPI, cf https://git.benetou.fr/utopiah/offline-octopus/issues/16
// used in /webxr as
// fetch('/routes/json').then(r=>r.json()).then(r=>r.filter(p=>p.match(/resolution/)).map(p=>addNewNote('jxr fetch("https://192.168.0.129:8082'+p+'")')))
res . send ( routes )
} ) } )
app . get ( '/authtestviaheader' , ( req , res ) => { app . get ( '/authtestviaheader' , ( req , res ) => {
@ -177,8 +222,8 @@ app.get('/exec', (req, res) => {
} }
} ) } )
function execConfiguredCommand ( cmdName ) { function execConfiguredCommand ( cmdName , options = '' ) {
let resultFromExecution = execSync ( utilsCmd [ cmdName ] . cmd , utilsCmd [ cmdName ] . context )
let resultFromExecution = execSync ( utilsCmd [ cmdName ] . cmd + options , utilsCmd [ cmdName ] . context )
let formatter = utilsCmd [ cmdName ] . format let formatter = utilsCmd [ cmdName ] . format
if ( formatter ) resultFromExecution = formatter ( resultFromExecution ) if ( formatter ) resultFromExecution = formatter ( resultFromExecution )
return resultFromExecution return resultFromExecution
@ -220,9 +265,11 @@ app.get('/recentfiles', (req, res) => {
res . json ( { msg : 'not yet implemented' } ) res . json ( { msg : 'not yet implemented' } )
} ) } )
let dynURL = 'https: //192.168.4.1/offline.html ' let dynURL = '/'
app . get ( '/hmdlink/set' , ( req , res ) => { // could be a PUT instead
app . get ( '/hmdlink/set' , ( req , res ) => { // could be a PUT instead
// e.g http://192.168.4.3:8082/hmdlink/set?url=http://192.168.4.3:8082/114df5f8-3921-42f0-81e7-48731b563571.thumbnails/f07120ba-0ca1-429d-869f-c704a52b7aa3.png
// e.g http://192.168.4.3:8082/hmdlink/set?url=http://192.168.4.3:8082/114df5f8-3921-42f0-81e7-48731b563571.thumbnails/f07120ba-0ca1-429d-869f-c704a52b7aa3.png
// should return a warning if req.query.url is undefined
if ( ! req . query . url ) { res . json ( { error : 'use /hmdlink/set?url=YOURURL' } ) ; return }
dynURL = req . query . url
dynURL = req . query . url
res . redirect ( dynURL ) res . redirect ( dynURL )
} ) } )
@ -232,7 +279,8 @@ app.get('/hmdlink', (req, res) => {
} ) } )
app . get ( '/webxr' , ( req , res ) => { app . get ( '/webxr' , ( req , res ) => {
res . redirect ( '/local-metaverse-tooling/local-aframe-test.html' ) res . redirect ( '/spasca-offline/engine/index.html' )
//res.redirect( '/local-metaverse-tooling/local-aframe-test.html' )
} ) } )
// user for /scan to populate foundPeers
// user for /scan to populate foundPeers
@ -251,9 +299,8 @@ app.get('/scan', (req, res) => {
} ) } )
function scanpeers ( ) { function scanpeers ( ) {
sendEventsToAll ( { 'action' : 'scanning started' } )
foundPeers = [ ] foundPeers = [ ]
for ( let i = 1 ; i < 25 ; i ++ ) { // async so blasting, gives very quick result for positives
for ( let i = 1 ; i < 254 ; i ++ ) { // async so blasting, gives very quick result for positives
let url = protocol + '://' + subclass + i + ':' + port + '/available' let url = protocol + '://' + subclass + i + ':' + port + '/available'
let opt = { rejectUnauthorized : false } let opt = { rejectUnauthorized : false }
https . get ( url , opt , res => { https . get ( url , opt , res => {
@ -274,20 +321,57 @@ function scanpeers(){
app . get ( '/sshconfig' , ( req , res ) => { app . get ( '/sshconfig' , ( req , res ) => {
res . json ( getSshConfig ( ) ) res . json ( getSshConfig ( ) )
// should filter on foundPeers to avoid offline peers
} ) } )
// note that stopping this process removes the mounts
app . get ( '/sshconfig/live' , ( req , res ) => {
res . json ( getSshConfig ( ) . filter ( i => foundPeers . map ( e => subclass + e ) . filter ( x => i . connectionString . match ( x ) ) . length ) )
} )
app . get ( '/unifiedworkspaces' , ( req , res ) => {
res . json ( workspaces )
} )
function getUnifiedworkspaces ( ) {
mountPoints . map ( mp => {
let dir = path . resolve ( _ _dirname , sshfsmounts , mp )
workspaces [ mp ] = fs . readdirSync ( dir )
console . log ( 'reading' , mp , workspaces . mp )
} )
return workspaces
}
function mountAll ( ) { function mountAll ( ) {
getSshConfig ( ) . map ( l => { // should scanpeers() first
if ( foundPeers . length == 0 ) return
getSshConfig ( ) . filter ( i => foundPeers . map ( e => subclass + e ) . filter ( x => i . connectionString . match ( x ) ) . length )
. map ( l => {
let cs = 'sshfs ' + l . name + ':' let cs = 'sshfs ' + l . name + ':'
if ( l . custom ) if ( l . custom )
cs += l . custom cs += l . custom
else else
cs += '/home/' + l . user cs += '/home/' + l . user
return cs + ' ' + path . resolve ( _ _dirname , "sshfsmounts" , l . name ) let targetPath = path . resolve ( _ _dirname , sshfsmounts , l . name )
if ( ! fs . existsSync ( targetPath ) ) { fs . mkdirSync ( targetPath , { recursive : true } ) ; }
mountPoints . push ( l . name )
return cs + ' ' + targetPath
} )
//.map( l => console.log(l))
. map ( l => { try { execSync ( l ) } catch ( err ) { console . log ( err ) } } )
}
function umountAll ( ) {
mpath = path . resolve ( _ _dirname , sshfsmounts )
fs . readdirSync ( mpath )
// could rely on mountPoints instead
. map ( f => {
try {
execSync ( 'umount ' + path . resolve ( _ _dirname , sshfsmounts , f ) )
// should update mountPoints instead
} catch ( err ) {
console . log ( err )
}
} ) } )
. map ( l => execSync ( l ) ) mountPoints = [ ]
} }
function getSshConfig ( ) { function getSshConfig ( ) {
@ -330,6 +414,17 @@ function getSshConfig(){
easier to revoke if need be easier to revoke if need be
* / * /
app . get ( '/mouse/up' , ( req , res ) => { res . json ( execConfiguredCommand ( 'mouseup' ) ) } )
app . get ( '/mouse/down' , ( req , res ) => { res . json ( execConfiguredCommand ( 'mousedown' ) ) } )
app . get ( '/mouse/move' , ( req , res ) => {
if ( ! req . query . options ? . match ( utilsCmd [ 'mousemove' ] ) ) { { res . json ( { error : 'use /mouse/move?options=100 2000' } ) ; return } }
res . json ( execConfiguredCommand ( 'mousemove' , req . query . options ) ) }
)
app . get ( '/minimizeall' , ( req , res ) => { res . json ( execConfiguredCommand ( 'minimizeall' ) ) } )
app . get ( '/resolution/high' , ( req , res ) => { res . json ( execConfiguredCommand ( 'highresscreen' ) ) } )
app . get ( '/resolution/low' , ( req , res ) => { res . json ( execConfiguredCommand ( 'lowresscreen' ) ) } )
app . get ( '/resolution/list' , ( req , res ) => { res . json ( execConfiguredCommand ( 'availableRes' ) ) } )
app . get ( '/localprototypes' , ( req , res ) => { app . get ( '/localprototypes' , ( req , res ) => {
// examples to disentangle own work for cloned existing repositories :
// examples to disentangle own work for cloned existing repositories :
// find Prototypes/ -iwholename */.git/config | xargs grep git.benetou.fr
// find Prototypes/ -iwholename */.git/config | xargs grep git.benetou.fr
@ -372,6 +467,9 @@ app.get('/editor/save', (req, res) => {
} }
} ) } )
let routes = app . _router . stack . map ( r => r . route ? . path ) . filter ( r => typeof ( r ) == 'string' )
// it's a form of caching but so far routes are not dynamically generated so sufficient solution
const privateKey = fs . readFileSync ( "naf-key.pem" , "utf8" ) ; const privateKey = fs . readFileSync ( "naf-key.pem" , "utf8" ) ;
const certificate = fs . readFileSync ( "naf.pem" , "utf8" ) ; const certificate = fs . readFileSync ( "naf.pem" , "utf8" ) ;
const credentials = { key : privateKey , cert : certificate } ; const credentials = { key : privateKey , cert : certificate } ;
@ -381,30 +479,85 @@ const webServer = https.createServer(credentials, app);
// const webServer = http.createServer(app);
// const webServer = http.createServer(app);
// Listen on port
// Listen on port
webServer . listen ( port , ( ) => { webServer . listen ( port , ( ) => {
console . log ( "listening on " + protocol + "://localhost:" + port ) ; console . log ( "listening on " + protocol + "://0.0.0.0:" + port )
getCommand ( )
} ) ; } ) ;
// SSE from https://www.digitalocean.com/community/tutorials/nodejs-server-sent-events-build-realtime-app
// REPL testing
// adapted from jxr-permanence
const readline = require ( "readline" ) ;
let clients = [ ] ; const rl = readline . createInterface ( {
input : process . stdin ,
function eventsHandler ( request , response , next ) { output : process . stdout ,
const headers = { completer : completer
'Content-Type' : 'text/event-stream' , } ) ;
'Connection' : 'keep-alive' ,
'Cache-Control' : 'no-cache' // https://nodejs.org/api/readline.html#use-of-the-completer-function
} ; function completer ( line ) {
response . writeHead ( 200 , headers ) ; const completions = help ( ) . split ( '\n' ) ;
const clientId = Date . now ( ) ; const hits = completions . filter ( ( c ) => c . startsWith ( line ) ) ;
const newClient = { id : clientId , response } ; // Show all completions if none found
clients . push ( newClient ) ; return [ hits . length ? hits : completions , line ] ;
request . on ( 'close' , ( ) => { clients = clients . filter ( client => client . id !== clientId ) ; } ) ;
} }
function sendEventsToAll ( data ) { let command = ''
// function used to broadcast
function getCommand ( ) {
clients . forEach ( client => client . response . write ( ` data: ${ JSON . stringify ( data ) } \n \n ` ) ) rl . question ( process . title + " REPL: " , function ( command ) {
if ( command == "close" ) {
rl . close ( ) ;
} else {
try {
console . log ( command , eval ( command ) )
} catch ( err ) {
console . log ( err )
} }
getCommand ( )
// somehow switch to node REPL proper after?!
}
} ) ;
}
function help ( ) {
return `
help ( )
execConfiguredCommand ( cmdName )
getSshConfig ( )
mountAll ( )
umountAll ( )
scanpeers ( )
getUnifiedworkspaces ( )
foundPeers
port
protocol
subclass
publicKeyPath
publicKey
md5fromPub
process . title
filename
fileSaveFullPath
minfilename
minfileSaveFullPath
sshconfigpath
propath
localServices
configFilePath
utilsCmd
instructions
auth _instructions
process . title
sshfsmounts
mountPoints
workspaces
`
}
rl . on ( "close" , function ( ) {
console . log ( "\ndone" ) ;
umountAll ( )
process . exit ( 0 ) ;
} ) ;
app . get ( '/events' , eventsHandler ) ; // Demo Day target :
// for example /events.html shows when /scan begings (but not ends)
// show files from ~/Prototypes as cubes from ssh mounted on a virtual workspace
// sshfs might not even be needed, see allpeers/exec instead
// wouldn't easily get content back though, just meta data
Fabien Benetou