ci: Add code coverage to MRs

Add configuration file for lcov

This is useful for accurately testing code coverage. You can use this with:

  meson configure -Db_coverage=true
  meson test
  ninja coverage

ci: Export JUnit report

ci: Use fdo templates

conncheck: Limit ichecks based on property

Limit the number of stored incoming checks based on the property
limiting the number of total connectivity checks instead of using
the fixed limit on the number of remote candidates.

udp-bsd: Explicitly bind to the interface when creating a socket

interfaces: Add API to find the interface index from a local address

This will find some interface that has the address and will not work
correctly if multiple interfaces have the same address. But in any
case, nothing in libnice expects that and we would need to break the
API to make that work.

candidate: Copy stun_server with candidate

Bug reported and fix suggested by Masato Takahashi

Fixes #164

version: Add NICE_CHECK_VERSION to the documentation

address: Add Boxed Type

This should make the library more easily usable for bindings

agent: Support adding optional headers to HTTP proxy client

One use case for this is adding an ALPN header which is a MUST
requirement when a HTTP proxy is used in WebRTC (see RFC8835, section
3.4).

Conncheck: renomination: set use_candidate for pending check on early inbound STUN with NOMINATION attr

Conncheck: always updating remote_consent.last_received for selected pair on keepalive

NICE_CHECK_VERSION: fix unexpected "git = next version" assumption

0.1.18.1 should not satisfy a check for 0.1.19, especially not
for libraries that release once a year at best.

If someone needs more control they should do a feature check for
the symbol in the headers or lib.

Fix NICE_CHECK_VERSION in public install

Install a nice-version.h so that the version defines
are available.

https://gitlab.freedesktop.org/libnice/libnice/-/merge_requests/232

Conncheck: recheck consent timeout overflow fix

candidate: Add utility function to get STUN server address

Can be useful to know which STUN server was used to discover the given candidate.

docs: Add index for symbols added in 0.1.20

Add NICE_CHECK_VERSION macro

agent: Initialize variable

There is a codepath where it can be used without being filled.
Found by coverity.

version 0.1.19.1

version 0.1.19

candidate: Add utility function to get TURN relay address

Can be useful to know which TURN server is being used as relay server for a given candidate.

agent: Hold ref while doing async close

It's possible that the callback will be called synchronously during the
close function, in this case, we need to be ready to the last reference
to the agent to be dropped in this callback.

This fix was suggested by Fabrice Bellet

Fixes #153

Don't try to use link-local addresses outside local network

If we have gathered a host IP-address that is link-local we should
never try to use it for anything else than trying to match it with
another link-local address. Some routers seem to have problems with
traffic from link-local addresses destined at external IP-addresses.
By definition link-local addresses should stay local so there's no
reason to access STUN/TURN from it or try to form a candidate with
another address that is not link-local.

agent: Fix warning about required glib version

../agent/discovery.c: In function ‘on_refresh_remove_timeout’:
../agent/discovery.c:203:13: warning: Not available before 2.60
  203 |       G_GNUC_FALLTHROUGH;
      |             ^~~~~~~~~~~~~

../agent/conncheck.c: In function ‘priv_turn_allocate_refresh_retransmissions_tick_agent_locked’:
../agent/conncheck.c:1656:13: warning: Not available before 2.60
 1656 |       G_GNUC_FALLTHROUGH;
      |             ^~~~~~~~~~~~~

The comment /* fall through */ is enough to cause GCC and Clang to not
emit the implicit-fallthrough warning.

agent: Convert g_print() to nice_debug()

This was probably added by mistake.

meson: Fix openssl setting

This should fix builds on platforms openssl

gitlab-ci: Allow manual runs

tcp-active: Fix use-after-free in error case

Fixes issue found by Coverity

agent: Clear the original message pointer instead of a copy

In one case, the message pointer gets replaced by the rfc4571_message
one, so it wasn't getting cleared as expected.

gstnicesink: disable drop out of segment on nicesink

It's very tricky and unintuitive to have webrtcbin not sending data
because of the segment.

Fix https://gitlab.freedesktop.org/gstreamer/gstreamer/-/issues/907

test-io-stream-common: Avoid CPU starvation by yielding

Busy-looping is not a good idea, especially not when run under Valgrind,
where such a thread may result in well-behaved threads running thousands
of times slower. While passing --fair-sched=yes to Valgrind avoids the
issue, it's still better to make our busy-looping less aggressive.

agent: Consume data before removing disconnected socket

This was caught by tests randomly failing (timing out).

iostream: Implement close() for ICE-TCP also

component: Clear buffer pointers to avoid potential double free

In case close() is called more than once.

test-io-stream-thread: Handle partial I/O

test-io-stream-closing-write: Handle partial I/O

test-io-stream-closing-read: Handle partial I/O

test-io-stream-common: Remove incorrect assertion

We cannot assume that the message will be completely filled even in
reliable mode.

test-io-stream-common: Fix GSource callback signature

Cannot pass g_main_loop_quit as the GSourceFunc as its return type is
void.

test-io-stream-common: Remove dead code

Due to off-by-one errors. Since the code added above now handles what
this code tried to handle, we can go ahead and remove it.

agent: Add support for bytestream TCP

conncheck: don't ignore local socket errors

With this patch we ensure that local socket errors during connection
establishment are properly transmitted to the connection check layer, so
the related pair can be put in state failed when needed. The local
socket errors we are interested in, are those occuring when the local
source address cannot be bound anymore, because the underlying interface
vanished for example.

In particular, we don't ignore errors coming from g_socket_bind() with
tcp active sockets, that perform a bind to *whatever* local address is
available, in case it cannot bind to the specified address.

This behaviour was demonstrated with the test-tcp example, that tried
to bind to the IPv4 loopback address on a socket initially created for
the IPv6 loopback.

meson: Add agent include dir to uninstalled pkgconfig file

Meson picks up the includedirs from the library target that it is
building the pkgconfig file for. Since libnice's headers are split
into the nice/ and agent/ subdirs, we need to add agent/ to
include_directories: so that it's automatically added to the
uninstalled pkgconfig file by Meson.

agent: Handle failure to create TCP TURN socket

E.g. if the server address is IPv6 but the local system cannot reach it,
so connect() fails right away.

conncheck: schedule the connection check in most relevant places

The patch invokes the conncheck timer creation where it makes most
sense: when a new pair is inserted in the conncheck list, and when a
pair is added to the triggered check list (because the conncheck
scheduler works on these two lists).

stun: Use a specific variable to enable Win32 crypto

This should make it possible to use OpenSSL or GnuTLS also on Windows if
required.

gitlab-ci: Try to disable CI on non-MR/non-master branches

gitlab-ci: Add OpenSSL specific build

meson: Simplify finding OpenSSL

Remove duplicated calls to dependency() so we can have fallback in all
cases.

meson: Fix name of variable

This is a fix over the recent fix in commit 574f44b4

tests: Use g_assert_true() instead of g_assert() everywhere

Remove g_assert_cmp* macros outside of the unit tests

agent: ensure suceeded and discovered pairs fail the same time

This patch ensures that related succeeded-discovered pairs change to
state failed simultaneously, to avoid leaving dangling pointers if one
is freeed while the other is still in the conncheck list. Such
transition is very rare, and only occurs in regular nomination mode,
when the network conditions change between the time the pair is
initially discovered and the time it is rechecked with the use-candidate
flag.

Fix error when crypto/ssl libs are found without pkg-config

In that case crypto_dep is a list and we can't call .found() method.

agent: Unify constructors into nice_agent_new_full

Instead of having 3 independent implementations, make the simpler
versions delegate into the full one.

The simplest constructor needs to pass "no option", for which no
constant exists in the NiceAgentOption enum. Thus the new
NICE_AGENT_OPTION_NONE constant is added to reflect this possibility.

Use native crypto support on Windows by default

As we only need a few primitives there isn't much OS-specific code
needed, and for applications that don't already depend on OpenSSL or
GnuTLS it simplifies the build process quite a lot.

Note that we use the vintage WinCrypt APIs as the Cryptography Next
Generation APIs are only available on Vista and newer.

component: reset the stun agent on ice restart

The stun agent may contain references to the password previously stored
in some remote candidates, freeed by nice_component_restart(), that were
used by keep-alive stun requests. These stun replies may arrive later
after ice has been restarted. Since the remote candidates are freeed
when ice is restarted, the stun agent must be reset to get rid of these
related references.

gitlab-ci: Update Windows image

gitlab-ci: Update ci-fairy to upstream recommended script

nice: Bring new symbols to 0.1.19

It's not released yet and we don't do even/odd in this project.

nice: Export nice_candidate_transport_to_string

Also update the Since to 0.1.19, because it's not really usable now

nice: Export nice_candidate_type_to_string

Also update the Since to 0.1.19, because it's not really usable now

stun: Make the headers usable from C++ code

Add the relevant ifdef extern C bits

agent: Simplify accepting state changes to FAILED

The component can go from any state to FAILED, so simplify
that and make it explicit.

agent: Accept any transition back to the gathering state

When doing a ICE restart, which can be done from any state, we can
always go back into the gathering state.

This fixes a regression introduced by b20ac5ba7b731f2cc698f26e8def28a518de058e

gitlab-ci: Allow msys CI to fail

It just won't work for now.

subprojects: Get zlib from Qt mirror

Getting it from the upstream mirror seems to fail miserably

gitlab-ci: Remove meson update

Update Windows image

test-restart: fix potential stack buffer overflow with new candidate API

test-consent: fix potential stack buffer overflow with new candidate API

test-io-stream-pollable: Handle partial reads

pseudotcp: Disable Nagle algorithm by default

To be consistent with what we do for ICE-TCP.

tcp-bsd: Handle send before connect() completes

agent: Remove duplicated early return

The type is already checked to not be peer reflexive earlier.

agent: Avoid leak on programming error

Even if the agent is invalid, don't leak.

This makes coverity a little happier.

conncheck: Free password in more obvious way

This should make Coverity's job a little easier. And also fix a little
leak in the error path.

udp-turn: Remove request before freeing it

As removing the request from the queue looks into the SendRequest, one
needs to unqueue it before freeing it.

agent: avoid leak of all turn refreshes when disposing the agent

With this patch we free all outstanding refreshes when the agent dispose
method is called, even those that are in the way to be discarded
asynchronously, when a stream is removed.

We also make the final user callback of the refresh proces synchronous,
so we don't have to deal with an heap use-after-free problem. This also
requires to order some parts of code.

discovery: fix asynchronous agent refreshes pruning

Asynchronous refreshes pruning may occur when the agent async close
function is called, but also when a stream is closed. A flag
'discarding' is used in the CandidateRefresh object to determine
if a refresh is already on the way to be asynchronously freed. A refresh
definitely freed is removed from agent refresh_list.

When the agent async close function is called, it is passed a user
callback that will be invoked when all refreshes have been freed.

This is not exactly how things work currently, because right now, the
callback function is also invoked when all CandidateRefresh objects have
the discarding flag set, with the test 'data->items_to_free==0'. In that
case, clearly not all refreshes have been freed, as some are still there
in the refresh_list with the discarding flag set.

This is probably not what the user expects from the function
nice_agent_close_async(), where the callback is supposed to be invoked
after all refreshes have been freed: and including those asynchronously
pruned by nice_prune_stream_async().

This patch adds a supplementary timeout when closing the agent async,
that waits until the agent refresh list becomes empty.

agent: avoid leak of turn refreshes

We keep refreshes having the discarding flag set. They may be freed later
if the agent main context remains alive after agent deletion.

agent: warn when closing the agent with alive turn refreshes

This patch suggests the developer to close its alive reservations on
the turn server before disposing the agent.

Not removing reservations on the turn server, will make them alive until
their default timeout, generally 300 seconds, which is not fair for the
turn server resources, but also it may cause a fatal error 437,
"Mismatched allocation: wrong transaction ID", when another agent tries
to contact the same turn server using the same nat mapping before this
delay expires.

agent: Verify the source before dereferencing the pointer

The reason is that the component object could have been destroyed in the
mean time.

agent: don't allocate large arrays on the stack

udp-turn: don't allocate large arrays on the stack

agent: keep a track of the candidate refreshes being pruned

Refreshes with zero lifetime sent over tcp transport may cause the
removal of the underlying socket when the remote peer closes the
connection taking our request into account. These refreshes must be
tracked and freeed on our side to avoid retransmission attempt on a
closed socket and a heap-use-after-free error in that case.

interfaces: Skip special interfaces on Apple OSes

Including unused utun devices.

interfaces: Skip special interfaces on Apple OSes

Including unused utun devices.

gitlab-ci: Accept double pipeline otherwise MRs arent mergeable

gitlab-ci: Stop base msvc build on msys

gitlab-ci: Mark all tasks as interruptible

gitlab-ci: Move pacman setup to before_script

gitlab-ci: Run meson, ninja and meson test separately

gitlab-ci: Just skip the msys global upgrade

gitlab-ci: Update to 2021-02-04 Windows image

gitlab-ci: Verify that allow-edit is set

agent: reset remote credentials when restarting ice

The remote credentials recorded in the streams should be reset,
in the case the restarted conncheck begins with new remote candidates
*before* the updated remote credentials are received.

agent: transition to state gathering when restarting ice

The state of the component is downgraded to gathering state, so it can
really restart a new conncheck from scratch. It'll transition to state
connecting when receiving the updated remote candidates.