[FrameworkBundle] Deprecate session.sid_length and session.sid_bits_per_character config options

alexandre-daubois · alexandre-daubois · commit 42535609bb81 · 2024-08-05T09:05:09.000+02:00
diff --git a/UPGRADE-7.2.md b/UPGRADE-7.2.md
@@ -22,6 +22,7 @@ FrameworkBundle
 ---------------
 
  * [BC BREAK] The `secrets:decrypt-to-local` command terminates with a non-zero exit code when a secret could not be read
+ * Deprecate `session.sid_length` and `session.sid_bits_per_character` config options
 
 Security
 --------
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * Make the `config/` directory optional in `MicroKernelTrait`, add support for service arguments in the
    invokable Kernel class, and register `FrameworkBundle` by default when the `bundles.php` file is missing
  * [BC BREAK] The `secrets:decrypt-to-local` command terminates with a non-zero exit code when a secret could not be read
+ * Deprecate `session.sid_length` and `session.sid_bits_per_character` config options
 
 7.1
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -685,10 +685,12 @@ private function addSessionSection(ArrayNodeDefinition $rootNode): void
                         ->integerNode('sid_length')
                             ->min(22)
                             ->max(256)
+                            ->setDeprecated('symfony/framework-bundle', '7.1', 'Setting the "%path%.%node%" configuration option is deprecated. It will be removed in version 8.0.')
                         ->end()
                         ->integerNode('sid_bits_per_character')
                             ->min(4)
                             ->max(6)
+                            ->setDeprecated('symfony/framework-bundle', '7.1', 'Setting the "%path%.%node%" configuration option is deprecated. It will be removed in version 8.0.')
                         ->end()
                     ->end()
                 ->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php
@@ -43,8 +43,6 @@
         'gc_maxlifetime' => 90000,
         'gc_divisor' => 108,
         'gc_probability' => 1,
-        'sid_length' => 22,
-        'sid_bits_per_character' => 4,
         'save_path' => '/path/to/sessions',
     ],
     'assets' => [
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -17,7 +17,7 @@
         <framework:ssi enabled="true" />
         <framework:profiler only-exceptions="true" enabled="false" />
         <framework:router resource="%kernel.project_dir%/config/routing.xml" type="xml" utf8="true" />
-        <framework:session gc-maxlifetime="90000" gc-probability="1" gc-divisor="108" storage-factory-id="session.storage.factory.native" handler-id="session.handler.native_file" name="_SYMFONY" cookie-lifetime="86400" cookie-path="/" cookie-domain="example.com" cookie-secure="true" cookie-samesite="lax" cookie-httponly="false" use-cookies="true" save-path="/path/to/sessions" sid-length="22" sid-bits-per-character="4" />
+        <framework:session gc-maxlifetime="90000" gc-probability="1" gc-divisor="108" storage-factory-id="session.storage.factory.native" handler-id="session.handler.native_file" name="_SYMFONY" cookie-lifetime="86400" cookie-path="/" cookie-domain="example.com" cookie-secure="true" cookie-samesite="lax" cookie-httponly="false" use-cookies="true" save-path="/path/to/sessions" />
         <framework:request>
             <framework:format name="csv">
                 <framework:mime-type>text/csv</framework:mime-type>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -36,8 +36,6 @@ framework:
         gc_probability:  1
         gc_divisor:      108
         gc_maxlifetime:  90000
-        sid_length:      22
-        sid_bits_per_character: 4
         save_path:       /path/to/sessions
     assets:
         version: v1
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -673,8 +673,6 @@ public function testSession()
         $this->assertEquals(108, $options['gc_divisor']);
         $this->assertEquals(1, $options['gc_probability']);
         $this->assertEquals(90000, $options['gc_maxlifetime']);
-        $this->assertEquals(22, $options['sid_length']);
-        $this->assertEquals(4, $options['sid_bits_per_character']);
 
         $this->assertEquals('/path/to/sessions', $container->getParameter('session.save_path'));
     }

Original file line number	Diff line number	Diff line change
`@@ -673,8 +673,6 @@ public function testSession()`
`673`	`673`	`$this->assertEquals(108, $options['gc_divisor']);`
`674`	`674`	`$this->assertEquals(1, $options['gc_probability']);`
`675`	`675`	`$this->assertEquals(90000, $options['gc_maxlifetime']);`
`676`		`- $this->assertEquals(22, $options['sid_length']);`
`677`		`- $this->assertEquals(4, $options['sid_bits_per_character']);`
`678`	`676`
`679`	`677`	`$this->assertEquals('/path/to/sessions', $container->getParameter('session.save_path'));`
`680`	`678`	`}`