first commit

Author: orkhanshukurlu

.gitignore

@@ -0,0 +1 @@
+/vendor/

.idea/php.xml

@@ -1,51 +1,35 @@
+![latest release](https://img.shields.io/badge/PHP->=7.3-blue.svg?style=flat-square)
+![latest release](https://img.shields.io/badge/Version-1.0.0-red.svg?style=flat-square)
+![latest release](https://img.shields.io/badge/License-MIT-success.svg?style=flat-square)
+
 # PHP CSRF
 
-## Kurulum
-```shell
-    composer require orkhanshukurlu/php-csrf
-```
+PHP CSRF, PHP üçün yazılmış CSRF token paketidir. Siz bu paket vasitəsilə yazdığınız layihəni həm CSRF hücumlarından qoruyacaqsınız həm də layihənizi daha təhlükəsiz etmiş olacaqsınız
 
-### Basit Kullanım
-`vendor/autoload.php` dosyasını dahil ettikten sonra `Csrf` sınıfını üretin. Sınıfı `new` anahtar kelimesiyle çağırdığınızda token üretecektir. Tokeni kullanmak için:
-```php
-    use ahmetbarut\Csrf\Csrf;
+## Tələblər
 
-    require __DIR__ . "/vendor/autoload.php";
+* PHP 7.3+
 
-    // Sınıfı ürettiğinizde token oluşturur. Herhangi bir istek yoksa üretilir, istek varsa token üretmez. 
-    $csrf = new Csrf;
+## Yükləmə
 
-    // Üretilen token değerini getirir.
-    $csrf->getToken();
 ```
-### HTML İçinde Kullanım Ve Kontrol
-Burda kolay kullanım açısından form içinde helper fonksiyonları kullanılıyor. İki yöntemi de kullanabilirsiniz.
+composer require orkhanshukurlu/php-csrf
+```
 
-## ! Not :
-`hasToken` yöntemine gelen verileri olduğu gibi veriniz arkaplanda, `input[name=_token]` olarak bakacaktır.
+## İstifadə
+`vendor/autoload.php` faylını səhifəyə daxil etdikdən sonra CSRF istifadə etmək mümkündür
 ```php
-<?php
-    use ahmetbarut\Csrf\Csrf;
-
-    require __DIR__ . "/vendor/autoload.php";
-
-    $csrf = new Csrf;
-    if($_POST){
-        $csrf->tokenHas($_POST); // bool
-    }
-?>
-
-<form method="POST">
-    <?=csrf_field()?>
-    <input type="text" name="test">
-    <button>Gönder</button>
-</form>
+require __DIR__.'/vendor/autoload.php';
 ```
 
-| Method      | Hakkında |
-| :---        |    :----:
-| __construct | Nesne üretildiğinde beraberinde `session`'u başlatır ve token oluşturur.    |
-| tokenHas   | Verilen tokeni, oluşturulan token ile karşılaştırır.    |
-| getToken   | Oluşturulan son tokeni döndürür.
-| csrf_field   | İnput oluşturur ve token verir. Helper fonksiyonudur. 
-| create_token   | Yeni token oluşturur.
+### `Csrf::field() - csrf_field()`
+CSRF token üçün gizli input generasiya edir. `Html`-də `<form>` elementinin daxilinə uyğun metod və ya funkisyanı əlavə etmək lazımdır
+```php
+require __DIR__.'/vendor/autoload.php';
+
+// Csrf sinifi vasitəsi ilə istifadə
+use OrkhanShukurlu\Csrf\Csrf;
+
+echo Csrf::field(); // 
+// Funksiya vasitəsi ilə istifadə
+```

README.md

@@ -1,28 +1,26 @@
 {
     "name": "orkhanshukurlu/php-csrf",
-    "description": "A package written for user activity logging in Laravel",
+    "description": "PHP üçün yazılmış CSRF token paketi",
     "keywords": [
         "orkhanshukurlu",
-        "laravel",
-        "activity-log",
-        "user-activity-log"
+        "php-csrf",
+        "csrf",
+        "php"
     ],
-    "homepage": "https://github.com/orkhanshukurlu/php-csrf",
-    "license": "MIT",
     "authors": [
         {
             "name": "Orkhan Shukurlu",
-            "email": "orkhandev@gmail.com",
-            "role": "Developer"
+            "email": "orkhandev@gmail.com"
         }
     ],
+    "homepage": "https://github.com/orkhanshukurlu/php-csrf",
+    "license": "MIT",
     "require": {
-        "php" : "^7.3|^8.0|^8.1",
-        "illuminate/database": "^7.0|^8.0|^9.0"
+        "php" : ">=7.3"
     },
     "autoload": {
         "psr-4": {
-            "OrkhanShukurlu\\ActivityLog\\": "src"
+            "OrkhanShukurlu\\Csrf\\": "src/"
         },
         "files": [
             "src/helpers.php"
@@ -33,4 +31,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

composer.json

@@ -0,0 +1,6 @@
+<?php
+
+try {
+    echo csrf_field();
+} catch (Exception $e) {
+}

index.php

@@ -2,28 +2,51 @@
 
 namespace OrkhanShukurlu\Csrf;
 
+use Exception;
+
 class Csrf
 {
-    public static function check(array $request): bool
-    {
-        return isset($request['_token'], $_SESSION['_token']) && hash_equals($request['_token'], $_SESSION['_token']);
-    }
+    const TOKEN_NAME = '_token';
+    const TOKEN_SIZE = 20;
 
+    /**
+     * CSRF token üçün input generasiya edir
+     *
+     * @return string
+     * @throws Exception
+     */
     public static function field(): string
     {
-        return '<input type="hidden" name="_token" value="' . csrf_token() . '">';
+        return '<input type="hidden" name="' . self::TOKEN_NAME . '" value="' . self::token() . '">';
     }
 
+    /**
+     * CSRF token dəyəri generasiya edir
+     *
+     * @return string
+     * @throws Exception
+     */
     public static function token(): string
     {
         if (session_status() === PHP_SESSION_NONE) {
             session_start();
         }
 
-        if (!isset($_SESSION['_token'])) {
-            $_SESSION['_token'] = bin2hex(random_bytes(40));
+        if (! isset($_SESSION[self::TOKEN_NAME])) {
+            $_SESSION[self::TOKEN_NAME] = bin2hex(random_bytes(self::TOKEN_SIZE));
         }
 
-        return $_SESSION['_token'];
+        return $_SESSION[self::TOKEN_NAME];
+    }
+
+    /**
+     * CSRF tokenin doğruluğunu yoxlayır
+     *
+     * @param  array $request
+     * @return bool
+     */
+    public static function validate(array $request): bool
+    {
+        return isset($request[self::TOKEN_NAME], $_SESSION[self::TOKEN_NAME]) && hash_equals($request[self::TOKEN_NAME], $_SESSION[self::TOKEN_NAME]);
     }
 }

src/Csrf.php

@@ -0,0 +1,42 @@
+<?php
+
+use OrkhanShukurlu\Csrf\Csrf;
+
+if (! function_exists('csrf_field')) {
+    /**
+     * CSRF token üçün input generasiya edir
+     *
+     * @return string
+     * @throws Exception
+     */
+    function csrf_field(): string
+    {
+        return Csrf::field();
+    }
+}
+
+if (! function_exists('csrf_token')) {
+    /**
+     * CSRF token dəyəri generasiya edir
+     *
+     * @return string
+     * @throws Exception
+     */
+    function csrf_token(): string
+    {
+        return Csrf::token();
+    }
+}
+
+if (! function_exists('csrf_validate')) {
+    /**
+     * CSRF tokenin doğruluğunu yoxlayır
+     *
+     * @param  array $request
+     * @return bool
+     */
+    function csrf_validate(array $request): bool
+    {
+        return Csrf::validate($request);
+    }
+}