{"id":7470,"date":"2021-02-20T21:56:15","date_gmt":"2021-02-20T21:56:15","guid":{"rendered":"https:\/\/www.use-snip.com\/kb\/?post_type=ht_kb&p=7470"},"modified":"2021-03-05T16:24:09","modified_gmt":"2021-03-05T16:24:09","slug":"restricting-users-by-agent","status":"publish","type":"ht_kb","link":"https:\/\/www.use-snip.com\/kb\/knowledge-base\/restricting-users-by-agent\/","title":{"rendered":"Restricting Users, by Agent"},"content":{"rendered":"

This article describes how to add an NTRIP Agent<\/strong> Restriction<\/strong> to user accounts in the SNIP<\/strong><\/span> NTRIP Caster.<\/p>\n

The NTRIP Agent Restrictions tab<\/h2>\n

This tab is used to control which User Agents (NTRIP Client software) the User Account<\/a> is allowed to connect with. Use this feature to restrict the list of approved devices (hardware or software) this user account can use to connect to your Caster.<\/p>\n

\"\"<\/p>\n

All well constructed NTRIP Clients<\/a> provide a “User agent” string as part of the HTTP header used when they connect to your Caster.\u00a0 The precise format varies between the NTRIP Rev1 and Rev2 connection protocols (this article<\/a> summarizes the main differences with examples).<\/p>\n

Want a quick look at some common NTRIP Client agents?
\nClick here<\/a> to see what has connected to the RTK2go.com<\/a>:2101 Public Caster recently.<\/p>\n

But the primary take-away is that well behaved NTRIP Clients identify the software (and often the version) they are using when they connect.\u00a0 And therefore this can also be used as yet another way to control how your user accounts are allowed to connect to your Caster.<\/p>\n

The checking method used by SNIP<\/strong><\/span> performs a simple string search using the “root name” of the agent name in a case sensitive sub-string match.\u00a0 NTRIP Clients using an agent that matches the sub-string are either allowed<\/em> to prohibited<\/em> (depending on which list the matching sub-string was in).<\/p>\n

In the below image the Select None<\/strong> button has been pressed, resulting in a listing all the known Agents from which the user can select the ones of interest.\u00a0 The “root name” of over 80 common agents are currently loaded, and the operator can add items (or edit and extend an existing item) with the Add…<\/strong> button in the normal way.<\/p>\n

\"\"<\/p>\n

The check box Case Sensitive Matches<\/strong> should in general be left checked to prevent false positive matches.<\/p>\n

The checkbox called Hide those Not Selected<\/strong> is used to hide agents which are not checked.\u00a0 This has value for clutter reduction so that the operator can clearly see which agents have been selected.<\/p>\n

When a user with this account connects, the agent is checked against the Allowed and Prohibited lists, if the Activate<\/strong> checkbox is enabled.\u00a0\u00a0 If the user is not allowed to connect due to this restriction, an entry in the console log is added to inform the operator.<\/p>\n

The most typical use case is a Caster operator that wishes to ensure that a given user account connects only with the NTRIP Client software they are authorized to be using.<\/p>\n

On sub-string matching<\/h3>\n

Care should be taken when adding new Agents to avoid a false match.\u00a0 Short strings are always a concern in this regard.\u00a0 For example; entering only the term “NTRIP” would match nearly every agent, which is probably not the desired outcome.<\/p>\n

By the same logic, strings which are too long may match on a very specific version of the agent when perhaps less specificity is required.<\/p>\n

As an example, consider the following fifteen NTRIP Client agents:<\/p>\n

NTRIP RTKLIB\/2.4.1\u00a0 \r\nNTRIP RTKLIB\/2.4.2\u00a0 \r\nNTRIP RTKLIB\/2.4.3\u00a0 \r\nNTRIP RTKLIB\/2.4.3 Emlid \r\nNTRIP RTKLIB\/2.4.3 demo5\u00a0 \r\nNTRIP RTKLIB\/2.4.3_b33\u00a0 \r\nNTRIP RTKLIB\/demo5_b30\u00a0 \r\nNTRIP RTKLIB\/demo5_b31\u00a0 \r\nNTRIP RTKLIB\/demo5_b31a\u00a0 \r\nNTRIP RTKLIB\/demo5_b33a\u00a0 \r\nNTRIP RTKLIB\/demo5_b33b2\u00a0 \r\nNTRIP RTKLIB\/demo5_b33c\u00a0 \r\nNTRIP RTKLIB\/demo5_b33d \r\nNTRIP RTKLIB\/demo5_b33e\u00a0 \r\nNTRIP RTKLIB\/demo5_b33f<\/pre>\n
And then consider the following possible agent strings and their outcomes.<\/p>\n