Annotation of embedaddon/iperf/docs/news.rst, revision 1.1.1.3

1.1       misho       1: iperf3 Project News
                      2: ===================
                      3: 
1.1.1.3 ! misho       4: 2023-07-07:  iperf-3.14 released
        !             5: --------------------------------
        !             6: | URL:  https://downloads.es.net/pub/iperf/iperf-3.14.tar.gz
        !             7: | SHA256:  ``723fcc430a027bc6952628fa2a3ac77584a1d0bd328275e573fc9b206c155004``
        !             8: 
        !             9: iperf 3.14 fixes a memory allocation hazard that allowed a remote user
        !            10: to crash an iperf3 process (server or client).
        !            11: 
        !            12: More information on this specific fix can be found at:
        !            13: 
        !            14: https://downloads.es.net/pub/iperf/esnet-secadv-2023-0001.txt.asc
        !            15: 
        !            16: This version of iperf3 also includes a number of minor bug fixes,
        !            17: which are summarized in the release notes.
        !            18: 
        !            19: 2023-02-16:  iperf-3.13 released
        !            20: ----------------------------------
        !            21: | URL:  https://downloads.es.net/pub/iperf/iperf-3.13.tar.gz
        !            22: | SHA256:  ``bee427aeb13d6a2ee22073f23261f63712d82befaa83ac8cb4db5da4c2bdc865``
        !            23: 
        !            24: iperf 3.13 is primarily a bugfix release.
        !            25: 
        !            26: 
        !            27: 2022-09-30:  iperf-3.12 released
        !            28: ----------------------------------
        !            29: | URL:  https://downloads.es.net/pub/iperf/iperf-3.12.tar.gz
        !            30: | SHA256:  ``72034ecfb6a7d6d67e384e19fb6efff3236ca4f7ed4c518d7db649c447e1ffd6``
        !            31: 
        !            32: iperf 3.12 is principally a bugfix release, although it includes an
        !            33: updated version of cJSON and adds a few new features.
        !            34: 
        !            35: 
        !            36: 2022-01-28:  iperf-3.11 released
        !            37: ----------------------------------
        !            38: | URL:  https://downloads.es.net/pub/iperf/iperf-3.11.tar.gz
        !            39: | SHA256:  ``de8cb409fad61a0574f4cb07eb19ce1159707403ac2dc01b5d175e91240b7e5f``
        !            40: 
        !            41: iperf 3.11 is principally a bugfix release. Also GitHub
        !            42: Discussions are now supported.
        !            43: 
        !            44: 
        !            45: 2021-06-02:  iperf-3.10.1 released
        !            46: ----------------------------------
        !            47: 
        !            48: | URL:  https://downloads.es.net/pub/iperf/iperf-3.10.1.tar.gz
        !            49: | SHA256:  ``03bc9760cc54a245191d46bfc8edaf8a4750f0e87abca6764486972044d6715a  iperf-3.10.1.tar.gz``
        !            50: 
        !            51: iperf 3.10.1 fixes a problem with the configure script that made it
        !            52: make not work correctly in some circumstances. It is functionally
        !            53: identical to iperf 3.10.
        !            54: 
        !            55: 2021-05-26:  iperf-3.10 released
        !            56: --------------------------------
        !            57: 
        !            58: | URL:  https://downloads.es.net/pub/iperf/iperf-3.10.tar.gz
        !            59: | SHA256:  ``4390982928542256c17d6dd1f56eede9092649ebfd8a97c8cecfad12d238ad57  iperf-3.10.tar.gz``
        !            60: 
        !            61: iperf 3.10 is principally a bugfix release. A few new features have
        !            62: been added (``--time-skew-threshold``, ``--bind-dev``,
        !            63: ``--rcv-timeout``, and ``--dont-fragment``).  More information on
        !            64: these new features can be found in the release notes.
        !            65: 
        !            66: 2020-08-17:  iperf-3.9 released
        !            67: ---------------------------------
        !            68: 
        !            69: | URL:  https://downloads.es.net/pub/iperf/iperf-3.9.tar.gz
        !            70: | SHA256:  ``24b63a26382325f759f11d421779a937b63ca1bc17c44587d2fcfedab60ac038  iperf-3.9.tar.gz``
        !            71: 
        !            72: iperf 3.9 adds a ``--timestamps`` flag, which prepends a timestamp to
        !            73: each output line.  A new ``--server-bitrate-limit`` flag has been
        !            74: added as a server command-line argument, and allows an iperf3 server
        !            75: to enforce a maximum throughput rate.  More information on these new
        !            76: features can be found in the release notes.
        !            77: 
1.1.1.2   misho      78: 2020-06-10:  iperf-3.8.1 released
                     79: ---------------------------------
                     80: 
                     81: | URL:  https://downloads.es.net/pub/iperf/iperf-3.8.1.tar.gz
                     82: | SHA256:  ``e5b080f3273a8a715a4100f13826ac2ca31cc7b1315925631b2ecf64957ded96 iperf-3.8.1.tar.gz``
                     83: 
                     84: iperf 3.8.1 fixes a regression with ``make install`` in iperf 3.8.  It
                     85: is otherwise identical to iperf 3.8.
                     86: 
                     87: 2020-06-08:  iperf-3.8 released
                     88: -------------------------------
                     89: 
                     90: | URL:  https://downloads.es.net/pub/iperf/iperf-3.8.tar.gz
                     91: | SHA256:  ``edc1c317b0ae31925e5eb84f0295faefbaa1db3229f4693e11d954d114de4bcd  iperf-3.8.tar.gz``
                     92: 
                     93: iperf 3.8 contains minor bugfixes and enhancements.
                     94: 
                     95: 
                     96: 2019-06-21:  iperf-3.7 released
                     97: -------------------------------
                     98: 
                     99: | URL:  https://downloads.es.net/pub/iperf/iperf-3.7.tar.gz
                    100: | SHA256:  ``d846040224317caf2f75c843d309a950a7db23f9b44b94688ccbe557d6d1710c  iperf-3.7.tar.gz``
                    101: 
                    102: iperf 3.7 adds the ``--bidir`` flag for bidirectional tests, includes
                    103: some minor enhancements, and fixes a number of bugs.  More details can
                    104: be found in the release notes.
                    105: 
                    106: Note:  Documentation for the ``--bidir`` flag was inadvertently
                    107: omitted from the manual page.  This will be fixed in a future
                    108: release.
                    109: 
                    110: 2018-06-25:  iperf-3.6 released
                    111: -------------------------------
                    112: 
                    113: | URL:  https://downloads.es.net/pub/iperf/iperf-3.6.tar.gz
                    114: | SHA256:  ``de5d51e46dc460cc590fb4d44f95e7cad54b74fea1eba7d6ebd6f8887d75946e  iperf-3.6.tar.gz``
                    115: 
                    116: iperf 3.6 adds the ``--extra-data`` and ``--repeating-payload``
                    117: options and fixes some minor bugs.
                    118: 
                    119: 2018-03-02:  iperf-3.5 released
                    120: -------------------------------
                    121: 
                    122: | URL:  http://downloads.es.net/pub/iperf/iperf-3.5.tar.gz
                    123: | SHA256:  ``539bd9ecdca1b8c1157ff85b70ed09b3c75242e69886fc16b54883b399f72cd5  iperf-3.5.tar.gz``
                    124: 
                    125: iperf 3.5 fixes a bug that could over-count data transfers (and hence
                    126: measured bitrate).
                    127: 
                    128: 2018-02-14:  iperf-3.4 released
                    129: -------------------------------
                    130: 
                    131: | URL:  http://downloads.es.net/pub/iperf/iperf-3.4.tar.gz
                    132: | SHA256:  ``71528332d751df85e046d1944d9a0269773cadd6e51840aecdeed30925f79111  iperf-3.4.tar.gz``
                    133: 
                    134: iperf 3.4 fixes a number of minor bugs and adds a few enhancements.
                    135: 
                    136: 2017-10-31:  iperf-3.3 released
                    137: -------------------------------
                    138: 
                    139: | URL:  http://downloads.es.net/pub/iperf/iperf-3.3.tar.gz
                    140: | SHA256:  ``6f596271251056bffc11bbb8f17d4244ad9a7d4a317c2459fdbb853ae51284d8  iperf-3.3.tar.gz``
                    141: 
                    142: New minor release of iperf 3.3, fixing a number of minor bugs.
                    143: 
                    144: 2017-06-26:  iperf-3.2 released
                    145: -------------------------------
                    146: 
                    147: | URL:  http://downloads.es.net/pub/iperf/iperf-3.2.tar.gz
                    148: | SHA256:  ``f207b36f861485845dbdf09f909c62f3d2222a3cf3d2682095aede8213cd9c1d  iperf-3.2.tar.gz``
                    149: 
                    150: New minor release of iperf 3.2, with new features, bugfixes, and enhancements.
                    151: 
                    152: 2017-06-06:  iperf3 update, June 2017
                    153: --------------------------------------
                    154: 
                    155: https://raw.githubusercontent.com/esnet/iperf/master/docs/2017-06-06.txt
                    156: 
                    157: 
                    158: 2017-04-27:  iperf3 update, April 2017
                    159: --------------------------------------
                    160: 
                    161: https://raw.githubusercontent.com/esnet/iperf/master/docs/2017-04-27.txt
                    162: 
                    163: 
                    164: 2017-03-06:  iperf-3.1.7 released
                    165: ---------------------------------
                    166: 
                    167: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.7.tar.gz
                    168: | SHA256:  ``a4ef73406fe92250602b8da2ae89ec53211f805df97a1d1d629db5a14043734f  iperf-3.1.7.tar.gz``
                    169: 
                    170: This version of iperf3 contains two documentation fixes, but is
                    171: otherwise identical to the prior release.
                    172: 
                    173: 
                    174: 2017-02-02:  iperf-3.1.6 released
                    175: ---------------------------------
                    176: 
                    177: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.6.tar.gz
                    178: | SHA256:  ``70f0c72d9e60c6ecb2c478ed17e4fd81d3b827d57896fee43bcd0c53abccb29d  iperf-3.1.6.tar.gz``
                    179: 
                    180: This version of iperf3 contains two minor fixes.  Notably, one of them
                    181: unbreaks JSON output with UDP tests.
                    182: 
                    183: 
                    184: 2017-01-12:  iperf-3.1.5 released
                    185: ---------------------------------
                    186: 
                    187: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.5.tar.gz
                    188: | SHA256:  ``6e1a6200cd38baeab58ef0d7b8769e7aa6410c3a3168e65ea8277a4de79e5500  iperf-3.1.5.tar.gz``
                    189: 
                    190: This version of iperf3 makes some improvements to the fair-queue-based
                    191: pacing and improves the selection of the default UDP packet size.
                    192: Users who use either of these aspects of iperf3 are encourage to
                    193: review the release notes for this version.
                    194: 
                    195: 
                    196: 2016-10-31:  iperf-3.1.4 released
                    197: ---------------------------------
                    198: 
                    199: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.4.tar.gz
                    200: | SHA256:  ``db61d70ac62003ebe0bf15496bd8c4b3c4b728578a44d0a1a88fcf8afc0e8f76  iperf-3.1.4.tar.gz``
                    201: 
                    202: This release fixes a few minor bugs, including a
                    203: (non-security-impacting) buffer overflow fix ported from upstream
                    204: cjson.
                    205: 
                    206: 
                    207: 2016-06-08:  Security Issue:  iperf-3.1.3, iperf-3.0.12 released
                    208: ----------------------------------------------------------------
                    209: 
                    210: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.3.tar.gz
                    211: | SHA256:  ``60d8db69b1d74a64d78566c2317c373a85fef691b8d277737ee5d29f448595bf  iperf-3.1.3.tar.gz``
                    212: 
                    213: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.12.tar.gz
                    214: | SHA256:  ``9393d646e4e616f0cd7864bc8ceacc379f5d36b08003a3d8d65cd7c99d15daec  iperf-3.0.12.tar.gz``
                    215: 
                    216: These releases address a security issue that could cause a crash of an
                    217: iperf3 process (it could theoretically lead to a remote code
                    218: execution).  Although the risk for common use cases is believed to be
                    219: low, all users are encouraged to update to these versions or newer as
                    220: soon as possible.  More information on the security vulnerability can
                    221: be found in the following ESnet Software Security Advisory:
                    222: 
                    223: https://raw.githubusercontent.com/esnet/security/master/cve-2016-4303/esnet-secadv-2016-0001.txt.asc
                    224: 
                    225: iperf-3.1.3 also includes support for fair-queueing, per-socket based
                    226: pacing of tests on platforms that support it (currently recent Linux
                    227: distributions), as well as several other fixes.
                    228: 
                    229: 
                    230: 2016-02-01:  iperf-3.1.2 released
                    231: ---------------------------------
                    232: 
                    233: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.2.tar.gz
                    234: | SHA256:  ``f9dbdb99f869c077d14bc1de78675f5e4b8d1bf78dc92381e96c3eb5b1fd7d86  iperf-3.1.2.tar.gz``
                    235: 
                    236: This release fixes a couple of minor bugs, including one that results
                    237: in invalid JSON being emitted for UDP tests.
                    238: 
                    239: Older News
                    240: ----------
                    241: 
                    242: 2015-11-19:  iperf-3.1.1 released
                    243: .................................
                    244: 
                    245: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.1.tar.gz
                    246: | SHA256:  ``62f7c64eafe19046ba974b3ef2d962a5597194d6fbbddde328a15a5e74110564  iperf-3.1.1.tar.gz``
                    247: 
                    248: This release fixes a few minor bugs.
                    249: 
                    250: 2015-10-16:  iperf3 Development Status
                    251: ......................................
                    252: 
                    253: Beginning with the release of iperf 3.1, ESnet plans to support iperf3
                    254: in "maintenance mode".  At this point, we have no definite plans for
                    255: further iperf3 releases, and ESnet will be providing a very limited
                    256: amount of resources for support and development, going forward.
                    257: However, ESnet could issue new iperf3 releases to deal with security
                    258: issues or high-impact bug fixes.
                    259: 
                    260: Requests for support, enhancements, and questions should best be
                    261: directed to the iperf-dev mailing list.  ESnet would be open to adding
                    262: project members/committers from the community, in case there are
                    263: developers who are interested in doing more active work with iperf3
                    264: and/or supporting the user base.
                    265: 
                    266: 
                    267: 2015-10-16:  iperf-3.1 released
                    268: ...............................
                    269: 
                    270: | URL:  http://downloads.es.net/pub/iperf/iperf-3.1.tar.gz
                    271: | SHA256:  ``4385a32ece25cb09d4606b4c99316356b3d2cb03b318aa056b99cdb91c5ce656  iperf-3.1.tar.gz``
                    272: 
                    273: This release adds support for SCTP on supported platforms, better
                    274: feature detection on FreeBSD, better compatibility with various
                    275: platforms, and a number of bug fixes.
                    276: 
                    277: 
1.1       misho     278: 2015-01-09:  iperf-3.0.11 released
1.1.1.2   misho     279: ..................................
1.1       misho     280: 
                    281: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.11.tar.gz
                    282: | SHA256:  ``e01db5be6f47f67c987463095fe4f5b8b9ff891fb92c39104d042ad8fde97f6e  iperf-3.0.11.tar.gz``
                    283: 
                    284: This maintenance release adds a -1 flag to make the iperf3 execute a
                    285: single test and exit, needed for an upcoming bwctl release.  A few
                    286: other bugs are also fixed.
                    287: 
                    288: 2014-12-16:  iperf-3.0.10 released
1.1.1.2   misho     289: ..................................
1.1       misho     290: 
                    291: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.10.tar.gz
                    292: | SHA256:  ``a113442967cf0981b0b2d538be7c88903b2fb0f87b0d281384e41b462e33059d  iperf-3.0.10.tar.gz``
                    293: 
                    294: This maintenance release fixes building on MacOS X Yosemite, as well
                    295: as making the -w option work correctly with UDP tests.
                    296: 
                    297: 2014-10-14:  iperf-3.0.9 released
1.1.1.2   misho     298: .................................
1.1       misho     299: 
                    300: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.9.tar.gz
                    301: | SHA256:  ``40249a2b30d26b937350b969bcb19f88e1beb356f886ed31422b554bac692459  iperf-3.0.9.tar.gz``
                    302: 
                    303: This maintenance release fixes an issue for a situation in which
                    304: attempting a UDP test with pathologically large (and illegal) packet
                    305: sizes could put the iperf3 server in a state where it would stop
                    306: accepting connections from clients, thus causing the clients to crash
                    307: when interrupted.
                    308: 
                    309: 
                    310: 2014-09-30:  iperf-3.0.8 released
1.1.1.2   misho     311: .................................
1.1       misho     312: 
                    313: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.8.tar.gz
                    314: | SHA256:  ``81b8d91159862896c57f9b90a006e8b5dc22bd94175d97bd0db50b0ae2c1a78e  iperf-3.0.8.tar.gz``
                    315: 
                    316: This maintenance release is functionally identical to 3.0.7.  It
                    317: incorporates updated license verbage and a minor compilation fix.
                    318: 
                    319: 
                    320: 2014-08-28:  iperf-3.0.7 released
1.1.1.2   misho     321: .................................
1.1       misho     322: 
                    323: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.7.tar.gz
                    324: | SHA256:  ``49510e886f9e876cd73dcd80414bfb8c49b147c82125585e09c2a6e92369d3f2  iperf-3.0.7.tar.gz``
                    325: 
                    326: This maintenance release fixes several minor bugs.  Of particular
                    327: note:
                    328: 
                    329: * A bug that caused some problems with bwctl / perfSONAR has been
                    330:   fixed.
                    331: 
                    332: * A bug that made it possible to disrupt existing, running tests has
                    333:   been fixed.
                    334: 
                    335: 2014-07-28:  iperf-3.0.6 released
1.1.1.2   misho     336: .................................
1.1       misho     337: 
                    338: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.6.tar.gz
                    339: | SHA256:  ``3c5909c9b286b6503ffa141a94cfc588915d6e67f2aa732b08df0af73e21938  iperf-3.0.6.tar.gz``
                    340: 
                    341: This maintenance release includes the following bug fixes:
                    342: 
                    343: * Several problems with the -B option have been fixed.  Also, API
                    344:   calls have been added to libiperf to extend this functionality to
                    345:   API clients.
                    346: 
                    347: * Some portability fixes for OpenBSD and Solaris have been merged from
                    348:   the mainline.
                    349: 
1.1.1.3 ! misho     350: As always, more details can be found in the ``RELNOTES.md`` file in
1.1       misho     351: the source distribution.
                    352: 
                    353: 2014-06-16:  Project documentation on GitHub Pages
                    354: ..................................................
                    355: 
                    356: iperf3 project documentation can now be found at:
                    357: 
                    358: | URL:  http://software.es.net/iperf/
                    359: 
                    360: This is a GitHub Pages site.  In an ongoing series of steps, content
                    361: will be migrated from the iperf3 wiki to GitHub Pages.
                    362: 
                    363: 2014-06-16:  iperf-3.0.5 released
                    364: .................................
                    365: 
                    366: | URL:  http://downloads.es.net/pub/iperf/iperf-3.0.5.tar.gz
                    367: | SHA256:  ``e1e1989985b17a4c03b0fa207004ad164b137e37ab0682fecbf5e93bcaa920a6  iperf-3.0.5.tar.gz``
                    368: 
                    369: This is the third maintenance release of iperf 3, with few more
                    370: enhancements and bug fixes.  Highlights:
                    371: 
                    372: * A timing issue which caused measurement intervals to be wrong with
                    373:   TCP tests on lossy networks has been fixed.
                    374: 
                    375: * It is now possible to get (most of) the server-side output at
                    376:   the client by using the ``--get-server-output`` flag.
                    377: 
                    378: * A number of bugs with ``--json`` output have been fixed.
                    379: 
                    380: A more extensive list of changes can always be found in the
1.1.1.3 ! misho     381: ``RELNOTES.md`` file in the source distribution.
1.1       misho     382: 
                    383: Note:  An iperf-3.0.4 release was planned and tagged, but not
                    384: officially released.
                    385: 
                    386: 2014-06-10:  New iperf3 download site
                    387: .....................................
                    388: 
                    389: iperf3 downloads are now hosted on a new server at ESnet:
                    390: 
                    391: | URL:  http://downloads.es.net/pub/iperf/
                    392: 
                    393: Going forward, new releases will be made available in this directory.
                    394: Older releases will, at least for now, continue to also be available
                    395: at the previous location.
                    396: 
                    397: 2014-03-26:  iperf-3.0.3 released
                    398: .................................
                    399: 
                    400: | URL:  http://stats.es.net/software/iperf-3.0.3.tar.gz
                    401: | SHA256:  ``79daf3e5e5c933b2fc4843d6d21c98d741fe39b33ac05bd7a11c50d321a2f59d  iperf-3.0.3.tar.gz``
                    402: 
                    403: This is the second maintenance release of iperf 3.0, containing a few bug fixes and enhancements, notably:
                    404: 
                    405: * The structure of the JSON output is more consistent between the
                    406:   cases of one stream and multiple streams.
                    407: 
                    408: * The example programs once again build correctly.
                    409: 
                    410: * A possible buffer overflow related to error output has been fixed.
                    411:   (This is not believed to be exploitable.)
                    412: 
1.1.1.3 ! misho     413: More information on changes can be found in the ``RELNOTES.md``
1.1       misho     414: file in the source distribution.
                    415: 
                    416: 2014-03-10:  iperf-3.0.2 released
                    417: .................................
                    418: 
                    419: | URL:  http://stats.es.net/software/iperf-3.0.2.tar.gz
                    420: | SHA256:  ``3c379360bf40e6ac91dfc508cb43fefafb4739c651d9a8d905a30ec99095b282  iperf-3.0.2.tar.gz``
                    421: 
                    422: **Note:**  Due to a mistake in the release process, the distribution tarball referred to above is actually not compressed, despite its ``.tar.gz`` extension.  Instead it is an uncompressed tar archive.  The file checksum is correct, as are the file contents.
                    423: 
                    424: This version is a maintenance release that
                    425: fixes a number of bugs, many reported by users, adds a few minor
                    426: enhancements, and tracks the migration of the iperf3 project to
                    427: GitHub.  Of particular interest:
                    428: 
                    429: * Build / runtime fixes for CentOS 5, MacOS 10.9, and FreeBSD.
                    430: 
                    431: * TCP snd_cwnd output on Linux in the default output format.
                    432: 
                    433: * libiperf is now built as both a shared and static library; by
                    434:   default, the iperf3 binary links to the shared library.
                    435: 
1.1.1.3 ! misho     436: More information on changes can be found in the ``RELNOTES.md``
1.1       misho     437: file in the source distribution.
                    438: 
                    439: 2014-02-28:  iperf migrated to GitHub
                    440: .....................................
                    441: 
                    442: The new project page can be found at:
                    443: 
                    444: https://github.com/esnet/iperf
                    445: 
                    446: 2014-01-10:  iperf-3.0.1 released
                    447: .................................
                    448: 
                    449: | URL:  http://stats.es.net/software/iperf-3.0.1.tar.gz
                    450: | SHA256:  ``32b419ef634dd7670328c3cecc158babf7d706bd4b3d248cf95965528a20e614 iperf-3.0.1.tar.gz``
                    451: 
                    452: During development, there were various distributions of the source
                    453: code unofficially released carrying a 3.0.0 version number.  Because
1.1.1.3 ! misho     454: of the possibility for confusion, this first public release of iperf3
1.1       misho     455: was numbered 3.0.1.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>