bonsai/harakit
5
4
Fork 3
Code Issues 42 Pull Requests 5 Projects 1 Releases 34 Activity

peek(1) #93

Closed
trinity wants to merge 25 commits from peek into main
pull from: peek
merge into: bonsai:main
Conversation 13 Commits 25 Files Changed 4 +72 -52
1 changed files with 72 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 3db83fd79c - Show all commits

124
docs/peek.1
View File

@ -1,90 +1,110 @@
.\" Copyright (c) 2023-2024 DTB <trinity@trinity.moe>
.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
.\"
.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
.TH PEEK 1
.\"
.TH PEEK 1 2024-06-09 "Bonsai Core Utilites 0.13.9"
trinity marked this conversation as resolved Outdated
emma commented 2024-06-26 17:03:05 -06:00
Outdated
Review
Copy Link

.TH PEEK 1 [whenever you make the change] "Harakit X.X.X"

> .TH PEEK 1 [whenever you make the change] "Harakit X.X.X"
.SH NAME
peek \(en read from the standard input, furtively
.\"
.SH SYNOPSIS
peek
.RB ( -i )
.\"
.SH DESCRIPTION
Peek reads input from the standard input with terminal echo disabled.
Read input from the standard input with terminal echo disabled.
.\"
.SH OPTIONS
.B -i
.RS
Allows input to come from sources other than terminals (i.e. a pipe).
.RE
.IP \fB-i\fP
emma marked this conversation as resolved Outdated
emma commented 2024-04-17 22:30:03 -06:00
Outdated
Review
Copy Link

Peek reads input from standard input with terminal echo disabled,

Read input from the standard input with terminal echo disabled.

which may be useful to prevent secrets being spied upon by adversaries watching a user's
screen.

Should this be placed in a RATIONALE section?

> Peek reads input from standard input with terminal echo disabled, Read input from the standard input with terminal echo disabled. > which may be useful to prevent secrets being spied upon by adversaries watching a user's screen. Should this be placed in a RATIONALE section?
Allows input to come from sources other than terminals (i.e., a pipe).
trinity marked this conversation as resolved Outdated
silt commented 2024-06-17 22:43:04 -06:00
Outdated
Review
Copy Link

This appears to imply that there exists a multitude of other possible sources, but it's not made clear what those are or how to make use of them. Does it support reading input from… files? TCP sockets? IRC messages??

This appears to imply that there exists a multitude of other possible sources, but it's not made clear what those are or how to make use of them. Does it support reading input from… files? TCP sockets? IRC messages??
trinity commented 2024-06-26 09:37:45 -06:00
Outdated
Review
Copy Link

The "i.e." stands for "id est" and can be read as "in other words". Perhaps I should use the English. I mean to say that the source other than a terminal, in this case, is a pipe.

The "i.e." stands for "id est" and can be read as "in other words". Perhaps I should use the English. I mean to say that the source other than a terminal, in this case, is a pipe.
trinity commented 2024-06-26 09:57:33 -06:00
Outdated
Review
Copy Link

Changed to (pipes) which I think is more clear.

Changed to (pipes) which I think is more clear.
.\"
.SH DIAGNOSTICS
Peek prints an error message and exits with the appropriate status from
sysexits.h(3) if it encounters an unrecoverable error.
Peek tries to handle the signal SIGINT (^C) to ensure the user's terminal is
still usable after premature termination; if the signal can't be handled, it
prints an error message and continues. If peek is interrupted, it exits
unsuccessfully, without an error message.
In the event of an error, a debug message will be printed and the program will
exit with the appropriate
.BR sysexits.h (3)
error code.
emma marked this conversation as resolved Outdated
emma commented 2024-05-24 10:30:44 -06:00
Outdated
Review
Copy Link

In the event of an error, a debug message will be printed and the program will
exit with the appropriate sysexits.h(3) error code.

For parity with the man pages in the docs branch. For example, see npc.1.

> In the event of an error, a debug message will be printed and the program will exit with the appropriate sysexits.h(3) error code. For parity with the man pages in the `docs` branch. For example, see [`npc.1`](https://git.tebibyte.media/bonsai/coreutils/src/commit/b7f52902b6bde54876b5fd8efafa433e2cf0df9a/docs/npc.1#L44).
In order to ensure the user\(cqs terminal is still usable after premature
termination, the program attempts to handle the SIGINT signal; if it cannot,
emma marked this conversation as resolved Outdated
emma commented 2024-05-24 10:33:18 -06:00
Outdated
Review
Copy Link

If it encounters a SIGINT signal (^C), the program will attempt to handle it to ensure the user’s terminal is still usable after premature termination; if the signal can’t be handled, it prints an error message and continues. If the program is interrupted, it exits unsuccessfully and without printing an error message.

If it encounters a SIGINT signal (^C), the program will attempt to handle it to ensure the user’s terminal is still usable after premature termination; if the signal can’t be handled, it prints an error message and continues. If the program is interrupted, it exits unsuccessfully and without printing an error message.
an error message is printed and execution continues. If the program is
interrupted, it exits unsuccessfully without an error message.
.\"
.SH RATIONALE
This tool was originally written to accept passwords in shell scripts, as an
extremely simple alternative to the GNU Privacy Guard project's pinentry(1).
This tool was originally written to accept passwords in shell scripts as an
extremely simple alternative to the GNU Privacy Guard project\(cqs
.BR pinentry (1)
utility.
Accepting input without showing what is being typed is useful when keying in
secrets in public settings or places with installed surveillance cameras.
secrets in public settings or in places where surveillance cameras are
installed.
.\"
emma marked this conversation as resolved Outdated
emma commented 2024-05-24 10:27:14 -06:00
Outdated
Review
Copy Link

This being in the BUGS section implies that this can be fixed by the program. Therefore, this belongs in a CAVEATS section because it is definitionally a caveat.

This being in the BUGS section implies that this can be fixed by the program. Therefore, this belongs in a CAVEATS section because it is definitionally a caveat.
.SH CAVEATS
trinity marked this conversation as resolved Outdated
emma commented 2024-04-17 22:30:36 -06:00
Outdated
Review
Copy Link

“[...] the standard output”

“[...] the standard output”
.SH BUGS
This program does nothing to prevent others from seeing the key presses input to
a keyboard. It also does not protect against the sound of typing being analyzed
trinity marked this conversation as resolved Outdated
emma commented 2024-04-17 22:31:40 -06:00
Outdated
Review
Copy Link

What is the benefit to this over using a shell pipe?

What is the benefit to this over using a shell pipe?
to determine what was inputted without needing to see screen or keyboard.
This does nothing to prevent others seeing the keyboard being used to input
secrets or mask the sound of typing. Audio or video recordings of typing can be
used to determine what was input without needing to see the characters appear
on the screen.
Accepting secrets in shell scripts is probably not adviseable.
On systems that support it, the ioctl(2) command TIOCSTI can be used to insert
characters into the standard input going to peek. This doesn't allow snooping
but can be used for general mischief.
Accepting secrets in shell scripts is probably not advisable.
On systems that support it, the
.BR ioctl (2)
command TIOCSTI can be used to insert characters into the standard input. This
doesn't allow snooping but can be used for general mischief.
.\"
.SH EXAMPLES
This is an sh(1p) command line that hashes a given password. It uses head(1p)
to only accept one line of input, xargs(1p) and printf(1p) to strip the
trailing newline, htpasswd(1) from Apache's utilities to hash the input with
the bcrypt algorithm, and cut(1p) to print only the resulting hash:
This is an
.BR sh (1p)
command line that hashes a given password. It uses
.BR head (1p)
to only accept one line of input,
.BR xargs (1p)
and
.BR printf (1p)
to strip the trailing newline,
.BR htpasswd (1)
emma marked this conversation as resolved Outdated
emma commented 2024-05-24 10:36:38 -06:00
Outdated
Review
Copy Link

It uses mm(1) to pipe the hidden input to both the standard error and the regular file writing.txt.

> It uses mm(1) to pipe the hidden input to both the standard error and the regular file writing.txt.
from Apache\(cqs utilities to hash the input with the bcrypt algorithm, and
.BR cut (1p)
to print only the resulting hash:
.RS
.R $ peek | head -n 1 | xargs printf '%s' | htpasswd -nBi _ | cut -d : -f 2
$ peek | head -n 1 | xargs printf '%s' | htpasswd -nBi _ | cut -d : -f 2
.RE
This is an sh(1p) command line that lets a user blindly write into a text file,
only able to see written lines. Some writers have the habit of prematurely
revising their work and use tools like this to prevent it. It uses mm(1) to
pipe the output of peek to both the standard error and the regular file
writing.txt.
This is an
.BR sh (1p)
command line that allows a user to write blindly into a text file but displaying
only written lines. Some writers have the habit of prematurely revising their
work and use tools with functionality similar to this to prevent it.
It uses
.BR mm (1)
to pipe the output of the program to both the standard error and the regular
file writing.txt:
.RS
.R $ echo Input ^D to quit. && peek | mm -eo - >writing.txt
$ echo Input ^D to quit. && peek | mm -eo - >writing.txt
.RE
.\"
.SH AUTHOR
Written by DTB <trinity@trinity.moe>.
Written by DTB
trinity marked this conversation as resolved Outdated
emma commented 2024-04-17 22:33:35 -06:00
Outdated
Review
Copy Link

Either:

This is a POSIX shell [...]

or:

This is an sh(1p) [...]

Either: > This is a POSIX shell [...] or: > This is an sh(1p) [...]
.MT trinity@trinity.moe
.ME .
.\"
.SH COPYRIGHT
Copyright (c) 2023-2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
Copyright \(co 2023-2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/gpl.html>.
.\"
.SH SEE ALSO
ioctl(2), ioctl_tty(2), read(1), sh(1)
.BR ioctl (2),
.BR ioctl_tty (2),
.BR read (1),
.BR sh (1)