code.vegaprotocol.io/vega@v0.79.0/wallet/api/admin_describe_permissions.go (about)

     1  // Copyright (C) 2023 Gobalsky Labs Limited
     2  //
     3  // This program is free software: you can redistribute it and/or modify
     4  // it under the terms of the GNU Affero General Public License as
     5  // published by the Free Software Foundation, either version 3 of the
     6  // License, or (at your option) any later version.
     7  //
     8  // This program is distributed in the hope that it will be useful,
     9  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    10  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    11  // GNU Affero General Public License for more details.
    12  //
    13  // You should have received a copy of the GNU Affero General Public License
    14  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    15  
    16  package api
    17  
    18  import (
    19  	"context"
    20  	"fmt"
    21  
    22  	"code.vegaprotocol.io/vega/libs/jsonrpc"
    23  	"code.vegaprotocol.io/vega/wallet/wallet"
    24  
    25  	"github.com/mitchellh/mapstructure"
    26  )
    27  
    28  type AdminDescribePermissionsParams struct {
    29  	Wallet   string `json:"wallet"`
    30  	Hostname string `json:"hostname"`
    31  }
    32  
    33  type AdminDescribePermissionsResult struct {
    34  	Permissions wallet.Permissions `json:"permissions"`
    35  }
    36  
    37  type AdminDescribePermissions struct {
    38  	walletStore WalletStore
    39  }
    40  
    41  // Handle retrieves permissions set for the specified wallet and hostname.
    42  func (h *AdminDescribePermissions) Handle(ctx context.Context, rawParams jsonrpc.Params) (jsonrpc.Result, *jsonrpc.ErrorDetails) {
    43  	params, err := validateDescribePermissionsParams(rawParams)
    44  	if err != nil {
    45  		return nil, InvalidParams(err)
    46  	}
    47  
    48  	if exist, err := h.walletStore.WalletExists(ctx, params.Wallet); err != nil {
    49  		return nil, InternalError(fmt.Errorf("could not verify the wallet exists: %w", err))
    50  	} else if !exist {
    51  		return nil, InvalidParams(ErrWalletDoesNotExist)
    52  	}
    53  
    54  	alreadyUnlocked, err := h.walletStore.IsWalletAlreadyUnlocked(ctx, params.Wallet)
    55  	if err != nil {
    56  		return nil, InternalError(fmt.Errorf("could not verify whether the wallet is already unlock or not: %w", err))
    57  	}
    58  	if !alreadyUnlocked {
    59  		return nil, RequestNotPermittedError(ErrWalletIsLocked)
    60  	}
    61  
    62  	w, err := h.walletStore.GetWallet(ctx, params.Wallet)
    63  	if err != nil {
    64  		return nil, InternalError(fmt.Errorf("could not retrieve the wallet: %w", err))
    65  	}
    66  
    67  	return AdminDescribePermissionsResult{
    68  		Permissions: w.Permissions(params.Hostname),
    69  	}, nil
    70  }
    71  
    72  func validateDescribePermissionsParams(rawParams jsonrpc.Params) (AdminDescribePermissionsParams, error) {
    73  	if rawParams == nil {
    74  		return AdminDescribePermissionsParams{}, ErrParamsRequired
    75  	}
    76  
    77  	params := AdminDescribePermissionsParams{}
    78  	if err := mapstructure.Decode(rawParams, &params); err != nil {
    79  		return AdminDescribePermissionsParams{}, ErrParamsDoNotMatch
    80  	}
    81  
    82  	if params.Wallet == "" {
    83  		return AdminDescribePermissionsParams{}, ErrWalletIsRequired
    84  	}
    85  
    86  	if params.Hostname == "" {
    87  		return AdminDescribePermissionsParams{}, ErrHostnameIsRequired
    88  	}
    89  
    90  	return params, nil
    91  }
    92  
    93  func NewAdminDescribePermissions(
    94  	walletStore WalletStore,
    95  ) *AdminDescribePermissions {
    96  	return &AdminDescribePermissions{
    97  		walletStore: walletStore,
    98  	}
    99  }