gpgfs is an encrypted file storage solution utilizing gnupg to implement the gpgfs file system
- Documentation - datapartyjs.github.io/gpgfs/
- NPM - npmjs.com/package/gpgfs
- Code - github.com/datapartyjs/gpgfs
- Social - @datapartyjs
- Private by default
- Transport agnostic
- Represent file buckets
- Encrypted metadata
- Granular permissions
const gpgfs = require('gpgfs')
async function main(){
const securefs = new gpgfs()
await securefs.open()
//! Trust user
await securefs.keychain.trustCard()
const bucket = await securefs.bucket('staging')
if(!bucket.exists()){
console.log('creating bucket')
await bucket.create()
}
const file = await bucket.file('directory-1/foo/bar/file-test.txt')
if(!file.exists()){
console.log('creating file', file.id)
await file.create()
await file.save('hello world\n')
}
const [ content, metadata, lastchange ] = await Promise.all([
file.read(),
file.getMetadata(),
file.getLastchange()
])
console.log('metadata', metadata)
console.log('lastchange', lastchange)
console.log('file-content [', content.toString(), ']')
}Bucket content is stored in the .gpgfs directory, locatable anywhere on a host file system. All files are encrypted as PGP armored output
.gpgfs/
└── buckets
└── bucket-5e571d7969643103e4887f5f
├── index
├── keys
│ ├── meta-read-key
│ └── read-key
├── metadata
├── object-lastchange
│ └── object-5e571d7e69643103e4887f60-lastchange
├── object-meta
│ └── object-5e571d7e69643103e4887f60-meta
└── objects
└── object-5e571d7e69643103e4887f60