tools: refactor hex parsing

deduplicate parsing into a `hex_to_bin_exact`

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

formatting fixup

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

api-macro: support raw method parameters

Support raw parameter name identifiers (eg. `r#type`)

    #[api(
        input: {
            properties: {
                type: {
                    type: String,
                    description: "Foo",
                },
            },
        },
    )]
    fn foo(r#type: String) { code... }

The "r#type" parameter in the fn decl will match the "type"
parameter name in the input property list.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump proxmox-api-macro version to 0.2.3

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

proxmox: loosen version requirement to api macro crate

allow updates of minor api-macro releases, breaking ones should get
the first or second version tuple bumped anyway.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

fix prefix for nested commands

Fixes a regression from commit f50a627f340ca2ae018079e431edd5a127638458
which resulted in re-using the prefix without sub-commands when calling
handle_simple_command(_future)

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

tfa: make AuthResponse fields public

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

make u2f registration challenge Deserialize

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

make u2f attestation certificate optional

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump proxmox to 0.7.0-1

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

totp: rename step to period

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump proxmox to 0.6.0-1

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

add proxmox::tools::tfa

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

test fixups

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

rpcenv: rename user to auth_id

since it does no longer store just a userid, but potentially an API
token identifier as well

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

api macro: reuse generated default const for "unwrap_or"

Instead of setting a default value to a const and inside an
.unwrap_or_else closure, lets set it only to the const and reuse that
later in .unwrap_or

To achieve that we move the "unrwap_or" code for param plumbing code generation
a bit later so that we have easy access to the generated const name.
As all this code is related to optional/default-value stuff it does read still
relatively OK with that change, IMO.

This has the advantage of not getting a warning like:

>  warning: constant is never used: `API_METHOD_EXAMPLE_FOO_PARAM_DEFAULT_FORCE`
>   --> src/api2/node/foo.rs
>    |
> XY |             force: {
>    |             ^^^^^
>    = note: `#[warn(dead_code)]` on by default

When one has a API endpoint like:

> #[api(
>     input: {
>         properties: {
>             force: {
>                 type: bool,
>                 optional: true,
>                 default: false,
>             },
>         },
>     },
>     ...
> )]
> /// Example
> fn example_foo(force: bool) -> Result<(), Error> {
>     if force {
>         // do something
>     }
>     Ok(())
> }

It effectively changes the output for optional parameters with a default set
and no Option<T> from

> let p = p.unwrap_or_else(|| #default_value);

to

> let p = p.unwrap_or(#const_name_for_default);

where the "#const_name_for_default" is a pub const with value
"#default_value"

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

tools fs: fix comment typo and strange glyph

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump proxmox version to 0.5.0-1

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox::tools::fs: remove deprecated functions

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox: bump nix dependency

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

bump proxmox version to 0.4.4-1

api: RPC environment: add client IP getter/setter to trait

This is similar to what we have in PVE and PMG now. Will be used to
set the real client IP for proxied connections.

with a dummy implementation, which avoids the need to implement it
for the CLI or Backup environments, which do not have or care for a
client IP

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

clippy fixups

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump proxmox version to 0.4.3-1

tools: change constnamemap to a more automatic constnamedbitmap

We only used this for the privileges for now, and there it's a
nuisance to alter all bit definitions manually if something is added.

This change makes it count the bits up automatically.

Rename the macro to indicate that this is not a generic name map but
a more specific named bit mapping.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

formatting fixup

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

improve error messages in parse_rfc3339

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

big formatting cleanup

had to be done, sorry not sorry

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

formatting fixup

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox/tools/common_regex: improve IPRE_BRACKET

by disallowing [] around ipv4 adresses (which is not very common)

we did not use this anywhere, so there should not be any compatibility
problem

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

bump version to 0.4.2-1

simplify open_file_locked

proxmox/tools/fs: create tmpfile helper

by factoring out the code we had in 'replace_file'

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

proxmox/tools/fs: add shared lock helper

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

module consistency

tools/time.rs -> tools/time/mod.rs
sys/linux/procfs.rs -> sys/linux/procfs/mod.rs

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

d/changelog: fixup email address

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

bump version to 0.4.1-1

proxmox/src/tools/email.rs: use slice instead of Vec

bump versions to proxmox 0.4.0 and proxmox-api-macro 0.2.2

api-macro: replace ident hashmap with simple find

after benchmarking (again), i found that doing a simple find instead
of saving the inidices for the ident strings in a hashmap has
no real performance impact (the max list size for the properties
are max ~25 at the moment, so this should not be impacting compile
times much) but it is much simpler

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

permissions: introduce UserParam permission

to safely differentiate between checking
- the current user matches some static string
- the current user matches the value in some (path) parameter.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

bump version to 0.3.9, api-macro dependency to 0.2.1

bump proxmox-api-macro version to 0.2.1-1

api-macro: relax Fieldname rules

by replacing more characters ('.','+') by '_' and prefix them when
it starts with a number

we sometimes need to parse such fields, e.g in serde attributes like
 #[serde(rename = "802.3ad")]

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

api-macro: fix broken binary ident search

the 'properties_' list is sorted by the the literal string of a
fieldname, but we binary-search for the 'ident_str' (which may be
different, since we map '-' to '_' for example)

by creating a hashmap to map from ident to index, we can do a simple
lookup in that case that will work

benchmarks showed no measurable performance difference

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

time: add tests for gmtime range

mainly so we notice if this assumption does not hold for some platform
or changes in the future.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

time/rfc3339: add leading zeroes for years < 1000

strftime(3) does not mention this explicitly, but years before 1000 have
their leading zero(es) stripped, which is not valid according to either
ISO-8601 or its profile RFC3339.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

time: add tests for RFC3339 corner cases

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

time: allow leap seconds when parsing RFC3339

we don't ever produce those, but they are valid RFC3339 strings

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

time: add test for leap second parsing/converting

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>

bump proxmox version to 0.3.8-1

remove chrono dependency and related code

check year in epoch_to_rfc3339, new helpers strftime_local and strftime_utc

new helpers epoch_i64 and epoch_f64

These helpers use rust std SystemTime. Removed the libc time() binding.

proxmox/src/tools/serde.rs: fix epoch_as_rfc3339 doctest

bump proxmox version to 0.3.7

fix epoch_as_rfc3339 serializer

src/tools/serde.rs: implement epoch_as_rfc3339 serializer

src/tools/time.rs: rename rfc_3339 to rfc3339

src/tools/email.rs: avoid chrono dependency

src/tools/time.rs: add parse_rfc_3339

src/tools/time/tm_editor.rs: copied from proxmox backup

proxmox/src/tools/time.rs: add epoch_to_rfc_3339

proxmox/src/tools/time.rs: fix previous commit

bump proxmox version to 0.3.6-1

proxmox/src/tools/time.rs: add strftime bindings

bump proxmox version to 0.3.5-1

tools/time: give tm struct as mut reference

mktime/timegm can modify the timestruct (to normalize the time, e.g.
convert the january 40 to february 9)

to use that feature, we have to give a mutable reference, else the
struct will be copied and the original left untouched

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>

and run rustfmt over another big chunk of code

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

more formatting fixups

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

formatting fixups

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump proxmox to 0.3.4-1

email: add small function to send multi-part emails using sendmail

Signed-off-by: Hannes Laimer <h.laimer@proxmox.com>

bump proxmox to 0.3.3-1

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

add serde forwarding convenience macros

* forward_deserialize_to_from_str
* forward_serialize_to_display

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

clippy: use matches for if let -> bool

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump proxmox dep to 0.3.2-1

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

tools/mod.rs: sort modules

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

add lock_file and open_file_locked

to proxmox::tools::fs

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

add proxmox::sys::timer module (moved from proxmox-backup)

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

move uuid serde code to uuid.rs

And avoid the temporary string allocation where possible.

Implementing foreign traits in external modules is bad
practice. The `serde` module is for implementations which
deviate from the expected default.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump version to 0.3.1-1

Uuid: implement Serlialize/Deserialize

bump proxmox version to 0.3.0-1

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

add http_bail macro

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

http_err macro: imply format!()

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

switch to using mod.rs

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

fix #2882: correctly parse optional fields from mountinfo

As per the linux kernel documentation[0], the "optional fields" (called
"tags" in our parser) are not comma-separated, but are a variable number
(0 or more) of space-separated fields, always followed by a dash to mark
the end.

Fix the /proc/<pid>/mountinfo parser to correctly parse these and add
test cases (l3 is the line that produced the original warning from the
bug report).

[0] https://www.kernel.org/doc/html/latest/filesystems/proc.html#proc-pid-mountinfo-information-about-mounts

Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>

bump proxmox version to 0.2.1-1

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

proxmox/tools/byte_buffer: improve read_from example

'norun' was not a valid attribute, so cargo doc ignored it completely

instead, write a proper example that can be compiled

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox/tools/websocket: fix some clippy warnings

* reformat docs
* use &mut [u8] instead of Box<[u8]> (conversion can be done automatically)
* use:
    let foo = if condition { A } else { B };
  instead of matching on a boolean condition
* rename WaitingForData to Receiving so that not all
  variants of the enum end with Data

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox/tools/websocket: improve error handling

use io_err_other instead of io_format_err and change the Error type
of create_frame from io::Error to WebSocketError

it is not good to redefine the ErrorKinds of io::Error, since
the caller probably is not aware of that

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox/tools/websocket: introduce WebSocketError and use it

this patch introduces a custom WebSocketError, so that we can
detect errors in the websocket protocol and react to it in the
right way

the channel now sends a Result<(OpCode, Box<[u8]>), WebSocketError>
so that we can either react to a control frame, or react to an
errornous data stream (which means sending a close frame
with the appropriate error code)

while at it, change FrameHeader::try_from_bytes to return
Result<Option<FrameHeader>, WebSocketError> instead of a nested
Result with the *guessed* remaining size. This was neither used by
us, nor was it really meaningful, since this can change during the
decode every time new data is read (extensions, mask, payload length, etc.)
so simply returning an Option is enough information for us

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

api-macro: formatting fixups

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

a lot more clippy lint fixes

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

various clippy lint fixes

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

websocket feature dependency fixup

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox/tools/websocket: add WebSocket implementation

uses the existing WebSocketReader and Writer to establish a
two-way communication between an upstream and downstream connection.

The upstream connection sends and receives WebSocket frames, while
the downstream one only receives and sends raw data.

For now we do not support extensions, and only accept the protocol version 13

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox/tools/websocket: replace CallBack with a channel

instead of having a callback that we call on a control frame,
use a channel to send the data to a receiver

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

proxmox/tools/websocket: implement send_control_frame for writer

so that we can easily send a control frame to the endpoint

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>