Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oatpp/example-libressl
Example project how-to use oatpp-libressl submodule. HTTPS async server.
https://github.com/oatpp/example-libressl
async https-server libressl oatpp tls
Last synced: 4 days ago
JSON representation
Example project how-to use oatpp-libressl submodule. HTTPS async server.
- Host: GitHub
- URL: https://github.com/oatpp/example-libressl
- Owner: oatpp
- Created: 2019-01-29T15:54:20.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T21:28:22.000Z (7 months ago)
- Last Synced: 2024-10-29T22:52:34.228Z (16 days ago)
- Topics: async, https-server, libressl, oatpp, tls
- Language: C++
- Homepage: https://oatpp.io/
- Size: 32.2 KB
- Stars: 12
- Watchers: 4
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TLS-LibreSSL Example [](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=13&branchName=master)
Example project of how-to use [oatpp-libressl](https://github.com/oatpp/oatpp-libressl) module.
- Serve via HTTPS
- Make client calls via HTTPS.
- Using oatpp Async API.
See more:
- [Oat++ Website](https://oatpp.io/)
- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
- [Get Started](https://oatpp.io/docs/start)
## Overview
This project is using [oatpp](https://github.com/oatpp/oatpp) and [oatpp-libressl](https://github.com/oatpp/oatpp-libressl) modules.
### Project layout
```
|- CMakeLists.txt // projects CMakeLists.txt
|- src/
| |
| |- controller/ // Folder containing Controller where all endpoints are declared
| |- client/ // HTTP client is here. Used in "proxy" endpoint /api/get
| |- dto/ // DTOs are declared here
| |- AppComponent.hpp // Service config
| |- App.cpp // main() is here
|
|- test/ // test folder
|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
|- cert/ // folder with test certificates
```
---
### Build and Run
#### Using CMake
**Requires**
- LibreSSL installed. You may refer to this sh script - how to install libressl -
[install-libressl.sh](https://github.com/oatpp/oatpp-libressl/blob/master/utility/install-deps/install-libressl.sh).
Or try something like ```$ apk add libressl-dev```
- `oatpp` and `oatpp-libressl` modules installed. You may run `utility/install-oatpp-modules.sh`
script to install required oatpp modules.
```
$ mkdir build && cd build
$ cmake ..
$ make
$ ././example-libressl-exe # - run application.
```
#### In Docker
```
$ docker build -t example-libressl .
$ docker run -p 8443:8443 -t example-libressl
```
---
### Configure AppComponent
Configure server secure connection provider
```c++
/**
* Create ConnectionProvider component which listens on the port
*/
OATPP_CREATE_COMPONENT(std::shared_ptr, serverConnectionProvider)([] {
/* non_blocking connections should be used with AsyncHttpConnectionHandler for AsyncIO */
auto config = oatpp::libressl::Config::createDefaultServerConfig("cert/test_key.pem", "cert/test_cert.crt");
return oatpp::libressl::server::ConnectionProvider::createShared(config, 8443, true /* true for non_blocking */);
}());
```
Configure client secure connection provider
```c++
OATPP_CREATE_COMPONENT(std::shared_ptr, sslClientConnectionProvider) ([] {
auto config = oatpp::libressl::Config::createShared();
tls_config_insecure_noverifycert(config->getTLSConfig());
tls_config_insecure_noverifyname(config->getTLSConfig());
return oatpp::libressl::client::ConnectionProvider::createShared(config, "httpbin.org", 443);
}());
```
### Endpoints
---
"Hello Async" root endpoint with json response
```c++
ENDPOINT_ASYNC("GET", "/", Root) {
ENDPOINT_ASYNC_INIT(Root)
Action act() override {
auto dto = HelloDto::createShared();
dto->message = "Hello Async!";
dto->server = Header::Value::SERVER;
dto->userAgent = request->getHeader(Header::USER_AGENT);
return _return(controller->createDtoResponse(Status::CODE_200, dto));
}
};
```
result:
```
$ curl -X GET "https://localhost:8443/" --insecure
{"user-agent": "curl\/7.54.0", "message": "Hello Async!", "server": "oatpp\/0.19.1"}
```
---
Async proxy endpoint to ```https://httpbin.org/get```
```c++
ENDPOINT_ASYNC("GET", "/api/get", TestApiGet) {
ENDPOINT_ASYNC_INIT(TestApiGet)
Action act() override {
return controller->myApiClient->apiGetAsync().callbackTo(&TestApiGet::onResponse);
}
Action onResponse(const std::shared_ptr& response){
return response->readBodyToStringAsync().callbackTo(&TestApiGet::returnResult);
}
Action returnResult(const oatpp::String& body) {
return _return(controller->createResponse(Status::CODE_200, body));
}
};
```
result:
```
$ curl -X GET "https://localhost:8443/api/get" --insecure
{
"args": {},
"headers": {
"Connection": "close",
"Host": "httpbin.org"
},
"origin": "176.37.47.230",
"url": "https://httpbin.org/get"
}
```