search

kjdev / nginx-auth-jwt

Nginx module for the authenticate using JWT
MIT License
27 stars 17 forks source link

feat: Fix NULL warning #14

Closed Dyrkon closed 2 weeks ago

Dyrkon commented 3 months ago

There is a initialization warning preventing build by nix package manager.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The change involves modifying the jwt_parse function in the src/jwt/jwt.c file by initializing the variable sig to NULL. This adjustment ensures that sig has a defined state when the function is entered, enhancing variable management within the code.

Changes

Files Change Summary
src/jwt/jwt.c Changed char *sig; to char *sig = NULL; in jwt_parse function.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant jwt_parse
    participant sig

    Caller->>jwt_parse: Call jwt_parse()
    jwt_parse->>sig: Initialize sig to NULL
    jwt_parse->>Caller: Return from jwt_parse()

Poem

In the code where rabbits hop,
A variable found its stop.
Initialized with care, oh so bright,
Now it’s ready, pure delight!
Hopping through functions, all is well,
With sig set to NULL, we surely excel! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
kjdev commented 2 months ago

I don't think there is any problem with the modification, but the code doesn't seem to have any possibility of being used without being initialized.

Can you provide a build environment and instructions?

Dyrkon commented 2 months ago

Can you provide a build environment and instructions?

Upon further research, this error pops up when building the repo as a Nix package on MacOS which adds hardening flags.

For reference, the packaging looks something like this:

  nginx-auth-jwt = with pkgs; stdenv.mkDerivation rec {
    name = "nginx-auth-jwt";
    src = pkgs.fetchFromGitHub {
        name = "nginx-auth-jwt";
        owner = "kjdev";
        repo = "nginx-auth-jwt";
        rev = "0.7.0";
        sha256 = "sha256-zOqCZsKC3EmbZS9HtUsuwgT+sgiSJvQCCTmp85jnPEw=";
    };
    meta = with pkgs.lib; {
        description = "This nginx module implements client authorization by validating the provided JSON Web Token (JWT) using the specified keys.";
        homepage = "https://github.com/kjdev/nginx-auth-jwt";
        license = [ licenses.mit ];
        maintainers = with maintainers; [ kjdev ];
    };
  };
  nginx-with-jwt = (pkgs.nginx.overrideAttrs rec {
      version = "1.26.0";
      src = pkgs.fetchurl {
          url = "https://nginx.org/download/nginx-${version}.tar.gz";
          hash = "sha256-0ubIQ51sbbUBXY6qskcKtSrvhae/NjGCh5l34IQ3BJc=";
      };
      buildInputs = with pkgs; [
          pcre
          zlib
          openssl
          jansson
          msgpack
          libxslt
          libxml2
          gd
          geoip
          libxcrypt
      ];
  }).override {
      modules = [
          nginx-auth-jwt
      ];
  };
kjdev commented 2 weeks ago

https://github.com/kjdev/nginx-auth-jwt/commit/335c849b366d2a2514b54d9df3aecef70cb44b61

Fixed with the update of the built-in libjwt source code. https://github.com/kjdev/nginx-auth-jwt/blob/main/src/jwt/jwt.c#L595