Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Close #19695 : Add Basic and Bearer Authorization to the CPP Pistache generator #19978

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

mowijo
Copy link

@mowijo mowijo commented Oct 26, 2024

This PR implements a solution to #19695 .

The implementation is a bit different than what agreed upon in #19695. Because none of teh ApiImplementations share a common object apart from a Pistache::Router instance, there are no central object to install a shared credentials/token check on. I do not feel that would belong in the Pistache::Router class.

However, a shared authentication mechanism can be obtained by assigning a such in main. For example:

bool tokenValidator(HttpBearerToken &token)
{
    return (token.token == "Zm9vYmFyCg==");
}

int main() { 
  ...
  for (auto api : apiImpls) {
      api->setBearerTokenAuthenticator(&tokenValidator);
      api->init();
  }
  ...
}

and it may be overwritten in the individual implementations like

void PetsApiImpl::init() 
{
 PetsApi::setupRoutes(); 
   this->setBearerTokenAuthenticator([](){
      return (token.token == "Rk9PQkFSCg==");
   }
 );
}

and the same holds true for Basic.

If the expected headers are missing or malformed or the assigned validators returns false, a 401 is returned.

User Data

Both HttpBearerToken and HttpBasicCredentials can carry userdata as void* from the validator to the endpoint implementation. This can be used to propagate data from the validator that is expected to be reused in the endpoint. For example user ids. this can be accomplished like this:

bool tokenValidator(HttpBearerToken &token)
{
    if(token.token == "Zm9vYmFyCg==")
    {
        const int userIdOfFoo = 99;
        token.userdata = std::unique_ptr<void,std::function<void(void*)>>(
            reinterpret_cast<void*>(new int(userIdOfFoo)),
            [&](void* ptr)
            {
                int * value = reinterpret_cast<int*>(ptr);
                delete value;
            }
            );
        return true;
    }
    return false;
}

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package  &&  ./bin/generate-samples.sh ./bin/configs/*.yaml &&  ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Tagging

@ravinikam , @stkrwork , @etherealjoy , @MartinDelille , @muttleyxd

This allows for data ft be passed on from the authenticator to the
handler implementation. For example a userid that has already been
looked up
`api-base-source.mustache` contain implementations of security
related methods and also the empty constructor.
@wing328 wing328 added this to the 7.10.0 milestone Nov 1, 2024
@wing328
Copy link
Member

wing328 commented Nov 11, 2024

thanks for the PR

if you run mvn integration-test -f samples/server/petstore/cpp-pistache/pom.xml locally, does the test pass?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants