Inquiry - Mask Number permanence

[sg-modlab]

Exploring this plugin for a project and have a question. Reviewed the documentation and it seems that the maskNumbers filter will result in a string that is permanent. That over time if applied to the same number, you'd always get the same string when filter is applied. Is this accurate?

Over time is there anything you could envision that might result in the string the filter produces changing?

[rungta]

That is correct @sg-modlab. Given the same input, maskNumbers should always return the same output. However, if you want to dig deeper into this (and verify this contract), you should really check out the underlying Hashids library that maskNumbers is simply a wrapper for.

[rungta]

Just FYI, there are three parameters passed on to the Hashids constructor:

craft-cryptographer/src/services/Cryptographer.php

Lines 33 to 43 in 63ac9cb

	public function getHashIds()
	{
	if ($this->_hashIds === null) {
	$hashidsAlphabet = Plugin::getInstance()->settings->hashidsAlphabet;
	$hashidsMinLength = Plugin::getInstance()->settings->hashidsMinLength;
	$this->_hashIds = $hashidsAlphabet === null
	? new Hashids($this->secret, $hashidsMinLength)
	: new Hashids($this->secret, $hashidsMinLength, $hashidsAlphabet);
	}
	return $this->_hashIds;
	}

1. Your security key, used as the salt
2. Minimum length, or padding
3. The alphabet

As long as all three of them remain the same, the output should be permanent.

[sg-modlab]

And it is my understanding the plugin uses Craft's security key, correct. Only should add one to the config if this was used previously on a Craft 2 site.

[rungta]

That is correct.