mirror/go-gemini
1
0
Fork 0
mirror of https://git.sr.ht/~adnano/go-gemini synced 2024-11-23 21:02:28 +01:00
Code Releases Activity
Go implementation of the Gemini protocol
31 Commits 1 Branch 33 Tags 1.4 MiB
Go 100%
10139736e6
Go to file
adnano 10139736e6 Rename gemini.go to client.go
2020-09-25 19:07:40 -04:00
examples Remove TLSConfig fields 2020-09-25 18:53:20 -04:00
client.go Rename gemini.go to client.go 2020-09-25 19:07:40 -04:00
gemini_test.go Add test 2020-09-25 11:27:26 -04:00
go.mod Initial commit 2020-09-21 15:49:09 -04:00
LICENSE Add LICENSE 2020-09-21 15:55:27 -04:00
README.md Remove TLSConfig fields 2020-09-25 18:53:20 -04:00
server.go Move server code to its own file 2020-09-25 19:06:56 -04:00
tofu.go Remove TLSConfig fields 2020-09-25 18:53:20 -04:00

README.md

go-gemini

GoDoc

go-gemini implements the Gemini protocol in Go.

It aims to provide an API similar to that of net/http to make it easy to develop Gemini clients and servers.

Examples

See examples/client and examples/server for an example client and server.

To run the examples:

go run -tags=example ./examples/server

Overview

A quick overview of the Gemini protocol:

  1. Client opens connection
  2. Server accepts connection
  3. Client and server complete a TLS handshake
  4. Client validates server certificate
  5. Client sends request
  6. Server sends response header
  7. Server sends response body (only for successful responses)
  8. Server closes connection
  9. Client handles response

The way this is implemented in this package is like so:

  1. Client makes a request with NewRequest. The client then sends the request with Do(*Request) (*Response, error).
  2. Server recieves the request and constructs a response. The server calls the Serve(*ResponseWriter, *Request) method on the Handler field. The handler writes the response. The server then closes the connection.
  3. Client recieves the response as a *Response. The client then handles the response. The client can now verify the certificate of the server using a Trust-On-First-Use method.