StarMirror
/
sandboxed-api
mirror of https://github.com/google/sandboxed-api
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve documentation of `TransferToSandboxee()` and `TransferFromSandboxee()`. 

PiperOrigin-RevId: 606209322
Change-Id: I84e41671e7fa83d330d9217f45d4b61aed991d0d
main
Oliver Kunz 2024-02-12 04:20:52 -08:00 committed by Copybara-Service
parent 597b4430ba
commit 4f93af65e6
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
sandboxed_api/sandbox.h
View File

@ -98,9 +98,30 @@ class Sandbox {
// Finds the address of a symbol in the sandboxee.
absl::Status Symbol(const char* symname, void** addr);
// Transfers memory (both directions). Status is returned (memory transfer
// succeeded/failed).
// Transfers memory to the sandboxee's address space from the hostcode.
// Returns the status of the operation. Requires a v::Var object to be set up
// with a suitable memory buffer allocated in the hostcode.
//
// Example Usage:
// std::string buffer(size_of_memory_in_sandboxee, ' ');
// sapi::v::Array<uint8_t> sapi_buffer(
// reinterpret_cast<uint8_t*>(buffer.data()), buffer.size());
// SAPI_RETURN_IF_ERROR(sandbox.Allocate(&sapi_buffer));
// SAPI_RETURN_IF_ERROR(sandbox.TransferFromSandboxee(&sapi_buffer));
absl::Status TransferToSandboxee(v::Var* var);
// Transfers memory from the sandboxee's address space to the hostcode.
// Returns the status of the operation. Requires a v::Var object to be set up
// suitable memory buffer allocated in the hostcode. This call
// does not alter the memory in the sandboxee. It is therefore safe to
// const_cast `addr_of_memory_in_sandboxee` if necessary.
//
// Example Usage:
// std::string buffer(size_of_memory_in_sandboxee, ' ');
// sapi::v::Array<uint8_t> sapi_buffer(
// reinterpret_cast<uint8_t*>(buffer.data()), buffer.size());
// sapi_buffer.SetRemote(addr_of_memory_in_sandboxee);
// SAPI_RETURN_IF_ERROR(sandbox.TransferFromSandboxee(&sapi_buffer));
absl::Status TransferFromSandboxee(v::Var* var);
absl::StatusOr<std::string> GetCString(const v::RemotePtr& str,