Manual:Router AAA: Difference between revisions

From MikroTik Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 3: Line 3:


==Summary==
==Summary==
<p><b>Sub-menu:</b> <code>/user</code></p>
<p id="shbox"><b>Sub-menu:</b> <code>/user</code></p>
<br />
 


MikroTik RouterOS router user facility manage the users connecting the router from the local console, via serial terminal, telnet, SSH or Winbox. The users are authenticated using either local database or designated RADIUS server.
MikroTik RouterOS router user facility manage the users connecting the router from the local console, via serial terminal, telnet, SSH or Winbox. The users are authenticated using either local database or designated RADIUS server.
Line 14: Line 14:


==User Groups==
==User Groups==
<p><b>Sub-menu:</b> <code>/user group</code></p>
<p id="shbox"><b>Sub-menu:</b> <code>/user group</code></p>


The router user groups provide a convenient way to assign different permissions and access rights to different user classes.
The router user groups provide a convenient way to assign different permissions and access rights to different user classes.
Line 152: Line 152:


==Router Users==
==Router Users==
<p><b>Sub-menu:</b> <code>/user</code></p>
<p id="shbox"><b>Sub-menu:</b> <code>/user</code></p>
<br />
<br />


Line 210: Line 210:
==Monitoring Active Users==
==Monitoring Active Users==


<p><b>Sub-menu:</b> <code>/user active</code></p>
<p id="shbox"><b>Sub-menu:</b> <code>/user active</code></p>


<code>/user active print</code> command shows the currently active users along with respective statisics information.
<code>/user active print</code> command shows the currently active users along with respective statisics information.
Line 275: Line 275:


==Remote AAA==
==Remote AAA==
<p><b>Sub-menu:</b> <code>/user aaa</code></p>
<p id="shbox"><b>Sub-menu:</b> <code>/user aaa</code></p>


Router user remote AAA enables router user authentication and accounting via RADIUS server. The RADIUS user database is consulted only if the required username is not found in the local user database
Router user remote AAA enables router user authentication and accounting via RADIUS server. The RADIUS user database is consulted only if the required username is not found in the local user database
Line 288: Line 288:


{{Mr-arg-table
{{Mr-arg-table
|arg=accounting
|arg=default-group
|type=yes {{!}} no
|type=string
|default=yes
|default=read
|desc=Enable RADIUS accounting
|desc=User group used by default for users authenticated via RADIUS server.
}}
 
{{Versions|2.9, v3, v4}}
 
 
==Summary==
<p><b>Sub-menu:</b> <code>/user</code></p>
<br />
 
MikroTik RouterOS router user facility manage the users connecting the router from the local console, via serial terminal, telnet, SSH or Winbox. The users are authenticated using either local database or designated RADIUS server.
 
Each user is assigned to a user group, which denotes the rights of this user. A group policy is a combination of individual policy items.
 
In case the user authentication is performed using RADIUS, the [[RADIUS Client]] should be previously configured.
 
 
==User Groups==
<p><b>Sub-menu:</b> <code>/user group</code></p>
 
The router user groups provide a convenient way to assign different permissions and access rights to different user classes.
 
 
===Properties===
 
{{Mr-arg-table-h
|prop=Property
|desc=Description
}}
}}


{{Mr-arg-table
{{Mr-arg-table
|arg=name
|arg=interim-update
|type=string
|type=time
|default=
|default=0s
|desc=The name of the user group
|desc=Interim-Update time interval
}}
}}


{{Mr-arg-table-end
{{Mr-arg-table-end
|arg=policy
|arg=use-radius
|type=local {{!}} telnet {{!}} ssh {{!}} ftp {{!}} reboot {{!}} read {{!}} write {{!}} policy {{!}} test {{!}} web {{!}} sniff {{!}} api {{!}} winbox {{!}} password {{!}} sensitive
|type=yes {{!}}no
|default=
|default=no
|desc=List of allowed policies:
|desc=Enable user authentication via RADIUS
* <var>local</var> - policy that grants rights to log in locally via console
* <var>telnet</var> - policy that grants rights to log in remotely via telnet
* <var>ssh</var> - policy that grants rights to log in remotely via secure shell protocol
* <var>ftp</var> - policy that grants full rights to log in remotely via FTP and to transfer files from and to the router. Users with this policy can both read, write and erase files, regardless of "read/write" permission, as that deals only with RouterOS configuration.
* <var>reboot</var> - policy that allows rebooting the router
* <var>read</var> - policy that grants read access to the router's configuration. All console commands that do not alter router's configuration are allowed. Doesn't affect FTP
* <var>write</var> - policy that grants write access to the router's configuration, except for user management. This policy does not allow to read the configuration, so make sure to enable read policy as well
* <var>policy</var> - policy that grants user management rights. Should be used together with write policy
* <var>test</var> - policy that grants rights to run ping, traceroute, bandwidth-test and wireless scan, sniffer and snooper commands
* <var>web</var> - policy that grants rights to log in remotely via WebBox
* <var>winbox</var> - policy that grants rights to log in remotely via WinBox
* <var>password</var> - policy that grants rights to change the password
* <var>sensitive</var> - grants rights to see sensitive information in the router, see below list as to what is regarded as sensitive.
* <var>api</var> - grants rights to access router via API.
* <var>sniff</var> - policy that grants rights to use packet sniffer tool.
}}
}}


===Sensitive information===


Starting with RouterOS v3.27, the following information is regarded as sensitive, and can be hidden from certain user groups with the ''''sensitive'''' policy unchecked.
{{Note|If you are using RADIUS, you need to have CHAP support enabled in the RADIUS server for Winbox to work}}
 
Also, since RouterOS v4.3, [[Configuration_Management#System_Backup|backup files]] are considered sensitive, and users without this policy will not be able to download them in any way.
 
'''system package'''
/radius: secret
/snmp/community: authentication-password, encryption-password
 
'''advanced-tools package'''
/tool/sms: secret
 
'''wireless package'''
 
/interface/wireless/security-profiles: wpa-pre-shared-key,
wpa2-pre-shared-key, static-key-0, static-key-1, static-key-2,
static-key-3, static-sta-private-key
/interface/wireless/access-list: private-key, private-pre-shared-key
 
'''wireless-test package'''
 
/interface/wireless/security-profiles: wpa-pre-shared-key, wpa2-pre-shared-key,
static-key-0, static-key-1, static-key-2, static-key-3, static-sta-private-key, management-protection-key
/interface/wireless/access-list: private-key, private-pre-shared-key, management-protection-key
 
'''user-manager package'''
 
/tool/user-manager/user: password
/tool/user-manager/customer: password
 
'''hotspot package'''
 
/ip/hotspot/user: password
 
'''ppp package'''
 
/ppp/secret: password
 
'''security package'''
/ip/ipsec/installed-sa: auth-key, enc-key
/ip/ipsec/manual-sa: ah-key, esp-auth-key, esp-enc-key
/ip/ipsec/peer: secret
 
'''routing package'''
 
/routing/bgp/peer: tcp-md5-key
/routing/rip/interface: authentication-key
/routing/ospf/interface: authentication-key
/routing/ospf/virtual-link: authentication-key
 
'''routing-test package'''
 
/routing/bgp/peer: tcp-md5-key
/routing/rip/interface: authentication-key
/routing/ospf/interface: authentication-key
/routing/ospf/virtual-link: authentication-key
 
 
===Notes===
 
There are three system groups which cannot be deleted:
<pre>
[admin@rb13] > /user group print
0 name="read" policy=local,telnet,ssh,reboot,read,test,winbox,password,web,!ftp,!write,!policy
 
1 name="write" policy=local,telnet,ssh,reboot,read,write,test,winbox,password,web,!ftp,!policy
 
2 name="full" policy=local,telnet,ssh,ftp,reboot,read,write,policy,test,winbox,password,web
 
3 name="test" policy=ssh,read,policy,!local,!telnet,!ftp,!reboot,!write,!test,!winbox,!password,!web
[admin@rb13] >
</pre>
Exclamation sign '!' just before policy item name means NOT.
 
 
 
===Example===
 
To add reboot group that is allowed to reboot the router locally or using telnet, as well as read the router's configuration, enter the following command:
<pre>
[admin@rb13] user group> add name=reboot policy=telnet,reboot,read,local
[admin@rb13] user group> print
0 name="read" policy=local,telnet,ssh,reboot,read,test,winbox,password,web,!ftp,!write,!policy
 
1 name="write" policy=local,telnet,ssh,reboot,read,write,test,winbox,password,web,!ftp,!policy


2 name="full" policy=local,telnet,ssh,ftp,reboot,read,write,policy,test,winbox,password,web


3 name="reboot" policy=local,telnet,reboot,read,!ssh,!ftp,!write,!policy,!test,!winbox,!password,!web
==SSH Keys==
[admin@rb13] user group>
<p id="shbox"><b>Sub-menu:</b> <code>/user ssh-keys</code></p>
</pre>


==Router Users==
This menu allows to import public keys used for authentication.
<p><b>Sub-menu:</b> <code>/user</code></p>
<br />
 
Router user database stores the information such as username, password, allowed access addresses and group about router management personnel.
 
 
===Properties===




Properties:
{{Mr-arg-table-h
{{Mr-arg-table-h
|prop=Property
|prop=Property
|desc=Description
|desc=Description
}}
{{Mr-arg-table
|arg=address
|type=IP/mask {{!}} IPv6 prefix
|default=
|desc=Host or network address from which the user is allowed to log in
}}
{{Mr-arg-table
|arg=group
|type=string
|default=
|desc=Name of the [[#User_Groups | group]] the user belongs to
}}
{{Mr-arg-table
|arg=name
|type=string
|default=
|desc=User name. Although it must start with an alphanumeric character, it may contain "*", "_", "." and "@" symbols.
}}
}}


{{Mr-arg-table-end
{{Mr-arg-table-end
|arg=password
|arg=user
|type=string
|type=string
|default=
|default=
|desc=User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, "*" and "_" symbols.
|desc=
}}
}}


===Notes===
There is one predefined user with full access rights:
<pre>
[admin@MikroTik] user> print
Flags: X - disabled
  #  NAME                                            GROUP ADDRESS
  0  ;;; system default user
      admin                                            full  0.0.0.0/0
[admin@MikroTik] user>
</pre>
There always should be at least one user with fulls access rights. If the user with full access rights is the only one, it cannot be removed.
==Monitoring Active Users==
<p><b>Sub-menu:</b> <code>/user active</code></p>
<code>/user active print</code> command shows the currently active users along with respective statisics information.
===Properties===
All properties are read-only.


Read-only properties:
{{Mr-arg-table-h
{{Mr-arg-table-h
|prop=Property
|prop=Property
Line 519: Line 338:
}}
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table-end
|arg=address
|arg=key-owner
|type=IP/IPv6 address
|desc=Host IP/IPv6 address from which the user is accessing the router. 0.0.0.0 means that user is logged in locally
}}
 
{{Mr-arg-ro-table
|arg=group
|type=string
|desc=[[#User_Group | Group]] that user belongs to.
}}
 
{{Mr-arg-ro-table
|arg=name
|type=string
|type=string
|desc=User name.
|desc=
}}
}}


{{Mr-arg-ro-table
=== Private keys===
|arg=radius
<p id="shbox"><b>Sub-menu:</b> <code>/user ssh-keys private</code></p>
|type=true {{!}} false
|desc=Whether user is authenticated by RADIUS server.
}}
 
{{Mr-arg-ro-table
|arg=via
|type=console {{!}} telnet {{!}} ssh {{!}}winbox {{!}} api {{!}} web
|desc=User's access method
}}
 
{{Mr-arg-ro-table-end
|arg=when
|type=time
|desc=Time and date when user logged in.
}}
 
 
 
===Example===
To print currently active users, enter the following command:
<pre>
[admin@dzeltenais_burkaans] /user active> print detail
Flags: R - radius
0  when=dec/08/2010 16:19:24 name="admin" address=10.5.8.52 via=winbox
 
2  when=dec/09/2010 09:23:04 name="admin" address=10.5.101.38 via=telnet
 
3  when=dec/09/2010 09:34:27 name="admin" address=fe80::21a:4dff:fe5d:8e56 via=api
</pre>
 
==Remote AAA==
<p><b>Sub-menu:</b> <code>/user aaa</code></p>


Router user remote AAA enables router user authentication and accounting via RADIUS server. The RADIUS user database is consulted only if the required username is not found in the local user database
This  menu is used to import and list imported private keys. Private keys are used to authenticate remote login attempts using certificates.
 
 
===Properties===


Read-only properties:
{{Mr-arg-table-h
{{Mr-arg-table-h
|prop=Property
|prop=Property
Line 582: Line 355:
}}
}}


{{Mr-arg-table
{{Mr-arg-ro-table
|arg=default-group
|arg=user
|type=string
|type=string
|default=read
|desc=
|desc=User group used by default for users authenticated via RADIUS server.
}}
}}


{{Mr-arg-table
{{Mr-arg-ro-table-end
|arg=interim-update
|arg=key-owner
|type=time
|type=string
|default=0s
|desc=
|desc=Interim-Update time interval
}}
 
{{Mr-arg-table-end
|arg=use-radius
|type=yes {{!}}no
|default=no
|desc=Enable user authentication via RADIUS
}}
}}


===Example===
[[ M:System/SSH_client#Log-in_using_certificate | Read full example >>]]


{{Note|If you are using RADIUS, you need to have CHAP support enabled in the RADIUS server for Winbox to work}}


[[Category:Manual|A]]
[[Category:Manual|A]]
[[Category:AAA|A]]
[[Category:AAA|A]]

Revision as of 14:08, 2 May 2011

Applies to RouterOS: 2.9, v3, v4


Summary

Sub-menu: /user


MikroTik RouterOS router user facility manage the users connecting the router from the local console, via serial terminal, telnet, SSH or Winbox. The users are authenticated using either local database or designated RADIUS server.

Each user is assigned to a user group, which denotes the rights of this user. A group policy is a combination of individual policy items.

In case the user authentication is performed using RADIUS, the RADIUS Client should be previously configured.


User Groups

Sub-menu: /user group

The router user groups provide a convenient way to assign different permissions and access rights to different user classes.


Properties

Property Description
name (string; Default: ) The name of the user group
policy (local | telnet | ssh | ftp | reboot | read | write | policy | test | web | sniff | api | winbox | password | sensitive; Default: ) List of allowed policies:
  • local - policy that grants rights to log in locally via console
  • telnet - policy that grants rights to log in remotely via telnet
  • ssh - policy that grants rights to log in remotely via secure shell protocol
  • ftp - policy that grants full rights to log in remotely via FTP and to transfer files from and to the router. Users with this policy can both read, write and erase files, regardless of "read/write" permission, as that deals only with RouterOS configuration.
  • reboot - policy that allows rebooting the router
  • read - policy that grants read access to the router's configuration. All console commands that do not alter router's configuration are allowed. Doesn't affect FTP
  • write - policy that grants write access to the router's configuration, except for user management. This policy does not allow to read the configuration, so make sure to enable read policy as well
  • policy - policy that grants user management rights. Should be used together with write policy
  • test - policy that grants rights to run ping, traceroute, bandwidth-test and wireless scan, sniffer and snooper commands
  • web - policy that grants rights to log in remotely via WebBox
  • winbox - policy that grants rights to log in remotely via WinBox
  • password - policy that grants rights to change the password
  • sensitive - grants rights to see sensitive information in the router, see below list as to what is regarded as sensitive.
  • api - grants rights to access router via API.
  • sniff - policy that grants rights to use packet sniffer tool.

Sensitive information

Starting with RouterOS v3.27, the following information is regarded as sensitive, and can be hidden from certain user groups with the 'sensitive' policy unchecked.

Also, since RouterOS v4.3, backup files are considered sensitive, and users without this policy will not be able to download them in any way.

system package 

/radius: secret
/snmp/community: authentication-password, encryption-password

advanced-tools package 

/tool/sms: secret

wireless package 

/interface/wireless/security-profiles: wpa-pre-shared-key,
wpa2-pre-shared-key, static-key-0, static-key-1, static-key-2,
static-key-3, static-sta-private-key
/interface/wireless/access-list: private-key, private-pre-shared-key

wireless-test package 

/interface/wireless/security-profiles: wpa-pre-shared-key, wpa2-pre-shared-key, 
static-key-0, static-key-1, static-key-2, static-key-3, static-sta-private-key, management-protection-key
/interface/wireless/access-list: private-key, private-pre-shared-key, management-protection-key

user-manager package 

/tool/user-manager/user: password
/tool/user-manager/customer: password

hotspot package 

/ip/hotspot/user: password

ppp package 

/ppp/secret: password

security package 

/ip/ipsec/installed-sa: auth-key, enc-key
/ip/ipsec/manual-sa: ah-key, esp-auth-key, esp-enc-key
/ip/ipsec/peer: secret

routing package 

/routing/bgp/peer: tcp-md5-key
/routing/rip/interface: authentication-key
/routing/ospf/interface: authentication-key
/routing/ospf/virtual-link: authentication-key

routing-test package 

/routing/bgp/peer: tcp-md5-key
/routing/rip/interface: authentication-key
/routing/ospf/interface: authentication-key
/routing/ospf/virtual-link: authentication-key


Notes

There are three system groups which cannot be deleted: 

[admin@rb13] > /user group print
 0 name="read" policy=local,telnet,ssh,reboot,read,test,winbox,password,web,!ftp,!write,!policy

 1 name="write" policy=local,telnet,ssh,reboot,read,write,test,winbox,password,web,!ftp,!policy

 2 name="full" policy=local,telnet,ssh,ftp,reboot,read,write,policy,test,winbox,password,web

 3 name="test" policy=ssh,read,policy,!local,!telnet,!ftp,!reboot,!write,!test,!winbox,!password,!web
[admin@rb13] >

Exclamation sign '!' just before policy item name means NOT.


Example

To add reboot group that is allowed to reboot the router locally or using telnet, as well as read the router's configuration, enter the following command: 

[admin@rb13] user group> add name=reboot policy=telnet,reboot,read,local
[admin@rb13] user group> print
 0 name="read" policy=local,telnet,ssh,reboot,read,test,winbox,password,web,!ftp,!write,!policy

 1 name="write" policy=local,telnet,ssh,reboot,read,write,test,winbox,password,web,!ftp,!policy

 2 name="full" policy=local,telnet,ssh,ftp,reboot,read,write,policy,test,winbox,password,web

 3 name="reboot" policy=local,telnet,reboot,read,!ssh,!ftp,!write,!policy,!test,!winbox,!password,!web
[admin@rb13] user group>

Router Users

Sub-menu: /user


Router user database stores the information such as username, password, allowed access addresses and group about router management personnel.


Properties

Property Description
address (IP/mask | IPv6 prefix; Default: ) Host or network address from which the user is allowed to log in
group (string; Default: ) Name of the group the user belongs to
name (string; Default: ) User name. Although it must start with an alphanumeric character, it may contain "*", "_", "." and "@" symbols.
password (string; Default: ) User password. If not specified, it is left blank (hit [Enter] when logging in). It conforms to standard Unix characteristics of passwords and may contain letters, digits, "*" and "_" symbols.

Notes

There is one predefined user with full access rights: 

[admin@MikroTik] user> print
Flags: X - disabled
  #   NAME                                             GROUP ADDRESS
  0   ;;; system default user
      admin                                            full  0.0.0.0/0

[admin@MikroTik] user>

There always should be at least one user with fulls access rights. If the user with full access rights is the only one, it cannot be removed.

Monitoring Active Users

Sub-menu: /user active

/user active print command shows the currently active users along with respective statisics information.


Properties

All properties are read-only.

Property Description
address (IP/IPv6 address) Host IP/IPv6 address from which the user is accessing the router. 0.0.0.0 means that user is logged in locally
group (string) Group that user belongs to.
name (string) User name.
radius (true | false) Whether user is authenticated by RADIUS server.
via (console | telnet | ssh |winbox | api | web) User's access method
when (time) Time and date when user logged in.


Example

To print currently active users, enter the following command: 

[admin@dzeltenais_burkaans] /user active> print detail 
Flags: R - radius 
 0   when=dec/08/2010 16:19:24 name="admin" address=10.5.8.52 via=winbox 

 2   when=dec/09/2010 09:23:04 name="admin" address=10.5.101.38 via=telnet 

 3   when=dec/09/2010 09:34:27 name="admin" address=fe80::21a:4dff:fe5d:8e56 via=api

Remote AAA

Sub-menu: /user aaa

Router user remote AAA enables router user authentication and accounting via RADIUS server. The RADIUS user database is consulted only if the required username is not found in the local user database


Properties

Property Description
default-group (string; Default: read) User group used by default for users authenticated via RADIUS server.
interim-update (time; Default: 0s) Interim-Update time interval
use-radius (yes |no; Default: no) Enable user authentication via RADIUS


Note: If you are using RADIUS, you need to have CHAP support enabled in the RADIUS server for Winbox to work



SSH Keys

Sub-menu: /user ssh-keys

This menu allows to import public keys used for authentication.


Properties:

Property Description
user (string; Default: )


Read-only properties:

Property Description
key-owner (string)

Private keys

Sub-menu: /user ssh-keys private

This menu is used to import and list imported private keys. Private keys are used to authenticate remote login attempts using certificates.

Read-only properties:

Property Description
user (string)
key-owner (string)

Example

Read full example >>

Retrieved from "https://wiki.mikrotik.com/index.php?title=Manual:Router_AAA&oldid=20928"