Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gvmd: init at 23.4.0 #303758

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

gvmd: init at 23.4.0 #303758

wants to merge 2 commits into from

Conversation

Tochiaha
Copy link
Contributor

@Tochiaha Tochiaha commented Apr 13, 2024

Release: https://github.com/greenbone/gvmd/releases/tag/v23.4.0

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@Tochiaha Tochiaha changed the title openvas: init at 23.4.0 gvmd: init at 23.4.0 Apr 13, 2024
@Tochiaha
Copy link
Contributor Author

referencing #81418

@ofborg ofborg bot added 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild 10.rebuild-linux: 1-10 10.rebuild-linux: 1 labels Apr 13, 2024
@Tochiaha Tochiaha force-pushed the gvmd branch 2 times, most recently from 8a762c8 to f845c22 Compare April 15, 2024 15:03
pkgs/by-name/gv/gvmd/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/gv/gvmd/package.nix Show resolved Hide resolved
pkgs/by-name/gv/gvmd/package.nix Show resolved Hide resolved
pkgs/by-name/gv/gvmd/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/gv/gvmd/package.nix Outdated Show resolved Hide resolved

buildPhase = ''
substituteInPlace $src/src/sql_pg.c --replace "#include postgresql/libpq-fe.h" "#include ${postgresql}/include/libpq-fe.h"
mkdir -p $out/{bin,etc,sbin,lib,usr/{share,include},run/gvmd/gvmd.pid}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

share and include are expected in $out, not $out/usr. Is there a particular reason not to use this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need for the $out/usr will rely on the cmakeflags destination.

pkgs/by-name/gv/gvmd/package.nix Outdated Show resolved Hide resolved
@ofborg ofborg bot added 10.rebuild-darwin: 1-10 10.rebuild-darwin: 1 and removed 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild labels Apr 18, 2024
@Tochiaha
Copy link
Contributor Author

#305096 needed for gvmd

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/4075

'';

meta = with lib; {
description = "The central management service between security scanners and the user clients";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description = "The central management service between security scanners and the user clients";
description = "Central management service between security scanners and the user clients";

The policy has changed https://github.com/NixOS/nixpkgs/tree/master/pkgs#meta-attributes

postInstall = ''
mkdir -p \
$out/var/lib/gvm/gvmd/gvm-checking \
$out/run/gvmd/gvmd.pid
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two should not be needed. If there is a reason, write in the comment above postInstall.

Copy link
Contributor Author

@Tochiaha Tochiaha Jul 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what will be the best way to approach this error. reason for the postintsall.

pkgs/by-name/gv/gvmd/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/gv/gvmd/package.nix Show resolved Hide resolved
pkgs/by-name/gv/gvmd/package.nix Outdated Show resolved Hide resolved
pkgs/by-name/gv/gvmd/package.nix Outdated Show resolved Hide resolved
@Tochiaha Tochiaha force-pushed the gvmd branch 2 times, most recently from f1da724 to 6c10d5b Compare July 6, 2024 15:45
@Tochiaha
Copy link
Contributor Author

In between build time Flags are what's left.

@superherointj
Copy link
Contributor

@Tochiaha Please, ask someone else to review this PR. The inputs I could offer, I already did. And I don't really understand how this application works. And how things are arranged. So my judgement here is not a good one.

@superherointj superherointj dismissed their stale review July 23, 2024 19:19

I don't know.

@Tochiaha
Copy link
Contributor Author

for reference it needs some other GVM package and Pgsql from this https://greenbone.github.io/docs/latest/22.4/source-build/index.html#id115 line down shows the setup. also when "gvmd --create-user=admin --password=''" is used it logs error regading roles and user for DB pgsql in $out/var/log/gvm/gvmd.log and run time. creating user and role with Pgsql and executing "gvmd --create-user=admin --password=''" results in this ouput "User created" which shows build time and runtime successful for gvmd. Achitecture for gvm can be seen here for better understanding https://greenbone.github.io/docs/latest/architecture.html#id1

@Tochiaha
Copy link
Contributor Author

As recommended @fabaff can help he done other required packages of GVM.

@superherointj superherointj marked this pull request as ready for review July 23, 2024 22:56
@superherointj
Copy link
Contributor

superherointj commented Jul 24, 2024

for reference it needs some other GVM package and Pgsql from this https://greenbone.github.io/docs/latest/22.4/source-build/index.html#id115 line down shows the setup. also when "gvmd --create-user=admin --password=''" is used it logs error regading roles and user for DB pgsql in $out/var/log/gvm/gvmd.log and run time. creating user and role with Pgsql and executing "gvmd --create-user=admin --password=''" results in this ouput "User created" which shows build time and runtime successful for gvmd. Achitecture for gvm can be seen here for better understanding https://greenbone.github.io/docs/latest/architecture.html#id1

I really don't understand what you are doing.

$out/var/log/gvm/gvmd.log

This makes no sense to me. Because the nix store is not writable. How/why are you saving logs there?

My guess is, you are packaging a service which needs a NixOS module. I've already tried to explain to you this. Continuously I see red flags in what you are doing. And you don't seem to understand what I tell you.

There is a distinction between what is to be done at build time and what is to be done at runtime. And a package is not part of the runtime. Any runtime consideration should be sorted at a NixOS module. The package can only set a default value. It's static.

So far you have not answered how you are executing the application. How is this being run at runtime? Why you continuously add runtime concerns to a package?

I don't have context of this application. I think you need feedback from someone that knows best. Which is not me. Still. I highly recommend you to add other reviews. I think, you should seek help. Particularly from someone that understand what you are doing.

@superherointj
Copy link
Contributor

superherointj commented Jul 24, 2024

@Tochiaha

  1. How is this application being executed?
  2. Is this a service?
  3. If this is a service, consider a NixOS service module for it.
  4. Add more reviewers. (We need feedback here.)

@superherointj
Copy link
Contributor

superherointj commented Jul 24, 2024

Most of these parameters shouldn't go to the nix store. The package is just a default value for these parameters. And it should be a standard system parameter, no $out (which is nix store). Then, there are the runtime concerns I told you. Which is separate of the package.

-DDATADIR=$out/share \
-DGVM_SYSCONF_DIR=$out/etc/gvm \
-DGVM_DATA_DIR=$out/share/gvm \
-DGVM_STATE_DIR=$out/var/lib/gvm \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

State in the nix store?

-DGVMD_MAN_DIR=$out/share \
-DDATADIR=$out/share \
-DGVM_SYSCONF_DIR=$out/etc/gvm \
-DGVM_DATA_DIR=$out/share/gvm \
Copy link
Contributor

@superherointj superherointj Jul 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which kind of data is this?

-DINCLUDEDIR=$out/include \
-DGMP_DIR=$out/share \
-DGVMD_MAN_DIR=$out/share \
-DDATADIR=$out/share \
Copy link
Contributor

@superherointj superherointj Jul 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
-DDATADIR=$out/share \
-DDATADIR=$out/share \

Which kind of data is this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

without it result to https://termbin.com/bdhv

-DBINDIR=$out/bin \
-DSBINDIR=$out/sbin \
-DLIBDIR=$out/lib \
-DLOCALSTATEDIR=$out/var \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
-DLOCALSTATEDIR=$out/var \
-DLOCALSTATEDIR=$out/var \

State in the nix store?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

without it result to https://termbin.com/bdhv

-DGVM_SYSCONF_DIR=$out/etc/gvm \
-DGVM_DATA_DIR=$out/share/gvm \
-DGVM_STATE_DIR=$out/var/lib/gvm \
-DGVMD_STATE_DIR=$out/var/lib/gvm/gvmd \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
-DGVMD_STATE_DIR=$out/var/lib/gvm/gvmd \
-DGVMD_STATE_DIR=$out/var/lib/gvm/gvmd \

State in the nix store?

-DGVM_STATE_DIR=$out/var/lib/gvm \
-DGVMD_STATE_DIR=$out/var/lib/gvm/gvmd \
-DGVM_LIB_INSTALL_DIR=$out/lib \
-DGVMD_RUN_DIR=$out/run/gvmd \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
-DGVMD_RUN_DIR=$out/run/gvmd \
-DGVMD_RUN_DIR=$out/run/gvmd \

Is it a pid? If it is it shouldn't be in the nix store.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this?

@Tochiaha
Copy link
Contributor Author

Tochiaha commented Jul 24, 2024

@Tochiaha

1. How is this application being executed?

2. Is this a service?

3. If this is a service, consider a NixOS service module for it.

4. Add more reviewers. (We need feedback here.)

i can still do NixOS service module but consider this https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/tools/security/ospd-openvas/default.nix#L45 @mweinelt any help here?

@mweinelt
Copy link
Member

Not interested in this package. Did only contribute a drive-by fix.

@Tochiaha
Copy link
Contributor Author

Thank you.

@superherointj
Copy link
Contributor

superherointj commented Jul 26, 2024

i can still do NixOS service module but consider this https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/tools/security/ospd-openvas/default.nix#L45 @mweinelt any help here?

The NixOS module may be optional, but offering invalid paths as default paths for package was the main issue.
nix store paths are read only, hence no pid, socks, logs, state, data?.
In the package, you can only hard code paths.
To pass through customized paths, a NixOS module is convenient, particularly for runtime considerations.

Note that, at this point in time, we are seeking to clarify the arguments purposes and values. I have asked you several questions (for each argument). Try to answer them. We need to clarify if these arguments are correct. Once that is done, I don't have objections with this PR.

@Tochiaha
Copy link
Contributor Author

Working on it.


preFixup = ''
substituteInPlace $out/lib/systemd/system/gvmd.service \
--replace-fail "/run/ospd/ospd-openvas.sock" "${ospd-openvas}/run/ospd/ospd-openvas.sock"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A sock shouldn't exist in the nix store... That wouldn't be write-able.

@superherointj superherointj marked this pull request as draft August 2, 2024 14:41
Co-authored-by: Wolfgang Walther <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants