File Coverage

lib/Wireguard/WGmeta/ValidAttributes.pm

Criterion	Covered	Total	%
statement	54	54	100.0
branch	2	2	100.0
condition			n/a
subroutine	16	16	100.0
pod	1	1	100.0
total	73	73	100.0

=head1 NAME

WGmeta::ValidAttributes - Supported attribute configurations

=head1 DESCRIPTION

In this module all supported attributes are configured (and as well their possible validation function). Attributes configured
here affect how the parser stores them

=head1 SYNOPSIS

    use Wireguard::WGmeta::ValidAttributes;

    my $attr_type = get_attr_type($attr_name);

    if ($attr_type == ATTR_TYPE_IS_WG_META){
        print "Yiii-haa";
    }


=cut

package Wireguard::WGmeta::ValidAttributes;
use strict;
use warnings FATAL => 'all';
use experimental 'signatures';

use Wireguard::WGmeta::Validator;

our $VERSION = "0.3.2";

=head1 ATTRIBUTE TYPES

=cut

=head3 ATTR_TYPE_IS_WG_META

(Default) - wg-meta attributes

=cut
use constant ATTR_TYPE_IS_WG_META => 10;

=head3 ATTR_TYPE_IS_WG_QUICK

wg-quick attribute

=cut
use constant ATTR_TYPE_IS_WG_QUICK => 12;
=head3 ATTR_TYPE_IS_WG_ORIG_INTERFACE

Original Wireguard attribute, valid for C<[Interface]> sections.

=cut
use constant ATTR_TYPE_IS_WG_ORIG_INTERFACE => 13;
=head3 ATTR_TYPE_IS_WG_ORIG_PEER

Original Wireguard attribute, valid for C<[Peer]> sections.

=cut
use constant ATTR_TYPE_IS_WG_ORIG_PEER => 14;
=head3 ATTR_TYPE_IS_UNKNOWN

Any unknown attribute types

=cut
use constant ATTR_TYPE_IS_UNKNOWN => 15;

use constant TRUE => 1;
use constant FALSE => 0;

use base 'Exporter';
our @EXPORT = qw(
    ATTR_TYPE_IS_WG_META
    ATTR_TYPE_IS_WG_QUICK
    ATTR_TYPE_IS_WG_ORIG_INTERFACE
    ATTR_TYPE_IS_WG_ORIG_PEER
    ATTR_TYPE_IS_UNKNOWN
    NAME_2_KEYS_MAPPING
    KNOWN_ATTRIBUTES
    get_attr_type
);


=head3 KNOWN_ATTRIBUTES

Mapping of all known attributes

=cut

use constant KNOWN_ATTRIBUTES => {
    'alias'                => {
        'type'           => ATTR_TYPE_IS_WG_META,
        'in_config_name' => 'Alias',
        'validator'      => \&accept_any
    },
    'disabled'             => {
        'type'           => ATTR_TYPE_IS_WG_META,
        'in_config_name' => 'Disabled',
        'validator'      => \&accept_any
    },
    'checksum'             => {
        'type'           => ATTR_TYPE_IS_WG_META,
        'in_config_name' => 'Checksum',
        'validator'      => \&accept_any
    },
    'address'              => {
        'in_config_name' => 'Address',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'dns'                  => {
        'in_config_name' => 'DNS',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'mtu'                  => {
        'in_config_name' => 'MTU',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'table'                => {
        'in_config_name' => 'Table',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'pre-up'               => {
        'in_config_name' => 'PreUp',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'post-up'              => {
        'in_config_name' => 'PostUP',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'pre-down'             => {
        'in_config_name' => 'PreDown',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'post-down'            => {
        'in_config_name' => 'PostDown',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'save-config'          => {
        'in_config_name' => 'SaveConfig',
        'type'           => ATTR_TYPE_IS_WG_QUICK,
        'validator'      => \&accept_any
    },
    'listen-port'          => {
        'in_config_name' => 'ListenPort',
        'type'           => ATTR_TYPE_IS_WG_ORIG_INTERFACE,
        'validator'      => \&is_number
    },
    'fwmark'               => {
        'in_config_name' => 'Fwmark',
        'type'           => ATTR_TYPE_IS_WG_ORIG_INTERFACE,
        'validator'      => \&accept_any
    },
    'private-key'          => {
        'in_config_name' => 'PrivateKey',
        'type'           => ATTR_TYPE_IS_WG_ORIG_INTERFACE,
        'validator'      => \&accept_any
    },
    'public-key'           => {
        'in_config_name' => 'PublicKey',
        'type'           => ATTR_TYPE_IS_WG_ORIG_PEER,
        'validator'      => \&accept_any
    },
    'preshared-key'        => {
        'in_config_name' => 'PresharedKey',
        'type'           => ATTR_TYPE_IS_WG_ORIG_PEER,
        'validator'      => \&accept_any
    },
    'endpoint'             => {
        'in_config_name' => 'Endpoint',
        'type'           => ATTR_TYPE_IS_WG_ORIG_PEER,
        'validator'      => \&accept_any
    },
    'persistent-keepalive' => {
        'in_config_name' => 'PersistentKeepalive',
        'type'           => ATTR_TYPE_IS_WG_ORIG_PEER,
        'validator'      => \&accept_any
    },
    'allowed-ips'          => {
        'in_config_name' => 'AllowedIPs',
        'type'           => ATTR_TYPE_IS_WG_ORIG_PEER,
        'validator'      => \&accept_any
    },
};

sub _create_inconfig_name_mapping() {
    my $names2key = {};
    map {$names2key->{KNOWN_ATTRIBUTES->{$_}{in_config_name}} = $_;} (keys %{+KNOWN_ATTRIBUTES});
    return $names2key;
}


=head3 NAME_2_KEYS_MAPPING

[Generated] Static mapping from I to I.

=cut
use constant NAME_2_KEYS_MAPPING => _create_inconfig_name_mapping;


=head3 get_attr_type($attr_name)

Shorthand for getting the attribute type

=cut

sub get_attr_type($attr_name) {
    return KNOWN_ATTRIBUTES->{$attr_name}{type} if exists KNOWN_ATTRIBUTES->{$attr_name};
    return ATTR_TYPE_IS_UNKNOWN;
}

1;