Govroam

The Roaming solution for the public sector

User Tools

Site Tools


siteadmin:fticks_for_ms_nps

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
siteadmin:fticks_for_ms_nps [2024/04/25 13:05] adminsiteadmin:fticks_for_ms_nps [2024/05/20 08:53] (current) admin
Line 4: Line 4:
  
 **This only applies to Federation Operators and not to individual sites** **This only applies to Federation Operators and not to individual sites**
 +
 +The syslog server configuration below is for NXLog which is only capable of sending us a form of the Windows Event logs, not FTICKS unfortunately. Recommendations for free Windows syslog servers start and stop with NXLog and, in it's Community from, is simply unable to generate FTICKS. 
 +
 +However, if you have existing software which can accept Windows Eventlogs (or otherwise access NPS logs) and change the format into FTICKS then feel free to do so. The criteria for FTICKS are:
 +
 +  * Uses the [[public:fticks|FTICKS]] format
 +  * Proxies to utilities.govroam.uk on port 514/UDP with Facility local5
 +  * Includes in the FTICKS '#FEDID=0X000#' where 0X000 is replaced by the Federation ID supplied by Jisc.
 +  * Filters down the proxied log to just those for
 +    * Users on the govroam SSID
 +    * Roams between member sites going through the ORPS
 +    * Successful authentications
 +    * Only authentications between member sites (i.e. NOT those to or from the Jisc NRPS, or within an organisation)
 +
  
 =====Installation===== =====Installation=====
Line 18: Line 32:
  
 <code> <code>
-Panic Soft                                                                       +Panic Soft 
-#NoFreeOnExit TRUE                                                               +#NoFreeOnExit TRUE 
-                                                                                 + 
-define ROOT     C:\Program Files (x86)\nxlog                                     +define ROOT     C:\Program Files (x86)\nxlog 
-define CERTDIR  %ROOT%\cert                                                      +define CERTDIR  %ROOT%\cert 
-define CONFDIR  %ROOT%\conf                                                      +define CONFDIR  %ROOT%\conf 
-define LOGDIR   %ROOT%\data                                                      +define LOGDIR   %ROOT%\data 
-define LOGFILE  %LOGDIR%\nxlog.log                                               +define LOGFILE  %LOGDIR%\nxlog.log 
-LogFile %LOGFILE%                                                                +LogFile %LOGFILE% 
-                                                                                 + 
-Moduledir %ROOT%\modules                                                         +Moduledir %ROOT%\modules 
-CacheDir  %ROOT%\data                                                            +CacheDir  %ROOT%\data 
-Pidfile   %ROOT%\data\nxlog.pid                                                  +Pidfile   %ROOT%\data\nxlog.pid 
-SpoolDir  %ROOT%\data                                                            +SpoolDir  %ROOT%\data 
-                                                                                 + 
-<Extension _syslog>                                                              +<Extension _syslog> 
-    Module      xm_syslog                                                        +    Module      xm_syslog 
-</Extension>                                                                     +</Extension> 
-                                                                                 + 
-<Extension _charconv>                                                            +<Extension _exec> 
-    Module      xm_charconv                                                      +    Module      xm_exec 
-    AutodetectCharsets iso8859-2, utf-8, utf-16, utf-32                          +</Extension>
-</Extension>                                                                     +
-                                                                                 +
-<Extension _exec>                                                                +
-    Module      xm_exec                                                          +
-</Extension>                                                                    +
  
 <Output syslog_tls> <Output syslog_tls>
Line 50: Line 59:
     Host        212.219.243.132     Host        212.219.243.132
     Port        6514     Port        6514
-   CAFile      c:/Program Files (x86)/nxlog/data/cacert.pem+  CAFile      c:/Program Files (x86)/nxlog/data/cacert.pem
 #    CertFile    c:/Program Files (x86)/nxlog/data/clientreq.pem #    CertFile    c:/Program Files (x86)/nxlog/data/clientreq.pem
 #    CertKeyFile c:/Program Files (x86)/nxlog/data/clientkey.pem #    CertKeyFile c:/Program Files (x86)/nxlog/data/clientkey.pem
Line 76: Line 85:
       </QueryList>       </QueryList>
     </QueryXML>     </QueryXML>
 +    <Exec>
 +# Don't send log if going to or coming from a NRPS
 +# Change to math the ClientName and ProxyPolicyName as appropriate
 +   if $ClientName =~ /NRPS/i drop();
 +   if $ProxyPolicyName =~ /NRPS/i drop();
 +
 +# Replace with the provided Federation ID
 +   $FederationID = "XXXXX";
 +
 +# Send Client Name as the Operator Name if present, otherwise use a default.
 +# Replace 1something.here with the Federation's Operator Name
 +   if $ClientName == ''
 +   {
 +     $OperatorName = "1something.here";
 +   }
 +   else
 +   {
 +     $OperatorName = $ClientName;
 +   }
 +    </Exec>
 </Input> </Input>
  
Line 81: Line 110:
     Path        eventlog => syslog_tcp     Path        eventlog => syslog_tcp
 </Route> </Route>
- 
 </code> </code>
 +
 +Replace //XXXXX// with the Federation ID supplied by Jisc.
 +
 +Replace //1something.here// with your realm, prefixed by '1'.
 +
 +The Client Name and the Proxy Policy Name for receiving from/sending to the Jisc NRPS would have to contain 'NRPS' for the above to work. Otherwise change the above so that requests to/from the NRPS are excluded from the logging. 
  
 Save the file and restart the service. Save the file and restart the service.
 +
 +To make this work properly, the Client Name has to be in the form of a realm e.g. 1holby.nhs.uk for each of the Clients.
  
 The stanza, syslog_tls, is just there for information. It's not actually used in this configuration. At a later date we'll be looking at encryption but there's a PKI to build. The stanza, syslog_tls, is just there for information. It's not actually used in this configuration. At a later date we'll be looking at encryption but there's a PKI to build.
siteadmin/fticks_for_ms_nps.1714050350.txt.gz · Last modified: by admin