Bug 1819180 - Review Request: ssh-chat - custom ssh server which serves a chat room instead of a shell
Summary: Review Request: ssh-chat - custom ssh server which serves a chat room inste...
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Ralf Senderek
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-03-31 12:08 UTC by Ralf Senderek
Modified: 2020-05-22 16:04 UTC (History)
5 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2020-05-22 16:04:23 UTC
Type: ---
Embargoed:
ppisar: fedora-review?


Attachments (Terms of Use)

Description Ralf Senderek 2020-03-31 12:08:50 UTC
Spec URL: https://senderek.ie/fedora/ssh-chat/ssh-chat.spec

SRPM URL: https://senderek.ie/fedora/ssh-chat/ssh-chat-1.8.2-1.fc32.src.rpm

Description: The program ssh-chat is an implementation of a ssh server which serves a chat room instead of a shell.
The focus of ssh-chat is on secure chat with small teams. Traditionally to 
achieve this with IRC, you'd setup an ssh server for your friends and run 
a local host IRC server on it that your friends would connect to by tunneling 
over ssh. ssh-chat achieves a similar level of security without setting up 
multiple servers and tunnels.

Fedora Account System Username: senderek

Comment 1 Weiping 2020-03-31 13:54:13 UTC
Hi,

This is a informal review:

# RPM Spec file for ssh-chat

> SOURCE0:   https://github.com/shazow/ssh-chat/archive/v1.8.2.tar.gz
use %{version}, so you don't have to update every update.


> %{_mandir}/man1/%{name}.1.gz
Don't assure that it's gziped, use wildcard is ok.


fedora-review failed to build this package, consider use koji build environment to test your pakcage:
https://fedoraproject.org/wiki/Using_the_Koji_build_system

+ cd /builddir/build/BUILD
+ cd ssh-chat-1.8.2
+ make -j40 build
go build  -ldflags="-B 0x8fed0b1e64bd7424a5e5bae0774d74d15f24add1" ./cmd/ssh-chat
go: github.com/alexcesaro/log.0-20150915221235-61e686294e58: invalid version: git fetch -f origin refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /builddir/go/pkg/mod/cache/vcs/016624ec8fded143255b88378860b2bc8e5ac782133a7bec312d6e53ef83caea: exit status 128:
        fatal: unable to access 'https://github.com/alexcesaro/log/': Could not resolve host: github.com
make: *** [Makefile:12: ssh-chat] Error 1
error: Bad exit status from /var/tmp/rpm-tmp.8vUrau (%build)
    Bad exit status from /var/tmp/rpm-tmp.8vUrau (%build)
RPM build errors:
Child return code was: 1
EXCEPTION: [Error()]
Traceback (most recent call last):
  File "/usr/lib/python3.7/site-packages/mockbuild/trace_decorator.py", line 93, in trace
    result = func(*args, **kw)
  File "/usr/lib/python3.7/site-packages/mockbuild/util.py", line 755, in do_with_status
    raise exception.Error("Command failed: \n # %s\n%s" % (command, output), child.returncode)
mockbuild.exception.Error: Command failed:
 # /usr/bin/systemd-nspawn -q -M 025217b1e6ca4b90a70774bca9676600 -D /var/lib/mock/fedora-rawhide-x86_64/root -a --capability=cap_ipc_lock --bind=/tmp/mock-resolv.397tvh29:/etc/resolv.conf --bind=/dev/loop-control --bind=/dev/loop0 --bind=/dev/loop1 --bind=/dev/loop2 --bind=/dev/loop3 --bind=/dev/loop4 --bind=/dev/loop5 --bind=/dev/loop6 --bind=/dev/loop7 --bind=/dev/loop8 --bind=/dev/loop9 --bind=/dev/loop10 --bind=/dev/loop11 --console=pipe --setenv=TERM=vt100 --setenv=SHELL=/bin/bash --setenv=HOME=/builddir --setenv=HOSTNAME=mock --setenv=PATH=/usr/bin:/bin:/usr/sbin:/sbin --setenv=PROMPT_COMMAND=printf "\033]0;<mock-chroot>\007" --setenv=PS1=<mock-chroot> \s-\v\$  --setenv=LANG=en_US.UTF-8 -u mockbuild bash --login -c /usr/bin/rpmbuild -bb --target x86_64 --nodeps /builddir/build/SPECS/ssh-chat.spec

Comment 2 Ralf Senderek 2020-03-31 14:42:58 UTC
(In reply to Weiping from comment #1)
> Hi,
> 
> This is a informal review:
> 
> # RPM Spec file for ssh-chat
> 
> > SOURCE0:   https://github.com/shazow/ssh-chat/archive/v1.8.2.tar.gz
> use %{version}, so you don't have to update every update.
> 

Done.

> 
> > %{_mandir}/man1/%{name}.1.gz
> Don't assure that it's gziped, use wildcard is ok.

Done.

> 
> fedora-review failed to build this package, 

The reason for this is that mock needs the option --enable-network

It took me a time too, to figure out that the following command
finishes the mock build:

      fedora-review -v -o "\-\-enable-network" -n ssh-chat

SPEC and SRPM files are updated.

Thanks.

Comment 3 Zbigniew Jędrzejewski-Szmek 2020-03-31 19:24:11 UTC
Interesting package ;)

> The reason for this is that mock needs the option --enable-network

That will not work. Packages must build without network access, see
https://docs.fedoraproject.org/en-US/packaging-guidelines/#_build_time_network_access.
This must be fixed.

Some more suggestions:
make %{?_smp_mflags} build → %make_build build

> # RPM Spec file for ssh-chat
I'd remove that, because it's pretty obvious that ssh-chat.spec is a spec file for ssh-chat.

%setup -q
%patch1 -p1
→ %autosetup -p1

mkdir -p %{buildroot}%{_bindir}
cp %{_builddir}/%{name}*-%{version}/ssh-chat %{buildroot}%{_bindir}
→ install -Dt %{buildroot}%{_bindir} %{name}*-%{version}/ssh-chat

and similarly for the man page.

To make this work out of the box, please provide a systemd unit file.
That way users will be able to comfortably start and stop the daemon.
Something like this:
[Service]
ExecStart=ssh-chat
DynamicUser=1

[Install]
WantedBy=multi-user.target

I'm not sure what kind of privileges this daemon requires.
Generally, not running it as root would be a great improvement (the
DynamicUser=1 option), but depending on required privileges, this might
not be possible.
See also https://docs.fedoraproject.org/en-US/packaging-guidelines/Systemd/.

Comment 4 Ralf Senderek 2020-04-01 06:09:15 UTC
(In reply to Zbigniew Jędrzejewski-Szmek from comment #3)


Zbigniew.
thanks for your suggestions.

> Interesting package ;)
> 
> > The reason for this is that mock needs the option --enable-network
> 
> That will not work. Packages must build without network access, see
> https://docs.fedoraproject.org/en-US/packaging-guidelines/
> #_build_time_network_access.
> This must be fixed.

I know that. And I'm working on a solution. This might become the one show stopper.

Ralf

Comment 5 Ralf Senderek 2020-04-01 11:51:11 UTC
(In reply to Zbigniew Jędrzejewski-Szmek from comment #3)

I will create a systemd unit file, when I have removed the show stopper
above. I think this will be no problem since the custom ssh server can be
invoked by any ordinary user as far as my current tests on a local
machine tell me. If the custom port (default:2022) is open or alternatively users can
ssh into the server and then access localhost:2022, they can join the chat room.
No root permissions are neccessary.

> To make this work out of the box, please provide a systemd unit file.
> That way users will be able to comfortably start and stop the daemon.
> Something like this:
> [Service]
> ExecStart=ssh-chat
> DynamicUser=1
> 
> [Install]
> WantedBy=multi-user.target
> 
> I'm not sure what kind of privileges this daemon requires.
> Generally, not running it as root would be a great improvement (the
> DynamicUser=1 option), but depending on required privileges, this might
> not be possible.
> See also https://docs.fedoraproject.org/en-US/packaging-guidelines/Systemd/.

Comment 6 Ralf Senderek 2020-04-01 17:39:37 UTC
A systemd unit file has been added.

Some of the golang dependencies could be resolved by using existing golang-github devel packages.
There are still two dependecies that cannot be resolved:
    
     golang-github-alexcesaro-log
     and possibly
     golang-github-shazow-ssh-chat
     

The SPEC and SRPM files have been updated.

Comment 7 Ralf Senderek 2020-04-09 17:17:45 UTC
So the MOCK build problem is resolved.

SRPM and SPEC files are updated.

And a successful KOJI scratch build for F32 is here:

https://koji.fedoraproject.org/koji/taskinfo?taskID=43168846

Comment 8 Ralf Senderek 2020-04-10 12:00:07 UTC
The new systemd unit makes sure that the program is run as an UNPRIVILEGED user.

Comment 9 Ralf Senderek 2020-04-17 17:01:26 UTC
Just in case anyone is confused, this package is fit for a formal review since Thursday, 9th of April.

Comment 10 Petr Menšík 2020-04-29 23:24:47 UTC
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed


Issues:
=======
- systemd_post is invoked in %post, systemd_preun in %preun, and
  systemd_postun in %postun for Systemd service files.
  Note: Systemd service file(s) in ssh-chat
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/Scriptlets/#_scriptlets


===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: There is no build directory. Running licensecheck on vanilla
     upstream sources. Licenses found: "Unknown or generated", "Expat
     License", "BSD 3-clause "New" or "Revised" License". 83 files have
     unknown license. Detailed output of licensecheck in
     /home/reviewer/fedora/rawhide/1819180-ssh-chat/licensecheck.txt
[!]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/systemd/system,
     /usr/lib/systemd
[x]: %build honors applicable compiler flags or justifies otherwise.
[!]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[?]: Macros in Summary, %description expandable at SRPM build time.
     Note: Macros in: ssh-chat (description)
     is %gopkg on correct place?
[-]: Package contains desktop file if it is a GUI application.
[!]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[!]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[x]: Package contains systemd file(s) if in need.
[x]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 2 files.
[!]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[x]: SourceX tarball generation or download is documented.
     Note: Package contains tarball without URL, check comments
[?]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[-]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on debuginfo package(s).
     Note: No rpmlint messages.
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: ssh-chat-1.8.2-1.fc33.x86_64.rpm
          ssh-chat-1.8.2-1.fc33.src.rpm
ssh-chat.x86_64: W: spurious-executable-perm /usr/share/man/man1/ssh-chat.1.gz
ssh-chat.x86_64: W: dangerous-command-in-%post chown
ssh-chat.x86_64: W: dangerous-command-in-%postun rm
ssh-chat.src: W: strange-permission ssh-chatd 755
ssh-chat.src: E: specfile-error warning: -u use in %forgemeta is deprecated, use -z instead to select a separate set of rpm variables!
2 packages and 0 specfiles checked; 1 errors, 4 warnings.




Rpmlint (debuginfo)
-------------------
Checking: ssh-chat-debuginfo-1.8.2-1.fc33.x86_64.rpm
1 packages and 0 specfiles checked; 0 errors, 0 warnings.





Rpmlint (installed packages)
----------------------------
ssh-chat.x86_64: W: invalid-url URL: https://travis-ci.org/shazow/ssh-chat <urlopen error [Errno -2] Name or service not known>
ssh-chat.x86_64: W: spurious-executable-perm /usr/share/man/man1/ssh-chat.1.gz
ssh-chat.x86_64: W: dangerous-command-in-%post chown
ssh-chat.x86_64: W: dangerous-command-in-%postun rm
ssh-chat-debuginfo.x86_64: W: invalid-url URL: https://travis-ci.org/shazow/ssh-chat <urlopen error [Errno -2] Name or service not known>
2 packages and 0 specfiles checked; 0 errors, 5 warnings.



Source checksums
----------------
https://github.com/shazow/ssh-chat/archive/v1.8.2.tar.gz :
  CHECKSUM(SHA256) this package     : b547ad9919f9432eaad6a5f5b9de9a686f525624c29dd268ae14128e81542726
  CHECKSUM(SHA256) upstream package : b547ad9919f9432eaad6a5f5b9de9a686f525624c29dd268ae14128e81542726


Requires
--------
ssh-chat (rpmlib, GLIBC filtered):
    /bin/sh
    /usr/bin/bash
    libc.so.6()(64bit)
    libpthread.so.0()(64bit)
    openssh
    rtld(GNU_HASH)
    shadow-utils



Provides
--------
ssh-chat:
    ssh-chat
    ssh-chat(x86-64)



Generated by fedora-review 0.7.5 (5fa5b7e) last change: 2020-02-16
Command line :/usr/bin/fedora-review -b 1819180
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api
Disabled plugins: SugarActivity, fonts, Ocaml, Perl, PHP, Java, R, Haskell, C/C++, Python
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH


---

Few notes:
I do not like what is done in %post script. Please move key generation to systemd oneshot unit. It should not generate something in post script. It should not definitely generate it as root and chown there.
Also, it seems /usr is used for configuration. Please create %{_sysconfdir}/ssh-chat and put key there. It does not belong to /usr. If just key is required and nothing else, %{_sysconfdir}/ssh-chat.key would be enough. Check unbound-keygen.service from unbound package as an example.

#BuildRequires:  golang(github.com/alexcesaro/log)
#BuildRequires:  golang(github.com/alexcesaro/log/golog)
#BuildRequires:  golang(github.com/shazow/rateio)
it would be better if they got their own review and depend on it as normal package. If they are reusable, please make them that way. At least they should have devel subpackage with correct provides in this package.

Please either add 
Requires: systemd

or

%files
... 
%dir %{_unitdir}

Comment 11 Petr Menšík 2020-04-29 23:32:57 UTC
Also, do not remove anything from postun. If keyfile would be declared %config and owned by package, at least as %ghost file, it would be removed by rpm. Such cleanup is dangerous and should not be used like this.

Comment 12 Ralf Senderek 2020-05-01 13:11:04 UTC
(In reply to Petr Menšík from comment #11)
> Also, do not remove anything from postun. If keyfile would be declared
> %config and owned by package, at least as %ghost file, it would be removed
> by rpm. Such cleanup is dangerous and should not be used like this.

%postun is now removed comletely. And SRPM and SPEC files are updated.

Comment 13 Ralf Senderek 2020-05-01 13:25:12 UTC
(In reply to Petr Menšík from comment #10)
> Package Review
> ==============
...
> ---
> 
> Few notes:
> I do not like what is done in %post script. Please move key generation to
> systemd oneshot unit. It should not generate something in post script. It
> should not definitely generate it as root and chown there.
> Also, it seems /usr is used for configuration. Please create
> %{_sysconfdir}/ssh-chat and put key there. It does not belong to /usr. If
> just key is required and nothing else, %{_sysconfdir}/ssh-chat.key would be
> enough. Check unbound-keygen.service from unbound package as an example.

I have created a oneshot systemd unit "ssh-chat-keygen.service" that creates 
the RSA key for the user sshchat in %{_sysconfdir}/ssh-chat. So all configuration
will be done here and not under /usr.
This leads to a cleaner spec file as %post %postun and %preun can now be removed
completely.


> #BuildRequires:  golang(github.com/alexcesaro/log)
> #BuildRequires:  golang(github.com/alexcesaro/log/golog)
> #BuildRequires:  golang(github.com/shazow/rateio)
> it would be better if they got their own review and depend on it as normal
> package. If they are reusable, please make them that way. At least they
> should have devel subpackage with correct provides in this package.

I have to disagree with you on this point, because this package does provide 
one single binary and no devel files nor any bundled libraries.
The files SOURCE5 and SOURCE6 are neccessary only to build the binary. They 
are additional source code, which is not available in another package.
Once someone else provides these packages as devel packages I will drop
SOURCE5 and SOURCE6 in favour of these devel packages. But I will not provide
anything more than the one binary, because I don't want other packages to become
dependent on this one.

As the source code is not signed by upstream I don't use gpgverify.

SRPM and SPEC files are updated.

Comment 14 Ralf Senderek 2020-05-22 16:04:23 UTC
I hereby show my sincere gratitude towards everyone who helped to bury this devious package request.


Note You need to log in before you can comment on or make changes to this bug.