---
name: "Lemonldap::NG::Handler::PSGI"
section: "3pm"
platform: "linux"
package: "liblemonldap-ng-handler-perl"
version: "2.21.2+ds-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Lemonldap::NG::Handler::PSGI"
---

# Lemonldap::NG::Handler::PSGI(3pm)

Base library for protected PSGI applications.

## NAME

Lemonldap::NG::Handler::PSGI - Base library for protected PSGI applications.

## SYNOPSIS

```
  package My::PSGI;

  use base Lemonldap::NG::Handler;

  sub init {
    my ( $self, $args ) = @_;
    $self->protection('manager');
    # See Lemonldap::NG::Common::PSGI for more
    ...
    # Return a boolean. If false, then error message has to be stored in
    # $self->error
    return 1;
  }

  sub handler {
    my ( $self, $req ) = @_;
    # Will be called only if authorized
    my $userId = $self->userId;
    ...
    $self->sendJSONresponse(...);
  }
```

This package could then be called as a CGI, using FastCGI,...

```
  #!/usr/bin/env perl

  use My::PSGI;
  use Plack::Handler::FCGI; # or Plack::Handler::CGI
  Plack::Handler::FCGI->new->run( My::PSGI->run() );
```

## DESCRIPTION

This package provides base class for Lemonldap::NG protected REST API.

## METHODS

See Lemonldap::NG::Common::PSGI for logging methods, content sending,...

### Accessors

See Lemonldap::NG::Common::PSGI::Router for inherited accessors.

*protection*

Level of protection. It can be one of:

- 'none': no protection

  - 'authenticate': all authenticated users are granted

  - 'manager': access is granted following Lemonldap::NG rules

  ### Running methods

*user*

Returns user session data. If empty (no protection), returns:

```
  { _whatToTrace => 'anonymous' }
```

But if page is protected by server (Auth-Basic,...), it will return:

```
  { _whatToTrace => $REMOTE_USER }
```

*UserId*

Returns **user()**-\>{'\_whatToTrace'}.

*group*

Returns a list of groups to which user belongs.

## SEE ALSO

\<http://lemonldap-ng.org/\>, Lemonldap::NG::Portal, Lemonldap::NG::Handler, Plack, PSGI, Lemonldap::NG::Common::PSGI::Router, Lemonldap::NG::Common::PSGI::Request, HTML::Template,

## AUTHORS

- LemonLDAP::NG team \<http://lemonldap-ng.org/team\>

  ## BUG REPORT

Use OW2 system to report bug or ask for features: \<https://gitlab.ow2.org/lemonldap-ng/lemonldap-ng/issues\>

## DOWNLOAD

Lemonldap::NG is available at \<https://lemonldap-ng.org/download\>

## COPYRIGHT AND LICENSE

See COPYING file for details.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program.  If not, see \<http://www.gnu.org/licenses/\>.