19 KiB
ramsey/uuid Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Unreleased
Added
Changed
Deprecated
Removed
Fixed
Security
3.9.3 - 2020-02-20
Fixed
-
For v1 UUIDs, round down for timestamps so that microseconds do not bump the timestamp to the next second.
As an example, consider the case of timestamp
1
with600000
microseconds (1.600000
). This is the first second after midnight on January 1, 1970, UTC. Previous versions of this library had a bug that would round this to2
, so the rendered time was1970-01-01 00:00:02
. This was incorrect. Despite having600000
microseconds, the time should not round up to the next second. Rather, the time should be1970-01-01 00:00:01.600000
. Since this version of ramsey/uuid does not support microseconds, the microseconds are dropped, and the time is1970-01-01 00:00:01
. No rounding should occur.
3.9.2 - 2019-12-17
Fixed
- Check whether files returned by
/sys/class/net/*/address
are readable before attempting to read them. This avoids a PHP warning that was being emitted on hosts that do not grant permission to read these files.
3.9.1 - 2019-12-01
Fixed
- Fix
RandomNodeProvider
behavior on 32-bit systems. TheRandomNodeProvider
was converting a 6-byte string to a decimal number, which is a 48-bit, unsigned integer. This caused problems on 32-bit systems and has now been resolved.
3.9.0 - 2019-11-30
Added
- Add function API as convenience. The functions are available in the
Ramsey\Uuid
namespace.v1(int|string|null $node = null, int|null $clockSeq = null): string
v3(string|UuidInterface $ns, string $name): string
v4(): string
v5(string|UuidInterface $ns, string $name): string
Changed
- Use paragonie/random-lib instead of ircmaxell/random-lib. This is a non-breaking change.
- Use a high-strength generator by default, when using
RandomLibAdapter
. This is a non-breaking change.
Deprecated
These will be removed in ramsey/uuid version 4.0.0:
MtRandGenerator
,OpenSslGenerator
, andSodiumRandomGenerator
are deprecated in favor of using the defaultRandomBytesGenerator
.
Fixed
- Set
ext-json
as a required dependency incomposer.json
. - Use
PHP_OS
instead ofphp_uname()
when determining the system OS, for cases whenphp_uname()
is disabled for security reasons.
3.8.0 - 2018-07-19
Added
- Support discovery of MAC addresses on FreeBSD systems
- Use a polyfill to provide PHP ctype functions when running on systems where the ctype functions are not part of the PHP build
- Disallow a trailing newline character when validating UUIDs
- Annotate thrown exceptions for improved IDE hinting
3.7.3 - 2018-01-19
Fixed
- Gracefully handle cases where
glob()
returns false when searching/sys/class/net/*/address
files on Linux - Fix off-by-one error in
DefaultTimeGenerator
Security
- Switch to
random_int()
frommt_rand()
for better random numbers
3.7.2 - 2018-01-13
Fixed
- Check sysfs on Linux to determine the node identifier; this provides a reliable way to identify the node on Docker images, etc.
3.7.1 - 2017-09-22
Fixed
- Set the multicast bit for random nodes, according to RFC 4122, §4.5
Security
- Use
random_bytes()
when generating random nodes
3.7.0 - 2017-08-04
Added
- Add the following UUID version constants:
Uuid::UUID_TYPE_TIME
Uuid::UUID_TYPE_IDENTIFIER
Uuid::UUID_TYPE_HASH_MD5
Uuid::UUID_TYPE_RANDOM
Uuid::UUID_TYPE_HASH_SHA1
3.6.1 - 2017-03-26
Fixed
- Optimize UUID string decoding by using
str_pad()
instead ofsprintf()
3.6.0 - 2017-03-18
Added
- Add
InvalidUuidStringException
, which is thrown when attempting to decode an invalid string UUID; this does not introduce any BC issues, since the new exception inherits from the previously usedInvalidArgumentException
Fixed
- Improve memory usage when generating large quantities of UUIDs (use
str_pad()
anddechex()
instead ofsprintf()
)
3.5.2 - 2016-11-22
Fixed
- Improve test coverage
3.5.1 - 2016-10-02
Fixed
- Fix issue where the same UUIDs were not being treated as equal when using mixed cases
3.5.0 - 2016-08-02
Added
- Add
OrderedTimeCodec
to store UUID in an optimized way for InnoDB
Fixed
- Fix invalid node generation in
RandomNodeProvider
- Avoid multiple unnecessary system calls by caching failed attempt to retrieve system node
3.4.1 - 2016-04-23
Fixed
- Fix test that violated a PHP CodeSniffer rule, breaking the build
3.4.0 - 2016-04-23
Added
- Add
TimestampFirstCombCodec
andTimestampLastCombCodec
codecs to provide the ability to generate COMB sequential UUIDs with the timestamp encoded as either the first 48 bits or the last 48 bits - Improve logic of
CombGenerator
for COMB sequential UUIDs
3.3.0 - 2016-03-22
Security
- Drop the use of OpenSSL as a fallback and use paragonie/random_compat to
support
RandomBytesGenerator
in versions of PHP earlier than 7.0; this addresses and fixes the collision issue
3.2.0 - 2016-02-17
Added
- Add
SodiumRandomGenerator
to allow use of the PECL libsodium extension as a random bytes generator when creating UUIDs
3.1.0 - 2015-12-17
Added
- Implement the PHP
Serializable
interface to provide the ability to serialize/unserialize UUID objects
3.0.1 - 2015-10-21
Added
- Adopt the Contributor Code of Conduct for this project
3.0.0 - 2015-09-28
The 3.0.0 release represents a significant step for the ramsey/uuid library. While the simple and familiar API used in previous versions remains intact, this release provides greater flexibility to integrators, including the ability to inject your own number generators, UUID codecs, node and time providers, and more.
Please note: The changelog for 3.0.0 includes all notes from the alpha and beta versions leading up to this release.
Added
- Add a number of generators that may be used to override the library defaults
for generating random bytes (version 4) or time-based (version 1) UUIDs
CombGenerator
to allow generation of sequential UUIDsOpenSslGenerator
to generate random bytes on systems whereopenssql_random_pseudo_bytes()
is presentMtRandGenerator
to provide a fallback in the event other random generators are not presentRandomLibAdapter
to allow use of ircmaxell/random-libRandomBytesGenerator
for use with PHP 7; ramsey/uuid will default to use this generator when running on PHP 7- Refactor time-based (version 1) UUIDs into a
TimeGeneratorInterface
to allow for other sources to generate version 1 UUIDs in this library PeclUuidTimeGenerator
andPeclUuidRandomGenerator
for creating version 1 or version 4 UUIDs using the pecl-uuid extension
- Add a
setTimeGenerator
method onUuidFactory
to override the default time generator - Add option to enable
PeclUuidTimeGenerator
viaFeatureSet
- Support GUID generation by configuring a
FeatureSet
to use GUIDs - Allow UUIDs to be serialized as JSON through
JsonSerializable
Changed
- Change root namespace from "Rhumsaa" to "Ramsey;" in most cases, simply making this change in your applications is the only upgrade path you will need—everything else should work as expected
- No longer consider
Uuid
class asfinal
; everything is now based around interfaces and factories, allowing you to use this package as a base to implement other kinds of UUIDs with different dependencies - Return an object of type
DegradedUuid
on 32-bit systems to indicate that certain features are not available - Default
RandomLibAdapter
to a medium-strength generator with ircmaxell/random-lib; this is configurable, so other generator strengths may be used
Removed
- Remove
PeclUuidFactory
in favor of using pecl-uuid with generators - Remove
timeConverter
andtimeProvider
properties, setters, and getters in bothFeatureSet
andUuidFactory
as those are now exclusively used by the defaultTimeGenerator
- Move UUID Doctrine field type to ramsey/uuid-doctrine
- Move
uuid
console application to ramsey/uuid-console - Remove
Uuid::VERSION
package version constant
Fixed
- Improve GUID support to ensure that:
- On little endian (LE) architectures, the byte order of the first three fields is LE
- On big endian (BE) architectures, it is the same as a GUID
- String representation is always the same
- Fix exception message for
DegradedNumberConverter::fromHex()
3.0.0-beta1 - 2015-08-31
Fixed
- Improve GUID support to ensure that:
- On little endian (LE) architectures, the byte order of the first three fields is LE
- On big endian (BE) architectures, it is the same as a GUID
- String representation is always the same
- Fix exception message for
DegradedNumberConverter::fromHex()
3.0.0-alpha3 - 2015-07-28
Added
- Enable use of custom
TimeGenerator
implementations - Add a
setTimeGenerator
method onUuidFactory
to override the default time generator - Add option to enable
PeclUuidTimeGenerator
viaFeatureSet
Removed
- Remove
timeConverter
andtimeProvider
properties, setters, and getters in bothFeatureSet
andUuidFactory
as those are now exclusively used by the defaultTimeGenerator
3.0.0-alpha2 - 2015-07-28
Added
- Refactor time-based (version 1) UUIDs into a
TimeGeneratorInterface
to allow for other sources to generate version 1 UUIDs in this library - Add
PeclUuidTimeGenerator
andPeclUuidRandomGenerator
for creating version 1 or version 4 UUIDs using the pecl-uuid extension - Add
RandomBytesGenerator
for use with PHP 7. ramsey/uuid will default to use this generator when running on PHP 7
Changed
- Default
RandomLibAdapter
to a medium-strength generator with ircmaxell/random-lib; this is configurable, so other generator strengths may be used
Removed
- Remove
PeclUuidFactory
in favor of using pecl-uuid with generators
3.0.0-alpha1 - 2015-07-16
Added
- Allow dependency injection through
UuidFactory
and/or extendingFeatureSet
to override any package defaults - Add a number of generators that may be used to override the library defaults:
CombGenerator
to allow generation of sequential UUIDsOpenSslGenerator
to generate random bytes on systems whereopenssql_random_pseudo_bytes()
is presentMtRandGenerator
to provide a fallback in the event other random generators are not presentRandomLibAdapter
to allow use of ircmaxell/random-lib
- Support GUID generation by configuring a
FeatureSet
to use GUIDs - Allow UUIDs to be serialized as JSON through
JsonSerializable
Changed
- Change root namespace from "Rhumsaa" to "Ramsey;" in most cases, simply making this change in your applications is the only upgrade path you will need—everything else should work as expected
- No longer consider
Uuid
class asfinal
; everything is now based around interfaces and factories, allowing you to use this package as a base to implement other kinds of UUIDs with different dependencies - Return an object of type
DegradedUuid
on 32-bit systems to indicate that certain features are not available
Removed
- Move UUID Doctrine field type to ramsey/uuid-doctrine
- Move
uuid
console application to ramsey/uuid-console - Remove
Uuid::VERSION
package version constant
2.9.0 - 2016-03-22
Security
- Drop the use of OpenSSL as a fallback and use paragonie/random_compat to
support
RandomBytesGenerator
in versions of PHP earlier than 7.0; this addresses and fixes the collision issue
2.8.4 - 2015-12-17
Added
- Add support for symfony/console v3 in the
uuid
CLI application
2.8.3 - 2015-08-31
Fixed
- Fix exception message in
Uuid::calculateUuidTime()
2.8.2 - 2015-07-23
Fixed
- Ensure the release tag makes it into the rhumsaa/uuid package
2.8.1 - 2015-06-16
Fixed
- Use
passthru()
and output buffering ingetIfconfig()
- Cache the system node in a static variable so that we process it only once per runtime
2.8.0 - 2014-11-09
Added
- Add static
fromInteger()
method to create UUIDs from string integer orMoontoast\Math\BigNumber
Fixed
- Improve Doctrine conversion to Uuid or string for the ramsey/uuid Doctrine field type
2.7.4 - 2014-10-29
Fixed
- Change loop in
generateBytes()
fromforeach
tofor
2.7.3 - 2014-08-27
Fixed
- Fix upper range for
mt_rand
used in version 4 UUIDs
2.7.2 - 2014-07-28
Changed
- Upgrade to PSR-4 autoloading
2.7.1 - 2014-02-19
Fixed
- Move moontoast/math and symfony/console to require-dev
- Support symfony/console 2.3 (LTS version)
2.7.0 - 2014-01-31
Added
- Add
Uuid::VALID_PATTERN
constant containing a UUID validation regex pattern
2.6.1 - 2014-01-27
Fixed
- Fix bug where
uuid
console application could not find the Composer autoloader when installed in another project
2.6.0 - 2014-01-17
Added
- Introduce
uuid
console application for generating and decoding UUIDs from CLI (run./bin/uuid
for details) - Add
Uuid::getInteger()
to retrieve aMoontoast\Math\BigNumber
representation of the 128-bit integer representing the UUID - Add
Uuid::getHex()
to retrieve the hexadecimal representation of the UUID - Use
netstat
on Linux to capture the node for a version 1 UUID - Require moontoast/math as part of the regular package requirements
2.5.0 - 2013-10-30
Added
- Use
openssl_random_pseudo_bytes()
, if available, to generate random bytes
2.4.0 - 2013-07-29
Added
- Return
null
fromUuid::getVersion()
if the UUID isn't an RFC 4122 variant - Support string UUIDs without dashes passed to
Uuid::fromString()
2.3.0 - 2013-07-16
Added
- Support creation of UUIDs from bytes with
Uuid::fromBytes()
2.2.0 - 2013-07-04
Added
- Add
Doctrine\UuidType::requiresSQLCommentHint()
method
2.1.2 - 2013-07-03
Fixed
- Fix cases where the system node was coming back with uppercase hexadecimal digits; this ensures that case in the node is converted to lowercase
2.1.1 - 2013-04-29
Fixed
- Fix bug in
Uuid::isValid()
where the NIL UUID was not reported as valid
2.1.0 - 2013-04-15
Added
- Allow checking the validity of a UUID through the
Uuid::isValid()
method
2.0.0 - 2013-02-11
Added
- Support UUID generation on 32-bit platforms
Changed
- Mark
Uuid
classfinal
- Require moontoast/math on 64-bit platforms for
Uuid::getLeastSignificantBits()
andUuid::getMostSignificantBits()
; the integers returned by these methods are unsigned 64-bit integers and unsupported even on 64-bit builds of PHP - Move
UnsupportedOperationException
to theException
subnamespace
1.1.2 - 2012-11-29
Fixed
- Relax Doctrine field type conversion rules for UUIDs
1.1.1 - 2012-08-27
Fixed
- Remove
final
keyword fromUuid
class
1.1.0 - 2012-08-06
Added
- Support ramsey/uuid UUIDs as a Doctrine Database Abstraction Layer (DBAL) field mapping type
1.0.0 - 2012-07-19
Added
- Support generation of version 1, 3, 4, and 5 UUIDs