Branch data     Line data    Source code

       1                 :             : /*-------------------------------------------------------------------------
       2                 :             :  *
       3                 :             :  * superuser.c
       4                 :             :  *    The superuser() function.  Determines if user has superuser privilege.
       5                 :             :  *
       6                 :             :  * All code should use either of these two functions to find out
       7                 :             :  * whether a given user is a superuser, rather than examining
       8                 :             :  * pg_authid.rolsuper directly, so that the escape hatch built in for
       9                 :             :  * the single-user case works.
      10                 :             :  *
      11                 :             :  *
      12                 :             :  * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
      13                 :             :  * Portions Copyright (c) 1994, Regents of the University of California
      14                 :             :  *
      15                 :             :  *
      16                 :             :  * IDENTIFICATION
      17                 :             :  *    src/backend/utils/misc/superuser.c
      18                 :             :  *
      19                 :             :  *-------------------------------------------------------------------------
      20                 :             :  */
      21                 :             : #include "postgres.h"
      22                 :             : 
      23                 :             : #include "access/htup_details.h"
      24                 :             : #include "catalog/pg_authid.h"
      25                 :             : #include "miscadmin.h"
      26                 :             : #include "utils/inval.h"
      27                 :             : #include "utils/syscache.h"
      28                 :             : 
      29                 :             : /*
      30                 :             :  * In common cases the same roleid (ie, the session or current ID) will
      31                 :             :  * be queried repeatedly.  So we maintain a simple one-entry cache for
      32                 :             :  * the status of the last requested roleid.  The cache can be flushed
      33                 :             :  * at need by watching for cache update events on pg_authid.
      34                 :             :  */
      35                 :             : static Oid  last_roleid = InvalidOid;   /* InvalidOid == cache not valid */
      36                 :             : static bool last_roleid_is_super = false;
      37                 :             : static bool roleid_callback_registered = false;
      38                 :             : 
      39                 :             : static void RoleidCallback(Datum arg, SysCacheIdentifier cacheid,
      40                 :             :                            uint32 hashvalue);
      41                 :             : 
      42                 :             : 
      43                 :             : /*
      44                 :             :  * The Postgres user running this command has Postgres superuser privileges
      45                 :             :  */
      46                 :             : bool
      47                 :       75540 : superuser(void)
      48                 :             : {
      49                 :       75540 :     return superuser_arg(GetUserId());
      50                 :             : }
      51                 :             : 
      52                 :             : 
      53                 :             : /*
      54                 :             :  * The specified role has Postgres superuser privileges
      55                 :             :  */
      56                 :             : bool
      57                 :     5183370 : superuser_arg(Oid roleid)
      58                 :             : {
      59                 :             :     bool        result;
      60                 :             :     HeapTuple   rtup;
      61                 :             : 
      62                 :             :     /* Quick out for cache hit */
      63   [ +  +  +  + ]:     5183370 :     if (OidIsValid(last_roleid) && last_roleid == roleid)
      64                 :     4921617 :         return last_roleid_is_super;
      65                 :             : 
      66                 :             :     /* Special escape path in case you deleted all your users. */
      67   [ +  +  +  - ]:      261753 :     if (!IsUnderPostmaster && roleid == BOOTSTRAP_SUPERUSERID)
      68                 :      218717 :         return true;
      69                 :             : 
      70                 :             :     /* OK, look up the information in pg_authid */
      71                 :       43036 :     rtup = SearchSysCache1(AUTHOID, ObjectIdGetDatum(roleid));
      72         [ +  + ]:       43036 :     if (HeapTupleIsValid(rtup))
      73                 :             :     {
      74                 :       43028 :         result = ((Form_pg_authid) GETSTRUCT(rtup))->rolsuper;
      75                 :       43028 :         ReleaseSysCache(rtup);
      76                 :             :     }
      77                 :             :     else
      78                 :             :     {
      79                 :             :         /* Report "not superuser" for invalid roleids */
      80                 :           8 :         result = false;
      81                 :             :     }
      82                 :             : 
      83                 :             :     /* If first time through, set up callback for cache flushes */
      84         [ +  + ]:       43036 :     if (!roleid_callback_registered)
      85                 :             :     {
      86                 :       18717 :         CacheRegisterSyscacheCallback(AUTHOID,
      87                 :             :                                       RoleidCallback,
      88                 :             :                                       (Datum) 0);
      89                 :       18717 :         roleid_callback_registered = true;
      90                 :             :     }
      91                 :             : 
      92                 :             :     /* Cache the result for next time */
      93                 :       43036 :     last_roleid = roleid;
      94                 :       43036 :     last_roleid_is_super = result;
      95                 :             : 
      96                 :       43036 :     return result;
      97                 :             : }
      98                 :             : 
      99                 :             : /*
     100                 :             :  * RoleidCallback
     101                 :             :  *      Syscache inval callback function
     102                 :             :  */
     103                 :             : static void
     104                 :       21625 : RoleidCallback(Datum arg, SysCacheIdentifier cacheid, uint32 hashvalue)
     105                 :             : {
     106                 :             :     /* Invalidate our local cache in case role's superuserness changed */
     107                 :       21625 :     last_roleid = InvalidOid;
     108                 :       21625 : }