File: //lib/python3/dist-packages/secretstorage/__pycache__/collection.cpython-38.pyc
U
E�,W� � @ s� d Z ddlZddlmZmZ ddlmZmZ ddlm Z ddl
m Z m Z m
Z
mZmZmZmZ ed Zed Zd Zd
ZG d d� de�Zdd
d�Zdd� Zddd�Zdd� Zdd� Z dd� Z dS )ar Collection is a place where secret items are stored. Normally, only
the default collection should be used, but this module allows to use any
registered collection. Use :func:`get_default_collection` to get the
default collection (and create it, if necessary).
Collections are usually automatically unlocked when user logs in, but
collections can also be locked and unlocked using
:meth:`Collection.lock` and :meth:`Collection.unlock` methods (unlocking
requires showing the unlocking prompt to user and can be synchronous or
asynchronous). Creating new items and editing existing ones is possible
only in unlocked collection.� N)� SS_PREFIX�SS_PATH)�LockedException�ItemNotFoundException)�Item)�bus_get_object�InterfaceWrapper�exec_prompt_glib�
format_secret� open_session�
to_unicode�unlock_objects�
CollectionZServicez(/org/freedesktop/secrets/aliases/defaultz+/org/freedesktop/secrets/collection/sessionc @ sr e Zd ZdZedfdd�Zdd� Zdd� Zdd d
�Zd d � Z d
d� Z
dd� Z dd� Z dd� Z
dd� Zd dd�ZdS ) r zRepresents a collection.Nc C sL t ||�}|| _|| _|| _t|t�| _t|tj�| _ | j j
tddd� d S )N�Label�ss�Z signature) r �bus�session�collection_pathr �COLLECTION_IFACE�collection_iface�dbus�PROPERTIES_IFACE�collection_props_iface�Get)�selfr r r Zcollection_obj� r �:/usr/lib/python3/dist-packages/secretstorage/collection.py�__init__! s
��
�zCollection.__init__c C s t | jjtddd��S )zDReturns :const:`True` if item is locked, otherwise
:const:`False`.ZLockedr r )�boolr r r �r r r r � is_locked- s
�zCollection.is_lockedc C s | � � rtd��dS )zSIf collection is locked, raises
:exc:`~secretstorage.exceptions.LockedException`.zCollection is locked!N)r! r r r r r �ensure_not_locked3 s z Collection.ensure_not_lockedc C s t | j| jg|�S )a Requests unlocking the collection. If `callback` is specified,
calls it when unlocking is complete (see
:func:`~secretstorage.util.exec_prompt` description for details).
Otherwise, uses loop from GLib API and returns a boolean
representing whether the operation was dismissed.)r
r r )r �callbackr r r �unlock9 s zCollection.unlockc C s, t | jt�}t|t�}|j| jgdd� dS )zLocks the collection.Zaor N)r r r r �
SERVICE_IFACEZLockr )r � service_obj�
service_ifacer r r �lockA s
zCollection.lockc C s | � � | jjdd� dS )z/Deletes the collection and all items inside it.� r N)r" r ZDeleter r r r �deleteG s zCollection.deletec c s. | j jtddd�D ]}t| j|| j�V qdS )z3Returns a generator of all items in the collection.ZItemsr r N)r r r r r r )r � item_pathr r r �
get_all_itemsL s �
zCollection.get_all_itemsc c s0 | j j|dd�}|D ]}t| j|| j�V qdS )z^Returns a generator of items with the given attributes.
`attributes` should be a dictionary.�a{ss}r N)r � SearchItemsr r r )r �
attributes�resultr+ r r r � search_itemsR s
�zCollection.search_itemsc C s | j jtddd�}t|�S )z Returns the collection label.r r r )r r r r �r �labelr r r � get_labelZ s
�zCollection.get_labelc C s | � � | jjtd|dd� dS )z!Sets collection label to `label`.r Zssvr N)r" r �Setr r2 r r r � set_label` s
�zCollection.set_labelF�
text/plainc C sr | � � | jst| j�| _t| j||�}tj|dd�}td |td |i}| jj |||dd�\}}t
| j|| j�S )ac Creates a new :class:`~secretstorage.item.Item` with given
`label` (unicode string), `attributes` (dictionary) and `secret`
(bytestring). If `replace` is :const:`True`, replaces the existing
item with the same attributes. If `content_type` is given, also
sets the content type of the secret (``text/plain`` by default).
Returns the created item.r r z
Item.LabelzItem.Attributesza{sv}(oayays)b) r" r r r r
r Z
Dictionaryr r Z
CreateItemr ) r r3 r/ Zsecret�replaceZ content_type�
propertiesZnew_item�promptr r r � create_itemf s � �
zCollection.create_item)N)Fr7 )�__name__�
__module__� __qualname__�__doc__�DEFAULT_COLLECTIONr r! r" r$ r( r* r, r1 r4 r6 r; r r r r r s
�r) c C s� |s t | �}td |i}t| t�}t�|t�}|j||dd�\}}t|�dkr\t | ||d�S t
| |�\} }
| rvt d��t | |
|d�S )a Creates a new :class:`Collection` with the given `label` and `alias`
and returns it. This action requires prompting. If prompt is dismissed,
raises :exc:`~secretstorage.exceptions.ItemNotFoundException`. This is
synchronous function, uses loop from GLib API.zCollection.Labelza{sv}sr � )r zPrompt dismissed.) r r r r r � Interfacer% ZCreateCollection�lenr r r ) r r3 �aliasr r9 r& r' r r: Z dismissed�unlockedr r r �create_collection{ s
�
rF c c s> t | t�}t�|tj�}|jtddd�D ]}t| |�V q(dS )z1Returns a generator of all available collections.Z Collectionsr r N)r r r rB r r r% r )r r& Zservice_props_ifacer r r r �get_all_collections� s
� �
rG c C s2 z
t | �W S tk
r, t| dd|� Y S X dS )zAReturns the default collection. If it doesn't exist,
creates it.ZDefault�defaultN)r r rF )r r r r r �get_default_collection� s
�rI c C sf z
t | �W S tk
r Y nX z t | t�W S tk
r@ Y nX tt| ��}|rZ|d S td��dS )z�Returns any collection, in the following order of preference:
- The default collection;
- The "session" collection (usually temporary);
- The first collection in the collections list.r zNo collections found.N)r r �SESSION_COLLECTION�listrG )r � collectionsr r r �get_any_collection� s
rM c C sB t | t�}t�|t�}|j|dd�}t|�dkr8td��t| |�S )z�Returns the collection with the given `alias`. If there is no
such collection, raises
:exc:`~secretstorage.exceptions.ItemNotFoundException`.�sr rA z No collection with such alias.) r r r rB r% Z ReadAliasrC r r )r rD r& r' r r r r �get_collection_by_alias� s
rO c c sF t | t�}t�|t�}|j|dd�\}}|| D ]}t| |�V q0dS )zpReturns a generator of items in all collections with the given
attributes. `attributes` should be a dictionary.r- r N)r r r rB r% r. r )r r/ r& r' �lockedrE r+ r r r r1 � s
�
r1 )r) N)N) r? r Zsecretstorage.definesr r Zsecretstorage.exceptionsr r Zsecretstorage.itemr Zsecretstorage.utilr r r r
r r r
r r% r@ rJ �objectr rF rG rI rM rO r1 r r r r �<module> s $]