Jethro Magaji
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Engagement control
    • Make a copy
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Make a copy Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    1
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # How to Implement Authorization in Next.js in mere minutes with Permify # Outline ## Introduction A briefly explaination on Permify's capabilities and benefits for streamlining access control, emphasizing its focus on ease of use, scalability, and flexibility. An explaination Why Next.js and Permify combination is ideal for building secure and dynamic web applications, highlighting the advantages of server-side rendering (SSR) in Next.js and how Permify complements it. ## Prerequisites - Basic Knowledge of Next.js - Node.js Installed - Basic Understanding of REST APIs ## Full-Stack Blog Application with Permify: Step-by-Step Guide Here's a step-by-step outline for the full-stack blog application with access control using Permify, covering both the frontend and backend setup: **I. Building the Frontend (Next.js):** 1. **Create a New Next.js Project:** ```bash npx create-next-app@latest my-blog-app cd my-blog-app ``` 2. **Install Dependencies:** ```bash npm install @permify/permify-node @permify/react-role next-auth @types/next-auth jsonwebtoken ``` 3. **Create Basic Components:** * **`ProtectedRoute.js`:** Handles permission checks and redirects. * **`Dashboard.js`:** The protected dashboard area. * **`Post.js`:** Renders a single blog post. * **`PostForm.js`:** The form for creating and editing posts. * **`PostList.js`:** Displays a list of blog posts. * **`Layout.js`:** Defines the common structure of your blog. 4. **Set Up Authentication with NextAuth.js:** * Create `pages/api/auth/[...nextauth].js`: 5. **Implement Access Control in Pages:** * **`pages/index.js`:** Show the post list and conditionally render the dashboard if the user is authenticated and has the 'view:dashboard' permission. * **`pages/dashboard.js`:** Use `ProtectedRoute` to protect the dashboard. **II. Building the Backend API (Node.js):** 1. **Create a New Node.js Project:** ```bash mkdir my-blog-api cd my-blog-api npm init -y npm install express @permify/permify-node body-parser cors jsonwebtoken ``` 2. **Initialize Permify Client (in `index.js`):** 3. **Set Up Authentication (in `index.js`):** * Define a secret key for JWT (store securely in environment variables). * Create a `login` route to handle authentication: 4. **Implement Token Verification Middleware (in `index.js`):** * Create middleware to verify JWT tokens: 5. **Define API Routes (in `index.js`):** * **`/api/posts` (GET):** Fetch all posts. * **`/api/posts` (POST):** Create a new post. * **`/api/posts/:postId` (PUT):** Update a post. * **`/api/posts/:postId` (DELETE):** Delete a post. 6. **Implement Access Control Logic:** * **Use `@permify/permify-node`** to check permissions for each action (create, update, delete). 7. **Start the Server:** ```bash node index.js ``` **IV. Testing Your Full-Stack App:** Here the app will be tested to see the implementation of the Access control ### Conclusion * A recap on the key points and benefits of using Permify for access control in Next.js. * A call to action Encourage readers to try Permify for their Next.js projects. * Link to the Github source code. ### References Links to the Permify documentation, API reference, community and relevant resources. # DRAFT ## Introduction Access control is fundamental for web applications, ensuring that only authorized users can access specific features and data. Permify stands out as a powerful and user-friendly solution for implementing fine-grained access control with minimal effort. Next.js, is a popular React framework for server-side rendering (SSR), that offers the best performance and SEO benefits. SSR renders web pages on the server before delivering them to the client, resulting in faster loading times, improved SEO, and enhanced security. Permify seamlessly integrates with Next.js, allowing you to leverage its powerful access control features within the framework. This guide will walk you through the process of setting up access control in your Next.js application using Permify, taking you from zero to a basic, functional implementation in just 10 minutes. Table of content * Prerequisites * A Fullstack Next.js Application with Permify: Step-by-Step Guide * Step 1: Setting Up Next.js Application * Building the Frontend * Building the Backend API * Step 2: Setting up Permify In Our Application * Running Permify Service * Implement Access Control Logic * Step 3: Testing Our App * Start Permify * Start the Backend * Start the Frontend * Login * Wrap up * References ## Prerequisites * Basic Knowledge of [React](https://react.dev/learn), and [Next.js](https://nextjs.org/docs) * Basic Understanding of REST APIs * A code editor (Preferably [Vscode](https://code.visualstudio.com/download)) * [Permify](https://docs.permify.co/setting-up/installation/intro) Setup * [Node.js](https://nodejs.org/en) Installed * [Cors Unblock](https://chromewebstore.google.com/detail/cors-unblock/lfhmikememgdcahcdlaciloancbhjino?hl=en-US) - A chrome extension that allows cors in the browser. ## Step 1: Setting Up Next.js Application We will create a simple Next.js fullstack app that allows different users to login account based to their roles and permission using Permify to implement access control. Project structure ``` my-permify-nextjs-app/ ├── public/ | ├── next.svg │ └── vercel.svg ├── app/ │ ├── api │ │ └── permission.js | ├── page.js │ ├── admin.js │ ├── error.js │ ├── index.js | ├── member.js │ ├── manager.js | ├── layout.js | ├── favicon.ico │ └── global.css ├── app.js ├── app-relationship.js ├── app-tenant.js ├── app-schema.js ├── package.json ├── tailwind.config.js ├── jsconfig.json ├── package-lock.json ├── postcss.config.mjs ├── .gitignore └── next.config.mjs ``` ### Building the Frontend #### 1. Create a new Next.js project: ```bash npx create-next-app@latest my-permify-nextjs-app ``` Then ```bash cd my-permify-nextjs-app ``` #### 2. Install dependencies: ```bash npm install @permify/permify-node express react-chartjs-2 chart.js cors body-parser ``` #### 3. Replace your current `page.js` code with the code below. ```javascript "use client" // To specify client side component import React, { useState } from 'react'; import { useRouter } from 'next/router'; export default function IndexPage() { const router = useRouter(); const [userId, setUserId] = useState(''); // Manual configuration for the API port const apiPort = 3000; const handleLogin = async (role) => { try { if (!userId) { alert('User ID is missing. Please enter your User ID.'); return; } // send the role and userId to the backend for permission check const response = await fetch(`http://localhost:${apiPort}/${role}/${userId}`); const data = await response.json(); if (data.message === 'You are authorized!') { router.push(`/${role}`); // sends the authorized user to the authorized role page } else { router.push('/error'); // sends unauthorized user to an error page. } } catch (error) { console.error('Error during login:', error); router.push('/error'); } }; const handleUserIdChange = (e) => { setUserId(e.target.value); }; return ( <div className="flex min-h-screen items-center justify-center bg-gray-100"> <div className="w-full max-w-md p-6 bg-white rounded-md shadow-lg shadow-blue-500/50"> <div className="text-center mb-6"> {/* Add text-center for center alignment and mb-6 for bottom margin */} <h2 className="text-2xl font-semibold text-gray-900">Welcome User! Please Login</h2> {/* Add heading styles */} </div> <div className="mb-4"> <input type="text" placeholder="Enter Your User ID" value={userId} onChange={handleUserIdChange} className="w-full px-4 py-2 border rounded-md focus:outline-none focus:ring focus:ring-blue-500 text-gray-900" // Add text-gray-900 for black text /> </div> <div className="flex justify-between space-x-2"> {/* Add space-x-2 for spacing between buttons */} <button onClick={() => handleLogin('admin')} className="px-4 py-2 bg-blue-500 text-white rounded-md hover:bg-blue-600 focus:outline-none focus:ring focus:ring-blue-500 text-sm" // Reduce text size > Admin Login </button> <button onClick={() => handleLogin('manager')} className="px-4 py-2 bg-blue-500 text-white rounded-md hover:bg-blue-600 focus:outline-none focus:ring focus:ring-blue-500 text-sm" // Reduce text size > Manager Login </button> <button onClick={() => handleLogin('member')} className="px-4 py-2 bg-blue-500 text-white rounded-md hover:bg-blue-600 focus:outline-none focus:ring focus:ring-blue-500 text-sm" // Reduce text size > Member Login </button> </div> </div> </div> ); } ``` This is the landing page for the app with a simple login built using Next.js and Tailwind CSS. It has a welcome message and an input field where users can enter their `user Id`. The page has three buttons for "**`Admin Login,`**" "**`Manager Login,`**" and "**`Member Login.`**" When you click on any of these buttons, the code sends a `GET request` to the backend API with the entered User ID, and the selected role (admin, member, or manager). If the backend API confirms the user is authorized, it redirects the user to the corresponding page (dashboard, member, or manager). If the user is unauthorized, the user is redirected to an error page. To see the login page, run this command; ```bash npm run dev ``` ![Login page](https://hackmd.io/_uploads/HJMV8LiUA.png) #### 4. Create these pages in `app` directory: * **`admin.js:`** This is the component for the admin dashboard page, accessible only to admins. The code below is a demo admin page, you can add it or use your own code. ```javascript import React from 'react'; import { useState, useEffect } from 'react'; import { Chart as ChartJS, CategoryScale, LinearScale, PointElement, LineElement, Title, Tooltip, Legend } from 'chart.js'; import { Line } from 'react-chartjs-2'; ChartJS.register( CategoryScale, LinearScale, PointElement, LineElement, Title, Tooltip, Legend ); function AdminContent() { const [managers, setManagers] = useState([]); const [members, setMembers] = useState([]); const [chartData, setChartData] = useState(null); useEffect(() => { // Fetch or simulate data for managers and members const fetchDemoData = async () => { // Replace this with your actual data fetching logic const demoManagers = [ { name: 'Alice Johnson', image: 'https://picsum.photos/200/300', // Placeholder image email: 'alice.johnson@example.com', joinedDate: '2023-08-15' }, { name: 'Bob Williams', image: 'https://picsum.photos/200/300', // Placeholder image email: 'bob.williams@example.com', joinedDate: '2023-09-20' }, // ... add more managers ]; const demoMembers = [ { name: 'Carol Brown', image: 'https://picsum.photos/200/300', // Placeholder image email: 'carol.brown@example.com', joinedDate: '2023-10-05' }, { name: 'David Garcia', image: 'https://picsum.photos/200/300', // Placeholder image email: 'david.garcia@example.com', joinedDate: '2023-11-10' }, // ... add more members ]; // Chart data (replace with your actual data) const chartData = { labels: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun'], datasets: [ { label: 'Sales', data: [30, 50, 60, 40, 70, 90], borderColor: 'rgb(53, 162, 235)', tension: 0.4, }, ], }; setManagers(demoManagers); setMembers(demoMembers); setChartData(chartData); }; fetchDemoData(); }, []); return ( <div className="bg-gray-100 min-h-screen"> <div className="container mx-auto p-4"> <h1 className="text-3xl font-bold text-gray-800 mb-4">Admin Dashboard</h1> <div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4"> {/* Manager List */} <div className="bg-white rounded-md shadow-md p-4"> <h2 className="text-xl font-semibold text-gray-800 mb-2">Managers</h2> <ul className="list-none"> {managers.map((manager) => ( <li key={manager.email} className="flex items-center mb-2"> <img src={manager.image} alt={manager.name} className="w-10 h-10 rounded-full mr-2" /> <div> <span className="font-medium">{manager.name}</span> <br /> <span className="text-gray-600">{manager.email}</span> <br /> <span className="text-gray-600">Joined: {manager.joinedDate}</span> </div> </li> ))} </ul> </div> {/* Member List */} <div className="bg-white rounded-md shadow-md p-4"> <h2 className="text-xl font-semibold text-gray-800 mb-2">Members</h2> <ul className="list-none"> {members.map((member) => ( <li key={member.email} className="flex items-center mb-2"> <img src={member.image} alt={member.name} className="w-10 h-10 rounded-full mr-2" /> <div> <span className="font-medium">{member.name}</span> <br /> <span className="text-gray-600">{member.email}</span> <br /> <span className="text-gray-600">Joined: {member.joinedDate}</span> </div> </li> ))} </ul> </div> {/* Demo Chart */} {chartData && ( <div className="bg-white rounded-md shadow-md p-4"> <h2 className="text-xl font-semibold text-gray-800 mb-2">Sales Trend</h2> <Line data={chartData} /> </div> )} </div> {/* Additional content area (e.g., recent activity, reports, etc.) */} {/* ... */} </div> </div> ); } export default AdminContent; ``` * **`manager.js:`** This is the component for the manager page, accessible to managers and admins. The code below is a demo manager page, you can add it or use your own code. ```javascript import React from 'react'; import { useState, useEffect } from 'react'; import { Chart as ChartJS, CategoryScale, LinearScale, PointElement, LineElement, Title, Tooltip, Legend } from 'chart.js'; import { Line } from 'react-chartjs-2'; ChartJS.register( CategoryScale, LinearScale, PointElement, LineElement, Title, Tooltip, Legend ); function ManagerContent() { const [members, setMembers] = useState([]); const [chartData, setChartData] = useState(null); useEffect(() => { // Fetch or simulate data for members const fetchDemoData = async () => { // Replace this with your actual data fetching logic const demoMembers = [ { name: 'Carol Brown', image: 'https://picsum.photos/200/300', // Placeholder image email: 'carol.brown@example.com', joinedDate: '2023-10-05' }, { name: 'David Garcia', image: 'https://picsum.photos/200/300', // Placeholder image email: 'david.garcia@example.com', joinedDate: '2023-11-10' }, // ... add more members ]; // Chart data (replace with your actual data) const chartData = { labels: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun'], datasets: [ { label: 'Tasks Completed', data: [25, 35, 45, 30, 50, 60], borderColor: 'rgb(53, 162, 235)', tension: 0.4, }, ], }; setMembers(demoMembers); setChartData(chartData); }; fetchDemoData(); }, []); return ( <div className="bg-gray-100 min-h-screen"> <div className="container mx-auto p-4"> <h1 className="text-3xl font-bold text-gray-800 mb-4">Manager Dashboard</h1> <div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4"> {/* Member List */} <div className="bg-white rounded-md shadow-md p-4"> <h2 className="text-xl font-semibold text-gray-800 mb-2">Members</h2> <ul className="list-none"> {members.map((member) => ( <li key={member.email} className="flex items-center mb-2"> <img src={member.image} alt={member.name} className="w-10 h-10 rounded-full mr-2" /> <div> <span className="font-medium">{member.name}</span> <br /> <span className="text-gray-600">{member.email}</span> <br /> <span className="text-gray-600">Joined: {member.joinedDate}</span> </div> </li> ))} </ul> </div> {/* Demo Chart */} {chartData && ( <div className="bg-white rounded-md shadow-md p-4"> <h2 className="text-xl font-semibold text-gray-800 mb-2">Task Completion</h2> <Line data={chartData} /> </div> )} {/* Demo Card */} <div className="bg-white rounded-md shadow-md p-4"> <h2 className="text-xl font-semibold text-gray-800 mb-2">Recent Activity</h2> <div className="flex flex-col items-center"> <img src="https://picsum.photos/200/200" alt="Activity Image" className="rounded-md w-48 h-48 mb-2" /> <p className="text-gray-600 text-center"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla facilisi. Donec pulvinar, justo sit amet scelerisque bibendum, quam libero condimentum elit, id rhoncus lectus purus ac neque. </p> </div> </div> </div> {/* Additional content area (e.g., reports, tasks, etc.) */} {/* ... */} </div> </div> ); } export default ManagerContent; ``` * **`member.js:`** This is the component for the member page, accessible to members, and managers. The code below is a demo member page, you can add it or use your own code. ```javascript import React from 'react'; import { useState, useEffect } from 'react'; function MemberPage() { const [posts, setPosts] = useState([]); const [profile, setProfile] = useState(null); useEffect(() => { // Fetch or simulate data for posts and profile const fetchDemoData = async () => { // Replace this with your actual data fetching logic const demoPosts = [ { image: 'https://picsum.photos/600/400', caption: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.' }, { image: 'https://picsum.photos/600/400', caption: 'Nulla facilisi. Donec pulvinar, justo sit amet scelerisque bibendum, quam libero condimentum elit.' }, { image: 'https://picsum.photos/600/400', caption: 'Nulla facilisi. Donec pulvinar, justo sit amet scelerisque bibendum, quam libero condimentum elit.' }, { image: 'https://picsum.photos/600/400', caption: 'Nulla facilisi. Donec pulvinar, justo sit amet scelerisque bibendum, quam libero condimentum elit.' } // ... add more posts ]; const demoProfile = { name: 'John Doe', username: '@johndoe', profileImage: 'https://picsum.photos/200/200', bio: 'Hello! Welcome to the member page.', bannerImage: 'https://picsum.photos/1200/400' }; setPosts(demoPosts); setProfile(demoProfile); }; fetchDemoData(); }, []); return ( <div className="bg-gray-100 min-h-screen"> {profile && ( <div className="container mx-auto"> {/* Banner Image */} <div className="relative"> <img src={profile.bannerImage} alt="Banner" className="w-full h-48 object-cover" /> <div className="absolute bottom-4 left-4 flex items-center"> <img src={profile.profileImage} alt={profile.name} className="w-16 h-16 rounded-full" /> <div className="ml-4"> <h2 className="text-xl font-bold text-black">{profile.name}</h2> <p className="text-black">{profile.username}</p> </div> </div> </div> {/* Profile Details */} <div className="bg-white rounded-md shadow-md p-4 mt-4"> <p className="text-gray-900 text-center mb-2">{profile.bio}</p> </div> {/* Posts Grid */} <div className="grid grid-cols-1 sm:grid-cols-2 md:grid-cols-3 lg:grid-cols-4 gap-4 mt-4"> {posts.map((post) => ( <div key={post.image} className="bg-white rounded-md shadow-md p-2"> <img src={post.image} alt="Post" className="w-full h-48 object-cover rounded-md" /> <p className="text-gray-600 mt-2">{post.caption}</p> </div> ))} </div> </div> )} </div> ); } export default MemberPage; ``` * **`error.js:`** This is the component for the error page, that is shown when an unauthorized user tries to access a page. Add the code below. ```javascript "use client" // To specify client side component import React from 'react'; export default function ErrorPage() { return ( <div className="flex min-h-screen items-center justify-center bg-gray-100"> <div className="w-full max-w-md p-6 bg-white rounded-md shadow-lg shadow-blue-500/50"> <div className="text-center mb-8"> <h1 className="text-4xl font-bold text-gray-800 mb-2">Oops!</h1> <p className="text-gray-600 text-lg">Sorry, you do not have access to the requested page.</p> </div> <div className="flex flex-col items-center"> <img src="https://picsum.photos/300/200" alt="Error Illustration" className="rounded-md w-48 h-48 mb-4" /> </div> <div className="text-center"> <a href="/" className="px-6 py-2 bg-blue-500 text-white rounded-md hover:bg-blue-600 focus:outline-none focus:ring focus:ring-blue-500"> Go Back to Homepage </a> </div> </div> </div> ); } ``` ### Building the Backend API Create a `app.js` file in the root directory i.e. `my-permify-nextjs-app/app.js` and add the code below. ```javascript // Import required modules const express = require('express'); const cors = require('cors'); // Import cors const authorizedRoute = require('./src/api/permission'); // Import the permission middleware const bodyParser = require("body-parser"); // Create Express app const app = express(); // Enable CORS app.use(cors()); app.use(bodyParser.json()); // Define routes // Route for '/admin/:userId' app.get('/admin/:userId', authorizedRoute('view_admin'), (req, res) => { if (req.body && req.body.message === 'You are authorized!') { res.json({ message: 'You have access to the dashboard!'}); } else { res.status(403).json({ message: 'You are not authorized to access the dashboard'}); } }); // Route for '/member/:userId' app.get('/member/:userId', authorizedRoute('view_member'), (req, res) => { if (req.body && req.body.message === 'You are authorized!') { res.json({ message: 'You have access to the member page!'}); } else { res.status(403).json({ message: 'You are not authorized to access the member page'}); } }); // Route for '/manager/:userId' app.get('/manager/:userId', authorizedRoute('view_manager'), (req, res) => { if (req.body && req.body.message === 'You are authorized!') { res.json({ message: 'You have access to the manager page!'}); } else { res.status(403).json({ message: 'You are not authorized to access the manager page'}); } }); // Start the server const PORT = process.env.PORT || 3000; app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); }); ``` This code sets up a web server using Express.js that handles requests for different pages (admin, member, and manager) and checks if the user has the right permission to access them. It uses a special middleware function called `authorizedRoute` to check permissions. If a user is authorized to access a page, the server sends a success message to the user; else, it sends an error message saying that the user is not authorized. ## Step 2: Setting up Permify In Our Application Permify is a powerful authorization service that helps you define and manage access control in your applications. It provides a simple way to create a central authorization service and manage user permissions. ### Running Permify Service You can run Permify Service with [various options](https://docs.permify.co/setting-up/installation/intro#deployment-guides) but in that tutorial we run it via docker container. #### Run From Docker Container Production usage of Permify needs some configurations such as defining running options, selecting datastore to store authorization data and more. However, for the sake of this tutorial we'll not do any configurations and quickly start Permify on your local with running the docker command below: ```shell docker run -p 3476:3476 -p 3478:3478 ghcr.io/permify/permify serve ``` This will start Permify with the default configuration options: * Port 3476 is used to serve the REST API. * Port 3478 is used to serve the GRPC Service. * Authorization data stored in memory. #### Test your connection You can test your connection with creating an HTTP GET request, ```shell localhost:3476/healthz ``` #### Defining Your Authorization Model Permify comes with a default tenant named "`t1`" that you can use directly without the need for creating a new one. This default tenant simplifies the setup process and allows you to get started quickly. Before sending the authorization model to Permify, it's essential to understand the concepts we're modeling. In this example, we are creating a simple access control system for an organization. We'll define users and their roles within the organization, along with specific permissions for each role. * **Entities:** * `user`: Represents individual users in your application. * `organization`: Represents the organization itself, which acts as the context for our permissions. * **Roles:** Within the organization, we define roles with different access levels: * `admin`: Has the highest permissions. * `manager`: Has intermediate permissions. * `member`: Has basic permissions. * **Permissions:** Each role is assigned specific permissions that determine what actions a user can perform. In this example, we have permissions like: * `view_admin`: Only admins can view content related to this permission. * `view_manager`: Managers and admins have access. * `view_member`: Members and managers have access. #### Writing the Schema Create a `app-schema.js` file in the root directory i.e. `my-permify-nextjs-app/app-schema.js` and add the code below. ```javascript const permify = require("@permify/permify-node"); const client = new permify.grpc.newClient({ endpoint: "localhost:3478", // Use your Permify endpoint }); const tenantId = "t1"; // Replace with your tenant ID from Permify async function writeSchema() { try { const response = await client.schema.write({ tenantId: tenantId, schema: ` entity user {} entity organization { relation admin @user relation member @user relation manager @user permission view_admin = admin permission view_manager = manager or admin permission view_member = member or manager } ` }); console.log('Schema written:', response); } catch (error) { console.error("Error writing schema:", error); } } writeSchema(); ``` #### **Defining User-Role Relationships** To create relationships between users and their roles in Permify, you use the `client.data.write()` method. This method associates a subject (a user or a role) with a specific relation within an entity. Currently, when you try to access the admin page using an unauthorized userId named "**jack**", you will get an error as shown in the image below: ![An image showing Permify user-role relationship](https://hackmd.io/_uploads/ryoj1-WLC.png) To fix this you will need to grant "`jack`" the admin role. Then assign other roles as for follows; grant "`jane`" the member role, and "`john`" the manager role. Here's how you would define these relationships: Create a `app-relationship.js` file in the root directory i.e. `my-permify-nextjs-app/app-relationship.js` and add the code below. ```javascript const permify = require("@permify/permify-node"); const client = new permify.grpc.newClient({ endpoint: "localhost:3478", }) client.data.write({ tenantId: "t1", // Replace with your tenant ID from Permify metadata: { schemaVersion: "cpn2bv1isfs3gfv7ke6g" // Replace with your schema version from Permify }, "tuples": [ { "entity": { "type": "organization", "id": "1" }, "relation": "admin", "subject": { "type": "user", "id": "jack", } }, { "entity": { "type": "organization", "id": "1" }, "relation": "member", "subject": { "type": "user", "id": "jane", } }, { "entity": { "type": "organization", "id": "1" }, "relation": "manager", "subject": { "type": "user", "id": "john", } } ], "attributes": [] }).then((response) => { // handle response console.log(response) }) ``` ### Implementing Access Control Logic Create a `/api ` folder in the `/app` directory i.e. `/app/api/permission.js` , then create a `permission.js `file and add this code. ```javascript // Import Permify client const permify = require('@permify/permify-node'); const client = new permify.grpc.newClient({ endpoint: "localhost:3478", }); const authorizedUser = (permissionType) => { return async (req, res, next) => { try { // Ensure req.params.userId exists if (!req.params.userId) { throw new Error('User ID is missing in the request parameters'); } // Convert permissionType to string if necessary const permTypeString = String(permissionType); // Prepare data for Permify check request const checkRes = await client.permission.check({ tenantId: 't1', // Replace with your tenant ID from Permify metadata: { schemaVersion: 'cpn2bv1isfs3gfv7ke6g', // Replace with your schema version from Permify snapToken: '0DQC7mdS2Rc=', // Replace with your snaptoken from Permify depth: 20, }, entity: { type: 'organization', id: "1", }, permission: permTypeString, // Use the converted permissionType subject: { type: 'user', id: req.params.userId, }, }); if (checkRes.can === 1) { // If user is authorized res.json({ message: 'You are authorized!' }); // Send JSON response } else { // If user is not authorized res.status(401).json({ message: 'Unauthorized' }); // Send JSON response } } catch (err) { console.error('Error checking permissions:', err.message); res.status(500).json({ error: err.message }); // Send JSON error response } }; }; module.exports = authorizedUser; ``` This code defines a middleware function called `authorizedUser` which checks if a user has the required permission to access a resource. The middleware takes the permission type as an argument and uses it to check if a user, identified by their ID in the request parameters, has the required permission within the "`organization`" entity with ID "1." If the user is authorized, it sends a JSON response indicating success; else, it sends a JSON response indicating that the user is unauthorized. ## Step 3: Testing your app ### 1. Start Permify Ensure your Permify server is running. If you haven't setup your permify server, please visit this [link](https://docs.permify.co/setting-up/installation/intro) to do so based on your preference. #### Start Permify Server ```bash permify serve ``` You should see somthing like this; ![An image of permify server running](https://hackmd.io/_uploads/rkqXq1yUR.png) * Run your ***`app-tenant.js`*** code ```bash node app-tenant.js ``` * Run your ***`app-schema.js`*** code ```bash node app-schema.js ``` Copy your `{schema version}` and replace it in the `app-relationship.js` * Run your ***`app-relationship.js`*** code ```bash node app-relationship.js ``` Copy your `{schema version}` and `{snaptoken}` and replace them in the `permission.js` ### 2. Start the Backend Run your backend API ```bash node app.js ``` ### 3. Start the Frontend Run your Next.js development server. ```bash npm run dev ``` ### 4. Log In Go to your broswer and open **`localhost:3001`**. You will be shown the login page, enter the appropriate UserID based on the role and you will be redirected the role page. ![A screenshot showing Access Control In NextJs With Permify](https://hackmd.io/_uploads/rJXC_l-IA.png) Let's try to login using the "`jack`" userId, that has permission to view the admin page. You will get the same result as shown in the image below; ![A screenshot showing testing Access Control In NextJs With Permify](https://hackmd.io/_uploads/BJuCGWZ8A.png) You can play around with the different userId's to test their access to any page and see the result. ## Wrap Up You've learned how to implement access control in Next.js using permify by building a fullstack app and allowing users to login based on their roles. Building secure web apps can be hard, but Permify makes it easier! It lets you decide who can do what in your app. It's simple to use, works great with Next.js, and is built with security in mind. This is a powerful tool for developers wanting to build secure and flexible apps. Here's the [GitHub link](https://github.com/Jethro-magaji/my-permify-nextjs-apps) to gain access to the complete project. ### References To further help you understand implementation access control with Permify and Next.js, here are some valuable resources: * [Permify Documentation](https://docs.permify.co) * [Permify API Reference](https://docs.permify.co/api-reference/introduction) * [Permify Discord Community](https://discord.com/invite/n6KfzYxhPp) * [Next.js Documentation](https://nextjs.org/docs) * [Open-source: Implement Role Based Access Management with Permify React Role](https://permify.co/post/open-source-implement-role-based-access-management-with-permify-react-role/) * [Implementing Role Based Access Control (RBAC) in Node.js and Express App](https://permify.co/post/role-based-access-control-rbac-nodejs-expressjs/) * [Role-Based Access Control (RBAC) in SvelteKit](https://permify.co/post/role-based-access-control-rbac-sveltekit/)

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully