Add (ircmaxell) secure random string gen

Author: Robin Cawser

spec/Vivait/StringGeneratorBundle/Generator/SecureStringGeneratorSpec.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace spec\Vivait\StringGeneratorBundle\Generator;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use RandomLib\Factory;
+use RandomLib\Generator;
+use RandomLib\Mixer;
+use SecurityLib\Strength;
+
+class SecureStringGeneratorSpec extends ObjectBehavior
+{
+
+    /**
+     * @var Factory
+     */
+    private $factory;
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Vivait\StringGeneratorBundle\Generator\SecureStringGenerator');
+    }
+
+    function let(Factory $factory, Generator $low, Generator $medium)
+    {
+        $factory->getMediumStrengthGenerator()->willReturn($medium);
+        $factory->getLowStrengthGenerator()->willReturn($low);
+        $this->beConstructedWith($factory);
+
+        $defaults = [
+            'length' => 32,
+            'chars' => '',
+            'strength' => 'medium',
+        ];
+
+        $this->setOptions($defaults);
+    }
+
+    function it_chooses_medium_strength_gen_by_default(Generator $medium)
+    {
+        $this->getGenerator()->shouldReturn($medium);
+    }
+
+    function it_chooses_a_specified_strength_gen(Generator $medium, Generator $low)
+    {
+        $this->getGenerator('medium')->shouldReturn($medium);
+        $this->getGenerator('low')->shouldReturn($low);
+    }
+
+    function it_errors_on_invalid_strength_gen(Generator $medium, Generator $low)
+    {
+        $this->getGenerator('medium')->shouldReturn($medium);
+        $this->getGenerator('low')->shouldReturn($low);
+
+        $this->shouldThrow('\InvalidArgumentException')->duringGetGenerator('high');
+        $this->shouldThrow('\InvalidArgumentException')->duringGetGenerator('invalid');
+    }
+
+    function it_generates_a_random_string(Generator $medium)
+    {
+        $medium->generateString(32, '')->shouldBeCalled();
+        $this->generate();
+    }
+
+    function it_generates_a_random_string_of_set_length(Generator $medium, Generator $low)
+    {
+        $options = [
+            'length' => 8,
+            'chars' => '',
+            'strength' => 'low',
+        ];
+        $this->setOptions($options);
+
+        $medium->generateString(8, '')->shouldNotBeCalled();
+        $low->generateString(8, '')->shouldBeCalled();
+
+        $this->generate();
+    }
+
+    function getMatchers()
+    {
+        return [
+            'haveStrlen' => function($string, $length){
+                return strlen($string) == $length;
+            }
+        ];
+    }
+}

src/Vivait/StringGeneratorBundle/Generator/SecureBytesGenerator.php

@@ -38,4 +38,12 @@ public function generate()
     {
         return $this->secureRandom->nextBytes($this->length);
     }
+
+    /**
+     * @param array $options
+     */
+    public function setOptions(array $options)
+    {
+        // TODO: Implement setOptions() method.
+    }
 }

src/Vivait/StringGeneratorBundle/Generator/SecureStringGenerator.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace Vivait\StringGeneratorBundle\Generator;
+
+use RandomLib\Factory;
+use RandomLib\Generator;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Vivait\StringGeneratorBundle\Model\ConfigurableGeneratorInterface;
+use Vivait\StringGeneratorBundle\Model\GeneratorInterface;
+
+class SecureStringGenerator implements ConfigurableGeneratorInterface
+{
+
+    /**
+     * @var
+     */
+    private $length = 32;
+
+    /**
+     * @var Generator
+     */
+    private $generator;
+
+    private $chars = '';
+
+    private $strength = 'medium';
+
+    /**
+     * @var Factory
+     */
+    private $factory;
+
+    /**
+     * @param Factory $factory
+     */
+    public function __construct(Factory $factory)
+    {
+
+        $this->factory = $factory;
+    }
+
+    /**
+     * Creates a random string based on a length and alphabet
+     *
+     * @return string
+     */
+    public function generate()
+    {
+        return $this->generator->generateString($this->length, $this->chars);
+    }
+
+    public function getGenerator($strength = 'medium')
+    {
+        switch ($strength) {
+            case 'low':
+                return $this->factory->getLowStrengthGenerator();
+            case 'medium':
+                return $this->factory->getMediumStrengthGenerator();
+            case 'high':
+                throw new \InvalidArgumentException('"high" strength is currently unavailable');
+            default:
+                throw new \InvalidArgumentException('Could not find a generator for the specified strength');
+        }
+    }
+
+    public function setOptions(array $options = [])
+    {
+        $this->generator = $this->getGenerator($options['strength']);
+        $this->length = $options['length'];
+        $this->chars = $options['chars'];
+    }
+
+    public function getDefaultOptions(OptionsResolver $resolver)
+    {
+        return $resolver->setDefaults(
+            [
+                'length' => $this->length,
+                'chars' => $this->chars,
+                'strength' => $this->strength,
+            ]
+        );
+    }
+
+    /**
+     * @param integer $length
+     * @return $this
+     * @deprecated this will be deprecated in version 2.0 in favour of using callbacks on the generator. This is due to
+     * some generators not actually needing a length - only random string type generators require it.
+     */
+    public function setLength($length)
+    {
+        // TODO: Implement setLength() method.
+    }
+}