{{message}}
8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /src/main/resources/public/style.css: -------------------------------------------------------------------------------- 1 | body { 2 | font-family: "Droid Sans", sans-serif; 3 | } 4 | 5 | .content { 6 | padding: 50px; 7 | } 8 | 9 | .content { 10 | padding: 50px; 11 | } 12 | 13 | .errors { 14 | list-style: none; 15 | color: red; 16 | } 17 | -------------------------------------------------------------------------------- /src/test/kotlin/env/oauthserver/UserAuthentication.kt: -------------------------------------------------------------------------------- 1 | package env.oauthserver 2 | 3 | import org.http4k.core.Credentials 4 | 5 | class UserAuthentication(private vararg val validCredentials: Credentials) { 6 | fun authenticate(credentials: Credentials) = credentials in validCredentials 7 | } 8 | -------------------------------------------------------------------------------- /src/test/resources/functional/WebTest.serves static content.approved: -------------------------------------------------------------------------------- 1 | body { 2 | font-family: "Droid Sans", sans-serif; 3 | } 4 | 5 | .content { 6 | padding: 50px; 7 | } 8 | 9 | .content { 10 | padding: 50px; 11 | } 12 | 13 | .errors { 14 | list-style: none; 15 | color: red; 16 | } 17 | -------------------------------------------------------------------------------- /src/main/kotlin/verysecuresystems/diagnostic/Ping.kt: -------------------------------------------------------------------------------- 1 | package verysecuresystems.diagnostic 2 | 3 | import org.http4k.core.Method.GET 4 | import org.http4k.core.Response 5 | import org.http4k.core.Status.Companion.OK 6 | import org.http4k.routing.bind 7 | 8 | fun Ping() = "/ping" bind GET to { Response(OK).body("pong") } 9 | -------------------------------------------------------------------------------- /src/main/kotlin/verysecuresystems/Main.kt: -------------------------------------------------------------------------------- 1 | package verysecuresystems 2 | 3 | import org.http4k.config.Environment 4 | 5 | /** 6 | * Main entry point. Note that this will not run without setting up the correct environmental variables 7 | * - see RunnableEnvironment for a demo-able version of the server. 8 | */ 9 | fun main() { 10 | SecuritySystemServer(Environment.ENV).start() 11 | } -------------------------------------------------------------------------------- /src/main/kotlin/verysecuresystems/diagnostic/Uptime.kt: -------------------------------------------------------------------------------- 1 | package verysecuresystems.diagnostic 2 | 3 | import org.http4k.core.Method.GET 4 | import org.http4k.core.Response 5 | import org.http4k.core.Status.Companion.OK 6 | import org.http4k.routing.RoutingHttpHandler 7 | import org.http4k.routing.bind 8 | import java.time.Clock 9 | 10 | fun Uptime(clock: Clock): RoutingHttpHandler { 11 | val startTime = clock.instant().toEpochMilli() 12 | return "/uptime" bind GET to { 13 | Response(OK).body("uptime is: ${(clock.instant().toEpochMilli() - startTime) / 1000}s") 14 | } 15 | } -------------------------------------------------------------------------------- /src/main/kotlin/verysecuresystems/oauth/TokenChecker.kt: -------------------------------------------------------------------------------- 1 | package verysecuresystems.oauth 2 | 3 | import org.http4k.security.AccessToken 4 | 5 | /** 6 | * Checks that the passed BearerToken is authentic. (eg. signed with a particular key) 7 | */ 8 | interface TokenChecker { 9 | fun check(accessToken: AccessToken): Boolean 10 | } 11 | 12 | /** 13 | * We aren't doing any crypto in this example, so just check the key for the prefix. 14 | */ 15 | object InsecureTokenChecker : TokenChecker { 16 | override fun check(accessToken: AccessToken) = accessToken.value.startsWith("ACCESS_TOKEN") 17 | } -------------------------------------------------------------------------------- /src/test/kotlin/cdc/entrylogger/RealEntryLoggerTest.kt: -------------------------------------------------------------------------------- 1 | package cdc.entrylogger 2 | 3 | import org.http4k.client.OkHttp 4 | import org.http4k.core.Uri 5 | import org.http4k.core.then 6 | import org.http4k.filter.ClientFilters 7 | import org.junit.jupiter.api.Disabled 8 | 9 | /** 10 | * Contract implementation for the real user directory service. Extra steps might be required here to setup/teardown 11 | * test data. 12 | */ 13 | @Disabled // this would not be ignored in reality 14 | class RealEntryLoggerTest : EntryLoggerContract { 15 | override val http = ClientFilters.SetHostFrom(Uri.of("http://entrylogger.com")).then(OkHttp()) 16 | } -------------------------------------------------------------------------------- /src/main/kotlin/verysecuresystems/diagnostic/Diagnostic.kt: -------------------------------------------------------------------------------- 1 | package verysecuresystems.diagnostic 2 | 3 | import org.http4k.core.Method.GET 4 | import org.http4k.core.Response 5 | import org.http4k.core.Status.Companion.OK 6 | import org.http4k.routing.RoutingHttpHandler 7 | import org.http4k.routing.bind 8 | import org.http4k.routing.routes 9 | import java.time.Clock 10 | 11 | /** 12 | * The internal monitoring API. 13 | */ 14 | fun Diagnostic(clock: Clock): RoutingHttpHandler = "/internal" bind routes( 15 | Ping(), 16 | Uptime(clock), 17 | "/" bind GET to { Response(OK).body("diagnostic module. visit: /ping or /uptime") } 18 | ) 19 | -------------------------------------------------------------------------------- /src/test/resources/functional/ManageUsersTest.add user then delete them.approved: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |Known users are:
7 |Known users are:
7 |The time is {{time}}
9 |Your browser is {{browser}}
10 |Here is a (OAuth secured) list of known users (rendered with a Handlebars template)
11 |Here is the auto-generated remote API documentation (using a OpenApi 3 renderer)
12 |Here is a secured OpenApi 3 UI for interacting with the API (using a StaticModule)
13 |Here are some diagnostic endpoints
14 |Here is the Chaos injection interface for the user directory.
15 |
16 | The time is 3000-01-01T00:00:00
9 |Your browser is unknown
10 |Here is a (OAuth secured) list of known users (rendered with a Handlebars template)
11 |Here is the auto-generated remote API documentation (using a OpenApi 3 renderer)
12 |Here is a secured OpenApi 3 UI for interacting with the API (using a StaticModule)
13 |Here are some diagnostic endpoints
14 |Here is the Chaos injection interface for the user directory.
15 |
16 | Known users are:
7 || bob | email@email | 11 | 15 | |
Known users are:
7 || {{name.value}} | {{email.value}} | 11 | 15 | |
4 | [](https://codecov.io/gh/http4k/http4k-by-example)
5 |
6 | #### about
7 | Complete TDD'd example [http4k](http://http4k.org) application showcasing a lot of the http4k features for building and testing apps.
8 |
9 | ##### Features:
10 | - Composable routing in both standard and contract (OpenAPI) forms with automatic parameter marshalling and unmarshalling (Headers/Query/Path/Body/Forms)
11 | - HTTP response building, including sample JSON library support (Jackson) and auto-data class instance marshalling
12 | - OpenAPI v3 documentation and JSON schema generation from example model objects and OAuth-based security
13 | - Automatic invalid request handling
14 | - Endpoint security via an OAuth (including simple OAuth Server implementation)
15 | - Templating system (Handlebars)
16 | - Typesafe Form handling with validation and error feedback
17 | - Configured via typesafe 12-factor configuration
18 | - Serving of static resources
19 |
20 | ##### Testing features:
21 | - Testing applications completely in-memory for ultra fast test suites
22 | - Approval-based testing for testing JSON and HTML responses
23 | - Hamkrest matchers for easy assertions on http4k objects
24 | - Reusable Fake HTTP dependencies, with behaviour proven by Consumer Driven Contracts
25 | - WebDriver usage for browser-based testing
26 | - Simulating failures with the http4k ChaosEngine
27 |
28 | It has been developed in a London-TDD style with outside-in acceptance testing and CDCs for outside dependencies,
29 | to give a complete overview of how the app would look when finished.
30 |
31 | #### running this demo app
32 | 1. Clone this repo
33 | 2. Run `RunnableEnvironment` from an IDE. This will start the application on port 9000, which has been configured to use a fake versions of the remote dependencies (on ports 10000, 11000 and 12000)
34 | 3. Just point your browser at [http://localhost:9000/](http://localhost:9000/)
35 | 4. OAuth login details are `user:password`
36 |
37 |