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

FreeBSD Manual Pages

  
 
  

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

NAME
       sq key userid - Manage User IDs

SYNOPSIS
       sq key userid add [OPTIONS] FILE	USERID
       sq key userid revoke [OPTIONS] USERID REASON MESSAGE
       sq key userid strip [OPTIONS] FILE

DESCRIPTION
       Manage User IDs.

       Add User	IDs to,	or strip User IDs from a key.

SUBCOMMANDS
   sq key userid add
       Add a User ID.

       A  User	ID can contain a name, like `Juliet` or	an email address, like
       `<juliet@example.org>`.	Historically, a	name and  email	 address  were
       often combined as a single User ID, like	`Juliet	<juliet@example.org>`.

       `sq  userid  add`  respects  the	 reference  time  set by the top-level
       `--time`	argument.  It sets the creation	time of	the User ID's  binding
       signature to the	specified time.

   sq key userid revoke
       Revoke a	User ID.

       Creates a revocation certificate	for a User ID.

       If  `--revocation-key` 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-key`  is  not provided, then the certificate must in-
       clude a certification-capable key.

       `sq key userid 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.

   sq key userid strip
       Strip a User ID.

       Note  that this operation does not reliably remove User IDs from	a cer-
       tificate	that has already been disseminated!  (OpenPGP  software	 typi-
       cally  appends  new  information	it receives about a certificate	to its
       local copy of that certificate.	Systems	that have obtained a  copy  of
       your certificate	with the User ID that you are trying to	strip will not
       drop that User ID from their copy.)

       In  most	 cases,	you will want to use the 'sq key userid	revoke'	opera-
       tion instead.  That issues a revocation for a User  ID,	which  can  be
       used to mark the	User ID	as invalidated.

       However,	 this  operation can be	useful in very specific	cases, in par-
       ticular:	to remove a mistakenly added User ID before it	has  been  up-
       loaded to key servers or	otherwise shared.

       Stripping  a User ID may	change how a certificate is interpreted.  This
       is because information about the	 certificate  like  algorithm  prefer-
       ences,  the  primary  key's  key	flags, etc. is stored in the User ID's
       binding signature.

EXAMPLES
   sq key userid add
       First, generate a key:

	      sq key generate --userid '<juliet@example.org>' \
		     --output juliet.key.pgp

       Then, add a User	ID:

	      sq key userid add	--userid Juliet	juliet.key.pgp \
		     --output juliet-new.key.pgp

       Or, add a User ID whose creation	time is	set to June 28,	2022  at  mid-
       night UTC:

	      sq key userid add	--userid Juliet	--creation-time	20210628 \
		     juliet.key.pgp --output juliet-new.key.pgp

   sq key userid strip
       First, generate a key:

	      sq key generate --userid '<juliet@example.org>' \
		     --output juliet.key.pgp

       Then, strip a User ID:

	      sq key userid strip --userid '<juliet@example.org>' \
		     --output juliet-new.key.pgp juliet.key.pgp

SEE ALSO
       sq(1),	 sq-key(1),   sq-key-userid-add(1),   sq-key-userid-revoke(1),
       sq-key-userid-strip(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-userid&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help