NM-1.0 ▶ NM ▶ WireGuardPeerSince 1.16

constructor

• new WireGuardPeer(properties?: Partial<{}>): WireGuardPeer

  Parameters

  • Optionalproperties: Partial<{}>

  Returns WireGuardPeer

Static$gtype

append_allowed_ip

• append_allowed_ip(allowed_ip: string, accept_invalid: boolean): boolean

  Appends allowed_ip setting to the list. This does not check for duplicates and always appends allowed_ip to the end of the list. If allowed_ip is valid, it will be normalized and a modified for might be appended. If allowed_ip is invalid, it will still be appended, but later verification will fail.

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Parameters

  • allowed_ip: string

    the allowed-ip entry to set.

  • accept_invalid: boolean

    if true, also invalid allowed_ip value will be appended. Otherwise, the function does nothing in face of invalid values and returns false.

  Returns boolean

  true if the value is a valid allowed-ips value, false otherwise. Depending on accept_invalid, also invalid values are added.

clear_allowed_ips

• clear_allowed_ips(): void

  Removes all allowed-ip entries.

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Returns void

cmp

• cmp(b: WireGuardPeer, compare_flags: NM.SettingCompareFlags): number

  Parameters

  • b: WireGuardPeer

    the other NM.WireGuardPeer to compare.

  • compare_flags: NM.SettingCompareFlags

    NM.SettingCompareFlags to affect the comparison.

  Returns number

  zero of the two instances are equivalent or a non-zero integer otherwise. This defines a total ordering over the peers. Whether a peer is sealed or not, does not affect the comparison.

get_allowed_ip

• get_allowed_ip(idx: number, out_is_valid?: boolean): string

  Parameters

  • idx: number

    the index from zero to (allowed-ips-len - 1) to retrieve.

  • Optionalout_is_valid: boolean

    true if the returned value is a valid allowed-ip setting. This parameter is wrongly not marked as (out) argument, it is thus not accessible via introspection. This cannot be fixed without breaking API for introspection users.

  Returns string

  the allowed-ip setting at index idx. If idx is out of range, null will be returned.

get_allowed_ips_len

• get_allowed_ips_len(): number

  Returns number

  the number of allowed-ips entries.

get_endpoint

• get_endpoint(): string

  Returns string

  the endpoint or null if none was set.

get_persistent_keepalive

• get_persistent_keepalive(): number

  Returns number

  get the persistent-keepalive setting in seconds. Set to zero to disable keep-alive.

get_preshared_key

• get_preshared_key(): string

  Returns string

  the preshared key or null if unset.

get_preshared_key_flags

• get_preshared_key_flags(): NM.SettingSecretFlags

  Returns NM.SettingSecretFlags

  get the secret flags for the preshared-key.

get_public_key

• get_public_key(): string

  Returns string

  the public key or null if unset.

is_sealed

• is_sealed(): boolean

  Returns boolean

  whether self is sealed or not.

is_valid

• is_valid(check_non_secrets: boolean, check_secrets: boolean): boolean

  Parameters

  • check_non_secrets: boolean

    if true, secret properties are validated. Otherwise, they are ignored for this purpose.

  • check_secrets: boolean

    if true, non-secret properties are validated. Otherwise, they are ignored for this purpose.

  Returns boolean

  true if the peer is valid or fails with an error reason.

new_clone

• new_clone(with_secrets: boolean): WireGuardPeer

  Parameters

  • with_secrets: boolean

    if true, the preshared-key secrets are copied as well. Otherwise, they will be removed.

  Returns WireGuardPeer

  a clone of self. This instance is always unsealed.

ref

• ref(): WireGuardPeer

  Returns WireGuardPeer

  returns the input argument self after incrementing the reference count. Since 1.42, ref-counting of NM.WireGuardPeer is thread-safe.

remove_allowed_ip

• remove_allowed_ip(idx: number): boolean

  Removes the allowed-ip at the given idx. This shifts all following entries one index down.

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Parameters

  • idx: number

    the index from zero to (allowed-ips-len - 1) to retrieve. If the index is out of range, false is returned and nothing is done.

  Returns boolean

  true if idx was valid and the allowed-ip was removed. false otherwise, and the peer will not be changed.

seal

• seal(): void

  Seal the NM.WireGuardPeer instance. Afterwards, it is a bug to call all functions that modify the instance (except ref/unref). A sealed instance cannot be unsealed again, but you can create an unsealed copy with nm_wireguard_peer_new_clone().

  Returns void

set_endpoint

• set_endpoint(endpoint: string, allow_invalid: boolean): boolean

  Sets or clears the endpoint of self.

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Parameters

  • endpoint: string

    the socket address endpoint to set or null.

  • allow_invalid: boolean

    if true, also invalid values are set. If false, the function does nothing for invalid endpoint arguments.

  Returns boolean

  true if the endpoint is null or valid. For an invalid endpoint argument, false is returned. Depending on allow_invalid, the instance will be modified.

set_persistent_keepalive

• set_persistent_keepalive(persistent_keepalive: number): void

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Parameters

  • persistent_keepalive: number

    the keep-alive value to set.

  Returns void

set_preshared_key

• set_preshared_key(preshared_key: string, accept_invalid: boolean): boolean

  Reset the preshared key. Note that if the preshared key is valid, it will be normalized (which may or may not modify the set value).

  Note that the preshared-key is a secret and consequently has corresponding preshared-key-flags property. This is so that secrets can be optional and requested on demand from a secret-agent. Also, an invalid preshared-key may optionally cause nm_wireguard_peer_is_valid() to fail or it may be accepted.

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Parameters

  • preshared_key: string

    the new preshared key or null to clear the preshared key.

  • accept_invalid: boolean

    whether to allow setting the key to an invalid value. If false, self is unchanged if the key is invalid and if false is returned.

  Returns boolean

  true if the preshared-key is valid, otherwise false. null is considered a valid value. If the key is invalid, it depends on accept_invalid whether the previous value was reset.

set_preshared_key_flags

• set_preshared_key_flags(preshared_key_flags: NM.SettingSecretFlags): void

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Parameters

  • preshared_key_flags: NM.SettingSecretFlags

    the secret flags to set.

  Returns void

set_public_key

• set_public_key(public_key: string, accept_invalid: boolean): boolean

  Reset the public key. Note that if the public key is valid, it will be normalized (which may or may not modify the set value).

  It is a bug trying to modify a sealed NM.WireGuardPeer instance.

  Parameters

  • public_key: string

    the new public key or null to clear the public key.

  • accept_invalid: boolean

    if true and public_key is not null and invalid, then do not modify the instance.

  Returns boolean

  true if the key was valid or null. Returns false for invalid keys. Depending on accept_invalid will an invalid key be set or not.

unref

• unref(): void

  Drop a reference to self. If the last reference is dropped, the instance is freed and all associate data released.

  Since 1.42, ref-counting of NM.WireGuardPeer is thread-safe.

  Returns void

Staticnew

• new(): WireGuardPeer

  Returns WireGuardPeer