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

FreeBSD Manual Pages

  
 
  

home | help
hiq(1)			    General Commands Manual			hiq(1)

NAME
       hiq - query the himitsu(7) key store

SYNOPSIS
       hiq [-h1adelLQRs] [-c pair] [-F field] query...

DESCRIPTION
       hiq will	query the Himitsu key store for	keys matching the given	query.
       For details on the query	format,	consult	himitsu(7) under QUERY SYNTAX.
       Matching	 keys will be printed to the standard output in	the format de-
       scribed by himitsu(7) under KEY FORMAT.

       The user	is not required	to use redundant shell quoting to escape  keys
       or  values  with	special	characters; the	command	line arguments are in-
       terpreted as if they have already been quoted properly.

   OPTIONS
       -h
	   Print help text.

       -1
	   Causes hiq to exit with a non-zero status code if greater than  one
	   key matched the given query.

       -a
	   Adds	a new key to the key store. The	query must be fully specified,
	   such	 that  each key	has a value and	there are no optional keys. If
	   no command line arguments are provided, new keys are	read from  the
	   standard input. Using the standard input is recommended when	adding
	   keys	from an	interactive shell, to prevent secret values from being
	   stored in your shell	history.

       -c pair
	   Change  a  key/value	pair of	all matched entries. If	the key	has no
	   value the pair will be removed from the entries. If it has a	 value
	   it will be added or changed if exists.

       -d
	   Request decryption of secret	keys.

       -e
	   Edit	 all  matched  entries	by  providing  changes	via stdin. The
	   changes must	be provided as a query,	where all keys without	values
	   will	 be  removed from the entries and keys with values will	change
	   the values or of the	matching keys or will add them if  they	 don't
	   exist.

       -F field
	   Select  a  specific	field  to  print.  By default, the full	key is
	   printed in the format described by KEY FORMAT in himitsu(7).

       -l
	   Soft	locks the keyring by removing  the  secret  key	 from  memory.
	   Keeps non-private data of entries in	memory.

       -L
	   Hard	 locks	the keyring by removing	the secret key and all entries
	   from	memory.

       -Q
	   Terminate the Himitsu daemon. Only works if himitsud(1) was started
	   with	the -D flag.

       -R
	   Remove all keys from	the key	store matching the query. The user  is
	   prompted to consent before this operation is	committed.

       -s
	   Enable  strict  query  mode.	 Entries  must not have	more keys than
	   specified by	the query in order to be matched.

EXAMPLES
       To query	for all	keys matching proto=web:

	   $ hiq proto=web

       To query	for a key matching proto=web and host=example.org with	a  re-
       quired username and password and	an optional comment:

	   $ hiq proto=web host=example.org username password! comment?

       To query	for a key and decrypt it, returning the	password field alone:

	   $ hiq -dFpassword proto=web host=example.org

       To add a	new key	to the store:

	   $ hiq -a
	   proto=web host=example.org user=jdoe	password!=hunter2

       To delete all keys matching host=example.org:

	   $ hiq -R host=example.org

SEE ALSO
       himitsu(7), himitsu-ipc(5)

AUTHORS
       Maintained  by  Drew  DeVault <sir@cmpwn.com>, who is assisted by other
       contributors.   Up-to-date   source    code    can    be	   found    at
       https://git.sr.ht/~sircmpwn/himitsu,  and bugs/patches can be submitted
       by email	to ~sircmpwn/himitsu-devel@lists.sr.ht.

				  2026-06-13				hiq(1)

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

home | help