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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
//! A session with a validator node

use crate::{
    chain::{self, state::StateErrorKind},
    error::{Error, ErrorKind::*},
    prost::Message,
    rpc::{Request, Response, TendermintRequest},
    unix_connection::UnixConnection,
};
use signatory::{ed25519, PublicKeyed};
use signatory_dalek::Ed25519Signer;
use std::{
    fmt::Debug,
    io::{Read, Write},
    marker::{Send, Sync},
    net::TcpStream,
    os::unix::net::UnixStream,
    path::Path,
    sync::{
        atomic::{AtomicBool, Ordering},
        Arc,
    },
    time::Instant,
};
use subtle::ConstantTimeEq;
use tendermint::{
    amino_types::{PingRequest, PingResponse, PubKeyRequest, PubKeyResponse, RemoteError},
    node,
    secret_connection::{self, SecretConnection},
};

/// Encrypted session with a validator node
pub struct Session<Connection> {
    /// Remote peer location
    peer_addr: String,

    /// Chain ID for this session
    chain_id: chain::Id,

    /// Do not sign blocks greater than this height
    max_height: Option<tendermint::block::Height>,

    /// TCP connection to a validator node
    connection: Connection,
}

impl Session<SecretConnection<TcpStream>> {
    /// Create a new validator connection at the given TCP/IP address/port
    pub fn connect_tcp(
        chain_id: chain::Id,
        max_height: Option<tendermint::block::Height>,
        validator_peer_id: Option<node::Id>,
        host: &str,
        port: u16,
        secret_connection_key: &ed25519::Seed,
    ) -> Result<Self, Error> {
        let peer_addr = format!("{}:{}", host, port);
        debug!("{}: Connecting to {}...", chain_id, &peer_addr);

        let socket = TcpStream::connect(format!("{}:{}", host, port))?;
        let signer = Ed25519Signer::from(secret_connection_key);
        let public_key = secret_connection::PublicKey::from(
            signer.public_key().map_err(|_| Error::from(InvalidKey))?,
        );
        let connection = SecretConnection::new(socket, &public_key, &signer)?;
        let actual_peer_id = connection.remote_pubkey().peer_id();

        // TODO(tarcieri): move this logic into `SecretConnection::new`?
        if let Some(expected_peer_id) = validator_peer_id {
            if expected_peer_id.ct_eq(&actual_peer_id).unwrap_u8() == 0 {
                fail!(
                    VerificationError,
                    "{}:{}: validator peer ID mismatch! (expected {}, got {})",
                    host,
                    port,
                    expected_peer_id,
                    actual_peer_id
                );
            }
        } else {
            // TODO(tarcieri): make peer verification mandatory
            warn!(
                "[{}] {}:{}: unverified validator peer ID! ({})",
                chain_id, host, port, actual_peer_id
            );
        }

        Ok(Self {
            peer_addr,
            chain_id,
            max_height,
            connection,
        })
    }
}

impl Session<UnixConnection<UnixStream>> {
    /// Create a new Unix domain socket connection to a validator
    pub fn connect_unix(
        chain_id: chain::Id,
        max_height: Option<tendermint::block::Height>,
        socket_path: &Path,
    ) -> Result<Self, Error> {
        let peer_addr = socket_path.to_str().unwrap().to_owned();

        debug!("{}: Connecting to socket at {}...", chain_id, &peer_addr);

        let socket = UnixStream::connect(socket_path)?;
        let connection = UnixConnection::new(socket);

        Ok(Self {
            peer_addr,
            chain_id,
            max_height,
            connection,
        })
    }
}

impl<Connection> Session<Connection>
where
    Connection: Read + Write + Sync + Send,
{
    /// Main request loop
    pub fn request_loop(&mut self, should_term: &Arc<AtomicBool>) -> Result<(), Error> {
        debug!("starting handle request loop ... ");
        while self.handle_request(should_term)? {}
        Ok(())
    }

    /// Handle an incoming request from the validator
    fn handle_request(&mut self, should_term: &Arc<AtomicBool>) -> Result<bool, Error> {
        if should_term.load(Ordering::Relaxed) {
            info!("terminate signal received");
            return Ok(false);
        }

        let request = Request::read(&mut self.connection)?;
        debug!(
            "[{}:{}] received request: {:?}",
            &self.chain_id, &self.peer_addr, &request
        );

        let response = match request {
            Request::SignProposal(req) => self.sign(req)?,
            Request::SignVote(req) => self.sign(req)?,
            // non-signable requests:
            Request::ReplyPing(ref req) => self.reply_ping(req),
            Request::ShowPublicKey(ref req) => self.get_public_key(req)?,
        };

        debug!(
            "[{}:{}] sending response: {:?}",
            &self.chain_id, &self.peer_addr, &response
        );

        let mut buf = vec![];

        match response {
            Response::SignedProposal(sp) => sp.encode(&mut buf)?,
            Response::SignedVote(sv) => sv.encode(&mut buf)?,
            Response::Ping(ping) => ping.encode(&mut buf)?,
            Response::PublicKey(pk) => pk.encode(&mut buf)?,
        }

        self.connection.write_all(&buf)?;

        Ok(true)
    }

    /// Perform a digital signature operation
    fn sign<T: TendermintRequest + Debug>(&mut self, mut request: T) -> Result<Response, Error> {
        request.validate()?;

        let registry = chain::REGISTRY.get();
        let chain = registry.get_chain(&self.chain_id).unwrap();

        if let Some(request_state) = request.consensus_state() {
            // TODO(tarcieri): better handle `PoisonError`?
            let mut chain_state = chain.state.lock().unwrap();

            if let Err(e) = chain_state.update_consensus_state(request_state.clone()) {
                // Report double signing error back to the validator
                if e.kind() == StateErrorKind::DoubleSign {
                    let height = request.height().unwrap();

                    warn!(
                        "[{}:{}] attempt to double sign at height: {}",
                        &self.chain_id, &self.peer_addr, height
                    );

                    let remote_err = RemoteError::double_sign(height);
                    return Ok(request.build_response(Some(remote_err)));
                } else {
                    return Err(e.into());
                }
            }
        }

        if let Some(max_height) = self.max_height {
            if let Some(height) = request.height() {
                if height > max_height.value() as i64 {
                    fail!(
                        ExceedMaxHeight,
                        "attempted to sign at height {} which is greater than {}",
                        height,
                        max_height,
                    );
                }
            }
        }

        let mut to_sign = vec![];
        request.sign_bytes(self.chain_id, &mut to_sign)?;

        // TODO(ismail): figure out which key to use here instead of taking the only key
        let started_at = Instant::now();
        let signature = chain.keyring.sign_ed25519(None, &to_sign)?;

        self.log_signing_request(&request, started_at);
        request.set_signature(&signature);

        Ok(request.build_response(None))
    }

    /// Reply to a ping request
    fn reply_ping(&mut self, _request: &PingRequest) -> Response {
        debug!("replying with PingResponse");
        Response::Ping(PingResponse {})
    }

    /// Get the public key for (the only) public key in the keyring
    fn get_public_key(&mut self, _request: &PubKeyRequest) -> Result<Response, Error> {
        let registry = chain::REGISTRY.get();
        let chain = registry.get_chain(&self.chain_id).unwrap();

        Ok(Response::PublicKey(PubKeyResponse::from(
            *chain.keyring.default_pubkey()?,
        )))
    }

    /// Write an INFO logline about a signing request
    fn log_signing_request<T: TendermintRequest + Debug>(&self, request: &T, started_at: Instant) {
        let height = request
            .height()
            .map(|h| h.to_string())
            .unwrap_or_else(|| "none".to_owned());

        let msg_type = request
            .msg_type()
            .map(|t| format!("{:?}", t))
            .unwrap_or_else(|| "Unknown".to_owned());

        info!(
            "[{}@{}] signed {:?} at height: {} ({} ms)",
            &self.chain_id,
            &self.peer_addr,
            msg_type,
            height,
            started_at.elapsed().as_millis()
        );
    }
}