feat(core): rebrand to @lossless.zone/objectstorage

- Rename from @lossless.zone/s3container to @lossless.zone/objectstorage
- Replace @push.rocks/smarts3 with @push.rocks/smartstorage
- Change env var prefix from S3_ to OBJST_
- Rename S3Container class to ObjectStorageContainer
- Update web component prefix from s3c- to objst-
- Update UI labels, CLI flags, documentation, and Docker config
This commit is contained in:
2026-03-14 23:56:02 +00:00
commit 1f281bd7c8
76 changed files with 16765 additions and 0 deletions

View File

@@ -0,0 +1,376 @@
import * as plugins from '../plugins.ts';
import { type IObjectStorageConfig, defaultConfig } from '../types.ts';
import type * as interfaces from '../../ts_interfaces/index.ts';
import { OpsServer } from '../opsserver/index.ts';
import { PolicyManager } from './policymanager.ts';
export class ObjectStorageContainer {
public config: IObjectStorageConfig;
public smartstorageInstance!: plugins.smartstorage.SmartStorage;
public s3Client!: plugins.S3Client;
public opsServer: OpsServer;
public policyManager: PolicyManager;
public startedAt: number = 0;
constructor(configArg?: Partial<IObjectStorageConfig>) {
this.config = { ...defaultConfig, ...configArg };
// Read environment variables (override config)
const envPort = Deno.env.get('OBJST_PORT');
if (envPort) this.config.objstPort = parseInt(envPort, 10);
const envUiPort = Deno.env.get('UI_PORT');
if (envUiPort) this.config.uiPort = parseInt(envUiPort, 10);
const envStorageDir = Deno.env.get('OBJST_STORAGE_DIR');
if (envStorageDir) this.config.storageDirectory = envStorageDir;
const envAccessKey = Deno.env.get('OBJST_ACCESS_KEY');
const envSecretKey = Deno.env.get('OBJST_SECRET_KEY');
if (envAccessKey && envSecretKey) {
this.config.accessCredentials = [
{ accessKeyId: envAccessKey, secretAccessKey: envSecretKey },
];
}
const envAdminPassword = Deno.env.get('OBJST_ADMIN_PASSWORD');
if (envAdminPassword) this.config.adminPassword = envAdminPassword;
const envRegion = Deno.env.get('OBJST_REGION');
if (envRegion) this.config.region = envRegion;
this.opsServer = new OpsServer(this);
this.policyManager = new PolicyManager(this);
}
public async start(): Promise<void> {
console.log(`Starting ObjectStorage...`);
console.log(` Storage port: ${this.config.objstPort}`);
console.log(` UI port: ${this.config.uiPort}`);
console.log(` Storage: ${this.config.storageDirectory}`);
console.log(` Region: ${this.config.region}`);
// Start smartstorage
this.smartstorageInstance = await plugins.smartstorage.SmartStorage.createAndStart({
server: {
port: this.config.objstPort,
address: '0.0.0.0',
region: this.config.region,
},
storage: {
directory: this.config.storageDirectory,
},
auth: {
enabled: true,
credentials: this.config.accessCredentials,
},
});
this.startedAt = Date.now();
console.log(`Storage server started on port ${this.config.objstPort}`);
// Create S3 client for management operations
const descriptor = await this.smartstorageInstance.getStorageDescriptor();
this.s3Client = new plugins.S3Client({
endpoint: `http://${descriptor.endpoint}:${descriptor.port}`,
region: this.config.region,
credentials: {
accessKeyId: descriptor.accessKey,
secretAccessKey: descriptor.accessSecret,
},
forcePathStyle: true,
});
// Load named policies
await this.policyManager.load();
// Start UI server
await this.opsServer.start(this.config.uiPort);
console.log(`Management UI started on port ${this.config.uiPort}`);
}
public async stop(): Promise<void> {
console.log('Stopping ObjectStorage...');
await this.opsServer.stop();
await this.smartstorageInstance.stop();
console.log('ObjectStorage stopped.');
}
// ── Management methods ──
public async listBuckets(): Promise<interfaces.data.IBucketInfo[]> {
const response = await this.s3Client.send(new plugins.ListBucketsCommand({}));
const buckets: interfaces.data.IBucketInfo[] = [];
for (const bucket of response.Buckets || []) {
const name = bucket.Name || '';
const creationDate = bucket.CreationDate?.getTime() || 0;
// Get object count and size for each bucket
let objectCount = 0;
let totalSizeBytes = 0;
let continuationToken: string | undefined;
do {
const listResp = await this.s3Client.send(
new plugins.ListObjectsV2Command({
Bucket: name,
ContinuationToken: continuationToken,
}),
);
for (const obj of listResp.Contents || []) {
objectCount++;
totalSizeBytes += obj.Size || 0;
}
continuationToken = listResp.IsTruncated ? listResp.NextContinuationToken : undefined;
} while (continuationToken);
buckets.push({ name, creationDate, objectCount, totalSizeBytes });
}
return buckets;
}
public async createBucket(bucketName: string): Promise<void> {
await this.smartstorageInstance.createBucket(bucketName);
}
public async deleteBucket(bucketName: string): Promise<void> {
await this.s3Client.send(new plugins.DeleteBucketCommand({ Bucket: bucketName }));
}
public async listObjects(
bucketName: string,
prefix?: string,
delimiter?: string,
maxKeys?: number,
): Promise<interfaces.data.IObjectListResult> {
const response = await this.s3Client.send(
new plugins.ListObjectsV2Command({
Bucket: bucketName,
Prefix: prefix || '',
Delimiter: delimiter || '/',
MaxKeys: maxKeys || 1000,
}),
);
const objects: interfaces.data.IObjectInfo[] = (response.Contents || []).map((obj) => ({
key: obj.Key || '',
size: obj.Size || 0,
lastModified: obj.LastModified?.getTime() || 0,
etag: obj.ETag || '',
contentType: '',
}));
const commonPrefixes = (response.CommonPrefixes || []).map((p) => p.Prefix || '');
return {
objects,
commonPrefixes,
isTruncated: response.IsTruncated || false,
currentPrefix: prefix || '',
};
}
public async deleteObject(bucketName: string, key: string): Promise<void> {
await this.s3Client.send(
new plugins.DeleteObjectCommand({ Bucket: bucketName, Key: key }),
);
}
public async getObject(bucketName: string, key: string): Promise<{
content: string;
contentType: string;
size: number;
lastModified: string;
}> {
const response = await this.s3Client.send(
new plugins.GetObjectCommand({ Bucket: bucketName, Key: key }),
);
const bodyBytes = await response.Body!.transformToByteArray();
// Convert to base64
let binary = '';
for (const byte of bodyBytes) {
binary += String.fromCharCode(byte);
}
const base64Content = btoa(binary);
return {
content: base64Content,
contentType: response.ContentType || 'application/octet-stream',
size: response.ContentLength || 0,
lastModified: response.LastModified?.toISOString() || new Date().toISOString(),
};
}
public async putObject(
bucketName: string,
key: string,
base64Content: string,
contentType: string,
): Promise<void> {
const binaryString = atob(base64Content);
const bytes = new Uint8Array(binaryString.length);
for (let i = 0; i < binaryString.length; i++) {
bytes[i] = binaryString.charCodeAt(i);
}
await this.s3Client.send(
new plugins.PutObjectCommand({
Bucket: bucketName,
Key: key,
Body: bytes,
ContentType: contentType,
}),
);
}
public async deletePrefix(bucketName: string, prefix: string): Promise<void> {
let continuationToken: string | undefined;
do {
const listResp = await this.s3Client.send(
new plugins.ListObjectsV2Command({
Bucket: bucketName,
Prefix: prefix,
ContinuationToken: continuationToken,
}),
);
for (const obj of listResp.Contents || []) {
if (obj.Key) {
await this.s3Client.send(
new plugins.DeleteObjectCommand({ Bucket: bucketName, Key: obj.Key }),
);
}
}
continuationToken = listResp.IsTruncated ? listResp.NextContinuationToken : undefined;
} while (continuationToken);
}
public async getObjectUrl(bucketName: string, key: string): Promise<string> {
const descriptor = await this.smartstorageInstance.getStorageDescriptor();
return `http://${descriptor.endpoint}:${descriptor.port}/${bucketName}/${key}`;
}
public async moveObject(
bucketName: string,
sourceKey: string,
destKey: string,
): Promise<{ success: boolean; error?: string }> {
try {
await this.s3Client.send(
new plugins.CopyObjectCommand({
Bucket: bucketName,
CopySource: `${bucketName}/${sourceKey}`,
Key: destKey,
}),
);
await this.s3Client.send(
new plugins.DeleteObjectCommand({ Bucket: bucketName, Key: sourceKey }),
);
return { success: true };
} catch (err: any) {
return { success: false, error: err.message };
}
}
public async movePrefix(
bucketName: string,
sourcePrefix: string,
destPrefix: string,
): Promise<{ success: boolean; movedCount?: number; error?: string }> {
try {
let movedCount = 0;
let continuationToken: string | undefined;
do {
const listResp = await this.s3Client.send(
new plugins.ListObjectsV2Command({
Bucket: bucketName,
Prefix: sourcePrefix,
ContinuationToken: continuationToken,
}),
);
for (const obj of listResp.Contents || []) {
if (!obj.Key) continue;
const newKey = destPrefix + obj.Key.slice(sourcePrefix.length);
await this.s3Client.send(
new plugins.CopyObjectCommand({
Bucket: bucketName,
CopySource: `${bucketName}/${obj.Key}`,
Key: newKey,
}),
);
await this.s3Client.send(
new plugins.DeleteObjectCommand({ Bucket: bucketName, Key: obj.Key }),
);
movedCount++;
}
continuationToken = listResp.IsTruncated ? listResp.NextContinuationToken : undefined;
} while (continuationToken);
return { success: true, movedCount };
} catch (err: any) {
return { success: false, error: err.message };
}
}
public async getServerStats(): Promise<interfaces.data.IServerStatus> {
const buckets = await this.listBuckets();
let totalObjectCount = 0;
let totalStorageBytes = 0;
for (const b of buckets) {
totalObjectCount += b.objectCount;
totalStorageBytes += b.totalSizeBytes;
}
return {
running: true,
objstPort: this.config.objstPort,
uiPort: this.config.uiPort,
uptime: Math.floor((Date.now() - this.startedAt) / 1000),
startedAt: this.startedAt,
bucketCount: buckets.length,
totalObjectCount,
totalStorageBytes,
storageDirectory: this.config.storageDirectory,
region: this.config.region,
authEnabled: true,
};
}
public async getBucketPolicy(bucketName: string): Promise<string | null> {
try {
const response = await this.s3Client.send(
new plugins.GetBucketPolicyCommand({ Bucket: bucketName }),
);
return response.Policy || null;
} catch (err: any) {
if (err.name === 'NoSuchBucketPolicy' || err.Code === 'NoSuchBucketPolicy') {
return null;
}
throw err;
}
}
public async putBucketPolicy(bucketName: string, policyJson: string): Promise<void> {
await this.s3Client.send(
new plugins.PutBucketPolicyCommand({ Bucket: bucketName, Policy: policyJson }),
);
}
public async deleteBucketPolicy(bucketName: string): Promise<void> {
await this.s3Client.send(
new plugins.DeleteBucketPolicyCommand({ Bucket: bucketName }),
);
}
public async getConnectionInfo(): Promise<interfaces.data.IConnectionInfo> {
const descriptor = await this.smartstorageInstance.getStorageDescriptor();
return {
endpoint: descriptor.endpoint,
port: Number(descriptor.port ?? this.config.objstPort),
useSsl: descriptor.useSsl ?? false,
accessKey: descriptor.accessKey,
region: this.config.region,
};
}
}

269
ts/classes/policymanager.ts Normal file
View File

@@ -0,0 +1,269 @@
import type { ObjectStorageContainer } from './objectstoragecontainer.ts';
import type * as interfaces from '../../ts_interfaces/index.ts';
export class PolicyManager {
private objectStorageRef: ObjectStorageContainer;
private data: interfaces.data.IPoliciesData = {
namedPolicies: {},
bucketPolicyAttachments: {},
};
private filePath: string;
constructor(objectStorageRef: ObjectStorageContainer) {
this.objectStorageRef = objectStorageRef;
const storageDir = objectStorageRef.config.storageDirectory;
this.filePath = `${storageDir}/.objectstorage/policies.json`;
}
// ── Persistence ──
public async load(): Promise<void> {
try {
const dirPath = this.filePath.substring(0, this.filePath.lastIndexOf('/'));
await Deno.mkdir(dirPath, { recursive: true });
const content = await Deno.readTextFile(this.filePath);
this.data = JSON.parse(content);
} catch {
// File doesn't exist yet — start with empty data
this.data = { namedPolicies: {}, bucketPolicyAttachments: {} };
}
}
private async save(): Promise<void> {
const dirPath = this.filePath.substring(0, this.filePath.lastIndexOf('/'));
await Deno.mkdir(dirPath, { recursive: true });
await Deno.writeTextFile(this.filePath, JSON.stringify(this.data, null, 2));
}
// ── CRUD ──
public listPolicies(): interfaces.data.INamedPolicy[] {
return Object.values(this.data.namedPolicies);
}
public getPolicy(policyId: string): interfaces.data.INamedPolicy | null {
return this.data.namedPolicies[policyId] || null;
}
public async createPolicy(
name: string,
description: string,
statements: interfaces.data.IObjstStatement[],
): Promise<interfaces.data.INamedPolicy> {
const id = crypto.randomUUID();
const now = Date.now();
const policy: interfaces.data.INamedPolicy = {
id,
name,
description,
statements,
createdAt: now,
updatedAt: now,
};
this.data.namedPolicies[id] = policy;
await this.save();
return policy;
}
public async updatePolicy(
policyId: string,
name: string,
description: string,
statements: interfaces.data.IObjstStatement[],
): Promise<interfaces.data.INamedPolicy> {
const existing = this.data.namedPolicies[policyId];
if (!existing) {
throw new Error(`Policy not found: ${policyId}`);
}
existing.name = name;
existing.description = description;
existing.statements = statements;
existing.updatedAt = Date.now();
await this.save();
// Recompute policies for all buckets that have this policy attached
const affectedBuckets = this.getBucketsForPolicy(policyId);
for (const bucket of affectedBuckets) {
await this.recomputeAndApplyPolicy(bucket);
}
return existing;
}
public async deletePolicy(policyId: string): Promise<void> {
if (!this.data.namedPolicies[policyId]) {
throw new Error(`Policy not found: ${policyId}`);
}
// Find all affected buckets before deleting
const affectedBuckets = this.getBucketsForPolicy(policyId);
// Remove from namedPolicies
delete this.data.namedPolicies[policyId];
// Remove from all bucket attachments
for (const bucket of Object.keys(this.data.bucketPolicyAttachments)) {
this.data.bucketPolicyAttachments[bucket] = this.data.bucketPolicyAttachments[bucket].filter(
(id) => id !== policyId,
);
if (this.data.bucketPolicyAttachments[bucket].length === 0) {
delete this.data.bucketPolicyAttachments[bucket];
}
}
await this.save();
// Recompute policies for affected buckets
for (const bucket of affectedBuckets) {
await this.recomputeAndApplyPolicy(bucket);
}
}
// ── Attachments ──
public getBucketAttachments(bucketName: string): {
attachedPolicies: interfaces.data.INamedPolicy[];
availablePolicies: interfaces.data.INamedPolicy[];
} {
const attachedIds = this.data.bucketPolicyAttachments[bucketName] || [];
const allPolicies = this.listPolicies();
const attachedPolicies = allPolicies.filter((p) => attachedIds.includes(p.id));
const availablePolicies = allPolicies.filter((p) => !attachedIds.includes(p.id));
return { attachedPolicies, availablePolicies };
}
public getBucketsForPolicy(policyId: string): string[] {
const buckets: string[] = [];
for (const [bucket, policyIds] of Object.entries(this.data.bucketPolicyAttachments)) {
if (policyIds.includes(policyId)) {
buckets.push(bucket);
}
}
return buckets;
}
public async attachPolicyToBucket(policyId: string, bucketName: string): Promise<void> {
if (!this.data.namedPolicies[policyId]) {
throw new Error(`Policy not found: ${policyId}`);
}
if (!this.data.bucketPolicyAttachments[bucketName]) {
this.data.bucketPolicyAttachments[bucketName] = [];
}
if (!this.data.bucketPolicyAttachments[bucketName].includes(policyId)) {
this.data.bucketPolicyAttachments[bucketName].push(policyId);
}
await this.save();
await this.recomputeAndApplyPolicy(bucketName);
}
public async detachPolicyFromBucket(policyId: string, bucketName: string): Promise<void> {
if (this.data.bucketPolicyAttachments[bucketName]) {
this.data.bucketPolicyAttachments[bucketName] = this.data.bucketPolicyAttachments[bucketName].filter(
(id) => id !== policyId,
);
if (this.data.bucketPolicyAttachments[bucketName].length === 0) {
delete this.data.bucketPolicyAttachments[bucketName];
}
}
await this.save();
await this.recomputeAndApplyPolicy(bucketName);
}
public async setPolicyBuckets(policyId: string, bucketNames: string[]): Promise<void> {
if (!this.data.namedPolicies[policyId]) {
throw new Error(`Policy not found: ${policyId}`);
}
const oldBuckets = this.getBucketsForPolicy(policyId);
const newBucketsSet = new Set(bucketNames);
const oldBucketsSet = new Set(oldBuckets);
// Remove from buckets no longer in the list
for (const bucket of oldBuckets) {
if (!newBucketsSet.has(bucket)) {
this.data.bucketPolicyAttachments[bucket] = (this.data.bucketPolicyAttachments[bucket] || []).filter(
(id) => id !== policyId,
);
if (this.data.bucketPolicyAttachments[bucket]?.length === 0) {
delete this.data.bucketPolicyAttachments[bucket];
}
}
}
// Add to new buckets
for (const bucket of bucketNames) {
if (!oldBucketsSet.has(bucket)) {
if (!this.data.bucketPolicyAttachments[bucket]) {
this.data.bucketPolicyAttachments[bucket] = [];
}
if (!this.data.bucketPolicyAttachments[bucket].includes(policyId)) {
this.data.bucketPolicyAttachments[bucket].push(policyId);
}
}
}
await this.save();
// Recompute all affected buckets (union of old and new)
const allAffected = new Set([...oldBuckets, ...bucketNames]);
for (const bucket of allAffected) {
await this.recomputeAndApplyPolicy(bucket);
}
}
// ── Cleanup ──
public async onBucketDeleted(bucketName: string): Promise<void> {
if (this.data.bucketPolicyAttachments[bucketName]) {
delete this.data.bucketPolicyAttachments[bucketName];
await this.save();
}
}
// ── Merge & Apply ──
private async recomputeAndApplyPolicy(bucketName: string): Promise<void> {
const attachedIds = this.data.bucketPolicyAttachments[bucketName] || [];
if (attachedIds.length === 0) {
// No policies attached — remove any existing policy
try {
await this.objectStorageRef.deleteBucketPolicy(bucketName);
} catch {
// NoSuchBucketPolicy is fine
}
return;
}
// Gather all statements from attached policies
const allStatements: interfaces.data.IObjstStatement[] = [];
for (const policyId of attachedIds) {
const policy = this.data.namedPolicies[policyId];
if (!policy) continue;
for (const stmt of policy.statements) {
// Deep clone and replace ${bucket} placeholder
const cloned = JSON.parse(JSON.stringify(stmt)) as interfaces.data.IObjstStatement;
cloned.Resource = this.replaceBucketPlaceholder(cloned.Resource, bucketName);
allStatements.push(cloned);
}
}
const mergedPolicy = {
Version: '2012-10-17',
Statement: allStatements,
};
await this.objectStorageRef.putBucketPolicy(bucketName, JSON.stringify(mergedPolicy));
}
private replaceBucketPlaceholder(
resource: string | string[],
bucketName: string,
): string | string[] {
if (typeof resource === 'string') {
return resource.replace(/\$\{bucket\}/g, bucketName);
}
return resource.map((r) => r.replace(/\$\{bucket\}/g, bucketName));
}
}