2021-04-27 01:04:05 -07:00
|
|
|
use {
|
2021-04-29 00:42:21 -07:00
|
|
|
solana_sdk::pubkey::{ParsePubkeyError, Pubkey},
|
2021-04-27 01:04:05 -07:00
|
|
|
std::{
|
|
|
|
convert::{Infallible, TryFrom, TryInto},
|
|
|
|
str::FromStr,
|
|
|
|
},
|
|
|
|
thiserror::Error,
|
|
|
|
uriparse::{URIReference, URIReferenceBuilder, URIReferenceError},
|
|
|
|
};
|
|
|
|
|
|
|
|
#[derive(Clone, Copy, Debug, PartialEq)]
|
|
|
|
pub enum Manufacturer {
|
|
|
|
Unknown,
|
|
|
|
Ledger,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Default for Manufacturer {
|
|
|
|
fn default() -> Self {
|
|
|
|
Self::Unknown
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
const MANUFACTURER_UNKNOWN: &str = "unknown";
|
|
|
|
const MANUFACTURER_LEDGER: &str = "ledger";
|
|
|
|
|
|
|
|
#[derive(Clone, Debug, Error, PartialEq)]
|
|
|
|
#[error("not a manufacturer")]
|
|
|
|
pub struct ManufacturerError;
|
|
|
|
|
|
|
|
impl From<Infallible> for ManufacturerError {
|
|
|
|
fn from(_: Infallible) -> Self {
|
|
|
|
ManufacturerError
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl FromStr for Manufacturer {
|
|
|
|
type Err = ManufacturerError;
|
|
|
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
|
|
|
let s = s.to_ascii_lowercase();
|
|
|
|
match s.as_str() {
|
|
|
|
MANUFACTURER_LEDGER => Ok(Self::Ledger),
|
|
|
|
_ => Err(ManufacturerError),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl TryFrom<&str> for Manufacturer {
|
|
|
|
type Error = ManufacturerError;
|
|
|
|
fn try_from(s: &str) -> Result<Self, Self::Error> {
|
|
|
|
Manufacturer::from_str(s)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl AsRef<str> for Manufacturer {
|
|
|
|
fn as_ref(&self) -> &str {
|
|
|
|
match self {
|
|
|
|
Self::Unknown => MANUFACTURER_UNKNOWN,
|
|
|
|
Self::Ledger => MANUFACTURER_LEDGER,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl std::fmt::Display for Manufacturer {
|
|
|
|
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
|
|
|
|
let s: &str = self.as_ref();
|
|
|
|
write!(f, "{}", s)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Clone, Debug, Error, PartialEq)]
|
|
|
|
pub enum LocatorError {
|
|
|
|
#[error(transparent)]
|
|
|
|
ManufacturerError(#[from] ManufacturerError),
|
|
|
|
#[error(transparent)]
|
|
|
|
PubkeyError(#[from] ParsePubkeyError),
|
|
|
|
#[error(transparent)]
|
|
|
|
UriReferenceError(#[from] URIReferenceError),
|
|
|
|
#[error("unimplemented scheme")]
|
|
|
|
UnimplementedScheme,
|
|
|
|
#[error("infallible")]
|
|
|
|
Infallible,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl From<Infallible> for LocatorError {
|
|
|
|
fn from(_: Infallible) -> Self {
|
|
|
|
Self::Infallible
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Debug, PartialEq)]
|
|
|
|
pub struct Locator {
|
|
|
|
pub manufacturer: Manufacturer,
|
|
|
|
pub pubkey: Option<Pubkey>,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl std::fmt::Display for Locator {
|
|
|
|
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
|
|
|
|
let maybe_path = self.pubkey.map(|p| p.to_string());
|
|
|
|
let path = maybe_path.as_deref().unwrap_or("/");
|
|
|
|
|
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("usb"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some(self.manufacturer.as_ref()))
|
|
|
|
.unwrap()
|
|
|
|
.try_path(path)
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
write!(f, "{}", uri)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Locator {
|
|
|
|
pub fn new_from_path<P: AsRef<str>>(path: P) -> Result<Self, LocatorError> {
|
|
|
|
let path = path.as_ref();
|
|
|
|
let uri = URIReference::try_from(path)?;
|
|
|
|
Self::new_from_uri(&uri)
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn new_from_uri(uri: &URIReference<'_>) -> Result<Self, LocatorError> {
|
|
|
|
let scheme = uri.scheme().map(|s| s.as_str().to_ascii_lowercase());
|
|
|
|
let host = uri.host().map(|h| h.to_string());
|
|
|
|
match (scheme, host) {
|
|
|
|
(Some(scheme), Some(host)) if scheme == "usb" => {
|
|
|
|
let path = uri.path().segments().get(0).and_then(|s| {
|
|
|
|
if !s.is_empty() {
|
|
|
|
Some(s.as_str())
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
}
|
|
|
|
});
|
2021-04-29 00:42:21 -07:00
|
|
|
Self::new_from_parts(host.as_str(), path)
|
2021-04-27 01:04:05 -07:00
|
|
|
}
|
|
|
|
(Some(_scheme), Some(_host)) => Err(LocatorError::UnimplementedScheme),
|
|
|
|
(None, Some(_host)) => Err(LocatorError::UnimplementedScheme),
|
|
|
|
(_, None) => Err(LocatorError::ManufacturerError(ManufacturerError)),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-04-29 00:42:21 -07:00
|
|
|
pub fn new_from_parts<V, VE, P, PE>(
|
2021-04-27 01:04:05 -07:00
|
|
|
manufacturer: V,
|
|
|
|
pubkey: Option<P>,
|
|
|
|
) -> Result<Self, LocatorError>
|
|
|
|
where
|
|
|
|
VE: Into<LocatorError>,
|
|
|
|
V: TryInto<Manufacturer, Error = VE>,
|
|
|
|
PE: Into<LocatorError>,
|
|
|
|
P: TryInto<Pubkey, Error = PE>,
|
|
|
|
{
|
|
|
|
let manufacturer = manufacturer.try_into().map_err(|e| e.into())?;
|
|
|
|
let pubkey = if let Some(pubkey) = pubkey {
|
|
|
|
Some(pubkey.try_into().map_err(|e| e.into())?)
|
|
|
|
} else {
|
|
|
|
None
|
|
|
|
};
|
|
|
|
Ok(Self {
|
|
|
|
manufacturer,
|
|
|
|
pubkey,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use super::*;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_manufacturer() {
|
|
|
|
assert_eq!(MANUFACTURER_LEDGER.try_into(), Ok(Manufacturer::Ledger));
|
|
|
|
assert!(
|
|
|
|
matches!(Manufacturer::from_str(MANUFACTURER_LEDGER), Ok(v) if v == Manufacturer::Ledger)
|
|
|
|
);
|
|
|
|
assert_eq!(Manufacturer::Ledger.as_ref(), MANUFACTURER_LEDGER);
|
|
|
|
|
|
|
|
assert!(
|
|
|
|
matches!(Manufacturer::from_str("bad-manufacturer"), Err(e) if e == ManufacturerError)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_locator_new_from_parts() {
|
|
|
|
let manufacturer = Manufacturer::Ledger;
|
|
|
|
let manufacturer_str = "ledger";
|
|
|
|
let pubkey = Pubkey::new_unique();
|
|
|
|
let pubkey_str = pubkey.to_string();
|
|
|
|
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: None,
|
|
|
|
};
|
|
|
|
assert!(matches!(
|
2021-04-29 00:42:21 -07:00
|
|
|
Locator::new_from_parts(manufacturer, None::<Pubkey>),
|
2021-04-27 01:04:05 -07:00
|
|
|
Ok(e) if e == expect,
|
|
|
|
));
|
|
|
|
assert!(matches!(
|
2021-04-29 00:42:21 -07:00
|
|
|
Locator::new_from_parts(manufacturer_str, None::<Pubkey>),
|
2021-04-27 01:04:05 -07:00
|
|
|
Ok(e) if e == expect,
|
|
|
|
));
|
|
|
|
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: Some(pubkey),
|
|
|
|
};
|
|
|
|
assert!(matches!(
|
2021-04-29 00:42:21 -07:00
|
|
|
Locator::new_from_parts(manufacturer, Some(pubkey)),
|
2021-04-27 01:04:05 -07:00
|
|
|
Ok(e) if e == expect,
|
|
|
|
));
|
|
|
|
assert!(matches!(
|
2021-04-29 00:42:21 -07:00
|
|
|
Locator::new_from_parts(manufacturer_str, Some(pubkey_str.as_str())),
|
2021-04-27 01:04:05 -07:00
|
|
|
Ok(e) if e == expect,
|
|
|
|
));
|
|
|
|
|
|
|
|
assert!(matches!(
|
2021-04-29 00:42:21 -07:00
|
|
|
Locator::new_from_parts("bad-manufacturer", None::<Pubkey>),
|
2021-04-27 01:04:05 -07:00
|
|
|
Err(LocatorError::ManufacturerError(e)) if e == ManufacturerError,
|
|
|
|
));
|
|
|
|
assert!(matches!(
|
2021-04-29 00:42:21 -07:00
|
|
|
Locator::new_from_parts(manufacturer, Some("bad-pubkey")),
|
2021-04-27 01:04:05 -07:00
|
|
|
Err(LocatorError::PubkeyError(e)) if e == ParsePubkeyError::Invalid,
|
|
|
|
));
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_locator_new_from_uri() {
|
|
|
|
let manufacturer = Manufacturer::Ledger;
|
|
|
|
let pubkey = Pubkey::new_unique();
|
|
|
|
let pubkey_str = pubkey.to_string();
|
|
|
|
|
2021-04-29 00:42:21 -07:00
|
|
|
// usb://ledger/{PUBKEY}?key=0/0
|
2021-04-27 01:04:05 -07:00
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("usb"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some(Manufacturer::Ledger.as_ref()))
|
|
|
|
.unwrap()
|
|
|
|
.try_path(pubkey_str.as_str())
|
|
|
|
.unwrap()
|
|
|
|
.try_query(Some("key=0/0"))
|
|
|
|
.unwrap();
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: Some(pubkey),
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_uri(&uri), Ok(expect));
|
|
|
|
|
|
|
|
// usb://ledger/{PUBKEY}
|
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("usb"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some(Manufacturer::Ledger.as_ref()))
|
|
|
|
.unwrap()
|
|
|
|
.try_path(pubkey_str.as_str())
|
|
|
|
.unwrap();
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: Some(pubkey),
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_uri(&uri), Ok(expect));
|
|
|
|
|
|
|
|
// usb://ledger
|
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("usb"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some(Manufacturer::Ledger.as_ref()))
|
|
|
|
.unwrap()
|
|
|
|
.try_path("")
|
|
|
|
.unwrap();
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: None,
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_uri(&uri), Ok(expect));
|
|
|
|
|
|
|
|
// usb://ledger/
|
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("usb"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some(Manufacturer::Ledger.as_ref()))
|
|
|
|
.unwrap()
|
|
|
|
.try_path("/")
|
|
|
|
.unwrap();
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: None,
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_uri(&uri), Ok(expect));
|
|
|
|
|
|
|
|
// bad-scheme://ledger
|
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("bad-scheme"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some(Manufacturer::Ledger.as_ref()))
|
|
|
|
.unwrap()
|
|
|
|
.try_path("")
|
|
|
|
.unwrap();
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
assert_eq!(
|
|
|
|
Locator::new_from_uri(&uri),
|
|
|
|
Err(LocatorError::UnimplementedScheme)
|
|
|
|
);
|
|
|
|
|
|
|
|
// usb://bad-manufacturer
|
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("usb"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some("bad-manufacturer"))
|
|
|
|
.unwrap()
|
|
|
|
.try_path("")
|
|
|
|
.unwrap();
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
assert_eq!(
|
|
|
|
Locator::new_from_uri(&uri),
|
|
|
|
Err(LocatorError::ManufacturerError(ManufacturerError))
|
|
|
|
);
|
|
|
|
|
|
|
|
// usb://ledger/bad-pubkey
|
|
|
|
let mut builder = URIReferenceBuilder::new();
|
|
|
|
builder
|
|
|
|
.try_scheme(Some("usb"))
|
|
|
|
.unwrap()
|
|
|
|
.try_authority(Some(Manufacturer::Ledger.as_ref()))
|
|
|
|
.unwrap()
|
|
|
|
.try_path("bad-pubkey")
|
|
|
|
.unwrap();
|
|
|
|
let uri = builder.build().unwrap();
|
|
|
|
assert_eq!(
|
|
|
|
Locator::new_from_uri(&uri),
|
|
|
|
Err(LocatorError::PubkeyError(ParsePubkeyError::Invalid))
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_locator_new_from_path() {
|
|
|
|
let manufacturer = Manufacturer::Ledger;
|
|
|
|
let pubkey = Pubkey::new_unique();
|
|
|
|
let path = format!("usb://ledger/{}?key=0/0", pubkey);
|
|
|
|
Locator::new_from_path(path).unwrap();
|
|
|
|
|
|
|
|
// usb://ledger/{PUBKEY}?key=0'/0'
|
|
|
|
let path = format!("usb://ledger/{}?key=0'/0'", pubkey);
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: Some(pubkey),
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_path(path), Ok(expect));
|
|
|
|
|
|
|
|
// usb://ledger/{PUBKEY}
|
|
|
|
let path = format!("usb://ledger/{}", pubkey);
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: Some(pubkey),
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_path(path), Ok(expect));
|
|
|
|
|
|
|
|
// usb://ledger
|
|
|
|
let path = "usb://ledger";
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: None,
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_path(path), Ok(expect));
|
|
|
|
|
|
|
|
// usb://ledger/
|
|
|
|
let path = "usb://ledger/";
|
|
|
|
let expect = Locator {
|
|
|
|
manufacturer,
|
|
|
|
pubkey: None,
|
|
|
|
};
|
|
|
|
assert_eq!(Locator::new_from_path(path), Ok(expect));
|
|
|
|
|
|
|
|
// bad-scheme://ledger
|
|
|
|
let path = "bad-scheme://ledger";
|
|
|
|
assert_eq!(
|
|
|
|
Locator::new_from_path(path),
|
|
|
|
Err(LocatorError::UnimplementedScheme)
|
|
|
|
);
|
|
|
|
|
|
|
|
// usb://bad-manufacturer
|
|
|
|
let path = "usb://bad-manufacturer";
|
|
|
|
assert_eq!(
|
|
|
|
Locator::new_from_path(path),
|
|
|
|
Err(LocatorError::ManufacturerError(ManufacturerError))
|
|
|
|
);
|
|
|
|
|
|
|
|
// usb://ledger/bad-pubkey
|
|
|
|
let path = "usb://ledger/bad-pubkey";
|
|
|
|
assert_eq!(
|
|
|
|
Locator::new_from_path(path),
|
|
|
|
Err(LocatorError::PubkeyError(ParsePubkeyError::Invalid))
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|