gosc2023: net: http: project overview

[Emna-Rekik]

High Level Milestones / Deliverables

• Milestone 0: Continuous Integration
• Milestone 1: HTTP 2.0 Server (prototypes in Linux)
• Milestone 2: Rest API Support
• Milestone 3: CRiMe Support
• Milestone 4: JSON Support
• Milestone 5: TLS Support

Milestone 0: Continuous Integration

• gsoc2023: net: http: set up test for continuous integration #59028
• Enable Test Coverage

Milestone 1: HTTP 2.0 Server (prototypes in Linux)

RFC 9113: https://datatracker.ietf.org/doc/html/rfc9113

• Unit tests, Test Points, Features, etc
  • gsoc2023: net: http: performance analysis #59567
  • gsoc2023: net: http: Stress tests #59681
  • gsoc2023: net: http: Kconfig options #59684
  • gsoc2023: net: http: IPv4/IPv6 support #59685
  • gsoc2023: net: http: server is up #59686
  • gsoc2023: net: http: server can be shut down #59688
  • gsoc2023: net: http: loopback interface, ethernet, etc #59689
  • gsoc2023: net: http: HTTP 1.1 backward compatibility #59690
  • gsoc2023: net: http: Verify HTTP 1.1 to 2.0 upgrade #59670
  • gsoc2023: net: http: HTTP Header Parsing #59691
  • gsoc2023: net: http: HTTP Header Compression #59693
  • gsoc2023: net: http: Verify HTTP 2.0 concurrent streams #59694
  • gsoc2023: net: http: Verify HTTP 2.0 framing #59695
  • gsoc2023: net: http: Verify HTTP 2.0 frame types #59696
  • gsoc2023: net: http: Data, Header, Continuation, Settings #59697
  • gsoc2023: net: http: Data exchange #59698
  • gsoc2023: net: http: Verify HTTP 2.0 stream functionality #59699
  • gsoc2023: net: http: Gzipped Compression #59700

• Reuse Zephyr's HTTP Client Library
• Reuse Zephyr's HTTP Parser Library

Milestone 2: Rest API Support

• show multiple REST clients using the server simultaneously
• Sample apps with >= 2 REST endpoints
  • Use a REST generator to simplify things!
  • https://github.com/OAI/OpenAPI-Specification/
  • https://github.com/cfriedt/hanoi
• Documentation about how to add custom REST endpoints

Milestone 3: CRiMe Support

Not to be confused with the HTTP 2.0 / SPDY attack
https://en.wikipedia.org/wiki/CRIME

• gzip compression, use existing cmake + any necessary wrappers

Milestone 4: JSON Support

• Show that it's possible to exchange data with Zephyr over HTTP (JSON is often used in REST applications)
• Use Zephyr's Existing JSON Library

Milestone 5: TLS Support

• Security Regression Testsuite (show that we are not vulnerable to old attacks)
  • Research historically what CVEs affected Zephyr's HTTP support (via CivetWeb)
  • We don't want our new HTTP server to exhibit the same security vulnerabilities
• certificate compression / storage
• user provided certificates
• Asymmetric Encryption approach
• Symmetric Encryption approach (Mutual Authentication)
• Existing reference - samples/...

Milestone 6: Documentation (this is not an official milestone, but it is a deliverable)

• Ensure that there is adequate publishable content including
  • user-facing instructions ("How do I customize the HTTP Server?")
  • can be bundled with Sample app, but also important to document features in general (i.e. some .rst file in doc/)
  • features, performance, ...

[github-actions]

Hi @Emna-Rekik! We appreciate you submitting your first issue for our open-source project. 🌟

Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙

[cfriedt]

We might be able to assign tasks to Emna once she has made a commit. I'm not sure.

[cfriedt]

@Emna-Rekik, @rlubos - I wonder if the format of this should be more like an RFC. What do you think? It can be refined and then probably presented at the Networking Forum for feedback / discussion. IIRC, it's once a month, but I'm not sure of the next meeting.

[rlubos]

It can be refined and then probably presented at the Networking Forum for feedback / discussion. IIRC, it's once a month, but I'm not sure of the next meeting.

Next Networking Forum is due on 4th of July, not sure about the attendance though given this specific date. But for sure we could put this on the agenda.

[cfriedt]

@Emna-Rekik - could you possibly cut & paste the test plan portion of this issue somewhere else? Let's try to keep this issue description as more or less a checklist of subtasks

[clamattia]

Hello Zephyr Community

We are very interested in this feature and are curious, whether there is still work in progress on this.
Is the http server on the roadmap/planned?

[rlubos]

@clamattia Yes, we're working on wrapping the project up and integrating it with Zephyr (hopefully for 3.7 release).

[clamattia]

@clamattia Yes, we're working on wrapping the project up and integrating it with Zephyr (hopefully for 3.7 release).

Cool, thanks.