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

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

// OpenEthereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// OpenEthereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

//! Request Provenance

use ethereum_types::H256;
use std::fmt;

/// RPC request origin
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(rename_all = "kebab-case")]
pub enum Origin {
    /// RPC server (includes request origin)
    Rpc(String),
    /// IPC server (includes session hash)
    Ipc(H256),
    /// WS server
    Ws {
        /// Session id
        session: H256,
    },
    /// Signer (authorized WS server)
    Signer {
        /// Session id
        session: H256,
    },
    /// Unknown
    Unknown,
}

impl Default for Origin {
    fn default() -> Self {
        Origin::Unknown
    }
}

impl fmt::Display for Origin {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            Origin::Rpc(ref origin) => write!(f, "{} via RPC", origin),
            Origin::Ipc(ref session) => write!(f, "IPC (session: {})", session),
            Origin::Ws { ref session } => write!(f, "WebSocket (session: {})", session),
            Origin::Signer { ref session } => write!(f, "Secure Session (session: {})", session),
            Origin::Unknown => write!(f, "unknown origin"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::Origin;
    use ethereum_types::H256;
    use serde_json;

    #[test]
    fn should_serialize_origin() {
        // given
        let o1 = Origin::Rpc("test service".into());
        let o3 = Origin::Ipc(H256::from_low_u64_be(5));
        let o4 = Origin::Signer {
            session: H256::from_low_u64_be(10),
        };
        let o5 = Origin::Unknown;
        let o6 = Origin::Ws {
            session: H256::from_low_u64_be(5),
        };

        // when
        let res1 = serde_json::to_string(&o1).unwrap();
        let res3 = serde_json::to_string(&o3).unwrap();
        let res4 = serde_json::to_string(&o4).unwrap();
        let res5 = serde_json::to_string(&o5).unwrap();
        let res6 = serde_json::to_string(&o6).unwrap();

        // then
        assert_eq!(res1, r#"{"rpc":"test service"}"#);
        assert_eq!(
            res3,
            r#"{"ipc":"0x0000000000000000000000000000000000000000000000000000000000000005"}"#
        );
        assert_eq!(
            res4,
            r#"{"signer":{"session":"0x000000000000000000000000000000000000000000000000000000000000000a"}}"#
        );
        assert_eq!(res5, r#""unknown""#);
        assert_eq!(
            res6,
            r#"{"ws":{"session":"0x0000000000000000000000000000000000000000000000000000000000000005"}}"#
        );
    }
}