nushell/crates/nu-command/src/hash/generic_digest.rs
Benoît Cortier 32f0f94b46
feat: add --binary(-b) option to hash commands (#5885)
For instance,

```
echo 'abcdefghijklmnopqrstuvwxyz' | hash sha256 --binary
```

Will returns the hash as a binary value instead of a hexadecimaly encoded string.
2022-06-26 06:50:56 -05:00

134 lines
3.5 KiB
Rust

use nu_engine::CallExt;
use nu_protocol::ast::{Call, CellPath};
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{Example, PipelineData, ShellError, Signature, SyntaxShape, Value};
use std::marker::PhantomData;
pub trait HashDigest: digest::Digest + Clone {
fn name() -> &'static str;
fn examples() -> Vec<Example>;
}
#[derive(Clone)]
pub struct GenericDigest<D: HashDigest> {
name: String,
usage: String,
phantom: PhantomData<D>,
}
impl<D: HashDigest> Default for GenericDigest<D> {
fn default() -> Self {
Self {
name: format!("hash {}", D::name()),
usage: format!("Hash a value using the {} hash algorithm", D::name()),
phantom: PhantomData,
}
}
}
impl<D> Command for GenericDigest<D>
where
D: HashDigest + Send + Sync + 'static,
digest::Output<D>: core::fmt::LowerHex,
{
fn name(&self) -> &str {
&self.name
}
fn signature(&self) -> Signature {
Signature::build(self.name())
.switch(
"binary",
"Output binary instead of hexadecimal representation",
Some('b'),
)
.rest(
"rest",
SyntaxShape::CellPath,
format!("optionally {} hash data by cell path", D::name()),
)
}
fn usage(&self) -> &str {
&self.usage
}
fn examples(&self) -> Vec<Example> {
D::examples()
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
) -> Result<nu_protocol::PipelineData, nu_protocol::ShellError> {
let binary = call.has_flag("binary");
let cell_paths: Vec<CellPath> = call.rest(engine_state, stack, 0)?;
input.map(
move |v| {
if cell_paths.is_empty() {
action::<D>(binary, &v)
} else {
let mut v = v;
for path in &cell_paths {
let ret = v.update_cell_path(
&path.members,
Box::new(move |old| action::<D>(binary, old)),
);
if let Err(error) = ret {
return Value::Error { error };
}
}
v
}
},
engine_state.ctrlc.clone(),
)
}
}
pub fn action<D>(binary: bool, input: &Value) -> Value
where
D: HashDigest,
digest::Output<D>: core::fmt::LowerHex,
{
let (bytes, span) = match input {
Value::String { val, span } => (val.as_bytes(), *span),
Value::Binary { val, span } => (val.as_slice(), *span),
other => {
let span = match input.span() {
Ok(span) => span,
Err(error) => return Value::Error { error },
};
return Value::Error {
error: ShellError::UnsupportedInput(
format!(
"Type `{}` is not supported for {} hashing input",
other.get_type(),
D::name()
),
span,
),
};
}
};
let digest = D::digest(bytes);
if binary {
Value::Binary {
val: digest.to_vec(),
span,
}
} else {
Value::String {
val: format!("{:x}", digest),
span,
}
}
}