Skip to content

ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarcieri merged 1 commit into from
Jun 20, 2023
Merged

ssh-encoding: remove Encoding::Error; add LabelError#124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 11 additions & 42 deletions ssh-encoding/src/encode.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
/// Type returned in the event of an encoding error.
type Error: From<Error>;

/// Get the length of this type encoded in bytes, prior to Base64 encoding.
fn encoded_len(&self) -> Result<usize, Self::Error>;
fn encoded_len(&self) -> Result<usize, Error>;

/// Encode this value using the provided [`Writer`].
fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

/// Return the length of this type after encoding when prepended with a
/// `uint32` length prefix.
fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
fn encoded_len_prefixed(&self) -> Result<usize, Error> {
[4, self.encoded_len()?].checked_sum()
}

/// Encode this value, first prepending a `uint32` length prefix
/// set to [`Encode::encoded_len`].
fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
self.encoded_len()?.encode(writer)?;
self.encode(writer)
}
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
/// Encode this type using the [`Encode`] trait, writing the resulting PEM
/// document into the provided `out` buffer.
fn encode_pem<'o>(
&self,
line_ending: LineEnding,
out: &'o mut [u8],
) -> Result<&'o str, Self::Error>;
fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

/// Encode this type using the [`Encode`] trait, writing the resulting PEM
/// document to a returned [`String`].
#[cfg(feature = "alloc")]
fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
fn encode_pem<'o>(
&self,
line_ending: LineEnding,
out: &'o mut [u8],
) -> Result<&'o str, Self::Error> {
fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
let mut writer =
pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
.map_err(Error::from)?;

self.encode(&mut writer)?;
let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
str::from_utf8(&out[..encoded_len]).map_err(Error::from)
}

#[cfg(feature = "alloc")]
fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
let encoded_len = pem::encapsulated_len_wrapped(
Self::PEM_LABEL,
PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
let mut buf = vec![0u8; encoded_len];
let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
String::from_utf8(buf).map_err(Error::from)
}
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
Ok(1)
}
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
Ok(4)
}
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
Ok(8)
}
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
Ok(4)
}
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
[4, self.len()].checked_sum()
}
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
self.as_slice().encoded_len()
}
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
self.as_bytes().encoded_len()
}
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
self.as_slice().encoded_len()
}
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
self.as_str().encoded_len()
}
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
type Error = Error;

fn encoded_len(&self) -> Result<usize, Error> {
self.iter().try_fold(4usize, |acc, string| {
acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down
13 changes: 12 additions & 1 deletion ssh-encoding/src/error.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
/// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
/// Character encoding-related errors.
CharacterEncoding,

/// Invalid label.
Label(LabelError),

/// Invalid length.
Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
#[cfg(feature = "base64")]
Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
Error::CharacterEncoding => write!(f, "character encoding invalid"),
Error::Label(err) => write!(f, "{}", err),
Error::Length => write!(f, "length invalid"),
Error::Overflow => write!(f, "internal overflow error"),
#[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
}
}

impl From<LabelError> for Error {
fn from(err: LabelError) -> Error {
Error::Label(err)
}
}

impl From<core::num::TryFromIntError> for Error {
fn from(_: core::num::TryFromIntError) -> Error {
Error::Overflow
Expand Down
74 changes: 60 additions & 14 deletions ssh-encoding/src/label.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
/// Type returned in the event of an encoding error.
type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
type Error = T::Error;
type Error = Error;

fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
let mut buf = [0u8; MAX_LABEL_SIZE];
reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
}
}

impl<T: Label> Encode for T {
type Error = T::Error;
fn encoded_len(&self) -> Result<usize, Error> {
self.as_ref().encoded_len()
}

fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
self.as_ref().encode(writer)
}
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
/// The label that was considered invalid.
#[cfg(feature = "alloc")]
label: String,
}

fn encoded_len(&self) -> Result<usize, T::Error> {
Ok(self.as_ref().encoded_len()?)
impl LabelError {
/// Create a new [`LabelError`] for the given invalid label.
#[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
pub fn new(label: &str) -> Self {
Self {
#[cfg(feature = "alloc")]
label: label.into(),
}
}

fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
Ok(self.as_ref().encode(writer)?)
/// The invalid label string (if available).
#[inline]
pub fn label(&self) -> &str {
#[cfg(not(feature = "alloc"))]
{
""
}
#[cfg(feature = "alloc")]
{
&self.label
}
}
}

impl fmt::Display for LabelError {
#[cfg(not(feature = "alloc"))]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("invalid label")
}

#[cfg(feature = "alloc")]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "invalid label: '{}'", self.label)
}
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}
2 changes: 1 addition & 1 deletion ssh-encoding/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
decode::Decode,
encode::Encode,
error::{Error, Result},
label::Label,
label::{Label, LabelError},
reader::{NestedReader, Reader},
writer::Writer,
};
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ssh-encoding: remove `Encoding::Error`; add `LabelError` by tarcieri · Pull Request #124 · RustCrypto/SSH · GitHub
Skip to content
ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Jun 20, 2023
 Merged


ssh-encoding: remove Encoding::Error; add LabelError#124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


53 changes: 11 additions & 42 deletions
ssh-encoding/src/encode.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
 /// Type returned in the event of an encoding error.
 type Error: From<Error>;

 /// Get the length of this type encoded in bytes, prior to Base64 encoding.
 fn encoded_len(&self) -> Result<usize, Self::Error>;
 fn encoded_len(&self) -> Result<usize, Error>;

 /// Encode this value using the provided [`Writer`].
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

 /// Return the length of this type after encoding when prepended with a
 /// `uint32` length prefix.
 fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
 fn encoded_len_prefixed(&self) -> Result<usize, Error> {
 [4, self.encoded_len()?].checked_sum()
 }

 /// Encode this value, first prepending a `uint32` length prefix
 /// set to [`Encode::encoded_len`].
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.encoded_len()?.encode(writer)?;
 self.encode(writer)
 }
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document into the provided `out` buffer.
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error>;
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document to a returned [`String`].
 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error> {
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
 let mut writer =
 pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
 .map_err(Error::from)?;

 self.encode(&mut writer)?;
 let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
 str::from_utf8(&out[..encoded_len]).map_err(Error::from)
 }

 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
 let encoded_len = pem::encapsulated_len_wrapped(
 Self::PEM_LABEL,
 PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
 let mut buf = vec![0u8; encoded_len];
 let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
 buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
 String::from_utf8(buf).map_err(Error::from)
 }
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(1)
 }
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(8)
 }
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 [4, self.len()].checked_sum()
 }
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_bytes().encoded_len()
 }
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_str().encoded_len()
 }
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.iter().try_fold(4usize, |acc, string| {
 acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down

13 changes: 12 additions & 1 deletion
ssh-encoding/src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
 /// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
 /// Character encoding-related errors.
 CharacterEncoding,

 /// Invalid label.
 Label(LabelError),

 /// Invalid length.
 Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
 #[cfg(feature = "base64")]
 Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
 Error::CharacterEncoding => write!(f, "character encoding invalid"),
 Error::Label(err) => write!(f, "{}", err),
 Error::Length => write!(f, "length invalid"),
 Error::Overflow => write!(f, "internal overflow error"),
 #[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
 }
}

impl From<LabelError> for Error {
 fn from(err: LabelError) -> Error {
 Error::Label(err)
 }
}

impl From<core::num::TryFromIntError> for Error {
 fn from(_: core::num::TryFromIntError) -> Error {
 Error::Overflow
Expand Down

74 changes: 60 additions & 14 deletions
ssh-encoding/src/label.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
 /// Type returned in the event of an encoding error.
 type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
 type Error = T::Error;
 type Error = Error;

 fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
 fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
 let mut buf = [0u8; MAX_LABEL_SIZE];
 reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
 }
}

impl<T: Label> Encode for T {
 type Error = T::Error;
 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_ref().encoded_len()
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.as_ref().encode(writer)
 }
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
 /// The label that was considered invalid.
 #[cfg(feature = "alloc")]
 label: String,
}

 fn encoded_len(&self) -> Result<usize, T::Error> {
 Ok(self.as_ref().encoded_len()?)
impl LabelError {
 /// Create a new [`LabelError`] for the given invalid label.
 #[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
 pub fn new(label: &str) -> Self {
 Self {
 #[cfg(feature = "alloc")]
 label: label.into(),
 }
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
 Ok(self.as_ref().encode(writer)?)
 /// The invalid label string (if available).
 #[inline]
 pub fn label(&self) -> &str {
 #[cfg(not(feature = "alloc"))]
 {
 ""
 }
 #[cfg(feature = "alloc")]
 {
 &self.label
 }
 }
}

impl fmt::Display for LabelError {
 #[cfg(not(feature = "alloc"))]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 f.write_str("invalid label")
 }

 #[cfg(feature = "alloc")]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 write!(f, "invalid label: '{}'", self.label)
 }
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}

2 changes: 1 addition & 1 deletion
ssh-encoding/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
 decode::Decode,
 encode::Encode,
 error::{Error, Result},
 label::Label,
 label::{Label, LabelError},
 reader::{NestedReader, Reader},
 writer::Writer,
};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-encoding: remove `Encoding::Error`; add `LabelError` by tarcieri · Pull Request #124 · RustCrypto/SSH · GitHub
Skip to content
ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Jun 20, 2023
 Merged


ssh-encoding: remove Encoding::Error; add LabelError#124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


53 changes: 11 additions & 42 deletions
ssh-encoding/src/encode.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
 /// Type returned in the event of an encoding error.
 type Error: From<Error>;

 /// Get the length of this type encoded in bytes, prior to Base64 encoding.
 fn encoded_len(&self) -> Result<usize, Self::Error>;
 fn encoded_len(&self) -> Result<usize, Error>;

 /// Encode this value using the provided [`Writer`].
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

 /// Return the length of this type after encoding when prepended with a
 /// `uint32` length prefix.
 fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
 fn encoded_len_prefixed(&self) -> Result<usize, Error> {
 [4, self.encoded_len()?].checked_sum()
 }

 /// Encode this value, first prepending a `uint32` length prefix
 /// set to [`Encode::encoded_len`].
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.encoded_len()?.encode(writer)?;
 self.encode(writer)
 }
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document into the provided `out` buffer.
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error>;
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document to a returned [`String`].
 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error> {
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
 let mut writer =
 pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
 .map_err(Error::from)?;

 self.encode(&mut writer)?;
 let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
 str::from_utf8(&out[..encoded_len]).map_err(Error::from)
 }

 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
 let encoded_len = pem::encapsulated_len_wrapped(
 Self::PEM_LABEL,
 PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
 let mut buf = vec![0u8; encoded_len];
 let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
 buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
 String::from_utf8(buf).map_err(Error::from)
 }
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(1)
 }
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(8)
 }
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 [4, self.len()].checked_sum()
 }
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_bytes().encoded_len()
 }
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_str().encoded_len()
 }
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.iter().try_fold(4usize, |acc, string| {
 acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down

13 changes: 12 additions & 1 deletion
ssh-encoding/src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
 /// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
 /// Character encoding-related errors.
 CharacterEncoding,

 /// Invalid label.
 Label(LabelError),

 /// Invalid length.
 Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
 #[cfg(feature = "base64")]
 Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
 Error::CharacterEncoding => write!(f, "character encoding invalid"),
 Error::Label(err) => write!(f, "{}", err),
 Error::Length => write!(f, "length invalid"),
 Error::Overflow => write!(f, "internal overflow error"),
 #[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
 }
}

impl From<LabelError> for Error {
 fn from(err: LabelError) -> Error {
 Error::Label(err)
 }
}

impl From<core::num::TryFromIntError> for Error {
 fn from(_: core::num::TryFromIntError) -> Error {
 Error::Overflow
Expand Down

74 changes: 60 additions & 14 deletions
ssh-encoding/src/label.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
 /// Type returned in the event of an encoding error.
 type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
 type Error = T::Error;
 type Error = Error;

 fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
 fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
 let mut buf = [0u8; MAX_LABEL_SIZE];
 reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
 }
}

impl<T: Label> Encode for T {
 type Error = T::Error;
 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_ref().encoded_len()
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.as_ref().encode(writer)
 }
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
 /// The label that was considered invalid.
 #[cfg(feature = "alloc")]
 label: String,
}

 fn encoded_len(&self) -> Result<usize, T::Error> {
 Ok(self.as_ref().encoded_len()?)
impl LabelError {
 /// Create a new [`LabelError`] for the given invalid label.
 #[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
 pub fn new(label: &str) -> Self {
 Self {
 #[cfg(feature = "alloc")]
 label: label.into(),
 }
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
 Ok(self.as_ref().encode(writer)?)
 /// The invalid label string (if available).
 #[inline]
 pub fn label(&self) -> &str {
 #[cfg(not(feature = "alloc"))]
 {
 ""
 }
 #[cfg(feature = "alloc")]
 {
 &self.label
 }
 }
}

impl fmt::Display for LabelError {
 #[cfg(not(feature = "alloc"))]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 f.write_str("invalid label")
 }

 #[cfg(feature = "alloc")]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 write!(f, "invalid label: '{}'", self.label)
 }
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}

2 changes: 1 addition & 1 deletion
ssh-encoding/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
 decode::Decode,
 encode::Encode,
 error::{Error, Result},
 label::Label,
 label::{Label, LabelError},
 reader::{NestedReader, Reader},
 writer::Writer,
};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-encoding: remove `Encoding::Error`; add `LabelError` by tarcieri · Pull Request #124 · RustCrypto/SSH · GitHub
Skip to content
ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Jun 20, 2023
 Merged


ssh-encoding: remove Encoding::Error; add LabelError#124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


53 changes: 11 additions & 42 deletions
ssh-encoding/src/encode.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
 /// Type returned in the event of an encoding error.
 type Error: From<Error>;

 /// Get the length of this type encoded in bytes, prior to Base64 encoding.
 fn encoded_len(&self) -> Result<usize, Self::Error>;
 fn encoded_len(&self) -> Result<usize, Error>;

 /// Encode this value using the provided [`Writer`].
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

 /// Return the length of this type after encoding when prepended with a
 /// `uint32` length prefix.
 fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
 fn encoded_len_prefixed(&self) -> Result<usize, Error> {
 [4, self.encoded_len()?].checked_sum()
 }

 /// Encode this value, first prepending a `uint32` length prefix
 /// set to [`Encode::encoded_len`].
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.encoded_len()?.encode(writer)?;
 self.encode(writer)
 }
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document into the provided `out` buffer.
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error>;
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document to a returned [`String`].
 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error> {
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
 let mut writer =
 pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
 .map_err(Error::from)?;

 self.encode(&mut writer)?;
 let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
 str::from_utf8(&out[..encoded_len]).map_err(Error::from)
 }

 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
 let encoded_len = pem::encapsulated_len_wrapped(
 Self::PEM_LABEL,
 PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
 let mut buf = vec![0u8; encoded_len];
 let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
 buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
 String::from_utf8(buf).map_err(Error::from)
 }
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(1)
 }
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(8)
 }
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 [4, self.len()].checked_sum()
 }
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_bytes().encoded_len()
 }
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_str().encoded_len()
 }
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.iter().try_fold(4usize, |acc, string| {
 acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down

13 changes: 12 additions & 1 deletion
ssh-encoding/src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
 /// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
 /// Character encoding-related errors.
 CharacterEncoding,

 /// Invalid label.
 Label(LabelError),

 /// Invalid length.
 Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
 #[cfg(feature = "base64")]
 Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
 Error::CharacterEncoding => write!(f, "character encoding invalid"),
 Error::Label(err) => write!(f, "{}", err),
 Error::Length => write!(f, "length invalid"),
 Error::Overflow => write!(f, "internal overflow error"),
 #[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
 }
}

impl From<LabelError> for Error {
 fn from(err: LabelError) -> Error {
 Error::Label(err)
 }
}

impl From<core::num::TryFromIntError> for Error {
 fn from(_: core::num::TryFromIntError) -> Error {
 Error::Overflow
Expand Down

74 changes: 60 additions & 14 deletions
ssh-encoding/src/label.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
 /// Type returned in the event of an encoding error.
 type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
 type Error = T::Error;
 type Error = Error;

 fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
 fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
 let mut buf = [0u8; MAX_LABEL_SIZE];
 reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
 }
}

impl<T: Label> Encode for T {
 type Error = T::Error;
 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_ref().encoded_len()
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.as_ref().encode(writer)
 }
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
 /// The label that was considered invalid.
 #[cfg(feature = "alloc")]
 label: String,
}

 fn encoded_len(&self) -> Result<usize, T::Error> {
 Ok(self.as_ref().encoded_len()?)
impl LabelError {
 /// Create a new [`LabelError`] for the given invalid label.
 #[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
 pub fn new(label: &str) -> Self {
 Self {
 #[cfg(feature = "alloc")]
 label: label.into(),
 }
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
 Ok(self.as_ref().encode(writer)?)
 /// The invalid label string (if available).
 #[inline]
 pub fn label(&self) -> &str {
 #[cfg(not(feature = "alloc"))]
 {
 ""
 }
 #[cfg(feature = "alloc")]
 {
 &self.label
 }
 }
}

impl fmt::Display for LabelError {
 #[cfg(not(feature = "alloc"))]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 f.write_str("invalid label")
 }

 #[cfg(feature = "alloc")]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 write!(f, "invalid label: '{}'", self.label)
 }
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}

2 changes: 1 addition & 1 deletion
ssh-encoding/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
 decode::Decode,
 encode::Encode,
 error::{Error, Result},
 label::Label,
 label::{Label, LabelError},
 reader::{NestedReader, Reader},
 writer::Writer,
};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
ssh-encoding: remove `Encoding::Error`; add `LabelError` by tarcieri · Pull Request #124 · RustCrypto/SSH · GitHub
Skip to content
ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Jun 20, 2023
 Merged


ssh-encoding: remove Encoding::Error; add LabelError#124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


53 changes: 11 additions & 42 deletions
ssh-encoding/src/encode.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
 /// Type returned in the event of an encoding error.
 type Error: From<Error>;

 /// Get the length of this type encoded in bytes, prior to Base64 encoding.
 fn encoded_len(&self) -> Result<usize, Self::Error>;
 fn encoded_len(&self) -> Result<usize, Error>;

 /// Encode this value using the provided [`Writer`].
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

 /// Return the length of this type after encoding when prepended with a
 /// `uint32` length prefix.
 fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
 fn encoded_len_prefixed(&self) -> Result<usize, Error> {
 [4, self.encoded_len()?].checked_sum()
 }

 /// Encode this value, first prepending a `uint32` length prefix
 /// set to [`Encode::encoded_len`].
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.encoded_len()?.encode(writer)?;
 self.encode(writer)
 }
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document into the provided `out` buffer.
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error>;
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document to a returned [`String`].
 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error> {
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
 let mut writer =
 pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
 .map_err(Error::from)?;

 self.encode(&mut writer)?;
 let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
 str::from_utf8(&out[..encoded_len]).map_err(Error::from)
 }

 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
 let encoded_len = pem::encapsulated_len_wrapped(
 Self::PEM_LABEL,
 PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
 let mut buf = vec![0u8; encoded_len];
 let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
 buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
 String::from_utf8(buf).map_err(Error::from)
 }
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(1)
 }
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(8)
 }
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 [4, self.len()].checked_sum()
 }
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_bytes().encoded_len()
 }
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_str().encoded_len()
 }
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.iter().try_fold(4usize, |acc, string| {
 acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down

13 changes: 12 additions & 1 deletion
ssh-encoding/src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
 /// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
 /// Character encoding-related errors.
 CharacterEncoding,

 /// Invalid label.
 Label(LabelError),

 /// Invalid length.
 Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
 #[cfg(feature = "base64")]
 Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
 Error::CharacterEncoding => write!(f, "character encoding invalid"),
 Error::Label(err) => write!(f, "{}", err),
 Error::Length => write!(f, "length invalid"),
 Error::Overflow => write!(f, "internal overflow error"),
 #[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
 }
}

impl From<LabelError> for Error {
 fn from(err: LabelError) -> Error {
 Error::Label(err)
 }
}

impl From<core::num::TryFromIntError> for Error {
 fn from(_: core::num::TryFromIntError) -> Error {
 Error::Overflow
Expand Down

74 changes: 60 additions & 14 deletions
ssh-encoding/src/label.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
 /// Type returned in the event of an encoding error.
 type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
 type Error = T::Error;
 type Error = Error;

 fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
 fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
 let mut buf = [0u8; MAX_LABEL_SIZE];
 reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
 }
}

impl<T: Label> Encode for T {
 type Error = T::Error;
 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_ref().encoded_len()
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.as_ref().encode(writer)
 }
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
 /// The label that was considered invalid.
 #[cfg(feature = "alloc")]
 label: String,
}

 fn encoded_len(&self) -> Result<usize, T::Error> {
 Ok(self.as_ref().encoded_len()?)
impl LabelError {
 /// Create a new [`LabelError`] for the given invalid label.
 #[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
 pub fn new(label: &str) -> Self {
 Self {
 #[cfg(feature = "alloc")]
 label: label.into(),
 }
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
 Ok(self.as_ref().encode(writer)?)
 /// The invalid label string (if available).
 #[inline]
 pub fn label(&self) -> &str {
 #[cfg(not(feature = "alloc"))]
 {
 ""
 }
 #[cfg(feature = "alloc")]
 {
 &self.label
 }
 }
}

impl fmt::Display for LabelError {
 #[cfg(not(feature = "alloc"))]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 f.write_str("invalid label")
 }

 #[cfg(feature = "alloc")]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 write!(f, "invalid label: '{}'", self.label)
 }
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}

2 changes: 1 addition & 1 deletion
ssh-encoding/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
 decode::Decode,
 encode::Encode,
 error::{Error, Result},
 label::Label,
 label::{Label, LabelError},
 reader::{NestedReader, Reader},
 writer::Writer,
};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-encoding: remove `Encoding::Error`; add `LabelError` by tarcieri · Pull Request #124 · RustCrypto/SSH · GitHub
Skip to content
ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Jun 20, 2023
 Merged


ssh-encoding: remove Encoding::Error; add LabelError#124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


53 changes: 11 additions & 42 deletions
ssh-encoding/src/encode.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
 /// Type returned in the event of an encoding error.
 type Error: From<Error>;

 /// Get the length of this type encoded in bytes, prior to Base64 encoding.
 fn encoded_len(&self) -> Result<usize, Self::Error>;
 fn encoded_len(&self) -> Result<usize, Error>;

 /// Encode this value using the provided [`Writer`].
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

 /// Return the length of this type after encoding when prepended with a
 /// `uint32` length prefix.
 fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
 fn encoded_len_prefixed(&self) -> Result<usize, Error> {
 [4, self.encoded_len()?].checked_sum()
 }

 /// Encode this value, first prepending a `uint32` length prefix
 /// set to [`Encode::encoded_len`].
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.encoded_len()?.encode(writer)?;
 self.encode(writer)
 }
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document into the provided `out` buffer.
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error>;
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document to a returned [`String`].
 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error> {
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
 let mut writer =
 pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
 .map_err(Error::from)?;

 self.encode(&mut writer)?;
 let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
 str::from_utf8(&out[..encoded_len]).map_err(Error::from)
 }

 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
 let encoded_len = pem::encapsulated_len_wrapped(
 Self::PEM_LABEL,
 PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
 let mut buf = vec![0u8; encoded_len];
 let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
 buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
 String::from_utf8(buf).map_err(Error::from)
 }
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(1)
 }
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(8)
 }
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 [4, self.len()].checked_sum()
 }
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_bytes().encoded_len()
 }
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_str().encoded_len()
 }
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.iter().try_fold(4usize, |acc, string| {
 acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down

13 changes: 12 additions & 1 deletion
ssh-encoding/src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
 /// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
 /// Character encoding-related errors.
 CharacterEncoding,

 /// Invalid label.
 Label(LabelError),

 /// Invalid length.
 Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
 #[cfg(feature = "base64")]
 Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
 Error::CharacterEncoding => write!(f, "character encoding invalid"),
 Error::Label(err) => write!(f, "{}", err),
 Error::Length => write!(f, "length invalid"),
 Error::Overflow => write!(f, "internal overflow error"),
 #[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
 }
}

impl From<LabelError> for Error {
 fn from(err: LabelError) -> Error {
 Error::Label(err)
 }
}

impl From<core::num::TryFromIntError> for Error {
 fn from(_: core::num::TryFromIntError) -> Error {
 Error::Overflow
Expand Down

74 changes: 60 additions & 14 deletions
ssh-encoding/src/label.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
 /// Type returned in the event of an encoding error.
 type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
 type Error = T::Error;
 type Error = Error;

 fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
 fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
 let mut buf = [0u8; MAX_LABEL_SIZE];
 reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
 }
}

impl<T: Label> Encode for T {
 type Error = T::Error;
 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_ref().encoded_len()
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.as_ref().encode(writer)
 }
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
 /// The label that was considered invalid.
 #[cfg(feature = "alloc")]
 label: String,
}

 fn encoded_len(&self) -> Result<usize, T::Error> {
 Ok(self.as_ref().encoded_len()?)
impl LabelError {
 /// Create a new [`LabelError`] for the given invalid label.
 #[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
 pub fn new(label: &str) -> Self {
 Self {
 #[cfg(feature = "alloc")]
 label: label.into(),
 }
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
 Ok(self.as_ref().encode(writer)?)
 /// The invalid label string (if available).
 #[inline]
 pub fn label(&self) -> &str {
 #[cfg(not(feature = "alloc"))]
 {
 ""
 }
 #[cfg(feature = "alloc")]
 {
 &self.label
 }
 }
}

impl fmt::Display for LabelError {
 #[cfg(not(feature = "alloc"))]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 f.write_str("invalid label")
 }

 #[cfg(feature = "alloc")]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 write!(f, "invalid label: '{}'", self.label)
 }
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}

2 changes: 1 addition & 1 deletion
ssh-encoding/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
 decode::Decode,
 encode::Encode,
 error::{Error, Result},
 label::Label,
 label::{Label, LabelError},
 reader::{NestedReader, Reader},
 writer::Writer,
};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-encoding: remove `Encoding::Error`; add `LabelError` by tarcieri · Pull Request #124 · RustCrypto/SSH · GitHub
Skip to content
ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Jun 20, 2023
 Merged


ssh-encoding: remove Encoding::Error; add LabelError#124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


53 changes: 11 additions & 42 deletions
ssh-encoding/src/encode.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
 /// Type returned in the event of an encoding error.
 type Error: From<Error>;

 /// Get the length of this type encoded in bytes, prior to Base64 encoding.
 fn encoded_len(&self) -> Result<usize, Self::Error>;
 fn encoded_len(&self) -> Result<usize, Error>;

 /// Encode this value using the provided [`Writer`].
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

 /// Return the length of this type after encoding when prepended with a
 /// `uint32` length prefix.
 fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
 fn encoded_len_prefixed(&self) -> Result<usize, Error> {
 [4, self.encoded_len()?].checked_sum()
 }

 /// Encode this value, first prepending a `uint32` length prefix
 /// set to [`Encode::encoded_len`].
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.encoded_len()?.encode(writer)?;
 self.encode(writer)
 }
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document into the provided `out` buffer.
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error>;
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document to a returned [`String`].
 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error> {
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
 let mut writer =
 pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
 .map_err(Error::from)?;

 self.encode(&mut writer)?;
 let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
 str::from_utf8(&out[..encoded_len]).map_err(Error::from)
 }

 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
 let encoded_len = pem::encapsulated_len_wrapped(
 Self::PEM_LABEL,
 PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
 let mut buf = vec![0u8; encoded_len];
 let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
 buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
 String::from_utf8(buf).map_err(Error::from)
 }
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(1)
 }
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(8)
 }
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 [4, self.len()].checked_sum()
 }
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_bytes().encoded_len()
 }
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_str().encoded_len()
 }
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.iter().try_fold(4usize, |acc, string| {
 acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down

13 changes: 12 additions & 1 deletion
ssh-encoding/src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
 /// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
 /// Character encoding-related errors.
 CharacterEncoding,

 /// Invalid label.
 Label(LabelError),

 /// Invalid length.
 Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
 #[cfg(feature = "base64")]
 Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
 Error::CharacterEncoding => write!(f, "character encoding invalid"),
 Error::Label(err) => write!(f, "{}", err),
 Error::Length => write!(f, "length invalid"),
 Error::Overflow => write!(f, "internal overflow error"),
 #[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
 }
}

impl From<LabelError> for Error {
 fn from(err: LabelError) -> Error {
 Error::Label(err)
 }
}

impl From<core::num::TryFromIntError> for Error {
 fn from(_: core::num::TryFromIntError) -> Error {
 Error::Overflow
Expand Down

74 changes: 60 additions & 14 deletions
ssh-encoding/src/label.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
 /// Type returned in the event of an encoding error.
 type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
 type Error = T::Error;
 type Error = Error;

 fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
 fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
 let mut buf = [0u8; MAX_LABEL_SIZE];
 reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
 }
}

impl<T: Label> Encode for T {
 type Error = T::Error;
 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_ref().encoded_len()
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.as_ref().encode(writer)
 }
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
 /// The label that was considered invalid.
 #[cfg(feature = "alloc")]
 label: String,
}

 fn encoded_len(&self) -> Result<usize, T::Error> {
 Ok(self.as_ref().encoded_len()?)
impl LabelError {
 /// Create a new [`LabelError`] for the given invalid label.
 #[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
 pub fn new(label: &str) -> Self {
 Self {
 #[cfg(feature = "alloc")]
 label: label.into(),
 }
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
 Ok(self.as_ref().encode(writer)?)
 /// The invalid label string (if available).
 #[inline]
 pub fn label(&self) -> &str {
 #[cfg(not(feature = "alloc"))]
 {
 ""
 }
 #[cfg(feature = "alloc")]
 {
 &self.label
 }
 }
}

impl fmt::Display for LabelError {
 #[cfg(not(feature = "alloc"))]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 f.write_str("invalid label")
 }

 #[cfg(feature = "alloc")]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 write!(f, "invalid label: '{}'", self.label)
 }
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}

2 changes: 1 addition & 1 deletion
ssh-encoding/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
 decode::Decode,
 encode::Encode,
 error::{Error, Result},
 label::Label,
 label::{Label, LabelError},
 reader::{NestedReader, Reader},
 writer::Writer,
};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
ssh-encoding: remove `Encoding::Error`; add `LabelError` by tarcieri · Pull Request #124 · RustCrypto/SSH · GitHub
Skip to content
ssh-encoding: remove Encoding::Error; add LabelError#124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Jun 20, 2023
 Merged


ssh-encoding: remove Encoding::Error; add LabelError#124
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


53 changes: 11 additions & 42 deletions
ssh-encoding/src/encode.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,24 +19,21 @@ use {
///
/// This trait describes how to encode a given type.
pub trait Encode {
 /// Type returned in the event of an encoding error.
 type Error: From<Error>;

 /// Get the length of this type encoded in bytes, prior to Base64 encoding.
 fn encoded_len(&self) -> Result<usize, Self::Error>;
 fn encoded_len(&self) -> Result<usize, Error>;

 /// Encode this value using the provided [`Writer`].
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Self::Error>;
 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>;

 /// Return the length of this type after encoding when prepended with a
 /// `uint32` length prefix.
 fn encoded_len_prefixed(&self) -> Result<usize, Self::Error> {
Ok([4, self.encoded_len()?].checked_sum()?)
 fn encoded_len_prefixed(&self) -> Result<usize, Error> {
 [4, self.encoded_len()?].checked_sum()
 }

 /// Encode this value, first prepending a `uint32` length prefix
 /// set to [`Encode::encoded_len`].
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Self::Error> {
 fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.encoded_len()?.encode(writer)?;
 self.encode(writer)
 }
Expand All@@ -50,36 +47,28 @@ pub trait Encode {
pub trait EncodePem: Encode + PemLabel {
 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document into the provided `out` buffer.
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error>;
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error>;

 /// Encode this type using the [`Encode`] trait, writing the resulting PEM
 /// document to a returned [`String`].
 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error>;
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error>;
}

#[cfg(feature = "pem")]
impl<T: Encode + PemLabel> EncodePem for T {
 fn encode_pem<'o>(
 &self,
 line_ending: LineEnding,
 out: &'o mut [u8],
 ) -> Result<&'o str, Self::Error> {
 fn encode_pem<'o>(&self, line_ending: LineEnding, out: &'o mut [u8]) -> Result<&'o str, Error> {
 let mut writer =
 pem::Encoder::new_wrapped(Self::PEM_LABEL, PEM_LINE_WIDTH, line_ending, out)
 .map_err(Error::from)?;

 self.encode(&mut writer)?;
 let encoded_len = writer.finish().map_err(Error::from)?;
Ok(str::from_utf8(&out[..encoded_len]).map_err(Error::from)?)
 str::from_utf8(&out[..encoded_len]).map_err(Error::from)
 }

 #[cfg(feature = "alloc")]
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Self::Error> {
 fn encode_pem_string(&self, line_ending: LineEnding) -> Result<String, Error> {
 let encoded_len = pem::encapsulated_len_wrapped(
 Self::PEM_LABEL,
 PEM_LINE_WIDTH,
Expand All@@ -91,14 +80,12 @@ impl<T: Encode + PemLabel> EncodePem for T {
 let mut buf = vec![0u8; encoded_len];
 let actual_len = self.encode_pem(line_ending, &mut buf)?.len();
 buf.truncate(actual_len);
Ok(String::from_utf8(buf).map_err(Error::from)?)
 String::from_utf8(buf).map_err(Error::from)
 }
}

/// Encode a single `byte` to the writer.
impl Encode for u8 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(1)
 }
Expand All@@ -116,8 +103,6 @@ impl Encode for u8 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u32 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -134,8 +119,6 @@ impl Encode for u32 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for u64 {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(8)
 }
Expand All@@ -152,8 +135,6 @@ impl Encode for u64 {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for usize {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 Ok(4)
 }
Expand All@@ -171,8 +152,6 @@ impl Encode for usize {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for [u8] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 [4, self.len()].checked_sum()
 }
Expand All@@ -191,8 +170,6 @@ impl Encode for [u8] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl<const N: usize> Encode for [u8; N] {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand DownExpand Up@@ -220,8 +197,6 @@ impl<const N: usize> Encode for [u8; N] {
///
/// [RFC4251 § 5]: https://datatracker.ietf.org/doc/html/rfc4251#section-5
impl Encode for &str {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_bytes().encoded_len()
 }
Expand All@@ -233,8 +208,6 @@ impl Encode for &str {

#[cfg(feature = "alloc")]
impl Encode for Vec<u8> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_slice().encoded_len()
 }
Expand All@@ -246,8 +219,6 @@ impl Encode for Vec<u8> {

#[cfg(feature = "alloc")]
impl Encode for String {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_str().encoded_len()
 }
Expand All@@ -259,8 +230,6 @@ impl Encode for String {

#[cfg(feature = "alloc")]
impl Encode for Vec<String> {
 type Error = Error;

 fn encoded_len(&self) -> Result<usize, Error> {
 self.iter().try_fold(4usize, |acc, string| {
 acc.checked_add(string.encoded_len()?).ok_or(Error::Length)
Expand Down

13 changes: 12 additions & 1 deletion
ssh-encoding/src/error.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
//! Error types

use crate::LabelError;
use core::fmt;

/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
pub type Result<T> = core::result::Result<T, Error>;

/// Error type.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum Error {
 /// Base64-related errors.
Expand All@@ -16,6 +17,9 @@ pub enum Error {
 /// Character encoding-related errors.
 CharacterEncoding,

 /// Invalid label.
 Label(LabelError),

 /// Invalid length.
 Length,

Expand All@@ -39,6 +43,7 @@ impl fmt::Display for Error {
 #[cfg(feature = "base64")]
 Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
 Error::CharacterEncoding => write!(f, "character encoding invalid"),
 Error::Label(err) => write!(f, "{}", err),
 Error::Length => write!(f, "length invalid"),
 Error::Overflow => write!(f, "internal overflow error"),
 #[cfg(feature = "pem")]
Expand All@@ -51,6 +56,12 @@ impl fmt::Display for Error {
 }
}

impl From<LabelError> for Error {
 fn from(err: LabelError) -> Error {
 Error::Label(err)
 }
}

impl From<core::num::TryFromIntError> for Error {
 fn from(_: core::num::TryFromIntError) -> Error {
 Error::Overflow
Expand Down

74 changes: 60 additions & 14 deletions
ssh-encoding/src/label.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
//! Convenience trait for decoding/encoding string labels.

use crate::{Decode, Encode, Reader, Writer};
use core::str::FromStr;
use crate::{Decode, Encode, Error, Reader, Writer};
use core::{fmt, str::FromStr};

#[cfg(feature = "alloc")]
use alloc::string::String;

/// Maximum size of any algorithm name/identifier.
const MAX_LABEL_SIZE: usize = 48;

/// Labels for e.g. cryptographic algorithms.
///
/// Receives a blanket impl of [`Decode`] and [`Encode`].
pub trait Label: AsRef<str> + FromStr<Err = Self::Error> {
 /// Type returned in the event of an encoding error.
 type Error: From<crate::Error>;
}
pub trait Label: AsRef<str> + FromStr<Err = LabelError> {}

impl<T: Label> Decode for T {
 type Error = T::Error;
 type Error = Error;

 fn decode(reader: &mut impl Reader) -> Result<Self, T::Error> {
 fn decode(reader: &mut impl Reader) -> Result<Self, Error> {
 let mut buf = [0u8; MAX_LABEL_SIZE];
 reader.read_string(buf.as_mut())?.parse()
Ok(reader.read_string(buf.as_mut())?.parse()?)
 }
}

impl<T: Label> Encode for T {
 type Error = T::Error;
 fn encoded_len(&self) -> Result<usize, Error> {
 self.as_ref().encoded_len()
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), Error> {
 self.as_ref().encode(writer)
 }
}

/// Errors related to labels.
#[derive(Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub struct LabelError {
 /// The label that was considered invalid.
 #[cfg(feature = "alloc")]
 label: String,
}

 fn encoded_len(&self) -> Result<usize, T::Error> {
 Ok(self.as_ref().encoded_len()?)
impl LabelError {
 /// Create a new [`LabelError`] for the given invalid label.
 #[cfg_attr(not(feature = "alloc"), allow(unused_variables))]
 pub fn new(label: &str) -> Self {
 Self {
 #[cfg(feature = "alloc")]
 label: label.into(),
 }
 }

 fn encode(&self, writer: &mut impl Writer) -> Result<(), T::Error> {
 Ok(self.as_ref().encode(writer)?)
 /// The invalid label string (if available).
 #[inline]
 pub fn label(&self) -> &str {
 #[cfg(not(feature = "alloc"))]
 {
 ""
 }
 #[cfg(feature = "alloc")]
 {
 &self.label
 }
 }
}

impl fmt::Display for LabelError {
 #[cfg(not(feature = "alloc"))]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 f.write_str("invalid label")
 }

 #[cfg(feature = "alloc")]
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 write!(f, "invalid label: '{}'", self.label)
 }
}

#[cfg(feature = "std")]
impl std::error::Error for LabelError {}

2 changes: 1 addition & 1 deletion
ssh-encoding/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ pub use crate::{
 decode::Decode,
 encode::Encode,
 error::{Error, Result},
 label::Label,
 label::{Label, LabelError},
 reader::{NestedReader, Reader},
 writer::Writer,
};
Expand Down
Loading