Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SQ(1)				 User Commands				 SQ(1)

NAME
       sq key revoke - Revoke a	certificate

SYNOPSIS
       sq key revoke [OPTIONS] REASON MESSAGE

DESCRIPTION
       Revoke a	certificate.

       Creates a revocation certificate	for the	certificate.

       If `--revocation-file` is provided, then	that key is used to create the
       signature.   If	that  key  is different	from the certificate being re-
       voked, this creates a third-party revocation.  This  is	normally  only
       useful  if the owner of the certificate designated the key to be	a des-
       ignated revoker.

       If `--revocation-file` is not provided, then the	certificate  must  in-
       clude a certification-capable key.

       `sq  key	 revoke`  respects  the	 reference  time  set by the top-level
       `--time`	argument.  When	set, it	uses the specified time	instead	of the
       current time, when determining what keys	are valid, and it sets the re-
       vocation	certificate's creation time to the reference time  instead  of
       the current time.

OPTIONS
   Subcommand options
       -B, --binary
	      Emit binary data

       --certificate-file=FILE
	      Read  the	 certificate to	revoke from FILE or stdin, if omitted.
	      It is an error for the file to contain more  than	 one  certifi-
	      cate.

       --notation NAME VALUE
	      Add  a notation to the certification.  A user-defined notation's
	      name must	be of the form `name@a.domain.you.control.org`.	If the
	      notation's name starts with a `!`, then the notation  is	marked
	      as  being	critical.  If a	consumer of a signature	doesn't	under-
	      stand a critical notation, then it will  ignore  the  signature.
	      The notation is marked as	being human readable.

       -o, --output=FILE
	      Write to FILE or stdout if omitted

	      [default:	-]

       --private-key-store=KEY_STORE
	      Provide parameters for private key store

       --revocation-file=KEY_FILE
	      Sign  the	 revocation certificate	using the key in KEY_FILE.  If
	      the key is  different  from  the	certificate,  this  creates  a
	      third-party revocation.  If this option is not provided, and the
	      certificate  includes secret key material, then that key is used
	      to sign the revocation certificate.

	REASON
	      The reason for the revocation.  This must	 be  either:  `compro-
	      mised`, `superseded`, `retired`, or `unspecified`:

		-  `compromised`  means	 that the secret key material may have
	      been
		  compromised.	Prefer this value if you suspect that the  se-
	      cret
		  key has been leaked.

		- `superseded` means that the owner of the certificate has re-
	      placed
		  it  with a new certificate.  Prefer `compromised` if the se-
	      cret
		  key material has been	compromised even if the	certificate is
	      also
		  being	replaced!  You should include the fingerprint  of  the
	      new
		  certificate in the message.

		-  `retired`  means  that  this	certificate should not be used
	      anymore,
		  and there is no replacement.	This is	appropriate when some-
	      one
		  leaves an organisation.  Prefer `compromised`	if the	secret
	      key
		  material  has	 been  compromised  even if the	certificate is
	      also
		  being	retired!  You should include how to contact the	owner,
	      or
		  who to contact instead in the	message.

		- `unspecified`	means that none	of the three other three  rea-
	      sons
		  apply.   OpenPGP  implementations  conservatively treat this
	      type
		  of revocation	similar	to a compromised key.

	      If the reason happened in	the past, you should specify that  us-
	      ing  the `--time`	argument.  This	allows OpenPGP implementations
	      to more accurately reason	about objects whose  validity  depends
	      on the validity of the certificate.

	      [possible	values:	compromised, superseded, retired, unspecified]

	MESSAGE
	      A	short, explanatory text	that is	shown to a viewer of the revo-
	      cation  certificate.   It	 explains why the certificate has been
	      revoked.	For instance, if Alice has  created  a	new  key,  she
	      would generate a `superseded` revocation certificate for her old
	      key,  and	might include the message `I've	created	a new certifi-
	      cate, FINGERPRINT, please	use that in the	future.`

   Global options
       See sq(1) for a description of the global options.

SEE ALSO
       sq(1), sq-key(1).

       For the full documentation see <https://book.sequoia-pgp.org>.

VERSION
       0.36.0 (sequoia-openpgp 1.20.0)

Sequoia	PGP			    0.36.0				 SQ(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sq-key-revoke&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help