ggemini 0.20.0

Glib/Gio-oriented network API for Gemini protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

pub mod error;
pub mod request;
pub mod response;

pub use error::Error;
pub use request::{Mode, Request};
pub use response::Response;

use gio::{
    Cancellable, IOStream, NetworkAddress, SocketConnection, TlsCertificate, TlsClientConnection,
    prelude::{IOStreamExt, OutputStreamExtManual, TlsCertificateExt, TlsConnectionExt},
};
use glib::{
    Bytes, Priority,
    object::{Cast, ObjectExt},
};

#[derive(Debug, Clone)]
pub struct Connection {
    pub network_address: NetworkAddress,
    pub socket_connection: SocketConnection,
    pub tls_client_connection: TlsClientConnection,
}

impl Connection {
    // Constructors

    /// Create new `Self`
    pub fn build(
        socket_connection: SocketConnection,
        network_address: NetworkAddress,
        client_certificate: Option<TlsCertificate>,
        server_certificates: Option<Vec<TlsCertificate>>,
        is_session_resumption: bool,
    ) -> Result<Self, Error> {
        Ok(Self {
            tls_client_connection: match new_tls_client_connection(
                &socket_connection,
                Some(&network_address),
                server_certificates,
                is_session_resumption,
            ) {
                Ok(tls_client_connection) => {
                    if let Some(ref c) = client_certificate {
                        tls_client_connection.set_certificate(c);
                    }
                    tls_client_connection
                }
                Err(e) => return Err(e),
            },
            network_address,
            socket_connection,
        })
    }

    // Actions

    /// Send new `Request` to `Self` connection using
    /// [Gemini](https://geminiprotocol.net/docs/protocol-specification.gmi) or
    /// [Titan](gemini://transjovian.org/titan/page/The%20Titan%20Specification) protocol
    pub fn request_async(
        self,
        request: Request,
        priority: Priority,
        cancellable: Cancellable,
        callback: impl FnOnce(Result<(Response, Self), Error>) + 'static,
    ) {
        let output_stream = self.stream().output_stream();
        // Make sure **all header bytes** sent to the destination
        // > A partial write is performed with the size of a message block, which is 16kB
        // > https://docs.openssl.org/3.0/man3/SSL_write/#notes
        output_stream.clone().write_all_async(
            Bytes::from_owned(request.header()),
            priority,
            Some(&cancellable.clone()),
            move |result| match result {
                Ok(_) => match request {
                    Request::Gemini { mode, .. } => match mode {
                        Mode::HeaderOnly => Response::header_from_connection_async(
                            self,
                            priority,
                            cancellable,
                            |result, connection| {
                                callback(match result {
                                    Ok(response) => Ok((response, connection)),
                                    Err(e) => Err(Error::Response(e)),
                                })
                            },
                        ),
                    },
                    // Make sure **all data bytes** sent to the destination
                    // > A partial write is performed with the size of a message block, which is 16kB
                    // > https://docs.openssl.org/3.0/man3/SSL_write/#notes
                    Request::Titan { data, mode, .. } => output_stream.write_all_async(
                        data,
                        priority,
                        Some(&cancellable.clone()),
                        move |result| match result {
                            Ok(_) => match mode {
                                Mode::HeaderOnly => Response::header_from_connection_async(
                                    self,
                                    priority,
                                    cancellable,
                                    |result, connection| {
                                        callback(match result {
                                            Ok(response) => Ok((response, connection)),
                                            Err(e) => Err(Error::Response(e)),
                                        })
                                    },
                                ),
                            },
                            Err((b, e)) => callback(Err(Error::Request(b, e))),
                        },
                    ),
                },
                Err((b, e)) => callback(Err(Error::Request(b, e))),
            },
        )
    }

    // Getters

    /// Get [IOStream](https://docs.gtk.org/gio/class.IOStream.html)
    /// * compatible with user (certificate) and guest (certificate-less) connection type
    /// * useful to keep `Connection` reference active in async I/O context
    pub fn stream(&self) -> IOStream {
        self.tls_client_connection.clone().upcast::<IOStream>()
        // * also `base_io_stream` method available @TODO
    }
}

// Tools

/// Setup new [TlsClientConnection](https://docs.gtk.org/gio/iface.TlsClientConnection.html)
/// wrapper for [SocketConnection](https://docs.gtk.org/gio/class.SocketConnection.html)
/// using `server_identity` as the [SNI](https://geminiprotocol.net/docs/protocol-specification.gmi#server-name-indication)
fn new_tls_client_connection(
    socket_connection: &SocketConnection,
    server_identity: Option<&NetworkAddress>,
    server_certificates: Option<Vec<TlsCertificate>>,
    is_session_resumption: bool,
) -> Result<TlsClientConnection, Error> {
    match TlsClientConnection::new(socket_connection, server_identity) {
        Ok(tls_client_connection) => {
            // Prevent session resumption (certificate change ability in runtime)
            tls_client_connection.set_property("session-resumption-enabled", is_session_resumption);

            // Return `Err` on server connection mismatch following specification lines:
            // > Gemini servers MUST use the TLS close_notify implementation to close the connection
            // > A client SHOULD notify the user of such a case
            // https://geminiprotocol.net/docs/protocol-specification.gmi#closing-connections
            tls_client_connection.set_require_close_notify(true);

            // [TOFU](https://geminiprotocol.net/docs/protocol-specification.gmi#tls-server-certificate-validation)
            tls_client_connection.connect_accept_certificate(move |_, c, _| {
                server_certificates
                    .as_ref()
                    .is_none_or(|server_certificates| {
                        for server_certificate in server_certificates {
                            if server_certificate.is_same(c) {
                                return true;
                            }
                        }
                        false
                    })
            });

            Ok(tls_client_connection)
        }
        Err(e) => Err(Error::TlsClientConnection(e)),
    }
}