modpib.1.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. <?xml version='1.0' encoding='iso-8859-1'?>
  2. <!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  3. <html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
  4. <head>
  5. <title>
  6. modpib.1
  7. </title>
  8. <meta http-equiv='content-type' content='text/html;iso-8859-1'/>
  9. <meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
  10. <meta name='author' content='cmaier@cmassoc.net'/>
  11. <meta name='robots' content='noindex,nofollow'/>
  12. <link href='toolkit.css' rel='stylesheet' type='text/css'/>
  13. </head>
  14. <body>
  15. <div class='headerlink'>
  16. [<a href='mme.1.html' title=' mme.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='nics.1.html' title=' nics.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. modpib(1) Qualcomm Atheros Open Powerline Toolkit modpib(1)
  22. NAME
  23. modpib - Qualcomm Atheros PIB File Editor
  24. SYNOPSIS
  25. modpib [options] filename
  26. DESCRIPTION
  27. Change device identity parameters in a PIB file and update the checksum. Device identity parameters are the MAC, DAK,
  28. NMK and the Manufacturer, Network and User HFID. Collectively, they establish the device network identity.
  29. This program is the safe way to edit identity parameters since only valid PIB files can be edited and only selected val‐
  30. ues changed. In addition, critical cross-parameter updates are automatically applied.
  31. This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
  32. instructions.
  33. OPTIONS
  34. -C mode
  35. Set Central Coordinator Selection mode. Permitted values for mode are 0=Auto, 1=Never, 2=Always, 3=UserAssigned
  36. and 4=Covert.
  37. -D xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
  38. The new Device Access Key (DAK). This key will replace the original DAK. Keys are 16 hex octet strings. Octets
  39. may be seperated by optional colons. The symbol none, key1 or key2 may be specified in place of a hexadecimal
  40. string, for convenience. Use program hpavkey to compute the DAK for a specific password, if required.
  41. -L level
  42. Set security level. The security level is written into the PreferredNID. Level 0 enables pushbutton pairing.
  43. Level 1 disables it. The default secutity level is 0.
  44. -M xx:xx:xx:xx:xx:xx
  45. The new Media Access Control (MAC) address. This address will replace the original address, if specified.
  46. Addresses are 6 hex octet strings. Octets may be seperated by optional colons. Qualcomm Atheros powerline
  47. devices derive their MAC address from their PIB and each device on a network must have a unique address. To
  48. facilitate the assignement of unique addresses, substituting the word &quot;auto&quot;, &quot;next&quot; or &quot;plus&quot; will cause the
  49. original MAC address to be incremented before a new checksum is calculated. Successive uses of this option will
  50. continue to increment the stored address. You can inspect the stored MAC address with &quot;chkpib -v pibfile&quot;.
  51. -N xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
  52. The new Network Membership Key (NMK). This key will replace the original NMK, create a new PreferredNID and clear
  53. the AVLNMembership bit. Keys are 16 hex octets. Optionally, octets may be seperated colons. The symbol key1 or
  54. key2 can be specified in place of a hexadecimal string, for convenience. Use program hpavkey to compute the NMK
  55. from a specific password, if required.
  56. -P filename
  57. The specified file is loaded from disk and written into the prescaler section of the PIB. This file must be in
  58. the format used by the Qualcomm Atheros Windows Device Manager, which is a two column file, each column consisting
  59. of 8 ASCII alpha-numeric characters. The first column corresponds to the array index value (00000000 through
  60. 00001155, decimal), and the second column is the value stored at that position in the prescaler array (00000000
  61. through 000000ff, hexadecimal). The two columns may be separated by any whitespace characters when using this
  62. tool. However, for full compatibility with the Windows Device Manager it is advised to use a single space between
  63. the columns. The '#' character may also be used at the start of a line to denote a comment.
  64. -S string
  65. The new manufacturing string. The maximum length is 63 characters.
  66. -T string
  67. The new network name string. The maximum length is 63 character.
  68. -U string
  69. The new username string. The maximum length is 63 characters.
  70. -q Enable quiet mode. This option has no effect at present.
  71. -v Print PIB identity parameters on stdout after changes have been applied. This option helps verify that changes
  72. have been applied correctly. It can also be used, without changes, to merely inspect existing parameters.
  73. -?,--help
  74. Print program help summary on stdout. This option takes precedence over other options on the command line.
  75. -!,--version
  76. Print program version information on stdout. This option takes precedence over other options on the command line.
  77. Use this option when sending screen dumps to Qualcomm Atheros Technical Support so that they know exactly which
  78. version of the Linux Toolkit you are using.
  79. ARGUMENTS
  80. filename
  81. The name of the PIB file to be modified. No assumptions are made based on filename and no filename conventions
  82. are enforced.
  83. KEYS
  84. Encryption keys are long, tedious to type and prone to error. For convenience, symbolic names may be used to specify the
  85. key for options -D and -N. Symbolic name &quot;none&quot; translates to zeros. Symbolic name &quot;key1&quot; translates to the HomePlug AV
  86. compliant key for pass phrase &quot;HomePlugAV&quot;. Symbolic name &quot;key2&quot; translates to the HomePlug AV compliant key for pass
  87. phrase &quot;HomePlugAV0123&quot;. The actual key that is generated for key1 or key2 will differ depending on context.
  88. EXAMPLES
  89. The following example replaces the MAC address in pib file abc.pib and computes a new checksum. The input file is over-
  90. written. A command like this one can be used to establish the start MAC address when downloading a series of PIBs.
  91. # modpib -M 00:b0:52:DA:DA:FF abc.pib
  92. The following example increments the MAC address in pib file abc.pib and computes a new checksum. The word auto, next or
  93. plus, in place of a MAC address, will increment the old address each time the command is executed. This command can be
  94. used to ensure that unique and consecutive MAC addresses are used each time a PIB is downloaded.
  95. # modpib -M auto abc.pib
  96. The following command updates pib file abc.pib with the DAK and NMK read from the device connected to eth0. In similar
  97. fashion, program rkey can be used to compute random key values from a keyfile.
  98. # modpib -D $(int6kid -Di eth0) -N $(rkey secret.key -M) abc.pib
  99. The following example displays the current value of keys and strings stored in pib file abc.pib because option -v is
  100. present. This can be used to verify PIB identity settings before or after an edit.
  101. # modpib -v abc.pib
  102. PIB 4-4 15560 bytes
  103. MAC 00:B0:52:00:00:01
  104. DAK 68:9F:07:4B:8B:02:75:A2:71:0B:0B:57:79:AD:16:30 (HomePlugAV)
  105. NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
  106. NID B0:F2:E6:95:66:6B:03
  107. NET Qualcomm Atheros Enabled Network
  108. MFG Qualcomm Atheros HomePlug AV Device
  109. USR Qualcomm Atheros Enabled Product
  110. CCo Auto
  111. MDU N/A
  112. DISCLAIMER
  113. PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
  114. available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
  115. out any obligation to notify or compensate users of this program.
  116. SEE ALSO
  117. chkpib(7), chkpib2(7), getpib(7), modpib(1), pib2xml(1), pibcomp(1), pibdump(1), setpib(1), xml2pib(1)
  118. CREDITS
  119. Nathaniel Houghton &lt;nhoughto@qca.qualcomm.com&gt;
  120. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  121. open-plc-utils-0.0.3 Mar 2014 modpib(1)
  122. </pre>
  123. <div class='footerlink'>
  124. [<a href='mme.1.html' title=' mme.1 '>PREV</a>]
  125. [<a href='toolkit.html' title=' Index '>HOME</a>]
  126. [<a href='nics.1.html' title=' nics.1 '>NEXT</a>]
  127. </div>
  128. </body>
  129. </html>