.
19 |
20 | inbox:
21 | a ldp:BasicContainer, ldp:Container, ldp:Resource;
22 | terms:modified "2019-12-20T14:52:54Z"^^XML:dateTime;
23 | st:mtime 1576853574.389;
24 | st:size 4096.
25 | EOF;
26 |
27 | return $this->createTextResponse($body)->withHeader("Content-type", "text/turtle");
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright (c) 2020 PDS Interop
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining a copy
4 | of this software and associated documentation files (the "Software"), to deal
5 | in the Software without restriction, including without limitation the rights
6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 | copies of the Software, and to permit persons to whom the Software is furnished
8 | to do so, subject to the following conditions:
9 |
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 |
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | THE SOFTWARE.
20 |
--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
1 | version: '3'
2 | services:
3 | php-solid-server:
4 | build:
5 | context: .
6 | container_name: php-solid-server
7 | environment:
8 | # During development it can be useful to set the ENVIRONMENT to "development"
9 | # in order to see more details about the errors.
10 | # ENVIRONMENT: development
11 | USERNAME: alice
12 | PASSWORD: alice123
13 | # To change the root from https://localhost to something sensible , set SERVER_ROOT, for example:
14 | # SERVER_ROOT: https://nextcloud.local
15 | # to run in HTTP mode, set PROXY_MODE
16 | # PROXY_MODE: true
17 | PUBSUB_URL: http://pubsub:8080
18 | ports:
19 | - 80:80
20 | - 443:443
21 | volumes:
22 | - .:/app/
23 | # @TODO: The storage directory should be mounted separately
24 | # as it really _should_ live outside the code directory
25 |
26 | pubsub:
27 | build:
28 | context: https://github.com/pdsinterop/php-solid-pubsub-server.git#main
29 | ports:
30 | - 8080:8080
31 |
--------------------------------------------------------------------------------
/site.conf:
--------------------------------------------------------------------------------
1 |
2 | DocumentRoot "/app/web/"
3 | ErrorLog ${APACHE_LOG_DIR}/error.log
4 | CustomLog ${APACHE_LOG_DIR}/access.log combined
5 |
6 | SSLEngine on
7 | SSLCertificateFile "/tls/server.cert"
8 | SSLCertificateKeyFile "/tls/server.key"
9 |
10 |
11 | SSLOptions +StdEnvVars
12 |
13 |
14 |
15 | Options Indexes FollowSymLinks
16 | AllowOverride all
17 | Require all granted
18 |
19 | DirectoryIndex index.php
20 |
21 |
22 | RewriteEngine On
23 | RewriteCond %{HTTP:Authorization} ^(.*)
24 | RewriteRule .* - [e=HTTP_AUTHORIZATION:%1]
25 |
26 | SetEnv AccessControlAllowOrigin="*"
27 | SetEnvIf Origin "^(.*)$" AccessControlAllowOrigin=$0
28 | Header add Access-Control-Allow-Origin %{AccessControlAllowOrigin}e env=AccessControlAllowOrigin
29 | Header add Access-Control-Allow-Credentials true
30 | Header add Access-Control-Allow-Headers "authorization, content-type, dpop"
31 | Header add Access-Control-Allow-Methods "GET, PUT, POST, OPTIONS, DELETE, PATCH"
32 | Header add Accept-Patch: application/sparql-update
33 | Header add Access-Control-Expose-Headers: "Accept-Patch"
34 |
35 |
--------------------------------------------------------------------------------
/src/Controller/RegisterController.php:
--------------------------------------------------------------------------------
1 | withStatus(400, "Missing redirect URIs");
17 | }
18 | $clientData['client_id_issued_at'] = time();
19 | $parsedOrigin = parse_url($clientData['redirect_uris'][0]);
20 | $origin = $parsedOrigin['host'];
21 |
22 | $clientId = $this->config->saveClientRegistration($origin, $clientData);
23 |
24 | // FIXME: properly generate this url;
25 | $baseUrl = $this->baseUrl;
26 | $clientUrl = $baseUrl . "/clients/$clientId";
27 |
28 | $registration = array(
29 | 'client_id' => $clientId,
30 | 'registration_client_uri' => $clientUrl,
31 | 'client_id_issued_at' => $clientData['client_id_issued_at'],
32 | 'redirect_uris' => $clientData['redirect_uris'],
33 | );
34 |
35 | $registration = $this->tokenGenerator->respondToRegistration($registration, $this->config->getPrivateKey());
36 | return new JsonResponse($registration);
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/Controller/AbstractController.php:
--------------------------------------------------------------------------------
1 | getResponse()
24 | ->withHeader('location', $url)
25 | ->withStatus($status)
26 | ;
27 | }
28 |
29 | final public function createTemplateResponse(string $template, array $context = []) : ResponseInterface
30 | {
31 | $response = $this->buildTemplate($template, $context);
32 |
33 | return $this->createTextResponse($response);
34 | }
35 |
36 | final public function createTextResponse(string $message, int $status = 200) : ResponseInterface
37 | {
38 | $response = $this->getResponse();
39 |
40 | $body = $response->getBody();
41 |
42 | $body->write($message);
43 |
44 | return $response->withBody($body)->withStatus($status);
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | ---
2 | baseurl: /php-solid-server
3 | description: Standalone Solid Server written in PHP by PDS Interop
4 | repository: pdsinterop/php-solid-server
5 | title: Standalone PHP Solid Server
6 | url: https://pdsinterop.org
7 |
8 | permalink: pretty
9 | remote_theme: Potherca/extend-the-docs@v0.3.1
10 |
11 | exclude:
12 | - "bin/"
13 | - "src/"
14 | - "tests/"
15 | - "vendor/"
16 | - "Gemfile"
17 | - "*.json"
18 | - "*.lock"
19 |
20 | plugins:
21 | - github-pages
22 | - jekyll-github-metadata
23 | - jekyll-remote-theme
24 | - jekyll-seo-tag
25 |
26 | # Extend the Docs settings (see https://pother.ca/extend-the-docs/)
27 | nav:
28 | cross_repository:
29 | exclude:
30 | - jekyll-theme
31 | - pdsinterop.github.io
32 | show_archived: true
33 | show_homepage: false
34 | exclude:
35 | - /
36 | - /404.html
37 | favicon_ico : /favicon.ico
38 | main_title:
39 | link: '/'
40 | recurse: true
41 |
42 | # Just the Docs settings (see https://pmarsceill.github.io/just-the-docs/docs/configuration/)
43 | aux_links:
44 | "PDS Interop on GitHub":
45 | - https://github.com/pdsinterop
46 | footer_content: 'Copyright © 2020-2021 PDS Interop . Distributed under a MIT license .
'
47 | gh_edit_link: true
48 | gh_edit_repository: https://github.com/pdsinterop/php-solid-server/
49 | logo: https://avatars3.githubusercontent.com/u/65920341
50 | search_enabled: true
51 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM php:7.3-apache
2 |
3 | # ==============================================================================
4 | # Set up the machine
5 | # ------------------------------------------------------------------------------
6 | COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
7 |
8 | SHELL ["/bin/bash", "-o", "pipefail", "-c"]
9 |
10 | RUN export DEBIAN_FRONTEND=noninteractive \
11 | && apt-get update && \
12 | apt-get install -y --no-install-recommends \
13 | git \
14 | libzip-dev \
15 | zlib1g-dev \
16 | && rm -rf /var/lib/apt/lists/*
17 |
18 | RUN mkdir /tls && openssl req -new -x509 -days 365 -nodes \
19 | -out /tls/server.cert \
20 | -keyout /tls/server.key \
21 | -subj "/C=NL/ST=Overijssel/L=Enschede/O=PDS Interop/OU=IT/CN=pdsinterop.org"
22 |
23 | RUN docker-php-ext-install \
24 | bcmath \
25 | mbstring \
26 | mysqli \
27 | pdo \
28 | pdo_mysql \
29 | zip
30 |
31 | RUN a2enmod headers rewrite ssl
32 |
33 | COPY site.conf /etc/apache2/sites-enabled/site.conf
34 |
35 | WORKDIR /app
36 |
37 | EXPOSE 443
38 | # ==============================================================================
39 |
40 |
41 | # ==============================================================================
42 | # Add the source code
43 | # ------------------------------------------------------------------------------
44 | ARG PROJECT_PATH
45 | RUN : "${PROJECT_PATH:=$PWD}"
46 |
47 | COPY "${PROJECT_PATH}" /app/
48 |
49 | RUN composer install --no-dev --prefer-dist
50 | RUN chown -R www-data:www-data /app
51 | # ==============================================================================
52 |
--------------------------------------------------------------------------------
/src/Template/card.html:
--------------------------------------------------------------------------------
1 |
2 |
24 |
25 | Profile in various RDF formats
26 |
35 |
36 |
37 |
38 |
40 |
RDF Format
41 |
42 |
44 |
46 |
47 |
48 |
--------------------------------------------------------------------------------
/src/Controller/TokenController.php:
--------------------------------------------------------------------------------
1 | getParsedBody()['code'];
16 | $clientId = $request->getParsedBody()['client_id'];
17 | $DPop = new DPop();
18 | $dpop = $request->getServerParams()['HTTP_DPOP'];
19 | try {
20 | $dpopKey = $DPop->getDPopKey($dpop, $request);
21 | } catch(\Exception $e) {
22 | return $this->getResponse()->withStatus(409, "Invalid token");
23 | }
24 |
25 | $server = new \Pdsinterop\Solid\Auth\Server(
26 | $this->authServerFactory,
27 | $this->authServerConfig,
28 | new \Laminas\Diactoros\Response()
29 | );
30 |
31 | $response = $server->respondToAccessTokenRequest($request);
32 |
33 | // FIXME: not sure if decoding this here is the way to go.
34 | // FIXME: because this is a public page, the nonce from the session is not available here.
35 | $codeInfo = $this->tokenGenerator->getCodeInfo($code);
36 |
37 | return $this->tokenGenerator->addIdTokenToResponse($response,
38 | $clientId,
39 | $codeInfo['user_id'],
40 | $_SESSION['nonce'],
41 | $this->config->getPrivateKey(),
42 | $dpopKey
43 | );
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/src/Controller/AbstractRedirectController.php:
--------------------------------------------------------------------------------
1 | request->getRequestTarget();
23 |
24 | [$path, $query] = explode('?', $target);
25 |
26 | return $path;
27 | }
28 |
29 | /** @return string */
30 | final public function getQuery() : string
31 | {
32 | $target = $this->request->getRequestTarget();
33 |
34 | [$url, $query] = explode('?', $target);
35 |
36 | if (is_string($query)) {
37 | $query .= '?' . $query;
38 | }
39 |
40 |
41 | return (string) $query;
42 | }
43 |
44 | abstract public function getTargetUrl(): string;
45 |
46 | //////////////////////////////// PUBLIC API \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
47 |
48 | final public function __invoke(ServerRequestInterface $request, array $args): ResponseInterface
49 | {
50 | $this->request = $request;
51 | $this->args = $args;
52 |
53 | return $this->createRedirectResponse($this->getTargetUrl());
54 | }
55 |
56 | ////////////////////////////// UTILITY METHODS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\
57 |
58 | }
59 |
--------------------------------------------------------------------------------
/docs/spec-compliance/server.md:
--------------------------------------------------------------------------------
1 | # Server
2 |
3 | This document describes what the Solid specification demands from a server in
4 | general. Implementation details have been added describing if and how compliance
5 | has been reached.
6 |
7 | ## Spec compliance
8 |
9 | - [x] _All http URIs MUST redirect to their https counterparts using a response with a 301 status code and a Location header._Already logged in as $user ");
27 | } elseif ($postBody['username'] && $postBody['password']) {
28 | $user = $postBody['username'];
29 | $password = $postBody['password'];
30 |
31 | if (
32 | ($user === $_ENV['USERNAME'] && $password === $_ENV['PASSWORD'])
33 | || ($user === $_SERVER['USERNAME'] && $password === $_SERVER['PASSWORD'])
34 | ) {
35 | $_SESSION['userid'] = $user;
36 |
37 | if (isset($request->getQueryParams()['returnUrl'])) {
38 | return $response
39 | ->withHeader("Location", $request->getQueryParams()['returnUrl'])
40 | ->withStatus(302)
41 | ;
42 | }
43 |
44 | $response->getBody()->write("Welcome $user \n");
45 | } else {
46 | $response->getBody()->write("Login as $user failed \n");
47 | }
48 | } else {
49 | $response->getBody()->write("Login failed \n");
50 | }
51 | } else {
52 | return $this->createTemplateResponse('login.html');
53 | }
54 |
55 | return $response;
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/src/Traits/HasTemplateTrait.php:
--------------------------------------------------------------------------------
1 | template;
19 | }
20 |
21 | public function setTemplate(PHPTAL $template) : void
22 | {
23 | $this->template = $template;
24 | }
25 |
26 | public function buildTemplate(string $template, array $context) : string
27 | {
28 | $engine = $this->getTemplate();
29 |
30 | $templateExists = $this->isTemplate($template, $engine);
31 |
32 | if ($templateExists === true) {
33 | $engine->setTemplate($template);
34 | } else {
35 | $template = $this->createTemplateFromString($template);
36 |
37 | $engine->setSource($template);
38 | }
39 |
40 | $engine = $this->setContextOnTemplate($context, $engine);
41 |
42 | return $engine->execute();
43 | }
44 |
45 | ////////////////////////////// UTILITY METHODS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\
46 |
47 | private function createTemplateFromString(string $template) : string
48 | {
49 | return <<<"TAL"
50 |
51 |
52 | {$template}
53 |
54 |
55 | TAL;
56 | }
57 |
58 | private function isTemplate(string $template, \PHPTAL $engine) : bool
59 | {
60 | $templateExists = array_map(static function ($templateRepository) use ($template) {
61 | return file_exists($templateRepository . '/' . ltrim($template, '/'));
62 | }, $engine->getTemplateRepositories());
63 |
64 | return array_sum($templateExists) > 0;
65 | }
66 |
67 | private function setContextOnTemplate(array $context, \PHPTAL $engine) : \PHPTAL
68 | {
69 | array_walk($context, static function ($value, $name) use (&$engine) {
70 | $engine->set($name, $value);
71 | });
72 |
73 | return $engine;
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/src/Controller/HelloWorldController.php:
--------------------------------------------------------------------------------
1 | Hello, World!
15 | The following main URL are available on this server:
16 |
58 |
59 |
60 | Footnotes
61 |
62 | Also available without trailing slash /
63 | A file extension can be added to force a specific format. For instance /profile/card can be
64 | requested as /profile/card.ttl to request a Turtle file, or /profile/card.json to
65 | request a JSON-LD file
66 |
67 | This URL also accepts POST requests
68 | This URL only accepts POST requests
69 |
70 |
71 | HTML;
72 |
73 | return $this->createTemplateResponse($body);
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/src/Service/RouterService.php:
--------------------------------------------------------------------------------
1 | container = $container;
29 | $this->router = $router;
30 | }
31 |
32 | final public function populate() : Router
33 | {
34 | $container = $this->container;
35 | $router = $this->router;
36 |
37 | /*/ Default output is HTML, routes should return a Response object /*/
38 | $strategy = new ApplicationStrategy();
39 | $strategy->setContainer($container);
40 | $router->setStrategy($strategy);
41 |
42 | /*/ Redirect all HTTP requests to HTTPS, unless we are behind a proxy /*/
43 | if ( ! getenv('PROXY_MODE')) {
44 | $router->map('GET', '/{page:(?:.|/)*}', HttpToHttpsController::class)->setScheme('http');
45 | }
46 |
47 | /*/ Map routes and groups /*/
48 | $router->map('GET', '/', HelloWorldController::class);
49 | $router->group('/profile', $this->createProfileGroup());
50 |
51 | return $router;
52 | }
53 |
54 | ////////////////////////////// UTILITY METHODS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\
55 |
56 | private function createProfileGroup() : Callable
57 | {
58 | return static function (RouteGroup $group) {
59 | $group->map('GET', '/', AddSlashToPathController::class);
60 | $group->map('GET', '', ProfileController::class);
61 | $group->map('GET', '/card', CardController::class);
62 | $group->map('GET', '/card{extension}', CardController::class);
63 | };
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/ExceptionResponse.php:
--------------------------------------------------------------------------------
1 | exception = $exception;
25 | }
26 |
27 | final public function createResponse() : HtmlResponse
28 | {
29 | $exception = $this->exception;
30 |
31 | if ($exception instanceof HttpException) {
32 | $response = $this->respondToHttpException($exception);
33 | } else {
34 | $response = $this->responseToException($exception);
35 | }
36 |
37 | return $response;
38 | }
39 |
40 | ////////////////////////////// UTILITY METHODS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\
41 |
42 | private function isDevelop() : bool
43 | {
44 | static $isDevelop;
45 |
46 | if ($isDevelop === null) {
47 | $isDevelop = getenv('ENVIRONMENT') === 'development';
48 | }
49 |
50 | return $isDevelop;
51 | }
52 |
53 | private function responseToException(Exception $exception) : HtmlResponse
54 | {
55 | $html = "Oh-no! The developers messed up! {$exception->getMessage()}
";
56 |
57 | if ($this->isDevelop()) {
58 | $html .=
59 | "{$exception->getFile()}:{$exception->getLine()}
" .
60 | "{$exception->getTraceAsString()} ";
61 | }
62 |
63 | return new HtmlResponse($html, 500, []);
64 | }
65 |
66 | private function respondToHttpException(HttpException $exception) : HtmlResponse
67 | {
68 | $status = $exception->getStatusCode();
69 |
70 | $message = self::MESSAGE_GENERIC_ERROR;
71 |
72 | if ($exception instanceof NotFoundException) {
73 | $message = self::MESSAGE_NO_SUCH_PAGE;
74 | }
75 |
76 | $html = vsprintf('%s %s (%s)
', [
77 | $message,
78 | $exception->getMessage(),
79 | $status,
80 | ]);
81 |
82 | if ($this->isDevelop()) {
83 | $html .= "{$exception->getTraceAsString()} ";
84 | }
85 |
86 | return new HtmlResponse($html, $status, $exception->getHeaders());
87 | }
88 | }
89 |
--------------------------------------------------------------------------------
/src/Controller/AuthorizeController.php:
--------------------------------------------------------------------------------
1 | baseUrl . "/login/?returnUrl=" . urlencode($_SERVER['REQUEST_URI']);
15 |
16 | return $this->getResponse()
17 | ->withHeader("Location", $loginUrl)
18 | ->withStatus(302, "Approval required")
19 | ;
20 | }
21 |
22 | $queryParams = $request->getQueryParams();
23 |
24 | $parser = new \Lcobucci\JWT\Parser();
25 |
26 | try {
27 | $token = $parser->parse($request->getQueryParams()['request']);
28 | $_SESSION["nonce"] = $token->getClaim('nonce');
29 | } catch(\Exception $e) {
30 | $_SESSION["nonce"] = $request->getQueryParams()['nonce'];
31 | }
32 |
33 | /*/ Prepare GET parameters for OAUTH server request /*/
34 | $getVars = $queryParams;
35 |
36 | $getVars['response_type'] = $this->getResponseType($queryParams);
37 | $getVars['scope'] = "openid" ;
38 |
39 | if (!isset($getVars['grant_type'])) {
40 | $getVars['grant_type'] = 'implicit';
41 | }
42 |
43 | if (!isset($getVars['redirect_uri'])) {
44 | try {
45 | $getVars['redirect_uri'] = $token->getClaim("redirect_uri");
46 | } catch(\Exception $e) {
47 | return $this->getResponse()
48 | ->withStatus(400, "Bad request, missing redirect uri")
49 | ;
50 | }
51 | }
52 |
53 | if (! isset($queryParams['client_id'])) {
54 | return $this->getResponse()
55 | ->withStatus(400, "Bad request, missing client_id")
56 | ;
57 | }
58 |
59 | $clientId = $getVars['client_id'];
60 | $approval = $this->checkApproval($clientId);
61 | if (!$approval) {
62 | // FIXME: Generate a proper url for this;
63 | $approvalUrl = $this->baseUrl . "/sharing/$clientId/?returnUrl=" . urlencode($_SERVER['REQUEST_URI']);
64 |
65 | return $this->getResponse()
66 | ->withHeader("Location", $approvalUrl)
67 | ->withStatus(302, "Approval required")
68 | ;
69 | }
70 |
71 | // replace the request getVars with the morphed version
72 | $request = $request->withQueryParams($getVars);
73 |
74 | $user = new \Pdsinterop\Solid\Auth\Entity\User();
75 | $user->setIdentifier($this->getProfilePage());
76 |
77 | $response = new \Laminas\Diactoros\Response();
78 | $server = new \Pdsinterop\Solid\Auth\Server($this->authServerFactory, $this->authServerConfig, $response);
79 |
80 | $response = $server->respondToAuthorizationRequest($request, $user, $approval);
81 |
82 | return $this->tokenGenerator->addIdTokenToResponse($response,
83 | $clientId,
84 | $this->getProfilePage(),
85 | $_SESSION['nonce'],
86 | $this->config->getPrivateKey()
87 | );
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/run-solid-test-suite.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | set -e
3 |
4 | function setup {
5 | # Run the Solid test-suite
6 | docker network create testnet
7 |
8 | # Build and start Nextcloud server with code from current repo contents:
9 | docker build -t standalone-solid-server .
10 |
11 | docker build -t cookie https://github.com/pdsinterop/test-suites.git#main:servers/php-solid-server/cookie
12 | docker build -t pubsub-server https://github.com/pdsinterop/php-solid-pubsub-server.git#main
13 |
14 | docker pull solidtestsuite/webid-provider-tests:v2.0.3
15 | docker tag solidtestsuite/webid-provider-tests:v2.0.3 webid-provider-tests
16 | docker pull solidtestsuite/solid-crud-tests:v6.0.0
17 | docker tag solidtestsuite/solid-crud-tests:v6.0.0 solid-crud-tests
18 | docker pull solidtestsuite/web-access-control-tests:v7.0.0
19 | docker tag solidtestsuite/web-access-control-tests:v7.0.0 web-access-control-tests
20 | }
21 |
22 | function runPss {
23 | docker run -d --name server --network=testnet --env-file ./env-vars-for-test-image.list standalone-solid-server
24 | docker run -d --name thirdparty --network=testnet --env-file ./env-vars-for-third-party.list standalone-solid-server
25 |
26 | docker run -d --name pubsub --network=testnet pubsub-server
27 |
28 | until docker run --rm --network=testnet webid-provider-tests curl -kI https://server 2> /dev/null > /dev/null
29 | do
30 | echo Waiting for server to start, this can take up to a minute ...
31 | docker ps -a
32 | docker logs server
33 | sleep 1
34 | done
35 | docker ps -a
36 | docker logs server
37 | echo Confirmed that https://server is started now
38 |
39 | echo Getting cookie for Alice...
40 | export COOKIE="`docker run --rm --cap-add=SYS_ADMIN --network=testnet -e SERVER_TYPE=php-solid-server --env-file ./env-vars-for-test-image.list cookie`"
41 | if [[ $COOKIE == PHPSESSID* ]]
42 | then
43 | echo Successfully obtained cookie for Alice: $COOKIE
44 | else
45 | echo Error obtaining cookie for Alice, stopping.
46 | exit 1
47 | fi
48 |
49 | until docker run --rm --network=testnet webid-provider-tests curl -kI https://thirdparty 2> /dev/null > /dev/null
50 | do
51 | echo Waiting for thirdparty to start, this can take up to a minute ...
52 | docker ps -a
53 | docker logs thirdparty
54 | sleep 1
55 | done
56 | docker ps -a
57 | docker logs thirdparty
58 | echo Confirmed that https://thirdparty is started now
59 |
60 | echo Getting cookie for Bob...
61 | export COOKIE_BOB="`docker run --rm --cap-add=SYS_ADMIN --network=testnet -e SERVER_TYPE=php-solid-server --env-file ./env-vars-for-third-party.list cookie`"
62 | if [[ $COOKIE_BOB == PHPSESSID* ]]
63 | then
64 | echo Successfully obtained cookie for Bob: $COOKIE_BOB
65 | else
66 | echo Error obtaining cookie for Bob, stopping.
67 | exit 1
68 | fi
69 | }
70 |
71 | function runTests {
72 | echo "Running webid-provider tests with cookie $COOKIE"
73 | docker run --rm --network=testnet --env COOKIE="$COOKIE" --env-file ./env-vars-for-test-image.list webid-provider-tests
74 | docker run --rm --network=testnet --env COOKIE="$COOKIE" --env-file ./env-vars-for-test-image.list solid-crud-tests
75 | docker run --rm --network=testnet --env COOKIE="$COOKIE" --env COOKIE_ALICE="$COOKIE" --env COOKIE_BOB="$COOKIE_BOB" --env-file ./env-vars-for-test-image.list web-access-control-tests
76 | }
77 |
78 | function teardown {
79 | docker stop `docker ps --filter network=testnet -q`
80 | docker rm `docker ps --filter network=testnet -qa`
81 | docker network remove testnet
82 | }
83 |
84 | teardown || true
85 | setup
86 | runPss
87 | runTests
88 | # teardown
89 |
--------------------------------------------------------------------------------
/tests/fixtures/foaf.rdf:
--------------------------------------------------------------------------------
1 |
10 |
11 | Peachey
20 | Ben
21 |
23 |
24 | Alice
25 | 9e9c84204ba63aa49a664273c5563c0cd78cc9ea
26 |
28 |
29 |
30 |
31 | Bob
32 | 1a9daad476f0158b81bc66b7b27b438b4b4c19c0
33 |
35 |
36 | 012e360c88b2bf940e6a52de3e5bbf59ccbdada6
37 | Ben Peachey
38 | Potherca
39 | Mr.
42 |
45 |
46 |
51 |
52 | Bobby
61 | Bob
62 | Bob Bobby
63 | Bobbers
64 |
66 |
67 |
--------------------------------------------------------------------------------
/src/Controller/ResourceController.php:
--------------------------------------------------------------------------------
1 | server = $server;
29 | $this->DPop = new DPop();
30 | $this->WAC = new WAC($server->getFilesystem());
31 |
32 | // Make sure the root folder has an acl file, as is required by the spec;
33 | // Generate a default file granting the owner full access if there is nothing there.
34 | if (!$server->getFilesystem()->has("/storage/.acl")) {
35 | $defaultAcl = $this->generateDefaultAcl();
36 | $server->getFilesystem()->write("/storage/.acl", $defaultAcl);
37 | }
38 | }
39 |
40 | final public function __invoke(Request $request, array $args) : Response
41 | {
42 | try {
43 | $webId = $this->DPop->getWebId($request);
44 | } catch(\Exception $e) {
45 | return $this->server->getResponse()->withStatus(409, 'Invalid token');
46 | }
47 |
48 | $allowedOrigins = $this->config->getAllowedOrigins();
49 | $origins = $request->getHeader('Origin');
50 |
51 | if ($origins !== []) {
52 | foreach ($origins as $origin) {
53 | if ($this->WAC->isAllowed($request, $webId, $origin, $allowedOrigins)) {
54 | $response = $this->server->respondToRequest($request);
55 |
56 | return $this->WAC->addWACHeaders($request, $response, $webId);
57 | }
58 | }
59 | return $this->server->getResponse()->withStatus(403, 'Access denied');
60 | } else {
61 | $response = $this->server->respondToRequest($request);
62 |
63 | return $this->WAC->addWACHeaders($request, $response, $webId);
64 | }
65 | }
66 |
67 | ////////////////////////////// UTILITY METHODS \\\\\\\\\\\\\\\\\\\\\\\\\\\\\
68 |
69 | private function generateDefaultAcl()
70 | {
71 | $defaultProfile = <<< EOF
72 | # Root ACL resource for the user account
73 | @prefix acl: .
74 | @prefix foaf: {$message} {$exception->getMessage()} ({$status})
";
232 |
233 | if (getenv('ENVIRONMENT') === 'development') {
234 | $html .= "{$exception->getTraceAsString()} ";
235 | }
236 |
237 | $response = new HtmlResponse($html, $status, $exception->getHeaders());
238 | } catch (\Throwable $exception) {
239 | $class = get_class($exception);
240 | $html = "Oh-no! The developers messed up! {$exception->getMessage()} ($class)
";
241 |
242 | if (getenv('ENVIRONMENT') === 'development') {
243 | $html .=
244 | "{$exception->getFile()}:{$exception->getLine()}
" .
245 | "{$exception->getTraceAsString()} "
246 | ;
247 | }
248 |
249 | $response = new HtmlResponse($html, 500, []);
250 | }
251 |
252 | // send the response to the browser
253 | $emitter->emit($response);
254 | exit;
255 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Standalone PHP Solid Server
2 |
3 | [![Project stage: Development][project-stage-badge: Development]][project-stage-page]
4 | [![License][license-shield]][license-link]
5 | [![Latest Version][version-shield]][version-link]
6 | ![Maintained][maintained-shield]
7 |
8 | [![PDS Interop][pdsinterop-shield]][pdsinterop-site]
9 | [![standard-readme compliant][standard-readme-shield]][standard-readme-link]
10 | [![keep-a-changelog compliant][keep-a-changelog-shield]][keep-a-changelog-link]
11 |
12 | _Standalone Solid Server written in PHP by PDS Interop_
13 |
14 | ## Table of Contents
15 |
16 |
17 |
18 | - [Background](#background)
19 | - [Installation](#installation)
20 | - [Usage](#usage)
21 | - [Docker images](#docker-images)
22 | - [Local environment](#local-environment)
23 | - [Built-in PHP HTTP server](#built-in-php-http-server)
24 | - [Security](#security)
25 | - [Running solid/webid-provider-tests](#running-solidwebid-provider-tests)
26 | - [Available Features](#available-features)
27 | - [Development](#development)
28 | - [Project structure](#project-structure)
29 | - [Testing](#testing)
30 | - [Contributing](#contributing)
31 | - [License](#license)
32 |
33 |
34 |
35 | ## Background
36 |
37 | The Solid specifications defines what makes a "Solid Server". Parts of
38 | those specifications are still likely to change, but at the time of this writing,
39 | they define:
40 |
41 | - Authentication
42 | - Authorization (and access control)
43 | - Content representation
44 | - Identity
45 | - Profiles
46 | - Resource (reading and writing) API
47 | - Social Web App Protocols (Notifications, Friends Lists, Followers and Following)
48 |
49 | ## Installation
50 |
51 | To install the project, clone it from GitHub and install the PHP dependencies
52 | using Composer:
53 |
54 | ```sh
55 | git clone git://github.com/pdsinterop/php-solid-server.git \
56 | && cd php-solid-server \
57 | && composer install --no-dev --prefer-dist
58 | ```
59 | At this point, the application is ready to run.
60 |
61 | ## Usage
62 |
63 | The PHP Solid server can be run in several different ways.
64 |
65 | The application can be run with a Docker image of your choice or on a local
66 | environment, using Apache, NginX, or PHP's internal HTTP server. The latter is
67 | only advised in development.
68 |
69 | For security reasons, the server expects to run on HTTPS (also known as HTTP+TLS).
70 |
71 | To run insecure, for instance when the application is run behind a proxy or in a
72 | PHP-FPM (or similar) setup, set the environment variable `PROXY_MODE`.
73 | This will allow the application to accept HTTP requests.
74 |
75 | ### Docker images
76 |
77 | When running with your own Docker image, make sure to mount the project folder
78 | to wherever the image expects it to be, e.g. `/app` or `/var/www`.
79 |
80 | For instance:
81 |
82 | ```
83 | export PORT=8080 && \
84 | docker run \
85 | --env "PORT=${PORT}" \
86 | --expose "${PORT}" \
87 | --network host \
88 | --rm \
89 | --volume "$PWD:/app" \
90 | -it \
91 | php:7.3 \
92 | php --docroot /app/web/ --server "localhost:${PORT}" /app/web/index.php
93 | ```
94 | Or on Mac:
95 | ```
96 | export PORT=8080 && \
97 | docker run \
98 | --env "PORT=${PORT}" \
99 | --expose "${PORT}" \
100 | -p "${PORT}:${PORT}" \
101 | --rm \
102 | --volume "$PWD:/app" \
103 | -it \
104 | php:7.3 \
105 | php --docroot /app/web/ --server "localhost:${PORT}" /app/web/index.php
106 | ```
107 |
108 |
109 | ### Local environment
110 |
111 | How to run this application in an Apache, NginX, or other popular HTTP servers
112 | falls outside the scope of this project.
113 |
114 | For development purposes, the internal PHP HTTP server _is_ explained below.
115 |
116 | #### Built-in PHP HTTP server
117 |
118 | For development purposes a Composer `serve-dev` command has been provided. This will
119 | run the application using PHP internal HTTP server.
120 |
121 | To use it, run `composer serve-dev` in the project root.
122 |
123 | **!!! FOR SECURITY REASONS, DO NOT USE THIS METHOD IN PRODUCTION !!!**
124 |
125 | By default, the application is hosted on `localhost` port `8080`.
126 | So if you visit http://localhost:8080/ with your browser, you should see "Hello, World!".
127 |
128 | Both the `HOST` and `PORT` can be configured before running the command by
129 | setting them in the environment, for instance:
130 |
131 | ```sh
132 | HOST='solid.local' PORT=1234 composer serve-dev
133 | ```
134 |
135 | This command can also be run through a docker container, for instance:
136 |
137 | ```
138 | export PORT=8080 && \
139 | docker run \
140 | --env "PORT=${PORT}" \
141 | --expose "${PORT}" \
142 | --network host \
143 | --rm \
144 | --volume "$PWD:/app" \
145 | -it \
146 | composer:latest \
147 | serve
148 | ```
149 |
150 |
157 |
158 | ## Running solid/webid-provider-tests
159 | Due to https://github.com/pdsinterop/php-solid-server/issues/8 you should run, in one terminal window:
160 | ```sh
161 | HOST=127.0.0.1 composer serve-dev
162 | ```
163 | and in another you run the [webid-provider-test](https://github.com/solid/webid-provider-tests) as:
164 | ```sh
165 | SERVER_ROOT=http://localhost:8080 ./node_modules/.bin/jest test/surface/fetch-openid-config.test.ts
166 | ```
167 | The current `dev` branch of php-solid-server should pass roughly 7 out of 17 tests.
168 |
169 | ## Available Features
170 |
171 | Based on the specifications, the features listed below _should_ be available.
172 |
173 | The checkboxes show which features _are_, and which ones _are not_.
174 |
175 | The underlying functionality for these features is provided by:
176 |
177 | - [auth] = [`pdsinterop/solid-auth`](https://github.com/pdsinterop/php-solid-auth)
178 | - [crud] = [`pdsinterop/solid-crud`](https://github.com/pdsinterop/php-solid-crud)
179 | - [p/s] = [`pdsinterop/solid-pubsub-server`](https://github.com/pdsinterop/php-solid-pubsub-server)
180 | - [rdf] = [`pdsinterop/flysystem-rdf`](https://github.com/pdsinterop/flysystem-rdf)
181 |
182 | 1. User
183 | - [x] Authentication [auth] (since **v0.3**)
184 | - [x] Identity (since **v0.2**)
185 | - [x] Profiles (since **v0.2**)
186 | 2. Data storage
187 | - [x] Content representation [rdf] (since **v0.4**)
188 | - [x] Resource API
189 | - [x] HTTP REST API [crud] (since **v0.4**)
190 | - [x] Websocket API [p/s] (since **v0.6**)
191 | 3. Web Acces Control List
192 | - [x] Authorization (and Access Control) [crud] (since **v0.6**)
193 | 4. Social web apps
194 | - [ ] Calendar
195 | - [ ] Contacts
196 | - [ ] Friends Lists (Followers, Following)
197 | - [ ] Notifications
198 |
199 | ## Development
200 |
201 | The easiest way to develop this project is by running the environment provided
202 | by the `docker-compose.yml` file. This can be done by running `docker-compose up`.
203 |
204 | This will start the application and a pubsub server in separate docker containers.
205 |
206 | ### Project structure
207 |
208 | This project is structured as follows:
209 |
210 | ```
211 | .
212 | ├── bin/ <- CLI scripts
213 | ├── config/ <- Empty directory where server configuration is generated
214 | ├── docs/ <- Documentation
215 | ├── src/ <- Source code
216 | ├── tests/ <- Test fixtures, Integration- and unit-tests
217 | ├── vendor/ <- Third-party and vendor code
218 | ├── web/ <- Web content
219 | ├── composer.json <- PHP package and dependency configuration
220 | └── README.md <- You are now here
221 | ```
222 |
223 | ### Testing
224 |
225 | The PHPUnit version to be used is the one installed as a `dev-` dependency via composer. It can be run using `composer test` or by calling it directly:
226 |
227 | ```sh
228 | $ ./bin/phpunit
229 | ```
230 |
231 | ## Contributing
232 |
233 | Questions or feedback can be given by [opening an issue on GitHub][issues-link].
234 |
235 | All PDS Interop projects are open source and community-friendly.
236 | Any contribution is welcome!
237 | For more details read the [contribution guidelines][contributing-link].
238 |
239 | All PDS Interop projects adhere to [the Code Manifesto](http://codemanifesto.com)
240 | as its [code-of-conduct][code-of-conduct]. Contributors are expected to abide by its terms.
241 |
242 | There is [a list of all contributors on GitHub][contributors-page].
243 |
244 | For a list of changes see the [CHANGELOG][changelog] or [the GitHub releases page][releases-page].
245 |
246 | ## License
247 |
248 | All code created by PDS Interop is licensed under the [MIT License][license-link].
249 |
250 | [changelog]: CHANGELOG.md
251 | [code-of-conduct]: CODE_OF_CONDUCT.md
252 | [contributing-link]: CONTRIBUTING.md
253 | [contributors-page]: https://github.com/pdsinterop/php-solid-server/contributors
254 | [issues-link]: https://github.com/pdsinterop/php-solid-server/issues
255 | [releases-page]: https://github.com/pdsinterop/php-solid-server/releases
256 | [keep-a-changelog-link]: https://keepachangelog.com/
257 | [keep-a-changelog-shield]: https://img.shields.io/badge/Keep%20a%20Changelog-f15d30.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IiNmZmYiIHZpZXdCb3g9IjAgMCAxODcgMTg1Ij48cGF0aCBkPSJNNjIgN2MtMTUgMy0yOCAxMC0zNyAyMmExMjIgMTIyIDAgMDAtMTggOTEgNzQgNzQgMCAwMDE2IDM4YzYgOSAxNCAxNSAyNCAxOGE4OSA4OSAwIDAwMjQgNCA0NSA0NSAwIDAwNiAwbDMtMSAxMy0xYTE1OCAxNTggMCAwMDU1LTE3IDYzIDYzIDAgMDAzNS01MiAzNCAzNCAwIDAwLTEtNWMtMy0xOC05LTMzLTE5LTQ3LTEyLTE3LTI0LTI4LTM4LTM3QTg1IDg1IDAgMDA2MiA3em0zMCA4YzIwIDQgMzggMTQgNTMgMzEgMTcgMTggMjYgMzcgMjkgNTh2MTJjLTMgMTctMTMgMzAtMjggMzhhMTU1IDE1NSAwIDAxLTUzIDE2bC0xMyAyaC0xYTUxIDUxIDAgMDEtMTItMWwtMTctMmMtMTMtNC0yMy0xMi0yOS0yNy01LTEyLTgtMjQtOC0zOWExMzMgMTMzIDAgMDE4LTUwYzUtMTMgMTEtMjYgMjYtMzMgMTQtNyAyOS05IDQ1LTV6TTQwIDQ1YTk0IDk0IDAgMDAtMTcgNTQgNzUgNzUgMCAwMDYgMzJjOCAxOSAyMiAzMSA0MiAzMiAyMSAyIDQxLTIgNjAtMTRhNjAgNjAgMCAwMDIxLTE5IDUzIDUzIDAgMDA5LTI5YzAtMTYtOC0zMy0yMy01MWE0NyA0NyAwIDAwLTUtNWMtMjMtMjAtNDUtMjYtNjctMTgtMTIgNC0yMCA5LTI2IDE4em0xMDggNzZhNTAgNTAgMCAwMS0yMSAyMmMtMTcgOS0zMiAxMy00OCAxMy0xMSAwLTIxLTMtMzAtOS01LTMtOS05LTEzLTE2YTgxIDgxIDAgMDEtNi0zMiA5NCA5NCAwIDAxOC0zNSA5MCA5MCAwIDAxNi0xMmwxLTJjNS05IDEzLTEzIDIzLTE2IDE2LTUgMzItMyA1MCA5IDEzIDggMjMgMjAgMzAgMzYgNyAxNSA3IDI5IDAgNDJ6bS00My03M2MtMTctOC0zMy02LTQ2IDUtMTAgOC0xNiAyMC0xOSAzN2E1NCA1NCAwIDAwNSAzNGM3IDE1IDIwIDIzIDM3IDIyIDIyLTEgMzgtOSA0OC0yNGE0MSA0MSAwIDAwOC0yNCA0MyA0MyAwIDAwLTEtMTJjLTYtMTgtMTYtMzEtMzItMzh6bS0yMyA5MWgtMWMtNyAwLTE0LTItMjEtN2EyNyAyNyAwIDAxLTEwLTEzIDU3IDU3IDAgMDEtNC0yMCA2MyA2MyAwIDAxNi0yNWM1LTEyIDEyLTE5IDI0LTIxIDktMyAxOC0yIDI3IDIgMTQgNiAyMyAxOCAyNyAzM3MtMiAzMS0xNiA0MGMtMTEgOC0yMSAxMS0zMiAxMXptMS0zNHYxNGgtOFY2OGg4djI4bDEwLTEwaDExbC0xNCAxNSAxNyAxOEg5NnoiLz48L3N2Zz4K
258 | [license-link]: ./LICENSE
259 | [license-shield]: https://img.shields.io/github/license/pdsinterop/php-solid-server.svg
260 | [maintained-shield]: https://img.shields.io/maintenance/yes/2022.svg
261 | [pdsinterop-shield]: https://img.shields.io/badge/-PDS%20Interop-7C4DFF.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9Ii01IC01IDExMCAxMTAiIGZpbGw9IiNGRkYiIHN0cm9rZS13aWR0aD0iMCI+CiAgICA8cGF0aCBkPSJNLTEgNTJoMTdhMzcuNSAzNC41IDAgMDAyNS41IDMxLjE1di0xMy43NWEyMC43NSAyMSAwIDAxOC41LTQwLjI1IDIwLjc1IDIxIDAgMDE4LjUgNDAuMjV2MTMuNzVhMzcgMzQuNSAwIDAwMjUuNS0zMS4xNWgxN2EyMiAyMS4xNSAwIDAxLTEwMiAweiIvPgogICAgPHBhdGggZD0iTSAxMDEgNDhhMi43NyAyLjY3IDAgMDAtMTAyIDBoIDE3YTIuOTcgMi44IDAgMDE2OCAweiIvPgo8L3N2Zz4K
262 | [pdsinterop-site]: https://pdsinterop.org/
263 | [project-stage-badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
264 | [project-stage-page]: https://blog.pother.ca/project-stages/
265 | [standard-readme-link]: https://github.com/RichardLitt/standard-readme
266 | [standard-readme-shield]: https://img.shields.io/badge/-Standard%20Readme-brightgreen.svg
267 | [version-link]: https://packagist.org/packages/pdsinterop/php-solid-server
268 | [version-shield]: https://img.shields.io/github/v/release/pdsinterop/php-solid-server?sort=semver
269 |
--------------------------------------------------------------------------------