src/jdk.management.agent/share/conf/jmxremote.password.template
author hb
Tue, 02 Jan 2018 13:20:18 +0530
branchjmx-rest-api
changeset 56003 4f7f76f6be2f
parent 48144 364207a23251
permissions -rw-r--r--
* Start Rest adapter via command line arguments * Rest adapter config via management.properties
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
# ----------------------------------------------------------------------
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
#           Template for jmxremote.password
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
#
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
# o Copy this template to jmxremote.password
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
# o Set the user/password entries in jmxremote.password
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
     6
# o Change the permission of jmxremote.password to be accessible
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
     7
#   only by the owner.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
     8
# o The jmxremote.passwords file will be re-written by the server
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
     9
#   to replace all plain text passwords with hashed passwords when
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    10
#   the file is read by the server.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
#
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
##############################################################
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
#        Password File for Remote JMX Monitoring
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
##############################################################
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
#
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
# Password file for Remote JMX API access to monitoring.  This
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
# file defines the different roles and their passwords.  The access
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
# control file (jmxremote.access by default) defines the allowed
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
# access for each role.  To be functional, a role must have an entry
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
# in both the password and the access files.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
#
27565
729f9700483a 8049367: Modular Run-Time Images
chegar
parents: 25859
diff changeset
    23
# Default location of this file is $JRE/conf/management/jmxremote.password
729f9700483a 8049367: Modular Run-Time Images
chegar
parents: 25859
diff changeset
    24
# You can specify an alternate location by specifying a property in
729f9700483a 8049367: Modular Run-Time Images
chegar
parents: 25859
diff changeset
    25
# the management config file $JRE/conf/management/management.properties
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
# or by specifying a system property (See that file for details).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
##############################################################
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    29
#    File format of the jmxremote.password file
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
##############################################################
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
#
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    32
# The file contains multiple lines where each line is blank,
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
# a comment (like this one), or a password entry.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
#
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    35
# password entry follows the below syntax
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    36
#   role_name W [clearPassword|hashedPassword]
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
#
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    38
# role_name is any string that does not itself contain spaces or tabs.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    39
# W = spaces or tabs
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    40
#
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    41
# Passwords can be specified via clear text or via a hash. Clear text password
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    42
# is any string that does not contain spaces or tabs. Hashed passwords must
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    43
# follow the below format.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    44
# hashedPassword = base64_encoded_64_byte_salt W base64_encoded_hash W hash_algorithm
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    45
# where,
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    46
#   base64_encoded_64_byte_salt = 64 byte random salt
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    47
#   base64_encoded_hash = Hash_algorithm(password + salt)
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    48
#   W = spaces or tabs
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    49
#   hash_algorithm = Algorithm string specified using the format below
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    50
#       https://docs.oracle.com/javase/9/docs/specs/security/standard-names.html#messagedigest-algorithms
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    51
#       This is an optional field. If not specified, SHA3-512 will be assumed.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    52
#
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    53
# If passwords are in clear, they will be overwritten by their hash if all of
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    54
# the below criteria are met.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    55
#   * com.sun.management.jmxremote.password.toHashes property is set to true in
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    56
#     management.properties file
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    57
#   * the password file is writable
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    58
#   * the system security policy allows writing into the password file, if a
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    59
#     security manager is configured
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    60
#
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    61
# In order to change the password for a role, replace the hashed password entry
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    62
# with a new clear text password or a new hashed password. If the new password
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    63
# is in clear, it will be replaced with its hash when a new login attempt is made.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
#
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
# A given role should have at most one entry in this file.  If a role
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
# has no entry, it has no access.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
# If multiple entries are found for the same role name, then the last one
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
# is used.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
#
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    70
# A user generated hashed password file can also be used instead of clear-text
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    71
# password file. If generated by the user, hashed passwords must follow the
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    72
# format specified above.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    73
#
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    74
# Caution: It is recommended not to edit the password file while the
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    75
# agent is running, as edits could be lost if a client connection triggers the
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    76
# hashing of the password file at the same time that the file is externally modified.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    77
# The integrity of the file is guaranteed, but any external edits made to the
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    78
# file during the short period between the time that the agent reads the file
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    79
# and the time that it writes it back might get lost
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    80
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    81
##############################################################
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    82
#    File permissions of the jmxremote.password file
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    83
##############################################################
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    84
#       This file must be made accessible by ONLY the owner,
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    85
#       otherwise the program will exit with an error.
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    86
#
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    87
# In a typical installation, this file can be accessed by anybody on the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
# local machine, and possibly by people on other machines.
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    89
# For security, you should either restrict the access to this file except for owner,
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
# or specify another, less accessible file in the management config file
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
# as described above.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
#
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    93
# In order to prevent inadverent edits to the password file in the 
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    94
# production environment, it is recommended to deploy a read-only 
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    95
# hashed password file. The hashed entries for clear passwords can be generated 
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    96
# in advance by running the JMX agent.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
#
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
48144
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
    99
##############################################################
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   100
#    Sample of the jmxremote.password file
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   101
##############################################################
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   102
# Following are two commented-out entries.  The "monitorRole" role has
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   103
# password "QED".  The "controlRole" role has password "R&D". This is an example
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   104
# of specifying passwords in the clear
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   105
#
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   106
#   monitorRole  QED
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   107
#   controlRole  R&D
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   108
# 
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   109
# Once a login attempt is made, passwords will be hashed and the file will have 
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   110
# below entries with clear passwords overwritten by their respective 
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   111
# SHA3-512 hash
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   112
#
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   113
#   monitorRole trilby APzBTt34rV2l+OMbuvbnOQ4si8UZmfRCVbIY1+fAofV5CkQzXS/FDMGteQQk/R3q1wtt104qImzJEA7gCwl6dw== 4EeTdSJ7X6Imu0Mb+dWqIns7a7QPIBoM3NB/XlpMQSPSicE7PnlALVWn2pBY3Q3pGDHyAb32Hd8GUToQbUhAjA== SHA3-512
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   114
#   controlRole roHEJSbRqSSTII4Z4+NOCV2OJaZVQ/dw153Fy2u4ILDP9XiZ426GwzCzc3RtpoqNMwqYIcfdd74xWXSMrWtGaA== w9qDsekgKn0WOVJycDyU0kLBa081zbStcCjUAVEqlfon5Sgx7XHtaodbmzpLegA1jT7Ag36T0zHaEWRHJe2fdA== SHA3-512
364207a23251 5016517: Replace plaintext passwords by hashed passwords for out-of-the-box JMX Agent
hb
parents: 47216
diff changeset
   115
#