source/passdb/pdb_pgsql.c

   1 /*
   2  * PostgresSQL password backend for samba
   3  * Copyright (C) Hamish Friedlander 2003
   4  * Copyright (C) Jelmer Vernooij 2004
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; either version 2 of the License, or (at your option)
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with
  17  * this program; if not, write to the Free Software Foundation, Inc., 675
  18  * Mass Ave, Cambridge, MA 02139, USA.
  19  */
  20
  21 #include "includes.h"
  22 #include <libpq-fe.h>
  23
  24 #define CONFIG_HOST_DEFAULT                             "localhost"
  25 #define CONFIG_USER_DEFAULT                             "samba"
  26 #define CONFIG_PASS_DEFAULT                             ""
  27 #define CONFIG_PORT_DEFAULT                             "5432"
  28 #define CONFIG_DB_DEFAULT                               "samba"
  29
  30 /* handles for doing db transactions */
  31 typedef struct pdb_pgsql_data {
  32   PGconn     *handle ;
  33   PGresult   *pwent  ;
  34   long        currow ;
  35
  36   const char *location ;
  37 } pdb_pgsql_data ;
  38
  39 #define SET_DATA(data,methods) { \
  40         if(!methods){ \
  41                 DEBUG(0, ("invalid methods!\n")); \
  42                         return NT_STATUS_INVALID_PARAMETER; \
  43         } \
  44         data = (struct pdb_pgsql_data *)methods->private_data; \
  45                 if(!data || !(data->handle)){ \
  46                         DEBUG(0, ("invalid handle!\n")); \
  47                                 return NT_STATUS_INVALID_HANDLE; \
  48                 } \
  49 }
  50
  51 #define SET_DATA_QUIET(data,methods) { \
  52         if(!methods){ \
  53                 DEBUG(0, ("invalid methods!\n")); \
  54                         return ; \
  55         } \
  56         data = (struct pdb_pgsql_data *)methods->private_data; \
  57                 if(!data || !(data->handle)){ \
  58                         DEBUG(0, ("invalid handle!\n")); \
  59                                 return ; \
  60                 } \
  61 }
  62
  63
  64 #define config_value( data, name, default_value ) \
  65   lp_parm_const_string( GLOBAL_SECTION_SNUM, (data)->location, name, default_value )
  66
  67 static long PQgetlong( PGresult *r, long row, long col )
  68 {
  69   if ( PQgetisnull( r, row, col ) ) return 0 ;
  70
  71   return atol( PQgetvalue( r, row,  col ) ) ;
  72 }
  73
  74 static NTSTATUS row_to_sam_account ( PGresult *r, long row, SAM_ACCOUNT *u )
  75 {
  76   pstring temp ;
  77   DOM_SID sid ;
  78
  79   if ( row >= PQntuples( r ) ) return NT_STATUS_INVALID_PARAMETER ;
  80
  81   pdb_set_logon_time           ( u, PQgetlong ( r, row,  0 ), PDB_SET ) ;
  82   pdb_set_logoff_time          ( u, PQgetlong ( r, row,  1 ), PDB_SET ) ;
  83   pdb_set_kickoff_time         ( u, PQgetlong ( r, row,  2 ), PDB_SET ) ;
  84   pdb_set_pass_last_set_time   ( u, PQgetlong ( r, row,  3 ), PDB_SET ) ;
  85   pdb_set_pass_can_change_time ( u, PQgetlong ( r, row,  4 ), PDB_SET ) ;
  86   pdb_set_pass_must_change_time( u, PQgetlong ( r, row,  5 ), PDB_SET ) ;
  87   pdb_set_username             ( u, PQgetvalue( r, row,  6 ), PDB_SET ) ;
  88   pdb_set_domain               ( u, PQgetvalue( r, row,  7 ), PDB_SET ) ;
  89   pdb_set_nt_username          ( u, PQgetvalue( r, row,  8 ), PDB_SET ) ;
  90   pdb_set_fullname             ( u, PQgetvalue( r, row,  9 ), PDB_SET ) ;
  91   pdb_set_homedir              ( u, PQgetvalue( r, row, 10 ), PDB_SET ) ;
  92   pdb_set_dir_drive            ( u, PQgetvalue( r, row, 11 ), PDB_SET ) ;
  93   pdb_set_logon_script         ( u, PQgetvalue( r, row, 12 ), PDB_SET ) ;
  94   pdb_set_profile_path         ( u, PQgetvalue( r, row, 13 ), PDB_SET ) ;
  95   pdb_set_acct_desc            ( u, PQgetvalue( r, row, 14 ), PDB_SET ) ;
  96   pdb_set_workstations         ( u, PQgetvalue( r, row, 15 ), PDB_SET ) ;
  97   pdb_set_unknown_str          ( u, PQgetvalue( r, row, 16 ), PDB_SET ) ;
  98   pdb_set_munged_dial          ( u, PQgetvalue( r, row, 17 ), PDB_SET ) ;
  99
 100   pdb_set_acct_ctrl            ( u, PQgetlong ( r, row, 23 ), PDB_SET ) ;
 101   pdb_set_logon_divs           ( u, PQgetlong ( r, row, 24 ), PDB_SET ) ;
 102   pdb_set_hours_len            ( u, PQgetlong ( r, row, 25 ), PDB_SET ) ;
 103   pdb_set_bad_password_count    ( u, PQgetlong (r, row, 26 ), PDB_SET ) ;
 104   pdb_set_logon_count            ( u, PQgetlong ( r, row, 27 ), PDB_SET ) ;
 105   pdb_set_unknown_6            ( u, PQgetlong ( r, row, 28 ), PDB_SET ) ;
 106
 107   if ( !PQgetisnull( r, row, 18 ) ) string_to_sid( &sid, PQgetvalue( r, row, 18 ) ) ;
 108   pdb_set_user_sid ( u, &sid, PDB_SET ) ;
 109   if ( !PQgetisnull( r, row, 19 ) ) string_to_sid( &sid, PQgetvalue( r, row, 19 ) ) ;
 110   pdb_set_group_sid( u, &sid, PDB_SET ) ;
 111
 112   if ( pdb_gethexpwd( PQgetvalue( r, row, 20 ), temp ), PDB_SET ) pdb_set_lanman_passwd( u, temp, PDB_SET ) ;
 113   if ( pdb_gethexpwd( PQgetvalue( r, row, 21 ), temp ), PDB_SET ) pdb_set_nt_passwd    ( u, temp, PDB_SET ) ;
 114
 115   /* Only use plaintext password storage when lanman and nt are NOT used */
 116   if ( PQgetisnull( r, row, 20 ) || PQgetisnull( r, row, 21 ) ) pdb_set_plaintext_passwd( u, PQgetvalue( r, row, 22 ) ) ;
 117
 118   return NT_STATUS_OK ;
 119 }
 120
 121 static NTSTATUS pgsqlsam_setsampwent(struct pdb_methods *methods, BOOL update, uint16 acb_mask)
 122 {
 123   struct pdb_pgsql_data *data ;
 124   char *query ;
 125   NTSTATUS retval ;
 126
 127   SET_DATA( data, methods ) ;
 128
 129   query = sql_account_query_select(data->location, update, SQL_SEARCH_NONE, NULL);
 130
 131   /* Do it */
 132   DEBUG( 5, ("Executing query %s\n", query) ) ;
 133   data->pwent  = PQexec( data->handle, query ) ;
 134   data->currow = 0 ;
 135
 136   /* Result? */
 137   if ( data->pwent == NULL )
 138   {
 139     DEBUG( 0, ("Error executing %s, %s\n", query, PQerrorMessage( data->handle ) ) ) ;
 140     retval = NT_STATUS_UNSUCCESSFUL ;
 141   }
 142   else if ( PQresultStatus( data->pwent ) != PGRES_TUPLES_OK )
 143   {
 144     DEBUG( 0, ("Error executing %s, %s\n", query, PQresultErrorMessage( data->pwent ) ) ) ;
 145     retval = NT_STATUS_UNSUCCESSFUL ;
 146   }
 147   else
 148   {
 149     DEBUG( 5, ("pgsqlsam_setsampwent succeeded(%llu results)!\n", PQntuples(data->pwent)) ) ;
 150     retval = NT_STATUS_OK ;
 151   }
 152
 153   SAFE_FREE(query);
 154   return retval ;
 155 }
 156
 157 /***************************************************************
 158   End enumeration of the passwd list.
 159  ****************************************************************/
 160
 161 static void pgsqlsam_endsampwent(struct pdb_methods *methods)
 162 {
 163   struct pdb_pgsql_data *data ;
 164
 165   SET_DATA_QUIET( data, methods ) ;
 166
 167   if (data->pwent != NULL)
 168   {
 169     PQclear( data->pwent ) ;
 170   }
 171
 172   data->pwent  = NULL ;
 173   data->currow = 0 ;
 174
 175   DEBUG( 5, ("pgsql_endsampwent called\n") ) ;
 176 }
 177
 178 /*****************************************************************
 179   Get one SAM_ACCOUNT from the list (next in line)
 180  *****************************************************************/
 181
 182 static NTSTATUS pgsqlsam_getsampwent( struct pdb_methods *methods, SAM_ACCOUNT *user )
 183 {
 184   struct pdb_pgsql_data *data;
 185   NTSTATUS retval ;
 186
 187   SET_DATA( data, methods ) ;
 188
 189   if ( data->pwent == NULL )
 190   {
 191     DEBUG( 0, ("invalid pwent\n") ) ;
 192     return NT_STATUS_INVALID_PARAMETER ;
 193   }
 194
 195   retval = row_to_sam_account( data->pwent, data->currow, user ) ;
 196   data->currow++ ;
 197
 198   return retval ;
 199 }
 200
 201 static NTSTATUS pgsqlsam_select_by_field ( struct pdb_methods *methods, SAM_ACCOUNT *user, enum sql_search_field field, const char *sname )
 202 {
 203   struct pdb_pgsql_data *data ;
 204
 205   char *esc ;
 206   char *query ;
 207
 208   PGresult *result ;
 209   NTSTATUS retval ;
 210
 211   SET_DATA(data, methods);
 212
 213   if ( user == NULL )
 214   {
 215     DEBUG( 0, ("pdb_getsampwnam: SAM_ACCOUNT is NULL.\n") ) ;
 216     return NT_STATUS_INVALID_PARAMETER;
 217   }
 218
 219   DEBUG( 5, ("pgsqlsam_select_by_field: getting data where %d = %s(nonescaped)\n", field, sname) ) ;
 220
 221   /* Escape sname */
 222   esc = malloc(strlen(sname) * 2 + 1);
 223   if ( !esc )
 224   {
 225     DEBUG(0, ("Can't allocate memory to store escaped name\n"));
 226     return NT_STATUS_NO_MEMORY;
 227   }
 228
 229   //tmp_sname = smb_xstrdup(sname);
 230   PQescapeString( esc, sname, strlen(sname) ) ;
 231
 232   query = sql_account_query_select(data->location, True, field, esc);
 233
 234   /* Do it */
 235   DEBUG( 5, ("Executing query %s\n", query) ) ;
 236   result = PQexec( data->handle, query ) ;
 237
 238   /* Result? */
 239   if ( result == NULL )
 240   {
 241     DEBUG( 0, ("Error executing %s, %s\n", query, PQerrorMessage( data->handle ) ) ) ;
 242     retval = NT_STATUS_UNSUCCESSFUL ;
 243   }
 244   else if ( PQresultStatus( result ) != PGRES_TUPLES_OK )
 245   {
 246     DEBUG( 0, ("Error executing %s, %s\n", query, PQresultErrorMessage( result ) ) ) ;
 247     retval = NT_STATUS_UNSUCCESSFUL ;
 248   }
 249   else
 250   {
 251     retval = row_to_sam_account( result, 0, user ) ;
 252   }
 253
 254   SAFE_FREE( esc   ) ;
 255   SAFE_FREE( query ) ;
 256
 257   PQclear( result ) ;
 258
 259   return retval ;
 260 }
 261
 262 /******************************************************************
 263   Lookup a name in the SAM database
 264  ******************************************************************/
 265
 266 static NTSTATUS pgsqlsam_getsampwnam ( struct pdb_methods *methods, SAM_ACCOUNT *user, const char *sname )
 267 {
 268   struct pdb_pgsql_data *data;
 269
 270   SET_DATA(data, methods);
 271
 272   if ( !sname )
 273   {
 274     DEBUG( 0, ("invalid name specified") ) ;
 275     return NT_STATUS_INVALID_PARAMETER;
 276   }
 277
 278   return pgsqlsam_select_by_field( methods, user, SQL_SEARCH_USER_NAME, sname ) ;
 279 }
 280
 281
 282 /***************************************************************************
 283   Search by sid
 284  **************************************************************************/
 285
 286 static NTSTATUS pgsqlsam_getsampwsid ( struct pdb_methods *methods, SAM_ACCOUNT *user, const DOM_SID *sid )
 287 {
 288   struct pdb_pgsql_data *data;
 289   fstring sid_str;
 290
 291   SET_DATA( data, methods ) ;
 292
 293   sid_to_string( sid_str, sid ) ;
 294
 295   return pgsqlsam_select_by_field( methods, user, SQL_SEARCH_USER_SID, sid_str ) ;
 296 }
 297
 298 /***************************************************************************
 299   Delete a SAM_ACCOUNT
 300  ****************************************************************************/
 301
 302 static NTSTATUS pgsqlsam_delete_sam_account( struct pdb_methods *methods, SAM_ACCOUNT *sam_pass )
 303 {
 304   struct pdb_pgsql_data *data ;
 305
 306   const char *sname = pdb_get_username( sam_pass ) ;
 307   char *esc ;
 308   char *query ;
 309
 310   PGresult *result ;
 311   NTSTATUS retval ;
 312
 313   SET_DATA(data, methods);
 314
 315   if ( !sname )
 316   {
 317     DEBUG( 0, ("invalid name specified\n") ) ;
 318     return NT_STATUS_INVALID_PARAMETER ;
 319   }
 320
 321   /* Escape sname */
 322   esc = malloc(strlen(sname) * 2 + 1);
 323   if ( !esc )
 324   {
 325     DEBUG(0, ("Can't allocate memory to store escaped name\n"));
 326     return NT_STATUS_NO_MEMORY;
 327   }
 328
 329   PQescapeString( esc, sname, strlen(sname) ) ;
 330
 331   query = sql_account_query_delete(data->location, esc);
 332
 333   /* Do it */
 334   result = PQexec( data->handle, query ) ;
 335
 336   if ( result == NULL )
 337   {
 338     DEBUG( 0, ("Error executing %s, %s\n", query, PQerrorMessage( data->handle ) ) ) ;
 339     retval = NT_STATUS_UNSUCCESSFUL ;
 340   }
 341   else if ( PQresultStatus( result ) != PGRES_COMMAND_OK )
 342   {
 343     DEBUG( 0, ("Error executing %s, %s\n", query, PQresultErrorMessage( result ) ) ) ;
 344     retval = NT_STATUS_UNSUCCESSFUL ;
 345   }
 346   else
 347   {
 348     DEBUG( 5, ("User '%s' deleted\n", sname) ) ;
 349     retval = NT_STATUS_OK ;
 350   }
 351
 352   SAFE_FREE( esc ) ;
 353   SAFE_FREE( query ) ;
 354
 355   return retval ;
 356 }
 357
 358 static NTSTATUS pgsqlsam_replace_sam_account( struct pdb_methods *methods, const SAM_ACCOUNT *newpwd, char isupdate )
 359 {
 360   struct pdb_pgsql_data *data ;
 361   char *query;
 362   PGresult *result ;
 363
 364   if ( !methods )
 365   {
 366     DEBUG( 0, ("invalid methods!\n") ) ;
 367     return NT_STATUS_INVALID_PARAMETER ;
 368   }
 369
 370   data = (struct pdb_pgsql_data *) methods->private_data ;
 371
 372   if ( data == NULL || data->handle == NULL )
 373   {
 374     DEBUG( 0, ("invalid handle!\n") ) ;
 375     return NT_STATUS_INVALID_HANDLE ;
 376   }
 377
 378   query = sql_account_query_update(data->location, newpwd, isupdate);
 379
 380   result = PQexec( data->handle, query ) ;
 381
 382
 383   /* Execute the query */
 384   if ( result == NULL )
 385   {
 386     DEBUG( 0, ("Error executing %s, %s\n", query, PQerrorMessage( data->handle ) ) ) ;
 387     return NT_STATUS_INVALID_PARAMETER;
 388   }
 389   else if ( PQresultStatus( result ) != PGRES_COMMAND_OK )
 390   {
 391     DEBUG( 0, ("Error executing %s, %s\n", query, PQresultErrorMessage( result ) ) ) ;
 392     return NT_STATUS_INVALID_PARAMETER;
 393   }
 394   SAFE_FREE(query);
 395
 396   return NT_STATUS_OK;
 397 }
 398
 399 static NTSTATUS pgsqlsam_add_sam_account ( struct pdb_methods *methods, SAM_ACCOUNT *newpwd )
 400 {
 401   return pgsqlsam_replace_sam_account( methods, newpwd, 0 ) ;
 402 }
 403
 404 static NTSTATUS pgsqlsam_update_sam_account ( struct pdb_methods *methods, SAM_ACCOUNT *newpwd )
 405 {
 406   return pgsqlsam_replace_sam_account( methods, newpwd, 1 ) ;
 407 }
 408
 409 static NTSTATUS pgsqlsam_init ( struct pdb_context *pdb_context, struct pdb_methods **pdb_method, const char *location )
 410 {
 411   NTSTATUS nt_status ;
 412   struct pdb_pgsql_data *data ;
 413
 414   if ( !pdb_context )
 415   {
 416     DEBUG( 0, ("invalid pdb_methods specified\n") ) ;
 417     return NT_STATUS_UNSUCCESSFUL;
 418   }
 419
 420   if (!NT_STATUS_IS_OK
 421     (nt_status = make_pdb_methods(pdb_context->mem_ctx, pdb_method))) {
 422     return nt_status;
 423   }
 424
 425   (*pdb_method)->name               = "pgsqlsam" ;
 426
 427   (*pdb_method)->setsampwent        = pgsqlsam_setsampwent ;
 428   (*pdb_method)->endsampwent        = pgsqlsam_endsampwent ;
 429   (*pdb_method)->getsampwent        = pgsqlsam_getsampwent ;
 430   (*pdb_method)->getsampwnam        = pgsqlsam_getsampwnam ;
 431   (*pdb_method)->getsampwsid        = pgsqlsam_getsampwsid ;
 432   (*pdb_method)->add_sam_account    = pgsqlsam_add_sam_account ;
 433   (*pdb_method)->update_sam_account = pgsqlsam_update_sam_account ;
 434   (*pdb_method)->delete_sam_account = pgsqlsam_delete_sam_account ;
 435
 436   data = talloc( pdb_context->mem_ctx, sizeof( struct pdb_pgsql_data ) ) ;
 437   (*pdb_method)->private_data = data ;
 438   data->handle = NULL ;
 439   data->pwent  = NULL ;
 440
 441   if ( !location )
 442   {
 443     DEBUG( 0, ("No identifier specified. Check the Samba HOWTO Collection for details\n") ) ;
 444     return NT_STATUS_INVALID_PARAMETER;
 445   }
 446
 447   data->location = smb_xstrdup( location ) ;
 448
 449   if(!sql_account_config_valid(data->location)) {
 450           return NT_STATUS_INVALID_PARAMETER;
 451   }
 452
 453   DEBUG
 454   (
 455     1,
 456     (
 457       "Connecting to database server, host: %s, user: %s, password: XXXXXX, database: %s, port: %s\n",
 458       config_value( data, "pgsql host"    , CONFIG_HOST_DEFAULT ),
 459       config_value( data, "pgsql user"    , CONFIG_USER_DEFAULT ),
 460       config_value( data, "pgsql database", CONFIG_DB_DEFAULT   ),
 461       config_value( data, "pgsql port"    , CONFIG_PORT_DEFAULT )
 462     )
 463   ) ;
 464
 465   /* Do the pgsql initialization */
 466   data->handle = PQsetdbLogin(
 467                                 config_value( data, "pgsql host"    , CONFIG_HOST_DEFAULT ),
 468                                 config_value( data, "pgsql port"    , CONFIG_PORT_DEFAULT ),
 469                                 NULL,
 470                                 NULL,
 471                                 config_value( data, "pgsql database", CONFIG_DB_DEFAULT   ),
 472                                 config_value( data, "pgsql user"    , CONFIG_USER_DEFAULT ),
 473                                 config_value( data, "pgsql password", CONFIG_PASS_DEFAULT )
 474                              ) ;
 475
 476   if ( PQstatus( data->handle ) != CONNECTION_OK )
 477   {
 478     DEBUG( 0, ("Failed to connect to pgsql database: error: %s\n", PQerrorMessage( data->handle )) ) ;
 479     return NT_STATUS_UNSUCCESSFUL;
 480   }
 481
 482   DEBUG( 5, ("Connected to pgsql database\n") ) ;
 483   return NT_STATUS_OK;
 484 }
 485
 486 NTSTATUS pdb_pgsql_init(void)
 487 {
 488   return smb_register_passdb( PASSDB_INTERFACE_VERSION, "pgsql", pgsqlsam_init ) ;
 489 }