Solid Rust

A SoLiD server implemented in rust.

Status

Work (barely) In Progress. Not usable at all.

See the issues and Milestones to get an idea of the on going work.

• [ ] HTTP
• [ ] LDP
• [ ] WAC
• [ ] WebId
• [ ] ...

HTTP Related Conformance

• [x] MUST Be a Server
• [ ] MUST support GET, HEAD, OPTIONS on resources
• [ ] MUST indicate methods in Allow header for authorized requests
• [ ] MUST indicate supported media-types with Accept-Put, Accept-Post, Accept-Patch
  • [ ] MAY indicate those in OPTIONS requests
• [ ] MUST support Conditional Requests (Etag, 412, 304 etc)
• [ ] SHOULD provide Server Caching
• [ ] MAY support Range/If-Range (optional)
• [ ] MUST support http authentication standards (i.e. 401 or 404 for invalid creds)
• [ ] MUST reject PUT, POST, PATCH with 400 when no Content-Type header
• [ ] MUST 405 for methods not supported on the target resource
• [ ] MUST respond 404 when POSTing to a non-existing url
• [ ] MAY use the Slug header for resource naming handling POST
• [ ] MUST allow acl/description resources to be modified with PUT and PATCH

LDP Related Conformance

There doesn't seem to be any already existing LDP servers in Rust, so this is from scratch.

• [ ] MUST support LDP containers

• [ ] MUST create intermediate containers when creating

• [ ] MUST allow POSTing to a container to create

  • [ ] MUST create a container resource when Link Header rel=type ldp:Container header is present in the POST
  • [ ] MUST create the resource/container directly under the container in the url hierarchy

• [ ] MUST 403 when trying to POST with a slug indicating the auxiliary resource

• [ ] MUST 409 when someone tries to PUT or PATCH container's containment directly

• [ ] MUST 405 a request to delete the storage root or its acl

• [ ] MUST remove the reference of a deleted resources from it's container too

• [ ] MUST delete auxiliary resources when deleting a resource

• [ ] MUST support DELETE of empty containers

• [ ] MUST 409 a DELETE request of a non-empty container

• [x] Read Resources (GET, HEAD, OPTIONS)

  • [ ] Content Negotiation (.ttl->application/ld+json et al.) (Accept header)
  • [x] text/turtle
  • [ ] application/ld+json

• [ ] Write Resources

  • [ ] PUT to create
  • [ ] PUT to update
  • [ ] POST to create through container

• [ ] Read Containers

• [ ] Write Containers?

Miscellaneous Conformance

• [ ] MUST advertise Storage roots with pim:Storage header
• [ ] MUST provide an acl doc on the storage roo
• [ ] MUST have an acl:Control privileged role on that acl?
• [ ] MUST have the same origin for subject and its auxiliary resource
• [ ] MUST NOT associate multiple description resources with a resource
• [ ] MUST require acl:Write to change a description resource
• [ ] MUST require acl:Read to view a description resource

Web Access Control

• [ ] MUST honor the acl roles
• [ ] MUST NOT associate multiple acl docs with a resource
• [ ] MUST require acl:Control privilege to access acl doc
• [ ] SHOULD validate acl doc changes (e.g. shape validation)

Architecture

This is set up as a Cargo Workspace. The workspace parent crate is here, and the server crate is a member.

This parent crate is the CLI binary which is a very minimal wrapper around everything in ther server crate. The server crate is the actual application.

The gist of the code structure is as follows: there is a module for each of the major specs that are involved in a Solid server

• HTTP: The http module handles various things about the HTTP related specs. Handles 404 detection, Conditional Requests, Accept Header, etc

• LDP: The ldp module handles the things which are particular to the LDP specs. Handles LDP-Resource and LDP-Container related logic

More TBD.

Running the server

Currently there are no pre-build binaries. To run the server you must run it from source using cargo.

# clone the repo
cd solid-rust
cargo run # [-- -p port-number]

Tests

Tests are run by running Postman's newman from within a cargo integration test. The tests will start the server on port 7171, then execute various requests against 127.0.0.1:7171.

Unfortunately, this means you have to have [newman] installed. npm install -g newman. Alternatively, you can install the man Postman client and import the test suite and run it there.

More on using Postman for tests here.

Running the tests

cd solid-rust/server
cargo test

Writing tests

When it makes sense, simply write unit tests directly in the rust source code like normal.

Intergation tests are written in nodejs, using postmam. The best way to write more integration tests is to use Postman. You can import the test suite, add your own requests/tests scripts, then export back into the repo.

Contributing

Contributions are welcome!

• Fork the project
• make your changes
• follow the guidelines
• submit a pull request

One major contribution we need is json-ld support. I haven't found any existing rust crate for interacting with rdf through json-ld.

Guidelines

• Write tests (preferrably first)
• Write good documentation (preferrably first)

Resources

• Solid landing page
• The Node Solid Server
• Inrupt's (deprecated?) pod-server
• tokio docs
• hyper docs

Sepcs

• ldp
• solid spec