ezshare/protos/ezshare.proto

130 lines
2.5 KiB
Protocol Buffer
Raw Normal View History

2021-12-03 22:04:09 +00:00
syntax = "proto3";
package ezshare;
import "google/protobuf/timestamp.proto";
2021-12-05 10:08:09 +00:00
option go_package = "gitea.benny.dog/torjus/ezshare/pb";
/////////////////////
// Common messages //
/////////////////////
message Empty {}
////////////////////////
// FILE RELATED STUFF //
////////////////////////
2021-12-03 22:04:09 +00:00
message File {
string file_id = 1;
bytes data = 2;
message Metadata {
google.protobuf.Timestamp uploaded_on = 1;
google.protobuf.Timestamp expires_on = 2;
string original_filename = 3;
};
Metadata metadata = 3;
};
// Service messages
// Upload
message UploadFileRequest {
bytes data = 1;
string original_filename = 2;
google.protobuf.Timestamp expires_on = 3;
}
message UploadFileResponse {
string id = 1;
string file_url = 2;
}
// Get
message GetFileRequest {
string id = 1;
}
message GetFileResponse {
File file = 1;
}
2021-12-04 10:30:42 +00:00
// Delete
message DeleteFileRequest {
string id = 1;
}
message DeleteFileResponse {
}
// List
message ListFilesRequest {}
message ListFilesResponse {
message ListFileInfo {
string file_id = 1;
File.Metadata metadata = 2;
}
repeated ListFileInfo files = 1;
}
2021-12-03 22:04:09 +00:00
service FileService {
rpc UploadFile(UploadFileRequest) returns (UploadFileResponse) {}
rpc GetFile(GetFileRequest) returns (GetFileResponse) {}
2021-12-04 10:30:42 +00:00
rpc DeleteFile(DeleteFileRequest) returns (DeleteFileResponse) {}
rpc ListFiles(ListFilesRequest) returns (ListFilesResponse) {}
2021-12-05 10:08:09 +00:00
}
////////////////////////
// USER RELATED STUFF //
////////////////////////
message User {
string id = 1;
string username = 2;
bytes hashed_password = 3;
enum Role {
2021-12-05 13:55:18 +00:00
UNKNOWN = 0;
2021-12-05 10:08:09 +00:00
VIEWONLY = 1;
USER = 2;
ADMIN = 3;
2021-12-05 13:55:18 +00:00
UNAPPROVED = 4;
2021-12-05 10:08:09 +00:00
}
Role user_role = 4;
bool active = 5;
}
// Register
message RegisterUserRequest {
string username = 1;
string password = 2;
}
message RegisterUserResponse {
string id = 1;
string token = 2;
}
// Login
message LoginUserRequest {
2021-12-06 05:08:17 +00:00
string username = 1;
string password = 2;
2021-12-05 10:08:09 +00:00
}
message LoginUserResponse {
2021-12-06 05:08:17 +00:00
bytes client_cert = 1;
bytes client_key = 2;
2021-12-05 10:08:09 +00:00
}
// List
message ListUsersRequest {
}
message ListUsersResponse {
repeated User users = 1;
}
// Approve
message ApproveUserRequest {
string user_id = 1;
}
service UserService {
rpc Register(RegisterUserRequest) returns (RegisterUserResponse) {}
rpc Login(LoginUserRequest) returns (LoginUserResponse) {}
rpc List(ListUsersRequest) returns (ListUsersResponse) {}
rpc Approve(ApproveUserRequest) returns (Empty) {}
}