1use std::io::Write;
48use std::path::Path;
49
50use clap::Parser;
51use mkit_attest::{Algorithm, Envelope, PAYLOAD_TYPE_IN_TOTO, Sig, Signer, statement, store};
52use mkit_core::hash::Hash;
53use mkit_core::{hash as hash_mod, refs};
54
55use crate::clap_shim;
56use crate::commands::attest_factory::{self, FactoryError};
57use crate::config::Config;
58use crate::exit;
59
60const DEFAULT_PREDICATE_TYPE: &str =
68 "https://github.com/officialunofficial/mkit/spec/predicate/empty/v1";
69
70const MAX_PREDICATE_BYTES: u64 = 1024 * 1024;
75
76#[derive(Debug, Parser)]
77#[command(
78 name = "mkit attest",
79 about = "Produce a signed DSSE attestation for a commit."
80)]
81#[allow(clippy::struct_field_names)]
82struct Args {
83 #[arg(long, value_name = "HASH")]
85 commit: Option<String>,
86 #[arg(long, value_name = "ALG")]
88 algorithm: Option<String>,
89 #[arg(long, value_name = "KIND")]
91 signer: Option<String>,
92 #[arg(long = "predicate-type", value_name = "URI")]
94 predicate_type: Option<String>,
95 #[arg(long = "predicate-file", value_name = "PATH")]
97 predicate_file: Option<String>,
98 #[arg(long = "additional-signer", value_name = "SPEC")]
102 additional_signers: Vec<String>,
103 #[arg(
112 long = "external-signer-arg",
113 value_name = "ARG",
114 allow_hyphen_values = true
115 )]
116 external_signer_args_vec: Vec<String>,
117}
118
119impl Args {
120 fn external_signer_args(&self) -> Option<Vec<String>> {
124 if self.external_signer_args_vec.is_empty() {
125 None
126 } else {
127 Some(self.external_signer_args_vec.clone())
128 }
129 }
130}
131
132#[derive(Debug, PartialEq, Eq)]
137struct SignerSpec {
138 algorithm: Algorithm,
139 signer_kind: String,
140 path: Option<String>,
141 args: Option<Vec<String>>,
146}
147
148fn parse_signer_spec(s: &str) -> Result<SignerSpec, String> {
149 let mut algorithm: Option<Algorithm> = None;
150 let mut signer_kind: Option<String> = None;
151 let mut path: Option<String> = None;
152 let mut args: Option<Vec<String>> = None;
153 for part in s.split(',') {
154 let part = part.trim();
155 if part.is_empty() {
156 continue;
157 }
158 let Some((k, v)) = part.split_once('=') else {
159 return Err(format!(
160 "--additional-signer spec part '{part}' is not key=value"
161 ));
162 };
163 match k.trim() {
164 "algorithm" => {
165 let v = v.trim();
166 let alg = attest_factory::parse_algorithm(v).map_err(|_| {
167 format!("--additional-signer: unknown algorithm '{v}' — expected one of: ed25519, secp256k1, p256")
168 })?;
169 algorithm = Some(alg);
170 }
171 "signer" => {
172 let v = v.trim();
173 if !matches!(v, "repo-key" | "external") {
174 return Err(format!(
175 "--additional-signer: unknown signer '{v}' — expected one of: repo-key, external"
176 ));
177 }
178 signer_kind = Some(v.to_owned());
179 }
180 "path" => {
181 path = Some(v.trim().to_owned());
182 }
183 "args" => {
184 args = Some(crate::config::parse_pipe_list(v.trim()));
191 }
192 other => {
193 return Err(format!("--additional-signer: unknown spec key '{other}'"));
194 }
195 }
196 }
197 let algorithm =
198 algorithm.ok_or_else(|| "--additional-signer: missing algorithm=...".to_owned())?;
199 let signer_kind =
200 signer_kind.ok_or_else(|| "--additional-signer: missing signer=...".to_owned())?;
201 Ok(SignerSpec {
202 algorithm,
203 signer_kind,
204 path,
205 args,
206 })
207}
208
209#[must_use]
210#[allow(clippy::too_many_lines)]
211pub fn run(args: &[String]) -> u8 {
212 let parsed = match clap_shim::parse::<Args>("mkit attest", args) {
213 Ok(o) => o,
214 Err(code) => return code,
215 };
216
217 let cwd = match std::env::current_dir() {
218 Ok(p) => p,
219 Err(e) => return emit_err(&format!("cwd: {e}"), exit::NOINPUT),
220 };
221 let mkit_dir = cwd.join(mkit_core::MKIT_DIR);
222 if !mkit_dir.is_dir() {
223 return emit_err("not a mkit repo", exit::GENERAL_ERROR);
224 }
225
226 let mut cfg = match crate::config::read_or_default(&cwd) {
227 Ok(c) => c,
228 Err(e) => return emit_err(&format!("config: {e}"), exit::CONFIG_ERROR),
229 };
230
231 if let Some(argv) = parsed.external_signer_args() {
236 cfg.attest.external_signer_args = argv;
237 }
238
239 let commit_hash = match resolve_commit(&mkit_dir, parsed.commit.as_deref()) {
241 Ok(h) => h,
242 Err((msg, code)) => return emit_err(&msg, code),
243 };
244
245 let alg_str = parsed
247 .algorithm
248 .clone()
249 .unwrap_or_else(|| cfg.attest.default_algorithm_or_fallback().to_owned());
250 let algorithm = match attest_factory::parse_algorithm(&alg_str) {
251 Ok(a) => a,
252 Err(FactoryError::UnknownAlgorithm(s)) => {
253 return emit_err(
254 &format!("unknown algorithm '{s}' — expected one of: ed25519, secp256k1, p256"),
255 exit::USAGE,
256 );
257 }
258 Err(e) => return emit_err(&format!("{e}"), exit::USAGE),
259 };
260 let signer_kind = parsed
261 .signer
262 .clone()
263 .unwrap_or_else(|| cfg.attest.signer_or_fallback().to_owned());
264
265 let primary_signer = match attest_factory::build_signer(&cwd, algorithm, &signer_kind, &cfg) {
266 Ok(s) => s,
267 Err(e) => return emit_err(&format!("{e}"), factory_error_code(&e)),
268 };
269
270 let mut additional_specs: Vec<SignerSpec> = Vec::with_capacity(parsed.additional_signers.len());
274 for spec_str in &parsed.additional_signers {
275 match parse_signer_spec(spec_str) {
276 Ok(s) => additional_specs.push(s),
277 Err(e) => return emit_err(&e, exit::USAGE),
278 }
279 }
280
281 let mut signers: Vec<Box<dyn Signer>> = Vec::with_capacity(1 + additional_specs.len());
282 signers.push(primary_signer);
283 for spec in &additional_specs {
284 let signer = match build_additional_signer(&cwd, spec, &cfg) {
285 Ok(s) => s,
286 Err(e) => return emit_err(&format!("{e}"), factory_error_code(&e)),
287 };
288 signers.push(signer);
289 }
290
291 let predicate_bytes: Vec<u8> = match parsed.predicate_file.as_deref() {
293 Some(p) => match read_predicate_file(p) {
294 Ok(b) => b,
295 Err((msg, code)) => return emit_err(&msg, code),
296 },
297 None => b"{}".to_vec(),
298 };
299 let predicate_type = parsed
300 .predicate_type
301 .unwrap_or_else(|| DEFAULT_PREDICATE_TYPE.to_owned());
302
303 let stmt_bytes = match statement::for_commit(&commit_hash, &predicate_type, &predicate_bytes) {
305 Ok(s) => s.into_bytes(),
306 Err(
307 mkit_attest::Error::PredicateMustBeJsonObject
308 | mkit_attest::Error::PredicateNotJsonObject
309 | mkit_attest::Error::PredicateNotUtf8,
310 ) => {
311 return emit_err(
312 "--predicate-file must contain a JCS-canonical JSON object",
313 exit::DATAERR,
314 );
315 }
316 Err(e) => return emit_err(&format!("statement: {e}"), exit::DATAERR),
317 };
318
319 let pae = mkit_attest::pae_of(PAYLOAD_TYPE_IN_TOTO, &stmt_bytes);
321 let mut signatures: Vec<Sig> = Vec::with_capacity(signers.len());
322 for (idx, signer) in signers.iter_mut().enumerate() {
323 let sig_bytes = match signer.sign(&pae) {
324 Ok(b) => b,
325 Err(e) => {
326 return emit_err(
327 &format!("sign (signer #{}): {e}", idx + 1),
328 exit::GENERAL_ERROR,
329 );
330 }
331 };
332 let keyid = match signer.keyid() {
333 Ok(k) => k,
334 Err(e) => {
335 return emit_err(
336 &format!("keyid (signer #{}): {e}", idx + 1),
337 exit::GENERAL_ERROR,
338 );
339 }
340 };
341 signatures.push(Sig {
342 keyid,
343 sig: sig_bytes,
344 });
345 }
346
347 let envelope = Envelope {
348 payload_type: PAYLOAD_TYPE_IN_TOTO.to_owned(),
349 payload: stmt_bytes,
350 signatures,
351 };
352 let encoded = match envelope.encode() {
353 Ok(s) => s,
354 Err(e) => return emit_err(&format!("encode envelope: {e}"), exit::DATAERR),
355 };
356
357 let _lock = match super::acquire_worktree_lock(&cwd) {
366 Ok(l) => l,
367 Err(code) => return code,
368 };
369 let obj_store = match mkit_core::store::ObjectStore::open(&cwd) {
375 Ok(s) => s,
376 Err(e) => return emit_err(&format!("not a mkit repo: {e}"), exit::GENERAL_ERROR),
377 };
378 if !obj_store.contains(&commit_hash) {
379 return emit_err(
380 &format!(
381 "attested commit {} no longer exists (pruned concurrently?); aborting",
382 hash_mod::to_hex(&commit_hash)
383 ),
384 exit::CANTCREAT,
385 );
386 }
387 let (att_id, path) = match store::save(&mkit_dir, &commit_hash, encoded.as_bytes()) {
388 Ok(p) => p,
389 Err(e) => return emit_err(&format!("store: {e}"), exit::CANTCREAT),
390 };
391 let mut stderr = std::io::stderr().lock();
392 let _ = writeln!(
393 stderr,
394 "attested {} → {} ({} signature(s))",
395 hash_mod::to_hex(&att_id),
396 path.display(),
397 envelope.signatures.len()
398 );
399 exit::OK
400}
401
402fn build_additional_signer(
408 root: &Path,
409 spec: &SignerSpec,
410 base: &Config,
411) -> Result<Box<dyn Signer>, FactoryError> {
412 match spec.signer_kind.as_str() {
413 "repo-key" => {
414 let mut cfg = base.clone();
418 if let Some(p) = spec.path.as_deref() {
419 if let Err(e) = crate::config::validate_key_path(p) {
425 return Err(FactoryError::InvalidKeyFile {
426 path: p.to_owned(),
427 reason: e.to_string(),
428 });
429 }
430 match spec.algorithm {
431 Algorithm::Ed25519 => p.clone_into(&mut cfg.signing_key),
432 Algorithm::Secp256k1 => p.clone_into(&mut cfg.attest.secp256k1_key_path),
433 Algorithm::P256 => p.clone_into(&mut cfg.attest.p256_key_path),
434 #[cfg(feature = "bls-threshold")]
435 Algorithm::Bls12381Threshold => {
436 return Err(FactoryError::UnknownAlgorithm(
437 "bls12381-thr key path not configurable in Phase 1".to_owned(),
438 ));
439 }
440 }
441 }
442 attest_factory::build_signer(root, spec.algorithm, "repo-key", &cfg)
443 }
444 "external" => {
445 let mut cfg = base.clone();
446 if let Some(p) = spec.path.as_deref() {
447 p.clone_into(&mut cfg.attest.external_signer_path);
448 }
449 if let Some(argv) = spec.args.as_ref() {
454 cfg.attest.external_signer_args.clone_from(argv);
455 }
456 attest_factory::build_signer(root, spec.algorithm, "external", &cfg)
457 }
458 other => Err(FactoryError::UnknownSignerKind(other.to_owned())),
459 }
460}
461
462pub(crate) fn factory_error_code(e: &FactoryError) -> u8 {
463 match e {
464 FactoryError::UnknownSignerKind(_) | FactoryError::UnknownAlgorithm(_) => exit::USAGE,
465 FactoryError::MissingKeyFile { .. } | FactoryError::MissingKeystoreKey { .. } => {
466 exit::NOINPUT
467 }
468 _ => exit::CONFIG_ERROR,
469 }
470}
471
472fn read_predicate_file(path: &str) -> Result<Vec<u8>, (String, u8)> {
477 use std::io::Read;
478 let meta = std::fs::metadata(path)
479 .map_err(|e| (format!("predicate file '{path}': {e}"), exit::NOINPUT))?;
480 if meta.len() > MAX_PREDICATE_BYTES {
481 return Err((
482 format!("predicate file '{path}' exceeds {MAX_PREDICATE_BYTES}-byte cap"),
483 exit::DATAERR,
484 ));
485 }
486 let file = std::fs::File::open(path)
487 .map_err(|e| (format!("predicate file '{path}': {e}"), exit::NOINPUT))?;
488 let mut data = Vec::new();
489 file.take(MAX_PREDICATE_BYTES + 1)
490 .read_to_end(&mut data)
491 .map_err(|e| (format!("predicate file '{path}': {e}"), exit::NOINPUT))?;
492 if data.len() as u64 > MAX_PREDICATE_BYTES {
493 return Err((
494 format!("predicate file '{path}' exceeds {MAX_PREDICATE_BYTES}-byte cap"),
495 exit::DATAERR,
496 ));
497 }
498 Ok(data)
499}
500
501fn resolve_commit(mkit_dir: &Path, flag: Option<&str>) -> Result<Hash, (String, u8)> {
503 if let Some(hex) = flag {
504 return hash_mod::from_hex(hex)
505 .map_err(|e| (format!("bad --commit hash: {e}"), exit::DATAERR));
506 }
507 match refs::resolve_head(mkit_dir) {
508 Ok(Some(h)) => Ok(h),
509 Ok(None) => Err(("HEAD has no commit yet".to_owned(), exit::GENERAL_ERROR)),
510 Err(e) => Err((format!("read HEAD: {e}"), exit::GENERAL_ERROR)),
511 }
512}
513
514fn emit_err(msg: &str, code: u8) -> u8 {
515 let mut stderr = std::io::stderr().lock();
516 let _ = writeln!(stderr, "error: {msg}");
517 code
518}
519
520#[cfg(test)]
521mod tests {
522 use super::*;
523 use clap::Parser;
524
525 fn parse_args(args: &[String]) -> Result<Args, clap::Error> {
528 let mut full: Vec<String> = vec!["mkit attest".into()];
529 full.extend_from_slice(args);
530 Args::try_parse_from(full)
531 }
532
533 #[test]
534 fn parse_args_accepts_all_flags() {
535 let args = vec![
536 "--commit".into(),
537 "abc".into(),
538 "--algorithm".into(),
539 "p256".into(),
540 "--signer".into(),
541 "external".into(),
542 "--predicate-type".into(),
543 "https://example.com/p".into(),
544 "--predicate-file".into(),
545 "/tmp/x.json".into(),
546 ];
547 let p = parse_args(&args).unwrap();
548 assert_eq!(p.commit.as_deref(), Some("abc"));
549 assert_eq!(p.algorithm.as_deref(), Some("p256"));
550 assert_eq!(p.signer.as_deref(), Some("external"));
551 assert_eq!(p.predicate_type.as_deref(), Some("https://example.com/p"));
552 assert_eq!(p.predicate_file.as_deref(), Some("/tmp/x.json"));
553 assert!(p.additional_signers.is_empty());
554 }
555
556 #[test]
557 fn parse_args_collects_repeatable_external_signer_args() {
558 let args = vec![
559 "--external-signer-arg".into(),
560 "sign".into(),
561 "--external-signer-arg".into(),
562 "--tag".into(),
563 "--external-signer-arg".into(),
564 "demo".into(),
565 ];
566 let p = parse_args(&args).unwrap();
567 let expected = vec!["sign".to_owned(), "--tag".to_owned(), "demo".to_owned()];
568 assert_eq!(p.external_signer_args(), Some(expected));
569 }
570
571 #[test]
572 fn parse_args_external_signer_arg_none_when_absent() {
573 let p = parse_args(&[]).unwrap();
577 assert!(p.external_signer_args().is_none());
578 }
579
580 #[test]
581 fn parse_args_collects_multiple_additional_signers() {
582 let args = vec![
583 "--additional-signer".into(),
584 "algorithm=ed25519,signer=repo-key".into(),
585 "--additional-signer".into(),
586 "algorithm=p256,signer=external,path=/x".into(),
587 ];
588 let p = parse_args(&args).unwrap();
589 assert_eq!(p.additional_signers.len(), 2);
590 assert_eq!(p.additional_signers[0], "algorithm=ed25519,signer=repo-key");
591 }
592
593 #[test]
594 fn parse_args_rejects_unknown() {
595 let args = vec!["--bogus".into(), "x".into()];
596 assert!(parse_args(&args).is_err());
597 }
598
599 #[test]
600 fn parse_signer_spec_ok() {
601 let s = parse_signer_spec("algorithm=secp256k1,signer=repo-key,path=k.key").unwrap();
602 assert_eq!(s.algorithm, Algorithm::Secp256k1);
603 assert_eq!(s.signer_kind, "repo-key");
604 assert_eq!(s.path.as_deref(), Some("k.key"));
605 }
606
607 #[test]
608 fn parse_signer_spec_with_args() {
609 let s = parse_signer_spec(
610 "algorithm=p256,signer=external,path=/usr/bin/signer,args=sign|--tag|demo",
611 )
612 .unwrap();
613 assert_eq!(s.algorithm, Algorithm::P256);
614 assert_eq!(s.signer_kind, "external");
615 assert_eq!(s.path.as_deref(), Some("/usr/bin/signer"));
616 assert_eq!(
617 s.args.as_deref(),
618 Some(["sign".to_owned(), "--tag".to_owned(), "demo".to_owned()].as_slice())
619 );
620 }
621
622 #[test]
623 fn parse_signer_spec_args_empty_means_zero_argv() {
624 let s = parse_signer_spec("algorithm=ed25519,signer=external,args=").unwrap();
628 assert_eq!(s.args.as_deref(), Some([].as_slice()));
629 }
630
631 #[test]
632 fn parse_signer_spec_without_path() {
633 let s = parse_signer_spec("algorithm=p256,signer=external").unwrap();
634 assert_eq!(s.algorithm, Algorithm::P256);
635 assert_eq!(s.signer_kind, "external");
636 assert!(s.path.is_none());
637 }
638
639 #[test]
640 fn parse_signer_spec_missing_algorithm() {
641 let e = parse_signer_spec("signer=repo-key").unwrap_err();
642 assert!(e.contains("algorithm"), "{e}");
643 }
644
645 #[test]
646 fn parse_signer_spec_missing_signer() {
647 let e = parse_signer_spec("algorithm=ed25519").unwrap_err();
648 assert!(e.contains("signer"), "{e}");
649 }
650
651 #[test]
652 fn parse_signer_spec_unknown_algorithm() {
653 let e = parse_signer_spec("algorithm=rsa,signer=repo-key").unwrap_err();
654 assert!(e.contains("rsa"), "{e}");
655 }
656
657 #[test]
658 fn parse_signer_spec_unknown_signer_kind() {
659 let e = parse_signer_spec("algorithm=ed25519,signer=sigstore").unwrap_err();
660 assert!(e.contains("sigstore"), "{e}");
661 }
662
663 #[test]
664 fn parse_signer_spec_not_key_value() {
665 let e = parse_signer_spec("algorithm=ed25519 signer=repo-key").unwrap_err();
670 assert!(e.contains("algorithm") || e.contains("key=value"), "{e}");
671 }
672
673 #[test]
674 fn parse_args_all_defaults_when_empty() {
675 let p = parse_args(&[]).unwrap();
676 assert!(p.commit.is_none());
677 assert!(p.algorithm.is_none());
678 assert!(p.signer.is_none());
679 assert!(p.predicate_type.is_none());
680 assert!(p.predicate_file.is_none());
681 assert!(p.additional_signers.is_empty());
682 }
683}